@knocklabs/client 0.14.10 → 0.14.11

package/dist/esm/knock.mjs

@@ -0,0 +1,95 @@
+var l = Object.defineProperty;
+var c = (n, e, t) => e in n ? l(n, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : n[e] = t;
+var i = (n, e, t) => c(n, typeof e != "symbol" ? e + "" : e, t);
+import { jwtDecode as u } from "jwt-decode";
+import p from "./api.mjs";
+import f from "./clients/feed/index.mjs";
+import k from "./clients/messages/index.mjs";
+import m from "./clients/ms-teams/index.mjs";
+import d from "./clients/objects/index.mjs";
+import T from "./clients/preferences/index.mjs";
+import C from "./clients/slack/index.mjs";
+import w from "./clients/users/index.mjs";
+const g = "https://api.knock.app";
+class v {
+  constructor(e, t = {}) {
+    i(this, "host");
+    i(this, "apiClient", null);
+    i(this, "userId");
+    i(this, "userToken");
+    i(this, "logLevel");
+    i(this, "tokenExpirationTimer", null);
+    i(this, "feeds", new f(this));
+    i(this, "objects", new d(this));
+    i(this, "preferences", new T(this));
+    i(this, "slack", new C(this));
+    i(this, "msTeams", new m(this));
+    i(this, "user", new w(this));
+    i(this, "messages", new k(this));
+    if (this.apiKey = e, this.host = t.host || g, this.logLevel = t.logLevel, this.log("Initialized Knock instance"), this.apiKey && this.apiKey.startsWith("sk_"))
+      throw new Error(
+        "[Knock] You are using your secret API key on the client. Please use the public key."
+      );
+  }
+  client() {
+    return this.apiClient || (this.apiClient = this.createApiClient()), this.apiClient;
+  }
+  /*
+    Authenticates the current user. In non-sandbox environments
+    the userToken must be specified.
+  */
+  authenticate(e, t, s) {
+    let r = !1;
+    this.apiClient && (this.userId !== e || this.userToken !== t) && (this.log("userId or userToken changed; reinitializing connections"), this.feeds.teardownInstances(), this.teardown(), r = !0), this.userId = e, this.userToken = t, this.log(`Authenticated with userId ${e}`), this.userToken && (s == null ? void 0 : s.onUserTokenExpiring) instanceof Function && this.maybeScheduleUserTokenExpiration(
+      s.onUserTokenExpiring,
+      s.timeBeforeExpirationInMs
+    ), r && (this.apiClient = this.createApiClient(), this.feeds.reinitializeInstances(), this.log("Reinitialized real-time connections"));
+  }
+  failIfNotAuthenticated() {
+    if (!this.isAuthenticated())
+      throw new Error("Not authenticated. Please call `authenticate` first.");
+  }
+  /*
+    Returns whether or this Knock instance is authenticated. Passing `true` will check the presence
+    of the userToken as well.
+  */
+  isAuthenticated(e = !1) {
+    return e ? !!(this.userId && this.userToken) : !!this.userId;
+  }
+  // Used to teardown any connected instances
+  teardown() {
+    var e;
+    this.tokenExpirationTimer && clearTimeout(this.tokenExpirationTimer), (e = this.apiClient) != null && e.socket && this.apiClient.socket.isConnected() && this.apiClient.socket.disconnect();
+  }
+  log(e, t = !1) {
+    (this.logLevel === "debug" || t) && console.log(`[Knock] ${e}`);
+  }
+  /**
+   * Initiates an API client
+   */
+  createApiClient() {
+    return new p({
+      apiKey: this.apiKey,
+      host: this.host,
+      userToken: this.userToken
+    });
+  }
+  async maybeScheduleUserTokenExpiration(e, t = 3e4) {
+    if (!this.userToken) return;
+    const s = u(this.userToken), r = (s.exp ?? 0) * 1e3, o = Date.now();
+    if (r && r > o) {
+      const h = r - t - o;
+      this.tokenExpirationTimer = setTimeout(async () => {
+        const a = await e(this.userToken, s);
+        typeof a == "string" && this.authenticate(this.userId, a, {
+          onUserTokenExpiring: e,
+          timeBeforeExpirationInMs: t
+        });
+      }, h);
+    }
+  }
+}
+export {
+  v as default
+};
+//# sourceMappingURL=knock.mjs.map

package/dist/esm/knock.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"knock.mjs","sources":["../../src/knock.ts"],"sourcesContent":["import { jwtDecode } from \"jwt-decode\";\n\nimport ApiClient from \"./api\";\nimport FeedClient from \"./clients/feed\";\nimport MessageClient from \"./clients/messages\";\nimport MsTeamsClient from \"./clients/ms-teams\";\nimport ObjectClient from \"./clients/objects\";\nimport Preferences from \"./clients/preferences\";\nimport SlackClient from \"./clients/slack\";\nimport UserClient from \"./clients/users\";\nimport {\n  AuthenticateOptions,\n  KnockOptions,\n  LogLevel,\n  UserTokenExpiringCallback,\n} from \"./interfaces\";\n\nconst DEFAULT_HOST = \"https://api.knock.app\";\n\nclass Knock {\n  public host: string;\n  private apiClient: ApiClient | null = null;\n  public userId: string | undefined | null;\n  public userToken?: string;\n  public logLevel?: LogLevel;\n  private tokenExpirationTimer: ReturnType<typeof setTimeout> | null = null;\n  readonly feeds = new FeedClient(this);\n  readonly objects = new ObjectClient(this);\n  readonly preferences = new Preferences(this);\n  readonly slack = new SlackClient(this);\n  readonly msTeams = new MsTeamsClient(this);\n  readonly user = new UserClient(this);\n  readonly messages = new MessageClient(this);\n\n  constructor(\n    readonly apiKey: string,\n    options: KnockOptions = {},\n  ) {\n    this.host = options.host || DEFAULT_HOST;\n    this.logLevel = options.logLevel;\n\n    this.log(\"Initialized Knock instance\");\n\n    // Fail loudly if we're using the wrong API key\n    if (this.apiKey && this.apiKey.startsWith(\"sk_\")) {\n      throw new Error(\n        \"[Knock] You are using your secret API key on the client. Please use the public key.\",\n      );\n    }\n  }\n\n  client() {\n    // Initiate a new API client if we don't have one yet\n    if (!this.apiClient) {\n      this.apiClient = this.createApiClient();\n    }\n\n    return this.apiClient;\n  }\n\n  /*\n    Authenticates the current user. In non-sandbox environments\n    the userToken must be specified.\n  */\n  authenticate(\n    userId: Knock[\"userId\"],\n    userToken?: Knock[\"userToken\"],\n    options?: AuthenticateOptions,\n  ) {\n    let reinitializeApi = false;\n    const currentApiClient = this.apiClient;\n\n    // If we've previously been initialized and the values have now changed, then we\n    // need to reinitialize any stateful connections we have\n    if (\n      currentApiClient &&\n      (this.userId !== userId || this.userToken !== userToken)\n    ) {\n      this.log(\"userId or userToken changed; reinitializing connections\");\n      this.feeds.teardownInstances();\n      this.teardown();\n      reinitializeApi = true;\n    }\n\n    this.userId = userId;\n    this.userToken = userToken;\n\n    this.log(`Authenticated with userId ${userId}`);\n\n    if (this.userToken && options?.onUserTokenExpiring instanceof Function) {\n      this.maybeScheduleUserTokenExpiration(\n        options.onUserTokenExpiring,\n        options.timeBeforeExpirationInMs,\n      );\n    }\n\n    // If we get the signal to reinitialize the api client, then we want to create a new client\n    // and the reinitialize any existing feed real-time connections we have so everything continues\n    // to work with the new credentials we've been given\n    if (reinitializeApi) {\n      this.apiClient = this.createApiClient();\n      this.feeds.reinitializeInstances();\n      this.log(\"Reinitialized real-time connections\");\n    }\n\n    return;\n  }\n\n  failIfNotAuthenticated() {\n    if (!this.isAuthenticated()) {\n      throw new Error(\"Not authenticated. Please call `authenticate` first.\");\n    }\n  }\n\n  /*\n    Returns whether or this Knock instance is authenticated. Passing `true` will check the presence\n    of the userToken as well.\n  */\n  isAuthenticated(checkUserToken = false) {\n    return checkUserToken ? !!(this.userId && this.userToken) : !!this.userId;\n  }\n\n  // Used to teardown any connected instances\n  teardown() {\n    if (this.tokenExpirationTimer) {\n      clearTimeout(this.tokenExpirationTimer);\n    }\n    if (this.apiClient?.socket && this.apiClient.socket.isConnected()) {\n      this.apiClient.socket.disconnect();\n    }\n  }\n\n  log(message: string, force = false) {\n    if (this.logLevel === \"debug\" || force) {\n      console.log(`[Knock] ${message}`);\n    }\n  }\n\n  /**\n   * Initiates an API client\n   */\n  private createApiClient() {\n    return new ApiClient({\n      apiKey: this.apiKey,\n      host: this.host,\n      userToken: this.userToken,\n    });\n  }\n\n  private async maybeScheduleUserTokenExpiration(\n    callbackFn: UserTokenExpiringCallback,\n    timeBeforeExpirationInMs: number = 30_000,\n  ) {\n    if (!this.userToken) return;\n\n    const decoded = jwtDecode(this.userToken);\n    const expiresAtMs = (decoded.exp ?? 0) * 1000;\n    const nowMs = Date.now();\n\n    // Expiration is in the future\n    if (expiresAtMs && expiresAtMs > nowMs) {\n      // Check how long until the token should be regenerated\n      // | ----------------- | ----------------------- |\n      // ^ now               ^ expiration offset       ^ expires at\n      const msInFuture = expiresAtMs - timeBeforeExpirationInMs - nowMs;\n\n      this.tokenExpirationTimer = setTimeout(async () => {\n        const newToken = await callbackFn(this.userToken as string, decoded);\n\n        // Reauthenticate which will handle reinitializing sockets\n        if (typeof newToken === \"string\") {\n          this.authenticate(this.userId!, newToken, {\n            onUserTokenExpiring: callbackFn,\n            timeBeforeExpirationInMs: timeBeforeExpirationInMs,\n          });\n        }\n      }, msInFuture);\n    }\n  }\n}\n\nexport default Knock;\n"],"names":["DEFAULT_HOST","Knock","apiKey","options","__publicField","FeedClient","ObjectClient","Preferences","SlackClient","MsTeamsClient","UserClient","MessageClient","userId","userToken","reinitializeApi","checkUserToken","_a","message","force","ApiClient","callbackFn","timeBeforeExpirationInMs","decoded","jwtDecode","expiresAtMs","nowMs","msInFuture","newToken"],"mappings":";;;;;;;;;;;;AAiBA,MAAMA,IAAe;AAErB,MAAMC,EAAM;AAAA,EAeV,YACWC,GACTC,IAAwB,IACxB;AAjBK,IAAAC,EAAA;AACC,IAAAA,EAAA,mBAA8B;AAC/B,IAAAA,EAAA;AACA,IAAAA,EAAA;AACA,IAAAA,EAAA;AACC,IAAAA,EAAA,8BAA6D;AAC5D,IAAAA,EAAA,eAAQ,IAAIC,EAAW,IAAI;AAC3B,IAAAD,EAAA,iBAAU,IAAIE,EAAa,IAAI;AAC/B,IAAAF,EAAA,qBAAc,IAAIG,EAAY,IAAI;AAClC,IAAAH,EAAA,eAAQ,IAAII,EAAY,IAAI;AAC5B,IAAAJ,EAAA,iBAAU,IAAIK,EAAc,IAAI;AAChC,IAAAL,EAAA,cAAO,IAAIM,EAAW,IAAI;AAC1B,IAAAN,EAAA,kBAAW,IAAIO,EAAc,IAAI;AAYxC,QATS,KAAA,SAAAT,GAGJ,KAAA,OAAOC,EAAQ,QAAQH,GAC5B,KAAK,WAAWG,EAAQ,UAExB,KAAK,IAAI,4BAA4B,GAGjC,KAAK,UAAU,KAAK,OAAO,WAAW,KAAK;AAC7C,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,EACF;AAAA,EAGF,SAAS;AAEH,WAAC,KAAK,cACH,KAAA,YAAY,KAAK,gBAAgB,IAGjC,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOd,aACES,GACAC,GACAV,GACA;AACA,QAAIW,IAAkB;AAKtB,IAJyB,KAAK,cAM3B,KAAK,WAAWF,KAAU,KAAK,cAAcC,OAE9C,KAAK,IAAI,yDAAyD,GAClE,KAAK,MAAM,kBAAkB,GAC7B,KAAK,SAAS,GACIC,IAAA,KAGpB,KAAK,SAASF,GACd,KAAK,YAAYC,GAEZ,KAAA,IAAI,6BAA6BD,CAAM,EAAE,GAE1C,KAAK,cAAaT,KAAA,gBAAAA,EAAS,gCAA+B,YACvD,KAAA;AAAA,MACHA,EAAQ;AAAA,MACRA,EAAQ;AAAA,IACV,GAMEW,MACG,KAAA,YAAY,KAAK,gBAAgB,GACtC,KAAK,MAAM,sBAAsB,GACjC,KAAK,IAAI,qCAAqC;AAAA,EAGhD;AAAA,EAGF,yBAAyB;AACnB,QAAA,CAAC,KAAK;AACF,YAAA,IAAI,MAAM,sDAAsD;AAAA,EACxE;AAAA;AAAA;AAAA;AAAA;AAAA,EAOF,gBAAgBC,IAAiB,IAAO;AAC/B,WAAAA,IAAiB,CAAC,EAAE,KAAK,UAAU,KAAK,aAAa,CAAC,CAAC,KAAK;AAAA,EAAA;AAAA;AAAA,EAIrE,WAAW;;AACT,IAAI,KAAK,wBACP,aAAa,KAAK,oBAAoB,IAEpCC,IAAA,KAAK,cAAL,QAAAA,EAAgB,UAAU,KAAK,UAAU,OAAO,iBAC7C,KAAA,UAAU,OAAO,WAAW;AAAA,EACnC;AAAA,EAGF,IAAIC,GAAiBC,IAAQ,IAAO;AAC9B,KAAA,KAAK,aAAa,WAAWA,MACvB,QAAA,IAAI,WAAWD,CAAO,EAAE;AAAA,EAClC;AAAA;AAAA;AAAA;AAAA,EAMM,kBAAkB;AACxB,WAAO,IAAIE,EAAU;AAAA,MACnB,QAAQ,KAAK;AAAA,MACb,MAAM,KAAK;AAAA,MACX,WAAW,KAAK;AAAA,IAAA,CACjB;AAAA,EAAA;AAAA,EAGH,MAAc,iCACZC,GACAC,IAAmC,KACnC;AACI,QAAA,CAAC,KAAK,UAAW;AAEf,UAAAC,IAAUC,EAAU,KAAK,SAAS,GAClCC,KAAeF,EAAQ,OAAO,KAAK,KACnCG,IAAQ,KAAK,IAAI;AAGnB,QAAAD,KAAeA,IAAcC,GAAO;AAIhC,YAAAC,IAAaF,IAAcH,IAA2BI;AAEvD,WAAA,uBAAuB,WAAW,YAAY;AACjD,cAAME,IAAW,MAAMP,EAAW,KAAK,WAAqBE,CAAO;AAG/D,QAAA,OAAOK,KAAa,YACjB,KAAA,aAAa,KAAK,QAASA,GAAU;AAAA,UACxC,qBAAqBP;AAAA,UACrB,0BAAAC;AAAA,QAAA,CACD;AAAA,SAEFK,CAAU;AAAA,IAAA;AAAA,EACf;AAEJ;"}

