@knocklabs/client 0.13.0 → 0.14.0

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

@@ -0,0 +1,225 @@
+var k = Object.defineProperty;
+var l = (o, e, t) => e in o ? k(o, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : o[e] = t;
+var u = (o, e, t) => l(o, typeof e != "symbol" ? e + "" : e, t);
+import { Store as m } from "@tanstack/store";
+const h = (o) => [...o].sort(
+  (e, t) => t.priority - e.priority || new Date(t.inserted_at).getTime() - new Date(e.inserted_at).getTime()
+), g = (o) => `/v1/users/${o}/guides`;
+class p {
+  constructor(e, t, s = {}) {
+    u(this, "store");
+    // Phoenix channels for real time guide updates over websocket
+    u(this, "socket");
+    u(this, "socketChannel");
+    u(this, "socketChannelTopic");
+    u(this, "socketEventTypes", ["guide.added", "guide.updated", "guide.removed"]);
+    this.knock = e, this.channelId = t, this.targetParams = s, this.store = new m({
+      guides: [],
+      queries: {}
+    });
+    const { socket: r } = this.knock.client();
+    this.socket = r, this.socketChannelTopic = `guides:${t}`, this.knock.log("[Guide] Initialized a guide client");
+  }
+  async fetch(e) {
+    this.knock.failIfNotAuthenticated(), this.knock.log("[Guide] Loading all eligible guides");
+    const t = this.buildQueryParams(e == null ? void 0 : e.filters), s = this.formatQueryKey(t), r = this.store.state.queries[s];
+    if (r)
+      return r;
+    this.store.setState((i) => ({
+      ...i,
+      queries: { ...i.queries, [s]: { status: "loading" } }
+    }));
+    let n;
+    try {
+      const i = await this.knock.user.getGuides(this.channelId, t);
+      n = { status: "ok" }, this.store.setState((a) => ({
+        ...a,
+        // For now assume a single fetch to get all eligible guides. When/if
+        // we implement incremental loads, then this will need to be a merge
+        // and sort operation.
+        guides: i.entries.map((d) => this.localCopy(d)),
+        queries: { ...a.queries, [s]: n }
+      }));
+    } catch (i) {
+      n = { status: "error", error: i }, this.store.setState((a) => ({
+        ...a,
+        queries: { ...a.queries, [s]: n }
+      }));
+    }
+    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.targetParams, user_id: this.knock.userId }, t = this.socket.channel(this.socketChannelTopic, e);
+    for (const s of this.socketEventTypes)
+      t.on(s, (r) => this.handleSocketEvent(r));
+    ["closed", "errored"].includes(t.state) && t.join(), this.socketChannel = t;
+  }
+  unsubscribe() {
+    if (this.socketChannel) {
+      this.knock.log("[Guide] Unsubscribing from real time updates");
+      for (const e of this.socketEventTypes)
+        this.socketChannel.off(e);
+      this.socketChannel.leave(), this.socketChannel = void 0;
+    }
+  }
+  handleSocketEvent(e) {
+    const { event: t, data: s } = e;
+    switch (t) {
+      case "guide.added":
+        return this.addGuide(e);
+      case "guide.updated":
+        return s.eligible ? this.replaceOrAddGuide(e) : this.removeGuide(e);
+      case "guide.removed":
+        return this.removeGuide(e);
+      default:
+        return;
+    }
+  }
+  //
+  // Store selector
+  //
+  select(e, t = {}) {
+    return e.guides.filter((s) => !(t.type && t.type !== s.type || t.key && t.key !== s.key));
+  }
+  //
+  // Engagement event handlers
+  //
+  // Make an optimistic update on the client side first, then send an engagement
+  // event to the backend.
+  //
+  async markAsSeen(e, t) {
+    this.knock.log(
+      `[Guide] Marking as seen (Guide key: ${e.key}, Step ref:${t.ref})`
+    );
+    const s = this.setStepMessageAttrs(e.key, t.ref, {
+      seen_at: (/* @__PURE__ */ new Date()).toISOString()
+    });
+    if (!s) return;
+    const r = {
+      ...this.buildEngagementEventBaseParams(e, s),
+      content: s.content,
+      data: this.targetParams.data,
+      tenant: this.targetParams.tenant
+    };
+    return this.knock.user.markGuideStepAs(
+      "seen",
+      r
+    ), s;
+  }
+  async markAsInteracted(e, t, s) {
+    this.knock.log(
+      `[Guide] Marking as interacted (Guide key: ${e.key}, Step ref:${t.ref})`
+    );
+    const r = (/* @__PURE__ */ new Date()).toISOString(), n = this.setStepMessageAttrs(e.key, t.ref, {
+      read_at: r,
+      interacted_at: r
+    });
+    if (!n) return;
+    const i = {
+      ...this.buildEngagementEventBaseParams(e, n),
+      metadata: s
+    };
+    return this.knock.user.markGuideStepAs("interacted", i), n;
+  }
+  async markAsArchived(e, t) {
+    this.knock.log(
+      `[Guide] Marking as archived (Guide key: ${e.key}, Step ref:${t.ref})`
+    );
+    const s = this.setStepMessageAttrs(e.key, t.ref, {
+      archived_at: (/* @__PURE__ */ new Date()).toISOString()
+    });
+    if (!s) return;
+    const r = this.buildEngagementEventBaseParams(e, s);
+    return this.knock.user.markGuideStepAs(
+      "archived",
+      r
+    ), s;
+  }
+  //
+  // Helpers
+  //
+  localCopy(e) {
+    const t = this, s = { ...e };
+    return s.steps = e.steps.map(({ message: r, ...n }) => {
+      const i = {
+        ...n,
+        message: { ...r },
+        markAsSeen() {
+          if (!this.message.seen_at)
+            return t.markAsSeen(s, this);
+        },
+        markAsInteracted({ metadata: a } = {}) {
+          return t.markAsInteracted(s, this, a);
+        },
+        markAsArchived() {
+          if (!this.message.archived_at)
+            return t.markAsArchived(s, this);
+        }
+      };
+      return i.markAsSeen = i.markAsSeen.bind(i), i.markAsInteracted = i.markAsInteracted.bind(i), i.markAsArchived = i.markAsArchived.bind(i), i;
+    }), s;
+  }
+  buildQueryParams(e = {}) {
+    const t = { ...this.targetParams, ...e };
+    let s = Object.fromEntries(
+      Object.entries(t).filter(
+        ([r, n]) => n != null
+      )
+    );
+    return s = s.data ? { ...s, data: JSON.stringify(s.data) } : s, s;
+  }
+  formatQueryKey(e) {
+    const s = Object.keys(e).sort().map(
+      (n) => `${encodeURIComponent(n)}=${encodeURIComponent(e[n])}`
+    ).join("&"), r = g(this.knock.userId);
+    return s ? `${r}?${s}` : r;
+  }
+  setStepMessageAttrs(e, t, s) {
+    let r;
+    return this.store.setState((n) => {
+      const i = n.guides.map((a) => {
+        if (a.key !== e) return a;
+        const d = a.steps.map((c) => (c.ref !== t || (c.message = { ...c.message, ...s }, r = c), c));
+        return { ...a, steps: d };
+      });
+      return { ...n, guides: i };
+    }), r;
+  }
+  buildEngagementEventBaseParams(e, t) {
+    return {
+      message_id: t.message.id,
+      channel_id: e.channel_id,
+      guide_key: e.key,
+      guide_id: e.id,
+      guide_step_ref: t.ref
+    };
+  }
+  addGuide({ data: e }) {
+    const t = this.localCopy(e.guide);
+    this.store.setState((s) => ({ ...s, guides: h([...s.guides, t]) }));
+  }
+  replaceOrAddGuide({ data: e }) {
+    const t = this.localCopy(e.guide);
+    this.store.setState((s) => {
+      let r = !1;
+      const n = s.guides.map((i) => i.key !== t.key ? i : (r = !0, t));
+      return {
+        ...s,
+        guides: h(r ? n : [...n, t])
+      };
+    });
+  }
+  removeGuide({ data: e }) {
+    this.store.setState((t) => {
+      const s = t.guides.filter((r) => r.key !== e.guide.key);
+      return { ...t, guides: s };
+    });
+  }
+}
+export {
+  p as KnockGuideClient,
+  g as guidesApiRootPath
+};
+//# sourceMappingURL=client.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"client.mjs","sources":["../../../../src/clients/guide/client.ts"],"sourcesContent":["import { GenericData } from \"@knocklabs/types\";\nimport { Store } from \"@tanstack/store\";\nimport { Channel, Socket } from \"phoenix\";\n\nimport Knock from \"../../knock\";\n\nconst sortGuides = (guides: KnockGuide[]) => {\n  return [...guides].sort(\n    (a, b) =>\n      b.priority - a.priority ||\n      new Date(b.inserted_at).getTime() - new Date(a.inserted_at).getTime(),\n  );\n};\n\n//\n// Guides API (via User client)\n//\n\nexport const guidesApiRootPath = (userId: string | undefined | null) =>\n  `/v1/users/${userId}/guides`;\n\ninterface StepMessageState {\n  id: string;\n  seen_at: string | null;\n  read_at: string | null;\n  interacted_at: string | null;\n  archived_at: string | null;\n  link_clicked_at: string | null;\n}\n\ninterface GuideStepData {\n  ref: string;\n  schema_key: string;\n  schema_semver: string;\n  schema_variant_key: string;\n  message: StepMessageState;\n  // eslint-disable-next-line\n  content: any;\n}\n\ninterface GuideData {\n  __typename: \"Guide\";\n  channel_id: string;\n  id: string;\n  key: string;\n  priority: number;\n  type: string;\n  semver: string;\n  steps: GuideStepData[];\n  inserted_at: string;\n  updated_at: string;\n}\n\nexport interface KnockGuideStep extends GuideStepData {\n  markAsSeen: () => void;\n  markAsInteracted: (params?: { metadata?: GenericData }) => void;\n  markAsArchived: () => void;\n}\n\nexport interface KnockGuide extends GuideData {\n  steps: KnockGuideStep[];\n}\n\ntype GetGuidesQueryParams = {\n  data?: string;\n  tenant?: string;\n  type?: string;\n};\n\ntype GetGuidesResponse = {\n  entries: GuideData[];\n};\n\nexport type GuideEngagementEventBaseParams = {\n  // Base params required for all engagement update events\n  message_id: string;\n  channel_id: string;\n  guide_key: string;\n  guide_id: string;\n  guide_step_ref: string;\n};\n\ntype MarkAsSeenParams = GuideEngagementEventBaseParams & {\n  // Rendered step content seen by the recipient\n  content: GenericData;\n  // Target params\n  data?: GenericData;\n  tenant?: string;\n};\ntype MarkAsInteractedParams = GuideEngagementEventBaseParams;\ntype MarkAsArchivedParams = GuideEngagementEventBaseParams;\n\ntype MarkGuideAsResponse = {\n  status: \"ok\";\n};\n\ntype SocketEventType = \"guide.added\" | \"guide.updated\" | \"guide.removed\";\n\ntype SocketEventPayload<E extends SocketEventType, D> = {\n  topic: string;\n  event: E;\n  data: D;\n};\n\ntype GuideAddedEvent = SocketEventPayload<\n  \"guide.added\",\n  { guide: GuideData; eligible: true }\n>;\n\ntype GuideUpdatedEvent = SocketEventPayload<\n  \"guide.updated\",\n  { guide: GuideData; eligible: boolean }\n>;\n\ntype GuideRemovedEvent = SocketEventPayload<\n  \"guide.removed\",\n  { guide: Pick<GuideData, \"key\"> }\n>;\n\ntype GuideSocketEvent = GuideAddedEvent | GuideUpdatedEvent | GuideRemovedEvent;\n\n//\n// Guides client\n//\n\ntype QueryKey = string;\n\ntype QueryStatus = {\n  status: \"loading\" | \"ok\" | \"error\";\n  error?: Error;\n};\n\ntype StoreState = {\n  guides: KnockGuide[];\n  queries: Record<QueryKey, QueryStatus>;\n};\n\ntype QueryFilterParams = Pick<GetGuidesQueryParams, \"type\">;\n\nexport type SelectFilterParams = {\n  key?: string;\n  type?: string;\n};\n\nexport type TargetParams = {\n  data?: GenericData | undefined;\n  tenant?: string | undefined;\n};\n\nexport class KnockGuideClient {\n  public store: Store<StoreState, (state: StoreState) => StoreState>;\n\n  // Phoenix channels for real time guide updates over websocket\n  private socket: Socket | undefined;\n  private socketChannel: Channel | undefined;\n  private socketChannelTopic: string;\n  private socketEventTypes = [\"guide.added\", \"guide.updated\", \"guide.removed\"];\n\n  constructor(\n    readonly knock: Knock,\n    readonly channelId: string,\n    readonly targetParams: TargetParams = {},\n  ) {\n    this.store = new Store<StoreState>({\n      guides: [],\n      queries: {},\n    });\n\n    // In server environments we might not have a socket connection.\n    const { socket: maybeSocket } = this.knock.client();\n    this.socket = maybeSocket;\n    this.socketChannelTopic = `guides:${channelId}`;\n\n    this.knock.log(\"[Guide] Initialized a guide client\");\n  }\n\n  async fetch(opts?: { filters?: QueryFilterParams }) {\n    this.knock.failIfNotAuthenticated();\n    this.knock.log(\"[Guide] Loading all eligible guides\");\n\n    const queryParams = this.buildQueryParams(opts?.filters);\n    const queryKey = this.formatQueryKey(queryParams);\n\n    // If already fetched before, then noop.\n    const maybeQueryStatus = this.store.state.queries[queryKey];\n    if (maybeQueryStatus) {\n      return maybeQueryStatus;\n    }\n\n    // Mark this query status as loading.\n    this.store.setState((state) => ({\n      ...state,\n      queries: { ...state.queries, [queryKey]: { status: \"loading\" } },\n    }));\n\n    let queryStatus: QueryStatus;\n    try {\n      const data = await this.knock.user.getGuides<\n        GetGuidesQueryParams,\n        GetGuidesResponse\n      >(this.channelId, queryParams);\n      queryStatus = { status: \"ok\" };\n\n      this.store.setState((state) => ({\n        ...state,\n        // For now assume a single fetch to get all eligible guides. When/if\n        // we implement incremental loads, then this will need to be a merge\n        // and sort operation.\n        guides: data.entries.map((g) => this.localCopy(g)),\n        queries: { ...state.queries, [queryKey]: queryStatus },\n      }));\n    } catch (e) {\n      queryStatus = { status: \"error\", error: e as Error };\n\n      this.store.setState((state) => ({\n        ...state,\n        queries: { ...state.queries, [queryKey]: queryStatus },\n      }));\n    }\n\n    return queryStatus;\n  }\n\n  subscribe() {\n    if (!this.socket) return;\n    this.knock.failIfNotAuthenticated();\n    this.knock.log(\"[Guide] Subscribing to real time updates\");\n\n    // Ensure a live socket connection if not yet connected.\n    if (!this.socket.isConnected()) {\n      this.socket.connect();\n    }\n\n    // If there's an existing connected channel, then disconnect.\n    if (this.socketChannel) {\n      this.unsubscribe();\n    }\n\n    // Join the channel topic and subscribe to supported events.\n    const params = { ...this.targetParams, user_id: this.knock.userId };\n    const newChannel = this.socket.channel(this.socketChannelTopic, params);\n\n    for (const eventType of this.socketEventTypes) {\n      newChannel.on(eventType, (payload) => this.handleSocketEvent(payload));\n    }\n\n    if ([\"closed\", \"errored\"].includes(newChannel.state)) {\n      newChannel.join();\n    }\n\n    // Track the joined channel.\n    this.socketChannel = newChannel;\n  }\n\n  unsubscribe() {\n    if (!this.socketChannel) return;\n    this.knock.log(\"[Guide] Unsubscribing from real time updates\");\n\n    // Unsubscribe from the socket events and leave the channel.\n    for (const eventType of this.socketEventTypes) {\n      this.socketChannel.off(eventType);\n    }\n    this.socketChannel.leave();\n\n    // Unset the channel.\n    this.socketChannel = undefined;\n  }\n\n  private handleSocketEvent(payload: GuideSocketEvent) {\n    const { event, data } = payload;\n\n    switch (event) {\n      case \"guide.added\":\n        return this.addGuide(payload);\n\n      case \"guide.updated\":\n        return data.eligible\n          ? this.replaceOrAddGuide(payload)\n          : this.removeGuide(payload);\n\n      case \"guide.removed\":\n        return this.removeGuide(payload);\n\n      default:\n        return;\n    }\n  }\n\n  //\n  // Store selector\n  //\n\n  select(state: StoreState, filters: SelectFilterParams = {}) {\n    // TODO(KNO-7790): Need to evaluate activation rules also.\n\n    return state.guides.filter((guide) => {\n      if (filters.type && filters.type !== guide.type) {\n        return false;\n      }\n\n      if (filters.key && filters.key !== guide.key) {\n        return false;\n      }\n\n      return true;\n    });\n  }\n\n  //\n  // Engagement event handlers\n  //\n  // Make an optimistic update on the client side first, then send an engagement\n  // event to the backend.\n  //\n\n  async markAsSeen(guide: GuideData, step: GuideStepData) {\n    this.knock.log(\n      `[Guide] Marking as seen (Guide key: ${guide.key}, Step ref:${step.ref})`,\n    );\n\n    const updatedStep = this.setStepMessageAttrs(guide.key, step.ref, {\n      seen_at: new Date().toISOString(),\n    });\n    if (!updatedStep) return;\n\n    const params = {\n      ...this.buildEngagementEventBaseParams(guide, updatedStep),\n      content: updatedStep.content,\n      data: this.targetParams.data,\n      tenant: this.targetParams.tenant,\n    };\n\n    this.knock.user.markGuideStepAs<MarkAsSeenParams, MarkGuideAsResponse>(\n      \"seen\",\n      params,\n    );\n\n    return updatedStep;\n  }\n\n  async markAsInteracted(\n    guide: GuideData,\n    step: GuideStepData,\n    metadata?: GenericData,\n  ) {\n    this.knock.log(\n      `[Guide] Marking as interacted (Guide key: ${guide.key}, Step ref:${step.ref})`,\n    );\n\n    const ts = new Date().toISOString();\n    const updatedStep = this.setStepMessageAttrs(guide.key, step.ref, {\n      read_at: ts,\n      interacted_at: ts,\n    });\n    if (!updatedStep) return;\n\n    const params = {\n      ...this.buildEngagementEventBaseParams(guide, updatedStep),\n      metadata,\n    };\n\n    this.knock.user.markGuideStepAs<\n      MarkAsInteractedParams,\n      MarkGuideAsResponse\n    >(\"interacted\", params);\n\n    return updatedStep;\n  }\n\n  async markAsArchived(guide: GuideData, step: GuideStepData) {\n    this.knock.log(\n      `[Guide] Marking as archived (Guide key: ${guide.key}, Step ref:${step.ref})`,\n    );\n\n    const updatedStep = this.setStepMessageAttrs(guide.key, step.ref, {\n      archived_at: new Date().toISOString(),\n    });\n    if (!updatedStep) return;\n\n    const params = this.buildEngagementEventBaseParams(guide, updatedStep);\n\n    this.knock.user.markGuideStepAs<MarkAsArchivedParams, MarkGuideAsResponse>(\n      \"archived\",\n      params,\n    );\n\n    return updatedStep;\n  }\n\n  //\n  // Helpers\n  //\n\n  private localCopy(remoteGuide: GuideData) {\n    // eslint-disable-next-line @typescript-eslint/no-this-alias\n    const self = this;\n\n    // Build a local copy with helper methods added.\n    const localGuide = { ...remoteGuide };\n\n    localGuide.steps = remoteGuide.steps.map(({ message, ...rest }) => {\n      const localStep = {\n        ...rest,\n        message: { ...message },\n        markAsSeen() {\n          // Send a seen event if it has not been previously seen.\n          if (this.message.seen_at) return;\n          return self.markAsSeen(localGuide, this);\n        },\n        markAsInteracted({ metadata }: { metadata?: GenericData } = {}) {\n          // Always send an interaction event through.\n          return self.markAsInteracted(localGuide, this, metadata);\n        },\n        markAsArchived() {\n          // Send an archived event if it has not been previously archived.\n          if (this.message.archived_at) return;\n          return self.markAsArchived(localGuide, this);\n        },\n      };\n\n      // Bind all engagement action handler methods to the local step object so\n      // they can operate on itself.\n      localStep.markAsSeen = localStep.markAsSeen.bind(localStep);\n      localStep.markAsInteracted = localStep.markAsInteracted.bind(localStep);\n      localStep.markAsArchived = localStep.markAsArchived.bind(localStep);\n\n      return localStep;\n    });\n\n    return localGuide as KnockGuide;\n  }\n\n  private buildQueryParams(filterParams: QueryFilterParams = {}) {\n    // Combine the target params with the given filter params.\n    const combinedParams = { ...this.targetParams, ...filterParams };\n\n    // Prune out any keys that have an undefined or null value.\n    let params = Object.fromEntries(\n      Object.entries(combinedParams).filter(\n        ([_k, v]) => v !== undefined && v !== null,\n      ),\n    );\n\n    // Encode target data as a JSON string, if provided.\n    params = params.data\n      ? { ...params, data: JSON.stringify(params.data) }\n      : params;\n\n    return params as GetGuidesQueryParams;\n  }\n\n  private formatQueryKey(queryParams: GenericData) {\n    const sortedKeys = Object.keys(queryParams).sort();\n\n    const queryStr = sortedKeys\n      .map(\n        (key) =>\n          `${encodeURIComponent(key)}=${encodeURIComponent(queryParams[key])}`,\n      )\n      .join(\"&\");\n\n    const basePath = guidesApiRootPath(this.knock.userId);\n    return queryStr ? `${basePath}?${queryStr}` : basePath;\n  }\n\n  private setStepMessageAttrs(\n    guideKey: string,\n    stepRef: string,\n    attrs: Partial<StepMessageState>,\n  ) {\n    let updatedStep: KnockGuideStep | undefined;\n\n    this.store.setState((state) => {\n      const guides = state.guides.map((guide) => {\n        if (guide.key !== guideKey) return guide;\n\n        const steps = guide.steps.map((step) => {\n          if (step.ref !== stepRef) return step;\n\n          // Mutate in place and maintain the same obj ref so to make it easier\n          // to use in hook deps.\n          step.message = { ...step.message, ...attrs };\n          updatedStep = step;\n\n          return step;\n        });\n        return { ...guide, steps };\n      });\n      return { ...state, guides };\n    });\n\n    return updatedStep;\n  }\n\n  private buildEngagementEventBaseParams(\n    guide: GuideData,\n    step: GuideStepData,\n  ) {\n    return {\n      message_id: step.message.id,\n      channel_id: guide.channel_id,\n      guide_key: guide.key,\n      guide_id: guide.id,\n      guide_step_ref: step.ref,\n    };\n  }\n\n  private addGuide({ data }: GuideAddedEvent) {\n    const guide = this.localCopy(data.guide);\n\n    this.store.setState((state) => {\n      return { ...state, guides: sortGuides([...state.guides, guide]) };\n    });\n  }\n\n  private replaceOrAddGuide({ data }: GuideUpdatedEvent) {\n    const guide = this.localCopy(data.guide);\n\n    this.store.setState((state) => {\n      let replaced = false;\n\n      const guides = state.guides.map((g) => {\n        if (g.key !== guide.key) return g;\n        replaced = true;\n        return guide;\n      });\n\n      return {\n        ...state,\n        guides: replaced ? sortGuides(guides) : sortGuides([...guides, guide]),\n      };\n    });\n  }\n\n  private removeGuide({ data }: GuideUpdatedEvent | GuideRemovedEvent) {\n    this.store.setState((state) => {\n      const guides = state.guides.filter((g) => g.key !== data.guide.key);\n      return { ...state, guides };\n    });\n  }\n}\n"],"names":["sortGuides","guides","a","b","guidesApiRootPath","userId","KnockGuideClient","knock","channelId","targetParams","__publicField","Store","maybeSocket","opts","queryParams","queryKey","maybeQueryStatus","state","queryStatus","data","g","e","params","newChannel","eventType","payload","event","filters","guide","step","updatedStep","metadata","ts","remoteGuide","self","localGuide","message","rest","localStep","filterParams","combinedParams","_k","v","queryStr","key","basePath","guideKey","stepRef","attrs","steps","replaced"],"mappings":";;;;AAMA,MAAMA,IAAa,CAACC,MACX,CAAC,GAAGA,CAAM,EAAE;AAAA,EACjB,CAACC,GAAGC,MACFA,EAAE,WAAWD,EAAE,YACf,IAAI,KAAKC,EAAE,WAAW,EAAE,YAAY,IAAI,KAAKD,EAAE,WAAW,EAAE,QAAQ;AACxE,GAOWE,IAAoB,CAACC,MAChC,aAAaA,CAAM;AAkId,MAAMC,EAAiB;AAAA,EAS5B,YACWC,GACAC,GACAC,IAA6B,CAAA,GACtC;AAZK,IAAAC,EAAA;AAGC;AAAA,IAAAA,EAAA;AACA,IAAAA,EAAA;AACA,IAAAA,EAAA;AACA,IAAAA,EAAA,0BAAmB,CAAC,eAAe,iBAAiB,eAAe;AAGhE,SAAA,QAAAH,GACA,KAAA,YAAAC,GACA,KAAA,eAAAC,GAEJ,KAAA,QAAQ,IAAIE,EAAkB;AAAA,MACjC,QAAQ,CAAC;AAAA,MACT,SAAS,CAAA;AAAA,IAAC,CACX;AAGD,UAAM,EAAE,QAAQC,EAAA,IAAgB,KAAK,MAAM,OAAO;AAClD,SAAK,SAASA,GACT,KAAA,qBAAqB,UAAUJ,CAAS,IAExC,KAAA,MAAM,IAAI,oCAAoC;AAAA,EAAA;AAAA,EAGrD,MAAM,MAAMK,GAAwC;AAClD,SAAK,MAAM,uBAAuB,GAC7B,KAAA,MAAM,IAAI,qCAAqC;AAEpD,UAAMC,IAAc,KAAK,iBAAiBD,KAAA,gBAAAA,EAAM,OAAO,GACjDE,IAAW,KAAK,eAAeD,CAAW,GAG1CE,IAAmB,KAAK,MAAM,MAAM,QAAQD,CAAQ;AAC1D,QAAIC;AACK,aAAAA;AAIJ,SAAA,MAAM,SAAS,CAACC,OAAW;AAAA,MAC9B,GAAGA;AAAA,MACH,SAAS,EAAE,GAAGA,EAAM,SAAS,CAACF,CAAQ,GAAG,EAAE,QAAQ,UAAY,EAAA;AAAA,IAAA,EAC/D;AAEE,QAAAG;AACA,QAAA;AACI,YAAAC,IAAO,MAAM,KAAK,MAAM,KAAK,UAGjC,KAAK,WAAWL,CAAW;AACf,MAAAI,IAAA,EAAE,QAAQ,KAAK,GAExB,KAAA,MAAM,SAAS,CAACD,OAAW;AAAA,QAC9B,GAAGA;AAAA;AAAA;AAAA;AAAA,QAIH,QAAQE,EAAK,QAAQ,IAAI,CAACC,MAAM,KAAK,UAAUA,CAAC,CAAC;AAAA,QACjD,SAAS,EAAE,GAAGH,EAAM,SAAS,CAACF,CAAQ,GAAGG,EAAY;AAAA,MAAA,EACrD;AAAA,aACKG,GAAG;AACV,MAAAH,IAAc,EAAE,QAAQ,SAAS,OAAOG,EAAW,GAE9C,KAAA,MAAM,SAAS,CAACJ,OAAW;AAAA,QAC9B,GAAGA;AAAA,QACH,SAAS,EAAE,GAAGA,EAAM,SAAS,CAACF,CAAQ,GAAGG,EAAY;AAAA,MAAA,EACrD;AAAA,IAAA;AAGG,WAAAA;AAAA,EAAA;AAAA,EAGT,YAAY;AACN,QAAA,CAAC,KAAK,OAAQ;AAClB,SAAK,MAAM,uBAAuB,GAC7B,KAAA,MAAM,IAAI,0CAA0C,GAGpD,KAAK,OAAO,iBACf,KAAK,OAAO,QAAQ,GAIlB,KAAK,iBACP,KAAK,YAAY;AAIb,UAAAI,IAAS,EAAE,GAAG,KAAK,cAAc,SAAS,KAAK,MAAM,OAAO,GAC5DC,IAAa,KAAK,OAAO,QAAQ,KAAK,oBAAoBD,CAAM;AAE3D,eAAAE,KAAa,KAAK;AAC3B,MAAAD,EAAW,GAAGC,GAAW,CAACC,MAAY,KAAK,kBAAkBA,CAAO,CAAC;AAGvE,IAAI,CAAC,UAAU,SAAS,EAAE,SAASF,EAAW,KAAK,KACjDA,EAAW,KAAK,GAIlB,KAAK,gBAAgBA;AAAA,EAAA;AAAA,EAGvB,cAAc;AACR,QAAC,KAAK,eACL;AAAA,WAAA,MAAM,IAAI,8CAA8C;AAGlD,iBAAAC,KAAa,KAAK;AACtB,aAAA,cAAc,IAAIA,CAAS;AAElC,WAAK,cAAc,MAAM,GAGzB,KAAK,gBAAgB;AAAA;AAAA,EAAA;AAAA,EAGf,kBAAkBC,GAA2B;AAC7C,UAAA,EAAE,OAAAC,GAAO,MAAAP,EAAA,IAASM;AAExB,YAAQC,GAAO;AAAA,MACb,KAAK;AACI,eAAA,KAAK,SAASD,CAAO;AAAA,MAE9B,KAAK;AACI,eAAAN,EAAK,WACR,KAAK,kBAAkBM,CAAO,IAC9B,KAAK,YAAYA,CAAO;AAAA,MAE9B,KAAK;AACI,eAAA,KAAK,YAAYA,CAAO;AAAA,MAEjC;AACE;AAAA,IAAA;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA,EAOF,OAAOR,GAAmBU,IAA8B,IAAI;AAG1D,WAAOV,EAAM,OAAO,OAAO,CAACW,MACtB,EAAAD,EAAQ,QAAQA,EAAQ,SAASC,EAAM,QAIvCD,EAAQ,OAAOA,EAAQ,QAAQC,EAAM,IAK1C;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUH,MAAM,WAAWA,GAAkBC,GAAqB;AACtD,SAAK,MAAM;AAAA,MACT,uCAAuCD,EAAM,GAAG,cAAcC,EAAK,GAAG;AAAA,IACxE;AAEA,UAAMC,IAAc,KAAK,oBAAoBF,EAAM,KAAKC,EAAK,KAAK;AAAA,MAChE,UAAS,oBAAI,KAAK,GAAE,YAAY;AAAA,IAAA,CACjC;AACD,QAAI,CAACC,EAAa;AAElB,UAAMR,IAAS;AAAA,MACb,GAAG,KAAK,+BAA+BM,GAAOE,CAAW;AAAA,MACzD,SAASA,EAAY;AAAA,MACrB,MAAM,KAAK,aAAa;AAAA,MACxB,QAAQ,KAAK,aAAa;AAAA,IAC5B;AAEA,gBAAK,MAAM,KAAK;AAAA,MACd;AAAA,MACAR;AAAA,IACF,GAEOQ;AAAA,EAAA;AAAA,EAGT,MAAM,iBACJF,GACAC,GACAE,GACA;AACA,SAAK,MAAM;AAAA,MACT,6CAA6CH,EAAM,GAAG,cAAcC,EAAK,GAAG;AAAA,IAC9E;AAEA,UAAMG,KAAK,oBAAI,KAAK,GAAE,YAAY,GAC5BF,IAAc,KAAK,oBAAoBF,EAAM,KAAKC,EAAK,KAAK;AAAA,MAChE,SAASG;AAAA,MACT,eAAeA;AAAA,IAAA,CAChB;AACD,QAAI,CAACF,EAAa;AAElB,UAAMR,IAAS;AAAA,MACb,GAAG,KAAK,+BAA+BM,GAAOE,CAAW;AAAA,MACzD,UAAAC;AAAA,IACF;AAEA,gBAAK,MAAM,KAAK,gBAGd,cAAcT,CAAM,GAEfQ;AAAA,EAAA;AAAA,EAGT,MAAM,eAAeF,GAAkBC,GAAqB;AAC1D,SAAK,MAAM;AAAA,MACT,2CAA2CD,EAAM,GAAG,cAAcC,EAAK,GAAG;AAAA,IAC5E;AAEA,UAAMC,IAAc,KAAK,oBAAoBF,EAAM,KAAKC,EAAK,KAAK;AAAA,MAChE,cAAa,oBAAI,KAAK,GAAE,YAAY;AAAA,IAAA,CACrC;AACD,QAAI,CAACC,EAAa;AAElB,UAAMR,IAAS,KAAK,+BAA+BM,GAAOE,CAAW;AAErE,gBAAK,MAAM,KAAK;AAAA,MACd;AAAA,MACAR;AAAA,IACF,GAEOQ;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAOD,UAAUG,GAAwB;AAExC,UAAMC,IAAO,MAGPC,IAAa,EAAE,GAAGF,EAAY;AAEzB,WAAAE,EAAA,QAAQF,EAAY,MAAM,IAAI,CAAC,EAAE,SAAAG,GAAS,GAAGC,QAAW;AACjE,YAAMC,IAAY;AAAA,QAChB,GAAGD;AAAA,QACH,SAAS,EAAE,GAAGD,EAAQ;AAAA,QACtB,aAAa;AAEP,cAAA,MAAK,QAAQ;AACV,mBAAAF,EAAK,WAAWC,GAAY,IAAI;AAAA,QACzC;AAAA,QACA,iBAAiB,EAAE,UAAAJ,EAAS,IAAgC,IAAI;AAE9D,iBAAOG,EAAK,iBAAiBC,GAAY,MAAMJ,CAAQ;AAAA,QACzD;AAAA,QACA,iBAAiB;AAEX,cAAA,MAAK,QAAQ;AACV,mBAAAG,EAAK,eAAeC,GAAY,IAAI;AAAA,QAAA;AAAA,MAE/C;AAIA,aAAAG,EAAU,aAAaA,EAAU,WAAW,KAAKA,CAAS,GAC1DA,EAAU,mBAAmBA,EAAU,iBAAiB,KAAKA,CAAS,GACtEA,EAAU,iBAAiBA,EAAU,eAAe,KAAKA,CAAS,GAE3DA;AAAA,IAAA,CACR,GAEMH;AAAA,EAAA;AAAA,EAGD,iBAAiBI,IAAkC,IAAI;AAE7D,UAAMC,IAAiB,EAAE,GAAG,KAAK,cAAc,GAAGD,EAAa;AAG/D,QAAIjB,IAAS,OAAO;AAAA,MAClB,OAAO,QAAQkB,CAAc,EAAE;AAAA,QAC7B,CAAC,CAACC,GAAIC,CAAC,MAAyBA,KAAM;AAAA,MAAA;AAAA,IAE1C;AAGS,WAAApB,IAAAA,EAAO,OACZ,EAAE,GAAGA,GAAQ,MAAM,KAAK,UAAUA,EAAO,IAAI,EAC7C,IAAAA,GAEGA;AAAA,EAAA;AAAA,EAGD,eAAeR,GAA0B;AAG/C,UAAM6B,IAFa,OAAO,KAAK7B,CAAW,EAAE,KAAK,EAG9C;AAAA,MACC,CAAC8B,MACC,GAAG,mBAAmBA,CAAG,CAAC,IAAI,mBAAmB9B,EAAY8B,CAAG,CAAC,CAAC;AAAA,IAAA,EAErE,KAAK,GAAG,GAELC,IAAWzC,EAAkB,KAAK,MAAM,MAAM;AACpD,WAAOuC,IAAW,GAAGE,CAAQ,IAAIF,CAAQ,KAAKE;AAAA,EAAA;AAAA,EAGxC,oBACNC,GACAC,GACAC,GACA;AACI,QAAAlB;AAEC,gBAAA,MAAM,SAAS,CAACb,MAAU;AAC7B,YAAMhB,IAASgB,EAAM,OAAO,IAAI,CAACW,MAAU;AACrC,YAAAA,EAAM,QAAQkB,EAAiB,QAAAlB;AAEnC,cAAMqB,IAAQrB,EAAM,MAAM,IAAI,CAACC,OACzBA,EAAK,QAAQkB,MAIjBlB,EAAK,UAAU,EAAE,GAAGA,EAAK,SAAS,GAAGmB,EAAM,GAC7BlB,IAAAD,IAEPA,EACR;AACM,eAAA,EAAE,GAAGD,GAAO,OAAAqB,EAAM;AAAA,MAAA,CAC1B;AACM,aAAA,EAAE,GAAGhC,GAAO,QAAAhB,EAAO;AAAA,IAAA,CAC3B,GAEM6B;AAAA,EAAA;AAAA,EAGD,+BACNF,GACAC,GACA;AACO,WAAA;AAAA,MACL,YAAYA,EAAK,QAAQ;AAAA,MACzB,YAAYD,EAAM;AAAA,MAClB,WAAWA,EAAM;AAAA,MACjB,UAAUA,EAAM;AAAA,MAChB,gBAAgBC,EAAK;AAAA,IACvB;AAAA,EAAA;AAAA,EAGM,SAAS,EAAE,MAAAV,KAAyB;AAC1C,UAAMS,IAAQ,KAAK,UAAUT,EAAK,KAAK;AAElC,SAAA,MAAM,SAAS,CAACF,OACZ,EAAE,GAAGA,GAAO,QAAQjB,EAAW,CAAC,GAAGiB,EAAM,QAAQW,CAAK,CAAC,EAAE,EACjE;AAAA,EAAA;AAAA,EAGK,kBAAkB,EAAE,MAAAT,KAA2B;AACrD,UAAMS,IAAQ,KAAK,UAAUT,EAAK,KAAK;AAElC,SAAA,MAAM,SAAS,CAACF,MAAU;AAC7B,UAAIiC,IAAW;AAEf,YAAMjD,IAASgB,EAAM,OAAO,IAAI,CAACG,MAC3BA,EAAE,QAAQQ,EAAM,MAAYR,KACrB8B,IAAA,IACJtB,EACR;AAEM,aAAA;AAAA,QACL,GAAGX;AAAA,QACH,QAAmBjB,EAAXkD,IAAsBjD,IAAqB,CAAC,GAAGA,GAAQ2B,CAAK,CAAhC;AAAA,MACtC;AAAA,IAAA,CACD;AAAA,EAAA;AAAA,EAGK,YAAY,EAAE,MAAAT,KAA+C;AAC9D,SAAA,MAAM,SAAS,CAACF,MAAU;AACvB,YAAAhB,IAASgB,EAAM,OAAO,OAAO,CAACG,MAAMA,EAAE,QAAQD,EAAK,MAAM,GAAG;AAC3D,aAAA,EAAE,GAAGF,GAAO,QAAAhB,EAAO;AAAA,IAAA,CAC3B;AAAA,EAAA;AAEL;"}

