@espejo/browser 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,302 @@
+import { N as NetworkEntry, c as ConsoleEntry, I as Interaction, d as Navigation, e as EventsDocument } from './index-Djj7dbiY.cjs';
+export { b as ActResult, f as AgentAction, A as AgentActionType, g as AgentContext, h as AgentPolicy, E as EspejoAgent } from './index-Djj7dbiY.cjs';
+import { a as WidgetTheme } from './shadow-scaffold-DUJmxf_n.cjs';
+
+declare const AUTO_TRIGGERS: readonly ["auto:console_error", "auto:uncaught", "auto:unhandled_rejection", "auto:network_5xx", "auto:network_failed", "auto:network_4xx"];
+type AutoTrigger = (typeof AUTO_TRIGGERS)[number];
+interface AutoReportConfig {
+    enabled: boolean;
+    triggers: AutoTrigger[];
+    max_per_page: number;
+    cooldown_ms: number;
+    video_surface?: string | null;
+    has_triggers?: boolean;
+}
+
+declare const FEEDBACK_KINDS: readonly ["emoji3", "scale7", "thumbs"];
+type FeedbackKind = (typeof FEEDBACK_KINDS)[number];
+interface FeedbackConfig {
+    enabled: boolean;
+    kind: FeedbackKind;
+    cadence_days: number;
+}
+
+interface RingBufferOptions {
+    maxBytes: number;
+    maxItems: number;
+}
+declare class RingBuffer<T> {
+    private readonly options;
+    private slots;
+    private total;
+    private dropped;
+    constructor(options: RingBufferOptions);
+    push(item: T): void;
+    private evict;
+    toArray(): T[];
+    get droppedCount(): number;
+    get byteLength(): number;
+    get length(): number;
+    clear(): void;
+}
+
+declare const DEFAULT_BUDGETS: {
+    readonly networkBytes: 1200000;
+    readonly consoleBytes: 400000;
+    readonly interactionBytes: 200000;
+    readonly navigationBytes: 50000;
+    readonly maxItemsPerKind: 5000;
+};
+type Budgets = typeof DEFAULT_BUDGETS;
+interface DroppedCounts {
+    network: number;
+    console: number;
+    interactions: number;
+    navigations: number;
+}
+declare class SessionRecorder {
+    readonly startedAtIso: string;
+    private readonly clockStart;
+    readonly network: RingBuffer<NetworkEntry>;
+    readonly console: RingBuffer<ConsoleEntry>;
+    readonly interactions: RingBuffer<Interaction>;
+    readonly navigations: RingBuffer<Navigation>;
+    constructor(budgets?: Partial<Budgets>);
+    elapsed(): number;
+    get dropped(): DroppedCounts;
+    get byteLength(): number;
+    snapshot(): EventsDocument;
+    clear(): void;
+}
+
+interface SegmentRingOptions {
+    maxBytes: number;
+}
+declare class SegmentRing<T> {
+    private readonly options;
+    private segments;
+    private total;
+    private droppedSegments;
+    private overflowed;
+    constructor(options: SegmentRingOptions);
+    startSegment(): void;
+    push(item: T): void;
+    private evict;
+    toArray(): T[];
+    get byteLength(): number;
+    get segmentCount(): number;
+    get droppedCount(): number;
+    get isOverflowed(): boolean;
+    clear(): void;
+}
+
+declare const BLOCK_SELECTOR = "[data-espejo-block]";
+declare const MASK_SELECTOR = "[data-espejo-mask]";
+interface RrwebEvent {
+    type: number;
+    timestamp?: number;
+    [key: string]: unknown;
+}
+type RrwebRecord = (options: {
+    emit: (event: RrwebEvent, isCheckout?: boolean) => void;
+    checkoutEveryNms?: number;
+    maskAllInputs?: boolean;
+    blockSelector?: string;
+    maskTextSelector?: string;
+    recordCanvas?: boolean;
+    collectFonts?: boolean;
+}) => (() => void) | undefined;
+type RrwebSnapshot = (doc: Document, options?: {
+    maskAllInputs?: boolean;
+    blockSelector?: string | null;
+    maskTextSelector?: string | null;
+    inlineStylesheet?: boolean;
+    recordCanvas?: boolean;
+}) => unknown;
+
+declare const MAX_VIDEO_SECONDS = 240;
+type VideoSurface = 'current-tab' | 'browser' | 'window' | 'monitor';
+interface VideoCaptureOptions {
+    microphone?: boolean;
+    surface?: VideoSurface;
+    onUserStopped?: () => void;
+    onLimitReached?: () => void;
+    maxSeconds?: number;
+    maxHeight?: number;
+    frameRate?: number;
+    videoBitsPerSecond?: number;
+}
+interface MicrophoneResult {
+    on: boolean;
+    denied: boolean;
+}
+declare function videoSupported(): boolean;
+
+declare const DEFAULT_TEXT: {
+    triggerLabel: string;
+    title: string;
+    fieldLabel: string;
+    placeholder: string;
+    cancel: string;
+    submit: string;
+    sending: string;
+    success: string;
+    errorPrefix: string;
+    record: string;
+    recordHint: string;
+    recording: string;
+    stopRecording: string;
+    micOn: string;
+    micOff: string;
+    micBlocked: string;
+    micStateOn: string;
+    micStateOff: string;
+    micStateBlocked: string;
+    countdown: string;
+    markupOn: string;
+    markupOff: string;
+    videoAttached: string;
+    videoRemove: string;
+    limitReached: string;
+    recordErrorPrefix: string;
+};
+type WidgetText = typeof DEFAULT_TEXT;
+
+declare const DEFAULT_FEEDBACK_TEXT: {
+    title: string;
+    thanks: string;
+    dismiss: string;
+    emojiSad: string;
+    emojiNeutral: string;
+    emojiHappy: string;
+    thumbsDown: string;
+    thumbsUp: string;
+    scaleLabel: string;
+};
+type FeedbackWidgetText = typeof DEFAULT_FEEDBACK_TEXT;
+interface FeedbackWidgetOptions {
+    config: FeedbackConfig;
+    vote(value: number): Promise<void>;
+    text?: Partial<FeedbackWidgetText>;
+    theme?: WidgetTheme;
+    doc?: Document;
+}
+interface FeedbackWidgetHandle {
+    destroy(): void;
+    shadowRootForTesting: ShadowRoot;
+}
+declare function installFeedbackWidget(options: FeedbackWidgetOptions): FeedbackWidgetHandle | null;
+
+declare const BLOCK_ATTRIBUTE = "data-espejo-block";
+
+declare function fetchAutoReportConfig(ingestUrl: string, key: string, fetchImpl: typeof fetch): Promise<{
+    config: AutoReportConfig | null;
+    videoSurface: string | null;
+    hasTriggers: boolean;
+}>;
+declare function normalizeConfig(raw: unknown): AutoReportConfig | null;
+
+declare function fetchFeedbackConfig(ingestUrl: string, key: string, fetchImpl: typeof fetch): Promise<FeedbackConfig | null>;
+declare function normalizeFeedbackConfig(raw: unknown): FeedbackConfig | null;
+
+declare function canShowFeedback(projectKey: string, cadenceDays: number, doc?: Document): boolean;
+declare function sealFeedbackShown(projectKey: string, doc?: Document): void;
+
+interface VoteInput {
+    ingestUrl: string;
+    key: string;
+    kind: string;
+    value: number;
+    pageHost?: string;
+    userRef?: string;
+}
+declare function sendVote(input: VoteInput, fetchImpl?: typeof fetch): Promise<void>;
+
+declare const SDK_NAME = "@espejo/browser";
+declare const SDK_VERSION = "0.1.0";
+interface EspejoConfig {
+    key: string;
+    ingestUrl?: string;
+    mode?: 'ring' | 'always';
+    capture?: 'events' | 'dom';
+    budgets?: Partial<Budgets>;
+    release?: string;
+    env?: string;
+    userRef?: string;
+    button?: 'on' | 'off';
+    buttonText?: Partial<WidgetText>;
+    rrwebRecord?: RrwebRecord;
+    rrwebSnapshot?: RrwebSnapshot;
+    autoReport?: 'on' | 'off';
+    feedback?: 'on' | 'off';
+    feedbackText?: Partial<FeedbackWidgetText>;
+    theme?: 'auto' | 'light' | 'dark';
+    position?: 'bottom-right' | 'bottom-left' | 'top-right' | 'top-left';
+    buttonIcon?: string;
+    videoSurface?: VideoSurface;
+}
+type ReportOrigin = {
+    source: 'manual';
+} | {
+    source: 'auto';
+    trigger: AutoTrigger;
+};
+declare class Espejo {
+    private recorder;
+    private uninstall;
+    private dom;
+    private routeSnapshot;
+    private snapshotFn;
+    private widget;
+    private lastReport;
+    private feedback;
+    private annotator;
+    private markupHost;
+    private video;
+    private videoBlob;
+    private videoContentType;
+    private videoHasAudio;
+    private videoMs;
+    private autoConfig;
+    private autoGuard;
+    private autoKilled;
+    private autoInFlight;
+    private triggerSink;
+    private triggerBuf;
+    private triggersStop;
+    private readonly pristineFetch;
+    private readonly config;
+    constructor(config: EspejoConfig);
+    get recording(): boolean;
+    start(): void;
+    private pushTriggerSignal;
+    private loadTriggers;
+    private loadFeedback;
+    private loadAutoReport;
+    setAutoReport(enabled: boolean): void;
+    identify(userRef: string | null): void;
+    canOpenReport(): boolean;
+    openReport(): boolean;
+    get lastReportId(): string | null;
+    get autoReportActive(): boolean;
+    private autoEnabled;
+    private onConsoleEntry;
+    private onNetworkEntry;
+    private maybeAutoReport;
+    private enableDom;
+    stop(): void;
+    startVideo(options?: VideoCaptureOptions): Promise<void>;
+    setMicrophone(on: boolean): Promise<MicrophoneResult>;
+    get microphoneOn(): boolean;
+    stopVideo(): Promise<Blob | null>;
+    get recordingVideo(): boolean;
+    setMarkup(on: boolean, onExit?: () => void): Promise<boolean>;
+    private teardownMarkup;
+    discardVideo(): void;
+    snapshot(): EventsDocument | null;
+    report(description?: string, origin?: ReportOrigin, onProgress?: (fraction: number) => void): Promise<string | null>;
+    private manifest;
+}
+declare function autoStart(overrides?: Partial<EspejoConfig>): Espejo | null;
+
+export { BLOCK_ATTRIBUTE, BLOCK_SELECTOR, DEFAULT_BUDGETS, Espejo, type EspejoConfig, DEFAULT_FEEDBACK_TEXT as FEEDBACK_DEFAULT_TEXT, type FeedbackWidgetText, MASK_SELECTOR, MAX_VIDEO_SECONDS, type MicrophoneResult, type ReportOrigin, RingBuffer, SDK_NAME, SDK_VERSION, SegmentRing, SessionRecorder, DEFAULT_TEXT as WIDGET_DEFAULT_TEXT, type WidgetText, autoStart, canShowFeedback, fetchAutoReportConfig, fetchFeedbackConfig, installFeedbackWidget, normalizeConfig as normalizeAutoReportConfig, normalizeFeedbackConfig, sealFeedbackShown, sendVote, videoSupported };

