@guidelytech/sdk-core 0.1.0 → 0.2.0

package/dist/index.d.cts

@@ -1,6 +1,7 @@
 import * as _guidelytech_guide_runtime from '@guidelytech/guide-runtime';
-import { PublishedGuide, FrequencyConfig, ProjectTheme, SdkConfigResponse, ChecklistTask, SdkEvent, TargetingContext, SelectorStrategy, AuthoringPick } from '@guidelytech/shared';
-export { GuideConfig, GuideStep, PublishedGuide, SdkConfigResponse, SdkEvent, TargetingContext } from '@guidelytech/shared';
+import { PublishedGuide, FrequencyConfig, ProjectTheme, SdkConfigResponse, ChecklistTask, MessengerMessage, MessengerConversation, SdkEvent, TargetingContext, SelectorStrategy, AuthoringPick, AppSnapshot } from '@guidelytech/shared';
+export { AppSnapshot, GuideConfig, GuideStep, PublishedGuide, SdkConfigResponse, SdkEvent, TargetingContext } from '@guidelytech/shared';
+import { MessengerTab } from '@guidelytech/guide-runtime/messenger';
 
 /** Per-guide state kept locally and merged with the server's `IdentifyResponse.guideState`. */
 interface GuideLocalState {
@@ -50,6 +51,8 @@ declare const KEYS: {
     readonly session: "guidely:session";
     readonly active: "guidely:active";
     readonly authoring: "guidely:authoring";
+    /** Messenger conversations this browser can read: [{ id, token }]. */
+    readonly conversations: (key: string) => string;
 };
 
 type GuidelyEnvironment = "development" | "staging" | "production";
@@ -139,6 +142,12 @@ interface GuidelyEvents {
         responseId: string;
     }) => void;
     "resource-center:open": () => void;
+    "messenger:open": () => void;
+    /** A Scout or teammate message arrived in the messenger. */
+    "conversation:message": (info: {
+        message: MessengerMessage;
+        conversation: MessengerConversation;
+    }) => void;
     error: (error: Error) => void;
     /** Every tracked event (custom and lifecycle). */
     track: (event: SdkEvent) => void;
