@hoshomoh/react-native-document-scanner 1.2.0

package/lib/module/textReconstructor.js

@@ -0,0 +1,147 @@
+"use strict";
+
+// Internal — not part of the public API.
+
+const MODE_FACTOR = {
+  paragraphs: 0.5,
+  clustered: 0.4
+};
+/**
+ * Reconstructs a visually-aligned plain-text document from a `ScanResult`.
+ *
+ * Automatically selects the right strategy based on the OCR engine recorded
+ * in `metadata` — no manual mode selection needed:
+ *
+ * | Engine                          | Strategy                                |
+ * |---------------------------------|-----------------------------------------|
+ * | V2 · MLKit or VNRecognizeText   | Returns `text` directly — the native    |
+ * |                                 | clustering already produced column-     |
+ * |                                 | aligned output.                         |
+ * | iOS 26+ RecognizeDocumentsReq.  | Spatially reconstructs from paragraph-  |
+ * |                                 | level blocks.                           |
+ * | V1 · either platform            | Spatially reconstructs from line-level  |
+ * |                                 | blocks.                                 |
+ *
+ * @param scanResult A `ScanResult` (or any object with `text`, `blocks`, `metadata`).
+ * @param options    Optional output tuning.
+ * @returns A plain-text string with column-aligned rows.
+ *
+ * @example
+ * const results = await scanDocuments({ includeText: true });
+ * const text = reconstructText(results[0]);
+ */
+export function reconstructText(scanResult, options = {}) {
+  const {
+    metadata,
+    blocks = [],
+    text = ''
+  } = scanResult;
+
+  // V2 via VNRecognizeTextRequest or MLKit: the native adaptive clustering
+  // already produced column-aligned text — return it directly.
+  // If text is absent (caller omitted it), fall back to block reconstruction
+  // using the line-level cluster blocks rather than returning empty.
+  if (metadata?.textVersion === 2 && metadata.ocrEngine !== 'RecognizeDocumentsRequest') {
+    if (text) {
+      return text.trimEnd();
+    }
+    return reconstructFromBlocks(blocks, 'clustered', options);
+  }
+
+  // iOS 26+ RecognizeDocumentsRequest returns paragraph-level blocks;
+  // V1 on any platform returns line-level blocks.
+  // Both paths use the spatial block reconstruction algorithm.
+  const mode = metadata?.ocrEngine === 'RecognizeDocumentsRequest' ? 'paragraphs' : 'clustered';
+  return reconstructFromBlocks(blocks, mode, options);
+}
+
+// ─── Internal block reconstruction algorithm ─────────────────────────────────
+
+function reconstructFromBlocks(blocks, mode, options) {
+  const {
+    lineWidth = 56,
+    minConfidence
+  } = options;
+  const rowGroupingFactor = options.rowGroupingFactor ?? MODE_FACTOR[mode];
+
+  // Step 1: Filter by confidence when requested.
+  const filtered = minConfidence !== undefined ? blocks.filter(b => b.confidence === undefined || b.confidence >= minConfidence) : blocks;
+  if (filtered.length === 0) {
+    return '';
+  }
+
+  // Step 2: Compute the median block height (= reference line height).
+  const heights = filtered.map(b => b.frame.height).sort((a, b) => a - b);
+  const hMid = Math.floor(heights.length / 2);
+  const typicalHeight = heights.length % 2 === 0 ? (heights[hMid - 1] + heights[hMid]) / 2 : heights[hMid];
+  const threshold = rowGroupingFactor * (typicalHeight > 0 ? typicalHeight : 0.02);
+
+  // Step 3: Sort all blocks by midY ascending (top of page first).
+  const sorted = [...filtered].sort((a, b) => {
+    const midA = a.frame.y + a.frame.height / 2;
+    const midB = b.frame.y + b.frame.height / 2;
+    return midA - midB;
+  });
+
+  // Step 4: Greedy row grouping by midY proximity.
+  // Each row tracks a running median centerY so that adding blocks to one
+  // side of a long line doesn't pull the reference point away from the others.
+
+  function computeMedian(values) {
+    const s = [...values].sort((a, b) => a - b);
+    const m = Math.floor(s.length / 2);
+    return s.length % 2 === 0 ? (s[m - 1] + s[m]) / 2 : s[m];
+  }
+  const rows = [];
+  for (const block of sorted) {
+    const blockMidY = block.frame.y + block.frame.height / 2;
+    let bestRow = null;
+    let bestDist = Infinity;
+    for (const row of rows) {
+      const dist = Math.abs(row.medianMidY - blockMidY);
+      if (dist < threshold && dist < bestDist) {
+        bestDist = dist;
+        bestRow = row;
+      }
+    }
+    if (bestRow !== null) {
+      bestRow.blocks.push(block);
+      bestRow.midYs.push(blockMidY);
+      bestRow.medianMidY = computeMedian(bestRow.midYs);
+    } else {
+      rows.push({
+        blocks: [block],
+        midYs: [blockMidY],
+        medianMidY: blockMidY
+      });
+    }
+  }
+
+  // Step 5: Sort rows top-to-bottom.
+  rows.sort((a, b) => a.medianMidY - b.medianMidY);
+
+  // Step 6: Render each row into a fixed-width character buffer.
+  const lines = [];
+  for (const row of rows) {
+    // Sort blocks left-to-right within the row.
+    const rowBlocks = [...row.blocks].sort((a, b) => a.frame.x - b.frame.x);
+    const buf = new Array(lineWidth).fill(' ');
+    let cursor = 0;
+    for (const block of rowBlocks) {
+      // Map normalized X to a character column, but never retreat behind cursor.
+      const col = Math.max(Math.round(block.frame.x * lineWidth), cursor);
+      for (let i = 0; i < block.text.length; i++) {
+        const pos = col + i;
+        if (pos < lineWidth) {
+          buf[pos] = block.text[i];
+        }
+      }
+
+      // Advance cursor past this block + a minimum single-space gap.
+      cursor = col + block.text.length + 1;
+    }
+    lines.push(buf.join('').trimEnd());
+  }
+  return lines.join('\n');
+}
+//# sourceMappingURL=textReconstructor.js.map

