@scandit/web-datacapture-id 7.2.0-beta.1 → 7.2.0

package/build/js/safariOOMDetection/SafariOOMDetector.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Safari triggers a page reload when too much memory is requested (RangeError: Out of memory).
+ * This detector tracks these reloads and reports them to the passed callback.
+ * Some data can also be set in the storage to give more context about the page when the error occurs.
+ */
+export declare class SafariOOMDetector<T extends {}> {
+    private _onPageAbruptlyReloaded;
+    private _storage;
+    constructor(onPageAbruptlyReloaded: () => void);
+    static isSafari(): boolean;
+    install(): void;
+    /**
+     * Update the data stored in the storage.
+     */
+    updateData(data: T): void;
+    get data(): T;
+    uninstall(): void;
+    private getStorage;
+    private onUnload;
+}

package/build/js/safariOOMDetection/SafariOOMStatsCollector.d.ts

@@ -0,0 +1,28 @@
+import type { SafariOOMDetector } from "./SafariOOMDetector";
+import type { SafariOOMStats } from "./types";
+export declare class SafariOOMStatsCollector {
+    private static readonly UP_TIME_UPDATE_INTERVAL_MS;
+    private _framesProcessedCount;
+    private _didCaptureCount;
+    private _didRejectCount;
+    private _applySettingsCount;
+    private _videoResolution;
+    private _firstFrameProcessedTime?;
+    private _detector;
+    private _upTimeMs;
+    private _upTimeTimer;
+    constructor(detector: SafariOOMDetector<SafariOOMStats>);
+    destroy(): void;
+    get framesProcessedCount(): number;
+    get didCaptureCount(): number;
+    get didRejectCount(): number;
+    get applySettingsCount(): number;
+    get videoResolution(): string | null;
+    set framesProcessedCount(count: number);
+    set didCaptureCount(count: number);
+    set didRejectCount(count: number);
+    set applySettingsCount(count: number);
+    set videoResolution(resolution: string);
+    private get data();
+    private updateUpTime;
+}

package/build/js/safariOOMDetection/WriteThrottledStorage.d.ts

@@ -0,0 +1,21 @@
+type Data = Record<string, unknown>;
+/**
+ * A storage that throttles writes to the underlying storage.
+ * This is useful to avoid excessive writes to the storage, as we may have many updates
+ * of the data in a short period of time.
+ */
+export declare class WriteThrottledStorage {
+    private static readonly DEFAULT_WRITE_INTERVAL_MS;
+    private readonly _storage;
+    private _lastWrite;
+    private _pendingData?;
+    private _writeTimer?;
+    private readonly _writeIntervalMs;
+    constructor(storage: Storage, writeIntervalMs?: number);
+    hasDataAlreadyWritten(): boolean;
+    write(data: Data): Data;
+    read(): Data;
+    clear(): void;
+    private scheduleWrite;
+}
+export {};

package/build/js/safariOOMDetection/types.d.ts

@@ -0,0 +1,12 @@
+export interface SafariOOMStats {
+    framesProcessedCount: number;
+    didCaptureCount: number;
+    didRejectCount: number;
+    applySettingsCount: number;
+    upTime: number;
+    videoResolution: string;
+}
+export type SafariOOMEventData = SafariOOMStats & {
+    parentDomain: string | undefined;
+    centaurusEnabled: boolean;
+};

package/build/js/worker/dataCaptureEngine.d.ts

@@ -3,6 +3,7 @@ import { DataCaptureEngine as CoreDataCaptureEngine } from "@scandit/web-datacap
 import type { CapturedIdJSONWithoutCommonFieldsJSON, DataCaptureCallbackMessage, EngineWorkerResponse, IdCaptureSessionHolder, Module, ParseResult, WasmCaptureId } from "./dataCaptureWorkerRelated";
 import type { IdCaptureSettingsJSON } from "../IdCaptureSettings";
 import type { AamvaBarcodeVerificationResultJSON, CapturedIdJSON, CapturedIdJSONWithRawImageInfo, DataConsistencyResultJSON, IdCaptureSessionJSON } from "../SerializedTypes";
+import type { SafariOOMEventData } from "../safariOOMDetection/types";
 export interface WorkerFunctions extends BaseWorkerFunctions {
     postMessage: (message: DataCaptureCallbackMessage, transfer?: Transferable[]) => void;
 }
