@knocklabs/client 0.21.1 → 0.21.3

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

@@ -1,52 +1,53 @@
-var I = Object.defineProperty;
-var C = (u, e, t) => e in u ? I(u, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : u[e] = t;
-var c = (u, e, t) => C(u, typeof e != "symbol" ? e + "" : e, t);
-import { Store as E } from "@tanstack/store";
-import { URLPattern as w } from "urlpattern-polyfill";
-import { byKey as G, mockDefaultGroup as R, formatFilters as S, formatState as m, checkStateIfThrottled as y, formatGroupStage as v, DEFAULT_GROUP_KEY as P, newUrl as D, predicateUrlRules as A, predicateUrlPatterns as L, SelectionResult as $, findDefaultGroup as T } from "./helpers.mjs";
-const K = 50, O = 30 * 1e3, U = 3, g = {
+var E = Object.defineProperty;
+var w = (u, e, s) => e in u ? E(u, e, { enumerable: !0, configurable: !0, writable: !0, value: s }) : u[e] = s;
+var h = (u, e, s) => w(u, typeof e != "symbol" ? e + "" : e, s);
+import { Store as R } from "@tanstack/store";
+import { URLPattern as A } from "urlpattern-polyfill";
+import { byKey as S, mockDefaultGroup as P, formatFilters as v, formatState as b, checkStateIfThrottled as _, formatGroupStage as y, DEFAULT_GROUP_KEY as D, newUrl as K, predicateUrlRules as L, predicateUrlPatterns as $, findDefaultGroup as T } from "./helpers.mjs";
+import { SelectionResult as O } from "./types.mjs";
+const F = 50, U = 30 * 1e3, q = 3, f = {
   GUIDE_KEY: "knock_guide_key",
   PREVIEW_SESSION_ID: "knock_preview_session_id"
-}, f = "knock_guide_debug", l = () => {
+}, G = "knock_guide_debug", p = () => {
   if (typeof window < "u")
     return window;
-}, F = (u) => `/v1/users/${u}/guides`, b = () => {
-  const u = l();
+}, N = (u) => `/v1/users/${u}/guides`, I = () => {
+  const u = p();
   if (!u || !u.location)
     return { forcedGuideKey: null, previewSessionId: null };
-  const e = new URLSearchParams(u.location.search), t = e.get(g.GUIDE_KEY), s = e.get(
-    g.PREVIEW_SESSION_ID
+  const e = new URLSearchParams(u.location.search), s = e.get(f.GUIDE_KEY), t = e.get(
+    f.PREVIEW_SESSION_ID
   );
-  if (t || s) {
+  if (s || t) {
     if (u.localStorage)
       try {
-        const n = {
-          forcedGuideKey: t,
-          previewSessionId: s
+        const r = {
+          forcedGuideKey: s,
+          previewSessionId: t
         };
-        u.localStorage.setItem(f, JSON.stringify(n));
+        u.localStorage.setItem(G, JSON.stringify(r));
       } catch {
       }
     return {
-      forcedGuideKey: t,
-      previewSessionId: s
+      forcedGuideKey: s,
+      previewSessionId: t
     };
   }
-  let i = null, r = null;
+  let i = null, n = null;
   if (u.localStorage)
     try {
-      const n = u.localStorage.getItem(f);
-      if (n) {
-        const o = N(n);
-        i = o.forcedGuideKey, r = o.previewSessionId;
+      const r = u.localStorage.getItem(G);
+      if (r) {
+        const a = j(r);
+        i = a.forcedGuideKey, n = a.previewSessionId;
       }
     } catch {
     }
   return {
     forcedGuideKey: i,
-    previewSessionId: r
+    previewSessionId: n
   };
-}, N = (u) => {
+}, j = (u) => {
   try {
     const e = JSON.parse(u);
     return {
@@ -59,35 +60,35 @@ const K = 50, O = 30 * 1e3, U = 3, g = {
       previewSessionId: null
     };
   }
-}, _ = (u, e = {}) => {
-  const t = new $(), s = T(u.guideGroups);
-  if (!s) return t;
-  const i = s.display_sequence, r = u.location;
-  for (const [n, o] of i.entries()) {
-    const a = u.previewGuides[o] || u.guides[o];
-    !a || !q(a, e, {
+}, C = (u, e, s) => {
+  const t = new O(), i = T(u.guideGroups);
+  if (!i) return t;
+  const n = i.display_sequence, r = u.location;
+  for (const [a, o] of n.entries()) {
+    const c = u.previewGuides[o] || u.guides[o];
+    !c || !B(c, e, {
       location: r,
       ineligibleGuides: u.ineligibleGuides,
       debug: u.debug
-    }) || t.set(n, a);
-  }
-  return t.metadata = { guideGroup: s }, t;
-}, q = (u, e, { location: t, ineligibleGuides: s = {}, debug: i = {} }) => e.type && e.type !== u.type || e.key && e.key !== u.key ? !1 : i.forcedGuideKey ? i.forcedGuideKey === u.key : s[u.key] || !u.active || u.steps.every((n) => !!n.message.archived_at) ? !1 : j(u, t), j = (u, e) => {
-  const t = e ? D(e) : void 0, s = u.activation_url_rules || [], i = u.activation_url_patterns || [];
-  if (t && s.length > 0) {
-    if (!A(t, s)) return !1;
-  } else if (t && i.length > 0 && !L(t, i))
+    }) || t.set(a, c);
+  }
+  return t.metadata = { guideGroup: i, filters: e, ...s }, t;
+}, B = (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((r) => !!r.message.archived_at) ? !1 : M(u, s), M = (u, e) => {
+  const s = e ? K(e) : void 0, t = u.activation_url_rules || [], i = u.activation_url_patterns || [];
+  if (s && t.length > 0) {
+    if (!L(s, t)) return !1;
+  } else if (s && i.length > 0 && !$(s, i))
     return !1;
   return !0;
 };
-class W {
-  constructor(e, t, s = {}, i = {}) {
-    c(this, "store");
+class V {
+  constructor(e, s, t = {}, i = {}) {
+    h(this, "store");
     // Phoenix channels for real time guide updates over websocket
-    c(this, "socket");
-    c(this, "socketChannel");
-    c(this, "socketChannelTopic");
-    c(this, "socketEventTypes", [
+    h(this, "socket");
+    h(this, "socketChannel");
+    h(this, "socketChannelTopic");
+    h(this, "socketEventTypes", [
       "guide.added",
       "guide.updated",
       "guide.removed",
@@ -95,57 +96,57 @@ class W {
       "guide_group.updated",
       "guide.live_preview_updated"
     ]);
-    c(this, "subscribeRetryCount", 0);
+    h(this, "subscribeRetryCount", 0);
     // Original history methods to monkey patch, or restore in cleanups.
-    c(this, "pushStateFn");
-    c(this, "replaceStateFn");
+    h(this, "pushStateFn");
+    h(this, "replaceStateFn");
     // Guides that are competing to render are "staged" first without rendering
     // and ranked based on its relative order in the group over a duration of time
     // to resolve and render the prevailing one.
-    c(this, "stage");
-    c(this, "counterIntervalId");
+    h(this, "stage");
+    h(this, "counterIntervalId");
     // Define as an arrow func property to always bind this to the class instance.
-    c(this, "handleLocationChange", () => {
+    h(this, "handleLocationChange", () => {
       this.knock.log("[Guide] .handleLocationChange");
-      const e = l();
+      const e = p();
       if (!(e != null && e.location)) return;
-      const t = e.location.href;
-      if (this.store.state.location === t) return;
-      if (this.knock.log(`[Guide] Detected a location change: ${t}`), !this.options.trackDebugParams) {
-        this.setLocation(t);
+      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 s = this.store.state.debug || {}, i = b();
-      this.setLocation(t, { debug: i }), this.checkDebugStateChanged(
-        s,
+      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());
     });
-    var p;
-    this.knock = e, this.channelId = t, this.targetParams = s, this.options = i;
+    var g;
+    this.knock = e, this.channelId = s, this.targetParams = t, this.options = i;
     const {
-      trackLocationFromWindow: r = !0,
+      trackLocationFromWindow: n = !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: o = O
-    } = i, a = l(), d = r ? (p = a == null ? void 0 : a.location) == null ? void 0 : p.href : void 0, h = n ? b() : void 0;
-    this.store = new E({
+      trackDebugParams: r = !1,
+      throttleCheckInterval: a = U
+    } = i, o = p(), c = n ? (g = o == null ? void 0 : o.location) == null ? void 0 : g.href : void 0, d = r ? I() : void 0;
+    this.store = new R({
       guideGroups: [],
       guideGroupDisplayLogs: {},
       guides: {},
       ineligibleGuides: {},
       previewGuides: {},
       queries: {},
-      location: d,
+      location: c,
       // Increment to update the state store and trigger re-selection.
       counter: 0,
-      debug: h
+      debug: d
     });
-    const { socket: k } = this.knock.client();
-    this.socket = k, this.socketChannelTopic = `guides:${t}`, r && this.listenForLocationChangesFromWindow(), o && this.startCounterInterval(o), this.knock.log("[Guide] Initialized a guide client");
+    const { socket: l } = this.knock.client();
+    this.socket = l, this.socketChannelTopic = `guides:${s}`, n && this.listenForLocationChangesFromWindow(), a && this.startCounterInterval(a), 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 }));
@@ -163,52 +164,52 @@ class W {
   }
   async fetch(e) {
     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];
+    const s = this.buildQueryParams(e == null ? void 0 : e.filters), t = this.formatQueryKey(s), i = this.store.state.queries[t];
     if (i)
       return i;
-    this.store.setState((n) => ({
-      ...n,
-      queries: { ...n.queries, [s]: { status: "loading" } }
+    this.store.setState((r) => ({
+      ...r,
+      queries: { ...r.queries, [t]: { status: "loading" } }
     }));
-    let r;
+    let n;
     try {
       this.knock.log("[Guide] Fetching all eligible guides");
-      const n = await this.knock.user.getGuides(this.channelId, t);
-      r = { status: "ok" };
+      const r = await this.knock.user.getGuides(this.channelId, s);
+      n = { status: "ok" };
       const {
-        entries: o,
-        guide_groups: a,
-        guide_group_display_logs: d,
-        ineligible_guides: h
-      } = n;
-      this.knock.log("[Guide] Loading fetched guides"), this.store.setState((k) => ({
-        ...k,
-        guideGroups: (a == null ? void 0 : a.length) > 0 ? a : [R(o)],
-        guideGroupDisplayLogs: d || {},
-        guides: G(o.map((p) => this.localCopy(p))),
-        ineligibleGuides: G(h || []),
-        queries: { ...k.queries, [s]: r }
+        entries: a,
+        guide_groups: o,
+        guide_group_display_logs: c,
+        ineligible_guides: d
+      } = r;
+      this.knock.log("[Guide] Loading fetched guides"), this.store.setState((l) => ({
+        ...l,
+        guideGroups: (o == null ? void 0 : o.length) > 0 ? o : [P(a)],
+        guideGroupDisplayLogs: c || {},
+        guides: S(a.map((g) => this.localCopy(g))),
+        ineligibleGuides: S(d || []),
+        queries: { ...l.queries, [t]: n }
       }));
-    } catch (n) {
-      r = { status: "error", error: n }, this.store.setState((o) => ({
-        ...o,
-        queries: { ...o.queries, [s]: r }
+    } catch (r) {
+      n = { status: "error", error: r }, this.store.setState((a) => ({
+        ...a,
+        queries: { ...a.queries, [t]: n }
       }));
     }
-    return r;
+    return n;
   }
   subscribe() {
     if (!this.socket) return;
     this.knock.failIfNotAuthenticated(), this.knock.log("[Guide] Subscribing to real time updates"), this.socket.isConnected() || this.socket.connect(), this.socketChannel && this.unsubscribe();
-    const e = this.store.state.debug, t = {
+    const e = this.store.state.debug, s = {
       ...this.targetParams,
       user_id: this.knock.userId,
       force_all_guides: e != null && e.forcedGuideKey || e != null && e.debugging ? !0 : void 0,
       preview_session_id: (e == null ? void 0 : e.previewSessionId) || void 0
-    }, s = this.socket.channel(this.socketChannelTopic, t);
+    }, t = this.socket.channel(this.socketChannelTopic, s);
     for (const i of this.socketEventTypes)
-      s.on(i, (r) => this.handleSocketEvent(r));
-    ["closed", "errored"].includes(s.state) && (this.subscribeRetryCount = 0, s.join().receive("ok", () => {
+      t.on(i, (n) => this.handleSocketEvent(n));
+    ["closed", "errored"].includes(t.state) && (this.subscribeRetryCount = 0, t.join().receive("ok", () => {
       this.knock.log("[Guide] Successfully joined channel");
     }).receive("error", (i) => {
       this.knock.log(
@@ -216,10 +217,10 @@ class W {
       ), this.handleChannelJoinError();
     }).receive("timeout", () => {
       this.knock.log("[Guide] Channel join timed out"), this.handleChannelJoinError();
-    })), this.socketChannel = s;
+    })), this.socketChannel = t;
   }
   handleChannelJoinError() {
-    if (this.subscribeRetryCount >= U) {
+    if (this.subscribeRetryCount >= q) {
       this.knock.log(
         `[Guide] Channel join max retry limit reached: ${this.subscribeRetryCount}`
       ), this.unsubscribe();
@@ -236,12 +237,12 @@ class W {
     }
   }
   handleSocketEvent(e) {
-    const { event: t, data: s } = e;
-    switch (t) {
+    const { event: s, data: t } = e;
+    switch (s) {
       case "guide.added":
         return this.addOrReplaceGuide(e);
       case "guide.updated":
-        return s.eligible ? this.addOrReplaceGuide(e) : this.removeGuide(e);
+        return t.eligible ? this.addOrReplaceGuide(e) : this.removeGuide(e);
       case "guide.removed":
         return this.removeGuide(e);
       case "guide_group.added":
@@ -253,13 +254,13 @@ class W {
         return;
     }
   }
-  setLocation(e, t = {}) {
-    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 : {};
+  setLocation(e, s = {}) {
+    this.knock.log(`[Guide] .setLocation (loc=${e})`), this.clearGroupStage(), this.knock.log("[Guide] Updating the tracked location"), this.store.setState((t) => {
+      var n;
+      const i = (n = s == null ? void 0 : s.debug) != null && n.previewSessionId ? t.previewGuides : {};
       return {
-        ...s,
         ...t,
+        ...s,
         previewGuides: i,
         location: e
       };
@@ -267,112 +268,173 @@ class W {
   }
   exitDebugMode() {
     this.knock.log("[Guide] Exiting debug mode");
-    const e = l();
+    const e = p();
     if (e != null && e.localStorage)
       try {
-        e.localStorage.removeItem(f);
+        e.localStorage.removeItem(G);
       } catch {
       }
-    if (this.store.setState((t) => ({
-      ...t,
-      debug: { forcedGuideKey: null, previewSessionId: null },
+    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 t = new URL(e.location.href);
-      (t.searchParams.has(g.GUIDE_KEY) || t.searchParams.has(g.PREVIEW_SESSION_ID)) && (t.searchParams.delete(g.GUIDE_KEY), t.searchParams.delete(g.PREVIEW_SESSION_ID), e.location.href = t.toString());
+      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 s;
+    var t;
     this.knock.log("[Guide] .setDebug()");
-    const t = !((s = this.store.state.debug) != null && s.debugging);
+    const s = !((t = this.store.state.debug) != null && t.debugging);
     this.store.setState((i) => ({
       ...i,
-      debug: { ...e, debugging: !0 }
-    })), t && (this.knock.log(
+      debug: {
+        skipEngagementTracking: !0,
+        ignoreDisplayInterval: !0,
+        focusedGuideKeys: {},
+        ...e,
+        debugging: !0
+      }
+    })), s && (this.knock.log(
       "[Guide] Start debugging, refetching guides and resubscribing to the websocket channel"
     ), this.fetch(), this.subscribe());
   }
   unsetDebug() {
-    var t;
+    var s;
     this.knock.log("[Guide] .unsetDebug()");
-    const e = (t = this.store.state.debug) == null ? void 0 : t.debugging;
-    this.store.setState((s) => ({ ...s, debug: void 0 })), e && (this.knock.log(
+    const e = (s = this.store.state.debug) == null ? void 0 : s.debugging;
+    this.store.setState((t) => ({ ...t, debug: void 0 })), e && (this.knock.log(
       "[Guide] Stop debugging, refetching guides and resubscribing to the websocket channel"
     ), this.fetch(), this.subscribe());
   }
   //
   // Store selector
   //
-  selectGuides(e, t = {}, s = {}) {
-    if (this.knock.log(
-      `[Guide] .selectGuides (filters: ${S(t)}; state: ${m(e)})`
-    ), !this.selectGuide(e, t, s))
+  selectGuides(e, s = {}, t = {}) {
+    var c;
+    this.knock.log(
+      `[Guide] .selectGuides (filters: ${v(s)}; state: ${b(e)})`
+    );
+    const i = this.selectGuide(e, s, {
+      ...t,
+      // Don't record this result, not the actual query result we need.
+      recordSelectQuery: !1
+    }), { recordSelectQuery: n = !!((c = e.debug) != null && c.debugging) } = t, r = {
+      limit: "all",
+      opts: { ...t, recordSelectQuery: n }
+    }, a = C(e, s, r);
+    if (this.maybeRecordSelectResult(a), !i && !t.includeThrottled)
       return [];
-    const r = [..._(e, t).values()];
-    if (!s.includeThrottled && y(e)) {
-      const n = r.filter(
-        (a) => a.bypass_global_group_limit
-      ), o = r.length - n.length;
+    const o = [...a.values()];
+    if (!t.includeThrottled && _(e)) {
+      const d = o.filter(
+        (g) => g.bypass_global_group_limit
+      ), l = o.length - d.length;
       return this.knock.log(
-        `[Guide] Throttling ${o} guides from selection, and returning ${n.length} guides`
-      ), n;
+        `[Guide] Throttling ${l} guides from selection, and returning ${d.length} guides`
+      ), d;
     }
-    return this.knock.log(`[Guide] Returning ${r.length} guides from selection`), r;
+    return this.knock.log(`[Guide] Returning ${o.length} guides from selection`), o;
   }
-  selectGuide(e, t = {}, s = {}) {
+  selectGuide(e, s = {}, t = {}) {
+    var l, g, m;
     if (this.knock.log(
-      `[Guide] .selectGuide (filters: ${S(t)}; state: ${m(e)})`
+      `[Guide] .selectGuide (filters: ${v(s)}; state: ${b(e)})`
     ), Object.keys(e.guides).length === 0 && Object.keys(e.previewGuides).length === 0) {
       this.knock.log("[Guide] Exiting selection (no guides)");
       return;
     }
-    const i = _(e, t);
-    if (i.size === 0) {
+    this.stage || (this.stage = this.openGroupStage());
+    const { recordSelectQuery: i = !!((l = e.debug) != null && l.debugging) } = t, n = {
+      limit: "one",
+      opts: { ...t, recordSelectQuery: i }
+    }, r = C(e, s, n);
+    if (this.maybeRecordSelectResult(r), r.size === 0) {
       this.knock.log("[Guide] Selection found zero result");
       return;
     }
-    const [r, n] = [...i][0];
+    const [a, o] = [...r][0];
     if (this.knock.log(
-      `[Guide] Selection found: \`${n.key}\` (total: ${i.size})`
-    ), n.bypass_global_group_limit)
-      return this.knock.log(`[Guide] Returning the unthrottled guide: ${n.key}`), n;
-    if (!s.includeThrottled && y(e)) {
-      this.knock.log(`[Guide] Throttling the selected guide: ${n.key}`);
-      return;
-    }
-    switch (this.stage || (this.stage = this.openGroupStage()), this.stage.status) {
+      `[Guide] Selection found: \`${o.key}\` (total: ${r.size})`
+    ), o.bypass_global_group_limit)
+      return this.knock.log(`[Guide] Returning the unthrottled guide: ${o.key}`), o;
+    const c = (m = (g = e.debug) == null ? void 0 : g.focusedGuideKeys) == null ? void 0 : m[o.key], d = !t.includeThrottled && _(e);
+    switch (this.stage.status) {
       case "open": {
-        this.knock.log(`[Guide] Adding to the group stage: ${n.key}`), this.stage.ordered[r] = n.key;
+        this.knock.log(`[Guide] Adding to the group stage: ${o.key}`), this.stage.ordered[a] = o.key;
         return;
       }
       case "patch": {
-        this.knock.log(`[Guide] Patching the group stage: ${n.key}`), this.stage.ordered[r] = n.key;
-        const o = this.stage.resolved === n.key ? n : void 0;
+        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: ${y(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;
         return this.knock.log(
-          `[Guide] Returning \`${o == null ? void 0 : o.key}\` (stage: ${v(this.stage)})`
-        ), o;
+          `[Guide] Returning \`${k == null ? void 0 : k.key}\` (stage: ${y(this.stage)})`
+        ), k;
       }
       case "closed": {
-        const o = this.stage.resolved === n.key ? n : void 0;
+        if (c)
+          return this.knock.log(
+            `[Guide] Focused to return \`${o.key}\` (stage: ${y(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;
         return this.knock.log(
-          `[Guide] Returning \`${o == null ? void 0 : o.key}\` (stage: ${v(this.stage)})`
-        ), o;
+          `[Guide] Returning \`${k == null ? void 0 : k.key}\` (stage: ${y(this.stage)})`
+        ), k;
       }
     }
   }
+  // Record select query results by accumulating them by 1) key or type first,
+  // and then 2) "one" or "all".
+  maybeRecordSelectResult(e) {
+    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 n = this.stage.results.key || {};
+    t.key && (n[t.key] = {
+      ...n[t.key] || {},
+      [i]: e
+    });
+    const r = this.stage.results.type || {};
+    t.type && (r[t.type] = {
+      ...r[t.type] || {},
+      [i]: e
+    }), this.stage = {
+      ...this.stage,
+      results: { key: n, type: r }
+    };
+  }
+  getStage() {
+    return this.stage;
+  }
   openGroupStage() {
     this.knock.log("[Guide] Opening a new group stage");
     const {
-      orderResolutionDuration: e = K
-    } = this.options, t = setTimeout(() => {
+      orderResolutionDuration: e = F
+    } = this.options, s = setTimeout(() => {
       this.closePendingGroupStage(), this.incrementCounter();
     }, e);
     return this.stage = {
       status: "open",
       ordered: [],
-      timeoutId: t
+      results: {},
+      timeoutId: s
     }, this.stage;
   }
   // Close the current non-closed stage to resolve the prevailing guide up next
@@ -380,7 +442,7 @@ class W {
   closePendingGroupStage() {
     if (this.knock.log("[Guide] .closePendingGroupStage"), !this.stage || this.stage.status === "closed") return;
     this.ensureClearTimeout();
-    const e = this.stage.ordered.find((t) => t !== void 0);
+    const e = this.stage.ordered.find((s) => s !== void 0);
     return this.knock.log(
       `[Guide] Closing the current group stage: resolved=${e}`
     ), this.stage = {
@@ -396,16 +458,16 @@ class W {
   // rendered until we are ready to resolve the updated stage and re-render.
   // Note, must be called ahead of updating the state store.
   patchClosedGroupStage() {
-    var s;
-    if (this.knock.log("[Guide] .patchClosedGroupStage"), ((s = this.stage) == null ? void 0 : s.status) !== "closed") return;
-    const { orderResolutionDuration: e = 0 } = this.options, t = setTimeout(() => {
+    var t;
+    if (this.knock.log("[Guide] .patchClosedGroupStage"), ((t = this.stage) == null ? void 0 : t.status) !== "closed") return;
+    const { orderResolutionDuration: e = 0 } = this.options, s = setTimeout(() => {
       this.closePendingGroupStage(), this.incrementCounter();
     }, e);
     return this.ensureClearTimeout(), this.knock.log("[Guide] Patching the current group stage"), this.stage = {
       ...this.stage,
       status: "patch",
       ordered: [],
-      timeoutId: t
+      timeoutId: s
     }, this.stage;
   }
   clearGroupStage() {
@@ -417,11 +479,11 @@ class W {
   }
   // Test helpers to open and close the group stage to return the select result
   // immediately.
-  _selectGuide(e, t = {}, s = {}) {
-    return this.openGroupStage(), this.selectGuide(e, t, s), this.closePendingGroupStage(), this.selectGuide(e, t, s);
+  _selectGuide(e, s = {}, t = {}) {
+    return this.openGroupStage(), this.selectGuide(e, s, t), this.closePendingGroupStage(), this.selectGuide(e, s, t);
   }
-  _selectGuides(e, t = {}, s = {}) {
-    return this.openGroupStage(), this.selectGuides(e, t, s), this.closePendingGroupStage(), this.selectGuides(e, t, s);
+  _selectGuides(e, s = {}, t = {}) {
+    return this.openGroupStage(), this.selectGuides(e, s, t), this.closePendingGroupStage(), this.selectGuides(e, s, t);
   }
   //
   // Engagement event handlers
@@ -429,211 +491,227 @@ class W {
   // Make an optimistic update on the client side first, then send an engagement
   // event to the backend.
   //
-  async markAsSeen(e, t) {
-    if (t.message.seen_at) return;
+  async markAsSeen(e, s) {
+    if (s.message.seen_at) return;
     this.knock.log(
-      `[Guide] Marking as seen (Guide key: ${e.key}, Step ref:${t.ref})`
+      `[Guide] Marking as seen (Guide key: ${e.key}, Step ref:${s.ref})`
     );
-    const s = this.setStepMessageAttrs(e.key, t.ref, {
+    const t = this.setStepMessageAttrs(e.key, s.ref, {
       seen_at: (/* @__PURE__ */ new Date()).toISOString()
     });
-    if (!s) return;
+    if (!t) return;
+    if (this.shouldSkipEngagementApi())
+      return this.knock.log(
+        "[Guide] Skipping engagement API call for markAsSeen (debug mode)"
+      ), t;
     const i = {
-      ...this.buildEngagementEventBaseParams(e, s),
-      content: s.content,
+      ...this.buildEngagementEventBaseParams(e, t),
+      content: t.content,
       data: this.targetParams.data
     };
     return this.knock.user.markGuideStepAs(
       "seen",
       i
-    ), s;
+    ), t;
   }
-  async markAsInteracted(e, t, s) {
+  async markAsInteracted(e, s, t) {
     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:${s.ref})`
     );
-    const i = (/* @__PURE__ */ new Date()).toISOString(), r = this.setStepMessageAttrs(e.key, t.ref, {
+    const i = (/* @__PURE__ */ new Date()).toISOString(), n = this.setStepMessageAttrs(e.key, s.ref, {
       read_at: i,
       interacted_at: i
     });
-    if (!r) return;
-    const n = {
-      ...this.buildEngagementEventBaseParams(e, r),
-      metadata: s
+    if (!n) return;
+    if (this.shouldSkipEngagementApi())
+      return this.knock.log(
+        "[Guide] Skipping engagement API call for markAsInteracted (debug mode)"
+      ), n;
+    const r = {
+      ...this.buildEngagementEventBaseParams(e, n),
+      metadata: t
     };
-    return this.knock.user.markGuideStepAs("interacted", n), r;
+    return this.knock.user.markGuideStepAs("interacted", r), n;
   }
-  async markAsArchived(e, t) {
-    if (t.message.archived_at) return;
+  async markAsArchived(e, s) {
+    if (s.message.archived_at) return;
     this.knock.log(
-      `[Guide] Marking as archived (Guide key: ${e.key}, Step ref:${t.ref})`
+      `[Guide] Marking as archived (Guide key: ${e.key}, Step ref:${s.ref})`
     );
-    const s = this.setStepMessageAttrs(e.key, t.ref, {
+    const t = this.setStepMessageAttrs(e.key, s.ref, {
       archived_at: (/* @__PURE__ */ new Date()).toISOString()
     });
-    if (!s) return;
-    const i = this.buildEngagementEventBaseParams(e, s);
+    if (!t) return;
+    if (this.shouldSkipEngagementApi())
+      return this.knock.log(
+        "[Guide] Skipping engagement API call for markAsArchived (debug mode)"
+      ), t;
+    const i = this.buildEngagementEventBaseParams(e, t);
     return this.knock.user.markGuideStepAs(
       "archived",
       {
         ...i,
         unthrottled: e.bypass_global_group_limit
       }
-    ), s;
+    ), t;
+  }
+  shouldSkipEngagementApi() {
+    var e;
+    return !!((e = this.store.state.debug) != null && e.skipEngagementTracking);
   }
   //
   // Helpers
   //
   localCopy(e) {
-    const t = this, s = {
+    const s = this, t = {
       ...e,
       // Get the next unarchived step.
       getStep() {
-        var i;
-        return ((i = t.store.state.debug) == null ? void 0 : i.forcedGuideKey) === this.key ? this.steps[0] : this.steps.find((r) => !r.message.archived_at);
+        var i, n, r;
+        return ((i = s.store.state.debug) == null ? void 0 : i.forcedGuideKey) === this.key || (r = (n = s.store.state.debug) == null ? void 0 : n.focusedGuideKeys) != null && r[this.key] ? this.steps[0] : this.steps.find((a) => !a.message.archived_at);
       }
     };
-    return s.getStep = s.getStep.bind(s), s.steps = e.steps.map(({ message: i, ...r }) => {
-      const n = {
-        ...r,
+    return t.getStep = t.getStep.bind(t), t.steps = e.steps.map(({ message: i, ...n }) => {
+      const r = {
+        ...n,
         message: { ...i },
         markAsSeen() {
-          return t.markAsSeen(s, this);
+          return s.markAsSeen(t, this);
         },
-        markAsInteracted({ metadata: o } = {}) {
-          return t.markAsInteracted(s, this, o);
+        markAsInteracted({ metadata: a } = {}) {
+          return s.markAsInteracted(t, this, a);
         },
         markAsArchived() {
-          return t.markAsArchived(s, this);
+          return s.markAsArchived(t, this);
         }
       };
-      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) => ({
+      return r.markAsSeen = r.markAsSeen.bind(r), r.markAsInteracted = r.markAsInteracted.bind(r), r.markAsArchived = r.markAsArchived.bind(r), r;
+    }), t.activation_url_patterns = e.activation_url_patterns.map((i) => ({
       ...i,
-      pattern: new w({
+      pattern: new A({
         pathname: i.pathname ?? void 0,
         search: i.search ?? void 0
       })
-    })), s;
+    })), t;
   }
   buildQueryParams(e = {}) {
-    const t = {
+    const s = {
       ...this.targetParams,
       ...e
-    }, s = this.store.state.debug;
-    (s != null && s.forcedGuideKey || s != null && s.debugging) && (t.force_all_guides = !0);
+    }, t = this.store.state.debug;
+    (t != null && t.forcedGuideKey || t != null && t.debugging) && (s.force_all_guides = !0);
     let i = Object.fromEntries(
-      Object.entries(t).filter(
-        ([r, n]) => n != null
+      Object.entries(s).filter(
+        ([n, r]) => r != null
       )
     );
     return i = i.data ? { ...i, data: JSON.stringify(i.data) } : i, i;
   }
   formatQueryKey(e) {
-    const s = Object.keys(e).sort().map(
-      (r) => `${encodeURIComponent(r)}=${encodeURIComponent(e[r])}`
-    ).join("&"), i = F(this.knock.userId);
-    return s ? `${i}?${s}` : i;
+    const t = Object.keys(e).sort().map(
+      (n) => `${encodeURIComponent(n)}=${encodeURIComponent(e[n])}`
+    ).join("&"), i = N(this.knock.userId);
+    return t ? `${i}?${t}` : i;
   }
-  setStepMessageAttrs(e, t, s) {
+  setStepMessageAttrs(e, s, t) {
     let i;
-    return s.archived_at && this.clearGroupStage(), this.store.setState((r) => {
-      let n = r.guides[e];
-      if (!n) return r;
-      const o = n.steps.map((h) => (h.ref !== t || (h.message = { ...h.message, ...s }, i = h), h));
-      n = i ? { ...n, steps: o } : n;
-      const a = { ...r.guides, [n.key]: n }, d = s.archived_at && !n.bypass_global_group_limit ? {
-        ...r.guideGroupDisplayLogs,
-        [P]: s.archived_at
-      } : r.guideGroupDisplayLogs;
-      return { ...r, guides: a, guideGroupDisplayLogs: d };
+    return t.archived_at && this.clearGroupStage(), this.store.setState((n) => {
+      let r = n.guides[e];
+      if (!r) return n;
+      const a = r.steps.map((d) => (d.ref !== s || (d.message = { ...d.message, ...t }, i = d), d));
+      r = i ? { ...r, steps: a } : r;
+      const o = { ...n.guides, [r.key]: r }, c = t.archived_at && !r.bypass_global_group_limit ? {
+        ...n.guideGroupDisplayLogs,
+        [D]: t.archived_at
+      } : n.guideGroupDisplayLogs;
+      return { ...n, guides: o, guideGroupDisplayLogs: c };
     }), i;
   }
-  buildEngagementEventBaseParams(e, t) {
+  buildEngagementEventBaseParams(e, s) {
     return {
       channel_id: e.channel_id,
       guide_key: e.key,
       guide_id: e.id,
-      guide_step_ref: t.ref,
+      guide_step_ref: s.ref,
       // Can be used for scoping guide messages.
       tenant: this.targetParams.tenant
     };
   }
   addOrReplaceGuide({ data: e }) {
     this.patchClosedGroupStage();
-    const t = this.localCopy(e.guide);
-    this.store.setState((s) => {
-      const i = { ...s.guides, [t.key]: t };
-      return { ...s, guides: i };
+    const s = this.localCopy(e.guide);
+    this.store.setState((t) => {
+      const i = { ...t.guides, [s.key]: s };
+      return { ...t, guides: i };
     });
   }
   removeGuide({ data: e }) {
-    this.patchClosedGroupStage(), this.store.setState((t) => {
-      const { [e.guide.key]: s, ...i } = t.guides;
-      return { ...t, guides: i };
+    this.patchClosedGroupStage(), this.store.setState((s) => {
+      const { [e.guide.key]: t, ...i } = s.guides;
+      return { ...s, guides: i };
     });
   }
   addOrReplaceGuideGroup({
     data: e
   }) {
-    this.patchClosedGroupStage(), this.store.setState((t) => {
-      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, a) => {
-        if (!o[a]) return o;
-        const d = { ...o[a], bypass_global_group_limit: !0 };
-        return { ...o, [a]: d };
-      }, n), n = r.reduce((o, a) => {
-        if (!o[a]) return o;
-        const d = { ...o[a], bypass_global_group_limit: !1 };
-        return { ...o, [a]: d };
-      }, n), { ...t, guides: n, guideGroups: s };
+    this.patchClosedGroupStage(), this.store.setState((s) => {
+      const t = [e.guide_group], i = e.guide_group.display_sequence_unthrottled || [], n = e.guide_group.display_sequence_throttled || [];
+      let r = s.guides;
+      return r = i.reduce((a, o) => {
+        if (!a[o]) return a;
+        const c = { ...a[o], bypass_global_group_limit: !0 };
+        return { ...a, [o]: c };
+      }, r), r = n.reduce((a, o) => {
+        if (!a[o]) return a;
+        const c = { ...a[o], bypass_global_group_limit: !1 };
+        return { ...a, [o]: c };
+      }, r), { ...s, guides: r, guideGroups: t };
     });
   }
   updatePreviewGuide({ data: e }) {
-    const t = this.localCopy(e.guide);
-    this.store.setState((s) => {
-      const i = { ...s.previewGuides, [t.key]: t };
-      return { ...s, previewGuides: i };
+    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, t) {
-    return !!e.forcedGuideKey != !!t.forcedGuideKey || e.previewSessionId !== t.previewSessionId;
+  checkDebugStateChanged(e, s) {
+    return !!e.forcedGuideKey != !!s.forcedGuideKey || e.previewSessionId !== s.previewSessionId;
   }
   listenForLocationChangesFromWindow() {
-    const e = l();
+    const e = p();
     if (e != null && e.history && (e != null && e.addEventListener)) {
       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, r, n) => {
-          Reflect.apply(i, r, n), setTimeout(() => {
+      const s = e.history.pushState, t = e.history.replaceState;
+      e.history.pushState = new Proxy(s, {
+        apply: (i, n, r) => {
+          Reflect.apply(i, n, r), setTimeout(() => {
             this.handleLocationChange();
           }, 0);
         }
-      }), e.history.replaceState = new Proxy(s, {
-        apply: (i, r, n) => {
-          Reflect.apply(i, r, n), setTimeout(() => {
+      }), e.history.replaceState = new Proxy(t, {
+        apply: (i, n, r) => {
+          Reflect.apply(i, n, r), setTimeout(() => {
             this.handleLocationChange();
           }, 0);
         }
-      }), this.pushStateFn = t, this.replaceStateFn = s;
+      }), this.pushStateFn = s, this.replaceStateFn = t;
     } else
       this.knock.log(
         "[Guide] Unable to access the `window.history` object to detect location changes"
       );
   }
   removeLocationChangeEventListeners() {
-    const e = l();
+    const e = p();
     !(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));
   }
 }
 export {
-  g as DEBUG_QUERY_PARAMS,
-  W as KnockGuideClient,
-  j as checkActivatable,
-  F as guidesApiRootPath
+  f as DEBUG_QUERY_PARAMS,
+  V as KnockGuideClient,
+  M as checkActivatable,
+  N as guidesApiRootPath
 };
 //# sourceMappingURL=client.mjs.map