package/lib/module/textReconstructor.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["MODE_FACTOR","paragraphs","clustered","reconstructText","scanResult","options","metadata","blocks","text","textVersion","ocrEngine","trimEnd","reconstructFromBlocks","mode","lineWidth","minConfidence","rowGroupingFactor","filtered","undefined","filter","b","confidence","length","heights","map","frame","height","sort","a","hMid","Math","floor","typicalHeight","threshold","sorted","midA","y","midB","computeMedian","values","s","m","rows","block","blockMidY","bestRow","bestDist","Infinity","row","dist","abs","medianMidY","push","midYs","lines","rowBlocks","x","buf","Array","fill","cursor","col","max","round","i","pos","join"],"sourceRoot":"../../src","sources":["textReconstructor.ts"],"mappings":";;AAEA;;AAGA,MAAMA,WAA4C,GAAG;EACnDC,UAAU,EAAE,GAAG;EACfC,SAAS,EAAE;AACb,CAAC;AAgCD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,eAAeA,CAC7BC,UAA4E,EAC5EC,OAA2B,GAAG,CAAC,CAAC,EACxB;EACR,MAAM;IAAEC,QAAQ;IAAEC,MAAM,GAAG,EAAE;IAAEC,IAAI,GAAG;EAAG,CAAC,GAAGJ,UAAU;;EAEvD;EACA;EACA;EACA;EACA,IACEE,QAAQ,EAAEG,WAAW,KAAK,CAAC,IAC3BH,QAAQ,CAACI,SAAS,KAAK,2BAA2B,EAClD;IACA,IAAIF,IAAI,EAAE;MACR,OAAOA,IAAI,CAACG,OAAO,CAAC,CAAC;IACvB;IACA,OAAOC,qBAAqB,CAACL,MAAM,EAAE,WAAW,EAAEF,OAAO,CAAC;EAC5D;;EAEA;EACA;EACA;EACA,MAAMQ,IAAqB,GACzBP,QAAQ,EAAEI,SAAS,KAAK,2BAA2B,GAC/C,YAAY,GACZ,WAAW;EAEjB,OAAOE,qBAAqB,CAACL,MAAM,EAAEM,IAAI,EAAER,OAAO,CAAC;AACrD;;AAEA;;AAEA,SAASO,qBAAqBA,CAC5BL,MAAmB,EACnBM,IAAqB,EACrBR,OAA2B,EACnB;EACR,MAAM;IAAES,SAAS,GAAG,EAAE;IAAEC;EAAc,CAAC,GAAGV,OAAO;EACjD,MAAMW,iBAAiB,GAAGX,OAAO,CAACW,iBAAiB,IAAIhB,WAAW,CAACa,IAAI,CAAC;;EAExE;EACA,MAAMI,QAAQ,GACZF,aAAa,KAAKG,SAAS,GACvBX,MAAM,CAACY,MAAM,CACVC,CAAC,IAAKA,CAAC,CAACC,UAAU,KAAKH,SAAS,IAAIE,CAAC,CAACC,UAAU,IAAIN,aACvD,CAAC,GACDR,MAAM;EAEZ,IAAIU,QAAQ,CAACK,MAAM,KAAK,CAAC,EAAE;IACzB,OAAO,EAAE;EACX;;EAEA;EACA,MAAMC,OAAO,GAAGN,QAAQ,CAACO,GAAG,CAAEJ,CAAC,IAAKA,CAAC,CAACK,KAAK,CAACC,MAAM,CAAC,CAACC,IAAI,CAAC,CAACC,CAAC,EAAER,CAAC,KAAKQ,CAAC,GAAGR,CAAC,CAAC;EACzE,MAAMS,IAAI,GAAGC,IAAI,CAACC,KAAK,CAACR,OAAO,CAACD,MAAM,GAAG,CAAC,CAAC;EAC3C,MAAMU,aAAa,GACjBT,OAAO,CAACD,MAAM,GAAG,CAAC,KAAK,CAAC,GACpB,CAACC,OAAO,CAACM,IAAI,GAAG,CAAC,CAAC,GAAIN,OAAO,CAACM,IAAI,CAAE,IAAI,CAAC,GACzCN,OAAO,CAACM,IAAI,CAAE;EAEpB,MAAMI,SAAS,GACbjB,iBAAiB,IAAIgB,aAAa,GAAG,CAAC,GAAGA,aAAa,GAAG,IAAI,CAAC;;EAEhE;EACA,MAAME,MAAM,GAAG,CAAC,GAAGjB,QAAQ,CAAC,CAACU,IAAI,CAAC,CAACC,CAAC,EAAER,CAAC,KAAK;IAC1C,MAAMe,IAAI,GAAGP,CAAC,CAACH,KAAK,CAACW,CAAC,GAAGR,CAAC,CAACH,KAAK,CAACC,MAAM,GAAG,CAAC;IAC3C,MAAMW,IAAI,GAAGjB,CAAC,CAACK,KAAK,CAACW,CAAC,GAAGhB,CAAC,CAACK,KAAK,CAACC,MAAM,GAAG,CAAC;IAC3C,OAAOS,IAAI,GAAGE,IAAI;EACpB,CAAC,CAAC;;EAEF;EACA;EACA;;EAOA,SAASC,aAAaA,CAACC,MAAgB,EAAU;IAC/C,MAAMC,CAAC,GAAG,CAAC,GAAGD,MAAM,CAAC,CAACZ,IAAI,CAAC,CAACC,CAAC,EAAER,CAAC,KAAKQ,CAAC,GAAGR,CAAC,CAAC;IAC3C,MAAMqB,CAAC,GAAGX,IAAI,CAACC,KAAK,CAACS,CAAC,CAAClB,MAAM,GAAG,CAAC,CAAC;IAClC,OAAOkB,CAAC,CAAClB,MAAM,GAAG,CAAC,KAAK,CAAC,GAAG,CAACkB,CAAC,CAACC,CAAC,GAAG,CAAC,CAAC,GAAID,CAAC,CAACC,CAAC,CAAE,IAAI,CAAC,GAAGD,CAAC,CAACC,CAAC,CAAE;EAC7D;EAEA,MAAMC,IAAW,GAAG,EAAE;EAEtB,KAAK,MAAMC,KAAK,IAAIT,MAAM,EAAE;IAC1B,MAAMU,SAAS,GAAGD,KAAK,CAAClB,KAAK,CAACW,CAAC,GAAGO,KAAK,CAAClB,KAAK,CAACC,MAAM,GAAG,CAAC;IAExD,IAAImB,OAAmB,GAAG,IAAI;IAC9B,IAAIC,QAAQ,GAAGC,QAAQ;IAEvB,KAAK,MAAMC,GAAG,IAAIN,IAAI,EAAE;MACtB,MAAMO,IAAI,GAAGnB,IAAI,CAACoB,GAAG,CAACF,GAAG,CAACG,UAAU,GAAGP,SAAS,CAAC;MACjD,IAAIK,IAAI,GAAGhB,SAAS,IAAIgB,IAAI,GAAGH,QAAQ,EAAE;QACvCA,QAAQ,GAAGG,IAAI;QACfJ,OAAO,GAAGG,GAAG;MACf;IACF;IAEA,IAAIH,OAAO,KAAK,IAAI,EAAE;MACpBA,OAAO,CAACtC,MAAM,CAAC6C,IAAI,CAACT,KAAK,CAAC;MAC1BE,OAAO,CAACQ,KAAK,CAACD,IAAI,CAACR,SAAS,CAAC;MAC7BC,OAAO,CAACM,UAAU,GAAGb,aAAa,CAACO,OAAO,CAACQ,KAAK,CAAC;IACnD,CAAC,MAAM;MACLX,IAAI,CAACU,IAAI,CAAC;QACR7C,MAAM,EAAE,CAACoC,KAAK,CAAC;QACfU,KAAK,EAAE,CAACT,SAAS,CAAC;QAClBO,UAAU,EAAEP;MACd,CAAC,CAAC;IACJ;EACF;;EAEA;EACAF,IAAI,CAACf,IAAI,CAAC,CAACC,CAAC,EAAER,CAAC,KAAKQ,CAAC,CAACuB,UAAU,GAAG/B,CAAC,CAAC+B,UAAU,CAAC;;EAEhD;EACA,MAAMG,KAAe,GAAG,EAAE;EAE1B,KAAK,MAAMN,GAAG,IAAIN,IAAI,EAAE;IACtB;IACA,MAAMa,SAAS,GAAG,CAAC,GAAGP,GAAG,CAACzC,MAAM,CAAC,CAACoB,IAAI,CAAC,CAACC,CAAC,EAAER,CAAC,KAAKQ,CAAC,CAACH,KAAK,CAAC+B,CAAC,GAAGpC,CAAC,CAACK,KAAK,CAAC+B,CAAC,CAAC;IAEvE,MAAMC,GAAG,GAAG,IAAIC,KAAK,CAAS5C,SAAS,CAAC,CAAC6C,IAAI,CAAC,GAAG,CAAC;IAClD,IAAIC,MAAM,GAAG,CAAC;IAEd,KAAK,MAAMjB,KAAK,IAAIY,SAAS,EAAE;MAC7B;MACA,MAAMM,GAAG,GAAG/B,IAAI,CAACgC,GAAG,CAAChC,IAAI,CAACiC,KAAK,CAACpB,KAAK,CAAClB,KAAK,CAAC+B,CAAC,GAAG1C,SAAS,CAAC,EAAE8C,MAAM,CAAC;MAEnE,KAAK,IAAII,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAGrB,KAAK,CAACnC,IAAI,CAACc,MAAM,EAAE0C,CAAC,EAAE,EAAE;QAC1C,MAAMC,GAAG,GAAGJ,GAAG,GAAGG,CAAC;QACnB,IAAIC,GAAG,GAAGnD,SAAS,EAAE;UACnB2C,GAAG,CAACQ,GAAG,CAAC,GAAGtB,KAAK,CAACnC,IAAI,CAACwD,CAAC,CAAE;QAC3B;MACF;;MAEA;MACAJ,MAAM,GAAGC,GAAG,GAAGlB,KAAK,CAACnC,IAAI,CAACc,MAAM,GAAG,CAAC;IACtC;IAEAgC,KAAK,CAACF,IAAI,CAACK,GAAG,CAACS,IAAI,CAAC,EAAE,CAAC,CAACvD,OAAO,CAAC,CAAC,CAAC;EACpC;EAEA,OAAO2C,KAAK,CAACY,IAAI,CAAC,IAAI,CAAC;AACzB","ignoreList":[]}

