@knocklabs/client 0.21.0 → 0.21.2

package/dist/esm/knock.mjs

@@ -1,17 +1,17 @@
-var u = Object.defineProperty;
-var k = (s, i, e) => i in s ? u(s, i, { enumerable: !0, configurable: !0, writable: !0, value: e }) : s[i] = e;
-var t = (s, i, e) => k(s, typeof i != "symbol" ? i + "" : i, e);
-import { jwtDecode as d } from "jwt-decode";
-import g from "./api.mjs";
+var f = Object.defineProperty;
+var u = (s, i, e) => i in s ? f(s, i, { enumerable: !0, configurable: !0, writable: !0, value: e }) : s[i] = e;
+var t = (s, i, e) => u(s, typeof i != "symbol" ? i + "" : i, e);
+import { jwtDecode as g } from "jwt-decode";
+import k from "./api.mjs";
 import m from "./clients/feed/index.mjs";
 import T from "./clients/messages/index.mjs";
-import p from "./clients/ms-teams/index.mjs";
-import w from "./clients/objects/index.mjs";
-import C from "./clients/preferences/index.mjs";
-import y from "./clients/slack/index.mjs";
+import w from "./clients/ms-teams/index.mjs";
+import p from "./clients/objects/index.mjs";
+import y from "./clients/preferences/index.mjs";
+import C from "./clients/slack/index.mjs";
 import E from "./clients/users/index.mjs";
 const A = "https://api.knock.app";