package/dist/esm/clients/users/index.mjs

@@ -1,8 +1,9 @@
-var c = Object.defineProperty;
-var h = (s, e, t) => e in s ? c(s, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : s[e] = t;
-var a = (s, e, t) => h(s, typeof e != "symbol" ? e + "" : e, t);
-const i = "default";
-class l {
+var h = Object.defineProperty;
+var u = (n, e, t) => e in n ? h(n, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : n[e] = t;
+var a = (n, e, t) => u(n, typeof e != "symbol" ? e + "" : e, t);
+import { guidesApiRootPath as i } from "../guide/client.mjs";
+const r = "default";
+class o {
   constructor(e) {
     a(this, "instance");
     this.instance = e;
@@ -34,21 +35,21 @@ class l {
   }
   async getPreferences(e = {}) {
     this.instance.failIfNotAuthenticated();
-    const t = e.preferenceSet || i, n = await this.instance.client().makeRequest({
+    const t = e.preferenceSet || r, s = await this.instance.client().makeRequest({
       method: "GET",
       url: `/v1/users/${this.instance.userId}/preferences/${t}`,
       params: { tenant: e.tenant }
     });
-    return this.handleResponse(n);
+    return this.handleResponse(s);
   }
   async setPreferences(e, t = {}) {
     this.instance.failIfNotAuthenticated();
-    const n = t.preferenceSet || i, r = await this.instance.client().makeRequest({
+    const s = t.preferenceSet || r, c = await this.instance.client().makeRequest({
       method: "PUT",
-      url: `/v1/users/${this.instance.userId}/preferences/${n}`,
+      url: `/v1/users/${this.instance.userId}/preferences/${s}`,
       data: e
     });
-    return this.handleResponse(r);
+    return this.handleResponse(c);
   }
   async getChannelData(e) {
     this.instance.failIfNotAuthenticated();
@@ -63,12 +64,28 @@ class l {
     channelData: t
   }) {
     this.instance.failIfNotAuthenticated();
-    const n = await this.instance.client().makeRequest({
+    const s = await this.instance.client().makeRequest({
       method: "PUT",
       url: `/v1/users/${this.instance.userId}/channel_data/${e}`,
       data: { data: t }
     });
-    return this.handleResponse(n);
+    return this.handleResponse(s);
+  }
+  async getGuides(e, t) {
+    const s = await this.instance.client().makeRequest({
+      method: "GET",
+      url: `${i(this.instance.userId)}/${e}`,
+      params: t
+    });
+    return this.handleResponse(s);
+  }
+  async markGuideStepAs(e, t) {
+    const s = await this.instance.client().makeRequest({
+      method: "PUT",
+      url: `${i(this.instance.userId)}/messages/${t.message_id}/${e}`,
+      data: t
+    });
+    return this.handleResponse(s);
   }
   handleResponse(e) {
     if (e.statusCode === "error")
@@ -77,6 +94,6 @@ class l {
   }
 }
 export {
-  l as default
+  o as default
 };
 //# sourceMappingURL=index.mjs.map

package/dist/esm/clients/users/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sources":["../../../../src/clients/users/index.ts"],"sourcesContent":["import { GenericData } from \"@knocklabs/types\";\n\nimport { ApiResponse } from \"../../api\";\nimport { ChannelData, User } from \"../../interfaces\";\nimport Knock from \"../../knock\";\nimport {\n  GetPreferencesOptions,\n  PreferenceOptions,\n  PreferenceSet,\n  SetPreferencesProperties,\n} from \"../preferences/interfaces\";\n\nimport { GetChannelDataInput, SetChannelDataInput } from \"./interfaces\";\n\nconst DEFAULT_PREFERENCE_SET_ID = \"default\";\n\nclass UserClient {\n  private instance: Knock;\n\n  constructor(instance: Knock) {\n    this.instance = instance;\n  }\n\n  async get() {\n    this.instance.failIfNotAuthenticated();\n\n    const result = await this.instance.client().makeRequest({\n      method: \"GET\",\n      url: `/v1/users/${this.instance.userId}`,\n    });\n\n    return this.handleResponse<User>(result);\n  }\n\n  async identify(props: GenericData = {}) {\n    this.instance.failIfNotAuthenticated();\n\n    const result = await this.instance.client().makeRequest({\n      method: \"PUT\",\n      url: `/v1/users/${this.instance.userId}`,\n      params: props,\n    });\n\n    return this.handleResponse<User>(result);\n  }\n\n  async getAllPreferences() {\n    this.instance.failIfNotAuthenticated();\n\n    const result = await this.instance.client().makeRequest({\n      method: \"GET\",\n      url: `/v1/users/${this.instance.userId}/preferences`,\n    });\n\n    return this.handleResponse<PreferenceSet[]>(result);\n  }\n\n  async getPreferences(\n    options: GetPreferencesOptions = {},\n  ): Promise<PreferenceSet> {\n    this.instance.failIfNotAuthenticated();\n    const preferenceSetId = options.preferenceSet || DEFAULT_PREFERENCE_SET_ID;\n\n    const result = await this.instance.client().makeRequest({\n      method: \"GET\",\n      url: `/v1/users/${this.instance.userId}/preferences/${preferenceSetId}`,\n      params: { tenant: options.tenant },\n    });\n\n    return this.handleResponse<PreferenceSet>(result);\n  }\n\n  async setPreferences(\n    preferenceSet: SetPreferencesProperties,\n    options: PreferenceOptions = {},\n  ): Promise<PreferenceSet> {\n    this.instance.failIfNotAuthenticated();\n    const preferenceSetId = options.preferenceSet || DEFAULT_PREFERENCE_SET_ID;\n\n    const result = await this.instance.client().makeRequest({\n      method: \"PUT\",\n      url: `/v1/users/${this.instance.userId}/preferences/${preferenceSetId}`,\n      data: preferenceSet,\n    });\n\n    return this.handleResponse<PreferenceSet>(result);\n  }\n\n  async getChannelData<T = GenericData>(params: GetChannelDataInput) {\n    this.instance.failIfNotAuthenticated();\n\n    const result = await this.instance.client().makeRequest({\n      method: \"GET\",\n      url: `/v1/users/${this.instance.userId}/channel_data/${params.channelId}`,\n    });\n\n    return this.handleResponse<ChannelData<T>>(result);\n  }\n\n  async setChannelData<T = GenericData>({\n    channelId,\n    channelData,\n  }: SetChannelDataInput) {\n    this.instance.failIfNotAuthenticated();\n\n    const result = await this.instance.client().makeRequest({\n      method: \"PUT\",\n      url: `/v1/users/${this.instance.userId}/channel_data/${channelId}`,\n      data: { data: channelData },\n    });\n\n    return this.handleResponse<ChannelData<T>>(result);\n  }\n\n  private handleResponse<T>(response: ApiResponse) {\n    if (response.statusCode === \"error\") {\n      throw new Error(response.error || response.body);\n    }\n\n    return response.body as T;\n  }\n}\n\nexport default UserClient;\n"],"names":["DEFAULT_PREFERENCE_SET_ID","UserClient","instance","__publicField","result","props","options","preferenceSetId","preferenceSet","params","channelId","channelData","response"],"mappings":";;;AAcA,MAAMA,IAA4B;AAElC,MAAMC,EAAW;AAAA,EAGf,YAAYC,GAAiB;AAFrB,IAAAC,EAAA;AAGN,SAAK,WAAWD;AAAA,EAAA;AAAA,EAGlB,MAAM,MAAM;AACV,SAAK,SAAS,uBAAuB;AAErC,UAAME,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,aAAa,KAAK,SAAS,MAAM;AAAA,IAAA,CACvC;AAEM,WAAA,KAAK,eAAqBA,CAAM;AAAA,EAAA;AAAA,EAGzC,MAAM,SAASC,IAAqB,IAAI;AACtC,SAAK,SAAS,uBAAuB;AAErC,UAAMD,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,aAAa,KAAK,SAAS,MAAM;AAAA,MACtC,QAAQC;AAAA,IAAA,CACT;AAEM,WAAA,KAAK,eAAqBD,CAAM;AAAA,EAAA;AAAA,EAGzC,MAAM,oBAAoB;AACxB,SAAK,SAAS,uBAAuB;AAErC,UAAMA,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,aAAa,KAAK,SAAS,MAAM;AAAA,IAAA,CACvC;AAEM,WAAA,KAAK,eAAgCA,CAAM;AAAA,EAAA;AAAA,EAGpD,MAAM,eACJE,IAAiC,IACT;AACxB,SAAK,SAAS,uBAAuB;AAC/B,UAAAC,IAAkBD,EAAQ,iBAAiBN,GAE3CI,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,aAAa,KAAK,SAAS,MAAM,gBAAgBG,CAAe;AAAA,MACrE,QAAQ,EAAE,QAAQD,EAAQ,OAAO;AAAA,IAAA,CAClC;AAEM,WAAA,KAAK,eAA8BF,CAAM;AAAA,EAAA;AAAA,EAGlD,MAAM,eACJI,GACAF,IAA6B,IACL;AACxB,SAAK,SAAS,uBAAuB;AAC/B,UAAAC,IAAkBD,EAAQ,iBAAiBN,GAE3CI,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,aAAa,KAAK,SAAS,MAAM,gBAAgBG,CAAe;AAAA,MACrE,MAAMC;AAAA,IAAA,CACP;AAEM,WAAA,KAAK,eAA8BJ,CAAM;AAAA,EAAA;AAAA,EAGlD,MAAM,eAAgCK,GAA6B;AACjE,SAAK,SAAS,uBAAuB;AAErC,UAAML,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,aAAa,KAAK,SAAS,MAAM,iBAAiBK,EAAO,SAAS;AAAA,IAAA,CACxE;AAEM,WAAA,KAAK,eAA+BL,CAAM;AAAA,EAAA;AAAA,EAGnD,MAAM,eAAgC;AAAA,IACpC,WAAAM;AAAA,IACA,aAAAC;AAAA,EAAA,GACsB;AACtB,SAAK,SAAS,uBAAuB;AAErC,UAAMP,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,aAAa,KAAK,SAAS,MAAM,iBAAiBM,CAAS;AAAA,MAChE,MAAM,EAAE,MAAMC,EAAY;AAAA,IAAA,CAC3B;AAEM,WAAA,KAAK,eAA+BP,CAAM;AAAA,EAAA;AAAA,EAG3C,eAAkBQ,GAAuB;AAC3C,QAAAA,EAAS,eAAe;AAC1B,YAAM,IAAI,MAAMA,EAAS,SAASA,EAAS,IAAI;AAGjD,WAAOA,EAAS;AAAA,EAAA;AAEpB;"}
+{"version":3,"file":"index.mjs","sources":["../../../../src/clients/users/index.ts"],"sourcesContent":["import { GenericData } from \"@knocklabs/types\";\n\nimport { ApiResponse } from \"../../api\";\nimport { ChannelData, User } from \"../../interfaces\";\nimport Knock from \"../../knock\";\nimport {\n  GuideEngagementEventBaseParams,\n  guidesApiRootPath,\n} from \"../guide/client\";\nimport {\n  GetPreferencesOptions,\n  PreferenceOptions,\n  PreferenceSet,\n  SetPreferencesProperties,\n} from \"../preferences/interfaces\";\n\nimport { GetChannelDataInput, SetChannelDataInput } from \"./interfaces\";\n\nconst DEFAULT_PREFERENCE_SET_ID = \"default\";\n\nclass UserClient {\n  private instance: Knock;\n\n  constructor(instance: Knock) {\n    this.instance = instance;\n  }\n\n  async get() {\n    this.instance.failIfNotAuthenticated();\n\n    const result = await this.instance.client().makeRequest({\n      method: \"GET\",\n      url: `/v1/users/${this.instance.userId}`,\n    });\n\n    return this.handleResponse<User>(result);\n  }\n\n  async identify(props: GenericData = {}) {\n    this.instance.failIfNotAuthenticated();\n\n    const result = await this.instance.client().makeRequest({\n      method: \"PUT\",\n      url: `/v1/users/${this.instance.userId}`,\n      params: props,\n    });\n\n    return this.handleResponse<User>(result);\n  }\n\n  async getAllPreferences() {\n    this.instance.failIfNotAuthenticated();\n\n    const result = await this.instance.client().makeRequest({\n      method: \"GET\",\n      url: `/v1/users/${this.instance.userId}/preferences`,\n    });\n\n    return this.handleResponse<PreferenceSet[]>(result);\n  }\n\n  async getPreferences(\n    options: GetPreferencesOptions = {},\n  ): Promise<PreferenceSet> {\n    this.instance.failIfNotAuthenticated();\n    const preferenceSetId = options.preferenceSet || DEFAULT_PREFERENCE_SET_ID;\n\n    const result = await this.instance.client().makeRequest({\n      method: \"GET\",\n      url: `/v1/users/${this.instance.userId}/preferences/${preferenceSetId}`,\n      params: { tenant: options.tenant },\n    });\n\n    return this.handleResponse<PreferenceSet>(result);\n  }\n\n  async setPreferences(\n    preferenceSet: SetPreferencesProperties,\n    options: PreferenceOptions = {},\n  ): Promise<PreferenceSet> {\n    this.instance.failIfNotAuthenticated();\n    const preferenceSetId = options.preferenceSet || DEFAULT_PREFERENCE_SET_ID;\n\n    const result = await this.instance.client().makeRequest({\n      method: \"PUT\",\n      url: `/v1/users/${this.instance.userId}/preferences/${preferenceSetId}`,\n      data: preferenceSet,\n    });\n\n    return this.handleResponse<PreferenceSet>(result);\n  }\n\n  async getChannelData<T = GenericData>(params: GetChannelDataInput) {\n    this.instance.failIfNotAuthenticated();\n\n    const result = await this.instance.client().makeRequest({\n      method: \"GET\",\n      url: `/v1/users/${this.instance.userId}/channel_data/${params.channelId}`,\n    });\n\n    return this.handleResponse<ChannelData<T>>(result);\n  }\n\n  async setChannelData<T = GenericData>({\n    channelId,\n    channelData,\n  }: SetChannelDataInput) {\n    this.instance.failIfNotAuthenticated();\n\n    const result = await this.instance.client().makeRequest({\n      method: \"PUT\",\n      url: `/v1/users/${this.instance.userId}/channel_data/${channelId}`,\n      data: { data: channelData },\n    });\n\n    return this.handleResponse<ChannelData<T>>(result);\n  }\n\n  async getGuides<P, R>(channelId: string, params: P) {\n    const result = await this.instance.client().makeRequest({\n      method: \"GET\",\n      url: `${guidesApiRootPath(this.instance.userId)}/${channelId}`,\n      params,\n    });\n\n    return this.handleResponse<R>(result);\n  }\n\n  async markGuideStepAs<P extends GuideEngagementEventBaseParams, R>(\n    status: \"seen\" | \"interacted\" | \"archived\",\n    params: P,\n  ) {\n    const result = await this.instance.client().makeRequest({\n      method: \"PUT\",\n      url: `${guidesApiRootPath(this.instance.userId)}/messages/${params.message_id}/${status}`,\n      data: params,\n    });\n\n    return this.handleResponse<R>(result);\n  }\n\n  private handleResponse<T>(response: ApiResponse) {\n    if (response.statusCode === \"error\") {\n      throw new Error(response.error || response.body);\n    }\n\n    return response.body as T;\n  }\n}\n\nexport default UserClient;\n"],"names":["DEFAULT_PREFERENCE_SET_ID","UserClient","instance","__publicField","result","props","options","preferenceSetId","preferenceSet","params","channelId","channelData","guidesApiRootPath","status","response"],"mappings":";;;;AAkBA,MAAMA,IAA4B;AAElC,MAAMC,EAAW;AAAA,EAGf,YAAYC,GAAiB;AAFrB,IAAAC,EAAA;AAGN,SAAK,WAAWD;AAAA,EAAA;AAAA,EAGlB,MAAM,MAAM;AACV,SAAK,SAAS,uBAAuB;AAErC,UAAME,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,aAAa,KAAK,SAAS,MAAM;AAAA,IAAA,CACvC;AAEM,WAAA,KAAK,eAAqBA,CAAM;AAAA,EAAA;AAAA,EAGzC,MAAM,SAASC,IAAqB,IAAI;AACtC,SAAK,SAAS,uBAAuB;AAErC,UAAMD,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,aAAa,KAAK,SAAS,MAAM;AAAA,MACtC,QAAQC;AAAA,IAAA,CACT;AAEM,WAAA,KAAK,eAAqBD,CAAM;AAAA,EAAA;AAAA,EAGzC,MAAM,oBAAoB;AACxB,SAAK,SAAS,uBAAuB;AAErC,UAAMA,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,aAAa,KAAK,SAAS,MAAM;AAAA,IAAA,CACvC;AAEM,WAAA,KAAK,eAAgCA,CAAM;AAAA,EAAA;AAAA,EAGpD,MAAM,eACJE,IAAiC,IACT;AACxB,SAAK,SAAS,uBAAuB;AAC/B,UAAAC,IAAkBD,EAAQ,iBAAiBN,GAE3CI,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,aAAa,KAAK,SAAS,MAAM,gBAAgBG,CAAe;AAAA,MACrE,QAAQ,EAAE,QAAQD,EAAQ,OAAO;AAAA,IAAA,CAClC;AAEM,WAAA,KAAK,eAA8BF,CAAM;AAAA,EAAA;AAAA,EAGlD,MAAM,eACJI,GACAF,IAA6B,IACL;AACxB,SAAK,SAAS,uBAAuB;AAC/B,UAAAC,IAAkBD,EAAQ,iBAAiBN,GAE3CI,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,aAAa,KAAK,SAAS,MAAM,gBAAgBG,CAAe;AAAA,MACrE,MAAMC;AAAA,IAAA,CACP;AAEM,WAAA,KAAK,eAA8BJ,CAAM;AAAA,EAAA;AAAA,EAGlD,MAAM,eAAgCK,GAA6B;AACjE,SAAK,SAAS,uBAAuB;AAErC,UAAML,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,aAAa,KAAK,SAAS,MAAM,iBAAiBK,EAAO,SAAS;AAAA,IAAA,CACxE;AAEM,WAAA,KAAK,eAA+BL,CAAM;AAAA,EAAA;AAAA,EAGnD,MAAM,eAAgC;AAAA,IACpC,WAAAM;AAAA,IACA,aAAAC;AAAA,EAAA,GACsB;AACtB,SAAK,SAAS,uBAAuB;AAErC,UAAMP,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,aAAa,KAAK,SAAS,MAAM,iBAAiBM,CAAS;AAAA,MAChE,MAAM,EAAE,MAAMC,EAAY;AAAA,IAAA,CAC3B;AAEM,WAAA,KAAK,eAA+BP,CAAM;AAAA,EAAA;AAAA,EAGnD,MAAM,UAAgBM,GAAmBD,GAAW;AAClD,UAAML,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,GAAGQ,EAAkB,KAAK,SAAS,MAAM,CAAC,IAAIF,CAAS;AAAA,MAC5D,QAAAD;AAAA,IAAA,CACD;AAEM,WAAA,KAAK,eAAkBL,CAAM;AAAA,EAAA;AAAA,EAGtC,MAAM,gBACJS,GACAJ,GACA;AACA,UAAML,IAAS,MAAM,KAAK,SAAS,OAAA,EAAS,YAAY;AAAA,MACtD,QAAQ;AAAA,MACR,KAAK,GAAGQ,EAAkB,KAAK,SAAS,MAAM,CAAC,aAAaH,EAAO,UAAU,IAAII,CAAM;AAAA,MACvF,MAAMJ;AAAA,IAAA,CACP;AAEM,WAAA,KAAK,eAAkBL,CAAM;AAAA,EAAA;AAAA,EAG9B,eAAkBU,GAAuB;AAC3C,QAAAA,EAAS,eAAe;AAC1B,YAAM,IAAI,MAAMA,EAAS,SAASA,EAAS,IAAI;AAGjD,WAAOA,EAAS;AAAA,EAAA;AAEpB;"}

package/dist/esm/index.mjs

@@ -1,14 +1,16 @@
 import { default as f } from "./clients/feed/index.mjs";
 import t from "./knock.mjs";
-import { TENANT_OBJECT_COLLECTION as m } from "./clients/objects/constants.mjs";
-import { NetworkStatus as s, isRequestInFlight as d } from "./networkStatus.mjs";
-import { default as u } from "./clients/feed/feed.mjs";
+import { KnockGuideClient as m } from "./clients/guide/client.mjs";
+import { TENANT_OBJECT_COLLECTION as d } from "./clients/objects/constants.mjs";
+import { NetworkStatus as l, isRequestInFlight as s } from "./networkStatus.mjs";
+import { default as x } from "./clients/feed/feed.mjs";
 export {
-  u as Feed,
+  x as Feed,
   f as FeedClient,
-  s as NetworkStatus,
-  m as TENANT_OBJECT_COLLECTION,
+  m as KnockGuideClient,
+  l as NetworkStatus,
+  d as TENANT_OBJECT_COLLECTION,
   t as default,
-  d as isRequestInFlight
+  s as isRequestInFlight
 };
 //# sourceMappingURL=index.mjs.map

package/dist/esm/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;"}
+{"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;"}

package/dist/types/clients/feed/feed.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"feed.d.ts","sourceRoot":"","sources":["../../../../src/clients/feed/feed.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAG/C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAExC,OAAO,KAAK,MAAM,aAAa,CAAC;AAOhC,OAAO,EACL,iBAAiB,EAIjB,gBAAgB,EACjB,MAAM,cAAc,CAAC;AAEtB,OAAO,EACL,iBAAiB,EAEjB,iBAAiB,EAEjB,eAAe,EAEf,oBAAoB,EACpB,cAAc,EACf,MAAM,SAAS,CAAC;AASjB,cAAM,IAAI;IAeN,QAAQ,CAAC,KAAK,EAAE,KAAK;IACrB,QAAQ,CAAC,MAAM,EAAE,MAAM;IAfzB,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,OAAO,CAAC,CAAU;IAC1B,OAAO,CAAC,WAAW,CAAe;IAClC,OAAO,CAAC,cAAc,CAAoB;IAC1C,OAAO,CAAC,gBAAgB,CAA2B;IACnD,OAAO,CAAC,eAAe,CAA8C;IACrE,OAAO,CAAC,8BAA8B,CAAkB;IACxD,OAAO,CAAC,uBAAuB,CAAwB;IACvD,OAAO,CAAC,iCAAiC,CAAkB;IAGpD,KAAK,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC;gBAG5B,KAAK,EAAE,KAAK,EACZ,MAAM,EAAE,MAAM,EACvB,OAAO,EAAE,iBAAiB;IAgB5B;;OAEG;IACH,YAAY;IAWZ;;;OAGG;IACH,QAAQ;IAoBR,2EAA2E;IAC3E,OAAO;IAWP,gBAAgB;IA2BhB,EAAE,CACA,SAAS,EAAE,iBAAiB,EAC5B,QAAQ,EAAE,iBAAiB,GAAG,oBAAoB;IAKpD,GAAG,CACD,SAAS,EAAE,iBAAiB,EAC5B,QAAQ,EAAE,iBAAiB,GAAG,oBAAoB;IAKpD,QAAQ;IAIF,UAAU,CAAC,WAAW,EAAE,eAAe;IAYvC,aAAa;IA0Cb,YAAY,CAAC,WAAW,EAAE,eAAe;IAWzC,UAAU,CAAC,WAAW,EAAE,eAAe;IAYvC,aAAa;IA0Cb,YAAY,CAAC,WAAW,EAAE,eAAe;IAWzC,gBAAgB,CACpB,WAAW,EAAE,eAAe,EAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAwB7B,cAAc,CAAC,WAAW,EAAE,eAAe;IAuE3C,iBAAiB;IA2BjB,qBAAqB;IA0CrB,gBAAgB,CAAC,WAAW,EAAE,eAAe;IAS7C,KAAK,CAAC,OAAO,GAAE,gBAAqB;;;;IA+GpC,aAAa;IAenB,OAAO,CAAC,SAAS;YAQH,oBAAoB;IAalC,OAAO,CAAC,eAAe;IAIvB,OAAO,CAAC,iCAAiC;YAiD3B,gBAAgB;YAsBhB,oBAAoB;IA2BlC,OAAO,CAAC,qBAAqB;IAoC7B,OAAO,CAAC,oBAAoB;IAoB5B,OAAO,CAAC,4BAA4B;IA0BpC;;;OAGG;IACH,OAAO,CAAC,sBAAsB;IAa9B,OAAO,CAAC,yBAAyB;IAUjC,OAAO,CAAC,SAAS;IAkBjB,OAAO,CAAC,sBAAsB;CA2B/B;AAED,eAAe,IAAI,CAAC"}
+{"version":3,"file":"feed.d.ts","sourceRoot":"","sources":["../../../../src/clients/feed/feed.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAG/C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAExC,OAAO,KAAK,MAAM,aAAa,CAAC;AAOhC,OAAO,EACL,iBAAiB,EAIjB,gBAAgB,EACjB,MAAM,cAAc,CAAC;AAEtB,OAAO,EACL,iBAAiB,EAEjB,iBAAiB,EAEjB,eAAe,EAEf,oBAAoB,EACpB,cAAc,EACf,MAAM,SAAS,CAAC;AAUjB,cAAM,IAAI;IAeN,QAAQ,CAAC,KAAK,EAAE,KAAK;IACrB,QAAQ,CAAC,MAAM,EAAE,MAAM;IAfzB,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,OAAO,CAAC,CAAU;IAC1B,OAAO,CAAC,WAAW,CAAe;IAClC,OAAO,CAAC,cAAc,CAAoB;IAC1C,OAAO,CAAC,gBAAgB,CAA2B;IACnD,OAAO,CAAC,eAAe,CAA8C;IACrE,OAAO,CAAC,8BAA8B,CAAkB;IACxD,OAAO,CAAC,uBAAuB,CAAwB;IACvD,OAAO,CAAC,iCAAiC,CAAkB;IAGpD,KAAK,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC;gBAG5B,KAAK,EAAE,KAAK,EACZ,MAAM,EAAE,MAAM,EACvB,OAAO,EAAE,iBAAiB;IAkB5B;;OAEG;IACH,YAAY;IAWZ;;;OAGG;IACH,QAAQ;IAoBR,2EAA2E;IAC3E,OAAO;IAWP,gBAAgB;IA2BhB,EAAE,CACA,SAAS,EAAE,iBAAiB,EAC5B,QAAQ,EAAE,iBAAiB,GAAG,oBAAoB;IAKpD,GAAG,CACD,SAAS,EAAE,iBAAiB,EAC5B,QAAQ,EAAE,iBAAiB,GAAG,oBAAoB;IAKpD,QAAQ;IAIF,UAAU,CAAC,WAAW,EAAE,eAAe;IAYvC,aAAa;IA0Cb,YAAY,CAAC,WAAW,EAAE,eAAe;IAWzC,UAAU,CAAC,WAAW,EAAE,eAAe;IAYvC,aAAa;IA0Cb,YAAY,CAAC,WAAW,EAAE,eAAe;IAWzC,gBAAgB,CACpB,WAAW,EAAE,eAAe,EAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAwB7B,cAAc,CAAC,WAAW,EAAE,eAAe;IAuE3C,iBAAiB;IA2BjB,qBAAqB;IA0CrB,gBAAgB,CAAC,WAAW,EAAE,eAAe;IAS7C,KAAK,CAAC,OAAO,GAAE,gBAAqB;;;;IAiFpC,aAAa;IAenB,OAAO,CAAC,SAAS;YAQH,oBAAoB;IAalC,OAAO,CAAC,eAAe;IAIvB,OAAO,CAAC,iCAAiC;YAiD3B,gBAAgB;YAsBhB,oBAAoB;IA2BlC,OAAO,CAAC,qBAAqB;IAoC7B,OAAO,CAAC,oBAAoB;IAoB5B,OAAO,CAAC,4BAA4B;IA0BpC;;;OAGG;IACH,OAAO,CAAC,sBAAsB;IAa9B,OAAO,CAAC,yBAAyB;IAUjC,OAAO,CAAC,SAAS;IAkBjB,OAAO,CAAC,sBAAsB;CA2B/B;AAED,eAAe,IAAI,CAAC"}

package/dist/types/clients/feed/utils.d.ts

@@ -1,4 +1,19 @@
-import { FeedItem } from './interfaces';
+import { FeedClientOptions, FeedItem } from './interfaces';
 export declare function deduplicateItems(items: FeedItem[]): FeedItem[];
 export declare function sortItems(items: FeedItem[]): FeedItem<import('@knocklabs/types').GenericData>[];
+export declare function mergeDateRangeParams(options: FeedClientOptions): {
+    before?: string;
+    after?: string;
+    page_size?: number;
+    status?: "unread" | "read" | "unseen" | "seen" | "all";
+    source?: string;
+    tenant?: string;
+    has_tenant?: boolean;
+    workflow_categories?: string[];
+    archived?: "include" | "exclude" | "only";
+    trigger_data?: import('@knocklabs/types').GenericData;
+    __experimentalCrossBrowserUpdates?: boolean;
+    auto_manage_socket_connection?: boolean;
+    auto_manage_socket_connection_delay?: number;
+};
 //# sourceMappingURL=utils.d.ts.map

package/dist/types/clients/feed/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../src/clients/feed/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAExC,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,QAAQ,EAAE,GAAG,QAAQ,EAAE,CAY9D;AAED,wBAAgB,SAAS,CAAC,KAAK,EAAE,QAAQ,EAAE,sDAM1C"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../src/clients/feed/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAE3D,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,QAAQ,EAAE,GAAG,QAAQ,EAAE,CAY9D;AAED,wBAAgB,SAAS,CAAC,KAAK,EAAE,QAAQ,EAAE,sDAM1C;AAED,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,iBAAiB;;;;;;;;;;;;;;EAyB9D"}

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

@@ -0,0 +1,103 @@
+import { GenericData } from '@knocklabs/types';
+import { Store } from '@tanstack/store';
+import { default as Knock } from '../../knock';
+export declare const guidesApiRootPath: (userId: string | undefined | null) => string;
+interface StepMessageState {
+    id: string;
+    seen_at: string | null;
+    read_at: string | null;
+    interacted_at: string | null;
+    archived_at: string | null;
+    link_clicked_at: string | null;
+}
+interface GuideStepData {
+    ref: string;
+    schema_key: string;
+    schema_semver: string;
+    schema_variant_key: string;
+    message: StepMessageState;
+    content: any;
+}
+interface GuideData {
+    __typename: "Guide";
+    channel_id: string;
+    id: string;
+    key: string;
+    priority: number;
+    type: string;
+    semver: string;
+    steps: GuideStepData[];
+    inserted_at: string;
+    updated_at: string;
+}
+export interface KnockGuideStep extends GuideStepData {
+    markAsSeen: () => void;
+    markAsInteracted: (params?: {
+        metadata?: GenericData;
+    }) => void;
+    markAsArchived: () => void;
+}
+export interface KnockGuide extends GuideData {
+    steps: KnockGuideStep[];
+}
+type GetGuidesQueryParams = {
+    data?: string;
+    tenant?: string;
+    type?: string;
+};
+export type GuideEngagementEventBaseParams = {
+    message_id: string;
+    channel_id: string;
+    guide_key: string;
+    guide_id: string;
+    guide_step_ref: string;
+};
+type QueryKey = string;
+type QueryStatus = {
+    status: "loading" | "ok" | "error";
+    error?: Error;
+};
+type StoreState = {
+    guides: KnockGuide[];
+    queries: Record<QueryKey, QueryStatus>;
+};
+type QueryFilterParams = Pick<GetGuidesQueryParams, "type">;
+export type SelectFilterParams = {
+    key?: string;
+    type?: string;
+};
+export type TargetParams = {
+    data?: GenericData | undefined;
+    tenant?: string | undefined;
+};
+export declare class KnockGuideClient {
+    readonly knock: Knock;
+    readonly channelId: string;
+    readonly targetParams: TargetParams;
+    store: Store<StoreState, (state: StoreState) => StoreState>;
+    private socket;
+    private socketChannel;
+    private socketChannelTopic;
+    private socketEventTypes;
+    constructor(knock: Knock, channelId: string, targetParams?: TargetParams);
+    fetch(opts?: {
+        filters?: QueryFilterParams;
+    }): Promise<QueryStatus>;
+    subscribe(): void;
+    unsubscribe(): void;
+    private handleSocketEvent;
+    select(state: StoreState, filters?: SelectFilterParams): KnockGuide[];
+    markAsSeen(guide: GuideData, step: GuideStepData): Promise<KnockGuideStep | undefined>;
+    markAsInteracted(guide: GuideData, step: GuideStepData, metadata?: GenericData): Promise<KnockGuideStep | undefined>;
+    markAsArchived(guide: GuideData, step: GuideStepData): Promise<KnockGuideStep | undefined>;
+    private localCopy;
+    private buildQueryParams;
+    private formatQueryKey;
+    private setStepMessageAttrs;
+    private buildEngagementEventBaseParams;
+    private addGuide;
+    private replaceOrAddGuide;
+    private removeGuide;
+}
+export {};
+//# sourceMappingURL=client.d.ts.map

package/dist/types/clients/guide/client.d.ts.map

@@ -0,0 +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;AAGxC,OAAO,KAAK,MAAM,aAAa,CAAC;AAchC,eAAO,MAAM,iBAAiB,GAAI,QAAQ,MAAM,GAAG,SAAS,GAAG,IAAI,WACrC,CAAC;AAE/B,UAAU,gBAAgB;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED,UAAU,aAAa;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;IACtB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,OAAO,EAAE,gBAAgB,CAAC;IAE1B,OAAO,EAAE,GAAG,CAAC;CACd;AAED,UAAU,SAAS;IACjB,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,aAAa,EAAE,CAAC;IACvB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,cAAe,SAAQ,aAAa;IACnD,UAAU,EAAE,MAAM,IAAI,CAAC;IACvB,gBAAgB,EAAE,CAAC,MAAM,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,WAAW,CAAA;KAAE,KAAK,IAAI,CAAC;IAChE,cAAc,EAAE,MAAM,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,UAAW,SAAQ,SAAS;IAC3C,KAAK,EAAE,cAAc,EAAE,CAAC;CACzB;AAED,KAAK,oBAAoB,GAAG;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAMF,MAAM,MAAM,8BAA8B,GAAG;IAE3C,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AA6CF,KAAK,QAAQ,GAAG,MAAM,CAAC;AAEvB,KAAK,WAAW,GAAG;IACjB,MAAM,EAAE,SAAS,GAAG,IAAI,GAAG,OAAO,CAAC;IACnC,KAAK,CAAC,EAAE,KAAK,CAAC;CACf,CAAC;AAEF,KAAK,UAAU,GAAG;IAChB,MAAM,EAAE,UAAU,EAAE,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;CACxC,CAAC;AAEF,KAAK,iBAAiB,GAAG,IAAI,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;AAE5D,MAAM,MAAM,kBAAkB,GAAG;IAC/B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IAC/B,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B,CAAC;AAEF,qBAAa,gBAAgB;IAUzB,QAAQ,CAAC,KAAK,EAAE,KAAK;IACrB,QAAQ,CAAC,SAAS,EAAE,MAAM;IAC1B,QAAQ,CAAC,YAAY,EAAE,YAAY;IAX9B,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,CAAqD;gBAGlE,KAAK,EAAE,KAAK,EACZ,SAAS,EAAE,MAAM,EACjB,YAAY,GAAE,YAAiB;IAepC,KAAK,CAAC,IAAI,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,iBAAiB,CAAA;KAAE;IA+ClD,SAAS;IA+BT,WAAW;IAcX,OAAO,CAAC,iBAAiB;IAwBzB,MAAM,CAAC,KAAK,EAAE,UAAU,EAAE,OAAO,GAAE,kBAAuB;IAuBpD,UAAU,CAAC,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,aAAa;IAyBhD,gBAAgB,CACpB,KAAK,EAAE,SAAS,EAChB,IAAI,EAAE,aAAa,EACnB,QAAQ,CAAC,EAAE,WAAW;IA0BlB,cAAc,CAAC,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,aAAa;IAwB1D,OAAO,CAAC,SAAS;IAuCjB,OAAO,CAAC,gBAAgB;IAmBxB,OAAO,CAAC,cAAc;IActB,OAAO,CAAC,mBAAmB;IA6B3B,OAAO,CAAC,8BAA8B;IAatC,OAAO,CAAC,QAAQ;IAQhB,OAAO,CAAC,iBAAiB;IAmBzB,OAAO,CAAC,WAAW;CAMpB"}

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

@@ -0,0 +1,3 @@
+export { KnockGuideClient } from './client';
+export type { KnockGuide, KnockGuideStep, TargetParams as KnockGuideTargetParams, SelectFilterParams as KnockGuideFilterParams, } from './client';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/clients/guide/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/clients/guide/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAC5C,YAAY,EACV,UAAU,EACV,cAAc,EACd,YAAY,IAAI,sBAAsB,EACtC,kBAAkB,IAAI,sBAAsB,GAC7C,MAAM,UAAU,CAAC"}

package/dist/types/clients/users/index.d.ts

@@ -1,6 +1,7 @@
 import { GenericData } from '@knocklabs/types';
 import { ChannelData, User } from '../../interfaces';
 import { default as Knock } from '../../knock';
+import { GuideEngagementEventBaseParams } from '../guide/client';
 import { GetPreferencesOptions, PreferenceOptions, PreferenceSet, SetPreferencesProperties } from '../preferences/interfaces';
 import { GetChannelDataInput, SetChannelDataInput } from './interfaces';
 declare class UserClient {
@@ -13,6 +14,8 @@ declare class UserClient {
     setPreferences(preferenceSet: SetPreferencesProperties, options?: PreferenceOptions): Promise<PreferenceSet>;
     getChannelData<T = GenericData>(params: GetChannelDataInput): Promise<ChannelData<T>>;
     setChannelData<T = GenericData>({ channelId, channelData, }: SetChannelDataInput): Promise<ChannelData<T>>;
+    getGuides<P, R>(channelId: string, params: P): Promise<R>;
+    markGuideStepAs<P extends GuideEngagementEventBaseParams, R>(status: "seen" | "interacted" | "archived", params: P): Promise<R>;
     private handleResponse;
 }
 export default UserClient;

package/dist/types/clients/users/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/clients/users/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAG/C,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,KAAK,MAAM,aAAa,CAAC;AAChC,OAAO,EACL,qBAAqB,EACrB,iBAAiB,EACjB,aAAa,EACb,wBAAwB,EACzB,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAIxE,cAAM,UAAU;IACd,OAAO,CAAC,QAAQ,CAAQ;gBAEZ,QAAQ,EAAE,KAAK;IAIrB,GAAG;IAWH,QAAQ,CAAC,KAAK,GAAE,WAAgB;IAYhC,iBAAiB;IAWjB,cAAc,CAClB,OAAO,GAAE,qBAA0B,GAClC,OAAO,CAAC,aAAa,CAAC;IAanB,cAAc,CAClB,aAAa,EAAE,wBAAwB,EACvC,OAAO,GAAE,iBAAsB,GAC9B,OAAO,CAAC,aAAa,CAAC;IAanB,cAAc,CAAC,CAAC,GAAG,WAAW,EAAE,MAAM,EAAE,mBAAmB;IAW3D,cAAc,CAAC,CAAC,GAAG,WAAW,EAAE,EACpC,SAAS,EACT,WAAW,GACZ,EAAE,mBAAmB;IAYtB,OAAO,CAAC,cAAc;CAOvB;AAED,eAAe,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/clients/users/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAG/C,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,KAAK,MAAM,aAAa,CAAC;AAChC,OAAO,EACL,8BAA8B,EAE/B,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,qBAAqB,EACrB,iBAAiB,EACjB,aAAa,EACb,wBAAwB,EACzB,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAIxE,cAAM,UAAU;IACd,OAAO,CAAC,QAAQ,CAAQ;gBAEZ,QAAQ,EAAE,KAAK;IAIrB,GAAG;IAWH,QAAQ,CAAC,KAAK,GAAE,WAAgB;IAYhC,iBAAiB;IAWjB,cAAc,CAClB,OAAO,GAAE,qBAA0B,GAClC,OAAO,CAAC,aAAa,CAAC;IAanB,cAAc,CAClB,aAAa,EAAE,wBAAwB,EACvC,OAAO,GAAE,iBAAsB,GAC9B,OAAO,CAAC,aAAa,CAAC;IAanB,cAAc,CAAC,CAAC,GAAG,WAAW,EAAE,MAAM,EAAE,mBAAmB;IAW3D,cAAc,CAAC,CAAC,GAAG,WAAW,EAAE,EACpC,SAAS,EACT,WAAW,GACZ,EAAE,mBAAmB;IAYhB,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;IAU5C,eAAe,CAAC,CAAC,SAAS,8BAA8B,EAAE,CAAC,EAC/D,MAAM,EAAE,MAAM,GAAG,YAAY,GAAG,UAAU,EAC1C,MAAM,EAAE,CAAC;IAWX,OAAO,CAAC,cAAc;CAOvB;AAED,eAAe,UAAU,CAAC"}

package/dist/types/index.d.ts

@@ -1,6 +1,7 @@
 import { default as FeedClient, Feed } from './clients/feed';
 import { default as Knock } from './knock';
 export * from './interfaces';
+export * from './clients/guide';
 export * from './clients/feed/types';
 export * from './clients/feed/interfaces';
 export * from './clients/objects';

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,EAAE,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,KAAK,MAAM,SAAS,CAAC;AAE5B,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mBAAmB,CAAC;AAClC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,kCAAkC,CAAC;AACjD,cAAc,iBAAiB,CAAC;AAChC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,oBAAoB,CAAC;AACnC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,iBAAiB,CAAC;AAChC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,oBAAoB,CAAC;AACnC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,iBAAiB,CAAC;AAEhC,eAAe,KAAK,CAAC;AACrB,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,EAAE,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,KAAK,MAAM,SAAS,CAAC;AAE5B,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mBAAmB,CAAC;AAClC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,kCAAkC,CAAC;AACjD,cAAc,iBAAiB,CAAC;AAChC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,oBAAoB,CAAC;AACnC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,iBAAiB,CAAC;AAChC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,oBAAoB,CAAC;AACnC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,iBAAiB,CAAC;AAEhC,eAAe,KAAK,CAAC;AACrB,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC"}