@@ -153,7 +162,7 @@ interface GuidelyEvents {
 type GuidelyEventName = keyof GuidelyEvents;
 
 declare const SDK_NAME = "@guidelytech/sdk-core";
-declare const SDK_VERSION = "0.1.0";
+declare const SDK_VERSION = "0.2.0";
 declare const DEFAULT_API_URL = "https://api.guidely.app";
 /**
  * Framework-independent Guidely client. Create one per page with {@link createGuidely} or
@@ -182,6 +191,9 @@ declare class GuidelyClient {
     private widgets;
     private resourceCenter;
     private resourceCenterScope;
+    private messenger;
+    private messengerScope;
+    private messengerLoading;
     private cleanups;
     private timers;
     private visibilityObservers;
@@ -190,6 +202,8 @@ declare class GuidelyClient {
     private lastUrl;
     private authoring;
     private lastAudiences;
+    /** Set once the app calls identify()/reset(); bootstrap then leaves identity alone instead of re-identifying. */
+    private identitySettled;
     constructor(options: GuidelyOptions);
     /** Loads config (cache first, then network), wires listeners and evaluates triggers. Idempotent. */
     init(): Promise<void>;
@@ -249,6 +263,10 @@ declare class GuidelyClient {
     private navigate;
     private renderPersistentWidgets;
     private resumeActiveGuide;
+    /** Loads the messenger widget on demand (it is a separate chunk) and renders it. */
+    private loadMessenger;
+    private destroyMessenger;
+    private loadArticle;
     private searchResourceCenter;
     /** Current progress for a checklist guide (by id or key). */
     getChecklistProgress(idOrKey: string): ChecklistProgressState;
@@ -275,6 +293,11 @@ declare class GuidelyClient {
     isGuideCompleted(idOrKey: string): boolean;
     openResourceCenter(): void;
     closeResourceCenter(): void;
+    /** Opens the Scout messenger (when enabled for the project), optionally on a tab. */
+    openMessenger(tab?: MessengerTab): void;
+    closeMessenger(): void;
+    /** Opens a new messenger conversation, optionally pre-filling the message. */
+    showNewMessage(text?: string): void;
     on<K extends keyof GuidelyEvents>(event: K, cb: GuidelyEvents[K]): () => void;
     off<K extends keyof GuidelyEvents>(event: K, cb: GuidelyEvents[K]): void;
     /** Snapshot for debugging / devtools. */
@@ -436,6 +459,10 @@ type AuthoringOutgoingMessage = {
     type: "guidely:pong";
     sessionId: string;
     url: string;
+} | {
+    type: "guidely:snapshot";
+    sessionId: string;
+    snapshot: AppSnapshot;
 };
 /** Messages the dashboard may post to the app window (origin-checked against `dashboardOrigin`). */
 type AuthoringIncomingMessage = {
@@ -460,10 +487,20 @@ type AuthoringIncomingMessage = {
     type: "guidely:stop-preview";
 } | {
     type: "guidely:ping";
+} | {
+    type: "guidely:request-snapshot";
 } | {
     type: "guidely:exit";
 };
 
+/**
+ * Serializes the current page into a static HTML document for the dashboard's editor canvas.
+ * Scripts, event handlers, Guidely's own UI and form values are dropped; `maskSelectors` text is
+ * replaced with bullets. Same-origin CSSOM rules are inlined; everything else resolves through a
+ * `<base href>` so stylesheets and images load from the app.
+ */
+declare function captureSnapshot(doc: Document, maskSelectors: string[], maxBytes?: number): AppSnapshot | null;
+
 /**
  * @guidelytech/sdk-core — framework-independent Guidely browser SDK.
  *
@@ -479,4 +516,4 @@ declare const Guidely: {
     version: string;
 };
 
-export { AUTHORING_PARAM, type AuthoringIncomingMessage, type AuthoringOutgoingMessage, type ChecklistProgressState, type ConsentState, type ContextInput, DEFAULT_API_URL, type DeviceInfo, EventQueue, type EventQueueOptions, type GuideLocalState, type GuideStepInfo, Guidely, type GuidelyAccount, GuidelyClient, type GuidelyEnvironment, type GuidelyEventName, type GuidelyEvents, type GuidelyOptions, type GuidelyUser, HEARTBEAT_MS, KEYS, type KeyValueStore, type PersistedState, SDK_NAME, SDK_VERSION, type SessionState, type StorageKind, areMutuallyExclusive, buildContext, createGuidely, createStorage, Guidely as default, detectDevice, isExclusiveGuide, isFrequencyEligible, isWithinSchedule, watchNavigation };
+export { AUTHORING_PARAM, type AuthoringIncomingMessage, type AuthoringOutgoingMessage, type ChecklistProgressState, type ConsentState, type ContextInput, DEFAULT_API_URL, type DeviceInfo, EventQueue, type EventQueueOptions, type GuideLocalState, type GuideStepInfo, Guidely, type GuidelyAccount, GuidelyClient, type GuidelyEnvironment, type GuidelyEventName, type GuidelyEvents, type GuidelyOptions, type GuidelyUser, HEARTBEAT_MS, KEYS, type KeyValueStore, type PersistedState, SDK_NAME, SDK_VERSION, type SessionState, type StorageKind, areMutuallyExclusive, buildContext, captureSnapshot, createGuidely, createStorage, Guidely as default, detectDevice, isExclusiveGuide, isFrequencyEligible, isWithinSchedule, watchNavigation };

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 import * as _guidelytech_guide_runtime from '@guidelytech/guide-runtime';
-import { PublishedGuide, FrequencyConfig, ProjectTheme, SdkConfigResponse, ChecklistTask, SdkEvent, TargetingContext, SelectorStrategy, AuthoringPick } from '@guidelytech/shared';
-export { GuideConfig, GuideStep, PublishedGuide, SdkConfigResponse, SdkEvent, TargetingContext } from '@guidelytech/shared';
+import { PublishedGuide, FrequencyConfig, ProjectTheme, SdkConfigResponse, ChecklistTask, MessengerMessage, MessengerConversation, SdkEvent, TargetingContext, SelectorStrategy, AuthoringPick, AppSnapshot } from '@guidelytech/shared';
+export { AppSnapshot, GuideConfig, GuideStep, PublishedGuide, SdkConfigResponse, SdkEvent, TargetingContext } from '@guidelytech/shared';
+import { MessengerTab } from '@guidelytech/guide-runtime/messenger';
 
 /** Per-guide state kept locally and merged with the server's `IdentifyResponse.guideState`. */
 interface GuideLocalState {
@@ -50,6 +51,8 @@ declare const KEYS: {
     readonly session: "guidely:session";
     readonly active: "guidely:active";
     readonly authoring: "guidely:authoring";
+    /** Messenger conversations this browser can read: [{ id, token }]. */
+    readonly conversations: (key: string) => string;
 };
 
 type GuidelyEnvironment = "development" | "staging" | "production";
@@ -139,6 +142,12 @@ interface GuidelyEvents {
         responseId: string;
     }) => void;
     "resource-center:open": () => void;
+    "messenger:open": () => void;
+    /** A Scout or teammate message arrived in the messenger. */
+    "conversation:message": (info: {
+        message: MessengerMessage;
+        conversation: MessengerConversation;
+    }) => void;
     error: (error: Error) => void;
     /** Every tracked event (custom and lifecycle). */
     track: (event: SdkEvent) => void;
@@ -153,7 +162,7 @@ interface GuidelyEvents {
 type GuidelyEventName = keyof GuidelyEvents;
 
 declare const SDK_NAME = "@guidelytech/sdk-core";
-declare const SDK_VERSION = "0.1.0";
+declare const SDK_VERSION = "0.2.0";
 declare const DEFAULT_API_URL = "https://api.guidely.app";
 /**
  * Framework-independent Guidely client. Create one per page with {@link createGuidely} or
@@ -182,6 +191,9 @@ declare class GuidelyClient {
     private widgets;
     private resourceCenter;
     private resourceCenterScope;
+    private messenger;
+    private messengerScope;
+    private messengerLoading;
     private cleanups;
     private timers;
     private visibilityObservers;
@@ -190,6 +202,8 @@ declare class GuidelyClient {
     private lastUrl;
     private authoring;
     private lastAudiences;
+    /** Set once the app calls identify()/reset(); bootstrap then leaves identity alone instead of re-identifying. */
+    private identitySettled;
     constructor(options: GuidelyOptions);
     /** Loads config (cache first, then network), wires listeners and evaluates triggers. Idempotent. */
     init(): Promise<void>;
@@ -249,6 +263,10 @@ declare class GuidelyClient {
     private navigate;
     private renderPersistentWidgets;
     private resumeActiveGuide;
+    /** Loads the messenger widget on demand (it is a separate chunk) and renders it. */
+    private loadMessenger;
+    private destroyMessenger;
+    private loadArticle;
     private searchResourceCenter;
     /** Current progress for a checklist guide (by id or key). */
     getChecklistProgress(idOrKey: string): ChecklistProgressState;
@@ -275,6 +293,11 @@ declare class GuidelyClient {
     isGuideCompleted(idOrKey: string): boolean;
     openResourceCenter(): void;
     closeResourceCenter(): void;
+    /** Opens the Scout messenger (when enabled for the project), optionally on a tab. */
+    openMessenger(tab?: MessengerTab): void;
+    closeMessenger(): void;
+    /** Opens a new messenger conversation, optionally pre-filling the message. */
+    showNewMessage(text?: string): void;
     on<K extends keyof GuidelyEvents>(event: K, cb: GuidelyEvents[K]): () => void;
     off<K extends keyof GuidelyEvents>(event: K, cb: GuidelyEvents[K]): void;
     /** Snapshot for debugging / devtools. */
@@ -436,6 +459,10 @@ type AuthoringOutgoingMessage = {
     type: "guidely:pong";
     sessionId: string;
     url: string;
+} | {
+    type: "guidely:snapshot";
+    sessionId: string;
+    snapshot: AppSnapshot;
 };
 /** Messages the dashboard may post to the app window (origin-checked against `dashboardOrigin`). */
 type AuthoringIncomingMessage = {
@@ -460,10 +487,20 @@ type AuthoringIncomingMessage = {
     type: "guidely:stop-preview";
 } | {
     type: "guidely:ping";
+} | {
+    type: "guidely:request-snapshot";
 } | {
     type: "guidely:exit";
 };
 
+/**
+ * Serializes the current page into a static HTML document for the dashboard's editor canvas.
+ * Scripts, event handlers, Guidely's own UI and form values are dropped; `maskSelectors` text is
+ * replaced with bullets. Same-origin CSSOM rules are inlined; everything else resolves through a
+ * `<base href>` so stylesheets and images load from the app.
+ */
+declare function captureSnapshot(doc: Document, maskSelectors: string[], maxBytes?: number): AppSnapshot | null;
+
 /**
  * @guidelytech/sdk-core — framework-independent Guidely browser SDK.
  *
@@ -479,4 +516,4 @@ declare const Guidely: {
     version: string;
 };
 
-export { AUTHORING_PARAM, type AuthoringIncomingMessage, type AuthoringOutgoingMessage, type ChecklistProgressState, type ConsentState, type ContextInput, DEFAULT_API_URL, type DeviceInfo, EventQueue, type EventQueueOptions, type GuideLocalState, type GuideStepInfo, Guidely, type GuidelyAccount, GuidelyClient, type GuidelyEnvironment, type GuidelyEventName, type GuidelyEvents, type GuidelyOptions, type GuidelyUser, HEARTBEAT_MS, KEYS, type KeyValueStore, type PersistedState, SDK_NAME, SDK_VERSION, type SessionState, type StorageKind, areMutuallyExclusive, buildContext, createGuidely, createStorage, Guidely as default, detectDevice, isExclusiveGuide, isFrequencyEligible, isWithinSchedule, watchNavigation };
+export { AUTHORING_PARAM, type AuthoringIncomingMessage, type AuthoringOutgoingMessage, type ChecklistProgressState, type ConsentState, type ContextInput, DEFAULT_API_URL, type DeviceInfo, EventQueue, type EventQueueOptions, type GuideLocalState, type GuideStepInfo, Guidely, type GuidelyAccount, GuidelyClient, type GuidelyEnvironment, type GuidelyEventName, type GuidelyEvents, type GuidelyOptions, type GuidelyUser, HEARTBEAT_MS, KEYS, type KeyValueStore, type PersistedState, SDK_NAME, SDK_VERSION, type SessionState, type StorageKind, areMutuallyExclusive, buildContext, captureSnapshot, createGuidely, createStorage, Guidely as default, detectDevice, isExclusiveGuide, isFrequencyEligible, isWithinSchedule, watchNavigation };