@guidelytech/sdk-core 0.9.0 → 0.11.0

package/dist/types-d4eOerxi.d.cts

@@ -1,226 +0,0 @@
-import { SdkEvent, PublishedGuide, FrequencyConfig, AutocaptureSettings, NetworkRequest, ProjectTheme, SdkConfigResponse, ChecklistTask, MessengerMessage, MessengerConversation } from '@guidelytech/shared';
-import { b as KeyValueStore, S as StorageKind } from './http-47tiAlOM.cjs';
-
-interface EventQueueOptions {
-    store: KeyValueStore;
-    storageKey: string;
-    /** Sends one batch. Resolve `{ ok: true }` on success, `{ ok: false, retry }` otherwise. */
-    send: (events: SdkEvent[]) => Promise<{
-        ok: boolean;
-        retry?: boolean;
-    }>;
-    /** Synchronous best-effort send used on page hide. */
-    beacon?: (events: SdkEvent[]) => boolean;
-    /** Should events be flushed right now? (analytics enabled + consent granted). */
-    enabled: () => boolean;
-    flushIntervalMs?: number;
-    maxQueue?: number;
-    batchSize?: number;
-    maxAttempts?: number;
-    onError?: (err: unknown) => void;
-}
-/**
- * Bounded, persisted event queue. Batches ≤50 events every 2s (or on demand), dedupes by
- * `eventId`, retries with exponential backoff (1s→30s, 5 attempts) and keeps failed events for
- * the next flush. Drops the oldest events once the queue exceeds 200.
- */
-declare class EventQueue {
-    private readonly opts;
-    private events;
-    private timer;
-    private retryTimer;
-    private inflight;
-    private inflightIds;
-    private attempt;
-    private destroyed;
-    private readonly flushIntervalMs;
-    private readonly maxQueue;
-    private readonly batchSize;
-    private readonly maxAttempts;
-    constructor(opts: EventQueueOptions);
-    get size(): number;
-    /** Pending events (read-only copy, for debugging). */
-    peek(): SdkEvent[];
-    enqueue(event: SdkEvent): void;
-    private persist;
-    private schedule;
-    /** Sends queued events now (one batch at a time). Safe to call at any time. */
-    flush(): Promise<void>;
-    /** Best-effort synchronous flush on unload using `sendBeacon`. */
-    flushSync(): void;
-    clear(): void;
-    destroy(): void;
-}
-
-/** Per-guide state kept locally and merged with the server's `IdentifyResponse.guideState`. */
-interface GuideLocalState {
-    impressions: number;
-    completedAt?: string | null;
-    dismissedAt?: string | null;
-    lastShownAt?: string | null;
-    /** Last step reached in a multi-step flow (local only), so the messenger can offer to resume it. */
-    lastStepId?: string | null;
-}
-/**
- * Pure frequency evaluation. `shownThisSession` comes from session storage.
- * - `once`: a single impression ever (unless `reshowAfterDismiss` and it was only dismissed).
- * - `once_per_session`: at most once per browser session.
- * - `every_time`: on every trigger (still blocked by completion/dismissal rules below).
- * - `interval`: at most once every `intervalHours`.
- * `maxImpressions` caps total impressions; dismissal blocks re-showing unless `reshowAfterDismiss`
- * (then `cooldownHours` must have elapsed); completion blocks unless mode is `every_time`.
- */
-declare function isFrequencyEligible(freq: FrequencyConfig, state: GuideLocalState | undefined, shownThisSession: boolean, now?: number): boolean;
-/**
- * Exclusive guides (flows, modals, tooltips, announcements, surveys) run one at a time.
- * Banners, checklists and hotspot-only tooltips can coexist with an active flow.
- */
-declare function isExclusiveGuide(guide: PublishedGuide): boolean;
-/** Is `a` mutually exclusive with `b` (by id or key, in either direction)? */
-declare function areMutuallyExclusive(a: PublishedGuide, b: PublishedGuide): boolean;
-/** Survey scheduling window. */
-declare function isWithinSchedule(guide: PublishedGuide, now?: number): boolean;
-
-type GuidelyEnvironment = "development" | "staging" | "production";
-type ConsentState = "granted" | "denied" | "pending";
-interface GuidelyAccount {
-    id: string;
-    traits?: Record<string, unknown>;
-}
-interface GuidelyUser {
-    id: string;
-    traits?: Record<string, unknown>;
-    account?: GuidelyAccount;
-}
-interface GuidelyOptions {
-    /** Environment public key, e.g. `pk_dev_…`. Not a secret. */
-    projectId: string;
-    environment?: GuidelyEnvironment;
-    /** Base URL of the Guidely API (default `https://api.guidely.app`; use `http://localhost:3000` locally). */
-    apiUrl?: string;
-    /** Log trigger decisions and requests to the console. */
-    debug?: boolean;
-    /** Send analytics events (default `true`). Guides still render when disabled. */
-    analytics?: boolean;
-    /** `pending` buffers events until `setConsent("granted")`; `denied` disables analytics. */
-    consent?: ConsentState;
-    /** Where to persist identity, cached config and the event queue (default `local`). */
-    storage?: StorageKind;
-    /** Interval for re-checking element-visibility triggers while the page is idle (default 1000ms). */
-    pollIntervalMs?: number;
-    /** How often to refresh the published config (default 5 minutes). */
-    configRefreshMs?: number;
-    /** Elements whose text must never be captured (authoring snapshots, click text, session replays). Merged with the project setting. */
-    maskSelectors?: string[];
-    /**
-     * Page views, page leave, clicks and rage clicks are captured when the project enables them.
-     * `false` turns all of them off for this installation; an object turns individual ones off
-     * (`{ clicks: false }`). Options can only switch capture off, never on.
-     */
-    autocapture?: boolean | Partial<AutocaptureSettings>;
-    /** App version or commit SHA (≤100 chars), sent with every `exception` to pick the matching uploaded source maps. */
-    release?: string;
-    /** `false` stops uncaught errors / unhandled rejections from being reported (`captureException` still works). */
-    captureErrors?: boolean;
-    /**
-     * `false` never records sessions on this installation. An object can only make masking stricter:
-     * `maskAllText` masks every text node, `blockSelectors` replaces matching elements with a placeholder.
-     */
-    sessionReplay?: boolean | {
-        maskAllText?: boolean;
-        blockSelectors?: string[];
-        /** `false`: never record network requests / WebSockets in replays. */
-        recordNetwork?: false;
-        /** `false`: never record request/response headers, bodies or WebSocket frame data. */
-        recordNetworkPayloads?: false;
-        /** Last say over each recorded request (applied after redaction): return a modified copy, or null to drop it. */
-        maskNetworkRequest?: (request: NetworkRequest) => NetworkRequest | null;
-    };
-    onError?: (error: Error) => void;
-    /** Overrides for the project theme (colors, radius, font). */
-    theme?: Partial<ProjectTheme>;
-    /** Identify this user as soon as the client initialises. */
-    user?: GuidelyUser;
-    /** Custom fetch (tests / polyfills). */
-    fetch?: typeof fetch;
-    /** Disable the authoring-mode and how-to capture URL parameter detection. */
-    disableAuthoring?: boolean;
-}
-interface ChecklistProgressState {
-    completedTaskIds: string[];
-    completedAt?: string | null;
-    dismissedAt?: string | null;
-}
-/** Everything the client persists per project key (`guidely:state:<key>`). */
-interface PersistedState {
-    guides: Record<string, GuideLocalState>;
-    checklists: Record<string, ChecklistProgressState>;
-    surveysSubmitted: string[];
-    audienceIds: string[];
-    firstSeenAt?: string;
-}
-interface SessionState {
-    id: string;
-    startedAt: string;
-    shownGuides: string[];
-    events: string[];
-    /** Epoch ms of the last tracked activity; the session rotates after `sessionTimeoutMinutes` of inactivity. */
-    lastActivityAt?: number;
-    /** Page views sent in this session (the first one carries the referrer). */
-    pageViews?: number;
-    /** Exceptions reported in this session (capped at 100). */
-    exceptions?: number;
-    /** Replay decision for this session: sampled in / forced (`true`), sampled out or disabled by the server (`false`). */
-    replay?: boolean;
-}
-interface GuideStepInfo {
-    guide: PublishedGuide;
-    stepId: string;
-    stepIndex: number;
-}
-interface GuidelyEvents {
-    /** Config loaded (from network or cache) and triggers evaluated. */
-    ready: (config: SdkConfigResponse) => void;
-    /** Config (re)loaded. */
-    config: (config: SdkConfigResponse) => void;
-    "guide:start": (guide: PublishedGuide) => void;
-    "guide:step": (info: GuideStepInfo) => void;
-    "guide:complete": (guide: PublishedGuide) => void;
-    "guide:dismiss": (guide: PublishedGuide) => void;
-    "guide:skip": (guide: PublishedGuide) => void;
-    "checklist:task": (info: {
-        guide: PublishedGuide;
-        task: ChecklistTask;
-        progress: ChecklistProgressState;
-    }) => void;
-    "checklist:complete": (guide: PublishedGuide) => void;
-    "survey:submit": (info: {
-        guide: PublishedGuide;
-        answers: Record<string, unknown>;
-        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;
-    identify: (info: {
-        userId: string | null;
-        anonymousId: string;
-    }) => void;
-    authoring: (info: {
-        active: boolean;
-    }) => void;
-    /** How-to capture (recording steps for a how-to guide) started or ended in this tab. */
-    capture: (info: {
-        active: boolean;
-    }) => void;
-}
-type GuidelyEventName = keyof GuidelyEvents;
-
-export { type ChecklistProgressState as C, EventQueue as E, type GuideLocalState as G, type PersistedState as P, type SessionState as S, type ConsentState as a, type EventQueueOptions as b, type GuidelyAccount as c, type GuidelyEnvironment as d, type GuidelyUser as e, areMutuallyExclusive as f, isFrequencyEligible as g, isWithinSchedule as h, isExclusiveGuide as i, type GuidelyOptions as j, type GuidelyEvents as k, type GuideStepInfo as l, type GuidelyEventName as m };