@@ -28,6 +29,7 @@ export declare class DataCaptureEngine extends CoreDataCaptureEngine<Module> {
     idCaptureDataConsistencyVerifyCapture(capturedId: CapturedIdJSON): EngineWorkerResponse<"idCaptureDataConsistencyVerifyCapture">;
     idCaptureDrivingLicenseDetailsCreateWithBlinkIdData(vehicleClass: string, restrictions: string, endorsements: string): EngineWorkerResponse<"idCaptureDrivingLicenseDetailsCreateWithBlinkIdData">;
     getIdOpenSourceSoftwareLicenseInfo(): EngineWorkerResponse<"getIdOpenSourceSoftwareLicenseInfo">;
+    idCaptureReportSafariAbruptReload(environmentData: SafariOOMEventData): EngineWorkerResponse<"idCaptureReportSafariAbruptReload">;
     getModeDeserializers(): Vector;
     protected getWasmSideModuleFileName(): string;
     protected getWasmCoreFileName(simdSupport: boolean, webassemblyMultithreadingSupport: boolean): string;
@@ -74,6 +76,7 @@ export declare class IdCaptureMode {
     extractCaptureId(wasmCapturedId: WasmCaptureId | null): CapturedIdJSONWithRawImageInfo | null;
     onShutterButtonPositionChangedCallback(position: string): void;
     onShutterButtonStateChangedCallback(state: string): void;
+    reportSafariAbruptReload(environmentData: SafariOOMEventData): Promise<void>;
     /**
      * The session holder contains everything except the common fields for the captured id, which have to be
      * gathered manually.

package/build/js/worker/dataCaptureWorkerRelated.d.ts

@@ -3,10 +3,11 @@ import type { CaptureModeDeserializerInstance, AnyDataCaptureActionMessage as Co
 import type { IdCaptureSettingsJSON } from "../IdCaptureSettings";
 import type { AamvaBarcodeVerificationResultJSON, CapturedIdCommonFieldsJSON, CapturedIdJSON, CapturedIdJSONWithRawImageInfo, DataConsistencyResultJSON, DrivingLicenseDetailsJSON } from "../SerializedTypes";
 import type { ShutterButtonState } from "scandit-web-datacapture-id-private";
+import type { SafariOOMEventData } from "../safariOOMDetection/types";
 /**
  * MESSAGES (ACTIONS) SENT TO THE WORKER
  */
-export type DataCaptureActionMessageKey = CoreDataCaptureActionMessageKey | "idCaptureApplySettings" | "idCaptureBarcodeVerifyAamvaCapture" | "idCaptureDataConsistencyVerifyCapture" | "idCaptureParse" | "idCaptureReset" | "idCaptureSetLastDetectionIssue" | "idCaptureSetLastError" | "idCaptureSetLastLocalizedId" | "idCaptureSetLastResult" | "idCaptureDrivingLicenseDetailsCreateWithBlinkIdData" | "getIdOpenSourceSoftwareLicenseInfo";
+export type DataCaptureActionMessageKey = CoreDataCaptureActionMessageKey | "idCaptureApplySettings" | "idCaptureBarcodeVerifyAamvaCapture" | "idCaptureDataConsistencyVerifyCapture" | "idCaptureParse" | "idCaptureReset" | "idCaptureSetLastDetectionIssue" | "idCaptureSetLastError" | "idCaptureSetLastLocalizedId" | "idCaptureSetLastResult" | "idCaptureDrivingLicenseDetailsCreateWithBlinkIdData" | "getIdOpenSourceSoftwareLicenseInfo" | "idCaptureReportSafariAbruptReload";
 export interface IdCaptureParseResponse {
     result: ParseResult | null;
 }
@@ -78,7 +79,11 @@ export interface IdCaptureDrivingLicenseDetailsCreateWithBlinkIdDataDataCaptureA
 export interface GetIdOpenSourceSoftwareLicenseInfoAction extends DataCaptureActionMessage {
     command: "getIdOpenSourceSoftwareLicenseInfo";
 }
-export type AnyDataCaptureActionMessage = CoreAnyDataCaptureActionMessage | IdCaptureApplySettingsDataCaptureAction | IdCaptureBarcodeVerifyAamvaCaptureDataCaptureAction | IdCaptureDataConsistencyVerifyCaptureDataCaptureAction | IdCaptureParseDataCaptureAction | IdCaptureResetDataCaptureAction | IdCaptureSetLastDetectionIssueDataCaptureAction | IdCaptureSetLastErrorDataCaptureAction | IdCaptureSetLastLocalizedIdDataCaptureAction | IdCaptureSetLastResultDataCaptureAction | IdCaptureDrivingLicenseDetailsCreateWithBlinkIdDataDataCaptureAction | GetIdOpenSourceSoftwareLicenseInfoAction;
+export interface IdCaptureReportSafariAbruptReloadAction extends DataCaptureActionMessage {
+    command: "idCaptureReportSafariAbruptReload";
+    environmentData: SafariOOMEventData;
+}
+export type AnyDataCaptureActionMessage = CoreAnyDataCaptureActionMessage | IdCaptureApplySettingsDataCaptureAction | IdCaptureBarcodeVerifyAamvaCaptureDataCaptureAction | IdCaptureDataConsistencyVerifyCaptureDataCaptureAction | IdCaptureParseDataCaptureAction | IdCaptureResetDataCaptureAction | IdCaptureSetLastDetectionIssueDataCaptureAction | IdCaptureSetLastErrorDataCaptureAction | IdCaptureSetLastLocalizedIdDataCaptureAction | IdCaptureSetLastResultDataCaptureAction | IdCaptureDrivingLicenseDetailsCreateWithBlinkIdDataDataCaptureAction | GetIdOpenSourceSoftwareLicenseInfoAction | IdCaptureReportSafariAbruptReloadAction;
 export type MessagePayloadByCommand = {
     [key in AnyDataCaptureActionMessage["command"]]: Prettify<Omit<Extract<AnyDataCaptureActionMessage, {
         command: key;
@@ -296,6 +301,10 @@ interface IdCaptureModule {
     IdOpenSourceSoftwareLicenseInfo: {
         getLicenseText(): string;
     };
+    OutOfMemoryAnalyticsData: new (framesProcessedCount: number, didCaptureCount: number, didRejectCount: number, applySettingsCount: number, upTime: number, videoResolution: string, parentDomain: string | undefined, centaurusEnabled: boolean) => EmscriptenClassHandle;
+    OutOfMemoryAnalyticsHelper: {
+        storeAnalyticsEvent: (context: unknown, event: unknown) => void;
+    };
 }
 export interface Module extends CoreModule, IdCaptureModule {
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scandit/web-datacapture-id",
-  "version": "7.2.0-beta.1",
+  "version": "7.2.0",
   "description": "Scandit Data Capture SDK for the Web",
   "license": "SEE LICENSE IN LICENSE",
   "sideEffects": false,
@@ -102,6 +102,6 @@
     "@types/emscripten": "^1.39.13"
   },
   "peerDependencies": {
-    "@scandit/web-datacapture-core": "7.2.0-beta.1"
+    "@scandit/web-datacapture-core": "7.2.0"
   }
 }