@azure/communication-signaling - npm Package Compare versions

Comparing version 1.0.0-beta.23 to 1.0.0-beta.24

package.json

 {
   "name": "@azure/communication-signaling",
-  "version": "1.0.0-beta.23",
+  "version": "1.0.0-beta.24",
   "description": "Azure Communication Signaling Client",
@@ -67,4 +67,4 @@ "sdk-type": "client",
     "@azure/eslint-plugin-azure-sdk": "^2.0.1",
-    "@microsoft/api-documenter": "~7.8.17",
-    "@microsoft/api-extractor": "^7.5.4",
+    "@microsoft/api-documenter": "~7.8.56",
+    "@microsoft/api-extractor": "^7.38.2",
     "@rollup/plugin-commonjs": "^11.0.1",
@@ -76,5 +76,5 @@ "@rollup/plugin-json": "^4.0.0",
     "@skype/tstrouter": "^2022.35.0-1.18-b759f",
-    "@types/mocha": "^9.0.0",
-    "@types/node": "^14.18.36",
-    "@types/sinon": "^7.5.1",
+    "@types/mocha": "^10.0.0",
+    "@types/node": "^20.9.0",
+    "@types/sinon": "^10.0.0",
     "@typescript-eslint/eslint-plugin": "^2.0.0",
@@ -85,3 +85,3 @@ "@typescript-eslint/parser": "^2.0.0",
     "chai": "^4.3.10",
-    "cross-env": "^6.0.3",
+    "cross-env": "^7.0.2",
     "eslint": "^6.8.0",
@@ -96,4 +96,4 @@ "eslint-config-prettier": "^6.0.0",
     "karma": "^6.3.10",
-    "karma-chrome-launcher": "^3.1.0",
-    "karma-coverage": "^2.0.1",
+    "karma-chrome-launcher": "^3.2.0",
+    "karma-coverage": "^2.2.1",
     "karma-edge-launcher": "^0.4.2",
@@ -105,10 +105,10 @@ "karma-env-preprocessor": "^0.1.1",
     "karma-mocha": "^2.0.1",
-    "karma-mocha-reporter": "^2.2.3",
+    "karma-mocha-reporter": "^2.2.5",
     "karma-remap-istanbul": "^0.0.2",
     "lodash": "^4.17.21",
     "minimist": "^1.2.6",
-    "mocha": "^9.1.3",
+    "mocha": "^10.0.0",
     "mocha-junit-reporter": "^1.23.1",
     "node-fetch": "^2.6.7",
-    "prettier": "^1.16.4",
+    "prettier": "^2.5.1",
     "rimraf": "^3.0.0",
@@ -120,5 +120,5 @@ "rollup": "^1.27.3",
     "sinon": "^7.5.0",
-    "ts-node": "^8.7.0",
-    "typescript": "~3.8.3"
+    "ts-node": "^10.0.0",
+    "typescript": "~5.2.0"
   }
 }

src/events/chat.ts

@@ -25,7 +25,2 @@ // Copyright (c) Microsoft Corporation.
   shareHistoryTime?: Date;
-
-  /**
-   * Metadata of the participant.
-   */
-  metadata: Record<string, string>;
 }
@@ -41,7 +36,2 @@
   topic: string;
-
-  /**
-   * Metadata of the thread.
-   */
-  metadata: Record<string, string>;
 }
@@ -48,0 +38,0 @@

src/SignalingClient.ts

@@ -52,3 +52,3 @@ // Copyright (c) Microsoft Corporation.
 
