Update createAzureCommunicationChatAdapter ctor to take an object i…

…nstead of many params (#626)
Azure · Aug 3, 2021 · 370cb99 · 370cb99
1 parent f16a14c
commit 370cb99
Show file tree

Hide file tree

Showing 17 changed files with 109 additions and 76 deletions.
diff --git a/change/@internal-react-composites-fc54afea-88af-4bfd-b28f-43533ecefd56.json b/change/@internal-react-composites-fc54afea-88af-4bfd-b28f-43533ecefd56.json
@@ -0,0 +1,7 @@
+{
+  "type": "prerelease",
+  "comment": "Update createAzureCommunicationChatAdapter constructor to take in a named object instead of seperate args",
+  "packageName": "@internal/react-composites",
+  "email": "[email protected]",
+  "dependentChangeType": "patch"
+}
diff --git a/packages/communication-react/review/communication-react.api.md b/packages/communication-react/review/communication-react.api.md
@@ -180,6 +180,15 @@ export type AzureCommunicationCallAdapterArgs = {
     callClientOptions?: CallClientOptions;
 };
 
+// @public (undocumented)
+export type AzureCommunicationChatAdapterArgs = {
+    endpointUrl: string;
+    userId: CommunicationIdentifierKind;
+    displayName: string;
+    credential: CommunicationTokenCredential;
+    threadId: string;
+};
+
 // @public
 export interface BaseCustomStylesProps {
     root?: IStyle;
@@ -751,7 +760,7 @@ export interface ControlBarProps {
 export const createAzureCommunicationCallAdapter: ({ userId, displayName, credential, locator, callClientOptions }: AzureCommunicationCallAdapterArgs) => Promise<CallAdapter>;
 
 // @public (undocumented)
-export const createAzureCommunicationChatAdapter: (endpointUrl: string, userId: CommunicationIdentifierKind, displayName: string, credential: CommunicationTokenCredential, threadId: string) => Promise<ChatAdapter>;
+export const createAzureCommunicationChatAdapter: ({ endpointUrl, userId, displayName, credential, threadId }: AzureCommunicationChatAdapterArgs) => Promise<ChatAdapter>;
 
 // @public (undocumented)
 export const createDefaultCallingHandlers: (callClient: StatefulCallClient, callAgent: CallAgent | undefined, deviceManager: StatefulDeviceManager | undefined, call: Call | undefined) => {

diff --git a/packages/react-composites/review/react-composites.api.md b/packages/react-composites/review/react-composites.api.md
@@ -141,6 +141,15 @@ export type AzureCommunicationCallAdapterArgs = {
     callClientOptions?: CallClientOptions;
 };
 
+// @public (undocumented)
+export type AzureCommunicationChatAdapterArgs = {
+    endpointUrl: string;
+    userId: CommunicationIdentifierKind;
+    displayName: string;
+    credential: CommunicationTokenCredential;
+    threadId: string;
+};
+
 // @public (undocumented)
 export interface CallAdapter {
     // (undocumented)
@@ -387,7 +396,7 @@ export type ChatUIState = {
 export const createAzureCommunicationCallAdapter: ({ userId, displayName, credential, locator, callClientOptions }: AzureCommunicationCallAdapterArgs) => Promise<CallAdapter>;
 
 // @public (undocumented)
-export const createAzureCommunicationChatAdapter: (endpointUrl: string, userId: CommunicationIdentifierKind, displayName: string, credential: CommunicationTokenCredential, threadId: string) => Promise<ChatAdapter>;
+export const createAzureCommunicationChatAdapter: ({ endpointUrl, userId, displayName, credential, threadId }: AzureCommunicationChatAdapterArgs) => Promise<ChatAdapter>;
 
 // @public (undocumented)
 export type DisplayNameChangedListener = (event: {

diff --git a/...act-composites/src/composites/ChatComposite/adapter/AzureCommunicationChatAdapter.test.ts b/...act-composites/src/composites/ChatComposite/adapter/AzureCommunicationChatAdapter.test.ts
@@ -147,13 +147,13 @@ export const createChatAdapterWithStubs = async (chatClient: StubChatClient): Pr
       // Nothing to dispose in the stub.
     }
   };
-  return await createAzureCommunicationChatAdapter(
-    'stubEndointUrl',
-    { kind: 'communicationUser', communicationUserId: 'stubUserId' },
-    'stubDisplayName',
-    stubCredential,
-    'stubThreadId'
-  );
+  return await createAzureCommunicationChatAdapter({
+    endpointUrl: 'stubEndpointUrl',
+    userId: { kind: 'communicationUser', communicationUserId: 'stubUserId' },
+    displayName: 'stubDisplayName',
+    credential: stubCredential,
+    threadId: 'stubThreadId'
+  });
 };
 
 class StateChangeListener {

diff --git a/...es/react-composites/src/composites/ChatComposite/adapter/AzureCommunicationChatAdapter.ts b/...es/react-composites/src/composites/ChatComposite/adapter/AzureCommunicationChatAdapter.ts
@@ -297,13 +297,21 @@ const convertEventToChatMessage = (event: ChatMessageReceivedEvent): ChatMessage
   };
 };
 
-export const createAzureCommunicationChatAdapter = async (
-  endpointUrl: string,
-  userId: CommunicationIdentifierKind,
-  displayName: string,
-  credential: CommunicationTokenCredential,
-  threadId: string
-): Promise<ChatAdapter> => {
+export type AzureCommunicationChatAdapterArgs = {
+  endpointUrl: string;
+  userId: CommunicationIdentifierKind;
+  displayName: string;
+  credential: CommunicationTokenCredential;
+  threadId: string;
+};
+
+export const createAzureCommunicationChatAdapter = async ({
+  endpointUrl,
+  userId,
+  displayName,
+  credential,
+  threadId
+}: AzureCommunicationChatAdapterArgs): Promise<ChatAdapter> => {
   const chatClient = createStatefulChatClient({
     userId: userId,
     displayName,

diff --git a/packages/react-composites/src/composites/ChatComposite/index.ts b/packages/react-composites/src/composites/ChatComposite/index.ts
@@ -2,9 +2,9 @@
 // Licensed under the MIT license.
 
 export { createAzureCommunicationChatAdapter } from './adapter/AzureCommunicationChatAdapter';
+export type { AzureCommunicationChatAdapterArgs } from './adapter/AzureCommunicationChatAdapter';
 
 export { ChatComposite } from './ChatComposite';
-
 export type { ChatCompositeProps, ChatOptions } from './ChatComposite';
 
 export type {

diff --git a/packages/react-composites/tests/browser/chat/app/index.tsx b/packages/react-composites/tests/browser/chat/app/index.tsx
@@ -24,13 +24,13 @@ function App(): JSX.Element {
   useEffect(() => {
     const initialize = async (): Promise<void> => {
       setChatAdapter(
-        await createAzureCommunicationChatAdapter(
+        await createAzureCommunicationChatAdapter({
           endpointUrl,
-          { kind: 'communicationUser', communicationUserId: userId },
+          userId: { kind: 'communicationUser', communicationUserId: userId },
           displayName,
-          new AzureCommunicationTokenCredential(token),
+          credential: new AzureCommunicationTokenCredential(token),
           threadId
-        )
+        })
       );
     };
 

diff --git a/packages/storybook/stories/ChatComposite/CustomBehaviorExampleContainer.tsx b/packages/storybook/stories/ChatComposite/CustomBehaviorExampleContainer.tsx
@@ -27,13 +27,13 @@ export const ContosoChatContainer = (props: ContainerProps): JSX.Element => {
     }
 
     const createAdapter = async (): Promise<void> => {
-      const newAdapter = await createAzureCommunicationChatAdapter(
-        props.endpointUrl,
-        getIdentifierKind(props.userId),
-        props.displayName,
-        new AzureCommunicationTokenCredential(props.token),
-        props.threadId
-      );
+      const newAdapter = await createAzureCommunicationChatAdapter({
+        endpointUrl: props.endpointUrl,
+        userId: getIdentifierKind(props.userId),
+        displayName: props.displayName,
+        credential: new AzureCommunicationTokenCredential(props.token),
+        threadId: props.threadId
+      });
 
       // Custom behavior: Intercept messages from the local user and convert
       // to uppercase before sending to backend.

diff --git a/packages/storybook/stories/ChatComposite/snippets/Container.snippet.tsx b/packages/storybook/stories/ChatComposite/snippets/Container.snippet.tsx
@@ -36,13 +36,13 @@ export const ContosoChatContainer = (props: ContainerProps): JSX.Element => {
     if (!!credential && props) {
       const createAdapter = async (credential: AzureCommunicationTokenCredential): Promise<void> => {
         setAdapter(
-          await createAzureCommunicationChatAdapter(
-            props.endpointUrl,
-            getIdentifierKind(props.userId),
-            props.displayName,
+          await createAzureCommunicationChatAdapter({
+            endpointUrl: props.endpointUrl,
+            userId: getIdentifierKind(props.userId),
+            displayName: props.displayName,
             credential,
-            props.threadId
-          )
+            threadId: props.threadId
+          })
         );
       };
       createAdapter(credential);

diff --git a/...ages/storybook/stories/ChatComposite/snippets/CustomDataModelExampleContainer.snippet.tsx b/...ages/storybook/stories/ChatComposite/snippets/CustomDataModelExampleContainer.snippet.tsx
@@ -25,14 +25,14 @@ export const CustomDataModelExampleContainer = (props: CustomDataModelExampleCon
     if (props) {
       const createAdapter = async (): Promise<void> => {
         setAdapter(
-          await createAzureCommunicationChatAdapter(
-            props.endpointUrl,
-            getIdentifierKind(props.userId),
+          await createAzureCommunicationChatAdapter({
+            endpointUrl: props.endpointUrl,
+            userId: getIdentifierKind(props.userId),
             // Data model injection: The display name for the local user comes from Contoso's data model.
-            props.displayName,
-            new AzureCommunicationTokenCredential(props.token),
-            props.threadId
-          )
+            displayName: props.displayName,
+            credential: new AzureCommunicationTokenCredential(props.token),
+            threadId: props.threadId
+          })
         );
       };
       createAdapter();

diff --git a/packages/storybook/stories/ChatComposite/snippets/CustomizeBehavior.snippet.tsx b/packages/storybook/stories/ChatComposite/snippets/CustomizeBehavior.snippet.tsx
@@ -21,13 +21,13 @@ export const ContosoChatContainer = (props: ContainerProps): JSX.Element => {
     if (!props) return;
 
     const createAdapter = async (): Promise<void> => {
-      const chatAdapter = await createAzureCommunicationChatAdapter(
-        props.endpointUrl,
-        getIdentifierKind(props.userId),
-        props.displayName,
-        new AzureCommunicationTokenCredential(props.token),
-        props.threadId
-      );
+      const chatAdapter = await createAzureCommunicationChatAdapter({
+        endpointUrl: props.endpointUrl,
+        userId: getIdentifierKind(props.userId),
+        displayName: props.displayName,
+        credential: new AzureCommunicationTokenCredential(props.token),
+        threadId: props.threadId
+      });
 
       // Custom behavior: Intercept messages from the local user and convert
       // to uppercase before sending to backend.

diff --git a/packages/storybook/stories/MeetingComposite/snippets/Meeting.snippet.tsx b/packages/storybook/stories/MeetingComposite/snippets/Meeting.snippet.tsx
@@ -55,13 +55,13 @@ export const MeetingExperience = (props: MeetingExampleProps): JSX.Element => {
         );
 
         setChatAdapter(
-          await createAzureCommunicationChatAdapter(
-            props.endpointUrl,
-            { kind: 'communicationUser', communicationUserId: props.userId.communicationUserId },
-            props.displayName,
+          await createAzureCommunicationChatAdapter({
+            endpointUrl: props.endpointUrl,
+            userId: { kind: 'communicationUser', communicationUserId: props.userId.communicationUserId },
+            displayName: props.displayName,
             credential,
-            props.threadId
-          )
+            threadId: props.threadId
+          })
         );
       };
       createAdapters();

diff --git a/packages/storybook/stories/QuickStarts/snippets/QuickstartCompositeAdapter.snippet.tsx b/packages/storybook/stories/QuickStarts/snippets/QuickstartCompositeAdapter.snippet.tsx
@@ -36,13 +36,13 @@ function App(): JSX.Element {
     if (credential !== undefined) {
       const createAdapter = async (credential: AzureCommunicationTokenCredential): Promise<void> => {
         setChatAdapter(
-          await createAzureCommunicationChatAdapter(
+          await createAzureCommunicationChatAdapter({
             endpointUrl,
-            { kind: 'communicationUser', communicationUserId: userId },
+            userId: { kind: 'communicationUser', communicationUserId: userId },
             displayName,
             credential,
             threadId
-          )
+          })
         );
         setCallAdapter(
           await createAzureCommunicationCallAdapter({

diff --git a/packages/storybook/stories/QuickStarts/snippets/QuickstartCompositeComplete.snippet.tsx b/packages/storybook/stories/QuickStarts/snippets/QuickstartCompositeComplete.snippet.tsx
@@ -37,13 +37,13 @@ function App(): JSX.Element {
   useEffect(() => {
     const createAdapter = async (): Promise<void> => {
       setChatAdapter(
-        await createAzureCommunicationChatAdapter(
+        await createAzureCommunicationChatAdapter({
           endpointUrl,
-          { kind: 'communicationUser', communicationUserId: userId },
+          userId: { kind: 'communicationUser', communicationUserId: userId },
           displayName,
-          new AzureCommunicationTokenCredential(token),
+          credential: new AzureCommunicationTokenCredential(token),
           threadId
-        )
+        })
       );
       setCallAdapter(
         await createAzureCommunicationCallAdapter({

diff --git a/packages/storybook/stories/Stateful Client/snippets/ChatAdapterExample.snippet.tsx b/packages/storybook/stories/Stateful Client/snippets/ChatAdapterExample.snippet.tsx
@@ -20,13 +20,13 @@ export const ChatAdapterExample = (props: ChatAdapterExampleProps): JSX.Element
     if (props) {
       const createAdapter = async (): Promise<void> => {
         setChatAdapter(
-          await createAzureCommunicationChatAdapter(
-            props.endpointUrl,
-            getIdentifierKind(props.userId),
-            props.displayName,
-            new AzureCommunicationTokenCredential(props.accessToken),
-            props.threadId
-          )
+          await createAzureCommunicationChatAdapter({
+            endpointUrl: props.endpointUrl,
+            userId: getIdentifierKind(props.userId),
+            displayName: props.displayName,
+            credential: new AzureCommunicationTokenCredential(props.accessToken),
+            threadId: props.threadId
+          })
         );
       };
       createAdapter();

diff --git a/packages/storybook/stories/snippets/localization/LocalizedComposites.snippet.tsx b/packages/storybook/stories/snippets/localization/LocalizedComposites.snippet.tsx
@@ -38,13 +38,13 @@ function App(): JSX.Element {
   useEffect(() => {
     const createAdapter = async (): Promise<void> => {
       setChatAdapter(
-        await createAzureCommunicationChatAdapter(
+        await createAzureCommunicationChatAdapter({
           endpointUrl,
-          { kind: 'communicationUser', communicationUserId: userId },
+          userId: { kind: 'communicationUser', communicationUserId: userId },
           displayName,
-          new AzureCommunicationTokenCredential(token),
+          credential: new AzureCommunicationTokenCredential(token),
           threadId
-        )
+        })
       );
       setCallAdapter(
         await createAzureCommunicationCallAdapter({

diff --git a/samples/StaticHtmlComposites/src/chatComposite.js b/samples/StaticHtmlComposites/src/chatComposite.js
@@ -8,13 +8,13 @@ import { ChatComposite, createAzureCommunicationChatAdapter } from '@azure/commu
 
 export const loadChatComposite = async function (args, htmlElement) {
   const { userId, token, endpointUrl, threadId, displayName } = args;
-  const adapter = await createAzureCommunicationChatAdapter(
+  const adapter = await createAzureCommunicationChatAdapter({
     endpointUrl,
     userId,
-    displayName ?? 'anonymous',
-    new AzureCommunicationTokenCredential(token),
+    displayName: displayName ?? 'anonymous',
+    credential: new AzureCommunicationTokenCredential(token),
     threadId
-  );
+  });
   ReactDOM.render(React.createElement(ChatComposite, { adapter }, null), htmlElement);
   return adapter;
 };