@knocklabs/client 0.11.0-rc.0 → 0.11.0

package/src/clients/feed/feed.ts

@@ -124,6 +124,14 @@ class Feed {
 
     this.hasSubscribedToRealTimeUpdates = true;
 
+    // If the user is not authenticated, then do nothing
+    if (!this.knock.isAuthenticated()) {
+      this.knock.log(
+        "[Feed] User is not authenticated, skipping listening for updates",
+      );
+      return;
+    }
+
     const maybeSocket = this.knock.client().socket;
 
     // Connect the socket only if we don't already have a connection
@@ -318,11 +326,9 @@ class Feed {
     const shouldOptimisticallyRemoveItems =
       this.defaultOptions.archived === "exclude";
 
-    const normalizedItems = Array.isArray(itemOrItems)
-      ? itemOrItems
-      : [itemOrItems];
+    const items = Array.isArray(itemOrItems) ? itemOrItems : [itemOrItems];
 
-    const itemIds: string[] = normalizedItems.map((item) => item.id);
+    const itemIds: string[] = items.map((item) => item.id);
 
     /*
       In the code here we want to optimistically update counts and items
@@ -354,15 +360,17 @@ class Feed {
     if (shouldOptimisticallyRemoveItems) {
       // If any of the items are unseen or unread, then capture as we'll want to decrement
       // the counts for these in the metadata we have
-      const unseenCount = normalizedItems.filter((i) => !i.seen_at).length;
-      const unreadCount = normalizedItems.filter((i) => !i.read_at).length;
+      const unseenCount = items.filter((i) => !i.seen_at).length;
+      const unreadCount = items.filter((i) => !i.read_at).length;
 
       // Build the new metadata
       const updatedMetadata = {
         ...state.metadata,
-        total_count: state.metadata.total_count - normalizedItems.length,
-        unseen_count: state.metadata.unseen_count - unseenCount,
-        unread_count: state.metadata.unread_count - unreadCount,
+        // Ensure that the counts don't ever go below 0 on archiving where the client state
+        // gets out of sync with the server state
+        total_count: Math.max(0, state.metadata.total_count - items.length),
+        unseen_count: Math.max(0, state.metadata.unseen_count - unseenCount),
+        unread_count: Math.max(0, state.metadata.unread_count - unreadCount),
       };
 
       // Remove the archiving entries
@@ -464,8 +472,15 @@ class Feed {
   async fetch(options: FetchFeedOptions = {}) {
     const { networkStatus, ...state } = this.store.getState();
 
+    // If the user is not authenticated, then do nothing
+    if (!this.knock.isAuthenticated()) {
+      this.knock.log("[Feed] User is not authenticated, skipping fetch");
+      return;
+    }
+
     // If there's an existing request in flight, then do nothing
     if (isRequestInFlight(networkStatus)) {
+      this.knock.log("[Feed] Request is in flight, skipping fetch");
       return;
     }
 
@@ -750,7 +765,7 @@ class Feed {
 
     // If we're initializing but they have previously opted to listen to real-time updates
     // then we will automatically reconnect on their behalf
-    if (this.hasSubscribedToRealTimeUpdates) {
+    if (this.hasSubscribedToRealTimeUpdates && this.knock.isAuthenticated()) {
       if (!maybeSocket.isConnected()) maybeSocket.connect();
       this.channel.join();
     }

package/src/clients/messages/interfaces.ts

@@ -47,7 +47,15 @@ export type BulkUpdateMessagesInChannelProperties = {
   status: "seen" | "read" | "archive";
   options: {
     user_ids?: string[];
-    engagement_status?: "seen" | "read" | "unseen" | "unread";
+    engagement_status?:
+      | "seen"
+      | "read"
+      | "archived"
+      | "unseen"
+      | "unread"
+      | "unarchived"
+      | "interacted"
+      | "link_clicked";
     archived?: "exclude" | "include" | "only";
     has_tenant?: boolean;
     tenants?: string[];

package/src/clients/ms-teams/index.ts

@@ -0,0 +1,60 @@
+import { ApiResponse } from "../../api";
+import { AuthCheckInput, RevokeAccessTokenInput } from "../../interfaces";
+import Knock from "../../knock";
+import { TENANT_OBJECT_COLLECTION } from "../objects/constants";
+
+class MsTeamsClient {
+  private instance: Knock;
+
+  constructor(instance: Knock) {
+    this.instance = instance;
+  }
+
+  async authCheck({ tenant: tenantId, knockChannelId }: AuthCheckInput) {
+    const result = await this.instance.client().makeRequest({
+      method: "GET",
+      url: `/v1/providers/ms-teams/${knockChannelId}/auth_check`,
+      params: {
+        ms_teams_tenant_object: {
+          object_id: tenantId,
+          collection: TENANT_OBJECT_COLLECTION,
+        },
+        channel_id: knockChannelId,
+      },
+    });
+
+    return this.handleResponse(result);
+  }
+
+  async revokeAccessToken({
+    tenant: tenantId,
+    knockChannelId,
+  }: RevokeAccessTokenInput) {
+    const result = await this.instance.client().makeRequest({
+      method: "PUT",
+      url: `/v1/providers/ms-teams/${knockChannelId}/revoke_access`,
+      params: {
+        ms_teams_tenant_object: {
+          object_id: tenantId,
+          collection: TENANT_OBJECT_COLLECTION,
+        },
+        channel_id: knockChannelId,
+      },
+    });
+
+    return this.handleResponse(result);
+  }
+
+  private handleResponse(response: ApiResponse) {
+    if (response.statusCode === "error") {
+      if (response.error?.response?.status < 500) {
+        return response.error || response.body;
+      }
+      throw new Error(response.error || response.body);
+    }
+
+    return response.body;
+  }
+}
+
+export default MsTeamsClient;

package/src/clients/preferences/interfaces.ts

@@ -1,12 +1,17 @@
-import { ChannelType } from "@knocklabs/types";
+import { ChannelType, Condition } from "@knocklabs/types";
+
+export type ConditionalPreferenceSettings = {
+  conditions: Condition[];
+};
 
 export type ChannelTypePreferences = {
-  [_K in ChannelType]?: boolean;
+  [_K in ChannelType]?: boolean | ConditionalPreferenceSettings;
 };
 
 export type WorkflowPreferenceSetting =
   | boolean
-  | { channel_types: ChannelTypePreferences };
+  | { channel_types: ChannelTypePreferences }
+  | ConditionalPreferenceSettings;
 
 export type WorkflowPreferences = Partial<
   Record<string, WorkflowPreferenceSetting>
@@ -20,9 +25,9 @@ export interface SetPreferencesProperties {
 
 export interface PreferenceSet {
   id: string;
-  categories: WorkflowPreferences;
-  workflows: WorkflowPreferences;
-  channel_types: ChannelTypePreferences;
+  categories: WorkflowPreferences | null;
+  workflows: WorkflowPreferences | null;
+  channel_types: ChannelTypePreferences | null;
 }
 
 export interface PreferenceOptions {

package/src/clients/slack/index.ts

@@ -1,14 +1,9 @@
 import { ApiResponse } from "../../api";
+import { AuthCheckInput, RevokeAccessTokenInput } from "../../interfaces";
 import Knock from "../../knock";
+import { TENANT_OBJECT_COLLECTION } from "../objects/constants";
 
-import {
-  AuthCheckInput,
-  GetSlackChannelsInput,
-  GetSlackChannelsResponse,
-  RevokeAccessTokenInput,
-} from "./interfaces";
-
-const TENANT_COLLECTION = "$tenants";
+import { GetSlackChannelsInput, GetSlackChannelsResponse } from "./interfaces";
 
 class SlackClient {
   private instance: Knock;
@@ -24,7 +19,7 @@ class SlackClient {
       params: {
         access_token_object: {
           object_id: tenant,
-          collection: TENANT_COLLECTION,
+          collection: TENANT_OBJECT_COLLECTION,
         },
         channel_id: knockChannelId,
       },
@@ -45,7 +40,7 @@ class SlackClient {
       params: {
         access_token_object: {
           object_id: tenant,
-          collection: TENANT_COLLECTION,
+          collection: TENANT_OBJECT_COLLECTION,
         },
         channel_id: knockChannelId,
         query_options: {
@@ -68,7 +63,7 @@ class SlackClient {
       params: {
         access_token_object: {
           object_id: tenant,
-          collection: TENANT_COLLECTION,
+          collection: TENANT_OBJECT_COLLECTION,
         },
         channel_id: knockChannelId,
       },

package/src/clients/slack/interfaces.ts

@@ -17,16 +17,6 @@ export type GetSlackChannelsInput = {
   };
 };
 
-export type AuthCheckInput = {
-  tenant: string;
-  knockChannelId: string;
-};
-
-export type RevokeAccessTokenInput = {
-  tenant: string;
-  knockChannelId: string;
-};
-
 export type GetSlackChannelsResponse = {
   slack_channels: SlackChannel[];
   next_cursor: string | null;

package/src/clients/users/index.ts

@@ -3,7 +3,6 @@ import { GenericData } from "@knocklabs/types";
 import { ApiResponse } from "../../api";
 import { ChannelData, User } from "../../interfaces";
 import Knock from "../../knock";
-import { InAppMessagesResponse } from "../in-app-messages";
 import {
   GetPreferencesOptions,
   PreferenceOptions,
@@ -11,11 +10,7 @@ import {
   SetPreferencesProperties,
 } from "../preferences/interfaces";
 
-import {
-  GetChannelDataInput,
-  GetInAppMessagesInput,
-  SetChannelDataInput,
-} from "./interfaces";
+import { GetChannelDataInput, SetChannelDataInput } from "./interfaces";
 
 const DEFAULT_PREFERENCE_SET_ID = "default";
 
@@ -105,19 +100,6 @@ class UserClient {
     return this.handleResponse<ChannelData<T>>(result);
   }
 
-  async getInAppMessages<
-    TContent extends GenericData = GenericData,
-    TData extends GenericData = GenericData,
-  >({ channelId, messageType, params }: GetInAppMessagesInput) {
-    const result = await this.instance.client().makeRequest({
-      method: "GET",
-      url: `/v1/users/${this.instance.userId}/in-app-messages/${channelId}/${messageType}`,
-      params,
-    });
-
-    return this.handleResponse<InAppMessagesResponse<TContent, TData>>(result);
-  }
-
   private handleResponse<T>(response: ApiResponse) {
     if (response.statusCode === "error") {
       throw new Error(response.error || response.body);

package/src/clients/users/interfaces.ts

@@ -1,7 +1,5 @@
 import { GenericData } from "@knocklabs/types";
 
-import { InAppMessagesClientOptions } from "../in-app-messages/types";
-
 export interface SetChannelDataInput {
   channelId: string;
   channelData: GenericData;
@@ -10,9 +8,3 @@ export interface SetChannelDataInput {
 export interface GetChannelDataInput {
   channelId: string;
 }
-
-export interface GetInAppMessagesInput {
-  channelId: string;
-  messageType: string;
-  params: InAppMessagesClientOptions;
-}

package/src/index.ts

@@ -9,10 +9,10 @@ export * from "./clients/objects/constants";
 export * from "./clients/preferences/interfaces";
 export * from "./clients/slack";
 export * from "./clients/slack/interfaces";
+export * from "./clients/ms-teams";
 export * from "./clients/users";
 export * from "./clients/users/interfaces";
 export * from "./clients/messages";
-export * from "./clients/in-app-messages";
 export * from "./clients/messages/interfaces";
 export * from "./networkStatus";
 

package/src/interfaces.ts

@@ -66,3 +66,13 @@ export interface BulkOperation {
   inserted_at: string;
   updated_at: string;
 }
+
+export type AuthCheckInput = {
+  tenant: string;
+  knockChannelId: string;
+};
+
+export type RevokeAccessTokenInput = {
+  tenant: string;
+  knockChannelId: string;
+};

package/src/knock.ts

@@ -3,6 +3,7 @@ import { jwtDecode } from "jwt-decode";
 import ApiClient from "./api";
 import FeedClient from "./clients/feed";
 import MessageClient from "./clients/messages";
+import MsTeamsClient from "./clients/ms-teams";
 import ObjectClient from "./clients/objects";
 import Preferences from "./clients/preferences";
 import SlackClient from "./clients/slack";
@@ -27,6 +28,7 @@ class Knock {
   readonly objects = new ObjectClient(this);
   readonly preferences = new Preferences(this);
   readonly slack = new SlackClient(this);
+  readonly msTeams = new MsTeamsClient(this);
   readonly user = new UserClient(this);
   readonly messages = new MessageClient(this);
 
@@ -48,16 +50,6 @@ class Knock {
   }
 
   client() {
-    if (!this.userId) {
-      console.warn(
-        `[Knock] You must call authenticate(userId, userToken) first before trying to make a request.
-        Typically you'll see this message when you're creating a feed instance before having called
-        authenticate with a user Id and token. That means we won't know who to issue the request
-        to Knock on behalf of.
-        `,
-      );
-    }
-
     // Initiate a new API client if we don't have one yet
     if (!this.apiClient) {
       this.apiClient = this.createApiClient();

package/dist/cjs/clients/in-app-messages/channel-client.js

@@ -1,2 +0,0 @@
-"use strict";var c=Object.defineProperty;var u=(n,e,s)=>e in n?c(n,e,{enumerable:!0,configurable:!0,writable:!0,value:s}):n[e]=s;var a=(n,e,s)=>u(n,typeof e!="symbol"?e+"":e,s);Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const g=require("../../networkStatus.js"),k=require("./socket-manager.js"),l=require("./store.js");class h{constructor(e,s,t={}){a(this,"store");a(this,"socketManager");this.knock=e,this.channelId=s,this.defaultOptions=t,this.store=l.createStore();const{socket:r}=this.knock.client();r&&(this.socketManager=new k.InAppMessageSocketManager(r)),this.knock.log(`[IAM] Initialized a client on channel ${s}`)}setMessageAttrs(e,s){this.store.setState(t=>({...t,messages:{...t.messages,...e.reduce((r,i)=>(t.messages[i]&&(r[i]={...t.messages[i],...s}),r),{})}}))}setQueryResponse(e,s){const t={loading:!1,networkStatus:g.NetworkStatus.ready,data:{messageIds:s.entries.map(r=>r.id),pageInfo:s.pageInfo}};this.store.setState(r=>({...r,messages:s.entries.reduce((i,o)=>(i[o.id]=o,i),r.messages),queries:{...r.queries,[e]:t}}))}setQueryStatus(e,s){this.store.setState(t=>({...t,queries:{...t.queries,[e]:{...t.queries[e],...s}}}))}subscribe(e){if(this.socketManager)return this.knock.log(`[InAppMessagesClient] Subscribe a client ${e.referenceId} to socket events`),this.socketManager.join(e)}unsubscribe(e){this.socketManager&&(this.knock.log(`[InAppMessagesClient] Unsubscribe a client ${e.referenceId}`),this.socketManager.leave(e))}}exports.InAppMessagesChannelClient=h;
-//# sourceMappingURL=channel-client.js.map

package/dist/cjs/clients/in-app-messages/channel-client.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"channel-client.js","sources":["../../../../src/clients/in-app-messages/channel-client.ts"],"sourcesContent":["import Knock from \"../../knock\";\nimport { NetworkStatus } from \"../../networkStatus\";\n\nimport { InAppMessagesClient } from \"./message-client\";\nimport { InAppMessageSocketManager } from \"./socket-manager\";\nimport { InAppMessagesStore, createStore } from \"./store\";\nimport {\n  InAppMessage,\n  InAppMessagesClientOptions,\n  InAppMessagesQueryInfo,\n  InAppMessagesResponse,\n} from \"./types\";\n\n/**\n * Manages the configuration for an in app channel.\n * Stores all fetched messages to support optimistic updates.\n */\nexport class InAppMessagesChannelClient {\n  public store: InAppMessagesStore;\n\n  private socketManager: InAppMessageSocketManager | undefined;\n\n  constructor(\n    readonly knock: Knock,\n    readonly channelId: string,\n    readonly defaultOptions: InAppMessagesClientOptions = {},\n  ) {\n    this.store = createStore();\n\n    // Initialize a socket manager for the in-app channel client, which there\n    // should be one per in-app channel client but it's abstracted out as a\n    // separate module for the organization/encapsulation purposes.\n    const { socket } = this.knock.client();\n    if (socket) {\n      this.socketManager = new InAppMessageSocketManager(socket);\n    }\n\n    this.knock.log(`[IAM] Initialized a client on channel ${channelId}`);\n  }\n\n  // ----------------------------------------------\n  // Store helpers\n  // ----------------------------------------------\n\n  setMessageAttrs(messageIds: string[], attrs: Partial<InAppMessage>) {\n    this.store.setState((state) => ({\n      ...state,\n      messages: {\n        ...state.messages,\n        ...messageIds.reduce<Record<string, InAppMessage>>((messages, id) => {\n          if (state.messages[id]) {\n            messages[id] = {\n              ...state.messages[id],\n              ...attrs,\n            };\n          }\n          return messages;\n        }, {}),\n      },\n    }));\n  }\n\n  setQueryResponse(queryKey: string, response: InAppMessagesResponse) {\n    const queryInfo: InAppMessagesQueryInfo = {\n      loading: false,\n      networkStatus: NetworkStatus.ready,\n      data: {\n        messageIds: response.entries.map((iam) => iam.id),\n        pageInfo: response.pageInfo,\n      },\n    };\n\n    this.store.setState((state) => {\n      return {\n        ...state,\n        // Store new messages in store\n        messages: response.entries.reduce((messages, message) => {\n          messages[message.id] = message;\n          return messages;\n        }, state.messages),\n        // Store query results\n        queries: {\n          ...state.queries,\n          [queryKey]: queryInfo,\n        },\n      };\n    });\n  }\n\n  setQueryStatus(\n    queryKey: string,\n    status: Pick<InAppMessagesQueryInfo, \"loading\" | \"networkStatus\">,\n  ) {\n    this.store.setState((state) => ({\n      ...state,\n      queries: {\n        ...state.queries,\n        [queryKey]: {\n          ...state.queries[queryKey],\n          ...status,\n        },\n      },\n    }));\n  }\n\n  /*\n   * Socket\n   */\n\n  subscribe(client: InAppMessagesClient) {\n    if (!this.socketManager) return;\n    this.knock.log(\n      `[InAppMessagesClient] Subscribe a client ${client.referenceId} to socket events`,\n    );\n\n    // Pass the unsub func back to iam client so it can be used when\n    // unsubscribing.\n    return this.socketManager.join(client);\n  }\n\n  unsubscribe(client: InAppMessagesClient) {\n    if (!this.socketManager) return;\n    this.knock.log(\n      `[InAppMessagesClient] Unsubscribe a client ${client.referenceId}`,\n    );\n\n    this.socketManager.leave(client);\n  }\n}\n"],"names":["InAppMessagesChannelClient","knock","channelId","defaultOptions","__publicField","createStore","socket","InAppMessageSocketManager","messageIds","attrs","state","messages","id","queryKey","response","queryInfo","NetworkStatus","iam","message","status","client"],"mappings":"uVAiBO,MAAMA,CAA2B,CAKtC,YACWC,EACAC,EACAC,EAA6C,CAAA,EACtD,CARKC,EAAA,cAECA,EAAA,sBAGG,KAAA,MAAAH,EACA,KAAA,UAAAC,EACA,KAAA,eAAAC,EAET,KAAK,MAAQE,EAAAA,cAKb,KAAM,CAAE,OAAAC,CAAW,EAAA,KAAK,MAAM,OAAO,EACjCA,IACG,KAAA,cAAgB,IAAIC,EAAA,0BAA0BD,CAAM,GAG3D,KAAK,MAAM,IAAI,yCAAyCJ,CAAS,EAAE,CACrE,CAMA,gBAAgBM,EAAsBC,EAA8B,CAC7D,KAAA,MAAM,SAAUC,IAAW,CAC9B,GAAGA,EACH,SAAU,CACR,GAAGA,EAAM,SACT,GAAGF,EAAW,OAAqC,CAACG,EAAUC,KACxDF,EAAM,SAASE,CAAE,IACnBD,EAASC,CAAE,EAAI,CACb,GAAGF,EAAM,SAASE,CAAE,EACpB,GAAGH,CAAA,GAGAE,GACN,EAAE,CACP,CACA,EAAA,CACJ,CAEA,iBAAiBE,EAAkBC,EAAiC,CAClE,MAAMC,EAAoC,CACxC,QAAS,GACT,cAAeC,EAAc,cAAA,MAC7B,KAAM,CACJ,WAAYF,EAAS,QAAQ,IAAKG,GAAQA,EAAI,EAAE,EAChD,SAAUH,EAAS,QACrB,CAAA,EAGG,KAAA,MAAM,SAAUJ,IACZ,CACL,GAAGA,EAEH,SAAUI,EAAS,QAAQ,OAAO,CAACH,EAAUO,KAClCP,EAAAO,EAAQ,EAAE,EAAIA,EAChBP,GACND,EAAM,QAAQ,EAEjB,QAAS,CACP,GAAGA,EAAM,QACT,CAACG,CAAQ,EAAGE,CACd,CAAA,EAEH,CACH,CAEA,eACEF,EACAM,EACA,CACK,KAAA,MAAM,SAAUT,IAAW,CAC9B,GAAGA,EACH,QAAS,CACP,GAAGA,EAAM,QACT,CAACG,CAAQ,EAAG,CACV,GAAGH,EAAM,QAAQG,CAAQ,EACzB,GAAGM,CACL,CACF,CACA,EAAA,CACJ,CAMA,UAAUC,EAA6B,CACjC,GAAC,KAAK,cACV,YAAK,MAAM,IACT,4CAA4CA,EAAO,WAAW,mBAAA,EAKzD,KAAK,cAAc,KAAKA,CAAM,CACvC,CAEA,YAAYA,EAA6B,CAClC,KAAK,gBACV,KAAK,MAAM,IACT,8CAA8CA,EAAO,WAAW,EAAA,EAG7D,KAAA,cAAc,MAAMA,CAAM,EACjC,CACF"}

package/dist/cjs/clients/in-app-messages/message-client.js

@@ -1,2 +0,0 @@
-"use strict";var o=Object.defineProperty;var l=(a,e,t)=>e in a?o(a,e,{enumerable:!0,configurable:!0,writable:!0,value:t}):a[e]=t;var r=(a,e,t)=>l(a,typeof e!="symbol"?e+"":e,t);Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const g=require("nanoid"),i=require("../../networkStatus.js"),k=require("./socket-manager.js");class y{constructor(e,t,s={}){r(this,"knock");r(this,"queryKey");r(this,"referenceId");r(this,"unsub");this.channelClient=e,this.messageType=t,this.defaultOptions=s,this.defaultOptions={...e.defaultOptions,...s},this.knock=e.knock,this.queryKey=this.buildQueryKey(this.defaultOptions),this.referenceId=g.nanoid(),this.knock.log(`[IAM] Initialized a client for message ${t}`)}async fetch(){const e=this.defaultOptions;this.queryKey=this.buildQueryKey(e);const s=(this.channelClient.store.state.queries[this.queryKey]??{loading:!1,networkStatus:i.NetworkStatus.ready}).networkStatus;if(!(s&&i.isRequestInFlight(s))){this.channelClient.setQueryStatus(this.queryKey,{networkStatus:i.NetworkStatus.loading,loading:!0});try{const n=await this.knock.user.getInAppMessages({channelId:this.channelClient.channelId,messageType:this.messageType,params:e});return this.channelClient.setQueryResponse(this.queryKey,n),{data:n,status:"ok"}}catch(n){return this.channelClient.setQueryStatus(this.queryKey,{networkStatus:i.NetworkStatus.error,loading:!1}),{status:"error",error:n}}}}getQueryInfoSelector(e){var c;const t=e.queries[this.queryKey];return{messages:(((c=t==null?void 0:t.data)==null?void 0:c.messageIds)??[]).reduce((h,d)=>{const u=e.messages[d];return u&&h.push(u),h},[]),networkStatus:(t==null?void 0:t.networkStatus)??i.NetworkStatus.ready,loading:(t==null?void 0:t.loading)??!1}}async markAsSeen(e){const t=this.getItemIds(e);return this.channelClient.setMessageAttrs(t,{seen_at:new Date().toISOString()}),this.makeStatusUpdate(e,"seen")}async markAsUnseen(e){const t=this.getItemIds(e);return this.channelClient.setMessageAttrs(t,{seen_at:null}),this.makeStatusUpdate(e,"unseen")}async markAsRead(e){const t=this.getItemIds(e);return this.channelClient.setMessageAttrs(t,{read_at:new Date().toISOString()}),this.makeStatusUpdate(e,"read")}async markAsUnread(e){const t=this.getItemIds(e);return this.channelClient.setMessageAttrs(t,{read_at:null}),this.makeStatusUpdate(e,"unread")}async markAsInteracted(e,t){const s=new Date().toISOString(),n=this.getItemIds(e);return this.channelClient.setMessageAttrs(n,{read_at:s,interacted_at:s}),this.makeStatusUpdate(e,"interacted",t)}async markAsArchived(e){const t=this.getItemIds(e);return this.channelClient.setMessageAttrs(t,{archived_at:new Date().toISOString()}),this.makeStatusUpdate(e,"archived")}async markAsUnarchived(e){const t=this.getItemIds(e);return this.channelClient.setMessageAttrs(t,{archived_at:null}),this.makeStatusUpdate(e,"unarchived")}async makeStatusUpdate(e,t,s){const n=this.getItemIds(e);return await this.knock.messages.batchUpdateStatuses(n,t,{metadata:s})}buildQueryKey(e){const t=`/v1/users/${this.knock.userId}/in-app-messages/${this.channelClient.channelId}/${this.messageType}`,s=new URLSearchParams(e).toString();return s?`${t}?${s}`:t}subscribe(){this.unsub=this.channelClient.subscribe(this)}unsubscribe(){this.channelClient.unsubscribe(this)}async handleSocketEvent(e){switch(e.event){case k.SocketEventType.MessageCreated:return await this.fetch();default:throw new Error(`Unhandled socket event: ${e.event}`)}}socketChannelTopic(){return`in_app:${this.messageType}:${this.channelClient.channelId}:${this.knock.userId}`}getItemIds(e){return(Array.isArray(e)?e:[e]).map(s=>s.id)}}exports.InAppMessagesClient=y;
-//# sourceMappingURL=message-client.js.map

package/dist/cjs/clients/in-app-messages/message-client.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"message-client.js","sources":["../../../../src/clients/in-app-messages/message-client.ts"],"sourcesContent":["import { GenericData } from \"@knocklabs/types\";\nimport { nanoid } from \"nanoid\";\n\nimport Knock from \"../../knock\";\nimport { NetworkStatus, isRequestInFlight } from \"../../networkStatus\";\nimport { MessageEngagementStatus } from \"../messages/interfaces\";\n\nimport { InAppMessagesChannelClient } from \"./channel-client\";\nimport { SocketEventPayload, SocketEventType } from \"./socket-manager\";\nimport {\n  InAppMessage,\n  InAppMessagesClientOptions,\n  InAppMessagesResponse,\n  InAppMessagesStoreState,\n} from \"./types\";\n\n/**\n * Manages realtime connection to in app messages service.\n */\nexport class InAppMessagesClient {\n  private knock: Knock;\n\n  public queryKey: string;\n  public referenceId: string;\n  public unsub?: () => void;\n\n  constructor(\n    readonly channelClient: InAppMessagesChannelClient,\n    readonly messageType: string,\n    readonly defaultOptions: InAppMessagesClientOptions = {},\n  ) {\n    this.defaultOptions = {\n      ...channelClient.defaultOptions,\n      ...defaultOptions,\n    };\n    this.knock = channelClient.knock;\n    this.queryKey = this.buildQueryKey(this.defaultOptions);\n    this.referenceId = nanoid();\n\n    this.knock.log(`[IAM] Initialized a client for message ${messageType}`);\n  }\n\n  // ----------------------------------------------\n  // Data fetching\n  // ----------------------------------------------\n  async fetch<\n    TContent extends GenericData = GenericData,\n    TData extends GenericData = GenericData,\n  >(): Promise<\n    | {\n        status: \"ok\";\n        data: InAppMessagesResponse<TContent, TData>;\n      }\n    | {\n        status: \"error\";\n        error: Error;\n      }\n    | undefined\n  > {\n    const params = this.defaultOptions;\n\n    this.queryKey = this.buildQueryKey(params);\n\n    const queryState = this.channelClient.store.state.queries[\n      this.queryKey\n    ] ?? {\n      loading: false,\n      networkStatus: NetworkStatus.ready,\n    };\n    const networkStatus = queryState.networkStatus;\n\n    // If there's an existing request in flight, then do nothing\n    if (networkStatus && isRequestInFlight(networkStatus)) {\n      return;\n    }\n\n    // Set the loading type based on the request type it is\n    this.channelClient.setQueryStatus(this.queryKey, {\n      networkStatus: NetworkStatus.loading,\n      loading: true,\n    });\n\n    try {\n      const response = await this.knock.user.getInAppMessages<TContent, TData>({\n        channelId: this.channelClient.channelId,\n        messageType: this.messageType,\n        params,\n      });\n\n      this.channelClient.setQueryResponse(this.queryKey, response);\n\n      return { data: response, status: \"ok\" };\n    } catch (error) {\n      this.channelClient.setQueryStatus(this.queryKey, {\n        networkStatus: NetworkStatus.error,\n        loading: false,\n      });\n\n      return {\n        status: \"error\",\n        error: error as Error,\n      };\n    }\n  }\n\n  getQueryInfoSelector<\n    TContent extends GenericData = GenericData,\n    TData extends GenericData = GenericData,\n  >(\n    state: InAppMessagesStoreState,\n  ): {\n    messages: InAppMessage<TContent, TData>[];\n    loading: boolean;\n    networkStatus: NetworkStatus;\n  } {\n    const queryInfo = state.queries[this.queryKey];\n    const messageIds = queryInfo?.data?.messageIds ?? [];\n\n    const messages = messageIds.reduce<InAppMessage<TContent, TData>[]>(\n      (messages, messageId) => {\n        const message = state.messages[messageId];\n        if (message) {\n          messages.push(message as InAppMessage<TContent, TData>);\n        }\n        return messages;\n      },\n      [],\n    );\n\n    return {\n      messages,\n      networkStatus: queryInfo?.networkStatus ?? NetworkStatus.ready,\n      loading: queryInfo?.loading ?? false,\n    };\n  }\n\n  // ----------------------------------------------\n  // Message engagement\n  // ----------------------------------------------\n  async markAsSeen(itemOrItems: InAppMessage | InAppMessage[]) {\n    const itemIds = this.getItemIds(itemOrItems);\n\n    this.channelClient.setMessageAttrs(itemIds, {\n      seen_at: new Date().toISOString(),\n    });\n\n    return this.makeStatusUpdate(itemOrItems, \"seen\");\n  }\n\n  async markAsUnseen(itemOrItems: InAppMessage | InAppMessage[]) {\n    const itemIds = this.getItemIds(itemOrItems);\n\n    this.channelClient.setMessageAttrs(itemIds, {\n      seen_at: null,\n    });\n\n    return this.makeStatusUpdate(itemOrItems, \"unseen\");\n  }\n\n  async markAsRead(itemOrItems: InAppMessage | InAppMessage[]) {\n    const itemIds = this.getItemIds(itemOrItems);\n\n    this.channelClient.setMessageAttrs(itemIds, {\n      read_at: new Date().toISOString(),\n    });\n\n    return this.makeStatusUpdate(itemOrItems, \"read\");\n  }\n\n  async markAsUnread(itemOrItems: InAppMessage | InAppMessage[]) {\n    const itemIds = this.getItemIds(itemOrItems);\n\n    this.channelClient.setMessageAttrs(itemIds, {\n      read_at: null,\n    });\n\n    return this.makeStatusUpdate(itemOrItems, \"unread\");\n  }\n\n  async markAsInteracted(\n    itemOrItems: InAppMessage | InAppMessage[],\n    metadata?: Record<string, string>,\n  ) {\n    const now = new Date().toISOString();\n    const itemIds = this.getItemIds(itemOrItems);\n\n    this.channelClient.setMessageAttrs(itemIds, {\n      read_at: now,\n      interacted_at: now,\n    });\n\n    return this.makeStatusUpdate(itemOrItems, \"interacted\", metadata);\n  }\n\n  async markAsArchived(itemOrItems: InAppMessage | InAppMessage[]) {\n    const itemIds = this.getItemIds(itemOrItems);\n\n    this.channelClient.setMessageAttrs(itemIds, {\n      archived_at: new Date().toISOString(),\n    });\n\n    return this.makeStatusUpdate(itemOrItems, \"archived\");\n  }\n\n  async markAsUnarchived(itemOrItems: InAppMessage | InAppMessage[]) {\n    const itemIds = this.getItemIds(itemOrItems);\n\n    this.channelClient.setMessageAttrs(itemIds, {\n      archived_at: null,\n    });\n\n    return this.makeStatusUpdate(itemOrItems, \"unarchived\");\n  }\n\n  private async makeStatusUpdate(\n    itemOrItems: InAppMessage | InAppMessage[],\n    type: MessageEngagementStatus | \"unread\" | \"unseen\" | \"unarchived\",\n    metadata?: Record<string, string>,\n  ) {\n    // Always treat items as a batch to use the corresponding batch endpoint\n    const itemIds = this.getItemIds(itemOrItems);\n\n    const result = await this.knock.messages.batchUpdateStatuses(\n      itemIds,\n      type,\n      { metadata },\n    );\n\n    return result;\n  }\n\n  // ----------------------------------------------\n  // Helpers\n  // ----------------------------------------------\n  private buildQueryKey(params: GenericData): string {\n    const baseKey = `/v1/users/${this.knock.userId}/in-app-messages/${this.channelClient.channelId}/${this.messageType}`;\n    const paramsString = new URLSearchParams(params).toString();\n    return paramsString ? `${baseKey}?${paramsString}` : baseKey;\n  }\n\n  subscribe() {\n    this.unsub = this.channelClient.subscribe(this);\n  }\n\n  unsubscribe() {\n    this.channelClient.unsubscribe(this);\n  }\n\n  // This is a callback function that will be invoked when a new socket event\n  // relevant for this message client is received (and if subscribed).\n  async handleSocketEvent(payload: SocketEventPayload) {\n    switch (payload.event) {\n      case SocketEventType.MessageCreated:\n        // TODO(KNO-7169): Explore using an in-app message in the socket event\n        // directly instead of re-fetching.\n        return await this.fetch();\n\n      default:\n        throw new Error(`Unhandled socket event: ${payload.event}`);\n    }\n  }\n\n  socketChannelTopic() {\n    return `in_app:${this.messageType}:${this.channelClient.channelId}:${this.knock.userId}`;\n  }\n\n  private getItemIds(itemOrItems: InAppMessage | InAppMessage[]): string[] {\n    const items = Array.isArray(itemOrItems) ? itemOrItems : [itemOrItems];\n    return items.map((item) => item.id);\n  }\n}\n"],"names":["InAppMessagesClient","channelClient","messageType","defaultOptions","__publicField","nanoid","params","networkStatus","NetworkStatus","isRequestInFlight","response","error","state","queryInfo","_a","messages","messageId","message","itemOrItems","itemIds","metadata","now","type","baseKey","paramsString","payload","SocketEventType","item"],"mappings":"mVAmBO,MAAMA,CAAoB,CAO/B,YACWC,EACAC,EACAC,EAA6C,CAAA,EACtD,CAVMC,EAAA,cAEDA,EAAA,iBACAA,EAAA,oBACAA,EAAA,cAGI,KAAA,cAAAH,EACA,KAAA,YAAAC,EACA,KAAA,eAAAC,EAET,KAAK,eAAiB,CACpB,GAAGF,EAAc,eACjB,GAAGE,CAAA,EAEL,KAAK,MAAQF,EAAc,MAC3B,KAAK,SAAW,KAAK,cAAc,KAAK,cAAc,EACtD,KAAK,YAAcI,EAAAA,SAEnB,KAAK,MAAM,IAAI,0CAA0CH,CAAW,EAAE,CACxE,CAKA,MAAM,OAaJ,CACA,MAAMI,EAAS,KAAK,eAEf,KAAA,SAAW,KAAK,cAAcA,CAAM,EAQzC,MAAMC,GANa,KAAK,cAAc,MAAM,MAAM,QAChD,KAAK,QACP,GAAK,CACH,QAAS,GACT,cAAeC,EAAc,cAAA,KAAA,GAEE,cAG7B,GAAAD,EAAAA,GAAiBE,oBAAkBF,CAAa,GAK/C,MAAA,cAAc,eAAe,KAAK,SAAU,CAC/C,cAAeC,EAAc,cAAA,QAC7B,QAAS,EAAA,CACV,EAEG,GAAA,CACF,MAAME,EAAW,MAAM,KAAK,MAAM,KAAK,iBAAkC,CACvE,UAAW,KAAK,cAAc,UAC9B,YAAa,KAAK,YAClB,OAAAJ,CAAA,CACD,EAED,YAAK,cAAc,iBAAiB,KAAK,SAAUI,CAAQ,EAEpD,CAAE,KAAMA,EAAU,OAAQ,IAAK,QAC/BC,EAAO,CACT,YAAA,cAAc,eAAe,KAAK,SAAU,CAC/C,cAAeH,EAAc,cAAA,MAC7B,QAAS,EAAA,CACV,EAEM,CACL,OAAQ,QACR,MAAAG,CAAA,CAEJ,EACF,CAEA,qBAIEC,EAKA,OACA,MAAMC,EAAYD,EAAM,QAAQ,KAAK,QAAQ,EActC,MAAA,CACL,YAdiBE,EAAAD,GAAA,YAAAA,EAAW,OAAX,YAAAC,EAAiB,aAAc,CAAA,GAEtB,OAC1B,CAACC,EAAUC,IAAc,CACjB,MAAAC,EAAUL,EAAM,SAASI,CAAS,EACxC,OAAIC,GACFF,EAAS,KAAKE,CAAwC,EAEjDF,CACT,EACA,CAAC,CAAA,EAKD,eAAeF,GAAA,YAAAA,EAAW,gBAAiBL,EAAAA,cAAc,MACzD,SAASK,GAAA,YAAAA,EAAW,UAAW,EAAA,CAEnC,CAKA,MAAM,WAAWK,EAA4C,CACrD,MAAAC,EAAU,KAAK,WAAWD,CAAW,EAEtC,YAAA,cAAc,gBAAgBC,EAAS,CAC1C,QAAS,IAAI,KAAK,EAAE,YAAY,CAAA,CACjC,EAEM,KAAK,iBAAiBD,EAAa,MAAM,CAClD,CAEA,MAAM,aAAaA,EAA4C,CACvD,MAAAC,EAAU,KAAK,WAAWD,CAAW,EAEtC,YAAA,cAAc,gBAAgBC,EAAS,CAC1C,QAAS,IAAA,CACV,EAEM,KAAK,iBAAiBD,EAAa,QAAQ,CACpD,CAEA,MAAM,WAAWA,EAA4C,CACrD,MAAAC,EAAU,KAAK,WAAWD,CAAW,EAEtC,YAAA,cAAc,gBAAgBC,EAAS,CAC1C,QAAS,IAAI,KAAK,EAAE,YAAY,CAAA,CACjC,EAEM,KAAK,iBAAiBD,EAAa,MAAM,CAClD,CAEA,MAAM,aAAaA,EAA4C,CACvD,MAAAC,EAAU,KAAK,WAAWD,CAAW,EAEtC,YAAA,cAAc,gBAAgBC,EAAS,CAC1C,QAAS,IAAA,CACV,EAEM,KAAK,iBAAiBD,EAAa,QAAQ,CACpD,CAEA,MAAM,iBACJA,EACAE,EACA,CACA,MAAMC,EAAM,IAAI,KAAK,EAAE,YAAY,EAC7BF,EAAU,KAAK,WAAWD,CAAW,EAEtC,YAAA,cAAc,gBAAgBC,EAAS,CAC1C,QAASE,EACT,cAAeA,CAAA,CAChB,EAEM,KAAK,iBAAiBH,EAAa,aAAcE,CAAQ,CAClE,CAEA,MAAM,eAAeF,EAA4C,CACzD,MAAAC,EAAU,KAAK,WAAWD,CAAW,EAEtC,YAAA,cAAc,gBAAgBC,EAAS,CAC1C,YAAa,IAAI,KAAK,EAAE,YAAY,CAAA,CACrC,EAEM,KAAK,iBAAiBD,EAAa,UAAU,CACtD,CAEA,MAAM,iBAAiBA,EAA4C,CAC3D,MAAAC,EAAU,KAAK,WAAWD,CAAW,EAEtC,YAAA,cAAc,gBAAgBC,EAAS,CAC1C,YAAa,IAAA,CACd,EAEM,KAAK,iBAAiBD,EAAa,YAAY,CACxD,CAEA,MAAc,iBACZA,EACAI,EACAF,EACA,CAEM,MAAAD,EAAU,KAAK,WAAWD,CAAW,EAQpC,OANQ,MAAM,KAAK,MAAM,SAAS,oBACvCC,EACAG,EACA,CAAE,SAAAF,CAAS,CAAA,CAIf,CAKQ,cAAcd,EAA6B,CAC3C,MAAAiB,EAAU,aAAa,KAAK,MAAM,MAAM,oBAAoB,KAAK,cAAc,SAAS,IAAI,KAAK,WAAW,GAC5GC,EAAe,IAAI,gBAAgBlB,CAAM,EAAE,SAAS,EAC1D,OAAOkB,EAAe,GAAGD,CAAO,IAAIC,CAAY,GAAKD,CACvD,CAEA,WAAY,CACV,KAAK,MAAQ,KAAK,cAAc,UAAU,IAAI,CAChD,CAEA,aAAc,CACP,KAAA,cAAc,YAAY,IAAI,CACrC,CAIA,MAAM,kBAAkBE,EAA6B,CACnD,OAAQA,EAAQ,MAAO,CACrB,KAAKC,EAAgB,gBAAA,eAGZ,OAAA,MAAM,KAAK,QAEpB,QACE,MAAM,IAAI,MAAM,2BAA2BD,EAAQ,KAAK,EAAE,CAC9D,CACF,CAEA,oBAAqB,CACZ,MAAA,UAAU,KAAK,WAAW,IAAI,KAAK,cAAc,SAAS,IAAI,KAAK,MAAM,MAAM,EACxF,CAEQ,WAAWP,EAAsD,CAEvE,OADc,MAAM,QAAQA,CAAW,EAAIA,EAAc,CAACA,CAAW,GACxD,IAAKS,GAASA,EAAK,EAAE,CACpC,CACF"}

package/dist/cjs/clients/in-app-messages/socket-manager.js

@@ -1,2 +0,0 @@
-"use strict";var b=Object.defineProperty;var m=(t,e,s)=>e in t?b(t,e,{enumerable:!0,configurable:!0,writable:!0,value:s}):t[e]=s;var h=(t,e,s)=>m(t,typeof e!="symbol"?e+"":e,s);Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const g=require("@tanstack/store");var l=(t=>(t.MessageCreated="message.created",t))(l||{});const f=["message.created"];class S{constructor(e){h(this,"channels");h(this,"params");h(this,"inbox");this.socket=e,this.channels={},this.params={},this.inbox=new g.Store({})}join(e){const s=e.socketChannelTopic(),n=e.referenceId,o=e.defaultOptions;this.socket.isConnected()||this.socket.connect(),this.params[s]||(this.params[s]={});const a=this.params[s][n],p=!a||JSON.stringify(a)!==JSON.stringify(o);if(p&&(this.params[s]={...this.params[s],[n]:o}),!this.channels[s]||p){const c=this.socket.channel(s,this.params[s]);for(const d of f)c.on(d,u=>this.setInbox(u));this.channels[s]=c}const r=this.channels[s];return["closed","errored"].includes(r.state)&&r.join(),this.inbox.subscribe(()=>{const c=this.inbox.state[n];c&&e.handleSocketEvent(c)})}leave(e){e.unsub&&e.unsub();const s=e.socketChannelTopic(),n=e.referenceId,o={...this.params},a=o[s]||{};a[n]&&delete a[n];const r={...this.channels},i=r[s];if(i&&Object.keys(a).length===0){for(const c of f)i.off(c);i.leave(),delete r[s]}this.params=o,this.channels=r}setInbox(e){const{attn:s,...n}=e;this.inbox.setState(()=>s.reduce((o,a)=>({...o,[a]:n}),{}))}}exports.InAppMessageSocketManager=S;exports.SocketEventType=l;
-//# sourceMappingURL=socket-manager.js.map

package/dist/cjs/clients/in-app-messages/socket-manager.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"socket-manager.js","sources":["../../../../src/clients/in-app-messages/socket-manager.ts"],"sourcesContent":["import { Store } from \"@tanstack/store\";\nimport { Channel, Socket } from \"phoenix\";\n\nimport { InAppMessagesClient } from \"./message-client\";\nimport { InAppMessage, InAppMessagesClientOptions } from \"./types\";\n\nexport enum SocketEventType {\n  MessageCreated = \"message.created\",\n}\n\nconst SOCKET_EVENT_TYPES = [SocketEventType.MessageCreated];\n\ntype ClientQueryParams = InAppMessagesClientOptions;\n\n// e.g. in_app:<message-type>:<channel_id>:<user_id>\ntype ChannelTopic = string;\n\n// Unique reference id of an in-app message client\ntype ClientReferenceId = string;\n\ntype MessageCreatedEventPayload = {\n  event: SocketEventType.MessageCreated;\n  topic: string;\n  data: {\n    in_app_message: InAppMessage;\n  };\n};\n\nexport type SocketEventPayload = MessageCreatedEventPayload;\n\n// \"attn\" field contains a list of client reference ids that should be notified\n// of a socket event.\ntype WithAttn<P> = P & { attn: Array<ClientReferenceId> };\n\ntype InAppMessageSocketInbox = Record<ClientReferenceId, SocketEventPayload>;\n\n/*\n * Manages socket subscriptions for in-app messages, allowing multiple in-app\n * message clients or components to listen for real time updates from the socket\n * API via a single socket connection. It's expected to be instantiated once\n * per an in-app channel.\n */\nexport class InAppMessageSocketManager {\n  // Mapping of live channels by topic. Note, there can be one or more in-app\n  // message client(s) that can subscribe.\n  private channels: Record<ChannelTopic, Channel>;\n\n  // Mapping of query params for each in-app message client, partitioned by its\n  // reference id, and grouped by channel topic. It's a double nested object\n  // that looks like:\n  //  {\n  //    \"in_app:card:...\": {\n  //      \"ref-1\": {\n  //        \"workflow_key\": \"foo\",\n  //      },\n  //      \"ref-2\": {\n  //        \"workflow_key\": \"bar\",\n  //      },\n  //    },\n  //    \"in_app:banner:...\": {\n  //      \"ref-3\": {\n  //        \"workflow_key\": \"baz\",\n  //      },\n  //    }\n  //  }\n  //\n  // Each time a new in-app message client joins a channel, we send all cumulated\n  // params such that the socket API can apply filtering rules and figure out\n  // which in-app message clients should be notified basd on reference ids in\n  // \"attn\" field of the event payload when sending out an event.\n  private params: Record<\n    ChannelTopic,\n    Record<ClientReferenceId, ClientQueryParams>\n  >;\n\n  // A reactive store that captures a new socket event, that notifies any in-app\n  // message clients that have subscribed.\n  private inbox: Store<\n    InAppMessageSocketInbox,\n    (cb: InAppMessageSocketInbox) => InAppMessageSocketInbox\n  >;\n\n  constructor(readonly socket: Socket) {\n    this.channels = {};\n    this.params = {};\n    this.inbox = new Store<InAppMessageSocketInbox>({});\n  }\n\n  join(iamClient: InAppMessagesClient) {\n    const topic = iamClient.socketChannelTopic();\n    const referenceId = iamClient.referenceId;\n    const params = iamClient.defaultOptions;\n\n    // Ensure a live socket connection if not yet connected.\n    if (!this.socket.isConnected()) {\n      this.socket.connect();\n    }\n\n    // If a new in-app message client joins, or has updated query params then\n    // track the updated params and (re)join with the latest query params.\n    // Note, each time we send combined params of all in-app message clients that\n    // have subscribed for a given message type (and an in-app channel and a\n    // user), grouped by client's reference id.\n    if (!this.params[topic]) {\n      this.params[topic] = {};\n    }\n\n    const maybeParams = this.params[topic][referenceId];\n    const hasNewOrUpdatedParams =\n      !maybeParams || JSON.stringify(maybeParams) !== JSON.stringify(params);\n\n    if (hasNewOrUpdatedParams) {\n      // Tracks all subscribed client's params by its reference id and by topic.\n      this.params[topic] = { ...this.params[topic], [referenceId]: params };\n    }\n\n    if (!this.channels[topic] || hasNewOrUpdatedParams) {\n      const newChannel = this.socket.channel(topic, this.params[topic]);\n      for (const eventType of SOCKET_EVENT_TYPES) {\n        newChannel.on(eventType, (payload) => this.setInbox(payload));\n      }\n      // Tracks live channels by channel topic.\n      this.channels[topic] = newChannel;\n    }\n\n    const channel = this.channels[topic];\n\n    // Join the channel if not already joined or joining or leaving.\n    if ([\"closed\", \"errored\"].includes(channel.state)) {\n      channel.join();\n    }\n\n    // Let the in-app message client subscribe to the \"inbox\", so it can be\n    // notified when there's a new socket event that is relevant for the client.\n    const unsub = this.inbox.subscribe(() => {\n      const payload = this.inbox.state[referenceId];\n      if (!payload) return;\n\n      iamClient.handleSocketEvent(payload);\n    });\n\n    return unsub;\n  }\n\n  leave(iamClient: InAppMessagesClient) {\n    if (iamClient.unsub) {\n      iamClient.unsub();\n    }\n\n    const topic = iamClient.socketChannelTopic();\n    const referenceId = iamClient.referenceId;\n\n    const partitionedParams = { ...this.params };\n    const paramsForTopic = partitionedParams[topic] || {};\n    const paramsForReferenceClient = paramsForTopic[referenceId];\n\n    if (paramsForReferenceClient) {\n      delete paramsForTopic[referenceId];\n    }\n\n    const channels = { ...this.channels };\n    const channelForTopic = channels[topic];\n    if (channelForTopic && Object.keys(paramsForTopic).length === 0) {\n      for (const eventType of SOCKET_EVENT_TYPES) {\n        channelForTopic.off(eventType);\n      }\n      channelForTopic.leave();\n      delete channels[topic];\n    }\n\n    this.params = partitionedParams;\n    this.channels = channels;\n  }\n\n  private setInbox(payload: WithAttn<SocketEventPayload>) {\n    const { attn, ...rest } = payload;\n\n    // Set the incoming socket event into the inbox, keyed by relevant client\n    // reference ids provided by the server (via attn field), so we can notify\n    // only the clients that need to be notified.\n    this.inbox.setState(() =>\n      attn.reduce((acc, referenceId) => {\n        return { ...acc, [referenceId]: rest };\n      }, {}),\n    );\n  }\n}\n"],"names":["SocketEventType","SOCKET_EVENT_TYPES","InAppMessageSocketManager","socket","__publicField","Store","iamClient","topic","referenceId","params","maybeParams","hasNewOrUpdatedParams","newChannel","eventType","payload","channel","partitionedParams","paramsForTopic","channels","channelForTopic","attn","rest","acc"],"mappings":"uRAMY,IAAAA,GAAAA,IACVA,EAAA,eAAiB,kBADPA,IAAAA,GAAA,CAAA,CAAA,EAIZ,MAAMC,EAAqB,CAAC,mBAgCrB,MAAMC,CAA0B,CAwCrC,YAAqBC,EAAgB,CArC7BC,EAAA,iBAyBAA,EAAA,eAOAA,EAAA,cAKa,KAAA,OAAAD,EACnB,KAAK,SAAW,GAChB,KAAK,OAAS,GACd,KAAK,MAAQ,IAAIE,EAA+B,MAAA,CAAE,CAAA,CACpD,CAEA,KAAKC,EAAgC,CAC7B,MAAAC,EAAQD,EAAU,qBAClBE,EAAcF,EAAU,YACxBG,EAASH,EAAU,eAGpB,KAAK,OAAO,eACf,KAAK,OAAO,UAQT,KAAK,OAAOC,CAAK,IACf,KAAA,OAAOA,CAAK,EAAI,IAGvB,MAAMG,EAAc,KAAK,OAAOH,CAAK,EAAEC,CAAW,EAC5CG,EACJ,CAACD,GAAe,KAAK,UAAUA,CAAW,IAAM,KAAK,UAAUD,CAAM,EAOvE,GALIE,IAEF,KAAK,OAAOJ,CAAK,EAAI,CAAE,GAAG,KAAK,OAAOA,CAAK,EAAG,CAACC,CAAW,EAAGC,CAAO,GAGlE,CAAC,KAAK,SAASF,CAAK,GAAKI,EAAuB,CAC5C,MAAAC,EAAa,KAAK,OAAO,QAAQL,EAAO,KAAK,OAAOA,CAAK,CAAC,EAChE,UAAWM,KAAaZ,EACtBW,EAAW,GAAGC,EAAYC,GAAY,KAAK,SAASA,CAAO,CAAC,EAGzD,KAAA,SAASP,CAAK,EAAIK,CACzB,CAEM,MAAAG,EAAU,KAAK,SAASR,CAAK,EAGnC,MAAI,CAAC,SAAU,SAAS,EAAE,SAASQ,EAAQ,KAAK,GAC9CA,EAAQ,KAAK,EAKD,KAAK,MAAM,UAAU,IAAM,CACvC,MAAMD,EAAU,KAAK,MAAM,MAAMN,CAAW,EACvCM,GAELR,EAAU,kBAAkBQ,CAAO,CAAA,CACpC,CAGH,CAEA,MAAMR,EAAgC,CAChCA,EAAU,OACZA,EAAU,MAAM,EAGZ,MAAAC,EAAQD,EAAU,qBAClBE,EAAcF,EAAU,YAExBU,EAAoB,CAAE,GAAG,KAAK,MAAO,EACrCC,EAAiBD,EAAkBT,CAAK,GAAK,CAAA,EAClBU,EAAeT,CAAW,GAGzD,OAAOS,EAAeT,CAAW,EAGnC,MAAMU,EAAW,CAAE,GAAG,KAAK,QAAS,EAC9BC,EAAkBD,EAASX,CAAK,EACtC,GAAIY,GAAmB,OAAO,KAAKF,CAAc,EAAE,SAAW,EAAG,CAC/D,UAAWJ,KAAaZ,EACtBkB,EAAgB,IAAIN,CAAS,EAE/BM,EAAgB,MAAM,EACtB,OAAOD,EAASX,CAAK,CACvB,CAEA,KAAK,OAASS,EACd,KAAK,SAAWE,CAClB,CAEQ,SAASJ,EAAuC,CACtD,KAAM,CAAE,KAAAM,EAAM,GAAGC,CAAA,EAASP,EAK1B,KAAK,MAAM,SAAS,IAClBM,EAAK,OAAO,CAACE,EAAKd,KACT,CAAE,GAAGc,EAAK,CAACd,CAAW,EAAGa,CAAK,GACpC,EAAE,CAAA,CAET,CACF"}

package/dist/cjs/clients/in-app-messages/store.js

@@ -1,2 +0,0 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("@tanstack/store");function r(){return new e.Store({messages:{},queries:{}})}exports.createStore=r;
-//# sourceMappingURL=store.js.map

package/dist/cjs/clients/in-app-messages/store.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"store.js","sources":["../../../../src/clients/in-app-messages/store.ts"],"sourcesContent":["import { Store } from \"@tanstack/store\";\n\nimport { InAppMessagesStoreState } from \"./types\";\n\nexport type InAppMessagesStore = Store<\n  InAppMessagesStoreState,\n  (cb: InAppMessagesStoreState) => InAppMessagesStoreState\n>;\n\nexport function createStore() {\n  return new Store<InAppMessagesStoreState>({\n    messages: {},\n    queries: {},\n  });\n}\n"],"names":["createStore","Store"],"mappings":"mHASO,SAASA,GAAc,CAC5B,OAAO,IAAIC,EAAAA,MAA+B,CACxC,SAAU,CAAC,EACX,QAAS,CAAC,CAAA,CACX,CACH"}

package/dist/esm/clients/in-app-messages/channel-client.mjs

@@ -1,80 +0,0 @@
-var c = Object.defineProperty;
-var u = (n, e, s) => e in n ? c(n, e, { enumerable: !0, configurable: !0, writable: !0, value: s }) : n[e] = s;
-var o = (n, e, s) => u(n, typeof e != "symbol" ? e + "" : e, s);
-import { NetworkStatus as g } from "../../networkStatus.mjs";
-import { InAppMessageSocketManager as k } from "./socket-manager.mjs";
-import { createStore as h } from "./store.mjs";
-class I {
-  constructor(e, s, t = {}) {
-    o(this, "store");
-    o(this, "socketManager");
-    this.knock = e, this.channelId = s, this.defaultOptions = t, this.store = h();
-    const { socket: r } = this.knock.client();
-    r && (this.socketManager = new k(r)), this.knock.log(`[IAM] Initialized a client on channel ${s}`);
-  }
-  // ----------------------------------------------
-  // Store helpers
-  // ----------------------------------------------
-  setMessageAttrs(e, s) {
-    this.store.setState((t) => ({
-      ...t,
-      messages: {
-        ...t.messages,
-        ...e.reduce((r, i) => (t.messages[i] && (r[i] = {
-          ...t.messages[i],
-          ...s
-        }), r), {})
-      }
-    }));
-  }
-  setQueryResponse(e, s) {
-    const t = {
-      loading: !1,
-      networkStatus: g.ready,
-      data: {
-        messageIds: s.entries.map((r) => r.id),
-        pageInfo: s.pageInfo
-      }
-    };
-    this.store.setState((r) => ({
-      ...r,
-      // Store new messages in store
-      messages: s.entries.reduce((i, a) => (i[a.id] = a, i), r.messages),
-      // Store query results
-      queries: {
-        ...r.queries,
-        [e]: t
-      }
-    }));
-  }
-  setQueryStatus(e, s) {
-    this.store.setState((t) => ({
-      ...t,
-      queries: {
-        ...t.queries,
-        [e]: {
-          ...t.queries[e],
-          ...s
-        }
-      }
-    }));
-  }
-  /*
-   * Socket
-   */
-  subscribe(e) {
-    if (this.socketManager)
-      return this.knock.log(
-        `[InAppMessagesClient] Subscribe a client ${e.referenceId} to socket events`
-      ), this.socketManager.join(e);
-  }
-  unsubscribe(e) {
-    this.socketManager && (this.knock.log(
-      `[InAppMessagesClient] Unsubscribe a client ${e.referenceId}`
-    ), this.socketManager.leave(e));
-  }
-}
-export {
-  I as InAppMessagesChannelClient
-};
-//# sourceMappingURL=channel-client.mjs.map

package/dist/esm/clients/in-app-messages/channel-client.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"channel-client.mjs","sources":["../../../../src/clients/in-app-messages/channel-client.ts"],"sourcesContent":["import Knock from \"../../knock\";\nimport { NetworkStatus } from \"../../networkStatus\";\n\nimport { InAppMessagesClient } from \"./message-client\";\nimport { InAppMessageSocketManager } from \"./socket-manager\";\nimport { InAppMessagesStore, createStore } from \"./store\";\nimport {\n  InAppMessage,\n  InAppMessagesClientOptions,\n  InAppMessagesQueryInfo,\n  InAppMessagesResponse,\n} from \"./types\";\n\n/**\n * Manages the configuration for an in app channel.\n * Stores all fetched messages to support optimistic updates.\n */\nexport class InAppMessagesChannelClient {\n  public store: InAppMessagesStore;\n\n  private socketManager: InAppMessageSocketManager | undefined;\n\n  constructor(\n    readonly knock: Knock,\n    readonly channelId: string,\n    readonly defaultOptions: InAppMessagesClientOptions = {},\n  ) {\n    this.store = createStore();\n\n    // Initialize a socket manager for the in-app channel client, which there\n    // should be one per in-app channel client but it's abstracted out as a\n    // separate module for the organization/encapsulation purposes.\n    const { socket } = this.knock.client();\n    if (socket) {\n      this.socketManager = new InAppMessageSocketManager(socket);\n    }\n\n    this.knock.log(`[IAM] Initialized a client on channel ${channelId}`);\n  }\n\n  // ----------------------------------------------\n  // Store helpers\n  // ----------------------------------------------\n\n  setMessageAttrs(messageIds: string[], attrs: Partial<InAppMessage>) {\n    this.store.setState((state) => ({\n      ...state,\n      messages: {\n        ...state.messages,\n        ...messageIds.reduce<Record<string, InAppMessage>>((messages, id) => {\n          if (state.messages[id]) {\n            messages[id] = {\n              ...state.messages[id],\n              ...attrs,\n            };\n          }\n          return messages;\n        }, {}),\n      },\n    }));\n  }\n\n  setQueryResponse(queryKey: string, response: InAppMessagesResponse) {\n    const queryInfo: InAppMessagesQueryInfo = {\n      loading: false,\n      networkStatus: NetworkStatus.ready,\n      data: {\n        messageIds: response.entries.map((iam) => iam.id),\n        pageInfo: response.pageInfo,\n      },\n    };\n\n    this.store.setState((state) => {\n      return {\n        ...state,\n        // Store new messages in store\n        messages: response.entries.reduce((messages, message) => {\n          messages[message.id] = message;\n          return messages;\n        }, state.messages),\n        // Store query results\n        queries: {\n          ...state.queries,\n          [queryKey]: queryInfo,\n        },\n      };\n    });\n  }\n\n  setQueryStatus(\n    queryKey: string,\n    status: Pick<InAppMessagesQueryInfo, \"loading\" | \"networkStatus\">,\n  ) {\n    this.store.setState((state) => ({\n      ...state,\n      queries: {\n        ...state.queries,\n        [queryKey]: {\n          ...state.queries[queryKey],\n          ...status,\n        },\n      },\n    }));\n  }\n\n  /*\n   * Socket\n   */\n\n  subscribe(client: InAppMessagesClient) {\n    if (!this.socketManager) return;\n    this.knock.log(\n      `[InAppMessagesClient] Subscribe a client ${client.referenceId} to socket events`,\n    );\n\n    // Pass the unsub func back to iam client so it can be used when\n    // unsubscribing.\n    return this.socketManager.join(client);\n  }\n\n  unsubscribe(client: InAppMessagesClient) {\n    if (!this.socketManager) return;\n    this.knock.log(\n      `[InAppMessagesClient] Unsubscribe a client ${client.referenceId}`,\n    );\n\n    this.socketManager.leave(client);\n  }\n}\n"],"names":["InAppMessagesChannelClient","knock","channelId","defaultOptions","__publicField","createStore","socket","InAppMessageSocketManager","messageIds","attrs","state","messages","id","queryKey","response","queryInfo","NetworkStatus","iam","message","status","client"],"mappings":";;;;;;AAiBO,MAAMA,EAA2B;AAAA,EAKtC,YACWC,GACAC,GACAC,IAA6C,CAAA,GACtD;AARK,IAAAC,EAAA;AAEC,IAAAA,EAAA;AAGG,SAAA,QAAAH,GACA,KAAA,YAAAC,GACA,KAAA,iBAAAC,GAET,KAAK,QAAQE;AAKb,UAAM,EAAE,QAAAC,EAAW,IAAA,KAAK,MAAM,OAAO;AACrC,IAAIA,MACG,KAAA,gBAAgB,IAAIC,EAA0BD,CAAM,IAG3D,KAAK,MAAM,IAAI,yCAAyCJ,CAAS,EAAE;AAAA,EACrE;AAAA;AAAA;AAAA;AAAA,EAMA,gBAAgBM,GAAsBC,GAA8B;AAC7D,SAAA,MAAM,SAAS,CAACC,OAAW;AAAA,MAC9B,GAAGA;AAAA,MACH,UAAU;AAAA,QACR,GAAGA,EAAM;AAAA,QACT,GAAGF,EAAW,OAAqC,CAACG,GAAUC,OACxDF,EAAM,SAASE,CAAE,MACnBD,EAASC,CAAE,IAAI;AAAA,UACb,GAAGF,EAAM,SAASE,CAAE;AAAA,UACpB,GAAGH;AAAA,QAAA,IAGAE,IACN,EAAE;AAAA,MACP;AAAA,IACA,EAAA;AAAA,EACJ;AAAA,EAEA,iBAAiBE,GAAkBC,GAAiC;AAClE,UAAMC,IAAoC;AAAA,MACxC,SAAS;AAAA,MACT,eAAeC,EAAc;AAAA,MAC7B,MAAM;AAAA,QACJ,YAAYF,EAAS,QAAQ,IAAI,CAACG,MAAQA,EAAI,EAAE;AAAA,QAChD,UAAUH,EAAS;AAAA,MACrB;AAAA,IAAA;AAGG,SAAA,MAAM,SAAS,CAACJ,OACZ;AAAA,MACL,GAAGA;AAAA;AAAA,MAEH,UAAUI,EAAS,QAAQ,OAAO,CAACH,GAAUO,OAClCP,EAAAO,EAAQ,EAAE,IAAIA,GAChBP,IACND,EAAM,QAAQ;AAAA;AAAA,MAEjB,SAAS;AAAA,QACP,GAAGA,EAAM;AAAA,QACT,CAACG,CAAQ,GAAGE;AAAA,MACd;AAAA,IAAA,EAEH;AAAA,EACH;AAAA,EAEA,eACEF,GACAM,GACA;AACK,SAAA,MAAM,SAAS,CAACT,OAAW;AAAA,MAC9B,GAAGA;AAAA,MACH,SAAS;AAAA,QACP,GAAGA,EAAM;AAAA,QACT,CAACG,CAAQ,GAAG;AAAA,UACV,GAAGH,EAAM,QAAQG,CAAQ;AAAA,UACzB,GAAGM;AAAA,QACL;AAAA,MACF;AAAA,IACA,EAAA;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA,EAMA,UAAUC,GAA6B;AACjC,QAAC,KAAK;AACV,kBAAK,MAAM;AAAA,QACT,4CAA4CA,EAAO,WAAW;AAAA,MAAA,GAKzD,KAAK,cAAc,KAAKA,CAAM;AAAA,EACvC;AAAA,EAEA,YAAYA,GAA6B;AACnC,IAAC,KAAK,kBACV,KAAK,MAAM;AAAA,MACT,8CAA8CA,EAAO,WAAW;AAAA,IAAA,GAG7D,KAAA,cAAc,MAAMA,CAAM;AAAA,EACjC;AACF;"}