-export const enum ConnectionState  {
+export const enum ConnectionState {
   Unknown = 0,
@@ -64,3 +64,2 @@ Connected = 2,
   resourceEndpoint?: string;
-  gatewayApiVersion?: string;
 }
@@ -72,4 +71,4 @@
   BaseChatMessageEvent,
+  ChatAttachmentType,
   ChatAttachment,
-  ChatAttachmentType,
   ChatMessageReceivedEvent,
@@ -177,3 +176,2 @@ ChatMessageEditedEvent,
   private resourceEndpoint: string;
-  private gatewayApiVersion: string;
 
@@ -190,3 +188,2 @@ constructor(
     this.resourceEndpoint = this.options?.resourceEndpoint || "";
-    this.gatewayApiVersion = this.options?.gatewayApiVersion || "2023-11-07"
     if (this.config === undefined) {
@@ -266,4 +263,4 @@ this.config = {
     }
-    this.trouter.registerMessageHandler(toMessageHandler(event, listener, this.resourceEndpoint, this.gatewayApiVersion));
+    this.trouter.registerMessageHandler(toMessageHandler(event, listener, this.resourceEndpoint));
   }
 }

src/TrouterNotificationPayload.ts

@@ -66,10 +66,4 @@ // Copyright (c) Microsoft Corporation.
   shareHistoryTime?: string;
-  memberMetaData?: string;
 }
 
-export interface ChatThreadPropertiesPayload {
-  topic: string;
-  acsChatThreadMetadata?: string;
-}
-
 export interface ChatThreadCreatedPayload extends ChatThreadPayload {
@@ -76,0 +70,0 @@ createTime: string;

src/TrouterSettings.ts

@@ -26,3 +26,3 @@ // Copyright (c) Microsoft Corporation.
   pnhAppId: "AcsWeb",
-  pnhTemplate: "AcsWeb_Chat_1.8",
+  pnhTemplate: "AcsWeb_Chat_1.7",
   platform: "SPOOL",
@@ -56,3 +56,3 @@ platformUIVersion: "0.0.0",
   settings.pnhAppId = "cns-e2e-test";
-  settings.pnhTemplate = "cns-e2e-test:1.6";
+  settings.pnhTemplate = "cns-e2e-test:1.7";
   settings.registrarServiceUrl = INT_REGISTRAR_SERVICE_URL;
@@ -59,0 +59,0 @@ settings.trouterServiceUrl = INT_TROUTER_SERVICE_URL;

src/TrouterUtils.ts

@@ -25,4 +25,3 @@ // Copyright (c) Microsoft Corporation.
   ParticipantsRemovedPayload,
-  ChatParticipantPayload,
-  ChatThreadPropertiesPayload
+  ChatParticipantPayload
 } from "./TrouterNotificationPayload";
@@ -81,4 +80,3 @@ import {
   listener: (payload: any) => any,
-  resourceEndpoint: string,
-  gatewayApiVersion: string
+  resourceEndpoint: string
 ): MessageHandler => {
@@ -95,3 +93,3 @@ const eventId = eventIds.get(event);
       }
-      const eventPayload = toEventPayload(event, genericPayload, resourceEndpoint, gatewayApiVersion);
+      const eventPayload = toEventPayload(event, genericPayload, resourceEndpoint);
       if (eventPayload === null) {
@@ -106,3 +104,3 @@ return undefined;
 
-const toEventPayload = (event: ChatEventId, genericPayload: any, resourceEndpoint: string, gatewayApiVersion: string): any => {
+const toEventPayload = (event: ChatEventId, genericPayload: any, resourceEndpoint: string): any => {
   if (event === "chatMessageReceived") {
@@ -123,4 +121,3 @@ const payload = genericPayload as MessageReceivedPayload;
         (parseJsonString(payload.attachments) as ChatAttachment[]) || [],
-        resourceEndpoint, 
-        gatewayApiVersion
+        resourceEndpoint
       )
@@ -147,4 +144,3 @@ };
         (parseJsonString(payload.attachments) as ChatAttachment[]) || [],
-        resourceEndpoint,
-        gatewayApiVersion
+        resourceEndpoint
       )
@@ -203,5 +199,13 @@ };
     const membersPayload = JSON.parse(unescape(payload.members)) as ChatParticipantPayload[];