package/lib/typescript/package.json

@@ -0,0 +1 @@
+{"type":"module"}

package/lib/typescript/src/NativeDocumentScanner.d.ts

@@ -0,0 +1,191 @@
+import { type TurboModule } from 'react-native';
+/**
+ * Type union of all available filter values.
+ * Required for React Native Codegen compatibility.
+ */
+export type FilterType = 'color' | 'grayscale' | 'monochrome' | 'denoise' | 'sharpen' | 'ocrOptimized';
+/**
+ * Type union of all available format values.
+ * Required for React Native Codegen compatibility.
+ */
+export type FormatType = 'jpg' | 'png';
+/**
+ * Represents a discrete block of text recognized by the OCR engine.
+ * Useful for mapping text to specific regions on the image.
+ */
+export interface TextBlock {
+    /** The text content within the block. */
+    text: string;
+    /**
+     * The normalized bounding box of the text.
+     * Coordinates (x, y, width, height) are in the range [0, 1].
+     * (0,0) is usually top-left.
+     */
+    frame: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+    /**
+     * OCR confidence score (0.0 to 1.0).
+     * Higher values indicate more reliable recognition.
+     * Useful for LLM post-processing to weight or filter results.
+     */
+    confidence?: number;
+}
+/**
+ * Describes the OCR engine and configuration used to produce a ScanResult.
+ * Pass the parent `ScanResult` directly to `reconstructText` — it reads
+ * `metadata` internally to select the right reconstruction strategy.
+ */
+export interface ScanMetadata {
+    /** Platform that generated this result. */
+    platform: 'ios' | 'android';
+    /** OCR engine version that was requested (1 = Raw, 2 = Heuristic). */
+    textVersion: 1 | 2;
+    /** Image filter applied before OCR. */
+    filter: FilterType;
+    /**
+     * The specific OCR engine used:
+     * - `"RecognizeDocumentsRequest"`: iOS 26+ native document understanding (V2).
+     * - `"VNRecognizeTextRequest"`: Apple Vision text request (V1 or V2 on iOS < 26).
+     * - `"MLKit"`: Android ML Kit Text Recognition (V1 or V2).
+     * - `"none"`: OCR was not performed (`includeText` was false).
+     */
+    ocrEngine: 'RecognizeDocumentsRequest' | 'VNRecognizeTextRequest' | 'MLKit' | 'none';
+}
+/**
+ * The result of a single scanned page.
+ */
+export interface ScanResult {
+    /** The local file URI of the scanned image (e.g., file:///...). */
+    uri?: string;
+    /** The Base64 encoded string of the image (if requested). */
+    base64?: string;
+    /** The full text extracted from the page, preserving layout. */
+    text?: string;
+    /** Array of structured text blocks with metadata. */
+    blocks?: TextBlock[];
+    /** Configuration and engine metadata for this result. */
+    metadata?: ScanMetadata;
+}
+/**
+ * Base configuration options shared by scan and process operations.
+ */
+export interface BaseOptions {
+    /** Compression quality (0.0 to 1.0) for JPEG. Default is 1.0. */
+    quality?: number;
+    /** Output image format. Use the `Format` constant for type-safe values. Default is 'jpg'. */
+    format?: FormatType;
+    /**
+     * Post-processing filter to apply.
+     * - `color`: No filter (default).
+     * - `grayscale`: Desaturates the image.
+     * - `monochrome`: High-contrast black & white (best for OCR).
+     * - `denoise`: Reduces image noise (improves OCR on noisy photos).
+     * - `sharpen`: Enhances edge clarity (improves OCR on blurry text).
+     * - `ocrOptimized`: Full pipeline: denoise → sharpen → monochrome (best accuracy).
+     */
+    filter?: FilterType;
+    /** Whether to include the base64 string in the result. Default is false. */
+    includeBase64?: boolean;
+    /** Whether to perform OCR and include text/blocks. */
+    includeText?: boolean;
+    /**
+     * Version of the text recognizer to use.
+     * - 1: Raw output (standard Vision/ML Kit behavior).
+     * - 2: Heuristic enhanced (Adaptive Clustering for layout preservation). Default.
+     */
+    textVersion?: number;
+}
+/**
+ * Configuration options for the Document Scanner.
+ * Fields are listed explicitly (not via extends) for React Native Codegen compatibility —
+ * Codegen only generates struct fields declared directly on the interface.
+ */
+export interface ScanOptions {
+    /** Maximum number of pages to scan. Default is unlimited (or hardware limit). */
+    maxPageCount?: number;
+    /** Compression quality (0.0 to 1.0) for JPEG. Default is 1.0. */
+    quality?: number;
+    /** Output image format. Use the `Format` constant for type-safe values. Default is 'jpg'. */
+    format?: FormatType;
+    /**
+     * Post-processing filter to apply.
+     * - `color`: No filter (default).
+     * - `grayscale`: Desaturates the image.
+     * - `monochrome`: High-contrast black & white (best for OCR).
+     * - `denoise`: Reduces image noise (improves OCR on noisy photos).
+     * - `sharpen`: Enhances edge clarity (improves OCR on blurry text).
+     * - `ocrOptimized`: Full pipeline: denoise → sharpen → monochrome (best accuracy).
+     */
+    filter?: FilterType;
+    /** Whether to include the base64 string in the result. Default is false. */
+    includeBase64?: boolean;
+    /** Whether to perform OCR and include text/blocks. */
+    includeText?: boolean;
+    /**
+     * Version of the text recognizer to use.
+     * - 1: Raw output (standard Vision/ML Kit behavior).
+     * - 2: Heuristic enhanced (Adaptive Clustering for layout preservation). Default.
+     */
+    textVersion?: number;
+}
+/**
+ * Configuration options for processing existing images.
+ * Fields are listed explicitly (not via extends) for React Native Codegen compatibility —
+ * Codegen only generates struct fields declared directly on the interface.
+ */
+export interface ProcessOptions {
+    /**
+     * Array of image sources. Each can be:
+     * - A file URI (e.g., "file:///path/to/image.jpg")
+     * - A base64-encoded string (with or without data URI prefix)
+     */
+    images: string[];
+    /** Compression quality (0.0 to 1.0) for JPEG. Default is 1.0. */
+    quality?: number;
+    /** Output image format. Use the `Format` constant for type-safe values. Default is 'jpg'. */
+    format?: FormatType;
+    /**
+     * Post-processing filter to apply.
+     * - `color`: No filter (default).
+     * - `grayscale`: Desaturates the image.
+     * - `monochrome`: High-contrast black & white (best for OCR).
+     * - `denoise`: Reduces image noise (improves OCR on noisy photos).
+     * - `sharpen`: Enhances edge clarity (improves OCR on blurry text).
+     * - `ocrOptimized`: Full pipeline: denoise → sharpen → monochrome (best accuracy).
+     */
+    filter?: FilterType;
+    /** Whether to include the base64 string in the result. Default is false. */
+    includeBase64?: boolean;
+    /** Whether to perform OCR and include text/blocks. */
+    includeText?: boolean;
+    /**
+     * Version of the text recognizer to use.
+     * - 1: Raw output (standard Vision/ML Kit behavior).
+     * - 2: Heuristic enhanced (Adaptive Clustering for layout preservation). Default.
+     */
+    textVersion?: number;
+}
+/**
+ * TurboModule Specification for the Document Scanner.
+ */
+export interface Spec extends TurboModule {
+    /**
+     * Opens the native document scanner UI.
+     * @param options Configuration options.
+     * @returns A Promise resolving to an array of ScanResults.
+     */
+    scanDocuments(options?: ScanOptions): Promise<ScanResult[]>;
+    /**
+     * Processes existing images without opening the camera UI.
+     * @param options Configuration including image sources.
+     * @returns A Promise resolving to an array of ScanResults.
+     */
+    processDocuments(options: ProcessOptions): Promise<ScanResult[]>;
+}
+declare const _default: Spec;
+export default _default;
+//# sourceMappingURL=NativeDocumentScanner.d.ts.map

