@scanly/browser 2.0.0

package/dist/scanner/scanner-session.d.ts

@@ -0,0 +1,160 @@
+import { CaptureRouter, type NormalizedFrame, type RecoveryBudget, type RecoveryProfile, type RecoveryRouteId, type ScanOutcome } from "@scanly/core";
+import { type ScenarioDefinition } from "@scanly/scenario-schema";
+import { type DecodeWorkerFactory } from "../worker/worker-client.js";
+import { type ScannerTrackingRuntimeOptions } from "../tracking/scanner-tracking-runtime.js";
+import type { BarcodeTrack, TrackingStatistics } from "../tracking/types.js";
+import { CameraCapabilityController } from "./camera-capabilities.js";
+import { type CameraRecoveryPolicy, type DeviceDiagnostics } from "./camera-platform.js";
+import { BoundedDecodeEscalation } from "./decode-escalation.js";
+import { type FrameQualityAnalyzerOptions } from "./frame-quality.js";
+import { type FrameSchedulerOptions } from "./frame-scheduler.js";
+import { type TemporalCandidateStoreOptions } from "./temporal-confirmation.js";
+import { type TemporalROIOptions } from "./temporal-roi.js";
+import type { AutoZoomOptions, BarcodeObservationSetListener, CameraCapabilities, CameraFrameSource, CapabilityResult, RepeatPolicy, ScannerDecodeRequest, ScannerDecodeMode, ScannerDiagnosticListener, ScannerFrameDecoder, ScannerSessionStatistics, ScannerSessionState, ScannerStateListener, ScanResultListener, Unsubscribe } from "./types.js";
+export interface BrowserScannerFrameDecoderOptions {
+    router?: CaptureRouter;
+    workerFactory?: DecodeWorkerFactory;
+    useWorker?: boolean;
+    disposeRouter?: boolean;
+    scenario?: ScenarioDefinition;
+    /** Camera defaults to diagnosis-driven recovery; DPM remains explicitly off. */
+    recovery?: false | BrowserIndustrialRecoveryOptions;
+}
+export interface BrowserIndustrialRecoveryOptions {
+    profile?: RecoveryProfile;
+    budget?: RecoveryBudget;
+    dpmExperimental?: boolean;
+    excludedRoutes?: readonly RecoveryRouteId[];
+}
+/** Default decoder composition: persistent Worker with an explicit main-thread fallback. */
+export declare class BrowserScannerFrameDecoder implements ScannerFrameDecoder {
+    private readonly router;
+    private readonly ownsRouter;
+    private readonly worker;
+    private readonly useWorker;
+    private readonly baseScenario?;
+    private readonly recovery;
+    private readonly recoveryPipeline;
+    private mainRecoveryRunCount;
+    private mainRecoveryTemporaryBytes;
+    private mainRecoveryPeakTemporaryBytes;
+    private mainRecoveryRouteStateCount;
+    private disposed;
+    constructor(options?: BrowserScannerFrameDecoderOptions);
+    decode(frame: NormalizedFrame, request: ScannerDecodeRequest): Promise<ScanOutcome>;
+    private workerRecovery;
+    private decodeOnMain;
+    cancel(): void;
+    dispose(): Promise<void>;
+    getStatistics(): {
+        wasmInputAllocationBytes: number;
+        wasmActiveNativeResultCount: number;
+        wasmCurrentLinearMemoryBytes: number;
+        wasmPeakLinearMemoryBytes: number;
+        wasmReleasedNativeResultCount: number;
+        recoveryRunCount: number;
+        recoveryTemporaryBytes: number;
+        recoveryPeakTemporaryBytes: number;
+        recoveryRouteStateCount: number;
+        workerCreatedCount: number;
+        workerTerminatedCount: number;
+        activeTaskCount: number;
+        peakActiveTaskCount: number;
+        wasmObservationCount: number;
+        workerWasmDecodeCount: number;
+    };
+}
+export interface ScannerSessionOptions {
+    source: CameraFrameSource;
+    decoder?: ScannerFrameDecoder;
+    decoderOptions?: BrowserScannerFrameDecoderOptions;
+    confirmation?: TemporalCandidateStoreOptions;
+    repeatPolicy?: RepeatPolicy;
+    quality?: FrameQualityAnalyzerOptions;
+    qualityProbeInterval?: number;
+    scheduler?: FrameSchedulerOptions;
+    escalation?: ConstructorParameters<typeof BoundedDecodeEscalation>[0];
+    roi?: TemporalROIOptions;
+    capabilityController?: CameraCapabilityController;
+    autoZoom?: AutoZoomOptions;
+    cameraRecovery?: CameraRecoveryPolicy;
+    /** Explicitly enables the bounded multi-code tracking decode path. */
+    decodeMode?: ScannerDecodeMode;
+    /** Tracker/ROI composition used only when decodeMode is "tracking". */
+    tracking?: ScannerTrackingRuntimeOptions;
+}
+export declare class ScannerSession {
+    private state;
+    private source;
+    private readonly decoder;
+    private readonly ownsDecoder;
+    private readonly quality;
+    private readonly scheduler;
+    private readonly escalation;
+    private readonly candidates;
+    private readonly repeats;
+    private readonly roi;
+    private readonly decodeMode;
+    private readonly trackingRuntime?;
+    private capabilityController?;
+    private readonly autoZoom?;
+    private readonly cameraRecovery;
+    private readonly qualityProbeInterval;
+    private readonly resultListeners;
+    private readonly observationSetListeners;
+    private readonly stateListeners;
+    private readonly diagnosticListeners;
+    private generation;
+    private lifecycleGeneration;
+    private stopPromise;
+    private recoveryPromise;
+    private backgroundPaused;
+    private activeDecodeController;
+    private frameSequence;
+    private eventSequence;
+    private startedAt;
+    private firstDecodeAt?;
+    private firstConfirmedAt?;
+    private decodeLatencies;
+    private peakControlledMemory;
+    private currentWorkerMemory;
+    private counters;
+    constructor(options: ScannerSessionOptions);
+    getState(): ScannerSessionState;
+    start(): Promise<void>;
+    pause(): void;
+    resume(): void;
+    switchSource(source: CameraFrameSource, capabilityController?: CameraCapabilityController): Promise<void>;
+    stop(): Promise<void>;
+    reset(): void;
+    dispose(): Promise<void>;
+    getStatistics(): ScannerSessionStatistics;
+    onResult(listener: ScanResultListener): Unsubscribe;
+    onObservations(listener: BarcodeObservationSetListener): Unsubscribe;
+    onStateChange(listener: ScannerStateListener): Unsubscribe;
+    onDiagnostics(listener: ScannerDiagnosticListener): Unsubscribe;
+    getTracks(): readonly BarcodeTrack[];
+    getTrackingStatistics(): TrackingStatistics | undefined;
+    getDeviceDiagnostics(): DeviceDiagnostics | undefined;
+    getCameraCapabilities(): CameraCapabilities;
+    setTorch(enabled: boolean): Promise<CapabilityResult<boolean>>;
+    setZoom(value: number, manual?: boolean): Promise<CapabilityResult<number>>;
+    requestFocus(): Promise<CapabilityResult<boolean>>;
+    private acceptFrame;
+    private processFrame;
+    private observeResult;
+    private emitLost;
+    private event;
+    private canPublishGeneration;
+    private emitObservationSet;
+    private emitQualityHint;
+    private handleSourceEnded;
+    private handleSourceError;
+    private handleCameraLifecycle;
+    private invalidateCameraGeneration;
+    private recoverCamera;
+    private failCamera;
+    private setState;
+    private emitDiagnostic;
+}
+//# sourceMappingURL=scanner-session.d.ts.map