-    const createdBy = toChatParticipant(createdByPayload);
+    const propertiesPayload = JSON.parse(unescape(payload.properties)) as ChatThreadProperties;
+    const createdBy: ChatParticipant = {
+      id: constructIdentifierKindFromMri(createdByPayload.participantId),
+      displayName: createdByPayload.displayName
+    };
+
     const chatParticipants: ChatParticipant[] = membersPayload.map((m) => {
-      return toChatParticipant(m);
+      return {
+        id: constructIdentifierKindFromMri(m.participantId),
+        displayName: m.displayName
+      };
     });
@@ -214,5 +218,3 @@ const eventPayload: ChatThreadCreatedEvent = {
       participants: chatParticipants,
-      properties: toThreadProperties(
-        JSON.parse(unescape(payload.properties)) as ChatThreadPropertiesPayload
-      )
+      properties: propertiesPayload
     };
@@ -225,3 +227,7 @@ return eventPayload;
     const updatedByPayload = JSON.parse(unescape(payload.editedBy)) as ChatParticipantPayload;
-    const updatedBy = toChatParticipant(updatedByPayload);
+    const propertiesPayload = JSON.parse(unescape(payload.properties)) as ChatThreadProperties;
+    const updatedBy: ChatParticipant = {
+      id: constructIdentifierKindFromMri(updatedByPayload.participantId),
+      displayName: updatedByPayload.displayName
+    };
     const eventPayload: ChatThreadPropertiesUpdatedEvent = {
@@ -232,5 +238,3 @@ threadId: payload.threadId,
       version: payload.version,
-      properties: toThreadProperties(
-        JSON.parse(unescape(payload.properties)) as ChatThreadPropertiesPayload
-      )
+      properties: propertiesPayload
     };
@@ -242,5 +246,7 @@ return eventPayload;
     const payload = genericPayload as ChatThreadDeletedPayload;
-    const deletedBy = toChatParticipant(
-      JSON.parse(unescape(payload.deletedBy)) as ChatParticipantPayload
-    );
+    const deletedByPayload = JSON.parse(unescape(payload.deletedBy)) as ChatParticipantPayload;
+    const deletedBy: ChatParticipant = {
+      id: constructIdentifierKindFromMri(deletedByPayload.participantId),
+      displayName: deletedByPayload.displayName
+    };
     const eventPayload: ChatThreadDeletedEvent = {
@@ -261,5 +267,13 @@ threadId: payload.threadId,
     ) as ChatParticipantPayload[];
-    const addedBy = toChatParticipant(addedByPayload);
+    const addedBy: ChatParticipant = {
+      id: constructIdentifierKindFromMri(addedByPayload.participantId),
+      displayName: addedByPayload.displayName
+    };
+
     const chatParticipants: ChatParticipant[] = participantsAddedPayload.map((m) => {
-      return toChatParticipant(m);
+      return {
+        id: constructIdentifierKindFromMri(m.participantId),
+        displayName: m.displayName,
+        shareHistoryTime: new Date(m.shareHistoryTime)
+      };
     });
@@ -282,5 +296,12 @@ const eventPayload: ParticipantsAddedEvent = {
     ) as ChatParticipantPayload[];
-    const removedBy = toChatParticipant(removedByPayload);
+    const removedBy: ChatParticipant = {
+      id: constructIdentifierKindFromMri(removedByPayload.participantId),
+      displayName: removedByPayload.displayName
+    };
     const chatParticipants: ChatParticipant[] = participantsRemovedPayload.map((m) => {
-      return toChatParticipant(m);
+      return {
+        id: constructIdentifierKindFromMri(m.participantId),
+        displayName: m.displayName,
+        shareHistoryTime: new Date(m.shareHistoryTime)
+      };
     });
