@trycourier/courier-js 2.1.3 → 3.0.0

package/dist/index.mjs

@@ -857,13 +857,18 @@ class InboxClient extends Client {
    * @returns Promise resolving to paginated messages response
    */
   async getMessages(props) {
+    const filter = (props == null ? void 0 : props.filter) || {};
+    const filterParams = this.createFilterParams(filter);
+    const unreadCountFilterParams = this.createUnreadCountFilterParams(filter);
     const query = `
       query GetInboxMessages(
-        $params: FilterParamsInput = { ${this.options.tenantId ? `accountId: "${this.options.tenantId}"` : ""} }
+        $params: FilterParamsInput = ${filterParams}
+        $unreadCountParams: FilterParamsInput = ${unreadCountFilterParams}
         $limit: Int = ${(props == null ? void 0 : props.paginationLimit) ?? 24}
         $after: String ${(props == null ? void 0 : props.startCursor) ? `= "${props.startCursor}"` : ""}
       ) {
-        count(params: $params)
+        count: count(params: $params)
+        unreadCount: count(params: $unreadCountParams)
         messages(params: $params, limit: $limit, after: $after) {
           totalCount
           pageInfo {
@@ -903,48 +908,42 @@ class InboxClient extends Client {
     });
   }
   /**
-   * Get paginated archived messages
-   * @param paginationLimit - Number of messages to return per page (default: 24)
-   * @param startCursor - Cursor for pagination
-   * @returns Promise resolving to paginated archived messages response
+   * Get unread counts for multiple filters in a single query.
+   *
+   * @param filtersMap - Map of dataset ID to filter
+   * @returns Promise resolving to map of dataset ID to unread count
    */
-  async getArchivedMessages(props) {
+  async getUnreadCounts(filtersMap) {
+    const result = {};
+    const filtersToQuery = {};
+    for (const [datasetId, filter] of Object.entries(filtersMap)) {
+      if (filter.status === "read") {
+        result[datasetId] = 0;
+      } else {
+        filtersToQuery[datasetId] = filter;
+      }
+    }
+    if (Object.keys(filtersToQuery).length === 0) {
+      return result;
+    }
+    const variables = [];
+    const fields = [];
+    const sanitizedIdMapping = {};
+    for (const [datasetId, filter] of Object.entries(filtersToQuery)) {
+      const sanitizedId = InboxClient.sanitizeGraphQLIdentifier(datasetId);
+      sanitizedIdMapping[sanitizedId] = datasetId;
+      const unreadCountFilterParams = this.createUnreadCountFilterParams(filter);
+      variables.push(`$${sanitizedId}: FilterParamsInput = ${unreadCountFilterParams}`);
+      fields.push(`${sanitizedId}: count(params: $${sanitizedId})`);
+    }
     const query = `
-      query GetInboxMessages(
-        $params: FilterParamsInput = { ${this.options.tenantId ? `accountId: "${this.options.tenantId}"` : ""}, archived: true }
-        $limit: Int = ${(props == null ? void 0 : props.paginationLimit) ?? 24}
-        $after: String ${(props == null ? void 0 : props.startCursor) ? `= "${props.startCursor}"` : ""}
+      query GetUnreadCounts(
+        ${variables.join("\n")}
       ) {
-        count(params: $params)
-        messages(params: $params, limit: $limit, after: $after) {
-          totalCount
-          pageInfo {
-            startCursor
-            hasNextPage
-          }
-          nodes {
-            messageId
-            read
-            archived
-            created
-            opened
-            title
-            preview
-            data
-            tags
-            trackingIds {
-              clickTrackingId
-            }
-            actions {
-              content
-              data
-              href
-            }
-          }
-        }
+        ${fields.join("\n")}
       }
     `;
-    return graphql({
+    const response = await graphql({
       options: this.options,
       query,
       headers: {
@@ -953,6 +952,27 @@ class InboxClient extends Client {
       },
       url: this.options.apiUrls.inbox.graphql
     });
+    if (response.data) {
+      for (const [sanitizedId, originalId] of Object.entries(sanitizedIdMapping)) {
+        result[originalId] = response.data[sanitizedId] ?? 0;
+      }
+    }
+    return result;
+  }
+  /**
+   * Get paginated archived messages
+   * @param paginationLimit - Number of messages to return per page (default: 24)
+   * @param startCursor - Cursor for pagination
+   * @returns Promise resolving to paginated archived messages response
+   *
+   * @deprecated - replace usages with {@link InboxClient.getMessages}, passing the filter `{ archived: true }`
+   */
+  async getArchivedMessages(props) {
+    return this.getMessages({
+      paginationLimit: props == null ? void 0 : props.paginationLimit,
+      startCursor: props == null ? void 0 : props.startCursor,
+      filter: { archived: true }
+    });
   }
   /**
    * Get unread message count
@@ -1197,6 +1217,51 @@ class InboxClient extends Client {
       url: this.options.apiUrls.inbox.graphql
     });
   }
+  /**
+   * Create FilterParamsInput for the given filters.
+   *
+   * @param filter - the filtering options to include in the output
+   * @returns the FilterParamsInput to pass to a GraphQL query for messages
+   */
+  createFilterParams(filter) {
+    const parts = [];
+    if (this.options.tenantId) {
+      parts.push(`accountId: "${this.options.tenantId}"`);
+    }
+    if (filter.tags) {
+      parts.push(`tags: [${filter.tags.map((tag) => `"${tag}"`).join(",")}]`);
+    }
+    if (filter.status) {
+      parts.push(`status: "${filter.status}"`);
+    }
+    if (filter.archived) {
+      parts.push(`archived: ${filter.archived}`);
+    }
+    return `{ ${parts.join(",")} }`;
+  }
+  /**
+   * Create FilterParamsInput for the unread message count.
+   *
+   * The status: "unread" filter is only added if status is unset. This is because:
+   *  - If status is "unread", the params already include the filter that would be added.
+   *  - If status is "read", the unread count for the dataset would be a different set
+   *    of messages rather than a count of the unread subset.
+   */
+  createUnreadCountFilterParams(filter) {
+    if (!filter.status) {
+      return this.createFilterParams({ ...filter, status: "unread" });
+    }
+    return this.createFilterParams(filter);
+  }
+  /**
+   * Sanitize dataset IDs for use as GraphQL identifiers.
+   *
+   * GraphQL identifiers must contain only alphanumerics/underscores and begin with a letter or underscore.
+   * https://spec.graphql.org/draft/#sec-Names
+   */
+  static sanitizeGraphQLIdentifier(id) {
+    return `id_${id.replace(/_/g, "__").replace(/-/g, "_")}`;
+  }
 }
 class PreferenceTransformer {
   /**
@@ -1251,7 +1316,7 @@ class PreferenceClient extends Client {
    * Get all preferences for a user
    * @param paginationCursor - Optional cursor for pagination
    * @returns Promise resolving to user preferences
-   * @see https://www.courier.com/docs/reference/user-preferences/list-all-user-preferences
+   * @see https://www.courier.com/docs/api-reference/user-preferences/get-user-preferences
    */
   async getUserPreferences(props) {
     let url = `${this.options.apiUrls.courier.rest}/users/${this.options.userId}/preferences`;
@@ -1276,7 +1341,7 @@ class PreferenceClient extends Client {
    * Get preferences for a specific topic
    * @param topicId - The ID of the topic to get preferences for
    * @returns Promise resolving to topic preferences
-   * @see https://www.courier.com/docs/reference/user-preferences/get-subscription-topic-preferences
+   * @see https://www.courier.com/docs/api-reference/user-preferences/get-user-subscription-topic
    */
   async getUserPreferenceTopic(props) {
     const json = await http({
@@ -1297,7 +1362,7 @@ class PreferenceClient extends Client {
    * @param hasCustomRouting - Whether the topic has custom routing
    * @param customRouting - The custom routing channels for the topic
    * @returns Promise resolving when update is complete
-   * @see https://www.courier.com/docs/reference/user-preferences/update-subscription-topic-preferences
+   * @see https://www.courier.com/docs/api-reference/user-preferences/update-or-create-user-preferences-for-subscription-topic
    */
   async putUserPreferenceTopic(props) {
     const payload = {
@@ -1334,7 +1399,7 @@ class TokenClient extends Client {
    * @param token - The push notification token
    * @param provider - The provider of the token
    * @param device - The device information
-   * @see https://www.courier.com/docs/reference/token-management/put-token
+   * @see https://www.courier.com/docs/api-reference/device-tokens/add-single-token-to-user
    */
   async putUserToken(props) {
     const payload = {
@@ -1383,7 +1448,7 @@ class ListClient extends Client {
    * Subscribe a user to a list
    * @param listId - The ID of the list to subscribe to
    * @returns Promise resolving when subscription is complete
-   * @see https://www.courier.com/docs/reference/lists/recipient-subscribe
+   * @see https://www.courier.com/docs/api-reference/lists/subscribe-user-profile-to-list
    */
   async putSubscription(props) {
     return await http({
@@ -1399,7 +1464,7 @@ class ListClient extends Client {
    * Unsubscribe a user from a list
    * @param listId - The ID of the list to unsubscribe from
    * @returns Promise resolving when unsubscription is complete
-   * @see https://www.courier.com/docs/reference/lists/delete-subscription
+   * @see https://www.courier.com/docs/api-reference/lists/unsubscribe-user-profile-from-list
    */
   async deleteSubscription(props) {
     return await http({
@@ -1414,24 +1479,32 @@ class ListClient extends Client {
 }
 class TrackingClient extends Client {
   /**
-   * Post an inbound courier event
-   * @param event - The event type: Example: "New Order Placed"
-   * @param messageId - The message ID
-   * @param type - The type of event: Available options: "track"
-   * @param properties - The properties of the event
-   * @returns Promise resolving to the message ID
-   * @see https://www.courier.com/docs/reference/inbound/courier-track-event
+   * @deprecated This method is deprecated and will be removed or changed significantly in a future release.
+   *
+   * Post an inbound courier event. This is typically used for tracking custom events
+   * related to a specific message in Courier.
+   * 
+   * @param props - The event properties object containing:
+   *   - `clientKey`: The client key associated with your Courier project. 
+   *     You can get your client key here: https://app.courier.com/settings/api-keys
+   *   - `event`: The name of the event (e.g., "New Order Placed").
+   *   - `messageId`: The unique ID of the message this event relates to.
+   *   - `type`: The type of event. Only supported value: "track".
+   *   - `properties`: (Optional) Additional custom properties for the event.
+   * @returns Promise resolving to an object containing the messageId.
+   * @see https://www.courier.com/docs/api-reference/inbound/courier-track-event
    */
   async postInboundCourier(props) {
+    const { clientKey, ...bodyProps } = props;
     return await http({
       url: `${this.options.apiUrls.courier.rest}/inbound/courier`,
       options: this.options,
       method: "POST",
       headers: {
-        Authorization: `Bearer ${this.options.accessToken}`
+        "x-courier-client-key": clientKey
       },
       body: {
-        ...props,
+        ...bodyProps,
         userId: this.options.userId
       },
       validCodes: [200, 202]
@@ -1520,7 +1593,7 @@ const _CourierClient = class _CourierClient extends Client {
     }
     if (this.options.publicApiKey) {
       (_a = this.options.logger) == null ? void 0 : _a.warn(
-        "Courier Warning: Public API Keys are for testing only. Please use JWTs for production.\nYou can generate a JWT with this endpoint: https://www.courier.com/docs/reference/auth/issue-token\nThis endpoint should be called from your backend server, not the SDK."
+        "Courier Warning: Public API Keys are for testing only. Please use JWTs for production.\nYou can generate a JWT with this endpoint: https://www.courier.com/docs/api-reference/authentication/create-jwt\nThis endpoint should be called from your backend server, not the SDK."
       );
     }
     if (this.options.jwt && this.options.publicApiKey) {
@@ -1536,7 +1609,7 @@ __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.3");
+__publicField(_CourierClient, "COURIER_JS_VERSION", "3.0.0");
 let CourierClient = _CourierClient;
 class AuthenticationListener {
   constructor(callback) {