@knocklabs/client 0.17.2 → 0.18.1

package/dist/esm/clients/guide/client.mjs

@@ -1,53 +1,53 @@
-var v = Object.defineProperty;
-var G = (a, e, t) => e in a ? v(a, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : a[e] = t;
-var d = (a, e, t) => G(a, typeof e != "symbol" ? e + "" : e, t);
-import { Store as _ } from "@tanstack/store";
-import { URLPattern as b } from "urlpattern-polyfill";
-import { byKey as C, mockDefaultGroup as I, formatFilters as g, findDefaultGroup as m, DEFAULT_GROUP_KEY as p, checkIfThrottled as w, SelectionResult as E, newUrl as A, predicateUrlRules as R, predicateUrlPatterns as L } from "./helpers.mjs";
-const P = 50, D = 30 * 1e3, T = 3, k = {
+var _ = Object.defineProperty;
+var b = (a, e, t) => e in a ? _(a, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : a[e] = t;
+var d = (a, e, t) => b(a, typeof e != "symbol" ? e + "" : e, t);
+import { Store as C } from "@tanstack/store";
+import { URLPattern as I } from "urlpattern-polyfill";
+import { byKey as w, mockDefaultGroup as E, formatFilters as g, formatState as p, findDefaultGroup as S, DEFAULT_GROUP_KEY as k, checkIfThrottled as R, formatGroupStage as f, SelectionResult as A, newUrl as L, predicateUrlRules as P, predicateUrlPatterns as $ } from "./helpers.mjs";
+const D = 50, T = 30 * 1e3, O = 3, G = {
   GUIDE_KEY: "knock_guide_key",
   PREVIEW_SESSION_ID: "knock_preview_session_id"
 }, l = () => {
   if (typeof window < "u")
     return window;
-}, O = (a) => `/v1/users/${a}/guides`, f = () => {
+}, K = (a) => `/v1/users/${a}/guides`, y = () => {
   const a = l();
   if (!a)
     return { forcedGuideKey: null, previewSessionId: null };
-  const e = new URLSearchParams(a.location.search), t = e.get(k.GUIDE_KEY), s = e.get(k.PREVIEW_SESSION_ID);
+  const e = new URLSearchParams(a.location.search), t = e.get(G.GUIDE_KEY), s = e.get(G.PREVIEW_SESSION_ID);
   return { forcedGuideKey: t, previewSessionId: s };
-}, y = (a, e = {}) => {
-  const t = new E(), s = m(a.guideGroups);
+}, m = (a, e = {}) => {
+  const t = new A(), s = S(a.guideGroups);
   if (!s) return t;
-  const i = [...s.display_sequence], n = a.location;
+  const i = [...s.display_sequence], r = a.location;
   if (a.debug.forcedGuideKey) {
-    const r = i.indexOf(a.debug.forcedGuideKey);
-    r > -1 && i.splice(r, 1), i.unshift(a.debug.forcedGuideKey);
+    const n = i.indexOf(a.debug.forcedGuideKey);
+    n > -1 && i.splice(n, 1), i.unshift(a.debug.forcedGuideKey);
   }
-  for (const [r, o] of i.entries()) {
+  for (const [n, o] of i.entries()) {
     let u = a.guides[o];
-    a.debug.forcedGuideKey === o && a.previewGuides[o] && (u = a.previewGuides[o]), !(!u || !K(u, {
-      location: n,
+    a.debug.forcedGuideKey === o && a.previewGuides[o] && (u = a.previewGuides[o]), !(!u || !F(u, {
+      location: r,
       filters: e,
       debug: a.debug
-    })) && t.set(r, u);
+    })) && t.set(n, u);
   }
   return t.metadata = { guideGroup: s }, t;
-}, K = (a, { location: e, filters: t = {}, debug: s = {} }) => {
+}, F = (a, { location: e, filters: t = {}, debug: s = {} }) => {
   if (t.type && t.type !== a.type || t.key && t.key !== a.key)
     return !1;
   if (s.forcedGuideKey === a.key)
     return !0;
   if (!a.active || a.steps.every((o) => !!o.message.archived_at))
     return !1;
-  const i = e ? A(e) : void 0, n = a.activation_url_rules || [], r = a.activation_url_patterns || [];
-  if (i && n.length > 0) {
-    if (!R(i, n)) return !1;
-  } else if (i && r.length > 0 && !L(i, r))
+  const i = e ? L(e) : void 0, r = a.activation_url_rules || [], n = a.activation_url_patterns || [];
+  if (i && r.length > 0) {
+    if (!P(i, r)) return !1;
+  } else if (i && n.length > 0 && !$(i, n))
     return !1;
   return !0;
 };
-class j {
+class x {
   constructor(e, t, s = {}, i = {}) {
     d(this, "store");
     // Phoenix channels for real time guide updates over websocket
@@ -77,8 +77,8 @@ class j {
       if (!(e != null && e.location)) return;
       const t = e.location.href;
       if (this.store.state.location === t) return;
-      this.knock.log(`[Guide] Handle Location change: ${t}`);
-      const s = this.store.state.debug, i = f();
+      this.knock.log(`[Guide] Detected a location change: ${t}`);
+      const s = this.store.state.debug, i = y();
       this.setLocation(t, { debug: i }), this.checkDebugStateChanged(
         s,
         i
@@ -87,28 +87,28 @@ class j {
       ), this.fetch(), this.subscribe());
     });
     this.knock = e, this.channelId = t, this.targetParams = s, this.options = i;
-    const { trackLocationFromWindow: n = !0 } = i, r = l(), o = n ? r == null ? void 0 : r.location.href : void 0, u = f();
-    this.store = new _({
+    const {
+      trackLocationFromWindow: r = !0,
+      throttleCheckInterval: n = T
+    } = i, o = l(), u = r ? o == null ? void 0 : o.location.href : void 0, h = y();
+    this.store = new C({
       guideGroups: [],
       guideGroupDisplayLogs: {},
       guides: {},
       previewGuides: {},
       queries: {},
-      location: o,
+      location: u,
       // Increment to update the state store and trigger re-selection.
       counter: 0,
-      debug: u
+      debug: h
     });
     const { socket: c } = this.knock.client();
-    this.socket = c, this.socketChannelTopic = `guides:${t}`, n && this.listenForLocationChangesFromWindow(), this.startCounterInterval(), this.knock.log("[Guide] Initialized a guide client");
+    this.socket = c, this.socketChannelTopic = `guides:${t}`, r && this.listenForLocationChangesFromWindow(), n && this.startCounterInterval(n), this.knock.log("[Guide] Initialized a guide client");
   }
   incrementCounter() {
     this.knock.log("[Guide] Incrementing the counter"), this.store.setState((e) => ({ ...e, counter: e.counter + 1 }));
   }
-  startCounterInterval() {
-    const {
-      throttleCheckInterval: e = D
-    } = this.options;
+  startCounterInterval(e) {
     this.counterIntervalId = setInterval(() => {
       this.knock.log("[Guide] Counter interval tick"), !(this.stage && this.stage.status !== "closed") && this.incrementCounter();
     }, e);
@@ -120,33 +120,34 @@ class j {
     this.unsubscribe(), this.removeEventListeners(), this.clearGroupStage(), this.clearCounterInterval();
   }
   async fetch(e) {
-    this.knock.failIfNotAuthenticated(), this.knock.log("[Guide] Loading all eligible guides");
+    this.knock.log("[Guide] .fetch"), this.knock.failIfNotAuthenticated();
     const t = this.buildQueryParams(e == null ? void 0 : e.filters), s = this.formatQueryKey(t), i = this.store.state.queries[s];
     if (i)
       return i;
-    this.store.setState((r) => ({
-      ...r,
-      queries: { ...r.queries, [s]: { status: "loading" } }
+    this.store.setState((n) => ({
+      ...n,
+      queries: { ...n.queries, [s]: { status: "loading" } }
     }));
-    let n;
+    let r;
     try {
-      const r = await this.knock.user.getGuides(this.channelId, t);
-      n = { status: "ok" };
-      const { entries: o, guide_groups: u, guide_group_display_logs: c } = r;
-      this.store.setState((h) => ({
-        ...h,
-        guideGroups: (u == null ? void 0 : u.length) > 0 ? u : [I(o)],
-        guideGroupDisplayLogs: c || {},
-        guides: C(o.map((S) => this.localCopy(S))),
-        queries: { ...h.queries, [s]: n }
+      this.knock.log("[Guide] Fetching all eligible guides");
+      const n = await this.knock.user.getGuides(this.channelId, t);
+      r = { status: "ok" };
+      const { entries: o, guide_groups: u, guide_group_display_logs: h } = n;
+      this.knock.log("[Guide] Loading fetched guides"), this.store.setState((c) => ({
+        ...c,
+        guideGroups: (u == null ? void 0 : u.length) > 0 ? u : [E(o)],
+        guideGroupDisplayLogs: h || {},
+        guides: w(o.map((v) => this.localCopy(v))),
+        queries: { ...c.queries, [s]: r }
       }));
-    } catch (r) {
-      n = { status: "error", error: r }, this.store.setState((o) => ({
+    } catch (n) {
+      r = { status: "error", error: n }, this.store.setState((o) => ({
         ...o,
-        queries: { ...o.queries, [s]: n }
+        queries: { ...o.queries, [s]: r }
       }));
     }
-    return n;
+    return r;
   }
   subscribe() {
     if (!this.socket) return;
@@ -158,7 +159,7 @@ class j {
       preview_session_id: e.previewSessionId || void 0
     }, s = this.socket.channel(this.socketChannelTopic, t);
     for (const i of this.socketEventTypes)
-      s.on(i, (n) => this.handleSocketEvent(n));
+      s.on(i, (r) => this.handleSocketEvent(r));
     ["closed", "errored"].includes(s.state) && (this.subscribeRetryCount = 0, s.join().receive("ok", () => {
       this.knock.log("[Guide] Successfully joined channel");
     }).receive("error", (i) => {
@@ -170,7 +171,7 @@ class j {
     })), this.socketChannel = s;
   }
   handleChannelJoinError() {
-    if (this.subscribeRetryCount >= T) {
+    if (this.subscribeRetryCount >= O) {
       this.knock.log(
         `[Guide] Channel join max retry limit reached: ${this.subscribeRetryCount}`
       ), this.unsubscribe();
@@ -205,9 +206,9 @@ class j {
     }
   }
   setLocation(e, t = {}) {
-    this.clearGroupStage(), this.store.setState((s) => {
-      var n;
-      const i = (n = t == null ? void 0 : t.debug) != null && n.previewSessionId ? s.previewGuides : {};
+    this.knock.log(`[Guide] .setLocation (loc=${e})`), this.clearGroupStage(), this.knock.log("[Guide] Updating the tracked location"), this.store.setState((s) => {
+      var r;
+      const i = (r = t == null ? void 0 : t.debug) != null && r.previewSessionId ? s.previewGuides : {};
       return {
         ...s,
         ...t,
@@ -220,44 +221,62 @@ class j {
   // Store selector
   //
   selectGuides(e, t = {}) {
-    if (Object.keys(e.guides).length === 0 && Object.keys(e.previewGuides).length === 0)
-      return [];
-    this.knock.log(`[Guide] Selecting guides for: ${g(t)}`);
-    const s = y(e, t);
+    if (this.knock.log(
+      `[Guide] .selectGuides (filters: ${g(t)}; state: ${p(e)})`
+    ), Object.keys(e.guides).length === 0 && Object.keys(e.previewGuides).length === 0)
+      return this.knock.log("[Guide] Exiting selection (no guides)"), [];
+    const s = m(e, t);
     return s.size === 0 ? (this.knock.log("[Guide] Selection returned zero result"), []) : [...s.values()];
   }
   selectGuide(e, t = {}) {
-    if (Object.keys(e.guides).length === 0 && Object.keys(e.previewGuides).length === 0)
+    if (this.knock.log(
+      `[Guide] .selectGuide (filters: ${g(t)}; state: ${p(e)})`
+    ), Object.keys(e.guides).length === 0 && Object.keys(e.previewGuides).length === 0) {
+      this.knock.log("[Guide] Exiting selection (no guides)");
       return;
-    this.knock.log(`[Guide] Selecting a guide for: ${g(t)}`);
-    const s = y(e, t);
+    }
+    const s = m(e, t);
     if (s.size === 0) {
-      this.knock.log("[Guide] Selection returned zero result");
+      this.knock.log("[Guide] Selection found zero result");
       return;
     }
-    const [i, n] = [...s][0];
-    if (n.bypass_global_group_limit)
-      return n;
-    const r = m(e.guideGroups), o = e.guideGroupDisplayLogs[p];
-    if (!(r && r.display_interval && o && w(
+    const [i, r] = [...s][0];
+    if (this.knock.log(
+      `[Guide] Selection found: \`${r.key}\` (total: ${s.size})`
+    ), r.bypass_global_group_limit)
+      return this.knock.log(`[Guide] Returning the unthrottled guide: ${r.key}`), r;
+    const n = S(e.guideGroups), o = e.guideGroupDisplayLogs[k];
+    if (n && n.display_interval && o && R(
       o,
-      r.display_interval
-    )))
-      switch (this.stage || (this.stage = this.openGroupStage()), this.stage.status) {
-        case "open": {
-          this.knock.log(`[Guide] Addng to the group stage: ${n.key}`), this.stage.ordered[i] = n.key;
-          return;
-        }
-        case "patch":
-          return this.knock.log(`[Guide] Patching the group stage: ${n.key}`), this.stage.ordered[i] = n.key, this.stage.resolved === n.key ? n : void 0;
-        case "closed":
-          return this.stage.resolved === n.key ? n : void 0;
+      n.display_interval
+    )) {
+      this.knock.log(`[Guide] Throttling the selected guide: ${r.key}`);
+      return;
+    }
+    switch (this.stage || (this.stage = this.openGroupStage()), this.stage.status) {
+      case "open": {
+        this.knock.log(`[Guide] Addng to the group stage: ${r.key}`), this.stage.ordered[i] = r.key;
+        return;
+      }
+      case "patch": {
+        this.knock.log(`[Guide] Patching the group stage: ${r.key}`), this.stage.ordered[i] = r.key;
+        const u = this.stage.resolved === r.key ? r : void 0;
+        return this.knock.log(
+          `[Guide] Returning \`${u == null ? void 0 : u.key}\` (stage: ${f(this.stage)})`
+        ), u;
       }
+      case "closed": {
+        const u = this.stage.resolved === r.key ? r : void 0;
+        return this.knock.log(
+          `[Guide] Returning \`${u == null ? void 0 : u.key}\` (stage: ${f(this.stage)})`
+        ), u;
+      }
+    }
   }
   openGroupStage() {
     this.knock.log("[Guide] Opening a new group stage");
     const {
-      orderResolutionDuration: e = P
+      orderResolutionDuration: e = D
     } = this.options, t = setTimeout(() => {
       this.closePendingGroupStage(), this.incrementCounter();
     }, e);
@@ -270,12 +289,14 @@ class j {
   // Close the current non-closed stage to resolve the prevailing guide up next
   // for display amongst the ones that have been staged.
   closePendingGroupStage() {
-    if (!this.stage || this.stage.status === "closed") return;
-    this.knock.log("[Guide] Closing the current group stage"), this.ensureClearTimeout();
+    if (this.knock.log("[Guide] .closePendingGroupStage"), !this.stage || this.stage.status === "closed") return;
+    this.ensureClearTimeout();
     let e;
     return this.store.state.debug.forcedGuideKey && (e = this.stage.ordered.find(
       (t) => t === this.store.state.debug.forcedGuideKey
-    )), e || (e = this.stage.ordered.find((t) => t !== void 0)), this.stage = {
+    )), e || (e = this.stage.ordered.find((t) => t !== void 0)), this.knock.log(
+      `[Guide] Closing the current group stage: resolved=${e}`
+    ), this.stage = {
       ...this.stage,
       status: "closed",
       resolved: e,
@@ -289,12 +310,11 @@ class j {
   // Note, must be called ahead of updating the state store.
   patchClosedGroupStage() {
     var s;
-    if (((s = this.stage) == null ? void 0 : s.status) !== "closed") return;
-    this.knock.log("[Guide] Patching the current group stage");
+    if (this.knock.log("[Guide] .patchClosedGroupStage"), ((s = this.stage) == null ? void 0 : s.status) !== "closed") return;
     const { orderResolutionDuration: e = 0 } = this.options, t = setTimeout(() => {
       this.closePendingGroupStage(), this.incrementCounter();
     }, e);
-    return this.ensureClearTimeout(), this.stage = {
+    return this.ensureClearTimeout(), this.knock.log("[Guide] Patching the current group stage"), this.stage = {
       ...this.stage,
       status: "patch",
       ordered: [],
@@ -302,7 +322,7 @@ class j {
     }, this.stage;
   }
   clearGroupStage() {
-    this.stage && (this.knock.log("[Guide] Clearing the current group stage"), this.ensureClearTimeout(), this.stage = void 0);
+    this.knock.log("[Guide] .clearGroupStage"), this.stage && (this.knock.log("[Guide] Clearing the current group stage"), this.ensureClearTimeout(), this.stage = void 0);
   }
   ensureClearTimeout() {
     var e;
@@ -341,18 +361,18 @@ class j {
   }
   async markAsInteracted(e, t, s) {
     this.knock.log(
-      `[Guide] Marking as interacted (Guide key: ${e.key}, Step ref:${t.ref})`
+      `[Guide] Marking as interacted (Guide key: ${e.key}; Step ref:${t.ref})`
     );
-    const i = (/* @__PURE__ */ new Date()).toISOString(), n = this.setStepMessageAttrs(e.key, t.ref, {
+    const i = (/* @__PURE__ */ new Date()).toISOString(), r = this.setStepMessageAttrs(e.key, t.ref, {
       read_at: i,
       interacted_at: i
     });
-    if (!n) return;
-    const r = {
-      ...this.buildEngagementEventBaseParams(e, n),
+    if (!r) return;
+    const n = {
+      ...this.buildEngagementEventBaseParams(e, r),
       metadata: s
     };
-    return this.knock.user.markGuideStepAs("interacted", r), n;
+    return this.knock.user.markGuideStepAs("interacted", n), r;
   }
   async markAsArchived(e, t) {
     if (t.message.archived_at) return;
@@ -383,9 +403,9 @@ class j {
         return t.store.state.debug.forcedGuideKey === this.key ? this.steps[0] : this.steps.find((i) => !i.message.archived_at);
       }
     };
-    return s.getStep = s.getStep.bind(s), s.steps = e.steps.map(({ message: i, ...n }) => {
-      const r = {
-        ...n,
+    return s.getStep = s.getStep.bind(s), s.steps = e.steps.map(({ message: i, ...r }) => {
+      const n = {
+        ...r,
         message: { ...i },
         markAsSeen() {
           if (!this.message.seen_at)
@@ -399,10 +419,10 @@ class j {
             return t.markAsArchived(s, this);
         }
       };
-      return r.markAsSeen = r.markAsSeen.bind(r), r.markAsInteracted = r.markAsInteracted.bind(r), r.markAsArchived = r.markAsArchived.bind(r), r;
+      return n.markAsSeen = n.markAsSeen.bind(n), n.markAsInteracted = n.markAsInteracted.bind(n), n.markAsArchived = n.markAsArchived.bind(n), n;
     }), s.activation_url_patterns = e.activation_url_patterns.map((i) => ({
       ...i,
-      pattern: new b({ pathname: i.pathname })
+      pattern: new I({ pathname: i.pathname })
     })), s;
   }
   buildQueryParams(e = {}) {
@@ -413,29 +433,29 @@ class j {
     this.store.state.debug.forcedGuideKey && (t.force_all_guides = !0);
     let i = Object.fromEntries(
       Object.entries(t).filter(
-        ([n, r]) => r != null
+        ([r, n]) => n != null
       )
     );
     return i = i.data ? { ...i, data: JSON.stringify(i.data) } : i, i;
   }
   formatQueryKey(e) {
     const s = Object.keys(e).sort().map(
-      (n) => `${encodeURIComponent(n)}=${encodeURIComponent(e[n])}`
-    ).join("&"), i = O(this.knock.userId);
+      (r) => `${encodeURIComponent(r)}=${encodeURIComponent(e[r])}`
+    ).join("&"), i = K(this.knock.userId);
     return s ? `${i}?${s}` : i;
   }
   setStepMessageAttrs(e, t, s) {
     let i;
-    return s.archived_at && this.clearGroupStage(), this.store.setState((n) => {
-      const r = n.guides[e];
-      if (!r) return n;
-      const o = r.steps.map((h) => (h.ref !== t || (h.message = { ...h.message, ...s }, i = h), h));
-      r.steps = o;
-      const u = { ...n.guides, [r.key]: r }, c = s.archived_at && !r.bypass_global_group_limit ? {
-        ...n.guideGroupDisplayLogs,
-        [p]: s.archived_at
-      } : n.guideGroupDisplayLogs;
-      return { ...n, guides: u, guideGroupDisplayLogs: c };
+    return s.archived_at && this.clearGroupStage(), this.store.setState((r) => {
+      const n = r.guides[e];
+      if (!n) return r;
+      const o = n.steps.map((c) => (c.ref !== t || (c.message = { ...c.message, ...s }, i = c), c));
+      n.steps = o;
+      const u = { ...r.guides, [n.key]: n }, h = s.archived_at && !n.bypass_global_group_limit ? {
+        ...r.guideGroupDisplayLogs,
+        [k]: s.archived_at
+      } : r.guideGroupDisplayLogs;
+      return { ...r, guides: u, guideGroupDisplayLogs: h };
     }), i;
   }
   buildEngagementEventBaseParams(e, t) {
@@ -465,17 +485,17 @@ class j {
     data: e
   }) {
     this.patchClosedGroupStage(), this.store.setState((t) => {
-      const s = [e.guide_group], i = e.guide_group.display_sequence_unthrottled || [], n = e.guide_group.display_sequence_throttled || [];
-      let r = t.guides;
-      return r = i.reduce((o, u) => {
+      const s = [e.guide_group], i = e.guide_group.display_sequence_unthrottled || [], r = e.guide_group.display_sequence_throttled || [];
+      let n = t.guides;
+      return n = i.reduce((o, u) => {
         if (!o[u]) return o;
-        const c = { ...o[u], bypass_global_group_limit: !0 };
-        return { ...o, [u]: c };
-      }, r), r = n.reduce((o, u) => {
+        const h = { ...o[u], bypass_global_group_limit: !0 };
+        return { ...o, [u]: h };
+      }, n), n = r.reduce((o, u) => {
         if (!o[u]) return o;
-        const c = { ...o[u], bypass_global_group_limit: !1 };
-        return { ...o, [u]: c };
-      }, r), { ...t, guides: r, guideGroups: s };
+        const h = { ...o[u], bypass_global_group_limit: !1 };
+        return { ...o, [u]: h };
+      }, n), { ...t, guides: n, guideGroups: s };
     });
   }
   updatePreviewGuide({ data: e }) {
@@ -496,14 +516,14 @@ class j {
       e.addEventListener("popstate", this.handleLocationChange), e.addEventListener("hashchange", this.handleLocationChange);
       const t = e.history.pushState, s = e.history.replaceState;
       e.history.pushState = new Proxy(t, {
-        apply: (i, n, r) => {
-          Reflect.apply(i, n, r), setTimeout(() => {
+        apply: (i, r, n) => {
+          Reflect.apply(i, r, n), setTimeout(() => {
             this.handleLocationChange();
           }, 0);
         }
       }), e.history.replaceState = new Proxy(s, {
-        apply: (i, n, r) => {
-          Reflect.apply(i, n, r), setTimeout(() => {
+        apply: (i, r, n) => {
+          Reflect.apply(i, r, n), setTimeout(() => {
             this.handleLocationChange();
           }, 0);
         }
@@ -519,8 +539,8 @@ class j {
   }
 }
 export {
-  k as DEBUG_QUERY_PARAMS,
-  j as KnockGuideClient,
-  O as guidesApiRootPath
+  G as DEBUG_QUERY_PARAMS,
+  x as KnockGuideClient,
+  K as guidesApiRootPath
 };
 //# sourceMappingURL=client.mjs.map