package/lib/typescript/src/NativeDocumentScanner.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NativeDocumentScanner.d.ts","sourceRoot":"","sources":["../../../src/NativeDocumentScanner.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuB,KAAK,WAAW,EAAE,MAAM,cAAc,CAAC;AAErE;;;GAGG;AACH,MAAM,MAAM,UAAU,GAClB,OAAO,GACP,WAAW,GACX,YAAY,GACZ,SAAS,GACT,SAAS,GACT,cAAc,CAAC;AAEnB;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,KAAK,CAAC;AAEvC;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,KAAK,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IAC/D;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,2CAA2C;IAC3C,QAAQ,EAAE,KAAK,GAAG,SAAS,CAAC;IAC5B,sEAAsE;IACtE,WAAW,EAAE,CAAC,GAAG,CAAC,CAAC;IACnB,uCAAuC;IACvC,MAAM,EAAE,UAAU,CAAC;IACnB;;;;;;OAMG;IACH,SAAS,EACL,2BAA2B,GAC3B,wBAAwB,GACxB,OAAO,GACP,MAAM,CAAC;CACZ;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,mEAAmE;IACnE,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,6DAA6D;IAC7D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gEAAgE;IAChE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,qDAAqD;IACrD,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC;IACrB,yDAAyD;IACzD,QAAQ,CAAC,EAAE,YAAY,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,iEAAiE;IACjE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,6FAA6F;IAC7F,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,4EAA4E;IAC5E,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,sDAAsD;IACtD,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B,iFAAiF;IACjF,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,iEAAiE;IACjE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,6FAA6F;IAC7F,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,4EAA4E;IAC5E,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,sDAAsD;IACtD,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B;;;;OAIG;IACH,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,iEAAiE;IACjE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,6FAA6F;IAC7F,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,4EAA4E;IAC5E,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,sDAAsD;IACtD,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,IAAK,SAAQ,WAAW;IACvC;;;;OAIG;IACH,aAAa,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;IAE5D;;;;OAIG;IACH,gBAAgB,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;CAClE;;AAED,wBAAyE"}