@@ -300,23 +321,2 @@ const eventPayload: ParticipantsRemovedEvent = {
 
-const toChatParticipant = (payload: ChatParticipantPayload): ChatParticipant => {
-  const participant: ChatParticipant = {
-    id: constructIdentifierKindFromMri(payload.participantId),
-    displayName: payload.displayName,
-    metadata: (parseJsonString(payload.memberMetaData ?? "") as Record<string, string>) || {}
-  };
-
-  if (payload.shareHistoryTime) {
-    participant.shareHistoryTime = new Date(payload.shareHistoryTime);
-  }
-
-  return participant;
-};
-
-const toThreadProperties = (payload: ChatThreadPropertiesPayload): ChatThreadProperties => {
-  return {
-    topic: payload.topic,
-    metadata: (parseJsonString(payload.acsChatThreadMetadata ?? "") as Record<string, string>) || {}
-  };
-};
-
 export const toLogProvider = (logger: AzureLogger): LogProvider => {
@@ -404,6 +404,7 @@ return {
 
-const createMediaUrlString = (urlString: string, resourceEndpoint: string, gatewayApiVersion: string): string => {
+const createMediaUrlString = (urlString: string, resourceEndpoint: string): string => {
   let url: URL | undefined;
   try {
     url = new URL(urlString);
+    const queryString = url.search;
   
@@ -413,2 +414,3 @@ if (url.protocol === "http:" || url.protocol === "https:") {
       url = new URL(url.pathname, resourceEndpoint);
+      url.search = queryString;
     }
@@ -425,5 +427,2 @@ } catch (_) {
   }
-
-  // Append api-version query and return string
-  url.searchParams.set('api-version', gatewayApiVersion);
   return url.toString();
@@ -444,4 +443,3 @@ };
   attachments: ChatAttachment[],
-  resourceEndpoint: string,
-  gatewayApiVersion: string
+  resourceEndpoint: string
 ): ChatAttachment[] => {
@@ -460,6 +458,6 @@ if (
       if (attachment.previewUrl) {
-        attachment.previewUrl = createMediaUrlString(attachment.previewUrl, resourceEndpoint, gatewayApiVersion);
+        attachment.previewUrl = createMediaUrlString(attachment.previewUrl, resourceEndpoint);
       }
       if (attachment.url) {
-        attachment.url = createMediaUrlString(attachment.url, resourceEndpoint, gatewayApiVersion);
+        attachment.url = createMediaUrlString(attachment.url, resourceEndpoint);
       }
@@ -466,0 +464,0 @@ });

types/src/events/chat.d.ts

@@ -19,6 +19,2 @@ import { CommunicationIdentifierKind } from "./identifierModels";
     shareHistoryTime?: Date;
-    /**
-     * Metadata of the participant.
-     */
-    metadata: Record<string, string>;
 }
@@ -33,6 +29,2 @@ /**
     topic: string;
-    /**
-     * Metadata of the thread.
-     */
-    metadata: Record<string, string>;
 }
@@ -39,0 +31,0 @@ /** Defines values for AttachmentType. */

types/src/SignalingClient.d.ts

@@ -15,5 +15,4 @@ import { ChatEventId, BaseChatEvent, BaseChatMessageEvent, ChatMessageReceivedEvent, ChatMessageEditedEvent, ChatMessageDeletedEvent, ReadReceiptReceivedEvent, TypingIndicatorReceivedEvent, BaseChatThreadEvent, ChatParticipant, ChatAttachment, ChatAttachmentType, ChatThreadProperties, ChatThreadCreatedEvent, ChatThreadDeletedEvent, ChatThreadPropertiesUpdatedEvent, ParticipantsAddedEvent, ParticipantsRemovedEvent } from "./events/chat";
     resourceEndpoint?: string;
-    gatewayApiVersion?: string;
 }