package/dist/esm/networkStatus.mjs

@@ -0,0 +1,15 @@
+var e = /* @__PURE__ */ ((r) => (r.loading = "loading", r.fetchMore = "fetchMore", r.ready = "ready", r.error = "error", r))(e || {});
+function n(r) {
+  return [
+    "loading",
+    "fetchMore"
+    /* fetchMore */
+  ].includes(
+    r
+  );
+}
+export {
+  e as NetworkStatus,
+  n as isRequestInFlight
+};
+//# sourceMappingURL=networkStatus.mjs.map

package/dist/esm/networkStatus.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"networkStatus.mjs","sources":["../../src/networkStatus.ts"],"sourcesContent":["export enum NetworkStatus {\n  // Performing a top level loading operation\n  loading = \"loading\",\n\n  // Performing a fetch more on some already loaded data\n  fetchMore = \"fetchMore\",\n\n  // No operation is currently in progress\n  ready = \"ready\",\n\n  // The last operation failed with an error\n  error = \"error\",\n}\n\nexport function isRequestInFlight(networkStatus: NetworkStatus): boolean {\n  return [NetworkStatus.loading, NetworkStatus.fetchMore].includes(\n    networkStatus,\n  );\n}\n"],"names":["NetworkStatus","isRequestInFlight","networkStatus"],"mappings":"AAAY,IAAAA,sBAAAA,OAEVA,EAAA,UAAU,WAGVA,EAAA,YAAY,aAGZA,EAAA,QAAQ,SAGRA,EAAA,QAAQ,SAXEA,IAAAA,KAAA,CAAA,CAAA;AAcL,SAASC,EAAkBC,GAAuC;AAChE,SAAA;AAAA,IAAC;AAAA,IAAuB;AAAA;AAAA,EAAA,EAAyB;AAAA,IACtDA;AAAA,EACF;AACF;"}

