@knocklabs/client 0.17.2 → 0.18.1

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  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   * @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\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    // Inline identify the user if we've been given an object with an id.\n    if (\n      typeof userIdOrUserWithProperties === \"object\" &&\n      userIdOrUserWithProperties?.id\n    ) {\n      const { id, ...properties } = userIdOrUserWithProperties;\n      this.user.identify(properties);\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  /**\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    throw new Error(\"`user` object must contain an `id` property\");\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","id","properties","checkUserToken","_a","message","force","ApiClient","callbackFn","timeBeforeExpirationInMs","decoded","jwtDecode","expiresAtMs","nowMs","msInFuture","newToken"],"mappings":";;;;;;;;;;;;AAmBA,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,EAqBd,aACES,GACAC,GACAV,GACA;AACA,QAAIW,IAAkB;AACtB,UAAMC,IAAmB,KAAK,WACxBC,IAAS,KAAK,UAAUJ,CAA0B;AAoCxD,QA/BEG,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,IAK9C,OAAOF,KAA+B,aACtCA,KAAA,QAAAA,EAA4B,KAC5B;AACA,YAAM,EAAE,IAAAK,GAAI,GAAGC,EAAA,IAAeN;AACzB,WAAA,KAAK,SAASM,CAAU;AAAA,IAAA;AAAA,EAG/B;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;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASM,UAAUlB,GAAwD;AACxE,QACE,OAAOA,KAA+B,YACtC,CAACA;AAEM,aAAAA;AAGT,QAAIA,KAAA,QAAAA,EAA4B;AAC9B,aAAOA,EAA2B;AAG9B,UAAA,IAAI,MAAM,6CAA6C;AAAA,EAAA;AAEjE;"}
+{"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  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   * @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);\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  /**\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    throw new Error(\"`user` object must contain an `id` property\");\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","checkUserToken","_a","message","force","ApiClient","callbackFn","timeBeforeExpirationInMs","decoded","jwtDecode","expiresAtMs","nowMs","msInFuture","newToken"],"mappings":";;;;;;;;;;;;AAmBA,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,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;AACzB,WAAA,KAAK,SAASO,CAAU;AAAA,IAAA;AAAA,EAG/B;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;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASM,UAAUnB,GAAwD;AACxE,QACE,OAAOA,KAA+B,YACtC,CAACA;AAEM,aAAAA;AAGT,QAAIA,KAAA,QAAAA,EAA4B;AAC9B,aAAOA,EAA2B;AAG9B,UAAA,IAAI,MAAM,6CAA6C;AAAA,EAAA;AAEjE;"}

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;AAchC,OAAO,EACL,GAAG,EACH,eAAe,EAMf,SAAS,EAMT,aAAa,EAEb,UAAU,EACV,cAAc,EAKd,iBAAiB,EACjB,WAAW,EACX,kBAAkB,EAElB,UAAU,EACV,YAAY,EACb,MAAM,SAAS,CAAC;AAcjB,eAAO,MAAM,kBAAkB;;;CAG9B,CAAC;AASF,eAAO,MAAM,iBAAiB,GAAI,QAAQ,MAAM,GAAG,SAAS,GAAG,IAAI,WACrC,CAAC;AAiH/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;IAoCxC,OAAO,CAAC,gBAAgB;IAKxB,OAAO,CAAC,oBAAoB;IAa5B,OAAO,CAAC,oBAAoB;IAO5B,OAAO;IAOD,KAAK,CAAC,IAAI,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,iBAAiB,CAAA;KAAE;IAgDlD,SAAS;IAuDT,OAAO,CAAC,sBAAsB;IAc9B,WAAW;IAcX,OAAO,CAAC,iBAAiB;IA2BzB,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,gBAAgB,GAAE,OAAO,CAAC,UAAU,CAAM;IAuBpE,YAAY,CAAC,CAAC,GAAG,GAAG,EAClB,KAAK,EAAE,UAAU,EACjB,OAAO,GAAE,kBAAuB,GAC/B,UAAU,CAAC,CAAC,CAAC,EAAE;IAsBlB,WAAW,CAAC,CAAC,GAAG,GAAG,EACjB,KAAK,EAAE,UAAU,EACjB,OAAO,GAAE,kBAAuB,GAC/B,UAAU,CAAC,CAAC,CAAC,GAAG,SAAS;IA8F5B,OAAO,CAAC,cAAc;IAuBtB,OAAO,CAAC,sBAAsB;IAoC9B,OAAO,CAAC,qBAAqB;IAyB7B,OAAO,CAAC,eAAe;IASvB,OAAO,CAAC,kBAAkB;IAQ1B,OAAO,CAAC,YAAY;IAgBd,UAAU,CAAC,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,aAAa;IA2BhD,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;IA4DjB,OAAO,CAAC,gBAAgB;IA4BxB,OAAO,CAAC,cAAc;IActB,OAAO,CAAC,mBAAmB;IA+C3B,OAAO,CAAC,8BAA8B;IAatC,OAAO,CAAC,iBAAiB;IAYzB,OAAO,CAAC,WAAW;IASnB,OAAO,CAAC,sBAAsB;IAiC9B,OAAO,CAAC,kBAAkB;IAU1B,OAAO,CAAC,oBAAoB,CA2B1B;IAIF,OAAO,CAAC,sBAAsB;IAO9B,OAAO,CAAC,kCAAkC;IAyC1C,OAAO,CAAC,oBAAoB;CAgB7B"}
+{"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,EAElB,UAAU,EACV,YAAY,EACb,MAAM,SAAS,CAAC;AAcjB,eAAO,MAAM,kBAAkB;;;CAG9B,CAAC;AASF,eAAO,MAAM,iBAAiB,GAAI,QAAQ,MAAM,GAAG,SAAS,GAAG,IAAI,WACrC,CAAC;AAiH/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;IA0BpE,YAAY,CAAC,CAAC,GAAG,GAAG,EAClB,KAAK,EAAE,UAAU,EACjB,OAAO,GAAE,kBAAuB,GAC/B,UAAU,CAAC,CAAC,CAAC,EAAE;IAyBlB,WAAW,CAAC,CAAC,GAAG,GAAG,EACjB,KAAK,EAAE,UAAU,EACjB,OAAO,GAAE,kBAAuB,GAC/B,UAAU,CAAC,CAAC,CAAC,GAAG,SAAS;IAiH5B,OAAO,CAAC,cAAc;IAuBtB,OAAO,CAAC,sBAAsB;IAuC9B,OAAO,CAAC,qBAAqB;IA0B7B,OAAO,CAAC,eAAe;IASvB,OAAO,CAAC,kBAAkB;IAQ1B,OAAO,CAAC,YAAY;IAgBd,UAAU,CAAC,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,aAAa;IA2BhD,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;IA4DjB,OAAO,CAAC,gBAAgB;IA4BxB,OAAO,CAAC,cAAc;IActB,OAAO,CAAC,mBAAmB;IA+C3B,OAAO,CAAC,8BAA8B;IAatC,OAAO,CAAC,iBAAiB;IAYzB,OAAO,CAAC,WAAW;IASnB,OAAO,CAAC,sBAAsB;IAiC9B,OAAO,CAAC,kBAAkB;IAU1B,OAAO,CAAC,oBAAoB,CA4B1B;IAIF,OAAO,CAAC,sBAAsB;IAO9B,OAAO,CAAC,kCAAkC;IAyC1C,OAAO,CAAC,oBAAoB;CAgB7B"}

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

