@sagepilot-ai/web-events-addon 0.0.0-stage → 0.2.1

package/dist/index.d.cts

@@ -0,0 +1,91 @@
+type SagepilotInstallationOwner = {
+    session_id: string;
+    customer_id: string | null;
+};
+type SagepilotContactInput = {
+    submission_id: string;
+    popup_revision: number;
+    name?: string;
+    email?: string;
+    phone?: string;
+    marketing_consent: boolean;
+};
+type SagepilotContactResult = {
+    status: "verification_required" | "recorded";
+    challenge_id?: string;
+    expires_at?: string;
+};
+type SagepilotSDKObservation = {
+    event_id: string;
+    kind: "navigation" | "interaction" | "network" | "lifecycle" | "screen";
+    occurred_at: string;
+    owner: SagepilotInstallationOwner & {
+        identity_epoch: string;
+    };
+    data: Record<string, unknown>;
+    [key: string]: unknown;
+};
+
+type ObservationKey = Pick<SagepilotSDKObservation, "event_id" | "owner">;
+type JournalRecord<T> = {
+    id: string;
+    value: T;
+    bytes: number;
+    expires: number;
+    purge?: string;
+};
+type JournalDiagnostics = {
+    storage: "indexeddb" | "localStorage" | "memory";
+    pending_records: number;
+    pending_bytes: number;
+    memory_only_records: number;
+    quota_evicted: number;
+    expired_records: number;
+    storage_failures: number;
+};
+/** Opens a bounded journal with a small durable fallback for browsers that deny IndexedDB. */
+declare function createJournal<T extends ObservationKey>(scope: string): {
+    /** Coalesces queued captures into one disk transaction while preserving the capture order. */
+    append(record: JournalRecord<T>): Promise<void>;
+    /** Selects a bounded upload batch without removing unacknowledged records. */
+    batch(): Promise<T[]>;
+    /** Deletes only terminal receipt IDs from memory and any writable journal. */
+    acknowledge(ids: Set<string>): Promise<void>;
+    /** Purges evidence and fences the old generation if an inaccessible IndexedDB returns later. */
+    clear(): Promise<void>;
+    /** Reports known storage limits without exposing evidence or credentials. */
+    diagnostics(): JournalDiagnostics;
+    /** Closes browser handles after earlier writes settle. */
+    close(): Promise<void>;
+};
+
+type SagepilotWebEventsOptions = {
+    key: string;
+    /** HTTPS gateway origin; loopback origins are supported for local development. */
+    apiHost?: string;
+    /** Explicit website collection permission; capture is off by default. */
+    collectionEnabled?: boolean;
+    /** Optional custom transport for first-party requests and local integration fixtures. */
+    fetch?: typeof fetch;
+    onError?: (error: unknown) => void;
+};
+type SagepilotWebEvents = {
+    start(): Promise<void>;
+    setCollectionEnabled(enabled: boolean): Promise<void>;
+    flush(): Promise<void>;
+    submitContact(input: SagepilotContactInput): Promise<SagepilotContactResult>;
+    verifyContact(challengeId: string, code: string): Promise<void>;
+    logout(): Promise<void>;
+    refreshConfig(): Promise<void>;
+    diagnostics(): ReturnType<ReturnType<typeof createJournal>["diagnostics"]> & {
+        enabled: boolean;
+        rejected_payloads: number;
+        collector_dropped: number;
+        anonymous_id_storage: "cookie" | "localStorage" | "memory";
+    };
+    destroy(): Promise<void>;
+};
+/** Creates or reuses one installation collector; no hooks or HTTP calls run until start(). */
+declare function createSagepilotWebEvents(options: SagepilotWebEventsOptions): SagepilotWebEvents;
+
+export { type SagepilotWebEvents, type SagepilotWebEventsOptions, createSagepilotWebEvents };

package/dist/index.d.ts

@@ -0,0 +1,91 @@
+type SagepilotInstallationOwner = {
+    session_id: string;
+    customer_id: string | null;
+};
+type SagepilotContactInput = {
+    submission_id: string;
+    popup_revision: number;
+    name?: string;
+    email?: string;
+    phone?: string;
+    marketing_consent: boolean;
+};
+type SagepilotContactResult = {
+    status: "verification_required" | "recorded";
+    challenge_id?: string;
+    expires_at?: string;
+};
+type SagepilotSDKObservation = {
+    event_id: string;
+    kind: "navigation" | "interaction" | "network" | "lifecycle" | "screen";
+    occurred_at: string;
+    owner: SagepilotInstallationOwner & {
+        identity_epoch: string;
+    };
+    data: Record<string, unknown>;
+    [key: string]: unknown;
+};
+
+type ObservationKey = Pick<SagepilotSDKObservation, "event_id" | "owner">;
+type JournalRecord<T> = {
+    id: string;
+    value: T;
+    bytes: number;
+    expires: number;
+    purge?: string;
+};
+type JournalDiagnostics = {
+    storage: "indexeddb" | "localStorage" | "memory";
+    pending_records: number;
+    pending_bytes: number;
+    memory_only_records: number;
+    quota_evicted: number;
+    expired_records: number;
+    storage_failures: number;
+};
+/** Opens a bounded journal with a small durable fallback for browsers that deny IndexedDB. */
+declare function createJournal<T extends ObservationKey>(scope: string): {
+    /** Coalesces queued captures into one disk transaction while preserving the capture order. */
+    append(record: JournalRecord<T>): Promise<void>;
+    /** Selects a bounded upload batch without removing unacknowledged records. */
+    batch(): Promise<T[]>;
+    /** Deletes only terminal receipt IDs from memory and any writable journal. */
+    acknowledge(ids: Set<string>): Promise<void>;
+    /** Purges evidence and fences the old generation if an inaccessible IndexedDB returns later. */
+    clear(): Promise<void>;
+    /** Reports known storage limits without exposing evidence or credentials. */
+    diagnostics(): JournalDiagnostics;
+    /** Closes browser handles after earlier writes settle. */
+    close(): Promise<void>;
+};
+
+type SagepilotWebEventsOptions = {
+    key: string;
+    /** HTTPS gateway origin; loopback origins are supported for local development. */
+    apiHost?: string;
+    /** Explicit website collection permission; capture is off by default. */
+    collectionEnabled?: boolean;
+    /** Optional custom transport for first-party requests and local integration fixtures. */
+    fetch?: typeof fetch;
+    onError?: (error: unknown) => void;
+};
+type SagepilotWebEvents = {
+    start(): Promise<void>;
+    setCollectionEnabled(enabled: boolean): Promise<void>;
+    flush(): Promise<void>;
+    submitContact(input: SagepilotContactInput): Promise<SagepilotContactResult>;
+    verifyContact(challengeId: string, code: string): Promise<void>;
+    logout(): Promise<void>;
+    refreshConfig(): Promise<void>;
+    diagnostics(): ReturnType<ReturnType<typeof createJournal>["diagnostics"]> & {
+        enabled: boolean;
+        rejected_payloads: number;
+        collector_dropped: number;
+        anonymous_id_storage: "cookie" | "localStorage" | "memory";
+    };
+    destroy(): Promise<void>;
+};
+/** Creates or reuses one installation collector; no hooks or HTTP calls run until start(). */
+declare function createSagepilotWebEvents(options: SagepilotWebEventsOptions): SagepilotWebEvents;
+
+export { type SagepilotWebEvents, type SagepilotWebEventsOptions, createSagepilotWebEvents };