package/dist/types/api.d.ts

@@ -0,0 +1,25 @@
+import { AxiosRequestConfig } from 'axios';
+import { Socket } from 'phoenix';
+type ApiClientOptions = {
+    host: string;
+    apiKey: string;
+    userToken: string | undefined;
+};
+export interface ApiResponse {
+    error?: any;
+    body?: any;
+    statusCode: "ok" | "error";
+    status: number;
+}
+declare class ApiClient {
+    private host;
+    private apiKey;
+    private userToken;
+    private axiosClient;
+    socket: Socket | undefined;
+    constructor(options: ApiClientOptions);
+    makeRequest(req: AxiosRequestConfig): Promise<ApiResponse>;
+    private canRetryRequest;
+}
+export default ApiClient;
+//# sourceMappingURL=api.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../src/api.ts"],"names":[],"mappings":"AAAA,OAAc,EAA6B,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAE7E,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAEjC,KAAK,gBAAgB,GAAG;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B,CAAC;AAEF,MAAM,WAAW,WAAW;IAE1B,KAAK,CAAC,EAAE,GAAG,CAAC;IAEZ,IAAI,CAAC,EAAE,GAAG,CAAC;IACX,UAAU,EAAE,IAAI,GAAG,OAAO,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,cAAM,SAAS;IACb,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,SAAS,CAAgB;IACjC,OAAO,CAAC,WAAW,CAAgB;IAE5B,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;gBAEtB,OAAO,EAAE,gBAAgB;IAgC/B,WAAW,CAAC,GAAG,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC;IAwBhE,OAAO,CAAC,eAAe;CAuBxB;AAED,eAAe,SAAS,CAAC"}

package/dist/types/clients/feed/feed.d.ts

