@guidelytech/sdk-core 0.8.0 → 0.9.0

package/dist/index.d.cts

@@ -4,14 +4,14 @@ export { AppSnapshot, AutocaptureSettings, ExceptionProperties, GuideConfig, Gui
 import { FlagsClient, JsonValue, FlagValue, FlagDetails } from '@guidelytech/flags';
 export { Attributes, EvaluationResult, FlagDetails, FlagsBootstrap, FlagsClient, FlagsClientOptions, FlagsPayload, JsonValue } from '@guidelytech/flags';
 import { MessengerTab } from '@guidelytech/guide-runtime/messenger';
-import { j as GuidelyOptions, c as GuidelyAccount, a as ConsentState, C as ChecklistProgressState, k as GuidelyEvents, e as GuidelyUser, G as GuideLocalState, S as SessionState } from './types-DbKQPvFt.cjs';
-export { E as EventQueue, b as EventQueueOptions, l as GuideStepInfo, d as GuidelyEnvironment, m as GuidelyEventName, P as PersistedState, f as areMutuallyExclusive, i as isExclusiveGuide, g as isFrequencyEligible, h as isWithinSchedule } from './types-DbKQPvFt.cjs';
+import { k as GuidelyOptions, c as GuidelyAccount, a as ConsentState, C as ChecklistProgressState, l as GuidelyEvents, e as GuidelyUser, G as GuideLocalState, S as SessionState } from './types-zM5e3loY.cjs';
+export { E as EventQueue, b as EventQueueOptions, m as GuideStepInfo, d as GuidelyEnvironment, n as GuidelyEventName, P as PersistedState, f as areMutuallyExclusive, i as isExclusiveGuide, h as isFrequencyEligible, j as isWithinSchedule } from './types-zM5e3loY.cjs';
 export { K as KEYS, b as KeyValueStore, S as StorageKind, d as createStorage } from './http-47tiAlOM.cjs';
 export { C as CaptureMarker, a as CaptureOutgoingMessage } from './capture-C3faAYb7.cjs';
 export { CAPTURE_PARAM } from '@guidelytech/shared/runtime';
 
 declare const SDK_NAME = "@guidelytech/sdk-core";
-declare const SDK_VERSION = "0.8.0";
+declare const SDK_VERSION = "0.9.0";
 declare const DEFAULT_API_URL = "https://api.guidely.app";
 /**
  * Framework-independent Guidely client. Create one per page with {@link createGuidely} or
@@ -214,6 +214,11 @@ declare class GuidelyClient {
     /** Opens the Scout messenger (when enabled for the project), optionally on a tab. */
     openMessenger(tab?: MessengerTab): void;
     closeMessenger(): void;
+    /**
+     * Opens the complaint form in the messenger, optionally with a category picked (its id from
+     * Complaints → Categories). Does nothing when the project doesn't take complaints.
+     */
+    openComplaint(categoryId?: string): void;
     /** Opens a new messenger conversation, optionally pre-filling the message. */
     showNewMessage(text?: string): void;
     /** Boolean flag value for the current user; `fallback` (default `false`) until loaded or when missing. */

package/dist/index.d.ts

@@ -4,14 +4,14 @@ export { AppSnapshot, AutocaptureSettings, ExceptionProperties, GuideConfig, Gui
 import { FlagsClient, JsonValue, FlagValue, FlagDetails } from '@guidelytech/flags';
 export { Attributes, EvaluationResult, FlagDetails, FlagsBootstrap, FlagsClient, FlagsClientOptions, FlagsPayload, JsonValue } from '@guidelytech/flags';
 import { MessengerTab } from '@guidelytech/guide-runtime/messenger';
-import { j as GuidelyOptions, c as GuidelyAccount, a as ConsentState, C as ChecklistProgressState, k as GuidelyEvents, e as GuidelyUser, G as GuideLocalState, S as SessionState } from './types-DqhNl5Am.js';
-export { E as EventQueue, b as EventQueueOptions, l as GuideStepInfo, d as GuidelyEnvironment, m as GuidelyEventName, P as PersistedState, f as areMutuallyExclusive, i as isExclusiveGuide, g as isFrequencyEligible, h as isWithinSchedule } from './types-DqhNl5Am.js';
+import { k as GuidelyOptions, c as GuidelyAccount, a as ConsentState, C as ChecklistProgressState, l as GuidelyEvents, e as GuidelyUser, G as GuideLocalState, S as SessionState } from './types-DnJW_4ck.js';
+export { E as EventQueue, b as EventQueueOptions, m as GuideStepInfo, d as GuidelyEnvironment, n as GuidelyEventName, P as PersistedState, f as areMutuallyExclusive, i as isExclusiveGuide, h as isFrequencyEligible, j as isWithinSchedule } from './types-DnJW_4ck.js';
 export { K as KEYS, b as KeyValueStore, S as StorageKind, d as createStorage } from './http-47tiAlOM.js';
 export { C as CaptureMarker, a as CaptureOutgoingMessage } from './capture-Dqd7up2n.js';
 export { CAPTURE_PARAM } from '@guidelytech/shared/runtime';
 
 declare const SDK_NAME = "@guidelytech/sdk-core";
-declare const SDK_VERSION = "0.8.0";
+declare const SDK_VERSION = "0.9.0";
 declare const DEFAULT_API_URL = "https://api.guidely.app";
 /**
  * Framework-independent Guidely client. Create one per page with {@link createGuidely} or
@@ -214,6 +214,11 @@ declare class GuidelyClient {
     /** Opens the Scout messenger (when enabled for the project), optionally on a tab. */
     openMessenger(tab?: MessengerTab): void;
     closeMessenger(): void;
+    /**
+     * Opens the complaint form in the messenger, optionally with a category picked (its id from
+     * Complaints → Categories). Does nothing when the project doesn't take complaints.
+     */
+    openComplaint(categoryId?: string): void;
     /** Opens a new messenger conversation, optionally pre-filling the message. */
     showNewMessage(text?: string): void;
     /** Boolean flag value for the current user; `fallback` (default `false`) until loaded or when missing. */

package/dist/index.js

@@ -2,10 +2,11 @@ import {
   Emitter,
   EventQueue,
   areMutuallyExclusive,
+  dismissedAfterMerge,
   isExclusiveGuide,
   isFrequencyEligible,
   isWithinSchedule
-} from "./chunk-GDF6RCHQ.js";
+} from "./chunk-544KSOC3.js";
 import {
   KEYS,
   createStorage,
@@ -730,11 +731,15 @@ function forgetConversations(store, projectId) {
   store.remove(KEYS.conversations(projectId));
 }
 var HttpError = class extends Error {
-  constructor(status) {
-    super(`Request failed (${status})`);
+  constructor(status, message) {
+    super(message || `Request failed (${status})`);
     __publicField(this, "status", status);
   }
 };
+function serverMessage(data) {
+  const m = data?.error?.message;
+  return typeof m === "string" && m !== "Request validation failed" ? m : void 0;
+}
 function createMessengerTransport(opts) {
   const { api, store, projectId } = opts;
   const tokenFor = (id) => storedConversations(store, projectId).find((c) => c.id === id)?.token ?? "";
@@ -816,6 +821,16 @@ function createMessengerTransport(opts) {
       const res = await api.get(`/articles/${encodeURIComponent(id)}`);
       return res.ok && res.data ? res.data.article : null;
     },
+    async fileComplaint(input) {
+      const headers = input.conversationId ? { [TOKEN_HEADER]: tokenFor(input.conversationId) } : {};
+      const res = await api.post("/complaints", { ...input, anonymousId: opts.anonymousId(), userId: opts.userId(), pageUrl: opts.pageUrl() }, { headers });
+      if (!res.ok || !res.data || !("complaint" in res.data)) {
+        if (res.status === 429) throw new HttpError(429, "You've filed several complaints just now. Please try again later.");
+        throw new HttpError(res.status, serverMessage(res.data) ?? "Your complaint couldn't be sent. Please try again.");
+      }
+      if (res.data.token) remember(res.data.conversation.id, res.data.token);
+      return res.data;
+    },
     async pageContent(path) {
       const res = await api.post("/messenger/page", { anonymousId: opts.anonymousId(), userId: opts.userId(), path: path.split(/[?#]/)[0] || "/" });
       if (!res.ok || !res.data) throw new HttpError(res.status);
@@ -1013,7 +1028,7 @@ var loadRecorder = async () => (await import("./recorder.js")).recorder;
 
 // src/client.ts
 var SDK_NAME = "@guidelytech/sdk-core";
-var SDK_VERSION = "0.8.0";
+var SDK_VERSION = "0.9.0";
 var DEFAULT_API_URL = "https://api.guidely.app";
 var PAGE_SCOPED = /* @__PURE__ */ new Set(["page_load", "url_match", "element_click", "element_visible", "delay"]);
 var DAY_MS = 24 * 60 * 60 * 1e3;
@@ -1421,7 +1436,8 @@ var GuidelyClient = class _GuidelyClient {
       checklists[id] = {
         completedTaskIds: Array.from(/* @__PURE__ */ new Set([...local?.completedTaskIds ?? [], ...p.completedTaskIds ?? []])),
         completedAt: local?.completedAt ?? p.completedAt ?? null,
-        dismissedAt: local?.dismissedAt ?? p.dismissedAt ?? null
+        dismissedAt: dismissedAfterMerge(local, p),
+        dismissResetAt: p.dismissResetAt ?? local?.dismissResetAt ?? null
       };
     }
     this.state = {
@@ -2060,6 +2076,12 @@ var GuidelyClient = class _GuidelyClient {
       ctx: () => this.getContext(),
       startAtStep: stepId,
       eventBus: this.eventBus,
+      // Started from Help, Scout or startGuide(): steps on other pages offer to take the user there.
+      promptForUrl: manual,
+      // Also while a step waits for its page, so a link that loads that page resumes on it.
+      onPosition: (id) => {
+        if (exclusive) writeJson(this.sessionStore, KEYS.active, { guideId: guide.id, stepId: id, manual });
+      },
       onError: (err) => this.reportError(err),
       onEvent: (e) => {
         const step = e.stepId ? guide.config.steps.find((s) => s.id === e.stepId) : void 0;
@@ -2283,7 +2305,7 @@ var GuidelyClient = class _GuidelyClient {
     const ctx = this.getContext();
     const url = location.href;
     const seen = readJson(this.store, KEYS.newsSeen(this.options.projectId), []);
-    return buildMessengerVisitor({
+    const visitor = buildMessengerVisitor({
       guides: this.config?.guides ?? [],
       state: this.state,
       traits: this.user?.traits,
@@ -2296,6 +2318,7 @@ var GuidelyClient = class _GuidelyClient {
       },
       newsSeen: Array.isArray(seen) ? seen : []
     });
+    return { ...visitor, identified: !!this.user?.id };
   }
   destroyMessenger() {
     this.messenger?.destroy();
@@ -2481,6 +2504,14 @@ var GuidelyClient = class _GuidelyClient {
   closeMessenger() {
     this.messenger?.close();
   }
+  /**
+   * Opens the complaint form in the messenger, optionally with a category picked (its id from
+   * Complaints → Categories). Does nothing when the project doesn't take complaints.
+   */
+  openComplaint(categoryId) {
+    if (!this.config?.messenger?.enabled || !this.config.messenger.complaints?.categories.length) return;
+    void this.loadMessenger().then((m) => m?.openComplaint(categoryId));
+  }
   /** Opens a new messenger conversation, optionally pre-filling the message. */
   showNewMessage(text) {
     if (!this.config?.messenger?.enabled) return;