-class F {
+class D {
   constructor(i, e = {}) {
     t(this, "host");
     t(this, "apiClient", null);
@@ -19,15 +19,16 @@ class F {
     t(this, "userToken");
     t(this, "logLevel");
     t(this, "branch");
+    t(this, "disconnectOnPageHidden");
     t(this, "tokenExpirationTimer", null);
     t(this, "feeds", new m(this));
-    t(this, "objects", new w(this));
-    t(this, "preferences", new C(this));
-    t(this, "slack", new y(this));
-    t(this, "msTeams", new p(this));
+    t(this, "objects", new p(this));
+    t(this, "preferences", new y(this));
+    t(this, "slack", new C(this));
+    t(this, "msTeams", new w(this));
     t(this, "user", new E(this));
     t(this, "messages", new T(this));
-    if (this.apiKey = i, this.host = e.host || A, this.logLevel = e.logLevel, this.branch = e.branch || void 0, this.log("Initialized Knock instance"), this.apiKey && this.apiKey.startsWith("sk_"))
+    if (this.apiKey = i, this.host = e.host || A, this.logLevel = e.logLevel, this.branch = e.branch || void 0, this.disconnectOnPageHidden = e.disconnectOnPageHidden, 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."
       );
@@ -36,12 +37,12 @@ class F {
     return this.apiClient || (this.apiClient = this.createApiClient()), this.apiClient;
   }
   authenticate(i, e, n) {
-    let o = !1;
-    const h = this.apiClient, a = this.getUserId(i), c = (n == null ? void 0 : n.identificationStrategy) || "inline";
-    if (h && (this.userId !== a || this.userToken !== e) && (this.log("userId or userToken changed; reinitializing connections"), this.feeds.teardownInstances(), this.teardown(), o = !0), this.userId = a, this.userToken = e, this.log(`Authenticated with userId ${a}`), this.userToken && (n == null ? void 0 : n.onUserTokenExpiring) instanceof Function && this.maybeScheduleUserTokenExpiration(
+    let a = !1;
+    const h = this.apiClient, o = this.getUserId(i), c = (n == null ? void 0 : n.identificationStrategy) || "inline";
+    if (h && (this.userId !== o || this.userToken !== e) && (this.log("userId or userToken changed; reinitializing connections"), this.feeds.teardownInstances(), this.teardown(), a = !0), this.userId = o, this.userToken = e, this.log(`Authenticated with userId ${o}`), this.userToken && (n == null ? void 0 : n.onUserTokenExpiring) instanceof Function && this.maybeScheduleUserTokenExpiration(
       n.onUserTokenExpiring,
       n.timeBeforeExpirationInMs
-    ), o && (this.apiClient = this.createApiClient(), this.feeds.reinitializeInstances(), this.log("Reinitialized real-time connections")), c === "skip") {
+    ), a && (this.apiClient = this.createApiClient(), this.feeds.reinitializeInstances(), this.log("Reinitialized real-time connections")), c === "skip") {
       this.log("Skipping inline user identification");
       return;
     }
@@ -49,10 +50,10 @@ class F {
       this.log(`Identifying user ${i.id} inline`);
       const { id: x, ...r } = i;
       this.user.identify(r).catch((l) => {
-        const f = l instanceof Error ? l.message : "Unknown error";
+        const d = l instanceof Error ? l.message : "Unknown error";
         this.log(
           `Error identifying user ${i.id} inline:
-${f}`
+${d}`
         );
       });
     }
@@ -71,7 +72,7 @@ ${f}`
   // Used to teardown any connected instances
   teardown() {
     var i;
-    this.tokenExpirationTimer && clearTimeout(this.tokenExpirationTimer), (i = this.apiClient) != null && i.socket && this.apiClient.socket.isConnected() && this.apiClient.socket.disconnect();
+    this.tokenExpirationTimer && clearTimeout(this.tokenExpirationTimer), (i = this.apiClient) == null || i.teardown();
   }
   log(i, e = !1) {
     (this.logLevel === "debug" || e) && console.log(`[Knock] ${i}`);
@@ -80,25 +81,26 @@ ${f}`
    * Initiates an API client
    */
   createApiClient() {
-    return new g({
+    return new k({
       apiKey: this.apiKey,
       host: this.host,
       userToken: this.userToken,
-      branch: this.branch
+      branch: this.branch,
+      disconnectOnPageHidden: this.disconnectOnPageHidden
     });
   }
   async maybeScheduleUserTokenExpiration(i, e = 3e4) {
     if (!this.userToken) return;
-    const n = d(this.userToken), o = (n.exp ?? 0) * 1e3, h = Date.now();
-    if (o && o > h) {
-      const a = o - e - h;
+    const n = g(this.userToken), a = (n.exp ?? 0) * 1e3, h = Date.now();
+    if (a && a > h) {
+      const o = a - e - h;
       this.tokenExpirationTimer = setTimeout(async () => {
         const c = await i(this.userToken, n);
         typeof c == "string" && this.authenticate(this.userId, c, {
           onUserTokenExpiring: i,
           timeBeforeExpirationInMs: e
         });
-      }, a);
+      }, o);
     }
   }
   /**
@@ -115,6 +117,6 @@ ${f}`
   }
 }
 export {
-  F as default
+  D as default
 };
 //# sourceMappingURL=knock.mjs.map

package/dist/esm/knock.mjs.map

@@ -1 +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  UserId,\n  UserIdOrUserWithProperties,\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  public readonly branch?: string;\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    this.branch = options.branch || undefined;\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   * @deprecated Passing `userId` as a `string` is deprecated and will be removed in a future version.\n   * Please pass a `user` object instead containing an `id` value.\n   * example:\n   * ```ts\n   * knock.authenticate({ id: \"user_123\" });\n   * ```\n   */\n  authenticate(\n    userIdOrUserWithProperties: UserId,\n    userToken?: Knock[\"userToken\"],\n    options?: AuthenticateOptions,\n  ): never;\n  authenticate(\n    userIdOrUserWithProperties: UserIdOrUserWithProperties,\n    userToken?: Knock[\"userToken\"],\n    options?: AuthenticateOptions,\n  ): void;\n  authenticate(\n    userIdOrUserWithProperties: UserIdOrUserWithProperties,\n    userToken?: Knock[\"userToken\"],\n    options?: AuthenticateOptions,\n  ) {\n    let reinitializeApi = false;\n    const currentApiClient = this.apiClient;\n    const userId = this.getUserId(userIdOrUserWithProperties);\n    const identificationStrategy = options?.identificationStrategy || \"inline\";\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    // We explicitly skip the inline identification if the strategy is set to \"skip\"\n    if (identificationStrategy === \"skip\") {\n      this.log(\"Skipping inline user identification\");\n      return;\n    }\n\n    // Inline identify the user if we've been given an object with an id\n    // and the strategy is set to \"inline\".\n    if (\n      identificationStrategy === \"inline\" &&\n      typeof userIdOrUserWithProperties === \"object\" &&\n      userIdOrUserWithProperties?.id\n    ) {\n      this.log(`Identifying user ${userIdOrUserWithProperties.id} inline`);\n      const { id, ...properties } = userIdOrUserWithProperties;\n      this.user.identify(properties).catch((err) => {\n        const errorMessage =\n          err instanceof Error ? err.message : \"Unknown error\";\n\n        this.log(\n          `Error identifying user ${userIdOrUserWithProperties.id} inline:\\n${errorMessage}`,\n        );\n      });\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      branch: this.branch,\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  /**\n   * Returns the user id from the given userIdOrUserWithProperties\n   * @param userIdOrUserWithProperties - The user id or user object\n   * @returns The user id\n   * @throws {Error} If the user object does not contain an `id` property\n   */\n  private getUserId(userIdOrUserWithProperties: UserIdOrUserWithProperties) {\n    if (\n      typeof userIdOrUserWithProperties === \"string\" ||\n      !userIdOrUserWithProperties\n    ) {\n      return userIdOrUserWithProperties;\n    }\n\n    if (userIdOrUserWithProperties?.id) {\n      return userIdOrUserWithProperties.id;\n    }\n\n    return undefined;\n  }\n}\n\nexport default Knock;\n"],"names":["DEFAULT_HOST","Knock","apiKey","options","__publicField","FeedClient","ObjectClient","Preferences","SlackClient","MsTeamsClient","UserClient","MessageClient","userIdOrUserWithProperties","userToken","reinitializeApi","currentApiClient","userId","identificationStrategy","id","properties","err","errorMessage","checkUserToken","_a","message","force","ApiClient","callbackFn","timeBeforeExpirationInMs","decoded","jwtDecode","expiresAtMs","nowMs","msInFuture","newToken"],"mappings":";;;;;;;;;;;;AAmBA,MAAMA,IAAe;AAErB,MAAMC,EAAM;AAAA,EAgBV,YACWC,GACTC,IAAwB,IACxB;AAlBK,IAAAC,EAAA;AACC,IAAAA,EAAA,mBAA8B;AAC/B,IAAAA,EAAA;AACA,IAAAA,EAAA;AACA,IAAAA,EAAA;AACS,IAAAA,EAAA;AACR,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;AAaxC,QAVS,KAAA,SAAAT,GAGJ,KAAA,OAAOC,EAAQ,QAAQH,GAC5B,KAAK,WAAWG,EAAQ,UACnB,KAAA,SAASA,EAAQ,UAAU,QAEhC,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,EAqBd,aACES,GACAC,GACAV,GACA;AACA,QAAIW,IAAkB;AACtB,UAAMC,IAAmB,KAAK,WACxBC,IAAS,KAAK,UAAUJ,CAA0B,GAClDK,KAAyBd,KAAA,gBAAAA,EAAS,2BAA0B;AAoClE,QA/BEY,MACC,KAAK,WAAWC,KAAU,KAAK,cAAcH,OAE9C,KAAK,IAAI,yDAAyD,GAClE,KAAK,MAAM,kBAAkB,GAC7B,KAAK,SAAS,GACIC,IAAA,KAGpB,KAAK,SAASE,GACd,KAAK,YAAYH,GAEZ,KAAA,IAAI,6BAA6BG,CAAM,EAAE,GAE1C,KAAK,cAAab,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,IAI5CG,MAA2B,QAAQ;AACrC,WAAK,IAAI,qCAAqC;AAC9C;AAAA,IAAA;AAKF,QACEA,MAA2B,YAC3B,OAAOL,KAA+B,aACtCA,KAAA,QAAAA,EAA4B,KAC5B;AACA,WAAK,IAAI,oBAAoBA,EAA2B,EAAE,SAAS;AACnE,YAAM,EAAE,IAAAM,GAAI,GAAGC,EAAA,IAAeP;AAC9B,WAAK,KAAK,SAASO,CAAU,EAAE,MAAM,CAACC,MAAQ;AAC5C,cAAMC,IACJD,aAAe,QAAQA,EAAI,UAAU;AAElC,aAAA;AAAA,UACH,0BAA0BR,EAA2B,EAAE;AAAA,EAAaS,CAAY;AAAA,QAClF;AAAA,MAAA,CACD;AAAA,IAAA;AAAA,EAGH;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,MAChB,QAAQ,KAAK;AAAA,IAAA,CACd;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;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASM,UAAUrB,GAAwD;AACxE,QACE,OAAOA,KAA+B,YACtC,CAACA;AAEM,aAAAA;AAGT,QAAIA,KAAA,QAAAA,EAA4B;AAC9B,aAAOA,EAA2B;AAAA,EAG7B;AAEX;"}
+{"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  UserId,\n  UserIdOrUserWithProperties,\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  public readonly branch?: string;\n  private readonly disconnectOnPageHidden?: boolean;\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    this.branch = options.branch || undefined;\n    this.disconnectOnPageHidden = options.disconnectOnPageHidden;\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   * @deprecated Passing `userId` as a `string` is deprecated and will be removed in a future version.\n   * Please pass a `user` object instead containing an `id` value.\n   * example:\n   * ```ts\n   * knock.authenticate({ id: \"user_123\" });\n   * ```\n   */\n  authenticate(\n    userIdOrUserWithProperties: UserId,\n    userToken?: Knock[\"userToken\"],\n    options?: AuthenticateOptions,\n  ): never;\n  authenticate(\n    userIdOrUserWithProperties: UserIdOrUserWithProperties,\n    userToken?: Knock[\"userToken\"],\n    options?: AuthenticateOptions,\n  ): void;\n  authenticate(\n    userIdOrUserWithProperties: UserIdOrUserWithProperties,\n    userToken?: Knock[\"userToken\"],\n    options?: AuthenticateOptions,\n  ) {\n    let reinitializeApi = false;\n    const currentApiClient = this.apiClient;\n    const userId = this.getUserId(userIdOrUserWithProperties);\n    const identificationStrategy = options?.identificationStrategy || \"inline\";\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    // We explicitly skip the inline identification if the strategy is set to \"skip\"\n    if (identificationStrategy === \"skip\") {\n      this.log(\"Skipping inline user identification\");\n      return;\n    }\n\n    // Inline identify the user if we've been given an object with an id\n    // and the strategy is set to \"inline\".\n    if (\n      identificationStrategy === \"inline\" &&\n      typeof userIdOrUserWithProperties === \"object\" &&\n      userIdOrUserWithProperties?.id\n    ) {\n      this.log(`Identifying user ${userIdOrUserWithProperties.id} inline`);\n      const { id, ...properties } = userIdOrUserWithProperties;\n      this.user.identify(properties).catch((err) => {\n        const errorMessage =\n          err instanceof Error ? err.message : \"Unknown error\";\n\n        this.log(\n          `Error identifying user ${userIdOrUserWithProperties.id} inline:\\n${errorMessage}`,\n        );\n      });\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    this.apiClient?.teardown();\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      branch: this.branch,\n      disconnectOnPageHidden: this.disconnectOnPageHidden,\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  /**\n   * Returns the user id from the given userIdOrUserWithProperties\n   * @param userIdOrUserWithProperties - The user id or user object\n   * @returns The user id\n   * @throws {Error} If the user object does not contain an `id` property\n   */\n  private getUserId(userIdOrUserWithProperties: UserIdOrUserWithProperties) {\n    if (\n      typeof userIdOrUserWithProperties === \"string\" ||\n      !userIdOrUserWithProperties\n    ) {\n      return userIdOrUserWithProperties;\n    }\n\n    if (userIdOrUserWithProperties?.id) {\n      return userIdOrUserWithProperties.id;\n    }\n\n    return undefined;\n  }\n}\n\nexport default Knock;\n"],"names":["DEFAULT_HOST","Knock","apiKey","options","__publicField","FeedClient","ObjectClient","Preferences","SlackClient","MsTeamsClient","UserClient","MessageClient","userIdOrUserWithProperties","userToken","reinitializeApi","currentApiClient","userId","identificationStrategy","id","properties","err","errorMessage","checkUserToken","_a","message","force","ApiClient","callbackFn","timeBeforeExpirationInMs","decoded","jwtDecode","expiresAtMs","nowMs","msInFuture","newToken"],"mappings":";;;;;;;;;;;;AAmBA,MAAMA,IAAe;AAErB,MAAMC,EAAM;AAAA,EAiBV,YACWC,GACTC,IAAwB,IACxB;AAnBK,IAAAC,EAAA;AACC,IAAAA,EAAA,mBAA8B;AAC/B,IAAAA,EAAA;AACA,IAAAA,EAAA;AACA,IAAAA,EAAA;AACS,IAAAA,EAAA;AACC,IAAAA,EAAA;AACT,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;AAcxC,QAXS,KAAA,SAAAT,GAGJ,KAAA,OAAOC,EAAQ,QAAQH,GAC5B,KAAK,WAAWG,EAAQ,UACnB,KAAA,SAASA,EAAQ,UAAU,QAChC,KAAK,yBAAyBA,EAAQ,wBAEtC,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,EAqBd,aACES,GACAC,GACAV,GACA;AACA,QAAIW,IAAkB;AACtB,UAAMC,IAAmB,KAAK,WACxBC,IAAS,KAAK,UAAUJ,CAA0B,GAClDK,KAAyBd,KAAA,gBAAAA,EAAS,2BAA0B;AAoClE,QA/BEY,MACC,KAAK,WAAWC,KAAU,KAAK,cAAcH,OAE9C,KAAK,IAAI,yDAAyD,GAClE,KAAK,MAAM,kBAAkB,GAC7B,KAAK,SAAS,GACIC,IAAA,KAGpB,KAAK,SAASE,GACd,KAAK,YAAYH,GAEZ,KAAA,IAAI,6BAA6BG,CAAM,EAAE,GAE1C,KAAK,cAAab,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,IAI5CG,MAA2B,QAAQ;AACrC,WAAK,IAAI,qCAAqC;AAC9C;AAAA,IAAA;AAKF,QACEA,MAA2B,YAC3B,OAAOL,KAA+B,aACtCA,KAAA,QAAAA,EAA4B,KAC5B;AACA,WAAK,IAAI,oBAAoBA,EAA2B,EAAE,SAAS;AACnE,YAAM,EAAE,IAAAM,GAAI,GAAGC,EAAA,IAAeP;AAC9B,WAAK,KAAK,SAASO,CAAU,EAAE,MAAM,CAACC,MAAQ;AAC5C,cAAMC,IACJD,aAAe,QAAQA,EAAI,UAAU;AAElC,aAAA;AAAA,UACH,0BAA0BR,EAA2B,EAAE;AAAA,EAAaS,CAAY;AAAA,QAClF;AAAA,MAAA,CACD;AAAA,IAAA;AAAA,EAGH;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,IAExCC,IAAA,KAAK,cAAL,QAAAA,EAAgB;AAAA,EAAS;AAAA,EAG3B,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,MAChB,QAAQ,KAAK;AAAA,MACb,wBAAwB,KAAK;AAAA,IAAA,CAC9B;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;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASM,UAAUrB,GAAwD;AACxE,QACE,OAAOA,KAA+B,YACtC,CAACA;AAEM,aAAAA;AAGT,QAAIA,KAAA,QAAAA,EAA4B;AAC9B,aAAOA,EAA2B;AAAA,EAG7B;AAEX;"}

package/dist/esm/pageVisibility.mjs

@@ -0,0 +1,31 @@
+var s = Object.defineProperty;
+var c = (i, e, t) => e in i ? s(i, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : i[e] = t;
+var n = (i, e, t) => c(i, typeof e != "symbol" ? e + "" : e, t);
+class d {
+  constructor(e, t = 3e4) {
+    n(this, "disconnectTimer", null);
+    n(this, "wasConnected", !1);
+    n(this, "onVisibilityChange", () => {
+      document.hidden ? this.scheduleDisconnect() : this.reconnect();
+    });
+    this.socket = e, this.disconnectDelayMs = t, typeof document < "u" && document.addEventListener("visibilitychange", this.onVisibilityChange);
+  }
+  scheduleDisconnect() {
+    this.clearTimer(), this.disconnectTimer = setTimeout(() => {
+      this.disconnectTimer = null, this.socket.isConnected() && (this.wasConnected = !0, this.socket.disconnect());
+    }, this.disconnectDelayMs);
+  }
+  reconnect() {
+    this.clearTimer(), this.wasConnected && (this.wasConnected = !1, this.socket.connect());
+  }
+  clearTimer() {
+    this.disconnectTimer && (clearTimeout(this.disconnectTimer), this.disconnectTimer = null);
+  }
+  teardown() {
+    this.clearTimer(), typeof document < "u" && document.removeEventListener("visibilitychange", this.onVisibilityChange);
+  }
+}
+export {
+  d as PageVisibilityManager
+};
+//# sourceMappingURL=pageVisibility.mjs.map

package/dist/esm/pageVisibility.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"pageVisibility.mjs","sources":["../../src/pageVisibility.ts"],"sourcesContent":["import type { Socket } from \"phoenix\";\n\nconst DEFAULT_DISCONNECT_DELAY_MS = 30_000;\n\n/**\n * Disconnects the socket after a delay when the page becomes hidden,\n * and reconnects when it becomes visible again. This avoids holding\n * open connections for background tabs that aren't being viewed.\n *\n * The delay prevents unnecessary disconnects during brief tab switches.\n * Phoenix channels automatically rejoin after reconnecting.\n */\nexport class PageVisibilityManager {\n  private disconnectTimer: ReturnType<typeof setTimeout> | null = null;\n  private wasConnected = false;\n\n  constructor(\n    private socket: Socket,\n    private disconnectDelayMs: number = DEFAULT_DISCONNECT_DELAY_MS,\n  ) {\n    if (typeof document !== \"undefined\") {\n      document.addEventListener(\"visibilitychange\", this.onVisibilityChange);\n    }\n  }\n\n  private onVisibilityChange = () => {\n    if (document.hidden) {\n      this.scheduleDisconnect();\n    } else {\n      this.reconnect();\n    }\n  };\n\n  private scheduleDisconnect() {\n    this.clearTimer();\n\n    this.disconnectTimer = setTimeout(() => {\n      this.disconnectTimer = null;\n\n      if (this.socket.isConnected()) {\n        this.wasConnected = true;\n        this.socket.disconnect();\n      }\n    }, this.disconnectDelayMs);\n  }\n\n  private reconnect() {\n    this.clearTimer();\n\n    if (this.wasConnected) {\n      this.wasConnected = false;\n      this.socket.connect();\n    }\n  }\n\n  private clearTimer() {\n    if (this.disconnectTimer) {\n      clearTimeout(this.disconnectTimer);\n      this.disconnectTimer = null;\n    }\n  }\n\n  teardown() {\n    this.clearTimer();\n\n    if (typeof document !== \"undefined\") {\n      document.removeEventListener(\"visibilitychange\", this.onVisibilityChange);\n    }\n  }\n}\n"],"names":["PageVisibilityManager","socket","disconnectDelayMs","__publicField"],"mappings":";;;AAYO,MAAMA,EAAsB;AAAA,EAIjC,YACUC,GACAC,IAA4B,KACpC;AANM,IAAAC,EAAA,yBAAwD;AACxD,IAAAA,EAAA,sBAAe;AAWf,IAAAA,EAAA,4BAAqB,MAAM;AACjC,MAAI,SAAS,SACX,KAAK,mBAAmB,IAExB,KAAK,UAAU;AAAA,IAEnB;AAdU,SAAA,SAAAF,GACA,KAAA,oBAAAC,GAEJ,OAAO,WAAa,OACb,SAAA,iBAAiB,oBAAoB,KAAK,kBAAkB;AAAA,EACvE;AAAA,EAWM,qBAAqB;AAC3B,SAAK,WAAW,GAEX,KAAA,kBAAkB,WAAW,MAAM;AACtC,WAAK,kBAAkB,MAEnB,KAAK,OAAO,kBACd,KAAK,eAAe,IACpB,KAAK,OAAO,WAAW;AAAA,IACzB,GACC,KAAK,iBAAiB;AAAA,EAAA;AAAA,EAGnB,YAAY;AAClB,SAAK,WAAW,GAEZ,KAAK,iBACP,KAAK,eAAe,IACpB,KAAK,OAAO,QAAQ;AAAA,EACtB;AAAA,EAGM,aAAa;AACnB,IAAI,KAAK,oBACP,aAAa,KAAK,eAAe,GACjC,KAAK,kBAAkB;AAAA,EACzB;AAAA,EAGF,WAAW;AACT,SAAK,WAAW,GAEZ,OAAO,WAAa,OACb,SAAA,oBAAoB,oBAAoB,KAAK,kBAAkB;AAAA,EAC1E;AAEJ;"}

package/dist/types/api.d.ts

@@ -5,6 +5,8 @@ type ApiClientOptions = {
     apiKey: string;
     userToken: string | undefined;
     branch?: string;
+    /** Automatically disconnect the socket when the page is hidden and reconnect when visible. Defaults to `true`. */
+    disconnectOnPageHidden?: boolean;
 };
 export interface ApiResponse {
     error?: any;
@@ -19,8 +21,10 @@ declare class ApiClient {
     private branch;
     private axiosClient;
     socket: Socket | undefined;
+    private pageVisibility;
     constructor(options: ApiClientOptions);
     makeRequest(req: AxiosRequestConfig): Promise<ApiResponse>;
+    teardown(): void;
     private canRetryRequest;
     private getKnockClientHeader;
 }

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

@@ -1 +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;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,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,MAAM,CAAgB;IAC9B,OAAO,CAAC,WAAW,CAAgB;IAE5B,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;gBAEtB,OAAO,EAAE,gBAAgB;IAoC/B,WAAW,CAAC,GAAG,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC;IAwBhE,OAAO,CAAC,eAAe;IAwBvB,OAAO,CAAC,oBAAoB;CAQ7B;AAED,eAAe,SAAS,CAAC"}
+{"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;AAKjC,KAAK,gBAAgB,GAAG;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kHAAkH;IAClH,sBAAsB,CAAC,EAAE,OAAO,CAAC;CAClC,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,MAAM,CAAgB;IAC9B,OAAO,CAAC,WAAW,CAAgB;IAE5B,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,OAAO,CAAC,cAAc,CAAoC;gBAE9C,OAAO,EAAE,gBAAgB;IAoD/B,WAAW,CAAC,GAAG,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC;IAwBhE,QAAQ;IAQR,OAAO,CAAC,eAAe;IAwBvB,OAAO,CAAC,oBAAoB;CAQ7B;AAED,eAAe,SAAS,CAAC"}

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

@@ -14,10 +14,7 @@ declare class Feed {
     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);
     /**
@@ -47,7 +44,7 @@ declare class Feed {
     markAllReadAsArchived(): Promise<import('../..').BulkOperation>;
     markAsUnarchived(itemOrItems: FeedItemOrItems): Promise<import('../messages/interfaces').Message<GenericData>[]>;
     fetch(options?: FetchFeedOptions): Promise<{
-        status: "ok" | "error";
+        status: "error" | "ok";
         data: any;
     } | undefined>;
     fetchNextPage(options?: FetchFeedOptions): Promise<void>;
@@ -62,14 +59,7 @@ declare class Feed {
     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

@@ -1 +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;AAajB,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;IA8C7C,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"}
+{"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;AAWjB,cAAM,IAAI;IAcN,QAAQ,CAAC,KAAK,EAAE,KAAK;IACrB,QAAQ,CAAC,MAAM,EAAE,MAAM;IAdzB,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,8BAA8B,CAAkB;IAGjD,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;IAUR,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;IA8C7C,KAAK,CAAC,OAAO,GAAE,gBAAqB;;;;IAwFpC,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;IAW9B,iBAAiB,CAAC,OAAO,EAAE,kBAAkB;IAYnD,OAAO,CAAC,SAAS;CAiBlB;AAED,eAAe,IAAI,CAAC"}

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

@@ -22,8 +22,6 @@ export interface FeedClientOptions {
     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;
@@ -44,13 +42,25 @@ export type FetchFeedOptions = {
     __loadingType?: NetworkStatus.loading | NetworkStatus.fetchMore;
     __fetchSource?: "socket" | "http";
 } & Omit<FeedClientOptions, "__experimentalCrossBrowserUpdates">;
-export type FetchFeedOptionsForRequest = Omit<FeedClientOptions, "trigger_data"> & {
+/**
+ * The final data shape that is sent to the the list feed items endpoint of the Knock API.
+ *
+ * @see https://docs.knock.app/api-reference/users/feeds/list_items
+ */
+export type FetchFeedOptionsForRequest = Omit<FeedClientOptions, "trigger_data" | "inserted_at_date_range"> & {
+    /** The trigger data of the feed items (as a JSON string). */
     trigger_data?: string;
+    /** Limits the results to items inserted after or on the given date. */
+    "inserted_at.gte"?: string;
+    /** Limits the results to items inserted before or on the given date. */
+    "inserted_at.lte"?: string;
+    /** Limits the results to items inserted after the given date. */
+    "inserted_at.gt"?: string;
+    /** Limits the results to items inserted before the given date. */
+    "inserted_at.lt"?: string;
     __loadingType: undefined;
     __fetchSource: undefined;
     __experimentalCrossBrowserUpdates: undefined;
-    auto_manage_socket_connection: undefined;
-    auto_manage_socket_connection_delay: undefined;
 };
 export interface ContentBlockBase {
     name: string;

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

@@ -1 +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;IACF;;;;;;;;OAQG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC3B;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;;;OAGG;IACH,UAAU,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;IAC3B,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;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,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"}
+{"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,sBAAsB,CAAC,EAAE;QAEvB,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb,SAAS,CAAC,EAAE,OAAO,CAAC;KACrB,CAAC;IACF;;;;;;;;OAQG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC3B;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;AAEjE;;;;GAIG;AACH,MAAM,MAAM,0BAA0B,GAAG,IAAI,CAC3C,iBAAiB,EACjB,cAAc,GAAG,wBAAwB,CAC1C,GAAG;IACF,6DAA6D;IAC7D,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,uEAAuE;IACvE,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,wEAAwE;IACxE,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,iEAAiE;IACjE,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,kEAAkE;IAClE,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,aAAa,EAAE,SAAS,CAAC;IACzB,aAAa,EAAE,SAAS,CAAC;IACzB,iCAAiC,EAAE,SAAS,CAAC;CAC9C,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;;;OAGG;IACH,UAAU,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;IAC3B,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;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,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/utils.d.ts

@@ -13,8 +13,6 @@ export declare function mergeDateRangeParams(options: FeedClientOptions): {
     archived?: "include" | "exclude" | "only";
     trigger_data?: import('./interfaces').TriggerData;
     __experimentalCrossBrowserUpdates?: boolean;
-    auto_manage_socket_connection?: boolean;
-    auto_manage_socket_connection_delay?: number;
     mode?: "rich" | "compact";
 };
 export declare function getFormattedTriggerData(options: FeedClientOptions): string | undefined;

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

@@ -1 +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"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../src/clients/feed/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,iBAAiB,EACjB,QAAQ,EAET,MAAM,cAAc,CAAC;AAEtB,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,QAAQ,EAAE,GAAG,QAAQ,EAAE,CAY9D;AAED,wBAAgB,SAAS,CAAC,KAAK,EAAE,QAAQ,EAAE,sDAM1C;AAOD,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,iBAAiB;;;;;;;;;;;;;EAyB9D;AAMD,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,iBAAiB,sBAYjE"}

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

@@ -1,12 +1,13 @@
 import { GenericData } from '@knocklabs/types';
 import { Store } from '@tanstack/store';
 import { default as Knock } from '../../knock';
-import { Any, ConstructorOpts, GuideData, GuideStepData, KnockGuide, KnockGuideStep, QueryFilterParams, QueryStatus, SelectFilterParams, SelectGuideOpts, SelectGuidesOpts, StoreState, TargetParams } from './types';
+import { Any, ConstructorOpts, DebugState, GroupStage, GuideData, GuideStepData, KnockGuide, KnockGuideStep, QueryFilterParams, QueryStatus, SelectFilterParams, SelectGuideOpts, SelectGuidesOpts, StoreState, TargetParams } from './types';
 export declare const DEBUG_QUERY_PARAMS: {
     GUIDE_KEY: string;
     PREVIEW_SESSION_ID: string;
 };
 export declare const guidesApiRootPath: (userId: string | undefined | null) => string;
+export declare const checkActivatable: (guide: KnockGuide, location: string | undefined) => boolean;
 export declare class KnockGuideClient {
     readonly knock: Knock;
     readonly channelId: string;
@@ -36,8 +37,12 @@ export declare class KnockGuideClient {
     private handleSocketEvent;
     setLocation(href: string, additionalParams?: Partial<StoreState>): void;
     exitDebugMode(): void;
+    setDebug(debugOpts?: Omit<DebugState, "debugging">): void;
+    unsetDebug(): void;
     selectGuides<C = Any>(state: StoreState, filters?: SelectFilterParams, opts?: SelectGuidesOpts): KnockGuide<C>[];
     selectGuide<C = Any>(state: StoreState, filters?: SelectFilterParams, opts?: SelectGuideOpts): KnockGuide<C> | undefined;
+    private maybeRecordSelectResult;
+    getStage(): GroupStage | undefined;
     private openGroupStage;
     private closePendingGroupStage;
     private patchClosedGroupStage;

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

@@ -1 +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;AAIxC,OAAO,KAAK,MAAM,aAAa,CAAC;AAgBhC,OAAO,EACL,GAAG,EACH,eAAe,EAMf,SAAS,EAMT,aAAa,EAEb,UAAU,EACV,cAAc,EAKd,iBAAiB,EACjB,WAAW,EACX,kBAAkB,EAClB,eAAe,EACf,gBAAgB,EAEhB,UAAU,EACV,YAAY,EACb,MAAM,SAAS,CAAC;AAcjB,eAAO,MAAM,kBAAkB;;;CAG9B,CAAC;AAWF,eAAO,MAAM,iBAAiB,GAAI,QAAQ,MAAM,GAAG,SAAS,GAAG,IAAI,WACrC,CAAC;AAyK/B,qBAAa,gBAAgB;IA6BzB,QAAQ,CAAC,KAAK,EAAE,KAAK;IACrB,QAAQ,CAAC,SAAS,EAAE,MAAM;IAC1B,QAAQ,CAAC,YAAY,EAAE,YAAY;IACnC,QAAQ,CAAC,OAAO,EAAE,eAAe;IA/B5B,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,CAOtB;IACF,OAAO,CAAC,mBAAmB,CAAK;IAGhC,OAAO,CAAC,WAAW,CAAmC;IACtD,OAAO,CAAC,cAAc,CAAsC;IAK5D,OAAO,CAAC,KAAK,CAAyB;IAEtC,OAAO,CAAC,iBAAiB,CAA6C;gBAG3D,KAAK,EAAE,KAAK,EACZ,SAAS,EAAE,MAAM,EACjB,YAAY,GAAE,YAAiB,EAC/B,OAAO,GAAE,eAAoB;IAyCxC,OAAO,CAAC,gBAAgB;IAKxB,OAAO,CAAC,oBAAoB;IAS5B,OAAO,CAAC,oBAAoB;IAO5B,OAAO;IAOD,KAAK,CAAC,IAAI,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,iBAAiB,CAAA;KAAE;IAkDlD,SAAS;IAuDT,OAAO,CAAC,sBAAsB;IAc9B,WAAW;IAcX,OAAO,CAAC,iBAAiB;IA2BzB,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,gBAAgB,GAAE,OAAO,CAAC,UAAU,CAAM;IAsBpE,aAAa;IAuCb,YAAY,CAAC,CAAC,GAAG,GAAG,EAClB,KAAK,EAAE,UAAU,EACjB,OAAO,GAAE,kBAAuB,EAChC,IAAI,GAAE,gBAAqB,GAC1B,UAAU,CAAC,CAAC,CAAC,EAAE;IA6BlB,WAAW,CAAC,CAAC,GAAG,GAAG,EACjB,KAAK,EAAE,UAAU,EACjB,OAAO,GAAE,kBAAuB,EAChC,IAAI,GAAE,eAAoB,GACzB,UAAU,CAAC,CAAC,CAAC,GAAG,SAAS;IAmG5B,OAAO,CAAC,cAAc;IAuBtB,OAAO,CAAC,sBAAsB;IAuC9B,OAAO,CAAC,qBAAqB;IA0B7B,OAAO,CAAC,eAAe;IASvB,OAAO,CAAC,kBAAkB;IAQ1B,OAAO,CAAC,YAAY;IAapB,OAAO,CAAC,aAAa;IAoBf,UAAU,CAAC,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,aAAa;IA0BhD,gBAAgB,CACpB,KAAK,EAAE,SAAS,EAChB,IAAI,EAAE,aAAa,EACnB,QAAQ,CAAC,EAAE,WAAW;IA0BlB,cAAc,CAAC,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,aAAa;IA6B1D,OAAO,CAAC,SAAS;IA0DjB,OAAO,CAAC,gBAAgB;IA4BxB,OAAO,CAAC,cAAc;IActB,OAAO,CAAC,mBAAmB;IAgD3B,OAAO,CAAC,8BAA8B;IActC,OAAO,CAAC,iBAAiB;IAYzB,OAAO,CAAC,WAAW;IASnB,OAAO,CAAC,sBAAsB;IAiC9B,OAAO,CAAC,kBAAkB;IAU1B,OAAO,CAAC,oBAAoB,CA6B1B;IAIF,OAAO,CAAC,sBAAsB;IAO9B,OAAO,CAAC,kCAAkC;IAyC1C,kCAAkC;CAgBnC"}
+{"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;AAIxC,OAAO,KAAK,MAAM,aAAa,CAAC;AAehC,OAAO,EACL,GAAG,EACH,eAAe,EACf,UAAU,EAGV,UAAU,EAEV,SAAS,EAMT,aAAa,EAEb,UAAU,EACV,cAAc,EAKd,iBAAiB,EACjB,WAAW,EACX,kBAAkB,EAClB,eAAe,EACf,gBAAgB,EAIhB,UAAU,EACV,YAAY,EACb,MAAM,SAAS,CAAC;AAcjB,eAAO,MAAM,kBAAkB;;;CAG9B,CAAC;AAWF,eAAO,MAAM,iBAAiB,GAAI,QAAQ,MAAM,GAAG,SAAS,GAAG,IAAI,WACrC,CAAC;AAwJ/B,eAAO,MAAM,gBAAgB,GAC3B,OAAO,UAAU,EACjB,UAAU,MAAM,GAAG,SAAS,YAiB7B,CAAC;AAEF,qBAAa,gBAAgB;IA6BzB,QAAQ,CAAC,KAAK,EAAE,KAAK;IACrB,QAAQ,CAAC,SAAS,EAAE,MAAM;IAC1B,QAAQ,CAAC,YAAY,EAAE,YAAY;IACnC,QAAQ,CAAC,OAAO,EAAE,eAAe;IA/B5B,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,CAOtB;IACF,OAAO,CAAC,mBAAmB,CAAK;IAGhC,OAAO,CAAC,WAAW,CAAmC;IACtD,OAAO,CAAC,cAAc,CAAsC;IAK5D,OAAO,CAAC,KAAK,CAAyB;IAEtC,OAAO,CAAC,iBAAiB,CAA6C;gBAG3D,KAAK,EAAE,KAAK,EACZ,SAAS,EAAE,MAAM,EACjB,YAAY,GAAE,YAAiB,EAC/B,OAAO,GAAE,eAAoB;IA4CxC,OAAO,CAAC,gBAAgB;IAKxB,OAAO,CAAC,oBAAoB;IAS5B,OAAO,CAAC,oBAAoB;IAO5B,OAAO;IAOD,KAAK,CAAC,IAAI,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,iBAAiB,CAAA;KAAE;IAwDlD,SAAS;IAwDT,OAAO,CAAC,sBAAsB;IAc9B,WAAW;IAcX,OAAO,CAAC,iBAAiB;IA6BzB,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,gBAAgB,GAAE,OAAO,CAAC,UAAU,CAAM;IAsBpE,aAAa;IAmCb,QAAQ,CAAC,SAAS,CAAC,EAAE,IAAI,CAAC,UAAU,EAAE,WAAW,CAAC;IAkBlD,UAAU;IAmBV,YAAY,CAAC,CAAC,GAAG,GAAG,EAClB,KAAK,EAAE,UAAU,EACjB,OAAO,GAAE,kBAAuB,EAChC,IAAI,GAAE,gBAAqB,GAC1B,UAAU,CAAC,CAAC,CAAC,EAAE;IAkDlB,WAAW,CAAC,CAAC,GAAG,GAAG,EACjB,KAAK,EAAE,UAAU,EACjB,OAAO,GAAE,kBAAuB,EAChC,IAAI,GAAE,eAAoB,GACzB,UAAU,CAAC,CAAC,CAAC,GAAG,SAAS;IAqH5B,OAAO,CAAC,uBAAuB;IA8B/B,QAAQ;IAIR,OAAO,CAAC,cAAc;IAwBtB,OAAO,CAAC,sBAAsB;IA8B9B,OAAO,CAAC,qBAAqB;IA0B7B,OAAO,CAAC,eAAe;IASvB,OAAO,CAAC,kBAAkB;IAQ1B,OAAO,CAAC,YAAY;IAapB,OAAO,CAAC,aAAa;IAoBf,UAAU,CAAC,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,aAAa;IA0BhD,gBAAgB,CACpB,KAAK,EAAE,SAAS,EAChB,IAAI,EAAE,aAAa,EACnB,QAAQ,CAAC,EAAE,WAAW;IA0BlB,cAAc,CAAC,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,aAAa;IA6B1D,OAAO,CAAC,SAAS;IA0DjB,OAAO,CAAC,gBAAgB;IA4BxB,OAAO,CAAC,cAAc;IActB,OAAO,CAAC,mBAAmB;IAgD3B,OAAO,CAAC,8BAA8B;IActC,OAAO,CAAC,iBAAiB;IAYzB,OAAO,CAAC,WAAW;IASnB,OAAO,CAAC,sBAAsB;IAiC9B,OAAO,CAAC,kBAAkB;IAU1B,OAAO,CAAC,oBAAoB,CAoC1B;IAIF,OAAO,CAAC,sBAAsB;IAO9B,OAAO,CAAC,kCAAkC;IAyC1C,kCAAkC;CAgBnC"}

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

@@ -1,10 +1,4 @@
-import { GroupStage, GuideActivationUrlRuleData, GuideData, GuideGroupData, KnockGuide, KnockGuideActivationUrlPattern, SelectFilterParams, StoreState } from './types';
-export declare class SelectionResult<K = number, V = KnockGuide> extends Map<K, V> {
-    metadata: {
-        guideGroup: GuideGroupData;
-    } | undefined;
-    constructor();
-}
+import { GroupStage, GuideActivationUrlRuleData, GuideData, GuideGroupData, KnockGuideActivationUrlPattern, SelectFilterParams, StoreState } from './types';
 export declare const formatGroupStage: (stage: GroupStage) => string;
 export declare const formatState: (state: StoreState) => string;
 export declare const formatFilters: (filters?: SelectFilterParams) => string;

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

@@ -1 +1 @@
-{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../../../src/clients/guide/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,0BAA0B,EAC1B,SAAS,EACT,cAAc,EACd,UAAU,EACV,8BAA8B,EAC9B,kBAAkB,EAClB,UAAU,EACX,MAAM,SAAS,CAAC;AAKjB,qBAAa,eAAe,CAAC,CAAC,GAAG,MAAM,EAAE,CAAC,GAAG,UAAU,CAAE,SAAQ,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC;IACxE,QAAQ,EAAE;QAAE,UAAU,EAAE,cAAc,CAAA;KAAE,GAAG,SAAS,CAAC;;CAKtD;AAED,eAAO,MAAM,gBAAgB,GAAI,OAAO,UAAU,WAEjD,CAAC;AAEF,eAAO,MAAM,WAAW,GAAI,OAAO,UAAU,WAE5C,CAAC;AAEF,eAAO,MAAM,aAAa,GAAI,UAAS,kBAAuB,WAO7D,CAAC;AAEF,eAAO,MAAM,KAAK,GAAI,CAAC,SAAS;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,EAAE,OAAO,CAAC,EAAE,OAE1D,CAAC;AAUF,eAAO,MAAM,iBAAiB,YAAY,CAAC;AAO3C,eAAO,MAAM,gBAAgB,GAAI,UAAS,SAAS,EAAO,KAUnD,cACN,CAAC;AAEF,eAAO,MAAM,gBAAgB,GAAI,aAAa,cAAc,EAAE,+BAI3D,CAAC;AAEJ,eAAO,MAAM,qBAAqB,GAAI,OAAO,UAAU,YAkBtD,CAAC;AAqCF,eAAO,MAAM,MAAM,GAAI,UAAU,MAAM,oBAMtC,CAAC;AAGF,eAAO,MAAM,eAAe,GAC1B,KAAK,GAAG,EACR,SAAS,0BAA0B,YAmBpC,CAAC;AAEF,eAAO,MAAM,iBAAiB,GAC5B,KAAK,GAAG,EACR,UAAU,0BAA0B,EAAE,wBA+BvC,CAAC;AAEF,eAAO,MAAM,oBAAoB,GAC/B,KAAK,GAAG,EACR,aAAa,8BAA8B,EAAE,wBAiC9C,CAAC"}
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../../../src/clients/guide/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,0BAA0B,EAC1B,SAAS,EACT,cAAc,EACd,8BAA8B,EAC9B,kBAAkB,EAClB,UAAU,EACX,MAAM,SAAS,CAAC;AAEjB,eAAO,MAAM,gBAAgB,GAAI,OAAO,UAAU,WAEjD,CAAC;AAEF,eAAO,MAAM,WAAW,GAAI,OAAO,UAAU,WAE5C,CAAC;AAEF,eAAO,MAAM,aAAa,GAAI,UAAS,kBAAuB,WAO7D,CAAC;AAEF,eAAO,MAAM,KAAK,GAAI,CAAC,SAAS;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,EAAE,OAAO,CAAC,EAAE,OAE1D,CAAC;AAUF,eAAO,MAAM,iBAAiB,YAAY,CAAC;AAO3C,eAAO,MAAM,gBAAgB,GAAI,UAAS,SAAS,EAAO,KAUnD,cACN,CAAC;AAEF,eAAO,MAAM,gBAAgB,GAAI,aAAa,cAAc,EAAE,+BAI3D,CAAC;AAEJ,eAAO,MAAM,qBAAqB,GAAI,OAAO,UAAU,YAkBtD,CAAC;AAqCF,eAAO,MAAM,MAAM,GAAI,UAAU,MAAM,oBAMtC,CAAC;AAGF,eAAO,MAAM,eAAe,GAC1B,KAAK,GAAG,EACR,SAAS,0BAA0B,YAmBpC,CAAC;AAEF,eAAO,MAAM,iBAAiB,GAC5B,KAAK,GAAG,EACR,UAAU,0BAA0B,EAAE,wBA+BvC,CAAC;AAEF,eAAO,MAAM,oBAAoB,GAC/B,KAAK,GAAG,EACR,aAAa,8BAA8B,EAAE,wBAiC9C,CAAC"}

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

@@ -1,3 +1,4 @@
-export { KnockGuideClient, DEBUG_QUERY_PARAMS } from './client';
-export type { KnockGuide, KnockGuideStep, TargetParams as KnockGuideTargetParams, SelectFilterParams as KnockGuideFilterParams, SelectGuideOpts as KnockSelectGuideOpts, SelectGuidesOpts as KnockSelectGuidesOpts, } from './types';
+export { KnockGuideClient, DEBUG_QUERY_PARAMS, checkActivatable, } from './client';
+export { checkStateIfThrottled } from './helpers';
+export type { KnockGuide, KnockGuideStep, GuideIneligibilityMarker as KnockGuideIneligibilityMarker, TargetParams as KnockGuideTargetParams, SelectFilterParams as KnockGuideFilterParams, SelectGuideOpts as KnockSelectGuideOpts, SelectGuidesOpts as KnockSelectGuidesOpts, StoreState as KnockGuideClientStoreState, GroupStage as KnockGuideClientGroupStage, SelectionResult as KnockGuideSelectionResult, } from './types';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/clients/guide/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAChE,YAAY,EACV,UAAU,EACV,cAAc,EACd,YAAY,IAAI,sBAAsB,EACtC,kBAAkB,IAAI,sBAAsB,EAC5C,eAAe,IAAI,oBAAoB,EACvC,gBAAgB,IAAI,qBAAqB,GAC1C,MAAM,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/clients/guide/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,gBAAgB,GACjB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAC;AAClD,YAAY,EACV,UAAU,EACV,cAAc,EACd,wBAAwB,IAAI,6BAA6B,EACzD,YAAY,IAAI,sBAAsB,EACtC,kBAAkB,IAAI,sBAAsB,EAC5C,eAAe,IAAI,oBAAoB,EACvC,gBAAgB,IAAI,qBAAqB,EACzC,UAAU,IAAI,0BAA0B,EACxC,UAAU,IAAI,0BAA0B,EACxC,eAAe,IAAI,yBAAyB,GAC7C,MAAM,SAAS,CAAC"}

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

@@ -1,4 +1,15 @@
 import { GenericData } from '@knocklabs/types';
+export type SelectQueryLimit = "one" | "all";
+type SelectionResultMetadata = {
+    guideGroup: GuideGroupData;
+    filters: SelectFilterParams;
+    limit: SelectQueryLimit;
+    opts: SelectGuideOpts;
+};
+export declare class SelectionResult<K = number, V = KnockGuide> extends Map<K, V> {
+    metadata: SelectionResultMetadata | undefined;
+    constructor();
+}
 export type Any = any;
 export interface StepMessageState {
     seen_at: string | null;
@@ -51,6 +62,13 @@ export interface GuideGroupData {
     inserted_at: string;
     updated_at: string;
 }
+type GuideIneligibilityReason = "guide_not_active" | "marked_as_archived" | "target_conditions_not_met" | "not_in_target_audience";
+export type GuideIneligibilityMarker = {
+    __typename: "GuideIneligibilityMarker";
+    key: KnockGuide["key"];
+    reason: GuideIneligibilityReason;
+    message: string;
+};
 export type GetGuidesQueryParams = {
     data?: string;
     tenant?: string;
@@ -61,6 +79,7 @@ export type GetGuidesResponse = {
     entries: GuideData[];
     guide_groups: GuideGroupData[];
     guide_group_display_logs: Record<GuideGroupData["key"], string>;
+    ineligible_guides: GuideIneligibilityMarker[];
 };
 export type GuideEngagementEventBaseParams = {
     channel_id: string;
@@ -129,6 +148,7 @@ export type QueryStatus = {
     error?: Error;
 };
 export type DebugState = {
+    debugging?: boolean;
     forcedGuideKey?: string | null;
     previewSessionId?: string | null;
 };
@@ -136,11 +156,12 @@ export type StoreState = {
     guideGroups: GuideGroupData[];
     guideGroupDisplayLogs: Record<GuideGroupData["key"], string>;
     guides: Record<KnockGuide["key"], KnockGuide>;
+    ineligibleGuides: Record<GuideIneligibilityMarker["key"], GuideIneligibilityMarker>;
     previewGuides: Record<KnockGuide["key"], KnockGuide>;
     queries: Record<QueryKey, QueryStatus>;
     location: string | undefined;
     counter: number;
-    debug: DebugState;
+    debug?: DebugState;
 };
 export type QueryFilterParams = Pick<GetGuidesQueryParams, "type">;
 export type SelectFilterParams = {
@@ -149,6 +170,7 @@ export type SelectFilterParams = {
 };
 export type SelectGuideOpts = {
     includeThrottled?: boolean;
+    recordSelectQuery?: boolean;
 };
 export type SelectGuidesOpts = SelectGuideOpts;
 export type TargetParams = {
@@ -157,14 +179,24 @@ export type TargetParams = {
 };
 export type ConstructorOpts = {
     trackLocationFromWindow?: boolean;
+    trackDebugParams?: boolean;
     orderResolutionDuration?: number;
     throttleCheckInterval?: number;
 };
+type SelectionResultByLimit = {
+    one?: SelectionResult;
+    all?: SelectionResult;
+};
+type RecordedSelectionResults = {
+    key?: Record<KnockGuide["key"], SelectionResultByLimit>;
+    type?: Record<KnockGuide["type"], SelectionResultByLimit>;
+};
 export type GroupStage = {
     status: "open" | "closed" | "patch";
     ordered: Array<KnockGuide["key"]>;
     resolved?: KnockGuide["key"];
     timeoutId: ReturnType<typeof setTimeout> | null;
+    results: RecordedSelectionResults;
 };
 export {};
 //# sourceMappingURL=types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/clients/guide/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAO/C,MAAM,MAAM,GAAG,GAAG,GAAG,CAAC;AAEtB,MAAM,WAAW,gBAAgB;IAC/B,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,MAAM,WAAW,aAAa,CAAC,QAAQ,GAAG,GAAG;IAC3C,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;IACtB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,OAAO,EAAE,gBAAgB,CAAC;IAC1B,OAAO,EAAE,QAAQ,CAAC;CACnB;AAED,MAAM,WAAW,0BAA0B;IACzC,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC;IAC7B,QAAQ,EAAE,UAAU,CAAC;IACrB,QAAQ,EAAE,UAAU,GAAG,UAAU,CAAC;IAClC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,UAAU,6BAA6B;IACrC,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC;IAE7B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,SAAS,CAAC,QAAQ,GAAG,GAAG;IACvC,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,OAAO,CAAC;IAChB,KAAK,EAAE,aAAa,CAAC,QAAQ,CAAC,EAAE,CAAC;IACjC,oBAAoB,EAAE,0BAA0B,EAAE,CAAC;IACnD,uBAAuB,EAAE,6BAA6B,EAAE,CAAC;IACzD,yBAAyB,EAAE,OAAO,CAAC;IACnC,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,cAAc;IAC7B,UAAU,EAAE,YAAY,CAAC;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ,gBAAgB,EAAE,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;IAC1C,4BAA4B,EAAE,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC;IAC7D,0BAA0B,EAAE,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC;IAC3D,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,SAAS,EAAE,CAAC;IACrB,YAAY,EAAE,cAAc,EAAE,CAAC;IAC/B,wBAAwB,EAAE,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,CAAC;CACjE,CAAC;AAMF,MAAM,MAAM,8BAA8B,GAAG;IAE3C,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,8BAA8B,GAAG;IAE9D,OAAO,EAAE,WAAW,CAAC;IAErB,IAAI,CAAC,EAAE,WAAW,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AACF,MAAM,MAAM,sBAAsB,GAAG,8BAA8B,CAAC;AACpE,MAAM,MAAM,oBAAoB,GAAG,8BAA8B,GAAG;IAClE,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,MAAM,EAAE,IAAI,CAAC;CACd,CAAC;AAMF,KAAK,eAAe,GAChB,aAAa,GACb,eAAe,GACf,eAAe,GACf,mBAAmB,GACnB,qBAAqB,GACrB,4BAA4B,CAAC;AAEjC,KAAK,kBAAkB,CAAC,CAAC,SAAS,eAAe,EAAE,CAAC,IAAI;IACtD,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,CAAC,CAAC;IACT,IAAI,EAAE,CAAC,CAAC;CACT,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,kBAAkB,CAC9C,aAAa,EACb;IAAE,KAAK,EAAE,SAAS,CAAC;IAAC,QAAQ,EAAE,IAAI,CAAA;CAAE,CACrC,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,kBAAkB,CAChD,eAAe,EACf;IAAE,KAAK,EAAE,SAAS,CAAC;IAAC,QAAQ,EAAE,OAAO,CAAA;CAAE,CACxC,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,kBAAkB,CAChD,eAAe,EACf;IAAE,KAAK,EAAE,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAA;CAAE,CAClC,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,kBAAkB,CACnD,mBAAmB,EACnB;IAAE,WAAW,EAAE,cAAc,CAAA;CAAE,CAChC,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG,kBAAkB,CACrD,qBAAqB,EACrB;IAAE,WAAW,EAAE,cAAc,CAAA;CAAE,CAChC,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG,kBAAkB,CAC3D,4BAA4B,EAC5B;IAAE,KAAK,EAAE,SAAS,CAAC;IAAC,QAAQ,EAAE,OAAO,CAAA;CAAE,CACxC,CAAC;AAEF,MAAM,MAAM,gBAAgB,GACxB,eAAe,GACf,iBAAiB,GACjB,iBAAiB,GACjB,oBAAoB,GACpB,sBAAsB,GACtB,4BAA4B,CAAC;AAMjC,MAAM,WAAW,cAAc,CAAC,QAAQ,GAAG,GAAG,CAC5C,SAAQ,aAAa,CAAC,QAAQ,CAAC;IAC/B,UAAU,EAAE,MAAM,OAAO,CAAC,cAAc,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC,CAAC;IAChE,gBAAgB,EAAE,CAAC,MAAM,CAAC,EAAE;QAC1B,QAAQ,CAAC,EAAE,WAAW,CAAC;KACxB,KAAK,OAAO,CAAC,cAAc,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC,CAAC;IACpD,cAAc,EAAE,MAAM,OAAO,CAAC,cAAc,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC,CAAC;CACrE;AAED,MAAM,WAAW,8BACf,SAAQ,6BAA6B;IACrC,OAAO,EAAE,UAAU,CAAC;CACrB;AAED,MAAM,WAAW,UAAU,CAAC,QAAQ,GAAG,GAAG,CAAE,SAAQ,SAAS,CAAC,QAAQ,CAAC;IACrE,KAAK,EAAE,cAAc,CAAC,QAAQ,CAAC,EAAE,CAAC;IAClC,uBAAuB,EAAE,8BAA8B,EAAE,CAAC;IAC1D,OAAO,EAAE,MAAM,cAAc,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC;CACrD;AAED,KAAK,QAAQ,GAAG,MAAM,CAAC;AAEvB,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,EAAE,SAAS,GAAG,IAAI,GAAG,OAAO,CAAC;IACnC,KAAK,CAAC,EAAE,KAAK,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,WAAW,EAAE,cAAc,EAAE,CAAC;IAC9B,qBAAqB,EAAE,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,CAAC;IAC7D,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,UAAU,CAAC,CAAC;IAC9C,aAAa,EAAE,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,UAAU,CAAC,CAAC;IACrD,OAAO,EAAE,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IACvC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,UAAU,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,IAAI,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;AAEnE,MAAM,MAAM,kBAAkB,GAAG;IAC/B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,eAAe,CAAC;AAE/C,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IAC/B,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,MAAM,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC;IACpC,OAAO,EAAE,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;IAClC,QAAQ,CAAC,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;IAC7B,SAAS,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,GAAG,IAAI,CAAC;CACjD,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/clients/guide/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAG/C,MAAM,MAAM,gBAAgB,GAAG,KAAK,GAAG,KAAK,CAAC;AAE7C,KAAK,uBAAuB,GAAG;IAC7B,UAAU,EAAE,cAAc,CAAC;IAE3B,OAAO,EAAE,kBAAkB,CAAC;IAC5B,KAAK,EAAE,gBAAgB,CAAC;IACxB,IAAI,EAAE,eAAe,CAAC;CACvB,CAAC;AAKF,qBAAa,eAAe,CAAC,CAAC,GAAG,MAAM,EAAE,CAAC,GAAG,UAAU,CAAE,SAAQ,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC;IACxE,QAAQ,EAAE,uBAAuB,GAAG,SAAS,CAAC;;CAK/C;AAOD,MAAM,MAAM,GAAG,GAAG,GAAG,CAAC;AAEtB,MAAM,WAAW,gBAAgB;IAC/B,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,MAAM,WAAW,aAAa,CAAC,QAAQ,GAAG,GAAG;IAC3C,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;IACtB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,OAAO,EAAE,gBAAgB,CAAC;IAC1B,OAAO,EAAE,QAAQ,CAAC;CACnB;AAED,MAAM,WAAW,0BAA0B;IACzC,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC;IAC7B,QAAQ,EAAE,UAAU,CAAC;IACrB,QAAQ,EAAE,UAAU,GAAG,UAAU,CAAC;IAClC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,UAAU,6BAA6B;IACrC,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC;IAE7B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,SAAS,CAAC,QAAQ,GAAG,GAAG;IACvC,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,OAAO,CAAC;IAChB,KAAK,EAAE,aAAa,CAAC,QAAQ,CAAC,EAAE,CAAC;IACjC,oBAAoB,EAAE,0BAA0B,EAAE,CAAC;IACnD,uBAAuB,EAAE,6BAA6B,EAAE,CAAC;IACzD,yBAAyB,EAAE,OAAO,CAAC;IACnC,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,cAAc;IAC7B,UAAU,EAAE,YAAY,CAAC;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ,gBAAgB,EAAE,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;IAC1C,4BAA4B,EAAE,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC;IAC7D,0BAA0B,EAAE,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC;IAC3D,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,KAAK,wBAAwB,GACzB,kBAAkB,GAClB,oBAAoB,GACpB,2BAA2B,GAC3B,wBAAwB,CAAC;AAE7B,MAAM,MAAM,wBAAwB,GAAG;IACrC,UAAU,EAAE,0BAA0B,CAAC;IACvC,GAAG,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;IACvB,MAAM,EAAE,wBAAwB,CAAC;IACjC,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,SAAS,EAAE,CAAC;IACrB,YAAY,EAAE,cAAc,EAAE,CAAC;IAC/B,wBAAwB,EAAE,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,CAAC;IAChE,iBAAiB,EAAE,wBAAwB,EAAE,CAAC;CAC/C,CAAC;AAMF,MAAM,MAAM,8BAA8B,GAAG;IAE3C,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,8BAA8B,GAAG;IAE9D,OAAO,EAAE,WAAW,CAAC;IAErB,IAAI,CAAC,EAAE,WAAW,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AACF,MAAM,MAAM,sBAAsB,GAAG,8BAA8B,CAAC;AACpE,MAAM,MAAM,oBAAoB,GAAG,8BAA8B,GAAG;IAClE,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,MAAM,EAAE,IAAI,CAAC;CACd,CAAC;AAMF,KAAK,eAAe,GAChB,aAAa,GACb,eAAe,GACf,eAAe,GACf,mBAAmB,GACnB,qBAAqB,GACrB,4BAA4B,CAAC;AAEjC,KAAK,kBAAkB,CAAC,CAAC,SAAS,eAAe,EAAE,CAAC,IAAI;IACtD,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,CAAC,CAAC;IACT,IAAI,EAAE,CAAC,CAAC;CACT,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,kBAAkB,CAC9C,aAAa,EACb;IAAE,KAAK,EAAE,SAAS,CAAC;IAAC,QAAQ,EAAE,IAAI,CAAA;CAAE,CACrC,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,kBAAkB,CAChD,eAAe,EACf;IAAE,KAAK,EAAE,SAAS,CAAC;IAAC,QAAQ,EAAE,OAAO,CAAA;CAAE,CACxC,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,kBAAkB,CAChD,eAAe,EACf;IAAE,KAAK,EAAE,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAA;CAAE,CAClC,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,kBAAkB,CACnD,mBAAmB,EACnB;IAAE,WAAW,EAAE,cAAc,CAAA;CAAE,CAChC,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG,kBAAkB,CACrD,qBAAqB,EACrB;IAAE,WAAW,EAAE,cAAc,CAAA;CAAE,CAChC,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG,kBAAkB,CAC3D,4BAA4B,EAC5B;IAAE,KAAK,EAAE,SAAS,CAAC;IAAC,QAAQ,EAAE,OAAO,CAAA;CAAE,CACxC,CAAC;AAEF,MAAM,MAAM,gBAAgB,GACxB,eAAe,GACf,iBAAiB,GACjB,iBAAiB,GACjB,oBAAoB,GACpB,sBAAsB,GACtB,4BAA4B,CAAC;AAMjC,MAAM,WAAW,cAAc,CAAC,QAAQ,GAAG,GAAG,CAC5C,SAAQ,aAAa,CAAC,QAAQ,CAAC;IAC/B,UAAU,EAAE,MAAM,OAAO,CAAC,cAAc,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC,CAAC;IAChE,gBAAgB,EAAE,CAAC,MAAM,CAAC,EAAE;QAC1B,QAAQ,CAAC,EAAE,WAAW,CAAC;KACxB,KAAK,OAAO,CAAC,cAAc,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC,CAAC;IACpD,cAAc,EAAE,MAAM,OAAO,CAAC,cAAc,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC,CAAC;CACrE;AAED,MAAM,WAAW,8BACf,SAAQ,6BAA6B;IACrC,OAAO,EAAE,UAAU,CAAC;CACrB;AAED,MAAM,WAAW,UAAU,CAAC,QAAQ,GAAG,GAAG,CAAE,SAAQ,SAAS,CAAC,QAAQ,CAAC;IACrE,KAAK,EAAE,cAAc,CAAC,QAAQ,CAAC,EAAE,CAAC;IAClC,uBAAuB,EAAE,8BAA8B,EAAE,CAAC;IAC1D,OAAO,EAAE,MAAM,cAAc,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC;CACrD;AAED,KAAK,QAAQ,GAAG,MAAM,CAAC;AAEvB,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,EAAE,SAAS,GAAG,IAAI,GAAG,OAAO,CAAC;IACnC,KAAK,CAAC,EAAE,KAAK,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,WAAW,EAAE,cAAc,EAAE,CAAC;IAC9B,qBAAqB,EAAE,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,CAAC;IAC7D,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,UAAU,CAAC,CAAC;IAC9C,gBAAgB,EAAE,MAAM,CACtB,wBAAwB,CAAC,KAAK,CAAC,EAC/B,wBAAwB,CACzB,CAAC;IACF,aAAa,EAAE,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,UAAU,CAAC,CAAC;IACrD,OAAO,EAAE,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IACvC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,UAAU,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,IAAI,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;AAEnE,MAAM,MAAM,kBAAkB,GAAG;IAC/B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,eAAe,CAAC;AAE/C,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IAC/B,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC,CAAC;AAEF,KAAK,sBAAsB,GAAG;IAC5B,GAAG,CAAC,EAAE,eAAe,CAAC;IACtB,GAAG,CAAC,EAAE,eAAe,CAAC;CACvB,CAAC;AAEF,KAAK,wBAAwB,GAAG;IAC9B,GAAG,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,sBAAsB,CAAC,CAAC;IACxD,IAAI,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,sBAAsB,CAAC,CAAC;CAC3D,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,MAAM,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC;IACpC,OAAO,EAAE,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;IAClC,QAAQ,CAAC,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;IAC7B,SAAS,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,GAAG,IAAI,CAAC;IAChD,OAAO,EAAE,wBAAwB,CAAC;CACnC,CAAC"}

package/dist/types/helpers.d.ts

@@ -1,2 +1,21 @@
 export declare function isValidUuid(uuid: string): boolean;
+/**
+ * Exponential backoff with full jitter and a minimum delay floor.
+ *
+ * - Uses exponential growth capped at maxDelayMs
+ * - Applies full jitter to spread retries uniformly across the window
+ * - Enforces a minimum delay to avoid tight retry loops
+ *
+ * Example (baseDelayMs = 1000):
+ *   Try 1:   250ms – 1,000ms
+ *   Try 2:   250ms – 2,000ms
+ *   Try 3:   250ms – 4,000ms
+ *   Try 4:   250ms – 8,000ms
+ *   Try 5+:  250ms – maxDelayMs
+ */
+export declare function exponentialBackoffFullJitter(tries: number, { baseDelayMs, maxDelayMs, minDelayMs, }: {
+    baseDelayMs: number;
+    maxDelayMs: number;
+    minDelayMs?: number;
+}): number;
 //# sourceMappingURL=helpers.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../src/helpers.ts"],"names":[],"mappings":"AAGA,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,WAEvC"}
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../src/helpers.ts"],"names":[],"mappings":"AAGA,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,WAEvC;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,4BAA4B,CAC1C,KAAK,EAAE,MAAM,EACb,EACE,WAAW,EACX,UAAU,EACV,UAAgB,GACjB,EAAE;IACD,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,GACA,MAAM,CAYR"}

package/dist/types/interfaces.d.ts

@@ -6,6 +6,8 @@ export interface KnockOptions {
     host?: string;
     logLevel?: LogLevel;
     branch?: string;
+    /** Automatically disconnect the socket when the page is hidden and reconnect when visible. Defaults to `true`. */
+    disconnectOnPageHidden?: boolean;
 }
 export interface KnockObject<T = GenericData> {
     id: string;