@@ -0,0 +1,75 @@
+import { GenericData } from '@knocklabs/types';
+import { default as Knock } from '../../knock';
+import { FeedClientOptions, FetchFeedOptions } from './interfaces';
+import { FeedSocketManager, SocketEventPayload } from './socket-manager';
+import { FeedStore } from './store';
+import { BindableFeedEvent, FeedEventCallback, FeedItemOrItems, FeedRealTimeCallback } from './types';
+declare class Feed {
+    readonly knock: Knock;
+    readonly feedId: string;
+    readonly defaultOptions: FeedClientOptions;
+    readonly referenceId: string;
+    unsubscribeFromSocketEvents: (() => void) | undefined;
+    private socketManager;
+    private userFeedId;
+    private broadcaster;
+    private broadcastChannel;
+    private disconnectTimer;
+    private hasSubscribedToRealTimeUpdates;
+    private visibilityChangeHandler;
+    private visibilityChangeListenerConnected;
+    store: FeedStore;
+    constructor(knock: Knock, feedId: string, options: FeedClientOptions, socketManager: FeedSocketManager | undefined);
+    /**
+     * Used to reinitialize a current feed instance, which is useful when reauthenticating users
+     */
+    reinitialize(socketManager?: FeedSocketManager): void;
+    /**
+     * Cleans up a feed instance by destroying the store and disconnecting
+     * an open socket connection.
+     */
+    teardown(): void;
+    /** Tears down an instance and removes it entirely from the feed manager */
+    dispose(): void;
+    listenForUpdates(): void;
+    on(eventName: BindableFeedEvent, callback: FeedEventCallback | FeedRealTimeCallback): void;
+    off(eventName: BindableFeedEvent, callback: FeedEventCallback | FeedRealTimeCallback): void;
+    getState(): import('./types').FeedStoreState;
+    markAsSeen(itemOrItems: FeedItemOrItems): Promise<import('../messages/interfaces').Message<GenericData>[]>;
+    markAllAsSeen(): Promise<import('../..').BulkOperation>;
+    markAsUnseen(itemOrItems: FeedItemOrItems): Promise<import('../messages/interfaces').Message<GenericData>[]>;
+    markAsRead(itemOrItems: FeedItemOrItems): Promise<import('../messages/interfaces').Message<GenericData>[]>;
+    markAllAsRead(): Promise<import('../..').BulkOperation>;
+    markAsUnread(itemOrItems: FeedItemOrItems): Promise<import('../messages/interfaces').Message<GenericData>[]>;
+    markAsInteracted(itemOrItems: FeedItemOrItems, metadata?: Record<string, string>): Promise<import('../messages/interfaces').Message<GenericData>[]>;
+    markAsArchived(itemOrItems: FeedItemOrItems): Promise<import('../messages/interfaces').Message<GenericData>[]>;
+    markAllAsArchived(): Promise<import('../..').BulkOperation>;
+    markAllReadAsArchived(): Promise<import('../..').BulkOperation>;
+    markAsUnarchived(itemOrItems: FeedItemOrItems): Promise<import('../messages/interfaces').Message<GenericData>[]>;
+    fetch(options?: FetchFeedOptions): Promise<{
+        status: "ok" | "error";
+        data: any;
+    } | undefined>;
+    fetchNextPage(options?: FetchFeedOptions): Promise<void>;
+    get socketChannelTopic(): string;
+    private broadcast;
+    private onNewMessageReceived;
+    private buildUserFeedId;
+    private optimisticallyPerformStatusUpdate;
+    private makeStatusUpdate;
+    private makeBulkStatusUpdate;
+    private setupBroadcastChannel;
+    private broadcastOverChannel;
+    private initializeRealtimeConnection;
+    handleSocketEvent(payload: SocketEventPayload): Promise<void>;
+    /**
+     * Listen for changes to document visibility and automatically disconnect
+     * or reconnect the socket after a delay
+     */
+    private setUpVisibilityListeners;
+    private tearDownVisibilityListeners;
+    private emitEvent;
+    private handleVisibilityChange;
+}
+export default Feed;
+//# sourceMappingURL=feed.d.ts.map

package/dist/types/clients/feed/feed.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"feed.d.ts","sourceRoot":"","sources":["../../../../src/clients/feed/feed.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAK/C,OAAO,KAAK,MAAM,aAAa,CAAC;AAOhC,OAAO,EACL,iBAAiB,EAIjB,gBAAgB,EAEjB,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,iBAAiB,EACjB,kBAAkB,EAEnB,MAAM,kBAAkB,CAAC;AAC1B,OAAoB,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AACjD,OAAO,EACL,iBAAiB,EAEjB,iBAAiB,EAEjB,eAAe,EAEf,oBAAoB,EACrB,MAAM,SAAS,CAAC;AAYjB,cAAM,IAAI;IAiBN,QAAQ,CAAC,KAAK,EAAE,KAAK;IACrB,QAAQ,CAAC,MAAM,EAAE,MAAM;IAjBzB,SAAgB,cAAc,EAAE,iBAAiB,CAAC;IAClD,SAAgB,WAAW,EAAE,MAAM,CAAC;IAC7B,2BAA2B,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,SAAS,CAAa;IACzE,OAAO,CAAC,aAAa,CAAgC;IACrD,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,WAAW,CAAe;IAClC,OAAO,CAAC,gBAAgB,CAA2B;IACnD,OAAO,CAAC,eAAe,CAA8C;IACrE,OAAO,CAAC,8BAA8B,CAAkB;IACxD,OAAO,CAAC,uBAAuB,CAAwB;IACvD,OAAO,CAAC,iCAAiC,CAAkB;IAGpD,KAAK,EAAE,SAAS,CAAC;gBAGb,KAAK,EAAE,KAAK,EACZ,MAAM,EAAE,MAAM,EACvB,OAAO,EAAE,iBAAiB,EAC1B,aAAa,EAAE,iBAAiB,GAAG,SAAS;IA2B9C;;OAEG;IACH,YAAY,CAAC,aAAa,CAAC,EAAE,iBAAiB;IAa9C;;;OAGG;IACH,QAAQ;IAiBR,2EAA2E;IAC3E,OAAO;IAWP,gBAAgB;IAiBhB,EAAE,CACA,SAAS,EAAE,iBAAiB,EAC5B,QAAQ,EAAE,iBAAiB,GAAG,oBAAoB;IAKpD,GAAG,CACD,SAAS,EAAE,iBAAiB,EAC5B,QAAQ,EAAE,iBAAiB,GAAG,oBAAoB;IAKpD,QAAQ;IAIF,UAAU,CAAC,WAAW,EAAE,eAAe;IAYvC,aAAa;IA0Cb,YAAY,CAAC,WAAW,EAAE,eAAe;IAWzC,UAAU,CAAC,WAAW,EAAE,eAAe;IAYvC,aAAa;IA0Cb,YAAY,CAAC,WAAW,EAAE,eAAe;IAWzC,gBAAgB,CACpB,WAAW,EAAE,eAAe,EAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAwB7B,cAAc,CAAC,WAAW,EAAE,eAAe;IAuE3C,iBAAiB;IA2BjB,qBAAqB;IA0CrB,gBAAgB,CAAC,WAAW,EAAE,eAAe;IAS7C,KAAK,CAAC,OAAO,GAAE,gBAAqB;;;;IA0FpC,aAAa,CAAC,OAAO,GAAE,gBAAqB;IAgBlD,IAAI,kBAAkB,IAAI,MAAM,CAE/B;IAED,OAAO,CAAC,SAAS;YAQH,oBAAoB;IAiBlC,OAAO,CAAC,eAAe;IAIvB,OAAO,CAAC,iCAAiC;YAiD3B,gBAAgB;YAsBhB,oBAAoB;IA2BlC,OAAO,CAAC,qBAAqB;IAoC7B,OAAO,CAAC,oBAAoB;IAoB5B,OAAO,CAAC,4BAA4B;IAe9B,iBAAiB,CAAC,OAAO,EAAE,kBAAkB;IAYnD;;;OAGG;IACH,OAAO,CAAC,wBAAwB;IAahC,OAAO,CAAC,2BAA2B;IAUnC,OAAO,CAAC,SAAS;IAkBjB,OAAO,CAAC,sBAAsB;CA2B/B;AAED,eAAe,IAAI,CAAC"}

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

