@knocklabs/client 0.19.4 → 0.20.1

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

@@ -1 +1 @@
-{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../../../../src/clients/preferences/interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAE1D,MAAM,MAAM,6BAA6B,GAAG;IAC1C,UAAU,EAAE,SAAS,EAAE,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;KAClC,EAAE,IAAI,WAAW,CAAC,CAAC,EAAE,OAAO,GAAG,6BAA6B;CAC9D,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,GAAG,6BAA6B,CAAC;CAC/D,CAAC;AAEF,MAAM,MAAM,yBAAyB,GACjC,OAAO,GACP;IAAE,aAAa,EAAE,sBAAsB,CAAA;CAAE,GACzC;IAAE,QAAQ,EAAE,kBAAkB,CAAA;CAAE,GAChC,6BAA6B,CAAC;AAElC,MAAM,MAAM,mBAAmB,GAAG,OAAO,CACvC,MAAM,CAAC,MAAM,EAAE,yBAAyB,CAAC,CAC1C,CAAC;AAEF,MAAM,WAAW,wBAAwB;IACvC,SAAS,EAAE,mBAAmB,CAAC;IAC/B,UAAU,EAAE,mBAAmB,CAAC;IAChC,aAAa,EAAE,sBAAsB,CAAC;IACtC,QAAQ,EAAE,kBAAkB,CAAC;CAC9B;AAED,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,mBAAmB,GAAG,IAAI,CAAC;IACvC,SAAS,EAAE,mBAAmB,GAAG,IAAI,CAAC;IACtC,aAAa,EAAE,sBAAsB,GAAG,IAAI,CAAC;IAC7C,QAAQ,EAAE,kBAAkB,GAAG,IAAI,CAAC;CACrC;AAED,MAAM,WAAW,iBAAiB;IAChC,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,qBAAsB,SAAQ,iBAAiB;IAC9D,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../../../../src/clients/preferences/interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAE1D,MAAM,MAAM,6BAA6B,GAAG;IAC1C,UAAU,EAAE,SAAS,EAAE,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;KAClC,EAAE,IAAI,WAAW,CAAC,CAAC,EAAE,OAAO,GAAG,6BAA6B;CAC9D,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,GAAG,6BAA6B,CAAC;CAC/D,CAAC;AAEF,MAAM,MAAM,yBAAyB,GACjC,OAAO,GACP;IAAE,aAAa,EAAE,sBAAsB,CAAA;CAAE,GACzC;IAAE,QAAQ,EAAE,kBAAkB,CAAA;CAAE,GAChC,6BAA6B,CAAC;AAElC,MAAM,MAAM,mBAAmB,GAAG,OAAO,CACvC,MAAM,CAAC,MAAM,EAAE,yBAAyB,CAAC,CAC1C,CAAC;AAEF,MAAM,WAAW,wBAAwB;IACvC,SAAS,CAAC,EAAE,mBAAmB,CAAC;IAChC,UAAU,CAAC,EAAE,mBAAmB,CAAC;IACjC,aAAa,CAAC,EAAE,sBAAsB,CAAC;IACvC,QAAQ,CAAC,EAAE,kBAAkB,CAAC;CAC/B;AAED,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,mBAAmB,GAAG,IAAI,CAAC;IACvC,SAAS,EAAE,mBAAmB,GAAG,IAAI,CAAC;IACtC,aAAa,EAAE,sBAAsB,GAAG,IAAI,CAAC;IAC7C,QAAQ,EAAE,kBAAkB,GAAG,IAAI,CAAC;CACrC;AAED,MAAM,WAAW,iBAAiB;IAChC,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,qBAAsB,SAAQ,iBAAiB;IAC9D,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knocklabs/client",
-  "version": "0.19.4",
+  "version": "0.20.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

@@ -9,7 +9,7 @@ import {
   DEFAULT_GROUP_KEY,
   SelectionResult,
   byKey,
-  checkIfThrottled,
+  checkStateIfThrottled,
   findDefaultGroup,
   formatFilters,
   formatGroupStage,
@@ -44,6 +44,8 @@ import {
   QueryFilterParams,
   QueryStatus,
   SelectFilterParams,
+  SelectGuideOpts,
+  SelectGuidesOpts,
   StepMessageState,
   StoreState,
   TargetParams,
@@ -570,34 +572,40 @@ export class KnockGuideClient {
   selectGuides<C = Any>(
     state: StoreState,
     filters: SelectFilterParams = {},
+    opts: SelectGuidesOpts = {},
   ): 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)");
+
+    const selectedGuide = this.selectGuide(state, filters, opts);
+    if (!selectedGuide) {
       return [];
     }
 
-    const result = select(state, filters);
+    // There should be at least one guide to return here now.
+    const guides = [...select(state, filters).values()];
 
-    if (result.size === 0) {
-      this.knock.log("[Guide] Selection returned zero result");
-      return [];
+    if (!opts.includeThrottled && checkStateIfThrottled(state)) {
+      const unthrottledGuides = guides.filter(
+        (g) => g.bypass_global_group_limit,
+      );
+      const throttledCount = guides.length - unthrottledGuides.length;
+      this.knock.log(
+        `[Guide] Throttling ${throttledCount} guides from selection, and returning ${unthrottledGuides.length} guides`,
+      );
+
+      return unthrottledGuides;
     }
 
-    // Return all selected guides, since we cannot apply the one-at-a-time limit
-    // or throttle settings, but rather defer to the caller to decide which ones
-    // to render. Note
-    return [...result.values()];
+    this.knock.log(`[Guide] Returning ${guides.length} guides from selection`);
+    return guides;
   }
 
   selectGuide<C = Any>(
     state: StoreState,
     filters: SelectFilterParams = {},
+    opts: SelectGuideOpts = {},
   ): KnockGuide<C> | undefined {
     this.knock.log(
       `[Guide] .selectGuide (filters: ${formatFilters(filters)}; state: ${formatState(state)})`,
@@ -630,24 +638,10 @@ export class KnockGuideClient {
     }
 
     // Check if inside the throttle window (i.e. throttled) and if so stop and
-    // return undefined.
-    const defaultGroup = findDefaultGroup(state.guideGroups);
-    const throttleWindowStartedAt =
-      state.guideGroupDisplayLogs[DEFAULT_GROUP_KEY];
-
-    if (
-      defaultGroup &&
-      defaultGroup.display_interval &&
-      throttleWindowStartedAt
-    ) {
-      const throttled = checkIfThrottled(
-        throttleWindowStartedAt,
-        defaultGroup.display_interval,
-      );
-      if (throttled) {
-        this.knock.log(`[Guide] Throttling the selected guide: ${guide.key}`);
-        return undefined;
-      }
+    // return undefined unless explicitly given the option to include throttled.
+    if (!opts.includeThrottled && checkStateIfThrottled(state)) {
+      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
@@ -814,15 +808,32 @@ export class KnockGuideClient {
     }
   }
 
-  // Test helper that opens and closes the group stage to return the select
-  // result immediately.
-  private _selectGuide(state: StoreState, filters: SelectFilterParams = {}) {
+  // Test helpers to open and close the group stage to return the select result
+  // immediately.
+  private _selectGuide(
+    state: StoreState,
+    filters: SelectFilterParams = {},
+    opts: SelectGuideOpts = {},
+  ) {
+    this.openGroupStage();
+
+    this.selectGuide(state, filters, opts);
+    this.closePendingGroupStage();
+
+    return this.selectGuide(state, filters, opts);
+  }
+
+  private _selectGuides(
+    state: StoreState,
+    filters: SelectFilterParams = {},
+    opts: SelectGuidesOpts = {},
+  ) {
     this.openGroupStage();
 
-    this.selectGuide(state, filters);
+    this.selectGuides(state, filters, opts);
     this.closePendingGroupStage();
 
-    return this.selectGuide(state, filters);
+    return this.selectGuides(state, filters, opts);
   }
 
   //

package/src/clients/guide/helpers.ts

@@ -75,11 +75,31 @@ export const findDefaultGroup = (guideGroups: GuideGroupData[]) =>
       group.key === DEFAULT_GROUP_KEY || group.key === MOCK_DEFAULT_GROUP_KEY,
   );
 
+export const checkStateIfThrottled = (state: StoreState) => {
+  const defaultGroup = findDefaultGroup(state.guideGroups);
+  const throttleWindowStartedAt =
+    state.guideGroupDisplayLogs[DEFAULT_GROUP_KEY];
+
+  if (
+    defaultGroup &&
+    defaultGroup.display_interval &&
+    throttleWindowStartedAt
+  ) {
+    return checkTimeIfThrottled(
+      throttleWindowStartedAt,
+      defaultGroup.display_interval,
+    );
+  }
+
+  // Fall back to false, though this should never happen.
+  return false;
+};
+
 // Checks whether we are currently throttled (inside a "throttle window").
 // A throttle window opens when a user dismisses (archives) a guide, and lasts
 // for the configured display interval of the guide group used (currently only
 // the default global group).
-export const checkIfThrottled = (
+const checkTimeIfThrottled = (
   throttleWindowStartedAtTs: string,
   windowDurationInSeconds: number,
 ) => {

package/src/clients/guide/index.ts

@@ -4,4 +4,6 @@ export type {
   KnockGuideStep,
   TargetParams as KnockGuideTargetParams,
   SelectFilterParams as KnockGuideFilterParams,
+  SelectGuideOpts as KnockSelectGuideOpts,
+  SelectGuidesOpts as KnockSelectGuidesOpts,
 } from "./types";

package/src/clients/guide/types.ts

@@ -212,6 +212,12 @@ export type SelectFilterParams = {
   type?: string;
 };
 
+export type SelectGuideOpts = {
+  includeThrottled?: boolean;
+};
+
+export type SelectGuidesOpts = SelectGuideOpts;
+
 export type TargetParams = {
   data?: GenericData | undefined;
   tenant?: string | undefined;

package/src/clients/preferences/interfaces.ts

@@ -23,10 +23,10 @@ export type WorkflowPreferences = Partial<
 >;
 
 export interface SetPreferencesProperties {
-  workflows: WorkflowPreferences;
-  categories: WorkflowPreferences;
-  channel_types: ChannelTypePreferences;
-  channels: ChannelPreferences;
+  workflows?: WorkflowPreferences;
+  categories?: WorkflowPreferences;
+  channel_types?: ChannelTypePreferences;
+  channels?: ChannelPreferences;
 }
 
 export interface PreferenceSet {