@guidelytech/sdk-core 0.5.0 → 0.6.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.cts CHANGED
@@ -2,11 +2,14 @@ import * as _guidelytech_guide_runtime from '@guidelytech/guide-runtime';
2
2
  import { TargetingContext, PublishedGuide, ProjectTheme, SelectorStrategy, AuthoringPick, AppSnapshot } from '@guidelytech/shared';
3
3
  export { AppSnapshot, AutocaptureSettings, ExceptionProperties, GuideConfig, GuideStep, PublishedGuide, SdkConfigResponse, SdkEvent, StackFrame, TargetingContext } from '@guidelytech/shared';
4
4
  import { MessengerTab } from '@guidelytech/guide-runtime/messenger';
5
- 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-BZ9r3Fs9.cjs';
6
- export { E as EventQueue, b as EventQueueOptions, n as GuideStepInfo, d as GuidelyEnvironment, o as GuidelyEventName, K as KEYS, f as KeyValueStore, P as PersistedState, p as StorageKind, g as areMutuallyExclusive, q as createStorage, i as isExclusiveGuide, h as isFrequencyEligible, j as isWithinSchedule } from './types-BZ9r3Fs9.cjs';
5
+ 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-d4eOerxi.cjs';
6
+ 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-d4eOerxi.cjs';
7
+ export { K as KEYS, b as KeyValueStore, S as StorageKind, d as createStorage } from './http-47tiAlOM.cjs';
8
+ export { C as CaptureMarker, a as CaptureOutgoingMessage } from './capture-C3faAYb7.cjs';
9
+ export { CAPTURE_PARAM } from '@guidelytech/shared/runtime';
7
10
 
8
11
  declare const SDK_NAME = "@guidelytech/sdk-core";
9
- declare const SDK_VERSION = "0.5.0";
12
+ declare const SDK_VERSION = "0.6.2";
10
13
  declare const DEFAULT_API_URL = "https://api.guidely.app";
11
14
  /**
12
15
  * Framework-independent Guidely client. Create one per page with {@link createGuidely} or
@@ -45,6 +48,9 @@ declare class GuidelyClient {
45
48
  private firstVisit;
46
49
  private lastUrl;
47
50
  private authoring;
51
+ private capture;
52
+ /** A capture token was found and the (lazily loaded) capture bridge is starting. */
53
+ private captureStarting;
48
54
  private lastAudiences;
49
55
  /** Set once the app calls identify()/reset(); bootstrap then leaves identity alone instead of re-identifying. */
50
56
  private identitySettled;