@@ -0,0 +1,17 @@
+import { default as Knock } from '../../knock';
+import { default as Feed } from './feed';
+import { FeedClientOptions } from './interfaces';
+declare class FeedClient {
+    private instance;
+    private feedInstances;
+    private socketManager;
+    constructor(instance: Knock);
+    initialize(feedChannelId: string, options?: FeedClientOptions): Feed;
+    removeInstance(feed: Feed): void;
+    teardownInstances(): void;
+    reinitializeInstances(): void;
+    private initSocketManager;
+}
+export { Feed };
+export default FeedClient;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/clients/feed/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,aAAa,CAAC;AAEhC,OAAO,IAAI,MAAM,QAAQ,CAAC;AAC1B,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAGjD,cAAM,UAAU;IACd,OAAO,CAAC,QAAQ,CAAQ;IACxB,OAAO,CAAC,aAAa,CAAc;IACnC,OAAO,CAAC,aAAa,CAAgC;gBAEzC,QAAQ,EAAE,KAAK;IAI3B,UAAU,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,GAAE,iBAAsB;IAajE,cAAc,CAAC,IAAI,EAAE,IAAI;IAIzB,iBAAiB;IAMjB,qBAAqB;IAerB,OAAO,CAAC,iBAAiB;CAM1B;AAED,OAAO,EAAE,IAAI,EAAE,CAAC;AAChB,eAAe,UAAU,CAAC"}

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

@@ -0,0 +1,99 @@
+import { GenericData, PageInfo } from '@knocklabs/types';
+import { Activity, Recipient } from '../../interfaces';
+import { NetworkStatus } from '../../networkStatus';
+import { NotificationSource } from '../messages/interfaces';
+/**
+ * `trigger_data` may only specify flat key-value pairs, not nested objects
+ * Specifying a nested object will result in a 422 "invalid_params" error
+ * https://docs.knock.app/reference#trigger-data-filtering
+ */
+export interface TriggerData extends GenericData {
+    [key: string]: string | number | boolean | null;
+}
+export interface FeedClientOptions {
+    before?: string;
+    after?: string;
+    page_size?: number;
+    status?: "unread" | "read" | "unseen" | "seen" | "all";
+    source?: string;
+    tenant?: string;
+    has_tenant?: boolean;
+    workflow_categories?: string[];
+    archived?: "include" | "exclude" | "only";
+    trigger_data?: TriggerData;
+    __experimentalCrossBrowserUpdates?: boolean;
+    auto_manage_socket_connection?: boolean;
+    auto_manage_socket_connection_delay?: number;
+    inserted_at_date_range?: {
+        start?: string;
+        end?: string;
+        inclusive?: boolean;
+    };
+}
+export type FetchFeedOptions = {
+    __loadingType?: NetworkStatus.loading | NetworkStatus.fetchMore;
+    __fetchSource?: "socket" | "http";
+} & Omit<FeedClientOptions, "__experimentalCrossBrowserUpdates">;
+export type FetchFeedOptionsForRequest = Omit<FeedClientOptions, "trigger_data"> & {
+    trigger_data?: string;
+    __loadingType: undefined;
+    __fetchSource: undefined;
+    __experimentalCrossBrowserUpdates: undefined;
+    auto_manage_socket_connection: undefined;
+    auto_manage_socket_connection_delay: undefined;
+};
+export interface ContentBlockBase {
+    name: string;
+    type: "markdown" | "text" | "button_set";
+}
+export interface ActionButton {
+    name: string;
+    label: string;
+    action: string;
+}
+export interface ButtonSetContentBlock extends ContentBlockBase {
+    type: "button_set";
+    buttons: ActionButton[];
+}
+export interface TextContentBlock extends ContentBlockBase {
+    type: "text";
+    rendered: string;
+    content: string;
+}
+export interface MarkdownContentBlock extends ContentBlockBase {
+    type: "markdown";
+    rendered: string;
+    content: string;
+}
+export type ContentBlock = MarkdownContentBlock | TextContentBlock | ButtonSetContentBlock;
+export interface FeedItem<T = GenericData> {
+    __cursor: string;
+    id: string;
+    activities: Activity<T>[];
+    actors: Recipient[];
+    blocks: ContentBlock[];
+    inserted_at: string;
+    updated_at: string;
+    read_at: string | null;
+    seen_at: string | null;
+    clicked_at: string | null;
+    interacted_at: string | null;
+    link_clicked_at: string | null;
+    archived_at: string | null;
+    total_activities: number;
+    total_actors: number;
+    data: T | null;
+    source: NotificationSource;
+    tenant: string | null;
+}
+export interface FeedMetadata {
+    total_count: number;
+    unread_count: number;
+    unseen_count: number;
+}
+export interface FeedResponse<T = GenericData> {
+    entries: FeedItem<T>[];
+    meta: FeedMetadata;
+    page_info: PageInfo;
+}
+//# sourceMappingURL=interfaces.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../../../../src/clients/feed/interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAEzD,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAI5D;;;;GAIG;AACH,MAAM,WAAW,WAAY,SAAQ,WAAW;IAC9C,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;CACjD;AAED,MAAM,WAAW,iBAAiB;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,KAAK,CAAC;IAEvD,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE/B,QAAQ,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,MAAM,CAAC;IAE1C,YAAY,CAAC,EAAE,WAAW,CAAC;IAE3B,iCAAiC,CAAC,EAAE,OAAO,CAAC;IAE5C,6BAA6B,CAAC,EAAE,OAAO,CAAC;IAGxC,mCAAmC,CAAC,EAAE,MAAM,CAAC;IAE7C,sBAAsB,CAAC,EAAE;QAEvB,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb,SAAS,CAAC,EAAE,OAAO,CAAC;KACrB,CAAC;CACH;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,aAAa,CAAC,EAAE,aAAa,CAAC,OAAO,GAAG,aAAa,CAAC,SAAS,CAAC;IAChE,aAAa,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;CACnC,GAAG,IAAI,CAAC,iBAAiB,EAAE,mCAAmC,CAAC,CAAC;AAIjE,MAAM,MAAM,0BAA0B,GAAG,IAAI,CAC3C,iBAAiB,EACjB,cAAc,CACf,GAAG;IAEF,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,aAAa,EAAE,SAAS,CAAC;IACzB,aAAa,EAAE,SAAS,CAAC;IACzB,iCAAiC,EAAE,SAAS,CAAC;IAC7C,6BAA6B,EAAE,SAAS,CAAC;IACzC,mCAAmC,EAAE,SAAS,CAAC;CAChD,CAAC;AAEF,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,YAAY,CAAC;CAC1C;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB;IAC7D,IAAI,EAAE,YAAY,CAAC;IACnB,OAAO,EAAE,YAAY,EAAE,CAAC;CACzB;AAED,MAAM,WAAW,gBAAiB,SAAQ,gBAAgB;IACxD,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC5D,IAAI,EAAE,UAAU,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,MAAM,YAAY,GACpB,oBAAoB,GACpB,gBAAgB,GAChB,qBAAqB,CAAC;AAE1B,MAAM,WAAW,QAAQ,CAAC,CAAC,GAAG,WAAW;IACvC,QAAQ,EAAE,MAAM,CAAC;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;IAC1B,MAAM,EAAE,SAAS,EAAE,CAAC;IACpB,MAAM,EAAE,YAAY,EAAE,CAAC;IACvB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,gBAAgB,EAAE,MAAM,CAAC;IACzB,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC;IACf,MAAM,EAAE,kBAAkB,CAAC;IAC3B,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,YAAY;IAC3B,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,YAAY,CAAC,CAAC,GAAG,WAAW;IAC3C,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;IACvB,IAAI,EAAE,YAAY,CAAC;IACnB,SAAS,EAAE,QAAQ,CAAC;CACrB"}

