@trycourier/courier-js 2.0.0-beta → 2.0.2-beta

package/README.md

@@ -0,0 +1,22 @@
+# @trycourier/courier-js
+
+The base API client and shared instance singleton for Courier's JavaScript Browser SDK.
+
+## Installation
+
+```ts
+npm i @trycourier/courier-js@2.0.1-beta
+```
+
+## Usage
+
+```ts
+const courierClient = new CourierClient({
+    userId: 'mike',
+    jwt: 'ey...n0'
+});
+
+// Fetch the inbox messages for the user
+const messages = await courierClient.inbox.getMessages();
+console.log(messages);
+```

package/dist/client/brand-client.d.ts

@@ -3,6 +3,8 @@ import { Client } from './client';
 export declare class BrandClient extends Client {
     /**
      * Get a brand by ID using GraphQL
+     * @param brandId - The ID of the brand to retrieve
+     * @returns Promise resolving to the requested brand
      */
     getBrand(props: {
         brandId: string;

package/dist/client/courier-client.d.ts

@@ -23,10 +23,9 @@ export interface CourierClientOptions {
     readonly connectionId?: string;
     readonly tenantId?: string;
     readonly showLogs?: boolean;
-    readonly apiUrls?: CourierApiUrls;
     readonly accessToken?: string;
     readonly logger: Logger;
-    readonly urls: CourierApiUrls;
+    readonly apiUrls: CourierApiUrls;
 }
 export declare class CourierClient extends Client {
     readonly tokens: TokenClient;

package/dist/client/inbox-client.d.ts

@@ -7,6 +7,9 @@ export declare class InboxClient extends Client {
     constructor(options: CourierClientOptions);
     /**
      * Get paginated messages
+     * @param paginationLimit - Number of messages to return per page (default: 24)
+     * @param startCursor - Cursor for pagination
+     * @returns Promise resolving to paginated messages response
      */
     getMessages(props?: {
         paginationLimit?: number;
@@ -14,6 +17,9 @@ export declare class InboxClient extends Client {
     }): Promise<CourierGetInboxMessagesResponse>;
     /**
      * 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
      */
     getArchivedMessages(props?: {
         paginationLimit?: number;
@@ -21,10 +27,14 @@ export declare class InboxClient extends Client {
     }): Promise<CourierGetInboxMessagesResponse>;
     /**
      * Get unread message count
+     * @returns Promise resolving to number of unread messages
      */
     getUnreadMessageCount(): Promise<number>;
     /**
      * Track a click event
+     * @param messageId - ID of the message
+     * @param trackingId - ID for tracking the click
+     * @returns Promise resolving when click is tracked
      */
     click(props: {
         messageId: string;
@@ -32,30 +42,43 @@ export declare class InboxClient extends Client {
     }): Promise<void>;
     /**
      * Mark a message as read
+     * @param messageId - ID of the message to mark as read
+     * @returns Promise resolving when message is marked as read
      */
     read(props: {
         messageId: string;
     }): Promise<void>;
     /**
      * Mark a message as unread
+     * @param messageId - ID of the message to mark as unread
+     * @returns Promise resolving when message is marked as unread
      */
     unread(props: {
         messageId: string;
     }): Promise<void>;
     /**
      * Mark all messages as read
+     * @returns Promise resolving when all messages are marked as read
      */
     readAll(): Promise<void>;
     /**
      * Mark a message as opened
+     * @param messageId - ID of the message to mark as opened
+     * @returns Promise resolving when message is marked as opened
      */
     open(props: {
         messageId: string;
     }): Promise<void>;
     /**
      * Archive a message
+     * @param messageId - ID of the message to archive
+     * @returns Promise resolving when message is archived
      */
     archive(props: {
         messageId: string;
     }): Promise<void>;
+    /**
+     * Archive all read messages.
+     */
+    archiveRead(): Promise<void>;
 }

package/dist/client/list-client.d.ts

@@ -2,6 +2,8 @@ import { Client } from './client';
 export declare 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
      */
     putSubscription(props: {
@@ -9,6 +11,8 @@ export declare class ListClient extends Client {
     }): Promise<void>;
     /**
      * 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
      */
     deleteSubscription(props: {

package/dist/client/preference-client.d.ts

@@ -4,23 +4,32 @@ export declare class PreferenceClient extends Client {
     private transformer;
     /**
      * 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
      */
-    getUserPreferences(params?: {
+    getUserPreferences(props?: {
         paginationCursor?: string;
     }): Promise<CourierUserPreferences>;
     /**
      * 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
      */
-    getUserPreferenceTopic(params: {
+    getUserPreferenceTopic(props: {
         topicId: string;
     }): Promise<CourierUserPreferencesTopic>;
     /**
      * Update preferences for a specific topic
+     * @param topicId - The ID of the topic to update preferences for
+     * @param status - The new status for the topic
+     * @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
      */
-    putUserPreferenceTopic(params: {
+    putUserPreferenceTopic(props: {
         topicId: string;
         status: CourierUserPreferencesStatus;
         hasCustomRouting: boolean;
@@ -28,10 +37,10 @@ export declare class PreferenceClient extends Client {
     }): Promise<void>;
     /**
      * Get the notification center URL
-     * @param params
-     * @returns
+     * @param clientKey - The client key to use for the URL
+     * @returns The notification center URL
      */
-    getNotificationCenterUrl(params: {
+    getNotificationCenterUrl(props: {
         clientKey: string;
     }): string;
 }

package/dist/client/token-client.d.ts

@@ -3,6 +3,9 @@ import { Client } from './client';
 export declare class TokenClient extends Client {
     /**
      * Store a push notification token for a user
+     * @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
      */
     putUserToken(props: {
@@ -12,6 +15,8 @@ export declare class TokenClient extends Client {
     }): Promise<void>;
     /**
      * Delete a push notification token for a user
+     * @param token - The push notification token
+     * @returns Promise resolving when token is deleted
      */
     deleteUserToken(props: {
         token: string;

package/dist/client/tracking-client.d.ts

@@ -3,6 +3,11 @@ import { Client } from './client';
 export declare 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
      */
     postInboundCourier(props: {
@@ -16,6 +21,9 @@ export declare class TrackingClient extends Client {
     /**
      * Post a tracking URL event
      * These urls are found in messages sent from Courier
+     * @param url - The URL to post the event to
+     * @param event - The event type: Available options: "click", "open", "unsubscribe"
+     * @returns Promise resolving when the event is posted
      */
     postTrackingUrl(props: {
         url: string;

package/dist/index.js

@@ -1 +1 @@
-!function(t,e){"object"==typeof exports&&"undefined"!=typeof module?e(exports):"function"==typeof define&&define.amd?define(["exports"],e):e((t="undefined"!=typeof globalThis?globalThis:t||self).CourierJS={})}(this,(function(t){"use strict";var e=Object.defineProperty,s=(t,s,n)=>((t,s,n)=>s in t?e(t,s,{enumerable:!0,configurable:!0,writable:!0,value:n}):t[s]=n)(t,"symbol"!=typeof s?s+"":s,n);const n=class t{constructor(t,e){s(this,"webSocket",null),s(this,"pingInterval",null),s(this,"onOpen"),s(this,"onMessageReceived"),s(this,"onClose"),s(this,"onError"),s(this,"url"),s(this,"options"),this.url=t,this.options=e}get isConnected(){return null!==this.webSocket}async connect(){return this.disconnect(),new Promise(((t,e)=>{try{this.webSocket=new WebSocket(this.url),this.webSocket.onopen=()=>{var e;null==(e=this.onOpen)||e.call(this),t()},this.webSocket.onmessage=t=>{var e;null==(e=this.onMessageReceived)||e.call(this,t.data)},this.webSocket.onclose=t=>{var e;this.webSocket=null,null==(e=this.onClose)||e.call(this,t.code,t.reason)},this.webSocket.onerror=t=>{var s;this.webSocket=null;const n=new Error("Courier Socket connection failed");n.originalEvent=t,null==(s=this.onError)||s.call(this,n),e(n)}}catch(s){this.webSocket=null,e(s)}}))}disconnect(){this.stopPing(),this.webSocket&&(this.webSocket.close(t.NORMAL_CLOSURE_STATUS),this.webSocket=null)}async send(t){if(!this.webSocket)return!1;const e=JSON.stringify(t);return void 0!==this.webSocket.send(e)}keepAlive(t){this.stopPing(),this.pingInterval=setInterval((async()=>{var t;try{await this.send({action:"keepAlive"})}catch(e){null==(t=this.options.logger)||t.error("Error occurred on Keep Alive:",e)}}),(null==t?void 0:t.intervalInMillis)??3e5)}stopPing(){this.pingInterval&&(clearInterval(this.pingInterval),this.pingInterval=null)}};s(n,"NORMAL_CLOSURE_STATUS",1e3);let o=n;const i=t=>({courier:{rest:(null==t?void 0:t.courier.rest)||"https://api.courier.com",graphql:(null==t?void 0:t.courier.graphql)||"https://api.courier.com/client/q"},inbox:{graphql:(null==t?void 0:t.inbox.graphql)||"https://inbox.courier.com/q",webSocket:(null==t?void 0:t.inbox.webSocket)||"wss://realtime.courier.com"}});class r{constructor(t){s(this,"PREFIX","[COURIER]"),this.showLogs=t}warn(t,...e){this.showLogs&&console.warn(`${this.PREFIX} ${t}`,...e)}log(t,...e){this.showLogs&&console.log(`${this.PREFIX} ${t}`,...e)}error(t,...e){this.showLogs&&console.error(`${this.PREFIX} ${t}`,...e)}debug(t,...e){this.showLogs&&console.debug(`${this.PREFIX} ${t}`,...e)}info(t,...e){this.showLogs&&console.info(`${this.PREFIX} ${t}`,...e)}}class a{static generate(t){const e=Math.random().toString(36).substring(2,15)+Math.random().toString(36).substring(2,15);return t?t+e:e}}class c extends Error{constructor(t,e,s){super(e),this.code=t,this.type=s,this.name="CourierRequestError"}}function u(t,e,s,n){t.log(`\n📡 New Courier ${s} Request: ${e}\nURL: ${n.url}\n${n.method?`Method: ${n.method}`:""}\n${n.query?`Query: ${n.query}`:""}\n${n.variables?`Variables: ${JSON.stringify(n.variables,null,2)}`:""}\nHeaders: ${JSON.stringify(n.headers,null,2)}\nBody: ${n.body?JSON.stringify(n.body,null,2):"Empty"}\n  `)}function h(t,e,s,n){t.log(`\n📡 New Courier ${s} Response: ${e}\nStatus Code: ${n.status}\nResponse JSON: ${JSON.stringify(n.response,null,2)}\n  `)}async function l(t){const e=t.validCodes??[200],s=t.options.showLogs?a.generate():void 0,n=new Request(t.url,{method:t.method,headers:{"Content-Type":"application/json",...t.headers},body:t.body?JSON.stringify(t.body):void 0});s&&u(t.options.logger,s,"HTTP",{url:n.url,method:n.method,headers:Object.fromEntries(n.headers.entries()),body:t.body});const o=await fetch(n);if(204===o.status)return;let i;try{i=await o.json()}catch(r){if(200===o.status)return;throw new c(o.status,"Failed to parse response as JSON","PARSE_ERROR")}if(s&&h(t.options.logger,s,"HTTP",{status:o.status,response:i}),!e.includes(o.status))throw new c(o.status,(null==i?void 0:i.message)||"Unknown Error",null==i?void 0:i.type);return i}async function d(t){const e=t.options.showLogs?a.generate():void 0;e&&u(t.options.logger,e,"GraphQL",{url:t.url,headers:t.headers,query:t.query,variables:t.variables});const s=await fetch(t.url,{method:"POST",headers:{"Content-Type":"application/json",...t.headers},body:JSON.stringify({query:t.query,variables:t.variables})});let n;try{n=await s.json()}catch(o){throw new c(s.status,"Failed to parse response as JSON","PARSE_ERROR")}if(e&&h(t.options.logger,e,"GraphQL",{status:s.status,response:n}),!s.ok)throw new c(s.status,(null==n?void 0:n.message)||"Unknown Error",null==n?void 0:n.type);return n}class p{constructor(t){this.options=t}}class g extends p{async getBrand(t){const e=`\n      query GetBrand {\n        brand(brandId: "${t.brandId}") {\n          settings {\n            colors {\n              primary\n              secondary\n              tertiary\n            }\n            inapp {\n              borderRadius\n              disableCourierFooter\n            }\n          }\n        }\n      }\n    `;return(await d({options:this.options,url:this.options.urls.courier.graphql,headers:{"x-courier-user-id":this.options.userId,"x-courier-client-key":"empty",Authorization:`Bearer ${this.options.accessToken}`},query:e,variables:{brandId:t.brandId}})).data.brand}}class m extends o{constructor(t){super(m.buildUrl(t),t),s(this,"receivedMessage"),s(this,"receivedMessageEvent"),this.onMessageReceived=t=>this.convertToType(t)}convertToType(t){var e,s,n,o;try{switch(JSON.parse(t).type){case"event":const n=JSON.parse(t);null==(e=this.receivedMessageEvent)||e.call(this,n);break;case"message":const o=JSON.parse(t);null==(s=this.receivedMessage)||s.call(this,o)}}catch(i){null==(n=this.options.logger)||n.error("Error parsing socket message",i),i instanceof Error&&(null==(o=this.onError)||o.call(this,i))}}async sendSubscribe(t){var e;const s={action:"subscribe",data:{userAgent:"courier-js",channel:this.options.userId,event:"*",version:(null==t?void 0:t.version)??5}};this.options.connectionId&&(s.data.clientSourceId=this.options.connectionId),this.options.tenantId&&(s.data.accountId=this.options.tenantId),null==(e=this.options.logger)||e.debug("Sending subscribe request",s),await this.send(s)}static buildUrl(t){var e;let s=(null==(e=t.apiUrls)?void 0:e.inbox.webSocket)??"";return t.accessToken&&(s+=`/?auth=${t.accessToken}`),s}}class I extends p{constructor(t){super(t),s(this,"socket"),this.socket=new m(t)}async getMessages(t){const e=`\n      query GetInboxMessages(\n        $params: FilterParamsInput = { ${this.options.tenantId?`accountId: "${this.options.tenantId}"`:""} }\n        $limit: Int = ${(null==t?void 0:t.paginationLimit)??24}\n        $after: String ${(null==t?void 0:t.startCursor)?`= "${t.startCursor}"`:""}\n      ) {\n        count(params: $params)\n        messages(params: $params, limit: $limit, after: $after) {\n          totalCount\n          pageInfo {\n            startCursor\n            hasNextPage\n          }\n          nodes {\n            messageId\n            read\n            archived\n            created\n            opened\n            title\n            preview\n            data\n            tags\n            trackingIds {\n              clickTrackingId\n            }\n            actions {\n              content\n              data\n              href\n            }\n          }\n        }\n      }\n    `;return await d({options:this.options,query:e,headers:{"x-courier-user-id":this.options.userId,Authorization:`Bearer ${this.options.accessToken}`},url:this.options.urls.inbox.graphql})}async getArchivedMessages(t){const e=`\n      query GetInboxMessages(\n        $params: FilterParamsInput = { ${this.options.tenantId?`accountId: "${this.options.tenantId}"`:""}, archived: true }\n        $limit: Int = ${(null==t?void 0:t.paginationLimit)??24}\n        $after: String ${(null==t?void 0:t.startCursor)?`= "${t.startCursor}"`:""}\n      ) {\n        count(params: $params)\n        messages(params: $params, limit: $limit, after: $after) {\n          totalCount\n          pageInfo {\n            startCursor\n            hasNextPage\n          }\n          nodes {\n            messageId\n            read\n            archived\n            created\n            opened\n            title\n            preview\n            data\n            tags\n            trackingIds {\n              clickTrackingId\n            }\n            actions {\n              content\n              data\n              href\n            }\n          }\n        }\n      }\n    `;return d({options:this.options,query:e,headers:{"x-courier-user-id":this.options.userId,Authorization:`Bearer ${this.options.accessToken}`},url:this.options.urls.inbox.graphql})}async getUnreadMessageCount(){var t;const e=`\n      query GetMessages {\n        count(params: { status: "unread" ${this.options.tenantId?`, accountId: "${this.options.tenantId}"`:""} })\n      }\n    `;return(null==(t=(await d({options:this.options,query:e,headers:{"x-courier-user-id":this.options.userId,Authorization:`Bearer ${this.options.accessToken}`},url:this.options.urls.inbox.graphql})).data)?void 0:t.count)??0}async click(t){const e=`\n      mutation TrackEvent {\n        clicked(messageId: "${t.messageId}", trackingId: "${t.trackingId}")\n      }\n    `,s={"x-courier-user-id":this.options.userId,Authorization:`Bearer ${this.options.accessToken}`};this.options.connectionId&&(s["x-courier-client-source-id"]=this.options.connectionId),await d({options:this.options,query:e,headers:s,url:this.options.urls.inbox.graphql})}async read(t){const e=`\n      mutation TrackEvent {\n        read(messageId: "${t.messageId}")\n      }\n    `,s={"x-courier-user-id":this.options.userId,Authorization:`Bearer ${this.options.accessToken}`};this.options.connectionId&&(s["x-courier-client-source-id"]=this.options.connectionId),await d({options:this.options,query:e,headers:s,url:this.options.urls.inbox.graphql})}async unread(t){const e=`\n      mutation TrackEvent {\n        unread(messageId: "${t.messageId}")\n      }\n    `,s={"x-courier-user-id":this.options.userId,Authorization:`Bearer ${this.options.accessToken}`};this.options.connectionId&&(s["x-courier-client-source-id"]=this.options.connectionId),await d({options:this.options,query:e,headers:s,url:this.options.urls.inbox.graphql})}async readAll(){const t={"x-courier-user-id":this.options.userId,Authorization:`Bearer ${this.options.accessToken}`};this.options.connectionId&&(t["x-courier-client-source-id"]=this.options.connectionId),await d({options:this.options,query:"\n      mutation TrackEvent {\n        markAllRead\n      }\n    ",headers:t,url:this.options.urls.inbox.graphql})}async open(t){const e=`\n      mutation TrackEvent {\n        opened(messageId: "${t.messageId}")\n      }\n    `,s={"x-courier-user-id":this.options.userId,Authorization:`Bearer ${this.options.accessToken}`};this.options.connectionId&&(s["x-courier-client-source-id"]=this.options.connectionId),await d({options:this.options,query:e,headers:s,url:this.options.urls.inbox.graphql})}async archive(t){const e=`\n      mutation TrackEvent {\n        archive(messageId: "${t.messageId}")\n      }\n    `,s={"x-courier-user-id":this.options.userId,Authorization:`Bearer ${this.options.accessToken}`};this.options.connectionId&&(s["x-courier-client-source-id"]=this.options.connectionId),await d({options:this.options,query:e,headers:s,url:this.options.urls.inbox.graphql})}}class b{transformItem(t){return{topicId:t.topic_id,topicName:t.topic_name,sectionId:t.section_id,sectionName:t.section_name,status:t.status,defaultStatus:t.default_status,hasCustomRouting:t.has_custom_routing,customRouting:t.custom_routing||[]}}*transform(t){for(const e of t)yield this.transformItem(e)}}class v extends p{constructor(){super(...arguments),s(this,"transformer",new b)}async getUserPreferences(t){let e=`${this.options.urls.courier.rest}/users/${this.options.userId}/preferences`;(null==t?void 0:t.paginationCursor)&&(e+=`?cursor=${t.paginationCursor}`);const s=await l({options:this.options,url:e,method:"GET",headers:{Authorization:`Bearer ${this.options.accessToken}`}});return{items:[...this.transformer.transform(s.items)],paging:s.paging}}async getUserPreferenceTopic(t){const e=await l({options:this.options,url:`${this.options.urls.courier.rest}/users/${this.options.userId}/preferences/${t.topicId}`,method:"GET",headers:{Authorization:`Bearer ${this.options.accessToken}`}});return this.transformer.transformItem(e.topic)}async putUserPreferenceTopic(t){const e={topic:{status:t.status,has_custom_routing:t.hasCustomRouting,custom_routing:t.customRouting}};await l({options:this.options,url:`${this.options.urls.courier.rest}/users/${this.options.userId}/preferences/${t.topicId}`,method:"PUT",headers:{Authorization:`Bearer ${this.options.accessToken}`},body:e})}getNotificationCenterUrl(t){return`https://view.notificationcenter.app/p/${function(t){const e=new Uint8Array(t.length);for(let s=0;s<t.length;s++)e[s]=t.charCodeAt(s);return btoa(String.fromCharCode(...e))}(`${function(t){const e=atob(t),s=new Uint8Array(e.length);for(let n=0;n<e.length;n++)s[n]=e.charCodeAt(n);return String.fromCharCode(...s)}(t.clientKey)}#${this.options.userId}${this.options.tenantId?`#${this.options.tenantId}`:""}#false`)}`}}class y extends p{async putUserToken(t){const e={provider_key:t.provider,...t.device&&{device:{app_id:t.device.appId,ad_id:t.device.adId,device_id:t.device.deviceId,platform:t.device.platform,manufacturer:t.device.manufacturer,model:t.device.model}}};await l({options:this.options,url:`${this.options.urls.courier.rest}/users/${this.options.userId}/tokens/${t.token}`,method:"PUT",headers:{Authorization:`Bearer ${this.options.accessToken}`},body:e,validCodes:[200,204]})}async deleteUserToken(t){await l({options:this.options,url:`${this.options.urls.courier.rest}/users/${this.options.userId}/tokens/${t.token}`,method:"DELETE",headers:{Authorization:`Bearer ${this.options.accessToken}`},validCodes:[200,204]})}}class w extends p{async putSubscription(t){return await l({url:`${this.options.urls.courier.rest}/lists/${t.listId}/subscriptions/${this.options.userId}`,options:this.options,method:"PUT",headers:{Authorization:`Bearer ${this.options.accessToken}`}})}async deleteSubscription(t){return await l({url:`${this.options.urls.courier.rest}/lists/${t.listId}/subscriptions/${this.options.userId}`,options:this.options,method:"DELETE",headers:{Authorization:`Bearer ${this.options.accessToken}`}})}}class $ extends p{async postInboundCourier(t){return await l({url:`${this.options.urls.courier.rest}/inbound/courier`,options:this.options,method:"POST",headers:{Authorization:`Bearer ${this.options.accessToken}`},body:{...t,userId:this.options.userId},validCodes:[200,202]})}async postTrackingUrl(t){return await l({url:t.url,options:this.options,method:"POST",body:{event:t.event}})}}class f extends p{constructor(t){var e,n;const o=void 0!==t.showLogs?t.showLogs:"development"===process.env.NODE_ENV,a={...t,showLogs:o,apiUrls:t.apiUrls||i(),accessToken:t.jwt??t.publicApiKey};super({...a,logger:new r(a.showLogs),urls:i(a.apiUrls)}),s(this,"tokens"),s(this,"brands"),s(this,"preferences"),s(this,"inbox"),s(this,"lists"),s(this,"tracking"),this.tokens=new y(this.options),this.brands=new g(this.options),this.preferences=new v(this.options),this.inbox=new I(this.options),this.lists=new w(this.options),this.tracking=new $(this.options),this.options.jwt||this.options.publicApiKey||this.options.logger.warn("Courier Client initialized with no authentication method. Please provide a JWT or public API key."),this.options.publicApiKey&&(null==(e=this.options.logger)||e.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.")),this.options.jwt&&this.options.publicApiKey&&(null==(n=this.options.logger)||n.warn("Courier Warning: Both a JWT and a Public API Key were provided. The Public API Key will be ignored."))}}class k{constructor(t){s(this,"callback"),this.callback=t}remove(){S.shared.removeAuthenticationListener(this)}}const T=class t{constructor(){s(this,"id",a.generate()),s(this,"instanceClient"),s(this,"_paginationLimit",24),s(this,"authenticationListeners",[])}get paginationLimit(){return this._paginationLimit}set paginationLimit(t){this._paginationLimit=Math.min(Math.max(t,1),100)}get client(){return this.instanceClient}static get shared(){return t.instance||(t.instance=new t),t.instance}signIn(t){const e=t.connectionId??a.generate();this.instanceClient=new f({...t,connectionId:e}),this.notifyAuthenticationListeners({userId:t.userId})}signOut(){this.instanceClient=void 0,this.notifyAuthenticationListeners({userId:void 0})}addAuthenticationListener(t){var e;null==(e=this.instanceClient)||e.options.logger.info("Adding authentication listener");const s=new k(t);return this.authenticationListeners.push(s),s}removeAuthenticationListener(t){var e;null==(e=this.instanceClient)||e.options.logger.info("Removing authentication listener"),this.authenticationListeners=this.authenticationListeners.filter((e=>e!==t))}notifyAuthenticationListeners(t){this.authenticationListeners.forEach((e=>e.callback(t)))}};s(T,"instance");let S=T;t.BrandClient=g,t.Courier=S,t.CourierClient=f,t.CourierSocket=o,t.InboxClient=I,t.ListClient=w,t.PreferenceClient=v,t.TokenClient=y,Object.defineProperty(t,Symbol.toStringTag,{value:"Module"})}));
+!function(t,e){"object"==typeof exports&&"undefined"!=typeof module?e(exports):"function"==typeof define&&define.amd?define(["exports"],e):e((t="undefined"!=typeof globalThis?globalThis:t||self).CourierJS={})}(this,(function(t){"use strict";var e=Object.defineProperty,s=(t,s,n)=>((t,s,n)=>s in t?e(t,s,{enumerable:!0,configurable:!0,writable:!0,value:n}):t[s]=n)(t,"symbol"!=typeof s?s+"":s,n);const n=class t{constructor(t,e){s(this,"webSocket",null),s(this,"pingInterval",null),s(this,"onOpen"),s(this,"onMessageReceived"),s(this,"onClose"),s(this,"onError"),s(this,"url"),s(this,"options"),this.url=t,this.options=e}get isConnected(){return null!==this.webSocket}async connect(){return this.disconnect(),new Promise(((t,e)=>{try{this.webSocket=new WebSocket(this.url),this.webSocket.onopen=()=>{var e;null==(e=this.onOpen)||e.call(this),t()},this.webSocket.onmessage=t=>{var e;null==(e=this.onMessageReceived)||e.call(this,t.data)},this.webSocket.onclose=t=>{var e;this.webSocket=null,null==(e=this.onClose)||e.call(this,t.code,t.reason)},this.webSocket.onerror=t=>{var s;this.webSocket=null;const n=new Error("Courier Socket connection failed");n.originalEvent=t,null==(s=this.onError)||s.call(this,n),e(n)}}catch(s){this.webSocket=null,e(s)}}))}disconnect(){this.stopPing(),this.webSocket&&(this.webSocket.close(t.NORMAL_CLOSURE_STATUS),this.webSocket=null)}async send(t){if(!this.webSocket)return!1;const e=JSON.stringify(t);return void 0!==this.webSocket.send(e)}keepAlive(t){this.stopPing(),this.pingInterval=setInterval((async()=>{var t;try{await this.send({action:"keepAlive"})}catch(e){null==(t=this.options.logger)||t.error("Error occurred on Keep Alive:",e)}}),(null==t?void 0:t.intervalInMillis)??3e5)}stopPing(){this.pingInterval&&(clearInterval(this.pingInterval),this.pingInterval=null)}};s(n,"NORMAL_CLOSURE_STATUS",1e3);let i=n;const o=t=>({courier:{rest:(null==t?void 0:t.courier.rest)||"https://api.courier.com",graphql:(null==t?void 0:t.courier.graphql)||"https://api.courier.com/client/q"},inbox:{graphql:(null==t?void 0:t.inbox.graphql)||"https://inbox.courier.com/q",webSocket:(null==t?void 0:t.inbox.webSocket)||"wss://realtime.courier.com"}});class r{constructor(t){s(this,"PREFIX","[COURIER]"),this.showLogs=t}warn(t,...e){this.showLogs&&console.warn(`${this.PREFIX} ${t}`,...e)}log(t,...e){this.showLogs&&console.log(`${this.PREFIX} ${t}`,...e)}error(t,...e){this.showLogs&&console.error(`${this.PREFIX} ${t}`,...e)}debug(t,...e){this.showLogs&&console.debug(`${this.PREFIX} ${t}`,...e)}info(t,...e){this.showLogs&&console.info(`${this.PREFIX} ${t}`,...e)}}class a{static generate(t){const e=Math.random().toString(36).substring(2,15)+Math.random().toString(36).substring(2,15);return t?t+e:e}}class c extends Error{constructor(t,e,s){super(e),this.code=t,this.type=s,this.name="CourierRequestError"}}function u(t,e,s,n){t.log(`\n📡 New Courier ${s} Request: ${e}\nURL: ${n.url}\n${n.method?`Method: ${n.method}`:""}\n${n.query?`Query: ${n.query}`:""}\n${n.variables?`Variables: ${JSON.stringify(n.variables,null,2)}`:""}\nHeaders: ${JSON.stringify(n.headers,null,2)}\nBody: ${n.body?JSON.stringify(n.body,null,2):"Empty"}\n  `)}function h(t,e,s,n){t.log(`\n📡 New Courier ${s} Response: ${e}\nStatus Code: ${n.status}\nResponse JSON: ${JSON.stringify(n.response,null,2)}\n  `)}async function l(t){const e=t.validCodes??[200],s=t.options.showLogs?a.generate():void 0,n=new Request(t.url,{method:t.method,headers:{"Content-Type":"application/json",...t.headers},body:t.body?JSON.stringify(t.body):void 0});s&&u(t.options.logger,s,"HTTP",{url:n.url,method:n.method,headers:Object.fromEntries(n.headers.entries()),body:t.body});const i=await fetch(n);if(204===i.status)return;let o;try{o=await i.json()}catch(r){if(200===i.status)return;throw new c(i.status,"Failed to parse response as JSON","PARSE_ERROR")}if(s&&h(t.options.logger,s,"HTTP",{status:i.status,response:o}),!e.includes(i.status))throw new c(i.status,(null==o?void 0:o.message)||"Unknown Error",null==o?void 0:o.type);return o}async function d(t){const e=t.options.showLogs?a.generate():void 0;e&&u(t.options.logger,e,"GraphQL",{url:t.url,headers:t.headers,query:t.query,variables:t.variables});const s=await fetch(t.url,{method:"POST",headers:{"Content-Type":"application/json",...t.headers},body:JSON.stringify({query:t.query,variables:t.variables})});let n;try{n=await s.json()}catch(i){throw new c(s.status,"Failed to parse response as JSON","PARSE_ERROR")}if(e&&h(t.options.logger,e,"GraphQL",{status:s.status,response:n}),!s.ok)throw new c(s.status,(null==n?void 0:n.message)||"Unknown Error",null==n?void 0:n.type);return n}class p{constructor(t){this.options=t}}class g extends p{async getBrand(t){const e=`\n      query GetBrand {\n        brand(brandId: "${t.brandId}") {\n          settings {\n            colors {\n              primary\n              secondary\n              tertiary\n            }\n            inapp {\n              borderRadius\n              disableCourierFooter\n            }\n          }\n        }\n      }\n    `;return(await d({options:this.options,url:this.options.apiUrls.courier.graphql,headers:{"x-courier-user-id":this.options.userId,"x-courier-client-key":"empty",Authorization:`Bearer ${this.options.accessToken}`},query:e,variables:{brandId:t.brandId}})).data.brand}}class m extends i{constructor(t){super(m.buildUrl(t),t),s(this,"receivedMessage"),s(this,"receivedMessageEvent"),this.onMessageReceived=t=>this.convertToType(t)}convertToType(t){var e,s,n,i;try{switch(JSON.parse(t).type){case"event":const n=JSON.parse(t);null==(e=this.receivedMessageEvent)||e.call(this,n);break;case"message":const i=JSON.parse(t);null==(s=this.receivedMessage)||s.call(this,i)}}catch(o){null==(n=this.options.logger)||n.error("Error parsing socket message",o),o instanceof Error&&(null==(i=this.onError)||i.call(this,o))}}async sendSubscribe(t){var e;const s={action:"subscribe",data:{userAgent:"courier-js",channel:this.options.userId,event:"*",version:(null==t?void 0:t.version)??5}};this.options.connectionId&&(s.data.clientSourceId=this.options.connectionId),this.options.tenantId&&(s.data.accountId=this.options.tenantId),null==(e=this.options.logger)||e.debug("Sending subscribe request",s),await this.send(s)}static buildUrl(t){var e;let s=(null==(e=t.apiUrls)?void 0:e.inbox.webSocket)??"";return t.accessToken&&(s+=`/?auth=${t.accessToken}`),s}}class I extends p{constructor(t){super(t),s(this,"socket"),this.socket=new m(t)}async getMessages(t){const e=`\n      query GetInboxMessages(\n        $params: FilterParamsInput = { ${this.options.tenantId?`accountId: "${this.options.tenantId}"`:""} }\n        $limit: Int = ${(null==t?void 0:t.paginationLimit)??24}\n        $after: String ${(null==t?void 0:t.startCursor)?`= "${t.startCursor}"`:""}\n      ) {\n        count(params: $params)\n        messages(params: $params, limit: $limit, after: $after) {\n          totalCount\n          pageInfo {\n            startCursor\n            hasNextPage\n          }\n          nodes {\n            messageId\n            read\n            archived\n            created\n            opened\n            title\n            preview\n            data\n            tags\n            trackingIds {\n              clickTrackingId\n            }\n            actions {\n              content\n              data\n              href\n            }\n          }\n        }\n      }\n    `;return await d({options:this.options,query:e,headers:{"x-courier-user-id":this.options.userId,Authorization:`Bearer ${this.options.accessToken}`},url:this.options.apiUrls.inbox.graphql})}async getArchivedMessages(t){const e=`\n      query GetInboxMessages(\n        $params: FilterParamsInput = { ${this.options.tenantId?`accountId: "${this.options.tenantId}"`:""}, archived: true }\n        $limit: Int = ${(null==t?void 0:t.paginationLimit)??24}\n        $after: String ${(null==t?void 0:t.startCursor)?`= "${t.startCursor}"`:""}\n      ) {\n        count(params: $params)\n        messages(params: $params, limit: $limit, after: $after) {\n          totalCount\n          pageInfo {\n            startCursor\n            hasNextPage\n          }\n          nodes {\n            messageId\n            read\n            archived\n            created\n            opened\n            title\n            preview\n            data\n            tags\n            trackingIds {\n              clickTrackingId\n            }\n            actions {\n              content\n              data\n              href\n            }\n          }\n        }\n      }\n    `;return d({options:this.options,query:e,headers:{"x-courier-user-id":this.options.userId,Authorization:`Bearer ${this.options.accessToken}`},url:this.options.apiUrls.inbox.graphql})}async getUnreadMessageCount(){var t;const e=`\n      query GetMessages {\n        count(params: { status: "unread" ${this.options.tenantId?`, accountId: "${this.options.tenantId}"`:""} })\n      }\n    `;return(null==(t=(await d({options:this.options,query:e,headers:{"x-courier-user-id":this.options.userId,Authorization:`Bearer ${this.options.accessToken}`},url:this.options.apiUrls.inbox.graphql})).data)?void 0:t.count)??0}async click(t){const e=`\n      mutation TrackEvent {\n        clicked(messageId: "${t.messageId}", trackingId: "${t.trackingId}")\n      }\n    `,s={"x-courier-user-id":this.options.userId,Authorization:`Bearer ${this.options.accessToken}`};this.options.connectionId&&(s["x-courier-client-source-id"]=this.options.connectionId),await d({options:this.options,query:e,headers:s,url:this.options.apiUrls.inbox.graphql})}async read(t){const e=`\n      mutation TrackEvent {\n        read(messageId: "${t.messageId}")\n      }\n    `,s={"x-courier-user-id":this.options.userId,Authorization:`Bearer ${this.options.accessToken}`};this.options.connectionId&&(s["x-courier-client-source-id"]=this.options.connectionId),await d({options:this.options,query:e,headers:s,url:this.options.apiUrls.inbox.graphql})}async unread(t){const e=`\n      mutation TrackEvent {\n        unread(messageId: "${t.messageId}")\n      }\n    `,s={"x-courier-user-id":this.options.userId,Authorization:`Bearer ${this.options.accessToken}`};this.options.connectionId&&(s["x-courier-client-source-id"]=this.options.connectionId),await d({options:this.options,query:e,headers:s,url:this.options.apiUrls.inbox.graphql})}async readAll(){const t={"x-courier-user-id":this.options.userId,Authorization:`Bearer ${this.options.accessToken}`};this.options.connectionId&&(t["x-courier-client-source-id"]=this.options.connectionId),await d({options:this.options,query:"\n      mutation TrackEvent {\n        markAllRead\n      }\n    ",headers:t,url:this.options.apiUrls.inbox.graphql})}async open(t){const e=`\n      mutation TrackEvent {\n        opened(messageId: "${t.messageId}")\n      }\n    `,s={"x-courier-user-id":this.options.userId,Authorization:`Bearer ${this.options.accessToken}`};this.options.connectionId&&(s["x-courier-client-source-id"]=this.options.connectionId),await d({options:this.options,query:e,headers:s,url:this.options.apiUrls.inbox.graphql})}async archive(t){const e=`\n      mutation TrackEvent {\n        archive(messageId: "${t.messageId}")\n      }\n    `,s={"x-courier-user-id":this.options.userId,Authorization:`Bearer ${this.options.accessToken}`};this.options.connectionId&&(s["x-courier-client-source-id"]=this.options.connectionId),await d({options:this.options,query:e,headers:s,url:this.options.apiUrls.inbox.graphql})}async archiveRead(){const t={"x-courier-user-id":this.options.userId,Authorization:`Bearer ${this.options.accessToken}`};this.options.connectionId&&(t["x-courier-client-source-id"]=this.options.connectionId),await d({options:this.options,query:"\n      mutation TrackEvent {\n        archiveRead\n      }\n    ",headers:t,url:this.options.apiUrls.inbox.graphql})}}class v{transformItem(t){return{topicId:t.topic_id,topicName:t.topic_name,sectionId:t.section_id,sectionName:t.section_name,status:t.status,defaultStatus:t.default_status,hasCustomRouting:t.has_custom_routing,customRouting:t.custom_routing||[]}}*transform(t){for(const e of t)yield this.transformItem(e)}}class b extends p{constructor(){super(...arguments),s(this,"transformer",new v)}async getUserPreferences(t){let e=`${this.options.apiUrls.courier.rest}/users/${this.options.userId}/preferences`;(null==t?void 0:t.paginationCursor)&&(e+=`?cursor=${t.paginationCursor}`);const s=await l({options:this.options,url:e,method:"GET",headers:{Authorization:`Bearer ${this.options.accessToken}`}});return{items:[...this.transformer.transform(s.items)],paging:s.paging}}async getUserPreferenceTopic(t){const e=await l({options:this.options,url:`${this.options.apiUrls.courier.rest}/users/${this.options.userId}/preferences/${t.topicId}`,method:"GET",headers:{Authorization:`Bearer ${this.options.accessToken}`}});return this.transformer.transformItem(e.topic)}async putUserPreferenceTopic(t){const e={topic:{status:t.status,has_custom_routing:t.hasCustomRouting,custom_routing:t.customRouting}};await l({options:this.options,url:`${this.options.apiUrls.courier.rest}/users/${this.options.userId}/preferences/${t.topicId}`,method:"PUT",headers:{Authorization:`Bearer ${this.options.accessToken}`},body:e})}getNotificationCenterUrl(t){return`https://view.notificationcenter.app/p/${function(t){const e=new Uint8Array(t.length);for(let s=0;s<t.length;s++)e[s]=t.charCodeAt(s);return btoa(String.fromCharCode(...e))}(`${function(t){const e=atob(t),s=new Uint8Array(e.length);for(let n=0;n<e.length;n++)s[n]=e.charCodeAt(n);return String.fromCharCode(...s)}(t.clientKey)}#${this.options.userId}${this.options.tenantId?`#${this.options.tenantId}`:""}#false`)}`}}class y extends p{async putUserToken(t){const e={provider_key:t.provider,...t.device&&{device:{app_id:t.device.appId,ad_id:t.device.adId,device_id:t.device.deviceId,platform:t.device.platform,manufacturer:t.device.manufacturer,model:t.device.model}}};await l({options:this.options,url:`${this.options.apiUrls.courier.rest}/users/${this.options.userId}/tokens/${t.token}`,method:"PUT",headers:{Authorization:`Bearer ${this.options.accessToken}`},body:e,validCodes:[200,204]})}async deleteUserToken(t){await l({options:this.options,url:`${this.options.apiUrls.courier.rest}/users/${this.options.userId}/tokens/${t.token}`,method:"DELETE",headers:{Authorization:`Bearer ${this.options.accessToken}`},validCodes:[200,204]})}}class w extends p{async putSubscription(t){return await l({url:`${this.options.apiUrls.courier.rest}/lists/${t.listId}/subscriptions/${this.options.userId}`,options:this.options,method:"PUT",headers:{Authorization:`Bearer ${this.options.accessToken}`}})}async deleteSubscription(t){return await l({url:`${this.options.apiUrls.courier.rest}/lists/${t.listId}/subscriptions/${this.options.userId}`,options:this.options,method:"DELETE",headers:{Authorization:`Bearer ${this.options.accessToken}`}})}}class $ extends p{async postInboundCourier(t){return await l({url:`${this.options.apiUrls.courier.rest}/inbound/courier`,options:this.options,method:"POST",headers:{Authorization:`Bearer ${this.options.accessToken}`},body:{...t,userId:this.options.userId},validCodes:[200,202]})}async postTrackingUrl(t){return await l({url:t.url,options:this.options,method:"POST",body:{event:t.event}})}}class f extends p{constructor(t){var e,n;const i=void 0!==t.showLogs?t.showLogs:"development"===process.env.NODE_ENV,a={...t,showLogs:i,apiUrls:t.apiUrls||o(),accessToken:t.jwt??t.publicApiKey};super({...a,logger:new r(a.showLogs),apiUrls:o(a.apiUrls)}),s(this,"tokens"),s(this,"brands"),s(this,"preferences"),s(this,"inbox"),s(this,"lists"),s(this,"tracking"),this.tokens=new y(this.options),this.brands=new g(this.options),this.preferences=new b(this.options),this.inbox=new I(this.options),this.lists=new w(this.options),this.tracking=new $(this.options),this.options.jwt||this.options.publicApiKey||this.options.logger.warn("Courier Client initialized with no authentication method. Please provide a JWT or public API key."),this.options.publicApiKey&&(null==(e=this.options.logger)||e.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.")),this.options.jwt&&this.options.publicApiKey&&(null==(n=this.options.logger)||n.warn("Courier Warning: Both a JWT and a Public API Key were provided. The Public API Key will be ignored."))}}class k{constructor(t){s(this,"callback"),this.callback=t}remove(){S.shared.removeAuthenticationListener(this)}}const T=class t{constructor(){s(this,"id",a.generate()),s(this,"instanceClient"),s(this,"_paginationLimit",24),s(this,"authenticationListeners",[])}get paginationLimit(){return this._paginationLimit}set paginationLimit(t){this._paginationLimit=Math.min(Math.max(t,1),100)}get client(){return this.instanceClient}static get shared(){return t.instance||(t.instance=new t),t.instance}signIn(t){const e=t.connectionId??a.generate();this.instanceClient=new f({...t,connectionId:e}),this.notifyAuthenticationListeners({userId:t.userId})}signOut(){this.instanceClient=void 0,this.notifyAuthenticationListeners({userId:void 0})}addAuthenticationListener(t){var e;null==(e=this.instanceClient)||e.options.logger.info("Adding authentication listener");const s=new k(t);return this.authenticationListeners.push(s),s}removeAuthenticationListener(t){var e;null==(e=this.instanceClient)||e.options.logger.info("Removing authentication listener"),this.authenticationListeners=this.authenticationListeners.filter((e=>e!==t))}notifyAuthenticationListeners(t){this.authenticationListeners.forEach((e=>e.callback(t)))}};s(T,"instance");let S=T;t.BrandClient=g,t.Courier=S,t.CourierClient=f,t.CourierSocket=i,t.InboxClient=I,t.ListClient=w,t.PreferenceClient=b,t.TokenClient=y,Object.defineProperty(t,Symbol.toStringTag,{value:"Module"})}));

package/dist/index.mjs

@@ -269,6 +269,8 @@ class Client {
 class BrandClient extends Client {
   /**
    * Get a brand by ID using GraphQL
+   * @param brandId - The ID of the brand to retrieve
+   * @returns Promise resolving to the requested brand
    */
   async getBrand(props) {
     const query = `
@@ -290,7 +292,7 @@ class BrandClient extends Client {
     `;
     const json = await graphql({
       options: this.options,
-      url: this.options.urls.courier.graphql,
+      url: this.options.apiUrls.courier.graphql,
       headers: {
         "x-courier-user-id": this.options.userId,
         "x-courier-client-key": "empty",
@@ -370,6 +372,9 @@ class InboxClient extends Client {
   }
   /**
    * Get paginated messages
+   * @param paginationLimit - Number of messages to return per page (default: 24)
+   * @param startCursor - Cursor for pagination
+   * @returns Promise resolving to paginated messages response
    */
   async getMessages(props) {
     const query = `
@@ -414,11 +419,14 @@ class InboxClient extends Client {
         "x-courier-user-id": this.options.userId,
         "Authorization": `Bearer ${this.options.accessToken}`
       },
-      url: this.options.urls.inbox.graphql
+      url: this.options.apiUrls.inbox.graphql
     });
   }
   /**
    * 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
    */
   async getArchivedMessages(props) {
     const query = `
@@ -463,11 +471,12 @@ class InboxClient extends Client {
         "x-courier-user-id": this.options.userId,
         "Authorization": `Bearer ${this.options.accessToken}`
       },
-      url: this.options.urls.inbox.graphql
+      url: this.options.apiUrls.inbox.graphql
     });
   }
   /**
    * Get unread message count
+   * @returns Promise resolving to number of unread messages
    */
   async getUnreadMessageCount() {
     var _a;
@@ -483,12 +492,15 @@ class InboxClient extends Client {
         "x-courier-user-id": this.options.userId,
         "Authorization": `Bearer ${this.options.accessToken}`
       },
-      url: this.options.urls.inbox.graphql
+      url: this.options.apiUrls.inbox.graphql
     });
     return ((_a = response.data) == null ? void 0 : _a.count) ?? 0;
   }
   /**
    * Track a click event
+   * @param messageId - ID of the message
+   * @param trackingId - ID for tracking the click
+   * @returns Promise resolving when click is tracked
    */
   async click(props) {
     const query = `
@@ -507,11 +519,13 @@ class InboxClient extends Client {
       options: this.options,
       query,
       headers,
-      url: this.options.urls.inbox.graphql
+      url: this.options.apiUrls.inbox.graphql
     });
   }
   /**
    * Mark a message as read
+   * @param messageId - ID of the message to mark as read
+   * @returns Promise resolving when message is marked as read
    */
   async read(props) {
     const query = `
@@ -530,11 +544,13 @@ class InboxClient extends Client {
       options: this.options,
       query,
       headers,
-      url: this.options.urls.inbox.graphql
+      url: this.options.apiUrls.inbox.graphql
     });
   }
   /**
    * Mark a message as unread
+   * @param messageId - ID of the message to mark as unread
+   * @returns Promise resolving when message is marked as unread
    */
   async unread(props) {
     const query = `
@@ -553,11 +569,12 @@ class InboxClient extends Client {
       options: this.options,
       query,
       headers,
-      url: this.options.urls.inbox.graphql
+      url: this.options.apiUrls.inbox.graphql
     });
   }
   /**
    * Mark all messages as read
+   * @returns Promise resolving when all messages are marked as read
    */
   async readAll() {
     const query = `
@@ -576,11 +593,13 @@ class InboxClient extends Client {
       options: this.options,
       query,
       headers,
-      url: this.options.urls.inbox.graphql
+      url: this.options.apiUrls.inbox.graphql
     });
   }
   /**
    * Mark a message as opened
+   * @param messageId - ID of the message to mark as opened
+   * @returns Promise resolving when message is marked as opened
    */
   async open(props) {
     const query = `
@@ -599,11 +618,13 @@ class InboxClient extends Client {
       options: this.options,
       query,
       headers,
-      url: this.options.urls.inbox.graphql
+      url: this.options.apiUrls.inbox.graphql
     });
   }
   /**
    * Archive a message
+   * @param messageId - ID of the message to archive
+   * @returns Promise resolving when message is archived
    */
   async archive(props) {
     const query = `
@@ -622,7 +643,30 @@ class InboxClient extends Client {
       options: this.options,
       query,
       headers,
-      url: this.options.urls.inbox.graphql
+      url: this.options.apiUrls.inbox.graphql
+    });
+  }
+  /**
+   * Archive all read messages.
+   */
+  async archiveRead() {
+    const query = `
+      mutation TrackEvent {
+        archiveRead
+      }
+    `;
+    const headers = {
+      "x-courier-user-id": this.options.userId,
+      "Authorization": `Bearer ${this.options.accessToken}`
+    };
+    if (this.options.connectionId) {
+      headers["x-courier-client-source-id"] = this.options.connectionId;
+    }
+    await graphql({
+      options: this.options,
+      query,
+      headers,
+      url: this.options.apiUrls.inbox.graphql
     });
   }
 }
@@ -677,12 +721,14 @@ 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
    */
-  async getUserPreferences(params) {
-    let url = `${this.options.urls.courier.rest}/users/${this.options.userId}/preferences`;
-    if (params == null ? void 0 : params.paginationCursor) {
-      url += `?cursor=${params.paginationCursor}`;
+  async getUserPreferences(props) {
+    let url = `${this.options.apiUrls.courier.rest}/users/${this.options.userId}/preferences`;
+    if (props == null ? void 0 : props.paginationCursor) {
+      url += `?cursor=${props.paginationCursor}`;
     }
     const json = await http({
       options: this.options,
@@ -700,12 +746,14 @@ 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
    */
-  async getUserPreferenceTopic(params) {
+  async getUserPreferenceTopic(props) {
     const json = await http({
       options: this.options,
-      url: `${this.options.urls.courier.rest}/users/${this.options.userId}/preferences/${params.topicId}`,
+      url: `${this.options.apiUrls.courier.rest}/users/${this.options.userId}/preferences/${props.topicId}`,
       method: "GET",
       headers: {
         "Authorization": `Bearer ${this.options.accessToken}`
@@ -716,19 +764,24 @@ class PreferenceClient extends Client {
   }
   /**
    * Update preferences for a specific topic
+   * @param topicId - The ID of the topic to update preferences for
+   * @param status - The new status for the topic
+   * @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
    */
-  async putUserPreferenceTopic(params) {
+  async putUserPreferenceTopic(props) {
     const payload = {
       topic: {
-        status: params.status,
-        has_custom_routing: params.hasCustomRouting,
-        custom_routing: params.customRouting
+        status: props.status,
+        has_custom_routing: props.hasCustomRouting,
+        custom_routing: props.customRouting
       }
     };
     await http({
       options: this.options,
-      url: `${this.options.urls.courier.rest}/users/${this.options.userId}/preferences/${params.topicId}`,
+      url: `${this.options.apiUrls.courier.rest}/users/${this.options.userId}/preferences/${props.topicId}`,
       method: "PUT",
       headers: {
         "Authorization": `Bearer ${this.options.accessToken}`
@@ -738,11 +791,11 @@ class PreferenceClient extends Client {
   }
   /**
    * Get the notification center URL
-   * @param params 
-   * @returns 
+   * @param clientKey - The client key to use for the URL
+   * @returns The notification center URL
    */
-  getNotificationCenterUrl(params) {
-    const rootTenantId = decode(params.clientKey);
+  getNotificationCenterUrl(props) {
+    const rootTenantId = decode(props.clientKey);
     const url = encode(`${rootTenantId}#${this.options.userId}${this.options.tenantId ? `#${this.options.tenantId}` : ""}#${false}`);
     return `https://view.notificationcenter.app/p/${url}`;
   }
@@ -750,6 +803,9 @@ class PreferenceClient extends Client {
 class TokenClient extends Client {
   /**
    * Store a push notification token for a user
+   * @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
    */
   async putUserToken(props) {
@@ -768,7 +824,7 @@ class TokenClient extends Client {
     };
     await http({
       options: this.options,
-      url: `${this.options.urls.courier.rest}/users/${this.options.userId}/tokens/${props.token}`,
+      url: `${this.options.apiUrls.courier.rest}/users/${this.options.userId}/tokens/${props.token}`,
       method: "PUT",
       headers: {
         "Authorization": `Bearer ${this.options.accessToken}`
@@ -779,11 +835,13 @@ class TokenClient extends Client {
   }
   /**
    * Delete a push notification token for a user
+   * @param token - The push notification token
+   * @returns Promise resolving when token is deleted
    */
   async deleteUserToken(props) {
     await http({
       options: this.options,
-      url: `${this.options.urls.courier.rest}/users/${this.options.userId}/tokens/${props.token}`,
+      url: `${this.options.apiUrls.courier.rest}/users/${this.options.userId}/tokens/${props.token}`,
       method: "DELETE",
       headers: {
         "Authorization": `Bearer ${this.options.accessToken}`
@@ -795,11 +853,13 @@ class TokenClient extends Client {
 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
    */
   async putSubscription(props) {
     return await http({
-      url: `${this.options.urls.courier.rest}/lists/${props.listId}/subscriptions/${this.options.userId}`,
+      url: `${this.options.apiUrls.courier.rest}/lists/${props.listId}/subscriptions/${this.options.userId}`,
       options: this.options,
       method: "PUT",
       headers: {
@@ -809,11 +869,13 @@ 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
    */
   async deleteSubscription(props) {
     return await http({
-      url: `${this.options.urls.courier.rest}/lists/${props.listId}/subscriptions/${this.options.userId}`,
+      url: `${this.options.apiUrls.courier.rest}/lists/${props.listId}/subscriptions/${this.options.userId}`,
       options: this.options,
       method: "DELETE",
       headers: {
@@ -825,11 +887,16 @@ 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
    */
   async postInboundCourier(props) {
     return await http({
-      url: `${this.options.urls.courier.rest}/inbound/courier`,
+      url: `${this.options.apiUrls.courier.rest}/inbound/courier`,
       options: this.options,
       method: "POST",
       headers: {
@@ -845,6 +912,9 @@ class TrackingClient extends Client {
   /**
    * Post a tracking URL event
    * These urls are found in messages sent from Courier
+   * @param url - The URL to post the event to
+   * @param event - The event type: Available options: "click", "open", "unsubscribe"
+   * @returns Promise resolving when the event is posted
    */
   async postTrackingUrl(props) {
     return await http({
@@ -870,7 +940,7 @@ class CourierClient extends Client {
     super({
       ...baseOptions,
       logger: new Logger(baseOptions.showLogs),
-      urls: getCourierApiUrls(baseOptions.apiUrls)
+      apiUrls: getCourierApiUrls(baseOptions.apiUrls)
     });
     __publicField(this, "tokens");
     __publicField(this, "brands");

package/dist/socket/inbox-socket.d.ts

@@ -6,7 +6,7 @@ export interface MessageEvent {
     messageId?: string;
     type: string;
 }
-export type EventType = 'read' | 'unread' | 'mark-all-read' | 'opened' | 'unopened' | 'archive' | 'unarchive' | 'click';
+export type EventType = 'archive-read' | 'archive' | 'click' | 'mark-all-read' | 'opened' | 'read' | 'unarchive' | 'unopened' | 'unread';
 export declare class InboxSocket extends CourierSocket {
     receivedMessage?: (message: InboxMessage) => void;
     receivedMessageEvent?: (event: MessageEvent) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trycourier/courier-js",
-  "version": "2.0.0-beta",
+  "version": "2.0.2-beta",
   "description": "A browser-safe API wrapper",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -29,6 +29,8 @@
     "@types/jest": "29.5.14",
     "dotenv": "16.4.7",
     "jest": "29.7.0",
+    "jest-environment-jsdom": "29.7.0",
+    "jest-fetch-mock": "^3.0.3",
     "terser": "5.39.0",
     "ts-jest": "29.1.1",
     "vite": "6.2.6",