@@ -100,8 +106,10 @@ declare class GuidelyClient {
100
106
  /** Records activity; starts a new session after `sessionTimeoutMinutes` of inactivity or 24h. */
101
107
  private touchSession;
102
108
  private rotateSession;
103
- /** Autocapture, error tracking and replay need analytics on, consent granted and no authoring session. */
109
+ /** Autocapture, error tracking and replay need analytics on, consent granted and no authoring or how-to capture session. */
104
110
  private captureAllowed;
111
+ /** Authoring or how-to capture is running: no guides, widgets, replay or autocapture. */
112
+ private editing;
105
113
  /** A capability is on when the project enables it (absent on old servers → off) and no option turns it off. */
106
114
  private autocaptureOn;
107
115
  /** Page views on SPA navigation predate autocapture: only an explicit opt-out stops them. */
@@ -166,6 +174,8 @@ declare class GuidelyClient {
166
174
  private resumeActiveGuide;
167
175
  /** Loads the messenger widget on demand (it is a separate chunk) and renders it. */
168
176
  private loadMessenger;
177
+ /** What the messenger personalises from, computed fresh on every render. */
178
+ private messengerVisitor;
169
179
  private destroyMessenger;
170
180
  private loadArticle;
171
181
  private searchResourceCenter;
@@ -230,8 +240,17 @@ declare class GuidelyClient {
230
240
  session: SessionState;
231
241
  pendingEvents: number;
232
242
  authoring: boolean;
243
+ capture: boolean;
233
244
  };
234
245
  private maybeStartAuthoring;
246
+ /** Authoring or capture started / ended: pause everything a visitor would see or be recorded by. */
247
+ private setEditing;
248
+ private hidePersistentWidgets;
249
+ /**
250
+ * Starts how-to capture when the URL carries `guidely_capture` (or this tab is mid-recording).
251
+ * The bridge, toolbar and screenshot code are a separate chunk loaded only then.
252
+ */
253
+ private maybeStartCapture;
235
254
  private persistState;
236
255
  private persistSession;
237
256
  private reportError;
package/dist/index.d.ts CHANGED
@@ -2,11 +2,14 @@ import * as _guidelytech_guide_runtime from '@guidelytech/guide-runtime';
2
2
  import { TargetingContext, PublishedGuide, ProjectTheme, SelectorStrategy, AuthoringPick, AppSnapshot } from '@guidelytech/shared';
3
3
  export { AppSnapshot, AutocaptureSettings, ExceptionProperties, GuideConfig, GuideStep, PublishedGuide, SdkConfigResponse, SdkEvent, StackFrame, TargetingContext } from '@guidelytech/shared';
4
4
  import { MessengerTab } from '@guidelytech/guide-runtime/messenger';
5
- 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-BZ9r3Fs9.js';
6
- export { E as EventQueue, b as EventQueueOptions, n as GuideStepInfo, d as GuidelyEnvironment, o as GuidelyEventName, K as KEYS, f as KeyValueStore, P as PersistedState, p as StorageKind, g as areMutuallyExclusive, q as createStorage, i as isExclusiveGuide, h as isFrequencyEligible, j as isWithinSchedule } from './types-BZ9r3Fs9.js';
5
+ 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-RyeRQd9f.js';
6
+ 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-RyeRQd9f.js';
7
+ export { K as KEYS, b as KeyValueStore, S as StorageKind, d as createStorage } from './http-47tiAlOM.js';
8
+ export { C as CaptureMarker, a as CaptureOutgoingMessage } from './capture-Dqd7up2n.js';
9
+ export { CAPTURE_PARAM } from '@guidelytech/shared/runtime';
7
10
 
8
11
  declare const SDK_NAME = "@guidelytech/sdk-core";
9
- declare const SDK_VERSION = "0.5.0";
12
+ declare const SDK_VERSION = "0.6.2";
10
13
  declare const DEFAULT_API_URL = "https://api.guidely.app";
11
14
  /**
12
15
  * Framework-independent Guidely client. Create one per page with {@link createGuidely} or
@@ -45,6 +48,9 @@ declare class GuidelyClient {
45
48
  private firstVisit;
46
49
  private lastUrl;
47
50
  private authoring;
51
+ private capture;
52
+ /** A capture token was found and the (lazily loaded) capture bridge is starting. */
53
+ private captureStarting;
48
54
  private lastAudiences;
49
55
  /** Set once the app calls identify()/reset(); bootstrap then leaves identity alone instead of re-identifying. */
50
56
  private identitySettled;
@@ -100,8 +106,10 @@ declare class GuidelyClient {
100
106
  /** Records activity; starts a new session after `sessionTimeoutMinutes` of inactivity or 24h. */
101
107
  private touchSession;
102
108
  private rotateSession;
103
- /** Autocapture, error tracking and replay need analytics on, consent granted and no authoring session. */
109
+ /** Autocapture, error tracking and replay need analytics on, consent granted and no authoring or how-to capture session. */
104
110
  private captureAllowed;
111
+ /** Authoring or how-to capture is running: no guides, widgets, replay or autocapture. */
112
+ private editing;
105
113
  /** A capability is on when the project enables it (absent on old servers → off) and no option turns it off. */
106
114
  private autocaptureOn;
107
115
  /** Page views on SPA navigation predate autocapture: only an explicit opt-out stops them. */
@@ -166,6 +174,8 @@ declare class GuidelyClient {
166
174
  private resumeActiveGuide;
167
175
  /** Loads the messenger widget on demand (it is a separate chunk) and renders it. */
168
176
  private loadMessenger;
177
+ /** What the messenger personalises from, computed fresh on every render. */
178
+ private messengerVisitor;
169
179
  private destroyMessenger;
170
180
  private loadArticle;
171
181
  private searchResourceCenter;
@@ -230,8 +240,17 @@ declare class GuidelyClient {
230
240
  session: SessionState;
231
241
  pendingEvents: number;
232
242
  authoring: boolean;
243
+ capture: boolean;
233
244
  };
234
245
  private maybeStartAuthoring;
246
+ /** Authoring or capture started / ended: pause everything a visitor would see or be recorded by. */
247
+ private setEditing;
248
+ private hidePersistentWidgets;
249
+ /**
250
+ * Starts how-to capture when the URL carries `guidely_capture` (or this tab is mid-recording).
251
+ * The bridge, toolbar and screenshot code are a separate chunk loaded only then.
252
+ */
253
+ private maybeStartCapture;
235
254
  private persistState;
236
255
  private persistSession;
237
256
  private reportError;