package/dist/types/clients/feed/socket-manager.d.ts

@@ -0,0 +1,31 @@
+import { Socket } from 'phoenix';
+import { default as Feed } from './feed';
+import { FeedMetadata } from './interfaces';
+export declare const SocketEventType: {
+    readonly NewMessage: "new-message";
+};
+type ClientReferenceId = string;
+type NewMessageEventPayload = {
+    event: typeof SocketEventType.NewMessage;
+    /**
+     * @deprecated Top-level feed metadata. Exists for legacy reasons.
+     */
+    metadata: FeedMetadata;
+    /** Feed metadata, keyed by client reference id. */
+    data: Record<ClientReferenceId, {
+        metadata: FeedMetadata;
+    }>;
+};
+export type SocketEventPayload = NewMessageEventPayload;
+export declare class FeedSocketManager {
+    readonly socket: Socket;
+    private channels;
+    private params;
+    private inbox;
+    constructor(socket: Socket);
+    join(feed: Feed): () => void;
+    leave(feed: Feed): void;
+    private setInbox;
+}
+export {};
+//# sourceMappingURL=socket-manager.d.ts.map

package/dist/types/clients/feed/socket-manager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"socket-manager.d.ts","sourceRoot":"","sources":["../../../../src/clients/feed/socket-manager.ts"],"names":[],"mappings":"AACA,OAAO,EAAW,MAAM,EAAE,MAAM,SAAS,CAAC;AAE1C,OAAO,IAAI,MAAM,QAAQ,CAAC;AAC1B,OAAO,KAAK,EAAqB,YAAY,EAAE,MAAM,cAAc,CAAC;AAEpE,eAAO,MAAM,eAAe;;CAElB,CAAC;AAUX,KAAK,iBAAiB,GAAG,MAAM,CAAC;AAEhC,KAAK,sBAAsB,GAAG;IAC5B,KAAK,EAAE,OAAO,eAAe,CAAC,UAAU,CAAC;IACzC;;OAEG;IACH,QAAQ,EAAE,YAAY,CAAC;IACvB,mDAAmD;IACnD,IAAI,EAAE,MAAM,CAAC,iBAAiB,EAAE;QAAE,QAAQ,EAAE,YAAY,CAAA;KAAE,CAAC,CAAC;CAC7D,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,sBAAsB,CAAC;AAaxD,qBAAa,iBAAiB;IAuChB,QAAQ,CAAC,MAAM,EAAE,MAAM;IApCnC,OAAO,CAAC,QAAQ,CAAgC;IAwBhD,OAAO,CAAC,MAAM,CAGZ;IAIF,OAAO,CAAC,KAAK,CAGX;gBAEmB,MAAM,EAAE,MAAM;IAMnC,IAAI,CAAC,IAAI,EAAE,IAAI;IAwDf,KAAK,CAAC,IAAI,EAAE,IAAI;IA4BhB,OAAO,CAAC,QAAQ;CAYjB"}

package/dist/types/clients/feed/store.d.ts

@@ -0,0 +1,20 @@
+import { Store } from '@tanstack/store';
+import { FeedStoreState } from './types';
+export declare const initialStoreState: FeedStoreState;
+/**
+ * The FeedStore class is a wrapper for our store solution that's
+ * based on the same shape as zustand. This wrapping class allows
+ * us to maintain backwards compatibility with the zustand model
+ * while still allowing us to utilize tanstack store for the
+ * underlying store solution.
+ */
+export declare class FeedStore {
+    store: Store<FeedStoreState>;
+    constructor(store: Store<FeedStoreState>);
+    getState(): FeedStoreState;
+    setState(updater: ((state: FeedStoreState) => FeedStoreState) | FeedStoreState): void;
+    getInitialState(): FeedStoreState;
+    subscribe(listener: (state: FeedStoreState) => void): () => void;
+}
+export default function createStore(): FeedStore;
+//# sourceMappingURL=store.d.ts.map

package/dist/types/clients/feed/store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"store.d.ts","sourceRoot":"","sources":["../../../../src/clients/feed/store.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAKxC,OAAO,EAAE,cAAc,EAA0B,MAAM,SAAS,CAAC;AAejE,eAAO,MAAM,iBAAiB,EAAE,cAmB/B,CAAC;AAwEF;;;;;;GAMG;AACH,qBAAa,SAAS;IACpB,KAAK,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;gBAEjB,KAAK,EAAE,KAAK,CAAC,cAAc,CAAC;IAIxC,QAAQ;IAIR,QAAQ,CACN,OAAO,EAAE,CAAC,CAAC,KAAK,EAAE,cAAc,KAAK,cAAc,CAAC,GAAG,cAAc;IAOvE,eAAe;IAIf,SAAS,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,IAAI;CAGpD;AAED,MAAM,CAAC,OAAO,UAAU,WAAW,cAGlC"}

package/dist/types/clients/feed/types.d.ts

@@ -0,0 +1,35 @@
+import { GenericData, PageInfo } from '@knocklabs/types';
+import { NetworkStatus } from '../../networkStatus';
+import { FeedItem, FeedMetadata, FeedResponse } from './interfaces';
+import { SocketEventPayload, SocketEventType } from './socket-manager';
+export type StoreFeedResultOptions = {
+    shouldSetPage?: boolean;
+    shouldAppend?: boolean;
+};
+export interface FeedStoreState {
+    items: FeedItem[];
+    pageInfo: PageInfo;
+    metadata: FeedMetadata;
+    loading: boolean;
+    networkStatus: NetworkStatus;
+    setResult: (response: FeedResponse, opts?: StoreFeedResultOptions) => void;
+    setMetadata: (metadata: FeedMetadata) => void;
+    setNetworkStatus: (networkStatus: NetworkStatus) => void;
+    setItemAttrs: (itemIds: string[], attrs: object) => void;
+    resetStore: (metadata?: FeedMetadata) => void;
+}
+export type FeedMessagesReceivedPayload = Extract<SocketEventPayload, {
+    event: typeof SocketEventType.NewMessage;
+}>;
+export type FeedRealTimeEvent = "messages.new";
+export type FeedEvent = FeedRealTimeEvent | "items.received.page" | "items.received.realtime" | "items.archived" | "items.unarchived" | "items.seen" | "items.unseen" | "items.read" | "items.unread" | "items.all_archived" | "items.all_read" | "items.all_seen";
+export type BindableFeedEvent = FeedEvent | "items.received.*" | "items.*";
+export interface FeedEventPayload<T = GenericData> {
+    event: Omit<FeedEvent, "messages.new">;
+    items: FeedItem<T>[];
+    metadata: FeedMetadata;
+}
+export type FeedRealTimeCallback = (resp: FeedResponse) => void;
+export type FeedEventCallback = (payload: FeedEventPayload) => void;
+export type FeedItemOrItems = FeedItem | FeedItem[];
+//# sourceMappingURL=types.d.ts.map