package/lib/typescript/src/index.d.ts

@@ -0,0 +1,34 @@
+import { type ScanOptions, type ScanResult, type ScanMetadata, type TextBlock, type ProcessOptions, type FilterType, type FormatType } from './NativeDocumentScanner';
+/**
+ * Available image filters.
+ * Use these constants instead of raw strings for type safety.
+ */
+export declare const Filter: {
+    /** No filter (original colors) */
+    readonly COLOR: "color";
+    /** Desaturated image */
+    readonly GRAYSCALE: "grayscale";
+    /** High-contrast black & white */
+    readonly MONOCHROME: "monochrome";
+    /** Noise reduction (for noisy photos) */
+    readonly DENOISE: "denoise";
+    /** Edge enhancement (for blurry text) */
+    readonly SHARPEN: "sharpen";
+    /** Full OCR pipeline: denoise → sharpen → monochrome */
+    readonly OCR_OPTIMIZED: "ocrOptimized";
+};
+/**
+ * Available output formats.
+ */
+export declare const Format: {
+    /** JPEG format (smaller file size) */
+    readonly JPG: "jpg";
+    /** PNG format (lossless) */
+    readonly PNG: "png";
+};
+export declare function scanDocuments(options?: ScanOptions): Promise<ScanResult[]>;
+export declare function processDocuments(options: ProcessOptions): Promise<ScanResult[]>;
+export { reconstructText } from './textReconstructor';
+export type { ReconstructOptions } from './textReconstructor';
+export type { ScanOptions, ScanResult, ScanMetadata, TextBlock, ProcessOptions, FilterType, FormatType, };
+//# sourceMappingURL=index.d.ts.map

