@guidelytech/sdk-core 0.14.0 → 0.16.0

package/dist/index.d.cts

@@ -13,7 +13,7 @@ export { C as CaptureMarker, a as CaptureOutgoingMessage } from './capture-4Egpj
 import './http-zOI8d2c2.cjs';
 
 declare const SDK_NAME = "@guidelytech/sdk-core";
-declare const SDK_VERSION = "0.14.0";
+declare const SDK_VERSION = "0.16.0";
 declare const DEFAULT_API_URL = "https://api.guidely.app";
 /**
  * Framework-independent Guidely client. Create one per page with {@link createGuidely} or
@@ -252,6 +252,11 @@ declare class GuidelyClient {
     getGuides(): ReadonlyArray<PublishedGuide>;
     isGuideCompleted(idOrKey: string): boolean;
     openResourceCenter(): void;
+    /**
+     * Opens one help article: in Scout's Help tab when the messenger is on, otherwise in the resource
+     * center. Help-article links in guides (`#guidely-article:<id>`) call this.
+     */
+    openArticle(articleId: string): void;
     closeResourceCenter(): void;
     /** Opens the Scout messenger (when enabled for the project), optionally on a tab. */
     openMessenger(tab?: MessengerTab): void;

package/dist/index.d.ts

@@ -13,7 +13,7 @@ export { C as CaptureMarker, a as CaptureOutgoingMessage } from './capture-C-4R5
 import './http-BXys2d-j.js';
 
 declare const SDK_NAME = "@guidelytech/sdk-core";
-declare const SDK_VERSION = "0.14.0";
+declare const SDK_VERSION = "0.16.0";
 declare const DEFAULT_API_URL = "https://api.guidely.app";
 /**
  * Framework-independent Guidely client. Create one per page with {@link createGuidely} or
@@ -252,6 +252,11 @@ declare class GuidelyClient {
     getGuides(): ReadonlyArray<PublishedGuide>;
     isGuideCompleted(idOrKey: string): boolean;
     openResourceCenter(): void;
+    /**
+     * Opens one help article: in Scout's Help tab when the messenger is on, otherwise in the resource
+     * center. Help-article links in guides (`#guidely-article:<id>`) call this.
+     */
+    openArticle(articleId: string): void;
     closeResourceCenter(): void;
     /** Opens the Scout messenger (when enabled for the project), optionally on a tab. */
     openMessenger(tab?: MessengerTab): void;

package/dist/index.js

@@ -22,7 +22,7 @@ import {
 } from "./chunk-XML74K2P.js";
 
 // src/client.ts
-import { evaluateRules, localizeGuide, localizeResourceCenter, normalizeLocale, randomId as randomId2, rolloutBucket, sanitizeProperties, supportsPlatform, visibleAnnouncements, visitorLocales } from "@guidelytech/shared/runtime";
+import { articleIdFromHref, evaluateRules, localizeGuide, localizeResourceCenter, normalizeLocale, randomId as randomId2, rolloutBucket, sanitizeProperties, supportsPlatform, visibleAnnouncements, visitorLocales } from "@guidelytech/shared/runtime";
 import {
   closestComposed as closestComposed4,
   composedTarget,
@@ -1098,7 +1098,7 @@ function createMessengerTransport(opts) {
 }
 
 // src/messenger-visitor.ts
-import { firstNameFromTraits } from "@guidelytech/shared/runtime";
+import { firstNameFromTraits, videoThumbnailUrl } from "@guidelytech/shared/runtime";
 import { urlMatches } from "@guidelytech/guide-runtime";
 var PAGE_GUIDE_KINDS = /* @__PURE__ */ new Set(["flow", "tooltip", "modal"]);
 var CATCH_ALL = /* @__PURE__ */ new Set(["", "*", "**", "/*", "/**", "/"]);
@@ -1159,7 +1159,7 @@ function buildMessengerVisitor(input) {
       key: g.key,
       title: step.title || g.name,
       body: plainText(step.body ?? ""),
-      imageUrl: step.imageUrl || null,
+      imageUrl: step.imageUrl || videoThumbnailUrl(step.videoUrl) || null,
       publishedAt: g.publishedAt,
       // Read once opened in the News tab, or once the announcement itself was shown.
       unread: !seen.has(g.id) && !(state.guides[g.id]?.impressions ?? 0)
@@ -1415,7 +1415,7 @@ var loadRecorder = async () => (await import("./recorder.js")).recorder;
 
 // src/client.ts
 var SDK_NAME = "@guidelytech/sdk-core";
-var SDK_VERSION = "0.14.0";
+var SDK_VERSION = "0.16.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;
@@ -1681,6 +1681,15 @@ var GuidelyClient = class _GuidelyClient {
     const onClick = (e) => this.handleDocumentClick(e);
     doc.addEventListener("click", onClick, true);
     this.cleanups.push(() => doc.removeEventListener("click", onClick, true));
+    const onArticleLink = (e) => {
+      if (e.defaultPrevented) return;
+      const articleId = articleIdFromHref(composedTarget(e)?.closest?.("a[href]")?.getAttribute("href"));
+      if (!articleId) return;
+      e.preventDefault();
+      this.openArticle(articleId);
+    };
+    doc.addEventListener("click", onArticleLink);
+    this.cleanups.push(() => doc.removeEventListener("click", onArticleLink));
     const onVisibility = () => {
       const hidden = doc.visibilityState === "hidden";
       this.pageTracker.setHidden(hidden);
@@ -2654,6 +2663,7 @@ var GuidelyClient = class _GuidelyClient {
         if (action === "start_guide" && value) this.setTimer(() => this.startGuide(value), 0);
         else if (action === "event" && value) this.track(value);
         else if (action === "open_resource_center") this.openResourceCenter();
+        else if (action === "open_article" && value) this.openArticle(value);
       },
       onEnd: (reason) => {
         if (exclusive) {
@@ -3064,6 +3074,19 @@ var GuidelyClient = class _GuidelyClient {
     if (!this.resourceCenter) this.renderPersistentWidgets();
     this.resourceCenter?.open();
   }
+  /**
+   * Opens one help article: in Scout's Help tab when the messenger is on, otherwise in the resource
+   * center. Help-article links in guides (`#guidely-article:<id>`) call this.
+   */
+  openArticle(articleId) {
+    if (this.config?.messenger?.enabled) {
+      void this.loadMessenger().then((m) => m?.openArticle(articleId));
+      return;
+    }
+    if (!this.resourceCenter) this.renderPersistentWidgets();
+    if (this.resourceCenter) this.resourceCenter.openArticle(articleId);
+    else this.log("openArticle: the resource center is not enabled or published for this environment");
+  }
   closeResourceCenter() {
     if (this.messenger) return this.closeMessenger();
     this.resourceCenter?.close();