package/dist/types/clients/feed/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/clients/feed/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAEzD,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEpD,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AACpE,OAAO,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAEvE,MAAM,MAAM,sBAAsB,GAAG;IACnC,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,QAAQ,EAAE,CAAC;IAClB,QAAQ,EAAE,QAAQ,CAAC;IACnB,QAAQ,EAAE,YAAY,CAAC;IACvB,OAAO,EAAE,OAAO,CAAC;IACjB,aAAa,EAAE,aAAa,CAAC;IAC7B,SAAS,EAAE,CAAC,QAAQ,EAAE,YAAY,EAAE,IAAI,CAAC,EAAE,sBAAsB,KAAK,IAAI,CAAC;IAC3E,WAAW,EAAE,CAAC,QAAQ,EAAE,YAAY,KAAK,IAAI,CAAC;IAC9C,gBAAgB,EAAE,CAAC,aAAa,EAAE,aAAa,KAAK,IAAI,CAAC;IACzD,YAAY,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IACzD,UAAU,EAAE,CAAC,QAAQ,CAAC,EAAE,YAAY,KAAK,IAAI,CAAC;CAC/C;AAED,MAAM,MAAM,2BAA2B,GAAG,OAAO,CAC/C,kBAAkB,EAClB;IAAE,KAAK,EAAE,OAAO,eAAe,CAAC,UAAU,CAAA;CAAE,CAC7C,CAAC;AAQF,MAAM,MAAM,iBAAiB,GAAG,cAAc,CAAC;AAE/C,MAAM,MAAM,SAAS,GACjB,iBAAiB,GACjB,qBAAqB,GACrB,yBAAyB,GACzB,gBAAgB,GAChB,kBAAkB,GAClB,YAAY,GACZ,cAAc,GACd,YAAY,GACZ,cAAc,GACd,oBAAoB,GACpB,gBAAgB,GAChB,gBAAgB,CAAC;AAGrB,MAAM,MAAM,iBAAiB,GAAG,SAAS,GAAG,kBAAkB,GAAG,SAAS,CAAC;AAE3E,MAAM,WAAW,gBAAgB,CAAC,CAAC,GAAG,WAAW;IAC/C,KAAK,EAAE,IAAI,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;IACvC,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;IACrB,QAAQ,EAAE,YAAY,CAAC;CACxB;AAED,MAAM,MAAM,oBAAoB,GAAG,CAAC,IAAI,EAAE,YAAY,KAAK,IAAI,CAAC;AAEhE,MAAM,MAAM,iBAAiB,GAAG,CAAC,OAAO,EAAE,gBAAgB,KAAK,IAAI,CAAC;AAEpE,MAAM,MAAM,eAAe,GAAG,QAAQ,GAAG,QAAQ,EAAE,CAAC"}

package/dist/types/clients/feed/utils.d.ts

@@ -0,0 +1,20 @@
+import { FeedClientOptions, FeedItem } from './interfaces';
+export declare function deduplicateItems(items: FeedItem[]): FeedItem[];
+export declare function sortItems(items: FeedItem[]): FeedItem<import('@knocklabs/types').GenericData>[];
+export declare function mergeDateRangeParams(options: FeedClientOptions): {
+    before?: string;
+    after?: string;
+    page_size?: number;
+    status?: "unread" | "read" | "unseen" | "seen" | "all";
+    source?: string;
+    tenant?: string;
+    has_tenant?: boolean;
+    workflow_categories?: string[];
+    archived?: "include" | "exclude" | "only";
+    trigger_data?: import('./interfaces').TriggerData;
+    __experimentalCrossBrowserUpdates?: boolean;
+    auto_manage_socket_connection?: boolean;
+    auto_manage_socket_connection_delay?: number;
+};
+export declare function getFormattedTriggerData(options: FeedClientOptions): string | undefined;
+//# sourceMappingURL=utils.d.ts.map

package/dist/types/clients/feed/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../src/clients/feed/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAEhE,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,QAAQ,EAAE,GAAG,QAAQ,EAAE,CAY9D;AAED,wBAAgB,SAAS,CAAC,KAAK,EAAE,QAAQ,EAAE,sDAM1C;AAED,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,iBAAiB;;;;;;;;;;;;;;EAyB9D;AAMD,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,iBAAiB,sBAYjE"}

package/dist/types/clients/guide/client.d.ts

@@ -0,0 +1,124 @@
+import { GenericData } from '@knocklabs/types';
+import { Store } from '@tanstack/store';
+import { URLPattern } from 'urlpattern-polyfill';
+import { default as Knock } from '../../knock';
+export declare const guidesApiRootPath: (userId: string | undefined | null) => string;
+interface StepMessageState {
+    id: string;
+    seen_at: string | null;
+    read_at: string | null;
+    interacted_at: string | null;
+    archived_at: string | null;
+    link_clicked_at: string | null;
+}
+interface GuideStepData {
+    ref: string;
+    schema_key: string;
+    schema_semver: string;
+    schema_variant_key: string;
+    message: StepMessageState;
+    content: any;
+}
+interface GuideActivationLocationRuleData {
+    directive: "allow" | "block";
+    pathname: string;
+}
+interface GuideData {
+    __typename: "Guide";
+    channel_id: string;
+    id: string;
+    key: string;
+    priority: number;
+    type: string;
+    semver: string;
+    steps: GuideStepData[];
+    activation_location_rules: GuideActivationLocationRuleData[];
+    inserted_at: string;
+    updated_at: string;
+}
+export interface KnockGuideStep extends GuideStepData {
+    markAsSeen: () => void;
+    markAsInteracted: (params?: {
+        metadata?: GenericData;
+    }) => void;
+    markAsArchived: () => void;
+}
+interface KnockGuideActivationLocationRule extends GuideActivationLocationRuleData {
+    pattern: URLPattern;
+}
+export interface KnockGuide extends GuideData {
+    steps: KnockGuideStep[];
+    activation_location_rules: KnockGuideActivationLocationRule[];
+}
+type GetGuidesQueryParams = {
+    data?: string;
+    tenant?: string;
+    type?: string;
+};
+export type GuideEngagementEventBaseParams = {
+    message_id: string;
+    channel_id: string;
+    guide_key: string;
+    guide_id: string;
+    guide_step_ref: string;
+};
+type QueryKey = string;
+type QueryStatus = {
+    status: "loading" | "ok" | "error";
+    error?: Error;
+};
+type StoreState = {
+    guides: KnockGuide[];
+    queries: Record<QueryKey, QueryStatus>;
+    location: string | undefined;
+};
+type QueryFilterParams = Pick<GetGuidesQueryParams, "type">;
+export type SelectFilterParams = {
+    key?: string;
+    type?: string;
+};
+export type TargetParams = {
+    data?: GenericData | undefined;
+    tenant?: string | undefined;
+};
+type ConstructorOpts = {
+    trackLocationFromWindow?: boolean;
+};
+export declare class KnockGuideClient {
+    readonly knock: Knock;
+    readonly channelId: string;
+    readonly targetParams: TargetParams;
+    readonly options: ConstructorOpts;
+    store: Store<StoreState, (state: StoreState) => StoreState>;
+    private socket;
+    private socketChannel;
+    private socketChannelTopic;
+    private socketEventTypes;
+    private pushStateFn;
+    private replaceStateFn;
+    constructor(knock: Knock, channelId: string, targetParams?: TargetParams, options?: ConstructorOpts);
+    cleanup(): void;
+    fetch(opts?: {
+        filters?: QueryFilterParams;
+    }): Promise<QueryStatus>;
+    subscribe(): void;
+    unsubscribe(): void;
+    private handleSocketEvent;
+    select(state: StoreState, filters?: SelectFilterParams): KnockGuide[];
+    markAsSeen(guide: GuideData, step: GuideStepData): Promise<KnockGuideStep | undefined>;
+    markAsInteracted(guide: GuideData, step: GuideStepData, metadata?: GenericData): Promise<KnockGuideStep | undefined>;
+    markAsArchived(guide: GuideData, step: GuideStepData): Promise<KnockGuideStep | undefined>;
+    private localCopy;
+    private buildQueryParams;
+    private formatQueryKey;
+    private setStepMessageAttrs;
+    private buildEngagementEventBaseParams;
+    private addGuide;
+    private replaceOrAddGuide;
+    private removeGuide;
+    private handleLocationChange;
+    private listenForLocationChangesFromWindow;
+    private removeEventListeners;
+}
+export {};
+//# sourceMappingURL=client.d.ts.map

