@knocklabs/client 0.21.10 → 0.21.12

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

@@ -1,87 +1,35 @@
-var C = Object.defineProperty;
-var w = (a, e, s) => e in a ? C(a, e, { enumerable: !0, configurable: !0, writable: !0, value: s }) : a[e] = s;
-var h = (a, e, s) => w(a, typeof e != "symbol" ? e + "" : e, s);
-import { Store as R } from "@tanstack/store";
+var _ = Object.defineProperty;
+var C = (u, e, s) => e in u ? _(u, e, { enumerable: !0, configurable: !0, writable: !0, value: s }) : u[e] = s;
+var h = (u, e, s) => C(u, typeof e != "symbol" ? e + "" : e, s);
+import { Store as I } from "@tanstack/store";
 import { URLPattern as A } from "urlpattern-polyfill";
-import { byKey as S, mockDefaultGroup as P, formatFilters as b, formatState as v, checkStateIfThrottled as _, formatGroupStage as m, DEFAULT_GROUP_KEY as D, getToolbarRunConfigFromUrl as K, newUrl as L, predicateUrlRules as T, predicateUrlPatterns as $, findDefaultGroup as O } from "./helpers.mjs";
-import { SelectionResult as F } from "./types.mjs";
-const U = 50, N = 30 * 1e3, q = 3, f = {
-  GUIDE_KEY: "knock_guide_key",
-  PREVIEW_SESSION_ID: "knock_preview_session_id"
-}, y = "knock_guide_debug", p = () => {
+import { byKey as y, mockDefaultGroup as E, formatFilters as G, formatState as S, checkStateIfThrottled as b, formatGroupStage as p, DEFAULT_GROUP_KEY as R, getToolbarRunConfigFromUrl as T, newUrl as $, predicateUrlRules as L, predicateUrlPatterns as w, findDefaultGroup as F } from "./helpers.mjs";
+import { SelectionResult as P } from "./types.mjs";
+const D = 50, K = 30 * 1e3, O = 3, f = () => {
   if (typeof window < "u")
     return window;
-}, j = (a) => `/v1/users/${a}/guides`, I = () => {
-  const a = p();
-  if (!a || !a.location)
-    return { forcedGuideKey: null, previewSessionId: null };
-  const e = new URLSearchParams(a.location.search), s = e.get(f.GUIDE_KEY), t = e.get(
-    f.PREVIEW_SESSION_ID
-  );
-  if (s || t) {
-    if (a.localStorage)
-      try {
-        const n = {
-          forcedGuideKey: s,
-          previewSessionId: t
-        };
-        a.localStorage.setItem(y, JSON.stringify(n));
-      } catch {
-      }
-    return {
-      forcedGuideKey: s,
-      previewSessionId: t
-    };
-  }
-  let i = null, r = null;
-  if (a.localStorage)
-    try {
-      const n = a.localStorage.getItem(y);
-      if (n) {
-        const u = B(n);
-        i = u.forcedGuideKey, r = u.previewSessionId;
-      }
-    } catch {
-    }
-  return {
-    forcedGuideKey: i,
-    previewSessionId: r
-  };
-}, B = (a) => {
-  try {
-    const e = JSON.parse(a);
-    return {
-      forcedGuideKey: (e == null ? void 0 : e.forcedGuideKey) ?? null,
-      previewSessionId: (e == null ? void 0 : e.previewSessionId) ?? null
-    };
-  } catch {
-    return {
-      forcedGuideKey: null,
-      previewSessionId: null
-    };
-  }
-}, E = (a, e, s) => {
-  const t = new F(), i = O(a.guideGroups);
+}, U = (u) => `/v1/users/${u}/guides`, v = (u, e, s) => {
+  const t = new P(), i = F(u.guideGroups);
   if (!i) return t;
-  const r = i.display_sequence, n = a.location;
-  for (const [u, o] of r.entries()) {
-    const c = a.previewGuides[o] || a.guides[o];
-    !c || !M(c, e, {
+  const r = i.display_sequence, n = u.location;
+  for (const [a, o] of r.entries()) {
+    const c = u.previewGuides[o] || u.guides[o];
+    !c || !q(c, e, {
       location: n,
-      ineligibleGuides: a.ineligibleGuides,
-      debug: a.debug
-    }) || t.set(u, c);
+      ineligibleGuides: u.ineligibleGuides,
+      debug: u.debug
+    }) || t.set(a, c);
   }
   return t.metadata = { guideGroup: i, filters: e, ...s }, t;
-}, M = (a, e, { location: s, ineligibleGuides: t = {}, debug: i = {} }) => e.type && e.type !== a.type || e.key && e.key !== a.key ? !1 : i.focusedGuideKeys && Object.keys(i.focusedGuideKeys).length > 0 ? !!i.focusedGuideKeys[a.key] : i.forcedGuideKey ? i.forcedGuideKey === a.key : t[a.key] || !a.active || a.steps.every((n) => !!n.message.archived_at) ? !1 : Q(a, s), Q = (a, e) => {
-  const s = e ? L(e) : void 0, t = a.activation_url_rules || [], i = a.activation_url_patterns || [];
+}, q = (u, e, { location: s, ineligibleGuides: t = {}, debug: i = {} }) => e.type && e.type !== u.type || e.key && e.key !== u.key ? !1 : i.focusedGuideKeys && Object.keys(i.focusedGuideKeys).length > 0 ? !!i.focusedGuideKeys[u.key] : i.forcedGuideKey ? i.forcedGuideKey === u.key : t[u.key] || !u.active || u.steps.every((n) => !!n.message.archived_at) ? !1 : j(u, s), j = (u, e) => {
+  const s = e ? $(e) : void 0, t = u.activation_url_rules || [], i = u.activation_url_patterns || [];
   if (s && t.length > 0) {
-    if (!T(s, t)) return !1;
-  } else if (s && i.length > 0 && !$(s, i))
+    if (!L(s, t)) return !1;
+  } else if (s && i.length > 0 && !w(s, i))
     return !1;
   return !0;
 };
-class z {
+class J {
   constructor(e, s, t = {}, i = {}) {
     h(this, "store");
     // Phoenix channels for real time guide updates over websocket
@@ -93,8 +41,7 @@ class z {
       "guide.updated",
       "guide.removed",
       "guide_group.added",
-      "guide_group.updated",
-      "guide.live_preview_updated"
+      "guide_group.updated"
     ]);
     h(this, "subscribeRetryCount", 0);
     // Original history methods to monkey patch, or restore in cleanups.
@@ -108,45 +55,30 @@ class z {
     // Define as an arrow func property to always bind this to the class instance.
     h(this, "handleLocationChange", () => {
       this.knock.log("[Guide] .handleLocationChange");
-      const e = p();
+      const e = f();
       if (!(e != null && e.location)) return;
       const s = e.location.href;
-      if (this.store.state.location === s) return;
-      if (this.knock.log(`[Guide] Detected a location change: ${s}`), !this.options.trackDebugParams) {
-        this.setLocation(s);
-        return;
-      }
-      const t = this.store.state.debug || {}, i = I();
-      this.setLocation(s, { debug: i }), this.checkDebugStateChanged(
-        t,
-        i
-      ) && (this.knock.log(
-        "[Guide] Debug state changed, refetching guides and resubscribing to the websocket channel"
-      ), this.fetch(), this.subscribe());
+      this.store.state.location !== s && (this.knock.log(`[Guide] Detected a location change: ${s}`), this.setLocation(s));
     });
-    var l;
+    var d;
     this.knock = e, this.channelId = s, this.targetParams = t, this.options = i;
     const {
       trackLocationFromWindow: r = !0,
-      // TODO(KNO-11523): Remove once we ship guide toolbar v2, and offload as
-      // much debugging specific logic and responsibilities to toolbar.
-      trackDebugParams: n = !1,
-      throttleCheckInterval: u = N
-    } = i, o = p(), c = r ? (l = o == null ? void 0 : o.location) == null ? void 0 : l.href : void 0, d = n ? I() : void 0;
-    this.store = new R({
+      throttleCheckInterval: n = K
+    } = i, a = f(), o = r ? (d = a == null ? void 0 : a.location) == null ? void 0 : d.href : void 0;
+    this.store = new I({
       guideGroups: [],
       guideGroupDisplayLogs: {},
       guides: {},
       ineligibleGuides: {},
       previewGuides: {},
       queries: {},
-      location: c,
+      location: o,
       // Increment to update the state store and trigger re-selection.
-      counter: 0,
-      debug: d
+      counter: 0
     });
-    const { socket: g } = this.knock.client();
-    this.socket = g, this.socketChannelTopic = `guides:${s}`, r && this.listenForLocationChangesFromWindow(), u && this.startCounterInterval(u), this.knock.log("[Guide] Initialized a guide client");
+    const { socket: c } = this.knock.client();
+    this.socket = c, this.socketChannelTopic = `guides:${s}`, 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 }));
@@ -177,23 +109,23 @@ class z {
       const n = await this.knock.user.getGuides(this.channelId, s);
       r = { status: "ok" };
       const {
-        entries: u,
+        entries: a,
         guide_groups: o,
         guide_group_display_logs: c,
         ineligible_guides: d
       } = n;
-      this.stage && this.clearGroupStage(), this.knock.log("[Guide] Loading fetched guides"), this.store.setState((g) => ({
-        ...g,
-        guideGroups: (o == null ? void 0 : o.length) > 0 ? o : [P(u)],
+      this.stage && this.clearGroupStage(), this.knock.log("[Guide] Loading fetched guides"), this.store.setState((l) => ({
+        ...l,
+        guideGroups: (o == null ? void 0 : o.length) > 0 ? o : [E(a)],
         guideGroupDisplayLogs: c || {},
-        guides: S(u.map((l) => this.localCopy(l))),
-        ineligibleGuides: S(d || []),
-        queries: { ...g.queries, [t]: r }
+        guides: y(a.map((k) => this.localCopy(k))),
+        ineligibleGuides: y(d || []),
+        queries: { ...l.queries, [t]: r }
       }));
     } catch (n) {
-      r = { status: "error", error: n }, this.store.setState((u) => ({
-        ...u,
-        queries: { ...u.queries, [t]: r }
+      r = { status: "error", error: n }, this.store.setState((a) => ({
+        ...a,
+        queries: { ...a.queries, [t]: r }
       }));
     }
     return r;
@@ -220,7 +152,7 @@ class z {
     })), this.socketChannel = t;
   }
   handleChannelJoinError() {
-    if (this.subscribeRetryCount >= q) {
+    if (this.subscribeRetryCount >= O) {
       this.knock.log(
         `[Guide] Channel join max retry limit reached: ${this.subscribeRetryCount}`
       ), this.unsubscribe();
@@ -248,8 +180,6 @@ class z {
       case "guide_group.added":
       case "guide_group.updated":
         return this.addOrReplaceGuideGroup(e);
-      case "guide.live_preview_updated":
-        return this.updatePreviewGuide(e);
       default:
         return;
     }
@@ -266,28 +196,6 @@ class z {
       };
     });
   }
-  exitDebugMode() {
-    this.knock.log("[Guide] Exiting debug mode");
-    const e = p();
-    if (e != null && e.localStorage)
-      try {
-        e.localStorage.removeItem(y);
-      } catch {
-      }
-    if (this.store.setState((s) => ({
-      ...s,
-      debug: {
-        forcedGuideKey: null,
-        previewSessionId: null,
-        focusedGuideKeys: {}
-      },
-      previewGuides: {}
-      // Clear preview guides when exiting debug mode
-    })), e != null && e.location) {
-      const s = new URL(e.location.href);
-      (s.searchParams.has(f.GUIDE_KEY) || s.searchParams.has(f.PREVIEW_SESSION_ID)) && (s.searchParams.delete(f.GUIDE_KEY), s.searchParams.delete(f.PREVIEW_SESSION_ID), e.location.href = s.toString());
-    }
-  }
   setDebug(e) {
     var t;
     if (this.knock.log("[Guide] .setDebug()"), !this.knock.isAuthenticated()) {
@@ -326,7 +234,7 @@ class z {
   selectGuides(e, s = {}, t = {}) {
     var c;
     this.knock.log(
-      `[Guide] .selectGuides (filters: ${b(s)}; state: ${v(e)})`
+      `[Guide] .selectGuides (filters: ${G(s)}; state: ${S(e)})`
     );
     const i = this.selectGuide(e, s, {
       ...t,
@@ -335,75 +243,75 @@ class z {
     }), { recordSelectQuery: r = !!((c = e.debug) != null && c.debugging) } = t, n = {
       limit: "all",
       opts: { ...t, recordSelectQuery: r }
-    }, u = E(e, s, n);
-    if (this.maybeRecordSelectResult(u), !i && !t.includeThrottled)
+    }, a = v(e, s, n);
+    if (this.maybeRecordSelectResult(a), !i && !t.includeThrottled)
       return [];
-    const o = [...u.values()];
-    if (!t.includeThrottled && _(e)) {
+    const o = [...a.values()];
+    if (!t.includeThrottled && b(e)) {
       const d = o.filter(
-        (l) => l.bypass_global_group_limit
-      ), g = o.length - d.length;
+        (k) => k.bypass_global_group_limit
+      ), l = o.length - d.length;
       return this.knock.log(
-        `[Guide] Throttling ${g} guides from selection, and returning ${d.length} guides`
+        `[Guide] Throttling ${l} guides from selection, and returning ${d.length} guides`
       ), d;
     }
     return this.knock.log(`[Guide] Returning ${o.length} guides from selection`), o;
   }
   selectGuide(e, s = {}, t = {}) {
-    var g, l, G;
+    var l, k, m;
     if (this.knock.log(
-      `[Guide] .selectGuide (filters: ${b(s)}; state: ${v(e)})`
+      `[Guide] .selectGuide (filters: ${G(s)}; state: ${S(e)})`
     ), Object.keys(e.guides).length === 0 && Object.keys(e.previewGuides).length === 0) {
       this.knock.log("[Guide] Exiting selection (no guides)");
       return;
     }
     this.stage || (this.stage = this.openGroupStage());
-    const { recordSelectQuery: i = !!((g = e.debug) != null && g.debugging) } = t, r = {
+    const { recordSelectQuery: i = !!((l = e.debug) != null && l.debugging) } = t, r = {
       limit: "one",
       opts: { ...t, recordSelectQuery: i }
-    }, n = E(e, s, r);
+    }, n = v(e, s, r);
     if (this.maybeRecordSelectResult(n), n.size === 0) {
       this.knock.log("[Guide] Selection found zero result");
       return;
     }
-    const [u, o] = [...n][0];
+    const [a, o] = [...n][0];
     if (this.knock.log(
       `[Guide] Selection found: \`${o.key}\` (total: ${n.size})`
     ), o.bypass_global_group_limit)
       return this.knock.log(`[Guide] Returning the unthrottled guide: ${o.key}`), o;
-    const c = (G = (l = e.debug) == null ? void 0 : l.focusedGuideKeys) == null ? void 0 : G[o.key], d = !t.includeThrottled && _(e);
+    const c = (m = (k = e.debug) == null ? void 0 : k.focusedGuideKeys) == null ? void 0 : m[o.key], d = !t.includeThrottled && b(e);
     switch (this.stage.status) {
       case "open": {
-        this.knock.log(`[Guide] Adding to the group stage: ${o.key}`), this.stage.ordered[u] = o.key;
+        this.knock.log(`[Guide] Adding to the group stage: ${o.key}`), this.stage.ordered[a] = o.key;
         return;
       }
       case "patch": {
-        if (this.knock.log(`[Guide] Patching the group stage: ${o.key}`), this.stage.ordered[u] = o.key, c)
+        if (this.knock.log(`[Guide] Patching the group stage: ${o.key}`), this.stage.ordered[a] = o.key, c)
           return this.knock.log(
-            `[Guide] Focused to return \`${o.key}\` (stage: ${m(this.stage)})`
+            `[Guide] Focused to return \`${o.key}\` (stage: ${p(this.stage)})`
           ), o;
         if (d) {
           this.knock.log(`[Guide] Throttling the selected guide: ${o.key}`);
           return;
         }
-        const k = this.stage.resolved === o.key ? o : void 0;
+        const g = this.stage.resolved === o.key ? o : void 0;
         return this.knock.log(
-          `[Guide] Returning \`${k == null ? void 0 : k.key}\` (stage: ${m(this.stage)})`
-        ), k;
+          `[Guide] Returning \`${g == null ? void 0 : g.key}\` (stage: ${p(this.stage)})`
+        ), g;
       }
       case "closed": {
         if (c)
           return this.knock.log(
-            `[Guide] Focused to return \`${o.key}\` (stage: ${m(this.stage)})`
+            `[Guide] Focused to return \`${o.key}\` (stage: ${p(this.stage)})`
           ), o;
         if (d) {
           this.knock.log(`[Guide] Throttling the selected guide: ${o.key}`);
           return;
         }
-        const k = this.stage.resolved === o.key ? o : void 0;
+        const g = this.stage.resolved === o.key ? o : void 0;
         return this.knock.log(
-          `[Guide] Returning \`${k == null ? void 0 : k.key}\` (stage: ${m(this.stage)})`
-        ), k;
+          `[Guide] Returning \`${g == null ? void 0 : g.key}\` (stage: ${p(this.stage)})`
+        ), g;
       }
     }
   }
@@ -413,18 +321,18 @@ class z {
     if (!e.metadata) return;
     const { opts: s, filters: t, limit: i } = e.metadata;
     if (!s.recordSelectQuery || !t.key && !t.type || !this.stage || this.stage.status === "closed") return;
-    const r = this.stage.results.key || {};
+    const r = this.stage.results.byKey || {};
     t.key && (r[t.key] = {
       ...r[t.key] || {},
       [i]: e
     });
-    const n = this.stage.results.type || {};
+    const n = this.stage.results.byType || {};
     t.type && (n[t.type] = {
       ...n[t.type] || {},
       [i]: e
     }), this.stage = {
       ...this.stage,
-      results: { key: r, type: n }
+      results: { byKey: r, byType: n }
     };
   }
   getStage() {
@@ -433,7 +341,7 @@ class z {
   openGroupStage() {
     this.knock.log("[Guide] Opening a new group stage");
     const {
-      orderResolutionDuration: e = U
+      orderResolutionDuration: e = D
     } = this.options, s = setTimeout(() => {
       this.closePendingGroupStage(), this.incrementCounter();
     }, e);
@@ -582,7 +490,7 @@ class z {
       // Get the next unarchived step.
       getStep() {
         var i, r, n;
-        return ((i = s.store.state.debug) == null ? void 0 : i.forcedGuideKey) === this.key || (n = (r = s.store.state.debug) == null ? void 0 : r.focusedGuideKeys) != null && n[this.key] ? this.steps[0] : this.steps.find((u) => !u.message.archived_at);
+        return ((i = s.store.state.debug) == null ? void 0 : i.forcedGuideKey) === this.key || (n = (r = s.store.state.debug) == null ? void 0 : r.focusedGuideKeys) != null && n[this.key] ? this.steps[0] : this.steps.find((a) => !a.message.archived_at);
       },
       // Check whether any of its steps have an engagement timestamp.
       hasEngagement() {
@@ -598,8 +506,8 @@ class z {
         markAsSeen() {
           return s.markAsSeen(t, this);
         },
-        markAsInteracted({ metadata: u } = {}) {
-          return s.markAsInteracted(t, this, u);
+        markAsInteracted({ metadata: a } = {}) {
+          return s.markAsInteracted(t, this, a);
         },
         markAsArchived() {
           return s.markAsArchived(t, this);
@@ -630,7 +538,7 @@ class z {
   formatQueryKey(e) {
     const t = Object.keys(e).sort().map(
       (r) => `${encodeURIComponent(r)}=${encodeURIComponent(e[r])}`
-    ).join("&"), i = j(this.knock.userId);
+    ).join("&"), i = U(this.knock.userId);
     return t ? `${i}?${t}` : i;
   }
   setStepMessageAttrs(e, s, t) {
@@ -638,11 +546,11 @@ class z {
     return t.archived_at && this.clearGroupStage(), this.store.setState((r) => {
       let n = r.guides[e];
       if (!n) return r;
-      const u = n.steps.map((d) => (d.ref !== s || (d.message = { ...d.message, ...t }, i = d), d));
-      n = i ? { ...n, steps: u } : n;
+      const a = n.steps.map((d) => (d.ref !== s || (d.message = { ...d.message, ...t }, i = d), d));
+      n = i ? { ...n, steps: a } : n;
       const o = { ...r.guides, [n.key]: n }, c = t.archived_at && !n.bypass_global_group_limit ? {
         ...r.guideGroupDisplayLogs,
-        [D]: t.archived_at
+        [R]: t.archived_at
       } : r.guideGroupDisplayLogs;
       return { ...r, guides: o, guideGroupDisplayLogs: c };
     }), i;
@@ -677,31 +585,19 @@ class z {
     this.patchClosedGroupStage(), this.store.setState((s) => {
       const t = [e.guide_group], i = e.guide_group.display_sequence_unthrottled || [], r = e.guide_group.display_sequence_throttled || [];
       let n = s.guides;
-      return n = i.reduce((u, o) => {
-        if (!u[o]) return u;
-        const c = { ...u[o], bypass_global_group_limit: !0 };
-        return { ...u, [o]: c };
-      }, n), n = r.reduce((u, o) => {
-        if (!u[o]) return u;
-        const c = { ...u[o], bypass_global_group_limit: !1 };
-        return { ...u, [o]: c };
+      return n = i.reduce((a, o) => {
+        if (!a[o]) return a;
+        const c = { ...a[o], bypass_global_group_limit: !0 };
+        return { ...a, [o]: c };
+      }, n), n = r.reduce((a, o) => {
+        if (!a[o]) return a;
+        const c = { ...a[o], bypass_global_group_limit: !1 };
+        return { ...a, [o]: c };
       }, n), { ...s, guides: n, guideGroups: t };
     });
   }
-  updatePreviewGuide({ data: e }) {
-    const s = this.localCopy(e.guide);
-    this.store.setState((t) => {
-      const i = { ...t.previewGuides, [s.key]: s };
-      return { ...t, previewGuides: i };
-    });
-  }
-  // Returns whether debug params have changed. For guide key, we only check
-  // presence since the exact value has no impact on fetch/subscribe
-  checkDebugStateChanged(e, s) {
-    return !!e.forcedGuideKey != !!s.forcedGuideKey || e.previewSessionId !== s.previewSessionId;
-  }
   listenForLocationChangesFromWindow() {
-    const e = p();
+    const e = f();
     if (e != null && e.history && (e != null && e.addEventListener)) {
       e.addEventListener("popstate", this.handleLocationChange), e.addEventListener("hashchange", this.handleLocationChange);
       const s = e.history.pushState, t = e.history.replaceState;
@@ -724,17 +620,16 @@ class z {
       );
   }
   removeLocationChangeEventListeners() {
-    const e = p();
+    const e = f();
     !(e != null && e.history) || !(e != null && e.removeEventListener) || (e.removeEventListener("popstate", this.handleLocationChange), e.removeEventListener("hashchange", this.handleLocationChange), this.pushStateFn && (e.history.pushState = this.pushStateFn, this.pushStateFn = void 0), this.replaceStateFn && (e.history.replaceState = this.replaceStateFn, this.replaceStateFn = void 0));
   }
   static getToolbarRunConfigFromUrl() {
-    return K();
+    return T();
   }
 }
 export {
-  f as DEBUG_QUERY_PARAMS,
-  z as KnockGuideClient,
-  Q as checkActivatable,
-  j as guidesApiRootPath
+  J as KnockGuideClient,
+  j as checkActivatable,
+  U as guidesApiRootPath
 };
 //# sourceMappingURL=client.mjs.map