-export { ChatEventId, BaseChatEvent, BaseChatMessageEvent, ChatAttachment, ChatAttachmentType, ChatMessageReceivedEvent, ChatMessageEditedEvent, ChatMessageDeletedEvent, ReadReceiptReceivedEvent, TypingIndicatorReceivedEvent, BaseChatThreadEvent, ChatParticipant, ChatThreadProperties, ChatThreadCreatedEvent, ChatThreadDeletedEvent, ChatThreadPropertiesUpdatedEvent, ParticipantsAddedEvent, ParticipantsRemovedEvent, CommunicationIdentifier, CommunicationUserIdentifier, PhoneNumberIdentifier, MicrosoftTeamsUserIdentifier, UnknownIdentifier, CommunicationIdentifierKind, CommunicationUserKind, PhoneNumberKind, MicrosoftTeamsUserKind, MicrosoftTeamsAppKind, MicrosoftTeamsAppIdentifier, UnknownIdentifierKind };
+export { ChatEventId, BaseChatEvent, BaseChatMessageEvent, ChatAttachmentType, ChatAttachment, ChatMessageReceivedEvent, ChatMessageEditedEvent, ChatMessageDeletedEvent, ReadReceiptReceivedEvent, TypingIndicatorReceivedEvent, BaseChatThreadEvent, ChatParticipant, ChatThreadProperties, ChatThreadCreatedEvent, ChatThreadDeletedEvent, ChatThreadPropertiesUpdatedEvent, ParticipantsAddedEvent, ParticipantsRemovedEvent, CommunicationIdentifier, CommunicationUserIdentifier, PhoneNumberIdentifier, MicrosoftTeamsUserIdentifier, UnknownIdentifier, CommunicationIdentifierKind, CommunicationUserKind, PhoneNumberKind, MicrosoftTeamsUserKind, MicrosoftTeamsAppKind, MicrosoftTeamsAppIdentifier, UnknownIdentifierKind };
 export interface CommunicationGetTokenOptions {
@@ -88,3 +87,2 @@ abortSignal?: AbortSignalLike;
     private resourceEndpoint;
-    private gatewayApiVersion;
     constructor(credential: CommunicationTokenCredential, logger: AzureLogger, options?: SignalingClientOptions);
@@ -91,0 +89,0 @@ start(): Promise<void>;

types/src/TrouterNotificationPayload.d.ts

@@ -55,8 +55,3 @@ export interface BasePayload {
     shareHistoryTime?: string;
-    memberMetaData?: string;
 }
-export interface ChatThreadPropertiesPayload {
-    topic: string;
-    acsChatThreadMetadata?: string;
-}
 export interface ChatThreadCreatedPayload extends ChatThreadPayload {
@@ -63,0 +58,0 @@ createTime: string;

types/src/TrouterUtils.d.ts

@@ -6,3 +6,3 @@ import { MessageHandler, LogProvider, ITelemetrySender } from "@skype/tstrouter";
 import { CloudType } from "./constants";
-export declare const toMessageHandler: (event: ChatEventId, listener: (payload: any) => any, resourceEndpoint: string, gatewayApiVersion: string) => MessageHandler;
+export declare const toMessageHandler: (event: ChatEventId, listener: (payload: any) => any, resourceEndpoint: string) => MessageHandler;
 export declare const toLogProvider: (logger: AzureLogger) => LogProvider;
@@ -9,0 +9,0 @@ export declare const toTelemetrySender: (logger: AzureLogger) => ITelemetrySender;

types/template.d.ts

@@ -148,6 +148,2 @@ import { AbortSignalLike } from '@azure/core-http';
     shareHistoryTime?: Date;
-    /**
-     * Metadata of the participant.
-     */
-    metadata: Record<string, string>;
 }
@@ -203,6 +199,2 @@
     topic: string;
-    /**
-     * Metadata of the thread.
-     */
-    metadata: Record<string, string>;
 }
@@ -253,3 +245,2 @@
     private resourceEndpoint;
-    private gatewayApiVersion;
     constructor(credential: CommunicationTokenCredential, logger: AzureLogger, options?: SignalingClientOptions);
@@ -499,3 +490,2 @@ start(): Promise<void>;
     resourceEndpoint?: string;
-    gatewayApiVersion?: string;
 }
@@ -502,0 +492,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Deprecated

Maintenance

The maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

3140436

decreased by-0.04%

Lines of code

12227

decreased by-0.18%

Number of medium maintenance alerts

1

increased byInfinity%

No dependency changes