@exige/web-scanner-sdk 0.2.9

package/dist/sdk/scan.d.ts

@@ -0,0 +1,61 @@
+import { type OrtWasmPaths } from './ort-runtime';
+import type { DocumentCorners, DocumentDetectionResult, ImageSource, ScanResult } from './types';
+export interface ScanOptions {
+    minDimension?: number;
+    minConfidence?: number;
+    maxAnalysisDimension?: number;
+    maxOutputDimension?: number;
+    useWorker?: boolean;
+    /**
+     * DocAligner checkpoint URL. Omit this. The default is the Exige CDN
+     * DocAligner model (`DEFAULT_DOCUMENT_MODEL_URL`).
+     */
+    modelUrl?: string;
+    /** Heatmap threshold used before largest-component corner centroids. */
+    heatmapThreshold?: number;
+    /** Reuse model bytes through the browser HTTP cache. */
+    cacheModel?: boolean;
+    /**
+     * ONNX Runtime wasm override. Omit this. The default is the packaged
+     * `ort-wasm-simd-threaded.jsep.wasm` and `.mjs` files.
+     * A string is a directory that contains both files. An object sets each URL.
+     */
+    ortWasmPaths?: OrtWasmPaths;
+}
+export declare const DEFAULT_DOCUMENT_MODEL_URL = "https://exige-scanner-sdk.vercel.app/models/docaligner-lcnet100-f4117b78.onnx";
+export declare function resolveDocumentModelUrl(modelUrl?: string): string;
+export declare function perspectiveOutputSize(corners: DocumentCorners, maxDimension: number): {
+    width: number;
+    height: number;
+};
+/**
+ * Finds document corners. Returns `success`, `no-document`, `low-confidence`,
+ * or `low-quality`. A bad image is one of those statuses and does not throw.
+ * Inference or geometry failure is `modelStatus: 'failed'`, not a throw.
+ *
+ * @throws {LicenseError} LicenseError when the scan feature is not licensed. Detection does not start.
+ * @throws {ScannerError} ScannerError `canvas` when canvas 2D is unavailable.
+ * `worker` when the document worker cannot start.
+ * `model-http` when the DocAligner file returns a failed HTTP response.
+ */
+export declare function detectDocument(source: ImageSource, options?: ScanOptions): Promise<DocumentDetectionResult>;
+/**
+ * Perspective-crops `corners` onto a new canvas.
+ * Resolves with `status: 'success'`. It does not score image quality.
+ *
+ * @throws {LicenseError} LicenseError when the scan feature is not licensed.
+ * @throws {ScannerError} ScannerError `canvas` when canvas 2D is unavailable.
+ */
+export declare function cropDocument(source: ImageSource, corners: DocumentCorners, options?: Pick<ScanOptions, 'maxOutputDimension'>): Promise<ScanResult>;
+/**
+ * Detects a document and perspective-crops it.
+ * Returns `success`, `no-document`, `low-confidence`, or `low-quality`.
+ * A bad image is one of those statuses and does not throw.
+ * Inference or geometry failure is `modelStatus: 'failed'`, not a throw.
+ *
+ * @throws {LicenseError} LicenseError when the scan feature is not licensed. Detection does not start.
+ * @throws {ScannerError} ScannerError `canvas` when canvas 2D is unavailable.
+ * `worker` when the document worker cannot start.
+ * `model-http` when the DocAligner file returns a failed HTTP response.
+ */
+export declare function scanDocument(source: ImageSource, options?: ScanOptions): Promise<ScanResult>;

package/dist/sdk/types.d.ts