package/dist/index.d.ts

@@ -0,0 +1,302 @@
+import { N as NetworkEntry, c as ConsoleEntry, I as Interaction, d as Navigation, e as EventsDocument } from './index-Djj7dbiY.js';
+export { b as ActResult, f as AgentAction, A as AgentActionType, g as AgentContext, h as AgentPolicy, E as EspejoAgent } from './index-Djj7dbiY.js';
+import { a as WidgetTheme } from './shadow-scaffold-DUJmxf_n.js';
+
+declare const AUTO_TRIGGERS: readonly ["auto:console_error", "auto:uncaught", "auto:unhandled_rejection", "auto:network_5xx", "auto:network_failed", "auto:network_4xx"];
+type AutoTrigger = (typeof AUTO_TRIGGERS)[number];
+interface AutoReportConfig {
+    enabled: boolean;
+    triggers: AutoTrigger[];
+    max_per_page: number;
+    cooldown_ms: number;
+    video_surface?: string | null;
+    has_triggers?: boolean;
+}
+
+declare const FEEDBACK_KINDS: readonly ["emoji3", "scale7", "thumbs"];
+type FeedbackKind = (typeof FEEDBACK_KINDS)[number];
+interface FeedbackConfig {
+    enabled: boolean;
+    kind: FeedbackKind;
+    cadence_days: number;
+}
+
+interface RingBufferOptions {
+    maxBytes: number;
+    maxItems: number;
+}
+declare class RingBuffer<T> {
+    private readonly options;
+    private slots;
+    private total;
+    private dropped;
+    constructor(options: RingBufferOptions);
+    push(item: T): void;
+    private evict;
+    toArray(): T[];
+    get droppedCount(): number;
+    get byteLength(): number;
+    get length(): number;
+    clear(): void;
+}
+
+declare const DEFAULT_BUDGETS: {
+    readonly networkBytes: 1200000;
+    readonly consoleBytes: 400000;
+    readonly interactionBytes: 200000;
+    readonly navigationBytes: 50000;
+    readonly maxItemsPerKind: 5000;
+};
+type Budgets = typeof DEFAULT_BUDGETS;
+interface DroppedCounts {
+    network: number;
+    console: number;
+    interactions: number;
+    navigations: number;
+}
+declare class SessionRecorder {
+    readonly startedAtIso: string;
+    private readonly clockStart;
+    readonly network: RingBuffer<NetworkEntry>;
+    readonly console: RingBuffer<ConsoleEntry>;
+    readonly interactions: RingBuffer<Interaction>;
+    readonly navigations: RingBuffer<Navigation>;
+    constructor(budgets?: Partial<Budgets>);
+    elapsed(): number;
+    get dropped(): DroppedCounts;
+    get byteLength(): number;
+    snapshot(): EventsDocument;
+    clear(): void;
+}
+
+interface SegmentRingOptions {
+    maxBytes: number;
+}
+declare class SegmentRing<T> {
+    private readonly options;
+    private segments;
+    private total;
+    private droppedSegments;
+    private overflowed;
+    constructor(options: SegmentRingOptions);
+    startSegment(): void;
+    push(item: T): void;
+    private evict;
+    toArray(): T[];
+    get byteLength(): number;
+    get segmentCount(): number;
+    get droppedCount(): number;
+    get isOverflowed(): boolean;
+    clear(): void;
+}
+
+declare const BLOCK_SELECTOR = "[data-espejo-block]";
+declare const MASK_SELECTOR = "[data-espejo-mask]";
+interface RrwebEvent {
+    type: number;
+    timestamp?: number;
+    [key: string]: unknown;
+}
+type RrwebRecord = (options: {
+    emit: (event: RrwebEvent, isCheckout?: boolean) => void;
+    checkoutEveryNms?: number;
+    maskAllInputs?: boolean;
+    blockSelector?: string;
+    maskTextSelector?: string;
+    recordCanvas?: boolean;
+    collectFonts?: boolean;
+}) => (() => void) | undefined;
+type RrwebSnapshot = (doc: Document, options?: {
+    maskAllInputs?: boolean;
+    blockSelector?: string | null;
+    maskTextSelector?: string | null;
+    inlineStylesheet?: boolean;
+    recordCanvas?: boolean;
+}) => unknown;
+
+declare const MAX_VIDEO_SECONDS = 240;
+type VideoSurface = 'current-tab' | 'browser' | 'window' | 'monitor';
+interface VideoCaptureOptions {
+    microphone?: boolean;
+    surface?: VideoSurface;
+    onUserStopped?: () => void;
+    onLimitReached?: () => void;
+    maxSeconds?: number;
+    maxHeight?: number;
+    frameRate?: number;
+    videoBitsPerSecond?: number;
+}
+interface MicrophoneResult {
+    on: boolean;
+    denied: boolean;
+}
+declare function videoSupported(): boolean;
+
+declare const DEFAULT_TEXT: {
+    triggerLabel: string;
+    title: string;
+    fieldLabel: string;
+    placeholder: string;
+    cancel: string;
+    submit: string;
+    sending: string;
+    success: string;
+    errorPrefix: string;
+    record: string;
+    recordHint: string;
+    recording: string;
+    stopRecording: string;
+    micOn: string;
+    micOff: string;
+    micBlocked: string;
+    micStateOn: string;
+    micStateOff: string;
+    micStateBlocked: string;
+    countdown: string;
+    markupOn: string;
+    markupOff: string;
+    videoAttached: string;
+    videoRemove: string;
+    limitReached: string;
+    recordErrorPrefix: string;
+};
+type WidgetText = typeof DEFAULT_TEXT;
+
+declare const DEFAULT_FEEDBACK_TEXT: {
+    title: string;
+    thanks: string;
+    dismiss: string;
+    emojiSad: string;
+    emojiNeutral: string;
+    emojiHappy: string;
+    thumbsDown: string;
+    thumbsUp: string;
+    scaleLabel: string;
+};
+type FeedbackWidgetText = typeof DEFAULT_FEEDBACK_TEXT;
+interface FeedbackWidgetOptions {
+    config: FeedbackConfig;
+    vote(value: number): Promise<void>;
+    text?: Partial<FeedbackWidgetText>;
+    theme?: WidgetTheme;
+    doc?: Document;
+}
+interface FeedbackWidgetHandle {
+    destroy(): void;
+    shadowRootForTesting: ShadowRoot;
+}
+declare function installFeedbackWidget(options: FeedbackWidgetOptions): FeedbackWidgetHandle | null;
+
+declare const BLOCK_ATTRIBUTE = "data-espejo-block";
+
+declare function fetchAutoReportConfig(ingestUrl: string, key: string, fetchImpl: typeof fetch): Promise<{
+    config: AutoReportConfig | null;
+    videoSurface: string | null;
+    hasTriggers: boolean;
+}>;
+declare function normalizeConfig(raw: unknown): AutoReportConfig | null;
+
+declare function fetchFeedbackConfig(ingestUrl: string, key: string, fetchImpl: typeof fetch): Promise<FeedbackConfig | null>;
+declare function normalizeFeedbackConfig(raw: unknown): FeedbackConfig | null;
+
+declare function canShowFeedback(projectKey: string, cadenceDays: number, doc?: Document): boolean;
+declare function sealFeedbackShown(projectKey: string, doc?: Document): void;
+
+interface VoteInput {
+    ingestUrl: string;
+    key: string;
+    kind: string;
+    value: number;
+    pageHost?: string;
+    userRef?: string;
+}
+declare function sendVote(input: VoteInput, fetchImpl?: typeof fetch): Promise<void>;
+
+declare const SDK_NAME = "@espejo/browser";
+declare const SDK_VERSION = "0.1.0";
+interface EspejoConfig {
+    key: string;
+    ingestUrl?: string;
+    mode?: 'ring' | 'always';
+    capture?: 'events' | 'dom';
+    budgets?: Partial<Budgets>;
+    release?: string;
+    env?: string;
+    userRef?: string;
+    button?: 'on' | 'off';
+    buttonText?: Partial<WidgetText>;
+    rrwebRecord?: RrwebRecord;
+    rrwebSnapshot?: RrwebSnapshot;
+    autoReport?: 'on' | 'off';
+    feedback?: 'on' | 'off';
+    feedbackText?: Partial<FeedbackWidgetText>;
+    theme?: 'auto' | 'light' | 'dark';
+    position?: 'bottom-right' | 'bottom-left' | 'top-right' | 'top-left';
+    buttonIcon?: string;
+    videoSurface?: VideoSurface;
+}
+type ReportOrigin = {
+    source: 'manual';
+} | {
+    source: 'auto';
+    trigger: AutoTrigger;
+};
+declare class Espejo {
+    private recorder;
+    private uninstall;
+    private dom;
+    private routeSnapshot;
+    private snapshotFn;
+    private widget;
+    private lastReport;
+    private feedback;
+    private annotator;
+    private markupHost;
+    private video;
+    private videoBlob;
+    private videoContentType;
+    private videoHasAudio;
+    private videoMs;
+    private autoConfig;
+    private autoGuard;
+    private autoKilled;
+    private autoInFlight;
+    private triggerSink;
+    private triggerBuf;
+    private triggersStop;
+    private readonly pristineFetch;
+    private readonly config;
+    constructor(config: EspejoConfig);
+    get recording(): boolean;
+    start(): void;
+    private pushTriggerSignal;
+    private loadTriggers;
+    private loadFeedback;
+    private loadAutoReport;
+    setAutoReport(enabled: boolean): void;
+    identify(userRef: string | null): void;
+    canOpenReport(): boolean;
+    openReport(): boolean;
+    get lastReportId(): string | null;
+    get autoReportActive(): boolean;
+    private autoEnabled;
+    private onConsoleEntry;
+    private onNetworkEntry;
+    private maybeAutoReport;
+    private enableDom;
+    stop(): void;
+    startVideo(options?: VideoCaptureOptions): Promise<void>;
+    setMicrophone(on: boolean): Promise<MicrophoneResult>;
+    get microphoneOn(): boolean;
+    stopVideo(): Promise<Blob | null>;
+    get recordingVideo(): boolean;
+    setMarkup(on: boolean, onExit?: () => void): Promise<boolean>;
+    private teardownMarkup;
+    discardVideo(): void;
+    snapshot(): EventsDocument | null;
+    report(description?: string, origin?: ReportOrigin, onProgress?: (fraction: number) => void): Promise<string | null>;
+    private manifest;
+}
+declare function autoStart(overrides?: Partial<EspejoConfig>): Espejo | null;
+
+export { BLOCK_ATTRIBUTE, BLOCK_SELECTOR, DEFAULT_BUDGETS, Espejo, type EspejoConfig, DEFAULT_FEEDBACK_TEXT as FEEDBACK_DEFAULT_TEXT, type FeedbackWidgetText, MASK_SELECTOR, MAX_VIDEO_SECONDS, type MicrophoneResult, type ReportOrigin, RingBuffer, SDK_NAME, SDK_VERSION, SegmentRing, SessionRecorder, DEFAULT_TEXT as WIDGET_DEFAULT_TEXT, type WidgetText, autoStart, canShowFeedback, fetchAutoReportConfig, fetchFeedbackConfig, installFeedbackWidget, normalizeConfig as normalizeAutoReportConfig, normalizeFeedbackConfig, sealFeedbackShown, sendVote, videoSupported };