@knocklabs/client 0.10.13 → 0.11.0-rc.0

package/dist/esm/clients/users/index.mjs

@@ -1,10 +1,10 @@
-var i = Object.defineProperty;
-var u = (s, e, t) => e in s ? i(s, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : s[e] = t;
-var a = (s, e, t) => u(s, typeof e != "symbol" ? e + "" : e, t);
-const r = "default";
+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 r = (n, e, s) => u(n, typeof e != "symbol" ? e + "" : e, s);
+const i = "default";
 class l {
   constructor(e) {
-    a(this, "instance");
+    r(this, "instance");
     this.instance = e;
   }
   async get() {
@@ -15,12 +15,12 @@ class l {
     return this.handleResponse(e);
   }
   async identify(e = {}) {
-    const t = await this.instance.client().makeRequest({
+    const s = await this.instance.client().makeRequest({
       method: "PUT",
       url: `/v1/users/${this.instance.userId}`,
       params: e
     });
-    return this.handleResponse(t);
+    return this.handleResponse(s);
   }
   async getAllPreferences() {
     const e = await this.instance.client().makeRequest({
@@ -30,38 +30,46 @@ class l {
     return this.handleResponse(e);
   }
   async getPreferences(e = {}) {
-    const t = e.preferenceSet || r, n = await this.instance.client().makeRequest({
+    const s = e.preferenceSet || i, t = await this.instance.client().makeRequest({
       method: "GET",
-      url: `/v1/users/${this.instance.userId}/preferences/${t}`,
+      url: `/v1/users/${this.instance.userId}/preferences/${s}`,
       params: { tenant: e.tenant }
     });
-    return this.handleResponse(n);
+    return this.handleResponse(t);
   }
-  async setPreferences(e, t = {}) {
-    const n = t.preferenceSet || r, c = await this.instance.client().makeRequest({
+  async setPreferences(e, s = {}) {
+    const t = s.preferenceSet || i, a = await this.instance.client().makeRequest({
       method: "PUT",
-      url: `/v1/users/${this.instance.userId}/preferences/${n}`,
+      url: `/v1/users/${this.instance.userId}/preferences/${t}`,
       data: e
     });
-    return this.handleResponse(c);
+    return this.handleResponse(a);
   }
   async getChannelData(e) {
-    const t = await this.instance.client().makeRequest({
+    const s = await this.instance.client().makeRequest({
       method: "GET",
       url: `/v1/users/${this.instance.userId}/channel_data/${e.channelId}`
     });
-    return this.handleResponse(t);
+    return this.handleResponse(s);
   }
   async setChannelData({
     channelId: e,
-    channelData: t
+    channelData: s
   }) {
-    const n = await this.instance.client().makeRequest({
+    const t = await this.instance.client().makeRequest({
       method: "PUT",
       url: `/v1/users/${this.instance.userId}/channel_data/${e}`,
-      data: { data: t }
+      data: { data: s }
+    });
+    return this.handleResponse(t);
+  }
+  async getInAppMessages({ channelId: e, messageType: s, params: t }) {
+    const a = await this.instance.client().makeRequest({
+      method: "GET",
+      url: `/v1/users/${this.instance.userId}/in-app-messages/${e}/${s}`,
+      params: t
     });
-    return this.handleResponse(n);
+    return this.handleResponse(a);
   }
   handleResponse(e) {
     if (e.statusCode === "error")

package/dist/esm/clients/users/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sources":["../../../../src/clients/users/index.ts"],"sourcesContent":["import { GenericData } from \"@knocklabs/types\";\n\nimport { ApiResponse } from \"../../api\";\nimport { ChannelData, User } from \"../../interfaces\";\nimport Knock from \"../../knock\";\nimport {\n  GetPreferencesOptions,\n  PreferenceOptions,\n  PreferenceSet,\n  SetPreferencesProperties,\n} from \"../preferences/interfaces\";\n\nimport { GetChannelDataInput, SetChannelDataInput } from \"./interfaces\";\n\nconst DEFAULT_PREFERENCE_SET_ID = \"default\";\n\nclass UserClient {\n  private instance: Knock;\n\n  constructor(instance: Knock) {\n    this.instance = instance;\n  }\n\n  async get() {\n    const result = await this.instance.client().makeRequest({\n      method: \"GET\",\n      url: `/v1/users/${this.instance.userId}`,\n    });\n\n    return this.handleResponse<User>(result);\n  }\n\n  async identify(props: GenericData = {}) {\n    const result = await this.instance.client().makeRequest({\n      method: \"PUT\",\n      url: `/v1/users/${this.instance.userId}`,\n      params: props,\n    });\n\n    return this.handleResponse<User>(result);\n  }\n\n  async getAllPreferences() {\n    const result = await this.instance.client().makeRequest({\n      method: \"GET\",\n      url: `/v1/users/${this.instance.userId}/preferences`,\n    });\n\n    return this.handleResponse<PreferenceSet[]>(result);\n  }\n\n  async getPreferences(\n    options: GetPreferencesOptions = {},\n  ): Promise<PreferenceSet> {\n    const preferenceSetId = options.preferenceSet || DEFAULT_PREFERENCE_SET_ID;\n\n    const result = await this.instance.client().makeRequest({\n      method: \"GET\",\n      url: `/v1/users/${this.instance.userId}/preferences/${preferenceSetId}`,\n      params: { tenant: options.tenant },\n    });\n\n    return this.handleResponse<PreferenceSet>(result);\n  }\n\n  async setPreferences(\n    preferenceSet: SetPreferencesProperties,\n    options: PreferenceOptions = {},\n  ): Promise<PreferenceSet> {\n    const preferenceSetId = options.preferenceSet || DEFAULT_PREFERENCE_SET_ID;\n\n    const result = await this.instance.client().makeRequest({\n      method: \"PUT\",\n      url: `/v1/users/${this.instance.userId}/preferences/${preferenceSetId}`,\n      data: preferenceSet,\n    });\n\n    return this.handleResponse<PreferenceSet>(result);\n  }\n\n  async getChannelData<T = GenericData>(params: GetChannelDataInput) {\n    const result = await this.instance.client().makeRequest({\n      method: \"GET\",\n      url: `/v1/users/${this.instance.userId}/channel_data/${params.channelId}`,\n    });\n\n    return this.handleResponse<ChannelData<T>>(result);\n  }\n\n  async setChannelData<T = GenericData>({\n    channelId,\n    channelData,\n  }: SetChannelDataInput) {\n    const result = await this.instance.client().makeRequest({\n      method: \"PUT\",\n      url: `/v1/users/${this.instance.userId}/channel_data/${channelId}`,\n      data: { data: channelData },\n    });\n\n    return this.handleResponse<ChannelData<T>>(result);\n  }\n\n  private handleResponse<T>(response: ApiResponse) {\n    if (response.statusCode === \"error\") {\n      throw new Error(response.error || response.body);\n    }\n\n    return response.body as T;\n  }\n}\n\nexport default UserClient;\n"],"names":["DEFAULT_PREFERENCE_SET_ID","UserClient","instance","__publicField","result","props","options","preferenceSetId","preferenceSet","params","channelId","channelData","response"],"mappings":";;;AAcA,MAAMA,IAA4B;AAElC,MAAMC,EAAW;AAAA,EAGf,YAAYC,GAAiB;AAFrB,IAAAC,EAAA;AAGN,SAAK,WAAWD;AAAA,EAClB;AAAA,EAEA,MAAM,MAAM;AACV,UAAME,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,aAAa,KAAK,SAAS,MAAM;AAAA,IAAA,CACvC;AAEM,WAAA,KAAK,eAAqBA,CAAM;AAAA,EACzC;AAAA,EAEA,MAAM,SAASC,IAAqB,IAAI;AACtC,UAAMD,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,aAAa,KAAK,SAAS,MAAM;AAAA,MACtC,QAAQC;AAAA,IAAA,CACT;AAEM,WAAA,KAAK,eAAqBD,CAAM;AAAA,EACzC;AAAA,EAEA,MAAM,oBAAoB;AACxB,UAAMA,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,aAAa,KAAK,SAAS,MAAM;AAAA,IAAA,CACvC;AAEM,WAAA,KAAK,eAAgCA,CAAM;AAAA,EACpD;AAAA,EAEA,MAAM,eACJE,IAAiC,IACT;AAClB,UAAAC,IAAkBD,EAAQ,iBAAiBN,GAE3CI,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,aAAa,KAAK,SAAS,MAAM,gBAAgBG,CAAe;AAAA,MACrE,QAAQ,EAAE,QAAQD,EAAQ,OAAO;AAAA,IAAA,CAClC;AAEM,WAAA,KAAK,eAA8BF,CAAM;AAAA,EAClD;AAAA,EAEA,MAAM,eACJI,GACAF,IAA6B,IACL;AAClB,UAAAC,IAAkBD,EAAQ,iBAAiBN,GAE3CI,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,aAAa,KAAK,SAAS,MAAM,gBAAgBG,CAAe;AAAA,MACrE,MAAMC;AAAA,IAAA,CACP;AAEM,WAAA,KAAK,eAA8BJ,CAAM;AAAA,EAClD;AAAA,EAEA,MAAM,eAAgCK,GAA6B;AACjE,UAAML,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,aAAa,KAAK,SAAS,MAAM,iBAAiBK,EAAO,SAAS;AAAA,IAAA,CACxE;AAEM,WAAA,KAAK,eAA+BL,CAAM;AAAA,EACnD;AAAA,EAEA,MAAM,eAAgC;AAAA,IACpC,WAAAM;AAAA,IACA,aAAAC;AAAA,EAAA,GACsB;AACtB,UAAMP,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,aAAa,KAAK,SAAS,MAAM,iBAAiBM,CAAS;AAAA,MAChE,MAAM,EAAE,MAAMC,EAAY;AAAA,IAAA,CAC3B;AAEM,WAAA,KAAK,eAA+BP,CAAM;AAAA,EACnD;AAAA,EAEQ,eAAkBQ,GAAuB;AAC3C,QAAAA,EAAS,eAAe;AAC1B,YAAM,IAAI,MAAMA,EAAS,SAASA,EAAS,IAAI;AAGjD,WAAOA,EAAS;AAAA,EAClB;AACF;"}
+{"version":3,"file":"index.mjs","sources":["../../../../src/clients/users/index.ts"],"sourcesContent":["import { GenericData } from \"@knocklabs/types\";\n\nimport { ApiResponse } from \"../../api\";\nimport { ChannelData, User } from \"../../interfaces\";\nimport Knock from \"../../knock\";\nimport { InAppMessagesResponse } from \"../in-app-messages\";\nimport {\n  GetPreferencesOptions,\n  PreferenceOptions,\n  PreferenceSet,\n  SetPreferencesProperties,\n} from \"../preferences/interfaces\";\n\nimport {\n  GetChannelDataInput,\n  GetInAppMessagesInput,\n  SetChannelDataInput,\n} from \"./interfaces\";\n\nconst DEFAULT_PREFERENCE_SET_ID = \"default\";\n\nclass UserClient {\n  private instance: Knock;\n\n  constructor(instance: Knock) {\n    this.instance = instance;\n  }\n\n  async get() {\n    const result = await this.instance.client().makeRequest({\n      method: \"GET\",\n      url: `/v1/users/${this.instance.userId}`,\n    });\n\n    return this.handleResponse<User>(result);\n  }\n\n  async identify(props: GenericData = {}) {\n    const result = await this.instance.client().makeRequest({\n      method: \"PUT\",\n      url: `/v1/users/${this.instance.userId}`,\n      params: props,\n    });\n\n    return this.handleResponse<User>(result);\n  }\n\n  async getAllPreferences() {\n    const result = await this.instance.client().makeRequest({\n      method: \"GET\",\n      url: `/v1/users/${this.instance.userId}/preferences`,\n    });\n\n    return this.handleResponse<PreferenceSet[]>(result);\n  }\n\n  async getPreferences(\n    options: GetPreferencesOptions = {},\n  ): Promise<PreferenceSet> {\n    const preferenceSetId = options.preferenceSet || DEFAULT_PREFERENCE_SET_ID;\n\n    const result = await this.instance.client().makeRequest({\n      method: \"GET\",\n      url: `/v1/users/${this.instance.userId}/preferences/${preferenceSetId}`,\n      params: { tenant: options.tenant },\n    });\n\n    return this.handleResponse<PreferenceSet>(result);\n  }\n\n  async setPreferences(\n    preferenceSet: SetPreferencesProperties,\n    options: PreferenceOptions = {},\n  ): Promise<PreferenceSet> {\n    const preferenceSetId = options.preferenceSet || DEFAULT_PREFERENCE_SET_ID;\n\n    const result = await this.instance.client().makeRequest({\n      method: \"PUT\",\n      url: `/v1/users/${this.instance.userId}/preferences/${preferenceSetId}`,\n      data: preferenceSet,\n    });\n\n    return this.handleResponse<PreferenceSet>(result);\n  }\n\n  async getChannelData<T = GenericData>(params: GetChannelDataInput) {\n    const result = await this.instance.client().makeRequest({\n      method: \"GET\",\n      url: `/v1/users/${this.instance.userId}/channel_data/${params.channelId}`,\n    });\n\n    return this.handleResponse<ChannelData<T>>(result);\n  }\n\n  async setChannelData<T = GenericData>({\n    channelId,\n    channelData,\n  }: SetChannelDataInput) {\n    const result = await this.instance.client().makeRequest({\n      method: \"PUT\",\n      url: `/v1/users/${this.instance.userId}/channel_data/${channelId}`,\n      data: { data: channelData },\n    });\n\n    return this.handleResponse<ChannelData<T>>(result);\n  }\n\n  async getInAppMessages<\n    TContent extends GenericData = GenericData,\n    TData extends GenericData = GenericData,\n  >({ channelId, messageType, params }: GetInAppMessagesInput) {\n    const result = await this.instance.client().makeRequest({\n      method: \"GET\",\n      url: `/v1/users/${this.instance.userId}/in-app-messages/${channelId}/${messageType}`,\n      params,\n    });\n\n    return this.handleResponse<InAppMessagesResponse<TContent, TData>>(result);\n  }\n\n  private handleResponse<T>(response: ApiResponse) {\n    if (response.statusCode === \"error\") {\n      throw new Error(response.error || response.body);\n    }\n\n    return response.body as T;\n  }\n}\n\nexport default UserClient;\n"],"names":["DEFAULT_PREFERENCE_SET_ID","UserClient","instance","__publicField","result","props","options","preferenceSetId","preferenceSet","params","channelId","channelData","messageType","response"],"mappings":";;;AAmBA,MAAMA,IAA4B;AAElC,MAAMC,EAAW;AAAA,EAGf,YAAYC,GAAiB;AAFrB,IAAAC,EAAA;AAGN,SAAK,WAAWD;AAAA,EAClB;AAAA,EAEA,MAAM,MAAM;AACV,UAAME,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,aAAa,KAAK,SAAS,MAAM;AAAA,IAAA,CACvC;AAEM,WAAA,KAAK,eAAqBA,CAAM;AAAA,EACzC;AAAA,EAEA,MAAM,SAASC,IAAqB,IAAI;AACtC,UAAMD,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,aAAa,KAAK,SAAS,MAAM;AAAA,MACtC,QAAQC;AAAA,IAAA,CACT;AAEM,WAAA,KAAK,eAAqBD,CAAM;AAAA,EACzC;AAAA,EAEA,MAAM,oBAAoB;AACxB,UAAMA,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,aAAa,KAAK,SAAS,MAAM;AAAA,IAAA,CACvC;AAEM,WAAA,KAAK,eAAgCA,CAAM;AAAA,EACpD;AAAA,EAEA,MAAM,eACJE,IAAiC,IACT;AAClB,UAAAC,IAAkBD,EAAQ,iBAAiBN,GAE3CI,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,aAAa,KAAK,SAAS,MAAM,gBAAgBG,CAAe;AAAA,MACrE,QAAQ,EAAE,QAAQD,EAAQ,OAAO;AAAA,IAAA,CAClC;AAEM,WAAA,KAAK,eAA8BF,CAAM;AAAA,EAClD;AAAA,EAEA,MAAM,eACJI,GACAF,IAA6B,IACL;AAClB,UAAAC,IAAkBD,EAAQ,iBAAiBN,GAE3CI,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,aAAa,KAAK,SAAS,MAAM,gBAAgBG,CAAe;AAAA,MACrE,MAAMC;AAAA,IAAA,CACP;AAEM,WAAA,KAAK,eAA8BJ,CAAM;AAAA,EAClD;AAAA,EAEA,MAAM,eAAgCK,GAA6B;AACjE,UAAML,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,aAAa,KAAK,SAAS,MAAM,iBAAiBK,EAAO,SAAS;AAAA,IAAA,CACxE;AAEM,WAAA,KAAK,eAA+BL,CAAM;AAAA,EACnD;AAAA,EAEA,MAAM,eAAgC;AAAA,IACpC,WAAAM;AAAA,IACA,aAAAC;AAAA,EAAA,GACsB;AACtB,UAAMP,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,aAAa,KAAK,SAAS,MAAM,iBAAiBM,CAAS;AAAA,MAChE,MAAM,EAAE,MAAMC,EAAY;AAAA,IAAA,CAC3B;AAEM,WAAA,KAAK,eAA+BP,CAAM;AAAA,EACnD;AAAA,EAEA,MAAM,iBAGJ,EAAE,WAAAM,GAAW,aAAAE,GAAa,QAAAH,KAAiC;AAC3D,UAAML,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,aAAa,KAAK,SAAS,MAAM,oBAAoBM,CAAS,IAAIE,CAAW;AAAA,MAClF,QAAAH;AAAA,IAAA,CACD;AAEM,WAAA,KAAK,eAAuDL,CAAM;AAAA,EAC3E;AAAA,EAEQ,eAAkBS,GAAuB;AAC3C,QAAAA,EAAS,eAAe;AAC1B,YAAM,IAAI,MAAMA,EAAS,SAASA,EAAS,IAAI;AAGjD,WAAOA,EAAS;AAAA,EAClB;AACF;"}

package/dist/esm/index.mjs

@@ -1,14 +1,18 @@
-import { default as f } from "./clients/feed/index.mjs";
+import { default as p } from "./clients/feed/index.mjs";
 import t from "./knock.mjs";
-import { TENANT_OBJECT_COLLECTION as m } from "./clients/objects/constants.mjs";
-import { NetworkStatus as s, isRequestInFlight as d } from "./networkStatus.mjs";
+import { TENANT_OBJECT_COLLECTION as a } from "./clients/objects/constants.mjs";
+import { InAppMessagesChannelClient as n } from "./clients/in-app-messages/channel-client.mjs";
+import { InAppMessagesClient as m } from "./clients/in-app-messages/message-client.mjs";
+import { NetworkStatus as C, isRequestInFlight as i } from "./networkStatus.mjs";
 import { default as u } from "./clients/feed/feed.mjs";
 export {
   u as Feed,
-  f as FeedClient,
-  s as NetworkStatus,
-  m as TENANT_OBJECT_COLLECTION,
+  p as FeedClient,
+  n as InAppMessagesChannelClient,
+  m as InAppMessagesClient,
+  C as NetworkStatus,
+  a as TENANT_OBJECT_COLLECTION,
   t as default,
-  d as isRequestInFlight
+  i as isRequestInFlight
 };
 //# sourceMappingURL=index.mjs.map

package/dist/esm/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;"}
+{"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;"}

package/dist/types/clients/in-app-messages/channel-client.d.ts

@@ -0,0 +1,23 @@
+import { default as Knock } from '../../knock';
+import { InAppMessagesClient } from './message-client';
+import { InAppMessagesStore } from './store';
+import { InAppMessage, InAppMessagesClientOptions, InAppMessagesQueryInfo, InAppMessagesResponse } from './types';
+
+/**
+ * Manages the configuration for an in app channel.
+ * Stores all fetched messages to support optimistic updates.
+ */
+export declare class InAppMessagesChannelClient {
+    readonly knock: Knock;
+    readonly channelId: string;
+    readonly defaultOptions: InAppMessagesClientOptions;
+    store: InAppMessagesStore;
+    private socketManager;
+    constructor(knock: Knock, channelId: string, defaultOptions?: InAppMessagesClientOptions);
+    setMessageAttrs(messageIds: string[], attrs: Partial<InAppMessage>): void;
+    setQueryResponse(queryKey: string, response: InAppMessagesResponse): void;
+    setQueryStatus(queryKey: string, status: Pick<InAppMessagesQueryInfo, "loading" | "networkStatus">): void;
+    subscribe(client: InAppMessagesClient): (() => void) | undefined;
+    unsubscribe(client: InAppMessagesClient): void;
+}
+//# sourceMappingURL=channel-client.d.ts.map

package/dist/types/clients/in-app-messages/channel-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"channel-client.d.ts","sourceRoot":"","sources":["../../../../src/clients/in-app-messages/channel-client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,aAAa,CAAC;AAGhC,OAAO,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAEvD,OAAO,EAAE,kBAAkB,EAAe,MAAM,SAAS,CAAC;AAC1D,OAAO,EACL,YAAY,EACZ,0BAA0B,EAC1B,sBAAsB,EACtB,qBAAqB,EACtB,MAAM,SAAS,CAAC;AAEjB;;;GAGG;AACH,qBAAa,0BAA0B;IAMnC,QAAQ,CAAC,KAAK,EAAE,KAAK;IACrB,QAAQ,CAAC,SAAS,EAAE,MAAM;IAC1B,QAAQ,CAAC,cAAc,EAAE,0BAA0B;IAP9C,KAAK,EAAE,kBAAkB,CAAC;IAEjC,OAAO,CAAC,aAAa,CAAwC;gBAGlD,KAAK,EAAE,KAAK,EACZ,SAAS,EAAE,MAAM,EACjB,cAAc,GAAE,0BAA+B;IAmB1D,eAAe,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,YAAY,CAAC;IAkBlE,gBAAgB,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,qBAAqB;IA2BlE,cAAc,CACZ,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,IAAI,CAAC,sBAAsB,EAAE,SAAS,GAAG,eAAe,CAAC;IAkBnE,SAAS,CAAC,MAAM,EAAE,mBAAmB;IAWrC,WAAW,CAAC,MAAM,EAAE,mBAAmB;CAQxC"}

package/dist/types/clients/in-app-messages/index.d.ts

@@ -0,0 +1,4 @@
+export * from './channel-client';
+export * from './message-client';
+export * from './types';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/clients/in-app-messages/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/clients/in-app-messages/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,SAAS,CAAC"}

package/dist/types/clients/in-app-messages/message-client.d.ts

@@ -0,0 +1,52 @@
+import { GenericData } from '@knocklabs/types';
+import { NetworkStatus } from '../../networkStatus';
+import { InAppMessagesChannelClient } from './channel-client';
+import { SocketEventPayload } from './socket-manager';
+import { InAppMessage, InAppMessagesClientOptions, InAppMessagesResponse, InAppMessagesStoreState } from './types';
+
+/**
+ * Manages realtime connection to in app messages service.
+ */
+export declare class InAppMessagesClient {
+    readonly channelClient: InAppMessagesChannelClient;
+    readonly messageType: string;
+    readonly defaultOptions: InAppMessagesClientOptions;
+    private knock;
+    queryKey: string;
+    referenceId: string;
+    unsub?: () => void;
+    constructor(channelClient: InAppMessagesChannelClient, messageType: string, defaultOptions?: InAppMessagesClientOptions);
+    fetch<TContent extends GenericData = GenericData, TData extends GenericData = GenericData>(): Promise<{
+        status: "ok";
+        data: InAppMessagesResponse<TContent, TData>;
+    } | {
+        status: "error";
+        error: Error;
+    } | undefined>;
+    getQueryInfoSelector<TContent extends GenericData = GenericData, TData extends GenericData = GenericData>(state: InAppMessagesStoreState): {
+        messages: InAppMessage<TContent, TData>[];
+        loading: boolean;
+        networkStatus: NetworkStatus;
+    };
+    markAsSeen(itemOrItems: InAppMessage | InAppMessage[]): Promise<import('../messages/interfaces').Message<GenericData>[]>;
+    markAsUnseen(itemOrItems: InAppMessage | InAppMessage[]): Promise<import('../messages/interfaces').Message<GenericData>[]>;
+    markAsRead(itemOrItems: InAppMessage | InAppMessage[]): Promise<import('../messages/interfaces').Message<GenericData>[]>;
+    markAsUnread(itemOrItems: InAppMessage | InAppMessage[]): Promise<import('../messages/interfaces').Message<GenericData>[]>;
+    markAsInteracted(itemOrItems: InAppMessage | InAppMessage[], metadata?: Record<string, string>): Promise<import('../messages/interfaces').Message<GenericData>[]>;
+    markAsArchived(itemOrItems: InAppMessage | InAppMessage[]): Promise<import('../messages/interfaces').Message<GenericData>[]>;
+    markAsUnarchived(itemOrItems: InAppMessage | InAppMessage[]): Promise<import('../messages/interfaces').Message<GenericData>[]>;
+    private makeStatusUpdate;
+    private buildQueryKey;
+    subscribe(): void;
+    unsubscribe(): void;
+    handleSocketEvent(payload: SocketEventPayload): Promise<{
+        status: "error";
+        error: Error;
+    } | {
+        status: "ok";
+        data: InAppMessagesResponse<GenericData, GenericData>;
+    } | undefined>;
+    socketChannelTopic(): string;
+    private getItemIds;
+}
+//# sourceMappingURL=message-client.d.ts.map

package/dist/types/clients/in-app-messages/message-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"message-client.d.ts","sourceRoot":"","sources":["../../../../src/clients/in-app-messages/message-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAI/C,OAAO,EAAE,aAAa,EAAqB,MAAM,qBAAqB,CAAC;AAGvE,OAAO,EAAE,0BAA0B,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAmB,MAAM,kBAAkB,CAAC;AACvE,OAAO,EACL,YAAY,EACZ,0BAA0B,EAC1B,qBAAqB,EACrB,uBAAuB,EACxB,MAAM,SAAS,CAAC;AAEjB;;GAEG;AACH,qBAAa,mBAAmB;IAQ5B,QAAQ,CAAC,aAAa,EAAE,0BAA0B;IAClD,QAAQ,CAAC,WAAW,EAAE,MAAM;IAC5B,QAAQ,CAAC,cAAc,EAAE,0BAA0B;IATrD,OAAO,CAAC,KAAK,CAAQ;IAEd,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,IAAI,CAAC;gBAGf,aAAa,EAAE,0BAA0B,EACzC,WAAW,EAAE,MAAM,EACnB,cAAc,GAAE,0BAA+B;IAgBpD,KAAK,CACT,QAAQ,SAAS,WAAW,GAAG,WAAW,EAC1C,KAAK,SAAS,WAAW,GAAG,WAAW,KACpC,OAAO,CACR;QACE,MAAM,EAAE,IAAI,CAAC;QACb,IAAI,EAAE,qBAAqB,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;KAC9C,GACD;QACE,MAAM,EAAE,OAAO,CAAC;QAChB,KAAK,EAAE,KAAK,CAAC;KACd,GACD,SAAS,CACZ;IA+CD,oBAAoB,CAClB,QAAQ,SAAS,WAAW,GAAG,WAAW,EAC1C,KAAK,SAAS,WAAW,GAAG,WAAW,EAEvC,KAAK,EAAE,uBAAuB,GAC7B;QACD,QAAQ,EAAE,YAAY,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,CAAC;QAC1C,OAAO,EAAE,OAAO,CAAC;QACjB,aAAa,EAAE,aAAa,CAAC;KAC9B;IAyBK,UAAU,CAAC,WAAW,EAAE,YAAY,GAAG,YAAY,EAAE;IAUrD,YAAY,CAAC,WAAW,EAAE,YAAY,GAAG,YAAY,EAAE;IAUvD,UAAU,CAAC,WAAW,EAAE,YAAY,GAAG,YAAY,EAAE;IAUrD,YAAY,CAAC,WAAW,EAAE,YAAY,GAAG,YAAY,EAAE;IAUvD,gBAAgB,CACpB,WAAW,EAAE,YAAY,GAAG,YAAY,EAAE,EAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAa7B,cAAc,CAAC,WAAW,EAAE,YAAY,GAAG,YAAY,EAAE;IAUzD,gBAAgB,CAAC,WAAW,EAAE,YAAY,GAAG,YAAY,EAAE;YAUnD,gBAAgB;IAoB9B,OAAO,CAAC,aAAa;IAMrB,SAAS;IAIT,WAAW;IAML,iBAAiB,CAAC,OAAO,EAAE,kBAAkB;gBApMrC,OAAO;eACR,KAAK;;gBALJ,IAAI;;;IAoNlB,kBAAkB;IAIlB,OAAO,CAAC,UAAU;CAInB"}

package/dist/types/clients/in-app-messages/socket-manager.d.ts

@@ -0,0 +1,27 @@
+import { Socket } from 'phoenix';
+import { InAppMessagesClient } from './message-client';
+import { InAppMessage } from './types';
+
+export declare enum SocketEventType {
+    MessageCreated = "message.created"
+}
+type MessageCreatedEventPayload = {
+    event: SocketEventType.MessageCreated;
+    topic: string;
+    data: {
+        in_app_message: InAppMessage;
+    };
+};
+export type SocketEventPayload = MessageCreatedEventPayload;
+export declare class InAppMessageSocketManager {
+    readonly socket: Socket;
+    private channels;
+    private params;
+    private inbox;
+    constructor(socket: Socket);
+    join(iamClient: InAppMessagesClient): () => void;
+    leave(iamClient: InAppMessagesClient): void;
+    private setInbox;
+}
+export {};
+//# sourceMappingURL=socket-manager.d.ts.map

package/dist/types/clients/in-app-messages/socket-manager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"socket-manager.d.ts","sourceRoot":"","sources":["../../../../src/clients/in-app-messages/socket-manager.ts"],"names":[],"mappings":"AACA,OAAO,EAAW,MAAM,EAAE,MAAM,SAAS,CAAC;AAE1C,OAAO,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,EAAE,YAAY,EAA8B,MAAM,SAAS,CAAC;AAEnE,oBAAY,eAAe;IACzB,cAAc,oBAAoB;CACnC;AAYD,KAAK,0BAA0B,GAAG;IAChC,KAAK,EAAE,eAAe,CAAC,cAAc,CAAC;IACtC,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE;QACJ,cAAc,EAAE,YAAY,CAAC;KAC9B,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,0BAA0B,CAAC;AAc5D,qBAAa,yBAAyB;IAwCxB,QAAQ,CAAC,MAAM,EAAE,MAAM;IArCnC,OAAO,CAAC,QAAQ,CAAgC;IAyBhD,OAAO,CAAC,MAAM,CAGZ;IAIF,OAAO,CAAC,KAAK,CAGX;gBAEmB,MAAM,EAAE,MAAM;IAMnC,IAAI,CAAC,SAAS,EAAE,mBAAmB;IAwDnC,KAAK,CAAC,SAAS,EAAE,mBAAmB;IA8BpC,OAAO,CAAC,QAAQ;CAYjB"}

package/dist/types/clients/in-app-messages/store.d.ts

@@ -0,0 +1,6 @@
+import { Store } from '@tanstack/store';
+import { InAppMessagesStoreState } from './types';
+
+export type InAppMessagesStore = Store<InAppMessagesStoreState, (cb: InAppMessagesStoreState) => InAppMessagesStoreState>;
+export declare function createStore(): Store<InAppMessagesStoreState, (cb: InAppMessagesStoreState) => InAppMessagesStoreState>;
+//# sourceMappingURL=store.d.ts.map

package/dist/types/clients/in-app-messages/store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"store.d.ts","sourceRoot":"","sources":["../../../../src/clients/in-app-messages/store.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAExC,OAAO,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAC;AAElD,MAAM,MAAM,kBAAkB,GAAG,KAAK,CACpC,uBAAuB,EACvB,CAAC,EAAE,EAAE,uBAAuB,KAAK,uBAAuB,CACzD,CAAC;AAEF,wBAAgB,WAAW,6FAK1B"}

package/dist/types/clients/in-app-messages/types.d.ts

@@ -0,0 +1,52 @@
+import { GenericData, PageInfo, Tenant } from '@knocklabs/types';
+import { NetworkStatus } from '../../networkStatus';
+import { NotificationSource } from '../messages/interfaces';
+
+export interface InAppMessage<TContent extends GenericData = GenericData, TData extends GenericData = GenericData, TTenantProperties = GenericData> {
+    __cursor: string;
+    id: string;
+    message_type: string;
+    schema_variant: string;
+    schema_version: string;
+    content: TContent;
+    data: TData | null;
+    inserted_at: string;
+    updated_at: string;
+    seen_at: string | null;
+    read_at: string | null;
+    interacted_at: string | null;
+    archived_at: string | null;
+    link_clicked_at: string | null;
+    source: NotificationSource;
+    tenant: Tenant<TTenantProperties>;
+}
+export interface InAppMessagesResponse<TContent extends GenericData = GenericData, TData extends GenericData = GenericData> {
+    entries: InAppMessage<TContent, TData>[];
+    pageInfo: PageInfo;
+}
+export interface InAppMessagesQueryInfo {
+    networkStatus: NetworkStatus;
+    loading: boolean;
+    data?: {
+        messageIds: string[];
+        pageInfo: PageInfo;
+    };
+}
+export interface InAppMessagesStoreState {
+    messages: Record<string, InAppMessage>;
+    queries: Record<string, InAppMessagesQueryInfo>;
+}
+export type InAppMessageEngagementStatus = "read" | "unread" | "seen" | "unseen" | "link_clicked" | "link_unclicked" | "interacted" | "uninteracted";
+export interface InAppMessagesClientOptions {
+    order?: "asc" | "desc";
+    before?: string;
+    after?: string;
+    page_size?: number;
+    engagement_status?: InAppMessageEngagementStatus[];
+    tenant_id?: string | string[];
+    workflow_key?: string | string[];
+    workflow_categories?: string[];
+    archived?: "include" | "exclude" | "only";
+    trigger_data?: GenericData;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types/clients/in-app-messages/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/clients/in-app-messages/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAEjE,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAE5D,MAAM,WAAW,YAAY,CAC3B,QAAQ,SAAS,WAAW,GAAG,WAAW,EAC1C,KAAK,SAAS,WAAW,GAAG,WAAW,EACvC,iBAAiB,GAAG,WAAW;IAE/B,QAAQ,EAAE,MAAM,CAAC;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,MAAM,CAAC;IACvB,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,QAAQ,CAAC;IAClB,IAAI,EAAE,KAAK,GAAG,IAAI,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,MAAM,EAAE,kBAAkB,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC,iBAAiB,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,qBAAqB,CACpC,QAAQ,SAAS,WAAW,GAAG,WAAW,EAC1C,KAAK,SAAS,WAAW,GAAG,WAAW;IAEvC,OAAO,EAAE,YAAY,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,CAAC;IACzC,QAAQ,EAAE,QAAQ,CAAC;CACpB;AAED,MAAM,WAAW,sBAAsB;IACrC,aAAa,EAAE,aAAa,CAAC;IAC7B,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,CAAC,EAAE;QACL,UAAU,EAAE,MAAM,EAAE,CAAC;QACrB,QAAQ,EAAE,QAAQ,CAAC;KACpB,CAAC;CACH;AAED,MAAM,WAAW,uBAAuB;IACtC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IACvC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAC;CACjD;AAED,MAAM,MAAM,4BAA4B,GACpC,MAAM,GACN,QAAQ,GACR,MAAM,GACN,QAAQ,GACR,cAAc,GACd,gBAAgB,GAChB,YAAY,GACZ,cAAc,CAAC;AAEnB,MAAM,WAAW,0BAA0B;IACzC,KAAK,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,iBAAiB,CAAC,EAAE,4BAA4B,EAAE,CAAC;IAEnD,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAE9B,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAEjC,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE/B,QAAQ,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,MAAM,CAAC;IAI1C,YAAY,CAAC,EAAE,WAAW,CAAC;CAC5B"}

package/dist/types/clients/preferences/interfaces.d.ts

@@ -1,7 +1,7 @@
 import { ChannelType } from '@knocklabs/types';
 
 export type ChannelTypePreferences = {
-    [K in ChannelType]?: boolean;
+    [_K in ChannelType]?: boolean;
 };
 export type WorkflowPreferenceSetting = boolean | {
     channel_types: ChannelTypePreferences;

package/dist/types/clients/preferences/interfaces.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../../../../src/clients/preferences/interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C,MAAM,MAAM,sBAAsB,GAAG;KAClC,CAAC,IAAI,WAAW,CAAC,CAAC,EAAE,OAAO;CAC7B,CAAC;AAEF,MAAM,MAAM,yBAAyB,GACjC,OAAO,GACP;IAAE,aAAa,EAAE,sBAAsB,CAAA;CAAE,CAAC;AAE9C,MAAM,MAAM,mBAAmB,GAAG,OAAO,CACvC,MAAM,CAAC,MAAM,EAAE,yBAAyB,CAAC,CAC1C,CAAC;AAEF,MAAM,WAAW,wBAAwB;IACvC,SAAS,EAAE,mBAAmB,CAAC;IAC/B,UAAU,EAAE,mBAAmB,CAAC;IAChC,aAAa,EAAE,sBAAsB,CAAC;CACvC;AAED,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,mBAAmB,CAAC;IAChC,SAAS,EAAE,mBAAmB,CAAC;IAC/B,aAAa,EAAE,sBAAsB,CAAC;CACvC;AAED,MAAM,WAAW,iBAAiB;IAChC,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,qBAAsB,SAAQ,iBAAiB;IAC9D,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../../../../src/clients/preferences/interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C,MAAM,MAAM,sBAAsB,GAAG;KAClC,EAAE,IAAI,WAAW,CAAC,CAAC,EAAE,OAAO;CAC9B,CAAC;AAEF,MAAM,MAAM,yBAAyB,GACjC,OAAO,GACP;IAAE,aAAa,EAAE,sBAAsB,CAAA;CAAE,CAAC;AAE9C,MAAM,MAAM,mBAAmB,GAAG,OAAO,CACvC,MAAM,CAAC,MAAM,EAAE,yBAAyB,CAAC,CAC1C,CAAC;AAEF,MAAM,WAAW,wBAAwB;IACvC,SAAS,EAAE,mBAAmB,CAAC;IAC/B,UAAU,EAAE,mBAAmB,CAAC;IAChC,aAAa,EAAE,sBAAsB,CAAC;CACvC;AAED,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,mBAAmB,CAAC;IAChC,SAAS,EAAE,mBAAmB,CAAC;IAC/B,aAAa,EAAE,sBAAsB,CAAC;CACvC;AAED,MAAM,WAAW,iBAAiB;IAChC,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,qBAAsB,SAAQ,iBAAiB;IAC9D,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}

package/dist/types/clients/users/index.d.ts

@@ -1,8 +1,9 @@
 import { GenericData } from '@knocklabs/types';
 import { ChannelData, User } from '../../interfaces';
 import { default as Knock } from '../../knock';
+import { InAppMessagesResponse } from '../in-app-messages';
 import { GetPreferencesOptions, PreferenceOptions, PreferenceSet, SetPreferencesProperties } from '../preferences/interfaces';
-import { GetChannelDataInput, SetChannelDataInput } from './interfaces';
+import { GetChannelDataInput, GetInAppMessagesInput, SetChannelDataInput } from './interfaces';
 
 declare class UserClient {
     private instance;
@@ -14,6 +15,7 @@ declare class UserClient {
     setPreferences(preferenceSet: SetPreferencesProperties, options?: PreferenceOptions): Promise<PreferenceSet>;
     getChannelData<T = GenericData>(params: GetChannelDataInput): Promise<ChannelData<T>>;
     setChannelData<T = GenericData>({ channelId, channelData, }: SetChannelDataInput): Promise<ChannelData<T>>;
+    getInAppMessages<TContent extends GenericData = GenericData, TData extends GenericData = GenericData>({ channelId, messageType, params }: GetInAppMessagesInput): Promise<InAppMessagesResponse<TContent, TData>>;
     private handleResponse;
 }
 export default UserClient;

package/dist/types/clients/users/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/clients/users/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAG/C,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,KAAK,MAAM,aAAa,CAAC;AAChC,OAAO,EACL,qBAAqB,EACrB,iBAAiB,EACjB,aAAa,EACb,wBAAwB,EACzB,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAIxE,cAAM,UAAU;IACd,OAAO,CAAC,QAAQ,CAAQ;gBAEZ,QAAQ,EAAE,KAAK;IAIrB,GAAG;IASH,QAAQ,CAAC,KAAK,GAAE,WAAgB;IAUhC,iBAAiB;IASjB,cAAc,CAClB,OAAO,GAAE,qBAA0B,GAClC,OAAO,CAAC,aAAa,CAAC;IAYnB,cAAc,CAClB,aAAa,EAAE,wBAAwB,EACvC,OAAO,GAAE,iBAAsB,GAC9B,OAAO,CAAC,aAAa,CAAC;IAYnB,cAAc,CAAC,CAAC,GAAG,WAAW,EAAE,MAAM,EAAE,mBAAmB;IAS3D,cAAc,CAAC,CAAC,GAAG,WAAW,EAAE,EACpC,SAAS,EACT,WAAW,GACZ,EAAE,mBAAmB;IAUtB,OAAO,CAAC,cAAc;CAOvB;AAED,eAAe,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/clients/users/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAG/C,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,KAAK,MAAM,aAAa,CAAC;AAChC,OAAO,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,EACL,qBAAqB,EACrB,iBAAiB,EACjB,aAAa,EACb,wBAAwB,EACzB,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EACL,mBAAmB,EACnB,qBAAqB,EACrB,mBAAmB,EACpB,MAAM,cAAc,CAAC;AAItB,cAAM,UAAU;IACd,OAAO,CAAC,QAAQ,CAAQ;gBAEZ,QAAQ,EAAE,KAAK;IAIrB,GAAG;IASH,QAAQ,CAAC,KAAK,GAAE,WAAgB;IAUhC,iBAAiB;IASjB,cAAc,CAClB,OAAO,GAAE,qBAA0B,GAClC,OAAO,CAAC,aAAa,CAAC;IAYnB,cAAc,CAClB,aAAa,EAAE,wBAAwB,EACvC,OAAO,GAAE,iBAAsB,GAC9B,OAAO,CAAC,aAAa,CAAC;IAYnB,cAAc,CAAC,CAAC,GAAG,WAAW,EAAE,MAAM,EAAE,mBAAmB;IAS3D,cAAc,CAAC,CAAC,GAAG,WAAW,EAAE,EACpC,SAAS,EACT,WAAW,GACZ,EAAE,mBAAmB;IAUhB,gBAAgB,CACpB,QAAQ,SAAS,WAAW,GAAG,WAAW,EAC1C,KAAK,SAAS,WAAW,GAAG,WAAW,EACvC,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,EAAE,EAAE,qBAAqB;IAU3D,OAAO,CAAC,cAAc;CAOvB;AAED,eAAe,UAAU,CAAC"}

package/dist/types/clients/users/interfaces.d.ts

@@ -1,4 +1,5 @@
 import { GenericData } from '@knocklabs/types';
+import { InAppMessagesClientOptions } from '../in-app-messages/types';
 
 export interface SetChannelDataInput {
     channelId: string;
@@ -7,4 +8,9 @@ export interface SetChannelDataInput {
 export interface GetChannelDataInput {
     channelId: string;
 }
+export interface GetInAppMessagesInput {
+    channelId: string;
+    messageType: string;
+    params: InAppMessagesClientOptions;
+}
 //# sourceMappingURL=interfaces.d.ts.map

package/dist/types/clients/users/interfaces.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../../../../src/clients/users/interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C,MAAM,WAAW,mBAAmB;IAClC,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,WAAW,CAAC;CAC1B;AAED,MAAM,WAAW,mBAAmB;IAClC,SAAS,EAAE,MAAM,CAAC;CACnB"}
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../../../../src/clients/users/interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C,OAAO,EAAE,0BAA0B,EAAE,MAAM,0BAA0B,CAAC;AAEtE,MAAM,WAAW,mBAAmB;IAClC,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,WAAW,CAAC;CAC1B;AAED,MAAM,WAAW,mBAAmB;IAClC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,qBAAqB;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,0BAA0B,CAAC;CACpC"}

package/dist/types/index.d.ts

@@ -12,6 +12,7 @@ export * from './clients/slack/interfaces';
 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';
 export default Knock;

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,EAAE,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,KAAK,MAAM,SAAS,CAAC;AAE5B,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mBAAmB,CAAC;AAClC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,kCAAkC,CAAC;AACjD,cAAc,iBAAiB,CAAC;AAChC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,iBAAiB,CAAC;AAChC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,oBAAoB,CAAC;AACnC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,iBAAiB,CAAC;AAEhC,eAAe,KAAK,CAAC;AACrB,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,EAAE,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,KAAK,MAAM,SAAS,CAAC;AAE5B,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mBAAmB,CAAC;AAClC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,kCAAkC,CAAC;AACjD,cAAc,iBAAiB,CAAC;AAChC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,iBAAiB,CAAC;AAChC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,oBAAoB,CAAC;AACnC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,iBAAiB,CAAC;AAEhC,eAAe,KAAK,CAAC;AACrB,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knocklabs/client",
-  "version": "0.10.13",
+  "version": "0.11.0-rc.0",
   "description": "The clientside library for interacting with Knock",
   "homepage": "https://github.com/knocklabs/javascript/tree/main/packages/client",
   "author": "@knocklabs",
@@ -47,35 +47,37 @@
     "prepublishOnly": "npm run build"
   },
   "devDependencies": {
-    "@babel/cli": "^7.25.6",
-    "@babel/core": "^7.20.0",
+    "@babel/cli": "^7.25.7",
+    "@babel/core": "^7.25.7",
     "@babel/plugin-proposal-class-properties": "^7.16.7",
     "@babel/plugin-proposal-object-rest-spread": "^7.16.7",
-    "@babel/plugin-transform-runtime": "^7.16.7",
+    "@babel/plugin-transform-runtime": "^7.25.4",
     "@babel/preset-env": "^7.16.7",
     "@babel/preset-typescript": "^7.16.7",
     "@types/jsonwebtoken": "^9.0.5",
     "@typescript-eslint/eslint-plugin": "^6.20.0",
-    "@typescript-eslint/parser": "^6.20.0",
+    "@typescript-eslint/parser": "^8.8.1",
     "cross-env": "^7.0.3",
     "crypto": "^1.0.1",
     "eslint": "^8.56.0",
     "jsonwebtoken": "^9.0.2",
     "prettier": "^3.1.0",
     "rimraf": "^6.0.1",
-    "rollup": "^4.21.0",
-    "typescript": "^5.5.4",
+    "rollup": "^4.22.5",
+    "typescript": "^5.6.2",
     "vite": "^5.0.0",
     "vitest": "^2.0.5"
   },
   "dependencies": {
     "@babel/runtime": "^7.25.6",
-    "@knocklabs/types": "^0.1.4",
+    "@knocklabs/types": "^0.1.5-rc.0",
+    "@tanstack/store": "^0.5.5",
     "@types/phoenix": "^1.5.4",
     "axios": "^1.7.4",
-    "axios-retry": "^3.1.9",
+    "axios-retry": "^4.5.0",
     "eventemitter2": "^6.4.5",
     "jwt-decode": "^4.0.0",
+    "nanoid": "^3.0.0",
     "phoenix": "1.6.16",
     "zustand": "^3.7.2"
   }

package/src/clients/in-app-messages/channel-client.ts

@@ -0,0 +1,129 @@
+import Knock from "../../knock";
+import { NetworkStatus } from "../../networkStatus";
+
+import { InAppMessagesClient } from "./message-client";
+import { InAppMessageSocketManager } from "./socket-manager";
+import { InAppMessagesStore, createStore } from "./store";
+import {
+  InAppMessage,
+  InAppMessagesClientOptions,
+  InAppMessagesQueryInfo,
+  InAppMessagesResponse,
+} from "./types";
+
+/**
+ * Manages the configuration for an in app channel.
+ * Stores all fetched messages to support optimistic updates.
+ */
+export class InAppMessagesChannelClient {
+  public store: InAppMessagesStore;
+
+  private socketManager: InAppMessageSocketManager | undefined;
+
+  constructor(
+    readonly knock: Knock,
+    readonly channelId: string,
+    readonly defaultOptions: InAppMessagesClientOptions = {},
+  ) {
+    this.store = createStore();
+
+    // Initialize a socket manager for the in-app channel client, which there
+    // should be one per in-app channel client but it's abstracted out as a
+    // separate module for the organization/encapsulation purposes.
+    const { socket } = this.knock.client();
+    if (socket) {
+      this.socketManager = new InAppMessageSocketManager(socket);
+    }
+
+    this.knock.log(`[IAM] Initialized a client on channel ${channelId}`);
+  }
+
+  // ----------------------------------------------
+  // Store helpers
+  // ----------------------------------------------
+
+  setMessageAttrs(messageIds: string[], attrs: Partial<InAppMessage>) {
+    this.store.setState((state) => ({
+      ...state,
+      messages: {
+        ...state.messages,
+        ...messageIds.reduce<Record<string, InAppMessage>>((messages, id) => {
+          if (state.messages[id]) {
+            messages[id] = {
+              ...state.messages[id],
+              ...attrs,
+            };
+          }
+          return messages;
+        }, {}),
+      },
+    }));
+  }
+
+  setQueryResponse(queryKey: string, response: InAppMessagesResponse) {
+    const queryInfo: InAppMessagesQueryInfo = {
+      loading: false,
+      networkStatus: NetworkStatus.ready,
+      data: {
+        messageIds: response.entries.map((iam) => iam.id),
+        pageInfo: response.pageInfo,
+      },
+    };
+
+    this.store.setState((state) => {
+      return {
+        ...state,
+        // Store new messages in store
+        messages: response.entries.reduce((messages, message) => {
+          messages[message.id] = message;
+          return messages;
+        }, state.messages),
+        // Store query results
+        queries: {
+          ...state.queries,
+          [queryKey]: queryInfo,
+        },
+      };
+    });
+  }
+
+  setQueryStatus(
+    queryKey: string,
+    status: Pick<InAppMessagesQueryInfo, "loading" | "networkStatus">,
+  ) {
+    this.store.setState((state) => ({
+      ...state,
+      queries: {
+        ...state.queries,
+        [queryKey]: {
+          ...state.queries[queryKey],
+          ...status,
+        },
+      },
+    }));
+  }
+
+  /*
+   * Socket
+   */
+
+  subscribe(client: InAppMessagesClient) {
+    if (!this.socketManager) return;
+    this.knock.log(
+      `[InAppMessagesClient] Subscribe a client ${client.referenceId} to socket events`,
+    );
+
+    // Pass the unsub func back to iam client so it can be used when
+    // unsubscribing.
+    return this.socketManager.join(client);
+  }
+
+  unsubscribe(client: InAppMessagesClient) {
+    if (!this.socketManager) return;
+    this.knock.log(
+      `[InAppMessagesClient] Unsubscribe a client ${client.referenceId}`,
+    );
+
+    this.socketManager.leave(client);
+  }
+}

package/src/clients/in-app-messages/index.ts

@@ -0,0 +1,3 @@
+export * from "./channel-client";
+export * from "./message-client";
+export * from "./types";