Resolve all comments in azure review (#998)

* Resovle all comments from dom in azure review https://apiview.dev/Assemblies/Review/42fe51ace1e24184a42351ff89044352 * Update packages/react-components/src/components/MessageThread.tsx Co-authored-by: Nan Jiang <[email protected]> Co-authored-by: James Burnside <[email protected]>
Azure · Nov 2, 2021 · 6708f87 · 6708f87
1 parent 16fe225
commit 6708f87
Show file tree

Hide file tree

Showing 57 changed files with 167 additions and 116 deletions.
diff --git a/change/@internal-calling-component-bindings-2d6fa32c-8bcc-4f5f-bc3b-cf99f61fd2f7.json b/change/@internal-calling-component-bindings-2d6fa32c-8bcc-4f5f-bc3b-cf99f61fd2f7.json
@@ -0,0 +1,7 @@
+{
+  "type": "prerelease",
+  "comment": "Update according to azure review",
+  "packageName": "@internal/calling-component-bindings",
+  "email": "[email protected]",
+  "dependentChangeType": "patch"
+}
diff --git a/change/@internal-calling-stateful-client-46b853bf-8444-4209-a24b-a3d093f0f372.json b/change/@internal-calling-stateful-client-46b853bf-8444-4209-a24b-a3d093f0f372.json
@@ -0,0 +1,7 @@
+{
+  "type": "prerelease",
+  "comment": "Update according to azure review",
+  "packageName": "@internal/calling-stateful-client",
+  "email": "[email protected]",
+  "dependentChangeType": "patch"
+}
diff --git a/change/@internal-chat-component-bindings-de669021-913e-493b-a21f-f5b50735af32.json b/change/@internal-chat-component-bindings-de669021-913e-493b-a21f-f5b50735af32.json
@@ -0,0 +1,7 @@
+{
+  "type": "prerelease",
+  "comment": "Update according to azure review",
+  "packageName": "@internal/chat-component-bindings",
+  "email": "[email protected]",
+  "dependentChangeType": "patch"
+}
diff --git a/change/@internal-react-components-e0f7c92a-b9ea-4bce-9538-c33cb71fb8e0.json b/change/@internal-react-components-e0f7c92a-b9ea-4bce-9538-c33cb71fb8e0.json
@@ -0,0 +1,7 @@
+{
+  "type": "prerelease",
+  "comment": "Update according to azure review",
+  "packageName": "@internal/react-components",
+  "email": "[email protected]",
+  "dependentChangeType": "patch"
+}
diff --git a/change/@internal-react-composites-e8c218c4-5ab6-4f77-ac50-c1904a3fb10a.json b/change/@internal-react-composites-e8c218c4-5ab6-4f77-ac50-c1904a3fb10a.json
@@ -0,0 +1,7 @@
+{
+  "type": "prerelease",
+  "comment": "Update according to azure review",
+  "packageName": "@internal/react-composites",
+  "email": "[email protected]",
+  "dependentChangeType": "patch"
+}
diff --git a/change/@internal-storybook-827b3b0a-2580-4b96-a306-a82bf78e4353.json b/change/@internal-storybook-827b3b0a-2580-4b96-a306-a82bf78e4353.json
@@ -0,0 +1,7 @@
+{
+  "type": "prerelease",
+  "comment": "Update according to azure review",
+  "packageName": "@internal/storybook",
+  "email": "[email protected]",
+  "dependentChangeType": "patch"
+}
diff --git a/packages/calling-component-bindings/review/calling-component-bindings.api.md b/packages/calling-component-bindings/review/calling-component-bindings.api.md
@@ -80,7 +80,7 @@ export type CallingHandlers = {
     onHangUp: () => Promise<void>;
     onCreateLocalStreamView: (options?: VideoStreamOptions) => Promise<void>;
     onCreateRemoteStreamView: (userId: string, options?: VideoStreamOptions) => Promise<void>;
-    onParticipantRemove: (userId: string) => Promise<void>;
+    onRemoveParticipant: (userId: string) => Promise<void>;
     onDisposeRemoteStreamView: (userId: string) => Promise<void>;
     onDisposeLocalStreamView: () => Promise<void>;
 };

diff --git a/packages/calling-component-bindings/src/handlers/createHandlers.ts b/packages/calling-component-bindings/src/handlers/createHandlers.ts
@@ -42,7 +42,7 @@ export type CallingHandlers = {
   onHangUp: () => Promise<void>;
   onCreateLocalStreamView: (options?: VideoStreamOptions) => Promise<void>;
   onCreateRemoteStreamView: (userId: string, options?: VideoStreamOptions) => Promise<void>;
-  onParticipantRemove: (userId: string) => Promise<void>;
+  onRemoveParticipant: (userId: string) => Promise<void>;
   onDisposeRemoteStreamView: (userId: string) => Promise<void>;
   onDisposeLocalStreamView: () => Promise<void>;
 };
@@ -284,7 +284,7 @@ export const createDefaultCallingHandlers = memoizeOne(
       await disposeAllLocalPreviewViews(callClient);
     };
 
-    const onParticipantRemove = async (userId: string): Promise<void> => {
+    const onRemoveParticipant = async (userId: string): Promise<void> => {
       await call?.removeParticipant(fromFlatCommunicationIdentifier(userId));
     };
 
@@ -301,7 +301,7 @@ export const createDefaultCallingHandlers = memoizeOne(
       onToggleScreenShare,
       onCreateLocalStreamView,
       onCreateRemoteStreamView,
-      onParticipantRemove,
+      onRemoveParticipant,
       onStartLocalVideo,
       onDisposeRemoteStreamView,
       onDisposeLocalStreamView

diff --git a/packages/calling-stateful-client/review/calling-stateful-client.api.md b/packages/calling-stateful-client/review/calling-stateful-client.api.md
@@ -127,7 +127,7 @@ export interface DiagnosticsCallFeatureState {
 export interface IncomingCallState {
     callEndReason?: CallEndReason;
     callerInfo: CallerInfo;
-    endTime: Date | undefined;
+    endTime?: Date;
     id: string;
     startTime: Date;
 }

diff --git a/packages/calling-stateful-client/src/CallClientState.ts b/packages/calling-stateful-client/src/CallClientState.ts
@@ -368,7 +368,7 @@ export interface IncomingCallState {
    * Stores the local date when the call ended on the client. This property is added by the stateful layer and is not a
    * proxy of SDK state. It is undefined if the call is not ended yet.
    */
-  endTime: Date | undefined;
+  endTime?: Date;
 }
 
 /**

diff --git a/packages/chat-component-bindings/review/chat-component-bindings.api.md b/packages/chat-component-bindings/review/chat-component-bindings.api.md
@@ -41,7 +41,7 @@ export type ChatHandlers = {
     onSendMessage: (content: string) => Promise<void>;
     onMessageSeen: (chatMessageId: string) => Promise<void>;
     onTyping: () => Promise<void>;
-    onParticipantRemove: (userId: string) => Promise<void>;
+    onRemoveParticipant: (userId: string) => Promise<void>;
     updateThreadTopicName: (topicName: string) => Promise<void>;
     onLoadPreviousChatMessages: (messagesToLoad: number) => Promise<boolean>;
     onUpdateMessage: (messageId: string, content: string) => Promise<void>;

diff --git a/packages/chat-component-bindings/src/errorBarSelector.ts b/packages/chat-component-bindings/src/errorBarSelector.ts
@@ -61,7 +61,7 @@ export const errorBarSelector: ErrorBarSelector = createSelector(
       if (error !== undefined) {
         if (sendMessageError !== undefined) {
           activeErrorMessages.push({
-            type: 'sendMessageNotInThisThread',
+            type: 'sendMessageNotInChatThread',
             // Set the latest timestamp of all the errors that translated to an active error.
             timestamp:
               sendMessageError.timestamp > (error.timestamp ?? 0) ? sendMessageError.timestamp : error.timestamp
@@ -106,7 +106,7 @@ const latestAccessDeniedError = (latestErrors: ChatErrors): ActiveErrorMessage |
 };
 
 const latestNotInThisThreadError = (latestErrors: ChatErrors): ActiveErrorMessage | undefined => {
-  return latestActiveErrorSatisfying(latestErrors, 'userNotInThisThread', (error: ChatError): boolean => {
+  return latestActiveErrorSatisfying(latestErrors, 'userNotInChatThread', (error: ChatError): boolean => {
     if (!error || !error.innerError) {
       return false;
     }

diff --git a/packages/chat-component-bindings/src/handlers/createHandlers.ts b/packages/chat-component-bindings/src/handlers/createHandlers.ts
@@ -20,7 +20,7 @@ export type ChatHandlers = {
   onSendMessage: (content: string) => Promise<void>;
   onMessageSeen: (chatMessageId: string) => Promise<void>;
   onTyping: () => Promise<void>;
-  onParticipantRemove: (userId: string) => Promise<void>;
+  onRemoveParticipant: (userId: string) => Promise<void>;
   updateThreadTopicName: (topicName: string) => Promise<void>;
   onLoadPreviousChatMessages: (messagesToLoad: number) => Promise<boolean>;
   onUpdateMessage: (messageId: string, content: string) => Promise<void>;
@@ -61,7 +61,7 @@ export const createDefaultChatHandlers = memoizeOne(
       onTyping: async () => {
         await chatThreadClient.sendTypingNotification();
       },
-      onParticipantRemove: async (userId: string) => {
+      onRemoveParticipant: async (userId: string) => {
         await chatThreadClient.removeParticipant(fromFlatCommunicationIdentifier(userId));
       },
       updateThreadTopicName: async (topicName: string) => {

diff --git a/packages/communication-react/review/communication-react.api.md b/packages/communication-react/review/communication-react.api.md
@@ -126,7 +126,7 @@ export type AzureCommunicationCallAdapterArgs = {
 
 // @public
 export type AzureCommunicationChatAdapterArgs = {
-    endpointUrl: string;
+    endpoint: string;
     userId: CommunicationUserIdentifier;
     displayName: string;
     credential: CommunicationTokenCredential;
@@ -135,7 +135,7 @@ export type AzureCommunicationChatAdapterArgs = {
 
 // @alpha
 export type AzureCommunicationMeetingAdapterArgs = {
-    endpointUrl: string;
+    endpoint: string;
     userId: CommunicationUserIdentifier;
     displayName: string;
     credential: CommunicationTokenCredential;
@@ -409,7 +409,7 @@ export type CallingHandlers = {
     onHangUp: () => Promise<void>;
     onCreateLocalStreamView: (options?: VideoStreamOptions) => Promise<void>;
     onCreateRemoteStreamView: (userId: string, options?: VideoStreamOptions) => Promise<void>;
-    onParticipantRemove: (userId: string) => Promise<void>;
+    onRemoveParticipant: (userId: string) => Promise<void>;
     onDisposeRemoteStreamView: (userId: string) => Promise<void>;
     onDisposeLocalStreamView: () => Promise<void>;
 };
@@ -624,7 +624,7 @@ export type ChatHandlers = {
     onSendMessage: (content: string) => Promise<void>;
     onMessageSeen: (chatMessageId: string) => Promise<void>;
     onTyping: () => Promise<void>;
-    onParticipantRemove: (userId: string) => Promise<void>;
+    onRemoveParticipant: (userId: string) => Promise<void>;
     updateThreadTopicName: (topicName: string) => Promise<void>;
     onLoadPreviousChatMessages: (messagesToLoad: number) => Promise<boolean>;
     onUpdateMessage: (messageId: string, content: string) => Promise<void>;
@@ -906,13 +906,13 @@ export const createAzureCommunicationCallAdapter: ({ userId, displayName, creden
 export const createAzureCommunicationCallAdapterFromClient: (callClient: StatefulCallClient, callAgent: CallAgent, locator: TeamsMeetingLinkLocator | GroupCallLocator) => Promise<CallAdapter>;
 
 // @public
-export const createAzureCommunicationChatAdapter: ({ endpointUrl, userId, displayName, credential, threadId }: AzureCommunicationChatAdapterArgs) => Promise<ChatAdapter>;
+export const createAzureCommunicationChatAdapter: ({ endpoint: endpointUrl, userId, displayName, credential, threadId }: AzureCommunicationChatAdapterArgs) => Promise<ChatAdapter>;
 
 // @public
 export const createAzureCommunicationChatAdapterFromClient: (chatClient: StatefulChatClient, chatThreadClient: ChatThreadClient) => Promise<ChatAdapter>;
 
 // @alpha
-export const createAzureCommunicationMeetingAdapter: ({ userId, displayName, credential, endpointUrl, chatThreadId, callLocator }: AzureCommunicationMeetingAdapterArgs) => Promise<MeetingAdapter>;
+export const createAzureCommunicationMeetingAdapter: ({ userId, displayName, credential, endpoint, chatThreadId, callLocator }: AzureCommunicationMeetingAdapterArgs) => Promise<MeetingAdapter>;
 
 // @public
 export const createDefaultCallingHandlers: (callClient: StatefulCallClient, callAgent: CallAgent | undefined, deviceManager: StatefulDeviceManager | undefined, call: Call | undefined) => CallingHandlers;
@@ -1113,14 +1113,14 @@ export interface ErrorBarStrings {
     callNoSpeakerFound: string;
     muteGeneric: string;
     sendMessageGeneric: string;
-    sendMessageNotInThisThread: string;
+    sendMessageNotInChatThread: string;
     startScreenShareGeneric: string;
     startVideoGeneric: string;
     stopScreenShareGeneric: string;
     stopVideoGeneric: string;
     unableToReachChatService: string;
     unmuteGeneric: string;
-    userNotInThisThread: string;
+    userNotInChatThread: string;
 }
 
 // @public
@@ -1191,7 +1191,7 @@ export interface _Identifiers {
 export interface IncomingCallState {
     callEndReason?: CallEndReason;
     callerInfo: CallerInfo;
-    endTime: Date | undefined;
+    endTime?: Date;
     id: string;
     startTime: Date;
 }
@@ -1403,7 +1403,7 @@ export type MessageProps = {
     strings: MessageThreadStrings;
     messageContainerStyle?: ComponentSlotStyle;
     showDate?: boolean;
-    editDisabled?: boolean;
+    disableEditing?: boolean;
     onUpdateMessage?: (messageId: string, content: string) => Promise<void>;
     onDeleteMessage?: (messageId: string) => Promise<void>;
 };
@@ -1466,7 +1466,7 @@ export type MessageThreadProps = {
     onRenderMessage?: (messageProps: MessageProps, messageRenderer?: MessageRenderer) => JSX.Element;
     onUpdateMessage?: (messageId: string, content: string) => Promise<void>;
     onDeleteMessage?: (messageId: string) => Promise<void>;
-    editDisabled?: boolean;
+    disableEditing?: boolean;
     strings?: Partial<MessageThreadStrings>;
 };
 
@@ -1660,7 +1660,7 @@ export type ParticipantListProps = {
     excludeMe?: boolean;
     onRenderParticipant?: (participant: CommunicationParticipant) => JSX.Element | null;
     onRenderAvatar?: OnRenderAvatarCallback;
-    onParticipantRemove?: (userId: string) => void;
+    onRemoveParticipant?: (userId: string) => void;
     onFetchParticipantMenuItems?: ParticipantMenuItemsCallback;
     styles?: ParticipantListStyles;
 };
@@ -1709,7 +1709,7 @@ export interface ParticipantsButtonProps extends ControlBarButtonProps {
     myUserId?: string;
     onFetchParticipantMenuItems?: ParticipantMenuItemsCallback;
     onMuteAll?: () => void;
-    onParticipantRemove?: (userId: string) => void;
+    onRemoveParticipant?: (userId: string) => void;
     onRenderAvatar?: OnRenderAvatarCallback;
     onRenderParticipant?: (participant: CommunicationParticipant) => JSX.Element | null;
     onRenderParticipantList?: (props: ParticipantListProps) => JSX.Element | null;

diff --git a/packages/react-components/review/react-components.api.md b/packages/react-components/review/react-components.api.md
@@ -317,14 +317,14 @@ export interface ErrorBarStrings {
     callNoSpeakerFound: string;
     muteGeneric: string;
     sendMessageGeneric: string;
-    sendMessageNotInThisThread: string;
+    sendMessageNotInChatThread: string;
     startScreenShareGeneric: string;
     startVideoGeneric: string;
     stopScreenShareGeneric: string;
     stopVideoGeneric: string;
     unableToReachChatService: string;
     unmuteGeneric: string;
-    userNotInThisThread: string;
+    userNotInChatThread: string;
 }
 
 // @public
@@ -425,7 +425,7 @@ export type MessageProps = {
     strings: MessageThreadStrings;
     messageContainerStyle?: ComponentSlotStyle;
     showDate?: boolean;
-    editDisabled?: boolean;
+    disableEditing?: boolean;
     onUpdateMessage?: (messageId: string, content: string) => Promise<void>;
     onDeleteMessage?: (messageId: string) => Promise<void>;
 };
@@ -471,7 +471,7 @@ export type MessageThreadProps = {
     onRenderMessage?: (messageProps: MessageProps, messageRenderer?: MessageRenderer) => JSX.Element;
     onUpdateMessage?: (messageId: string, content: string) => Promise<void>;
     onDeleteMessage?: (messageId: string) => Promise<void>;
-    editDisabled?: boolean;
+    disableEditing?: boolean;
     strings?: Partial<MessageThreadStrings>;
 };
 
@@ -631,7 +631,7 @@ export type ParticipantListProps = {
     excludeMe?: boolean;
     onRenderParticipant?: (participant: CommunicationParticipant) => JSX.Element | null;
     onRenderAvatar?: OnRenderAvatarCallback;
-    onParticipantRemove?: (userId: string) => void;
+    onRemoveParticipant?: (userId: string) => void;
     onFetchParticipantMenuItems?: ParticipantMenuItemsCallback;
     styles?: ParticipantListStyles;
 };
@@ -668,7 +668,7 @@ export interface ParticipantsButtonProps extends ControlBarButtonProps {
     myUserId?: string;
     onFetchParticipantMenuItems?: ParticipantMenuItemsCallback;
     onMuteAll?: () => void;
-    onParticipantRemove?: (userId: string) => void;
+    onRemoveParticipant?: (userId: string) => void;
     onRenderAvatar?: OnRenderAvatarCallback;
     onRenderParticipant?: (participant: CommunicationParticipant) => JSX.Element | null;
     onRenderParticipantList?: (props: ParticipantListProps) => JSX.Element | null;

diff --git a/packages/react-components/src/components/ChatMessageComponent.tsx b/packages/react-components/src/components/ChatMessageComponent.tsx
@@ -27,7 +27,7 @@ type ChatMessageProps = {
   message: ChatMessage;
   messageContainerStyle?: ComponentSlotStyle;
   showDate?: boolean;
-  editDisabled?: boolean;
+  disableEditing?: boolean;
   onUpdateMessage?: (messageId: string, content: string) => Promise<void>;
   onDeleteMessage?: (messageId: string) => Promise<void>;
   strings: MessageThreadStrings;
@@ -95,7 +95,7 @@ export const ChatMessageComponent = (props: ChatMessageProps): JSX.Element => {
   const ids = useIdentifiers();
   const theme = useTheme();
 
-  const { message, onUpdateMessage, onDeleteMessage, editDisabled, showDate, messageContainerStyle, strings } = props;
+  const { message, onUpdateMessage, onDeleteMessage, disableEditing, showDate, messageContainerStyle, strings } = props;
   const [isEditing, setIsEditing] = useState(false);
 
   const menuClass = mergeStyles(chatActionsCSS, {
@@ -170,7 +170,7 @@ export const ChatMessageComponent = (props: ChatMessageProps): JSX.Element => {
         message.editedOn ? <div className={chatMessageEditedTagStyle(theme)}>{strings.editedTag}</div> : undefined
       }
       positionActionMenu={false}
-      actionMenu={!editDisabled && message.status !== 'sending' && message.mine ? actionMenu : undefined}
+      actionMenu={!disableEditing && message.status !== 'sending' && message.mine ? actionMenu : undefined}
     />
   );
 };

diff --git a/packages/react-components/src/components/ErrorBar.tsx b/packages/react-components/src/components/ErrorBar.tsx
@@ -49,14 +49,14 @@ export interface ErrorBarStrings {
   /**
    * User is no longer on the thread.
    *
-   * See also: {@link ErrorBarStrings.sendMessageNotInThisThread} for a more specific error.
+   * See also: {@link ErrorBarStrings.sendMessageNotInChatThread} for a more specific error.
    */
-  userNotInThisThread: string;
+  userNotInChatThread: string;
 
   /**
    * Sending message failed because user is no longer on the thread.
    */
-  sendMessageNotInThisThread: string;
+  sendMessageNotInChatThread: string;
 
   /**
    * A generic message when sending message fails.
@@ -180,7 +180,7 @@ export interface ActiveErrorMessage {
  *
  * This component internally tracks dismissed by the user.
  *   * Errors that have an associated timestamp: The error is shown on the UI again if it occurs after being dismissed.
- *   * Errors that do not have a timestamp: The error is dismissed until it dissappears from the props.
+ *   * Errors that do not have a timestamp: The error is dismissed until it disappears from the props.
  *         If the error recurs, it is shown in the UI.
  *
  * Uses {@link @fluentui/react#MessageBar} UI element.