package/dist/scanner/scanner-session.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scanner-session.d.ts","sourceRoot":"","sources":["../../src/scanner/scanner-session.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EAQb,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,eAAe,EACpB,KAAK,eAAe,EACpB,KAAK,WAAW,EAEjB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAsB,KAAK,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAEtF,OAAO,EAAsC,KAAK,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AAC1G,OAAO,EAEL,KAAK,6BAA6B,EACnC,MAAM,yCAAyC,CAAC;AACjD,OAAO,KAAK,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC7E,OAAO,EAAE,0BAA0B,EAAE,MAAM,0BAA0B,CAAC;AACtE,OAAO,EAAyC,KAAK,oBAAoB,EAAE,KAAK,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAChI,OAAO,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,EAAwB,KAAK,2BAA2B,EAAE,MAAM,oBAAoB,CAAC;AAC5F,OAAO,EAA6C,KAAK,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAE7G,OAAO,EAA0B,KAAK,6BAA6B,EAAE,MAAM,4BAA4B,CAAC;AACxG,OAAO,EAAe,KAAK,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AACzE,OAAO,KAAK,EACV,eAAe,EAEf,6BAA6B,EAE7B,kBAAkB,EAClB,iBAAiB,EACjB,gBAAgB,EAGhB,YAAY,EAEZ,oBAAoB,EACpB,iBAAiB,EAEjB,yBAAyB,EACzB,mBAAmB,EAEnB,wBAAwB,EACxB,mBAAmB,EACnB,oBAAoB,EACpB,kBAAkB,EAClB,WAAW,EACZ,MAAM,YAAY,CAAC;AAEpB,MAAM,WAAW,iCAAiC;IAChD,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB,aAAa,CAAC,EAAE,mBAAmB,CAAC;IACpC,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,EAAE,kBAAkB,CAAC;IAC9B,gFAAgF;IAChF,QAAQ,CAAC,EAAE,KAAK,GAAG,gCAAgC,CAAC;CACrD;AAED,MAAM,WAAW,gCAAgC;IAC/C,OAAO,CAAC,EAAE,eAAe,CAAC;IAC1B,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,cAAc,CAAC,EAAE,SAAS,eAAe,EAAE,CAAC;CAC7C;AAED,4FAA4F;AAC5F,qBAAa,0BAA2B,YAAW,mBAAmB;IACpE,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAgB;IACvC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAU;IACrC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAU;IACpC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAqB;IACnD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA2C;IACpE,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAoC;IACrE,OAAO,CAAC,oBAAoB,CAAK;IACjC,OAAO,CAAC,0BAA0B,CAAK;IACvC,OAAO,CAAC,8BAA8B,CAAK;IAC3C,OAAO,CAAC,2BAA2B,CAAK;IACxC,OAAO,CAAC,QAAQ,CAAS;gBAEb,OAAO,GAAE,iCAAsC;IASrD,MAAM,CAAC,KAAK,EAAE,eAAe,EAAE,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,WAAW,CAAC;IAiEzF,OAAO,CAAC,cAAc;YAWR,YAAY;IAc1B,MAAM,IAAI,IAAI;IACR,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAM9B,aAAa;;;;;;;;;;;;;;;;;CAiBd;AAED,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,iBAAiB,CAAC;IAC1B,OAAO,CAAC,EAAE,mBAAmB,CAAC;IAC9B,cAAc,CAAC,EAAE,iCAAiC,CAAC;IACnD,YAAY,CAAC,EAAE,6BAA6B,CAAC;IAC7C,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,OAAO,CAAC,EAAE,2BAA2B,CAAC;IACtC,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,SAAS,CAAC,EAAE,qBAAqB,CAAC;IAClC,UAAU,CAAC,EAAE,qBAAqB,CAAC,OAAO,uBAAuB,CAAC,CAAC,CAAC,CAAC,CAAC;IACtE,GAAG,CAAC,EAAE,kBAAkB,CAAC;IACzB,oBAAoB,CAAC,EAAE,0BAA0B,CAAC;IAClD,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B,cAAc,CAAC,EAAE,oBAAoB,CAAC;IACtC,sEAAsE;IACtE,UAAU,CAAC,EAAE,iBAAiB,CAAC;IAC/B,uEAAuE;IACvE,QAAQ,CAAC,EAAE,6BAA6B,CAAC;CAC1C;AAqBD,qBAAa,cAAc;IACzB,OAAO,CAAC,KAAK,CAA+B;IAC5C,OAAO,CAAC,MAAM,CAAoB;IAClC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAsB;IAC9C,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAU;IACtC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAuB;IAC/C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAiB;IAC3C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAA0B;IACrD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAyB;IACpD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAmB;IAC3C,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAc;IAClC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAoB;IAC/C,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAyB;IAC1D,OAAO,CAAC,oBAAoB,CAAC,CAA6B;IAC1D,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAkB;IAC5C,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA2B;IAC1D,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAS;IAC9C,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAiC;IACjE,OAAO,CAAC,QAAQ,CAAC,uBAAuB,CAA4C;IACpF,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAmC;IAClE,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAwC;IAC5E,OAAO,CAAC,UAAU,CAAK;IACvB,OAAO,CAAC,mBAAmB,CAAK;IAChC,OAAO,CAAC,WAAW,CAA8B;IACjD,OAAO,CAAC,eAAe,CAA8B;IACrD,OAAO,CAAC,gBAAgB,CAAS;IACjC,OAAO,CAAC,sBAAsB,CAAgC;IAC9D,OAAO,CAAC,aAAa,CAAK;IAC1B,OAAO,CAAC,aAAa,CAAK;IAC1B,OAAO,CAAC,SAAS,CAAK;IACtB,OAAO,CAAC,aAAa,CAAC,CAAS;IAC/B,OAAO,CAAC,gBAAgB,CAAC,CAAS;IAClC,OAAO,CAAC,eAAe,CAAgB;IACvC,OAAO,CAAC,oBAAoB,CAAK;IACjC,OAAO,CAAC,mBAAmB,CAAK;IAChC,OAAO,CAAC,QAAQ,CAKd;gBAEU,OAAO,EAAE,qBAAqB;IAyB1C,QAAQ,IAAI,mBAAmB;IAEzB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IA2B5B,KAAK,IAAI,IAAI;IAKb,MAAM,IAAI,IAAI;IAKR,YAAY,CAAC,MAAM,EAAE,iBAAiB,EAAE,oBAAoB,CAAC,EAAE,0BAA0B,GAAG,OAAO,CAAC,IAAI,CAAC;IAsBzG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAqB3B,KAAK,IAAI,IAAI;IAQP,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAE9B,aAAa,IAAI,wBAAwB;IA4CzC,QAAQ,CAAC,QAAQ,EAAE,kBAAkB,GAAG,WAAW;IACnD,cAAc,CAAC,QAAQ,EAAE,6BAA6B,GAAG,WAAW;IACpE,aAAa,CAAC,QAAQ,EAAE,oBAAoB,GAAG,WAAW;IAC1D,aAAa,CAAC,QAAQ,EAAE,yBAAyB,GAAG,WAAW;IAC/D,SAAS,IAAI,SAAS,YAAY,EAAE;IACpC,qBAAqB,IAAI,kBAAkB,GAAG,SAAS;IACvD,oBAAoB,IAAI,iBAAiB,GAAG,SAAS;IACrD,qBAAqB,IAAI,kBAAkB;IAC3C,QAAQ,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAC9D,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,UAAO,GAAG,OAAO,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;IACxE,YAAY,IAAI,OAAO,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;YAEpC,WAAW;YAYX,YAAY;IA0D1B,OAAO,CAAC,aAAa;IA0CrB,OAAO,CAAC,QAAQ;IAOhB,OAAO,CAAC,KAAK;IAGb,OAAO,CAAC,oBAAoB;IAC5B,OAAO,CAAC,kBAAkB;IAO1B,OAAO,CAAC,eAAe;IAIvB,OAAO,CAAC,iBAAiB;IASzB,OAAO,CAAC,iBAAiB;IAUzB,OAAO,CAAC,qBAAqB;IAsB7B,OAAO,CAAC,0BAA0B;YAMpB,aAAa;IAgC3B,OAAO,CAAC,UAAU;IAMlB,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,cAAc;CACvB"}