package/dist/types/clients/guide/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../src/clients/guide/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAExC,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjD,OAAO,KAAK,MAAM,aAAa,CAAC;AAchC,eAAO,MAAM,iBAAiB,GAAI,QAAQ,MAAM,GAAG,SAAS,GAAG,IAAI,WACrC,CAAC;AAE/B,UAAU,gBAAgB;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,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;CAChC;AAED,UAAU,aAAa;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;IACtB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,OAAO,EAAE,gBAAgB,CAAC;IAE1B,OAAO,EAAE,GAAG,CAAC;CACd;AAED,UAAU,+BAA+B;IACvC,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC;IAC7B,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,UAAU,SAAS;IACjB,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,aAAa,EAAE,CAAC;IACvB,yBAAyB,EAAE,+BAA+B,EAAE,CAAC;IAC7D,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,cAAe,SAAQ,aAAa;IACnD,UAAU,EAAE,MAAM,IAAI,CAAC;IACvB,gBAAgB,EAAE,CAAC,MAAM,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,WAAW,CAAA;KAAE,KAAK,IAAI,CAAC;IAChE,cAAc,EAAE,MAAM,IAAI,CAAC;CAC5B;AAED,UAAU,gCACR,SAAQ,+BAA+B;IACvC,OAAO,EAAE,UAAU,CAAC;CACrB;AAED,MAAM,WAAW,UAAW,SAAQ,SAAS;IAC3C,KAAK,EAAE,cAAc,EAAE,CAAC;IACxB,yBAAyB,EAAE,gCAAgC,EAAE,CAAC;CAC/D;AAED,KAAK,oBAAoB,GAAG;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAMF,MAAM,MAAM,8BAA8B,GAAG;IAE3C,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AA6CF,KAAK,QAAQ,GAAG,MAAM,CAAC;AAEvB,KAAK,WAAW,GAAG;IACjB,MAAM,EAAE,SAAS,GAAG,IAAI,GAAG,OAAO,CAAC;IACnC,KAAK,CAAC,EAAE,KAAK,CAAC;CACf,CAAC;AAEF,KAAK,UAAU,GAAG;IAChB,MAAM,EAAE,UAAU,EAAE,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IACvC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;CAC9B,CAAC;AAEF,KAAK,iBAAiB,GAAG,IAAI,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;AAE5D,MAAM,MAAM,kBAAkB,GAAG;IAC/B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IAC/B,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B,CAAC;AAEF,KAAK,eAAe,GAAG;IACrB,uBAAuB,CAAC,EAAE,OAAO,CAAC;CACnC,CAAC;AAEF,qBAAa,gBAAgB;IAczB,QAAQ,CAAC,KAAK,EAAE,KAAK;IACrB,QAAQ,CAAC,SAAS,EAAE,MAAM;IAC1B,QAAQ,CAAC,YAAY,EAAE,YAAY;IACnC,QAAQ,CAAC,OAAO,EAAE,eAAe;IAhB5B,KAAK,EAAE,KAAK,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,UAAU,CAAC,CAAC;IAGnE,OAAO,CAAC,MAAM,CAAqB;IACnC,OAAO,CAAC,aAAa,CAAsB;IAC3C,OAAO,CAAC,kBAAkB,CAAS;IACnC,OAAO,CAAC,gBAAgB,CAAqD;IAG7E,OAAO,CAAC,WAAW,CAAmC;IACtD,OAAO,CAAC,cAAc,CAAsC;gBAGjD,KAAK,EAAE,KAAK,EACZ,SAAS,EAAE,MAAM,EACjB,YAAY,GAAE,YAAiB,EAC/B,OAAO,GAAE,eAAoB;IA0BxC,OAAO;IAKD,KAAK,CAAC,IAAI,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,iBAAiB,CAAA;KAAE;IA+ClD,SAAS;IA+BT,WAAW;IAcX,OAAO,CAAC,iBAAiB;IAwBzB,MAAM,CAAC,KAAK,EAAE,UAAU,EAAE,OAAO,GAAE,kBAAuB;IAyDpD,UAAU,CAAC,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,aAAa;IAyBhD,gBAAgB,CACpB,KAAK,EAAE,SAAS,EAChB,IAAI,EAAE,aAAa,EACnB,QAAQ,CAAC,EAAE,WAAW;IA0BlB,cAAc,CAAC,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,aAAa;IAwB1D,OAAO,CAAC,SAAS;IA+CjB,OAAO,CAAC,gBAAgB;IAmBxB,OAAO,CAAC,cAAc;IActB,OAAO,CAAC,mBAAmB;IA6B3B,OAAO,CAAC,8BAA8B;IAatC,OAAO,CAAC,QAAQ;IAQhB,OAAO,CAAC,iBAAiB;IAmBzB,OAAO,CAAC,WAAW;IAQnB,OAAO,CAAC,oBAAoB,CAO1B;IAEF,OAAO,CAAC,kCAAkC;IAwC1C,OAAO,CAAC,oBAAoB;CAa7B"}

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

@@ -0,0 +1,3 @@
+export { KnockGuideClient } from './client';
+export type { KnockGuide, KnockGuideStep, TargetParams as KnockGuideTargetParams, SelectFilterParams as KnockGuideFilterParams, } from './client';
+//# sourceMappingURL=index.d.ts.map