package/lib/typescript/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAAA,OAAwB,EACtB,KAAK,WAAW,EAChB,KAAK,UAAU,EACf,KAAK,YAAY,EACjB,KAAK,SAAS,EACd,KAAK,cAAc,EACnB,KAAK,UAAU,EACf,KAAK,UAAU,EAChB,MAAM,yBAAyB,CAAC;AAEjC;;;GAGG;AACH,eAAO,MAAM,MAAM;IACjB,kCAAkC;;IAElC,wBAAwB;;IAExB,kCAAkC;;IAElC,yCAAyC;;IAEzC,yCAAyC;;IAEzC,wDAAwD;;CAEhD,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,MAAM;IACjB,sCAAsC;;IAEtC,4BAA4B;;CAEpB,CAAC;AAEX,wBAAgB,aAAa,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CAE1E;AAED,wBAAgB,gBAAgB,CAC9B,OAAO,EAAE,cAAc,GACtB,OAAO,CAAC,UAAU,EAAE,CAAC,CAEvB;AAED,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACtD,YAAY,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAE9D,YAAY,EACV,WAAW,EACX,UAAU,EACV,YAAY,EACZ,SAAS,EACT,cAAc,EACd,UAAU,EACV,UAAU,GACX,CAAC"}

package/lib/typescript/src/textReconstructor.d.ts