@@ -1,10 +1,12 @@
-import { GuideActivationUrlRuleData, GuideData, GuideGroupData, KnockGuide, KnockGuideActivationUrlPattern, SelectFilterParams } from './types';
+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();
 }
+export declare const formatGroupStage: (stage: GroupStage) => string;
+export declare const formatState: (state: StoreState) => string;
 export declare const formatFilters: (filters?: SelectFilterParams) => string;
 export declare const byKey: <T extends {
     key: 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,0BAA0B,EAC1B,SAAS,EACT,cAAc,EACd,UAAU,EACV,8BAA8B,EAC9B,kBAAkB,EACnB,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,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;AAMJ,eAAO,MAAM,gBAAgB,GAC3B,2BAA2B,MAAM,EACjC,yBAAyB,MAAM,YA0BhC,CAAC;AAGF,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,wBA4BvC,CAAC;AAEF,eAAO,MAAM,oBAAoB,GAC/B,KAAK,GAAG,EACR,aAAa,8BAA8B,EAAE,wBA4B9C,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,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;AAMJ,eAAO,MAAM,gBAAgB,GAC3B,2BAA2B,MAAM,EACjC,yBAAyB,MAAM,YA0BhC,CAAC;AAGF,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,wBA4BvC,CAAC;AAEF,eAAO,MAAM,oBAAoB,GAC/B,KAAK,GAAG,EACR,aAAa,8BAA8B,EAAE,wBA4B9C,CAAC"}

package/dist/types/interfaces.d.ts

@@ -43,6 +43,7 @@ export type UserTokenExpiringCallback = (currentToken: string, decodedToken: Jwt
 export interface AuthenticateOptions {
     onUserTokenExpiring?: UserTokenExpiringCallback;
     timeBeforeExpirationInMs?: number;
+    identificationStrategy?: "inline" | "skip";
 }
 export interface BulkOperation {
     id: string;

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

@@ -1 +1 @@
-{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../../src/interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAExC,OAAO,KAAK,MAAM,SAAS,CAAC;AAE5B,MAAM,MAAM,QAAQ,GAAG,OAAO,CAAC;AAE/B,MAAM,WAAW,YAAY;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED,MAAM,WAAW,WAAW,CAAC,CAAC,GAAG,WAAW;IAC1C,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,CAAC,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,IAAK,SAAQ,WAAW;IACvC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,MAAM,SAAS,GAAG,IAAI,GAAG,WAAW,CAAC;AAE3C,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG;IAAE,UAAU,EAAE,MAAM,CAAC;IAAC,EAAE,EAAE,MAAM,CAAA;CAAE,CAAC;AAEvE,MAAM,WAAW,QAAQ,CAAC,CAAC,GAAG,WAAW;IACvC,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,SAAS,CAAC;IACrB,KAAK,EAAE,SAAS,GAAG,IAAI,CAAC;IACxB,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC;CAChB;AAED,MAAM,WAAW,WAAW,CAAC,CAAC,GAAG,WAAW;IAC1C,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,CAAC,CAAC;CACT;AAED,MAAM,MAAM,yBAAyB,GAAG,CACtC,YAAY,EAAE,MAAM,EACpB,YAAY,EAAE,UAAU,KACrB,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;AAE5B,MAAM,WAAW,mBAAmB;IAClC,mBAAmB,CAAC,EAAE,yBAAyB,CAAC;IAChD,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,QAAQ,GAAG,YAAY,GAAG,WAAW,GAAG,QAAQ,CAAC;IACzD,cAAc,EAAE,MAAM,CAAC;IACvB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,MAAM,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;AACrC,MAAM,MAAM,kBAAkB,GAAG;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,GAAG,WAAW,CAAC;AAC9D,MAAM,MAAM,0BAA0B,GAAG,MAAM,GAAG,kBAAkB,CAAC"}
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../../src/interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAExC,OAAO,KAAK,MAAM,SAAS,CAAC;AAE5B,MAAM,MAAM,QAAQ,GAAG,OAAO,CAAC;AAE/B,MAAM,WAAW,YAAY;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED,MAAM,WAAW,WAAW,CAAC,CAAC,GAAG,WAAW;IAC1C,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,CAAC,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,IAAK,SAAQ,WAAW;IACvC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,MAAM,SAAS,GAAG,IAAI,GAAG,WAAW,CAAC;AAE3C,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG;IAAE,UAAU,EAAE,MAAM,CAAC;IAAC,EAAE,EAAE,MAAM,CAAA;CAAE,CAAC;AAEvE,MAAM,WAAW,QAAQ,CAAC,CAAC,GAAG,WAAW;IACvC,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,SAAS,CAAC;IACrB,KAAK,EAAE,SAAS,GAAG,IAAI,CAAC;IACxB,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC;CAChB;AAED,MAAM,WAAW,WAAW,CAAC,CAAC,GAAG,WAAW;IAC1C,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,CAAC,CAAC;CACT;AAED,MAAM,MAAM,yBAAyB,GAAG,CACtC,YAAY,EAAE,MAAM,EACpB,YAAY,EAAE,UAAU,KACrB,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;AAE5B,MAAM,WAAW,mBAAmB;IAClC,mBAAmB,CAAC,EAAE,yBAAyB,CAAC;IAChD,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,sBAAsB,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;CAC5C;AAED,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,QAAQ,GAAG,YAAY,GAAG,WAAW,GAAG,QAAQ,CAAC;IACzD,cAAc,EAAE,MAAM,CAAC;IACvB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,MAAM,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;AACrC,MAAM,MAAM,kBAAkB,GAAG;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,GAAG,WAAW,CAAC;AAC9D,MAAM,MAAM,0BAA0B,GAAG,MAAM,GAAG,kBAAkB,CAAC"}

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

@@ -1 +1 @@
-{"version":3,"file":"knock.d.ts","sourceRoot":"","sources":["../../src/knock.ts"],"names":[],"mappings":"AAEA,OAAO,SAAS,MAAM,OAAO,CAAC;AAC9B,OAAO,UAAU,MAAM,gBAAgB,CAAC;AACxC,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAC/C,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAC/C,OAAO,YAAY,MAAM,mBAAmB,CAAC;AAC7C,OAAO,WAAW,MAAM,uBAAuB,CAAC;AAChD,OAAO,WAAW,MAAM,iBAAiB,CAAC;AAC1C,OAAO,UAAU,MAAM,iBAAiB,CAAC;AACzC,OAAO,EACL,mBAAmB,EACnB,YAAY,EACZ,QAAQ,EACR,MAAM,EACN,0BAA0B,EAE3B,MAAM,cAAc,CAAC;AAItB,cAAM,KAAK;IAgBP,QAAQ,CAAC,MAAM,EAAE,MAAM;IAflB,IAAI,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,SAAS,CAA0B;IACpC,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CAAC;IAClC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAC3B,OAAO,CAAC,oBAAoB,CAA8C;IAC1E,QAAQ,CAAC,KAAK,aAAwB;IACtC,QAAQ,CAAC,OAAO,eAA0B;IAC1C,QAAQ,CAAC,WAAW,cAAyB;IAC7C,QAAQ,CAAC,KAAK,cAAyB;IACvC,QAAQ,CAAC,OAAO,gBAA2B;IAC3C,QAAQ,CAAC,IAAI,aAAwB;IACrC,QAAQ,CAAC,QAAQ,gBAA2B;gBAGjC,MAAM,EAAE,MAAM,EACvB,OAAO,GAAE,YAAiB;IAe5B,MAAM;IASN;;;;;;;OAOG;IACH,YAAY,CACV,0BAA0B,EAAE,MAAM,EAClC,SAAS,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,EAC9B,OAAO,CAAC,EAAE,mBAAmB,GAC5B,KAAK;IACR,YAAY,CACV,0BAA0B,EAAE,0BAA0B,EACtD,SAAS,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,EAC9B,OAAO,CAAC,EAAE,mBAAmB,GAC5B,IAAI;IAuDP,sBAAsB;IAUtB,eAAe,CAAC,cAAc,UAAQ;IAKtC,QAAQ;IASR,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,UAAQ;IAMlC;;OAEG;IACH,OAAO,CAAC,eAAe;YAQT,gCAAgC;IA+B9C;;;;;OAKG;IACH,OAAO,CAAC,SAAS;CAclB;AAED,eAAe,KAAK,CAAC"}
+{"version":3,"file":"knock.d.ts","sourceRoot":"","sources":["../../src/knock.ts"],"names":[],"mappings":"AAEA,OAAO,SAAS,MAAM,OAAO,CAAC;AAC9B,OAAO,UAAU,MAAM,gBAAgB,CAAC;AACxC,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAC/C,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAC/C,OAAO,YAAY,MAAM,mBAAmB,CAAC;AAC7C,OAAO,WAAW,MAAM,uBAAuB,CAAC;AAChD,OAAO,WAAW,MAAM,iBAAiB,CAAC;AAC1C,OAAO,UAAU,MAAM,iBAAiB,CAAC;AACzC,OAAO,EACL,mBAAmB,EACnB,YAAY,EACZ,QAAQ,EACR,MAAM,EACN,0BAA0B,EAE3B,MAAM,cAAc,CAAC;AAItB,cAAM,KAAK;IAgBP,QAAQ,CAAC,MAAM,EAAE,MAAM;IAflB,IAAI,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,SAAS,CAA0B;IACpC,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CAAC;IAClC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAC3B,OAAO,CAAC,oBAAoB,CAA8C;IAC1E,QAAQ,CAAC,KAAK,aAAwB;IACtC,QAAQ,CAAC,OAAO,eAA0B;IAC1C,QAAQ,CAAC,WAAW,cAAyB;IAC7C,QAAQ,CAAC,KAAK,cAAyB;IACvC,QAAQ,CAAC,OAAO,gBAA2B;IAC3C,QAAQ,CAAC,IAAI,aAAwB;IACrC,QAAQ,CAAC,QAAQ,gBAA2B;gBAGjC,MAAM,EAAE,MAAM,EACvB,OAAO,GAAE,YAAiB;IAe5B,MAAM;IASN;;;;;;;OAOG;IACH,YAAY,CACV,0BAA0B,EAAE,MAAM,EAClC,SAAS,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,EAC9B,OAAO,CAAC,EAAE,mBAAmB,GAC5B,KAAK;IACR,YAAY,CACV,0BAA0B,EAAE,0BAA0B,EACtD,SAAS,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,EAC9B,OAAO,CAAC,EAAE,mBAAmB,GAC5B,IAAI;IAiEP,sBAAsB;IAUtB,eAAe,CAAC,cAAc,UAAQ;IAKtC,QAAQ;IASR,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,UAAQ;IAMlC;;OAEG;IACH,OAAO,CAAC,eAAe;YAQT,gCAAgC;IA+B9C;;;;;OAKG;IACH,OAAO,CAAC,SAAS;CAclB;AAED,eAAe,KAAK,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knocklabs/client",
-  "version": "0.17.2",
+  "version": "0.18.1",
   "description": "The clientside library for interacting with Knock",
   "homepage": "https://github.com/knocklabs/javascript/tree/main/packages/client",
   "author": "@knocklabs",

package/src/clients/guide/client.ts

@@ -12,6 +12,8 @@ import {
   checkIfThrottled,
   findDefaultGroup,
   formatFilters,
+  formatGroupStage,
+  formatState,
   mockDefaultGroup,
   newUrl,
   predicateUrlPatterns,
@@ -219,7 +221,10 @@ export class KnockGuideClient {
     readonly targetParams: TargetParams = {},
     readonly options: ConstructorOpts = {},
   ) {
-    const { trackLocationFromWindow = true } = options;
+    const {
+      trackLocationFromWindow = true,
+      throttleCheckInterval = DEFAULT_COUNTER_INCREMENT_INTERVAL,
+    } = options;
     const win = checkForWindow();
 
     const location = trackLocationFromWindow ? win?.location.href : undefined;
@@ -247,8 +252,10 @@ export class KnockGuideClient {
       this.listenForLocationChangesFromWindow();
     }
 
-    // Start the counter loop to increment at an interval.
-    this.startCounterInterval();
+    if (throttleCheckInterval) {
+      // Start the counter loop to increment at an interval.
+      this.startCounterInterval(throttleCheckInterval);
+    }
 
     this.knock.log("[Guide] Initialized a guide client");
   }
@@ -258,11 +265,7 @@ export class KnockGuideClient {
     this.store.setState((state) => ({ ...state, counter: state.counter + 1 }));
   }
 
-  private startCounterInterval() {
-    const {
-      throttleCheckInterval: delay = DEFAULT_COUNTER_INCREMENT_INTERVAL,
-    } = this.options;
-
+  private startCounterInterval(delay: number) {
     this.counterIntervalId = setInterval(() => {
       this.knock.log("[Guide] Counter interval tick");
       if (this.stage && this.stage.status !== "closed") return;
@@ -286,8 +289,8 @@ export class KnockGuideClient {
   }
 
   async fetch(opts?: { filters?: QueryFilterParams }) {
+    this.knock.log("[Guide] .fetch");
     this.knock.failIfNotAuthenticated();
-    this.knock.log("[Guide] Loading all eligible guides");
 
     const queryParams = this.buildQueryParams(opts?.filters);
     const queryKey = this.formatQueryKey(queryParams);
@@ -306,6 +309,7 @@ export class KnockGuideClient {
 
     let queryStatus: QueryStatus;
     try {
+      this.knock.log("[Guide] Fetching all eligible guides");
       const data = await this.knock.user.getGuides<
         GetGuidesQueryParams,
         GetGuidesResponse
@@ -314,6 +318,7 @@ export class KnockGuideClient {
 
       const { entries, guide_groups: groups, guide_group_display_logs } = data;
 
+      this.knock.log("[Guide] Loading fetched guides");
       this.store.setState((state) => ({
         ...state,
         guideGroups: groups?.length > 0 ? groups : [mockDefaultGroup(entries)],
@@ -444,9 +449,12 @@ export class KnockGuideClient {
   }
 
   setLocation(href: string, additionalParams: Partial<StoreState> = {}) {
+    this.knock.log(`[Guide] .setLocation (loc=${href})`);
+
     // Make sure to clear out the stage.
     this.clearGroupStage();
 
+    this.knock.log("[Guide] Updating the tracked location");
     this.store.setState((state) => {
       // Clear preview guides if no longer in preview mode
       const previewGuides = additionalParams?.debug?.previewSessionId
@@ -470,13 +478,16 @@ export class KnockGuideClient {
     state: StoreState,
     filters: SelectFilterParams = {},
   ): KnockGuide<C>[] {
+    this.knock.log(
+      `[Guide] .selectGuides (filters: ${formatFilters(filters)}; state: ${formatState(state)})`,
+    );
     if (
       Object.keys(state.guides).length === 0 &&
       Object.keys(state.previewGuides).length === 0
     ) {
+      this.knock.log("[Guide] Exiting selection (no guides)");
       return [];
     }
-    this.knock.log(`[Guide] Selecting guides for: ${formatFilters(filters)}`);
 
     const result = select(state, filters);
 
@@ -495,26 +506,33 @@ export class KnockGuideClient {
     state: StoreState,
     filters: SelectFilterParams = {},
   ): KnockGuide<C> | undefined {
+    this.knock.log(
+      `[Guide] .selectGuide (filters: ${formatFilters(filters)}; state: ${formatState(state)})`,
+    );
     if (
       Object.keys(state.guides).length === 0 &&
       Object.keys(state.previewGuides).length === 0
     ) {
+      this.knock.log("[Guide] Exiting selection (no guides)");
       return undefined;
     }
-    this.knock.log(`[Guide] Selecting a guide for: ${formatFilters(filters)}`);
 
     const result = select(state, filters);
 
     if (result.size === 0) {
-      this.knock.log("[Guide] Selection returned zero result");
+      this.knock.log("[Guide] Selection found zero result");
       return undefined;
     }
 
     const [index, guide] = [...result][0]!;
+    this.knock.log(
+      `[Guide] Selection found: \`${guide.key}\` (total: ${result.size})`,
+    );
 
     // If a guide ignores the group limit, then return immediately to render
     // always.
     if (guide.bypass_global_group_limit) {
+      this.knock.log(`[Guide] Returning the unthrottled guide: ${guide.key}`);
       return guide;
     }
 
@@ -533,7 +551,10 @@ export class KnockGuideClient {
         throttleWindowStartedAt,
         defaultGroup.display_interval,
       );
-      if (throttled) return undefined;
+      if (throttled) {
+        this.knock.log(`[Guide] Throttling the selected guide: ${guide.key}`);
+        return undefined;
+      }
     }
 
     // Starting here to the end of this method represents the core logic of how
@@ -579,11 +600,20 @@ export class KnockGuideClient {
       case "patch": {
         this.knock.log(`[Guide] Patching the group stage: ${guide.key}`);
         this.stage.ordered[index] = guide.key;
-        return this.stage.resolved === guide.key ? guide : undefined;
+
+        const ret = this.stage.resolved === guide.key ? guide : undefined;
+        this.knock.log(
+          `[Guide] Returning \`${ret?.key}\` (stage: ${formatGroupStage(this.stage)})`,
+        );
+        return ret;
       }
 
       case "closed": {
-        return this.stage.resolved === guide.key ? guide : undefined;
+        const ret = this.stage.resolved === guide.key ? guide : undefined;
+        this.knock.log(
+          `[Guide] Returning \`${ret?.key}\` (stage: ${formatGroupStage(this.stage)})`,
+        );
+        return ret;
       }
     }
   }
@@ -612,10 +642,9 @@ export class KnockGuideClient {
   // Close the current non-closed stage to resolve the prevailing guide up next
   // for display amongst the ones that have been staged.
   private closePendingGroupStage() {
+    this.knock.log("[Guide] .closePendingGroupStage");
     if (!this.stage || this.stage.status === "closed") return;
 
-    this.knock.log("[Guide] Closing the current group stage");
-
     // Should have been cleared already since this method should be called as a
     // callback to a setTimeout, but just to be safe.
     this.ensureClearTimeout();
@@ -632,6 +661,10 @@ export class KnockGuideClient {
       resolved = this.stage.ordered.find((x) => x !== undefined);
     }
 
+    this.knock.log(
+      `[Guide] Closing the current group stage: resolved=${resolved}`,
+    );
+
     this.stage = {
       ...this.stage,
       status: "closed",
@@ -648,10 +681,9 @@ export class KnockGuideClient {
   // rendered until we are ready to resolve the updated stage and re-render.
   // Note, must be called ahead of updating the state store.
   private patchClosedGroupStage() {
+    this.knock.log("[Guide] .patchClosedGroupStage");
     if (this.stage?.status !== "closed") return;
 
-    this.knock.log("[Guide] Patching the current group stage");
-
     const { orderResolutionDuration: delay = 0 } = this.options;
 
     const timeoutId = setTimeout(() => {
@@ -662,6 +694,8 @@ export class KnockGuideClient {
     // Just to be safe.
     this.ensureClearTimeout();
 
+    this.knock.log("[Guide] Patching the current group stage");
+
     this.stage = {
       ...this.stage,
       status: "patch",
@@ -673,10 +707,10 @@ export class KnockGuideClient {
   }
 
   private clearGroupStage() {
+    this.knock.log("[Guide] .clearGroupStage");
     if (!this.stage) return;
 
     this.knock.log("[Guide] Clearing the current group stage");
-
     this.ensureClearTimeout();
     this.stage = undefined;
   }
@@ -738,7 +772,7 @@ export class KnockGuideClient {
     metadata?: GenericData,
   ) {
     this.knock.log(
-      `[Guide] Marking as interacted (Guide key: ${guide.key}, Step ref:${step.ref})`,
+      `[Guide] Marking as interacted (Guide key: ${guide.key}; Step ref:${step.ref})`,
     );
 
     const ts = new Date().toISOString();
@@ -1023,11 +1057,12 @@ export class KnockGuideClient {
     const href = win.location.href;
     if (this.store.state.location === href) return;
 
-    this.knock.log(`[Guide] Handle Location change: ${href}`);
+    this.knock.log(`[Guide] Detected a location change: ${href}`);
 
     // If entering debug mode, fetch all guides.
     const currentDebugParams = this.store.state.debug;
     const newDebugParams = detectDebugParams();
+
     this.setLocation(href, { debug: newDebugParams });
 
     // If debug state has changed, refetch guides and resubscribe to the websocket channel

package/src/clients/guide/helpers.ts

@@ -1,10 +1,12 @@
 import {
+  GroupStage,
   GuideActivationUrlRuleData,
   GuideData,
   GuideGroupData,
   KnockGuide,
   KnockGuideActivationUrlPattern,
   SelectFilterParams,
+  StoreState,
 } from "./types";
 
 // Extends the map class to allow having metadata on it, which is used to record
@@ -18,6 +20,14 @@ export class SelectionResult<K = number, V = KnockGuide> extends Map<K, V> {
   }
 }
 
+export const formatGroupStage = (stage: GroupStage) => {
+  return `status=${stage.status}, resolved=${stage.resolved}`;
+};
+
+export const formatState = (state: StoreState) => {
+  return `loc=${state.location}`;
+};
+
 export const formatFilters = (filters: SelectFilterParams = {}) => {
   return [
     filters.key && `key=${filters.key}`,

package/src/interfaces.ts

@@ -54,6 +54,7 @@ export type UserTokenExpiringCallback = (
 export interface AuthenticateOptions {
   onUserTokenExpiring?: UserTokenExpiringCallback;
   timeBeforeExpirationInMs?: number;
+  identificationStrategy?: "inline" | "skip";
 }
 
 export interface BulkOperation {

package/src/knock.ts

@@ -86,6 +86,7 @@ class Knock {
     let reinitializeApi = false;
     const currentApiClient = this.apiClient;
     const userId = this.getUserId(userIdOrUserWithProperties);
+    const identificationStrategy = options?.identificationStrategy || "inline";
 
     // If we've previously been initialized and the values have now changed, then we
     // need to reinitialize any stateful connections we have
@@ -120,11 +121,20 @@ class Knock {
       this.log("Reinitialized real-time connections");
     }
 
-    // Inline identify the user if we've been given an object with an id.
+    // We explicitly skip the inline identification if the strategy is set to "skip"
+    if (identificationStrategy === "skip") {
+      this.log("Skipping inline user identification");
+      return;
+    }
+
+    // Inline identify the user if we've been given an object with an id
+    // and the strategy is set to "inline".
     if (
+      identificationStrategy === "inline" &&
       typeof userIdOrUserWithProperties === "object" &&
       userIdOrUserWithProperties?.id
     ) {
+      this.log(`Identifying user ${userIdOrUserWithProperties.id} inline`);
       const { id, ...properties } = userIdOrUserWithProperties;
       this.user.identify(properties);
     }