@@ -0,0 +1,80 @@
+export type ImageSource = Blob | HTMLImageElement | HTMLCanvasElement | ImageBitmap;
+export interface Point {
+    x: number;
+    y: number;
+}
+export interface Box {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+export interface DocumentCorners {
+    topLeft: Point;
+    topRight: Point;
+    bottomRight: Point;
+    bottomLeft: Point;
+}
+export interface DocumentEdge {
+    start: Point;
+    end: Point;
+}
+export interface DocumentQuad extends DocumentCorners {
+    edges: {
+        top: DocumentEdge;
+        right: DocumentEdge;
+        bottom: DocumentEdge;
+        left: DocumentEdge;
+    };
+}
+export type DocumentDetectionStatus = 'success' | 'no-document' | 'low-confidence' | 'low-quality';
+export type DocumentModelStatus = 'loading' | 'ready' | 'failed';
+export interface DocumentDetectionResult {
+    status: DocumentDetectionStatus;
+    quad?: DocumentQuad;
+    corners?: DocumentCorners;
+    confidence: number;
+    message: string;
+    sourceWidth: number;
+    sourceHeight: number;
+    detector?: 'ml';
+    modelStatus?: DocumentModelStatus;
+    modelProvider?: 'webgpu' | 'wasm';
+    modelError?: string;
+    inferenceMs?: number;
+}
+export interface ScanResult extends DocumentDetectionResult {
+    canvas?: HTMLCanvasElement;
+}
+export interface OcrResult {
+    /** Text rebuilt from words that meet OcrOptions.minConfidence. */
+    text: string;
+    /** Arithmetic mean of retained word confidence, normalized 0–1; 0 when empty. */
+    confidence: number;
+    language: string;
+    imageWidth: number;
+    imageHeight: number;
+    diagnostics?: OcrDiagnostics;
+    words?: OcrBox[];
+    characters?: OcrBox[];
+}
+export interface OcrDiagnostics {
+    shadowPassUsed: boolean;
+    castShadowStrength: number;
+    shadowRegion?: Box;
+}
+export interface OcrBox {
+    text: string;
+    /** Token confidence normalized to 0–1. */
+    confidence: number;
+    bbox: Box;
+}
+export interface RedactionRegion extends Box {
+    mode?: 'blackout' | 'blur';
+}
+export interface RedactOptions {
+    mode?: 'blackout' | 'blur';
+    blurRadius?: number;
+    mimeType?: 'image/png' | 'image/jpeg' | 'image/webp';
+    quality?: number;
+}

package/package.json

@@ -0,0 +1,93 @@
+{
+  "name": "@exige/web-scanner-sdk",
+  "version": "0.2.9",
+  "description": "@exige/web-scanner-sdk is a client-side web document scanner SDK. ML document finding, OCR, and redaction run in the browser. The public demo is the only path that does not need an account. A hostname you control needs a signed license key.",
+  "type": "module",
+  "license": "MIT",
+  "sideEffects": [
+    "**/*.css"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/scanner-sdk.js",
+  "module": "./dist/scanner-sdk.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/scanner-sdk.js"
+    },
+    "./react": {
+      "types": "./dist/react.d.ts",
+      "import": "./dist/react.js"
+    },
+    "./camera-overlay.css": "./dist/components/scanner-camera-overlay.css",
+    "./assets/document-worker.js": "./dist/assets/document-worker.js",
+    "./assets/ort.min.js": "./dist/assets/ort.min.js",
+    "./assets/ort-wasm-simd-threaded.jsep.wasm": "./dist/assets/ort-wasm-simd-threaded.jsep.wasm",
+    "./assets/ort-wasm-simd-threaded.jsep.mjs": "./dist/assets/ort-wasm-simd-threaded.jsep.mjs",
+    "./assets/tesseract/worker.min.js": "./dist/assets/tesseract/worker.min.js",
+    "./assets/tesseract/tesseract-core-lstm.wasm.js": "./dist/assets/tesseract/tesseract-core-lstm.wasm.js",
+    "./assets/tesseract/tesseract-core-simd-lstm.wasm.js": "./dist/assets/tesseract/tesseract-core-simd-lstm.wasm.js",
+    "./assets/tesseract/tesseract-core-relaxedsimd-lstm.wasm.js": "./dist/assets/tesseract/tesseract-core-relaxedsimd-lstm.wasm.js",
+    "./assets/tesseract/eng.traineddata.gz": "./dist/assets/tesseract/eng.traineddata.gz",
+    "./assets-manifest.json": "./dist/assets-manifest.json"
+  },
+  "scripts": {
+    "dev": "vite --config vite.config.app.ts",
+    "build": "npm run build:lib && npm run build:demo",
+    "build:wasm": "node scripts/build-scanner-wasm.mjs",
+    "prepare": "node scripts/copy-runtime-assets.mjs && node scripts/build-scanner-wasm.mjs",
+    "build:lib": "node scripts/copy-runtime-assets.mjs && tsc -b && vite build && tsc -p tsconfig.lib.json",
+    "build:demo": "node scripts/copy-runtime-assets.mjs && tsc -b && vite build --config vite.config.app.ts",
+    "vercel-build": "npm run build:demo",
+    "typecheck": "tsc -b",
+    "test": "node scripts/copy-runtime-assets.mjs && vitest run && node --test native/wasm/decode.test.mjs",
+    "test:wasm": "node --test native/wasm/decode.test.mjs",
+    "lint": "oxlint",
+    "preview": "vite preview --config vite.config.app.ts",
+    "docs:api": "typedoc",
+    "docs:dev": "npm run docs:api && vitepress dev site --host 0.0.0.0 --port 43261",
+    "docs:build": "npm run docs:api && vitepress build site",
+    "docs:preview": "vitepress preview site --host 0.0.0.0 --port 43261",
+    "docs:vercel": "npm run docs:build && node docs-mcp/assemble-vercel-output.mjs",
+    "docs:mcp": "node docs-mcp/server.mjs",
+    "docs:mcp:http": "node docs-mcp/server.mjs --http --host 127.0.0.1 --port 8787",
+    "dev:portal": "npm --prefix license-portal run dev",
+    "test:portal": "npm --prefix license-portal test"
+  },
+  "dependencies": {
+    "onnxruntime-web": "^1.30.0",
+    "tesseract.js": "^7.0.0"
+  },
+  "peerDependencies": {
+    "react": ">=18"
+  },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@tesseract.js-data/eng": "1.0.0",
+    "@types/node": "^24.13.3",
+    "@types/react": "^19.2.18",
+    "@types/react-dom": "^19.2.7",
+    "@vitejs/plugin-react": "^6.1.1",
+    "happy-dom": "^20.14.5",
+    "oxlint": "^1.81.0",
+    "react": "^19.2.8",
+    "react-dom": "^19.2.8",
+    "typedoc": "^0.28.20",
+    "typedoc-plugin-markdown": "^4.13.1",
+    "typescript": "~6.0.2",
+    "vite": "^8.3.0",
+    "vitepress": "^1.6.4",
+    "vitepress-plugin-llms": "^1.14.0",
+    "vitest": "^5.0.1"
+  }
+}