@@ -0,0 +1,60 @@
+import type { TextBlock, ScanMetadata } from './NativeDocumentScanner';
+export interface ReconstructOptions {
+    /**
+     * Width of the output in characters.
+     * Default: 56. Use 48 for narrow thermal receipts, 64+ for wide documents.
+     */
+    lineWidth?: number;
+    /**
+     * Discard blocks whose `confidence` is below this value before
+     * reconstruction. Useful when scan quality is poor and low-confidence
+     * blocks produce garbage characters that disrupt the output.
+     *
+     * Only applies to V1 on any platform. Has no effect on V2 paths (native
+     * text is returned directly) or on iOS 26+ RecognizeDocumentsRequest
+     * (paragraph confidence is not exposed by the API — blocks always pass).
+     *
+     * Suggested values: `0.3` (aggressive), `0.5` (moderate).
+     * Default: `undefined` (no filtering).
+     */
+    minConfidence?: number;
+    /**
+     * Fine-tune the Y-proximity threshold directly. The threshold is
+     * `rowGroupingFactor × medianLineHeight`. Increase if blocks on the same
+     * visual line are being split into separate rows. Decrease if adjacent
+     * lines are being merged.
+     *
+     * Only applies to the block-based reconstruction path (V1 and iOS 26+).
+     */
+    rowGroupingFactor?: number;
+}
+/**
+ * Reconstructs a visually-aligned plain-text document from a `ScanResult`.
+ *
+ * Automatically selects the right strategy based on the OCR engine recorded
+ * in `metadata` — no manual mode selection needed:
+ *
+ * | Engine                          | Strategy                                |
+ * |---------------------------------|-----------------------------------------|
+ * | V2 · MLKit or VNRecognizeText   | Returns `text` directly — the native    |
+ * |                                 | clustering already produced column-     |
+ * |                                 | aligned output.                         |
+ * | iOS 26+ RecognizeDocumentsReq.  | Spatially reconstructs from paragraph-  |
+ * |                                 | level blocks.                           |
+ * | V1 · either platform            | Spatially reconstructs from line-level  |
+ * |                                 | blocks.                                 |
+ *
+ * @param scanResult A `ScanResult` (or any object with `text`, `blocks`, `metadata`).
+ * @param options    Optional output tuning.
+ * @returns A plain-text string with column-aligned rows.
+ *
+ * @example
+ * const results = await scanDocuments({ includeText: true });
+ * const text = reconstructText(results[0]);
+ */
+export declare function reconstructText(scanResult: {
+    text?: string;
+    blocks?: TextBlock[];
+    metadata?: ScanMetadata;
+}, options?: ReconstructOptions): string;
+//# sourceMappingURL=textReconstructor.d.ts.map

