@trycourier/courier-js 2.0.12 → 2.1.1

package/dist/index.mjs

@@ -89,6 +89,10 @@ const _UUID = class _UUID {
 };
 __publicField(_UUID, "ALPHABET", "useandom-26T198340PX75pxJACKVERYMINDBUSHWOLF_GQZbfghjklqvwyzrict");
 let UUID = _UUID;
+const HTTP_HEADER_KEY = "x-courier-ua";
+const SDK_KEY = "sdk";
+const SDK_VERSION_KEY = "sdkv";
+const CLIENT_ID_KEY = "cid";
 class CourierRequestError extends Error {
   constructor(code, message, type) {
     super(message);
@@ -118,10 +122,12 @@ Response JSON: ${JSON.stringify(data.response, null, 2)}
 async function http(props) {
   const validCodes = props.validCodes ?? [200];
   const uid = props.options.showLogs ? UUID.nanoid() : void 0;
+  const courierUserAgentHeader = props.options.courierUserAgent.toHttpHeaderValue();
   const request = new Request(props.url, {
     method: props.method,
     headers: {
       "Content-Type": "application/json",
+      [HTTP_HEADER_KEY]: courierUserAgentHeader,
       ...props.headers
     },
     body: props.body ? JSON.stringify(props.body) : void 0
@@ -168,6 +174,7 @@ async function http(props) {
 }
 async function graphql(props) {
   const uid = props.options.showLogs ? UUID.nanoid() : void 0;
+  const courierUserAgentHeader = props.options.courierUserAgent.toHttpHeaderValue();
   if (uid) {
     logRequest(props.options.logger, uid, "GraphQL", {
       url: props.url,
@@ -180,6 +187,7 @@ async function graphql(props) {
     method: "POST",
     headers: {
       "Content-Type": "application/json",
+      [HTTP_HEADER_KEY]: courierUserAgentHeader,
       ...props.headers
     },
     body: JSON.stringify({
@@ -376,6 +384,9 @@ const _CourierSocket = class _CourierSocket {
   get logger() {
     return this.options.logger;
   }
+  get courierUserAgent() {
+    return this.options.courierUserAgent;
+  }
   /**
    * Whether the WebSocket connection is currently being established.
    */
@@ -398,7 +409,9 @@ const _CourierSocket = class _CourierSocket {
     const accessToken = this.options.accessToken;
     const connectionId = this.options.connectionId;
     const userId = this.userId;
-    return `${this.url}?auth=${accessToken}&cid=${connectionId}&iwpv=${INBOX_WIRE_PROTOCOL_VERSION}&userId=${userId}`;
+    const sdkName = this.courierUserAgent.getUserAgentInfo()[SDK_KEY];
+    const sdkVersion = this.courierUserAgent.getUserAgentInfo()[SDK_VERSION_KEY];
+    return `${this.url}?auth=${accessToken}&cid=${connectionId}&iwpv=${INBOX_WIRE_PROTOCOL_VERSION}&userId=${userId}&${SDK_KEY}=${sdkName}&${SDK_VERSION_KEY}=${sdkVersion}`;
   }
   /**
    * Parses the Retry-After time from the WebSocket close event reason,
@@ -711,9 +724,13 @@ const _CourierInboxSocket = class _CourierInboxSocket extends CourierSocket {
    * from the Courier WebSocket server.
    *
    * @param listener The listener function
+   * @returns A function that can be called to remove this specific listener
    */
   addMessageEventListener(listener) {
     this.messageEventListeners.push(listener);
+    return () => {
+      this.removeMessageEventListener(listener);
+    };
   }
   /**
    * Send a ping message to the server.
@@ -792,7 +809,20 @@ const _CourierInboxSocket = class _CourierInboxSocket extends CourierSocket {
    * Removes all message event listeners.
    */
   clearMessageEventListeners() {
-    this.messageEventListeners = [];
+    while (this.messageEventListeners.length > 0) {
+      this.messageEventListeners.pop();
+    }
+  }
+  /**
+   * Remove the message event listener specified.
+   *
+   * This is the same listener function passed to {@link addMessageEventListener}.
+   */
+  removeMessageEventListener(listener) {
+    const index = this.messageEventListeners.indexOf(listener);
+    if (index > -1) {
+      this.messageEventListeners.splice(index, 1);
+    }
   }
   static isInboxMessageEvent(event) {
     return Object.values(InboxMessageEvent).includes(event);
@@ -1425,19 +1455,52 @@ class TrackingClient extends Client {
     });
   }
 }
-class CourierClient extends Client {
+class CourierUserAgent {
+  /**
+   * Create User Agent info
+   * @param clientId client ID for this session
+   * @param sdkName identifier of the SDK making requests to the Courier backend
+   * @param sdkVersion version of the SDK making requests to the Courier backend
+   */
+  constructor(clientId, sdkName, sdkVersion) {
+    this.clientId = clientId;
+    this.sdkName = sdkName;
+    this.sdkVersion = sdkVersion;
+  }
+  /** Get the telemetry payload as a JSON-serializable object. */
+  getUserAgentInfo() {
+    return {
+      [SDK_KEY]: this.sdkName,
+      [SDK_VERSION_KEY]: this.sdkVersion,
+      [CLIENT_ID_KEY]: this.clientId
+    };
+  }
+  /** Get the telemetry payload as a comma-separated string, where keys and values are joined by `=`. */
+  toHttpHeaderValue() {
+    return Object.entries(this.getUserAgentInfo()).map(([key, value]) => `${key}=${value}`).join(",");
+  }
+}
+const _CourierClient = class _CourierClient extends Client {
   constructor(props) {
     var _a, _b;
     const showLogs = props.showLogs !== void 0 ? props.showLogs : false;
+    const connectionId = UUID.nanoid();
     const baseOptions = {
       ...props,
       showLogs,
+      connectionId,
       apiUrls: props.apiUrls || getCourierApiUrls(),
       accessToken: props.jwt ?? props.publicApiKey
     };
+    const courierUserAgent = new CourierUserAgent(
+      connectionId,
+      props.courierUserAgentName || _CourierClient.COURIER_JS_NAME,
+      props.courierUserAgentVersion || _CourierClient.COURIER_JS_VERSION
+    );
     super({
       ...baseOptions,
       logger: new Logger(baseOptions.showLogs),
+      courierUserAgent,
       apiUrls: getCourierApiUrls(baseOptions.apiUrls)
     });
     __publicField(this, "tokens");
@@ -1466,7 +1529,15 @@ class CourierClient extends Client {
       );
     }
   }
-}
+};
+/** User-agent reporting name of the courier-js package. */
+__publicField(_CourierClient, "COURIER_JS_NAME", "courier-js");
+/**
+ * User agent reporting version of the courier-js package.
+ * Inlined from package.json at build time.
+ */
+__publicField(_CourierClient, "COURIER_JS_VERSION", "2.1.1");
+let CourierClient = _CourierClient;
 class AuthenticationListener {
   constructor(callback) {
     __publicField(this, "callback");
@@ -1486,6 +1557,18 @@ const _Courier = class _Courier {
      * The Courier client instance
      */
     __publicField(this, "instanceClient");
+    /**
+     * Client's name reported in the user agent to the Courier backend.
+     *
+     * Other Courier SDKs calling APIs though the courier-js should set this property.
+     */
+    __publicField(this, "courierUserAgentName");
+    /**
+     * Client's version reported in the user agent to the Courier backend.
+     *
+     * Other Courier SDKs calling APIs though the courier-js should set this property.
+     */
+    __publicField(this, "courierUserAgentVersion");
     /**
      * The pagination limit (min: 1, max: 100)
      */
@@ -1527,8 +1610,11 @@ const _Courier = class _Courier {
       this.instanceClient.options.logger.warn("Sign in called but there is already a user signed in. Signing out the current user.");
       this.signOut();
     }
-    const connectionId = props.connectionId ?? UUID.nanoid();
-    this.instanceClient = new CourierClient({ ...props, connectionId });
+    this.instanceClient = new CourierClient({
+      ...props,
+      courierUserAgentName: this.courierUserAgentName,
+      courierUserAgentVersion: this.courierUserAgentVersion
+    });
     this.notifyAuthenticationListeners({ userId: props.userId });
   }
   /**