package/lib/typescript/src/textReconstructor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"textReconstructor.d.ts","sourceRoot":"","sources":["../../../src/textReconstructor.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAUvE,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;;;;;;;;OAWG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,eAAe,CAC7B,UAAU,EAAE;IAAE,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC;IAAC,QAAQ,CAAC,EAAE,YAAY,CAAA;CAAE,EAC5E,OAAO,GAAE,kBAAuB,GAC/B,MAAM,CA0BR"}

package/package.json

@@ -0,0 +1,137 @@
+{
+  "name": "@hoshomoh/react-native-document-scanner",
+  "version": "1.2.0",
+  "description": "A React Native library for scanning documents.",
+  "main": "./lib/module/index.js",
+  "types": "./lib/typescript/src/index.d.ts",
+  "exports": {
+    ".": {
+      "source": "./src/index.ts",
+      "types": "./lib/typescript/src/index.d.ts",
+      "default": "./lib/module/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "src",
+    "lib",
+    "ios",
+    "android",
+    "*.podspec",
+    "!ios/build",
+    "!android/build",
+    "!**/__tests__",
+    "!**/__fixtures__",
+    "!**/__mocks__",
+    "!**/.*"
+  ],
+  "scripts": {
+    "example": "yarn workspace react-native-document-scanner-example",
+    "clean": "del-cli example/ios/build lib",
+    "prepare": "lefthook install",
+    "build": "bob build",
+    "typecheck": "tsc",
+    "prepack": "bob build",
+    "lint": "eslint \"**/*.{js,ts,tsx}\"",
+    "lint:fix": "eslint \"**/*.{js,ts,tsx}\" --fix",
+    "lint:staged": "eslint --max-warnings=0",
+    "prettier": "prettier \"**/*.{js,ts,tsx,md}\" --check",
+    "prettier:fix": "prettier \"**/*.{js,ts,tsx,md}\" --write",
+    "prettier:staged": "prettier --write",
+    "test": "jest"
+  },
+  "keywords": [
+    "react-native",
+    "ios"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hoshomoh/react-native-document-scanner.git"
+  },
+  "author": "Oshomo Oforomeh <hello@oshomo.oforomeh.com> (https://github.com/hoshomoh)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/hoshomoh/react-native-document-scanner/issues"
+  },
+  "homepage": "https://github.com/hoshomoh/react-native-document-scanner#readme",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "devDependencies": {
+    "@commitlint/config-conventional": "^20.2.0",
+    "@eslint/compat": "^2.0.0",
+    "@eslint/eslintrc": "^3.3.3",
+    "@eslint/js": "^9.39.2",
+    "@react-native/babel-preset": "0.83.1",
+    "@react-native/eslint-config": "0.83.1",
+    "@types/jest": "^30.0.0",
+    "@types/react": "^19.2.7",
+    "commitlint": "^20.2.0",
+    "del-cli": "^7.0.0",
+    "eslint": "^9.39.2",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.4",
+    "jest": "^30.2.0",
+    "lefthook": "^2.0.13",
+    "prettier": "^3.7.4",
+    "react": "19.2.3",
+    "react-native": "0.83.1",
+    "react-native-builder-bob": "^0.40.17",
+    "turbo": "^2.7.2",
+    "typescript": "^5.9.3"
+  },
+  "peerDependencies": {
+    "react": "*",
+    "react-native": "*"
+  },
+  "workspaces": [
+    "example"
+  ],
+  "packageManager": "yarn@4.11.0",
+  "react-native-builder-bob": {
+    "source": "src",
+    "output": "lib",
+    "targets": [
+      [
+        "module",
+        {
+          "esm": true
+        }
+      ],
+      [
+        "typescript",
+        {
+          "project": "tsconfig.build.json"
+        }
+      ]
+    ]
+  },
+  "codegenConfig": {
+    "name": "DocumentScannerSpec",
+    "type": "modules",
+    "jsSrcsDir": "src",
+    "android": {
+      "javaPackageName": "com.documentscanner"
+    }
+  },
+  "prettier": {
+    "quoteProps": "consistent",
+    "singleQuote": true,
+    "tabWidth": 2,
+    "trailingComma": "es5",
+    "useTabs": false
+  },
+  "jest": {
+    "preset": "react-native",
+    "modulePathIgnorePatterns": [
+      "<rootDir>/example/node_modules",
+      "<rootDir>/lib/"
+    ]
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  }
+}