scanbot-web-sdk 7.0.0-dev.5 → 7.0.0-dev.7

package/@types/core/bridge/compiled/TiffTypes.d.ts

@@ -56,7 +56,7 @@ Binarization behavior to apply when adding pages to a TIFF.
 - `ENABLED`:
    Binarize the image. Image will be stored as a 1-bit TIFF. If the input image is not black-and-white, a simple thresholding is applied.
 - `ENABLED_IF_BINARIZATION_FILTER_SET`:
-   Same behavior as ENABLED if a binarization filter (TIFFWriterParameters.binarizationFilter) is set,
+   Same behavior as ENABLED if a binarization filter (TIFFGeneratorParameters.binarizationFilter) is set,
    otherwise same behavior as DISABLED. This is the default.
 */
 export type Binarization = "DISABLED" | "ENABLED" | "ENABLED_IF_BINARIZATION_FILTER_SET";
@@ -128,9 +128,9 @@ export declare class UserField extends PartiallyConstructible {
     constructor(source?: DeepPartial<UserField>);
 }
 /**
-TIFF writer parameters.
+TIFF generator parameters.
 */
-export declare class TiffWriterParameters extends PartiallyConstructible {
+export declare class TiffGeneratorParameters extends PartiallyConstructible {
     /**
     Compression.
     @defaultValue "LZW";
@@ -165,10 +165,10 @@ export declare class TiffWriterParameters extends PartiallyConstructible {
     @defaultValue null;
     */
     binarizationFilter: ParametricFilter | null;
-    /** @param source {@displayType `DeepPartial<TiffWriterParameters>`} */
-    constructor(source?: DeepPartial<TiffWriterParameters>);
+    /** @param source {@displayType `DeepPartial<TiffGeneratorParameters>`} */
+    constructor(source?: DeepPartial<TiffGeneratorParameters>);
 }
-export declare namespace TiffWriterParameters {
+export declare namespace TiffGeneratorParameters {
     /**
     Default compression.
     @defaultValue "LZW";

package/@types/core/worker/ScanbotSDK.Core.d.ts

@@ -10,7 +10,7 @@ import type { Page } from "../bridge/compiled/OcrTypes";
 import { type BarcodeDocumentFormat } from "../bridge/compiled/BarcodeDocumentTypes";
 import { BarcodeScannerConfiguration, type BarcodeScannerResult } from "../bridge/compiled/BarcodeScannerTypes";
 import { DocumentDataExtractorConfiguration, DocumentDataFrameExtractionParameters as GdrRecognitionParameters, type DocumentDataExtractionResult as GdrRecognitionResult } from "../bridge/compiled/DocumentDataExtractorTypes";
-import { type Binarization, TiffWriterParameters } from "../bridge/compiled/TiffTypes";
+import { type Binarization, TiffGeneratorParameters } from "../bridge/compiled/TiffTypes";
 import type { RawImage, Point, DeepPartial } from "../bridge/common";
 import type { GenericDocument } from "../bridge/compiled/GenericDocument";
 /** Represents an object of type T residing in the WASM's memory. */
@@ -52,7 +52,7 @@ export declare const commands: {
     beginPdf: (options: DeepPartial<PdfConfiguration>) => Promise<ObjectId<"PdfGenerationContext">>;
     addPageToPdf: (pdfOperation: ObjectId<"PdfGenerationContext">, image: Image) => Promise<void>;
     completePdf: (pdfOperation: ObjectId<"PdfGenerationContext">) => Promise<Uint8Array>;
-    beginTiff: (options: DeepPartial<TiffWriterParameters>) => Promise<ObjectId<"TiffGenerationContext">>;
+    beginTiff: (options: DeepPartial<TiffGeneratorParameters>) => Promise<ObjectId<"TiffGenerationContext">>;
     addPageToTiff: (tiffOperation: ObjectId<"TiffGenerationContext">, image: Image, binarization: Binarization) => Promise<unknown>;
     completeTiff: (tiffOperation: ObjectId<"TiffGenerationContext">) => Promise<Uint8Array>;
     createMRZScanner: (configuration: DeepPartial<MrzScannerConfiguration>) => Promise<ObjectId<"MRZScannerContext">>;

package/@types/cropping-view.d.ts

@@ -51,6 +51,7 @@ export default class CroppingView extends React.Component<CroppingViewProps, Cro
     private _configuration?;
     private onResizeCallback;
     private sdk;
+    private static readonly FULL_SIZE_POLYGON;
     constructor(props: any);
     /**
      * Public API functions

package/@types/index.d.ts

@@ -57,6 +57,7 @@ export { DocumentScannerUIResult } from "./ui2/configuration/document/DocumentSc
 
 /** Storage-related exports */
 export { SBStorage, SBStoreCroppedDetectionResult } from "./service/storage/sb-storage";
+export { SBStorageUtils, } from "./service/storage/utils/sb-storage-utils";
 export { SBStoreImage, SBStorePageImage, SBStoreImageType, SBStorageQuery } from "./service/storage/indexed-db/sb-indexed-db";
 export { SBDocument } from "./ui2/document/model/sb-document";
 export { SBPage, SBPageEditParams, SBPageCropData } from "./ui2/document/model/sb-page";

package/@types/scanbot-sdk.d.ts

@@ -20,7 +20,7 @@ import { VinScannerViewConfiguration } from "./model/configuration/vin-scanner-v
 import { ITextPatternScannerHandle } from "./interfaces/i-text-pattern-scanner-handle";
 import DocumentQualityAnalyzer from "./service/document-quality-analyzer";
 import ScanbotSDKUI from "./ui2/scanbot-sdk-ui";
-import { Image, DeepPartial, RawImage, ObjectId, Point, DocumentScannerParameters, DocumentDetectionResult, CroppedDetectionResult, BarcodeScannerConfiguration, BarcodeDocumentFormat, DocumentQualityAnalyzerConfiguration, ImageRotation, ParametricFilter, PdfConfiguration, TiffWriterParameters, DocumentDataExtractorConfiguration } from "./core-types";
+import { Image, DeepPartial, RawImage, ObjectId, Point, DocumentScannerParameters, DocumentDetectionResult, CroppedDetectionResult, BarcodeScannerConfiguration, BarcodeDocumentFormat, DocumentQualityAnalyzerConfiguration, ImageRotation, ParametricFilter, PdfConfiguration, TiffGeneratorParameters, DocumentDataExtractorConfiguration } from "./core-types";
 import * as Config from "./core-types";
 import { DocumentDataExtractor } from "./service/document-data-extractor";
 import { DocumentDataExtractorViewConfiguration } from "./model/configuration/document-data-extractor-view-configuration";
@@ -79,8 +79,8 @@ export default class ScanbotSDK {
     getLicenseInfo(): Promise<LicenseInfo>;
     /** @param options {@displayType `DeepPartial<PdfConfiguration>`} {@link PdfConfiguration}*/
     beginPdf(options: DeepPartial<PdfConfiguration>): Promise<PdfGenerator>;
-    /** @param options {@displayType `DeepPartial<TiffWriterParameters>`} {@link TiffWriterParameters} */
-    beginTiff(options?: DeepPartial<TiffWriterParameters>): Promise<TiffGenerator>;
+    /** @param options {@displayType `DeepPartial<TiffGeneratorParameters>`} {@link TiffGeneratorParameters} */
+    beginTiff(options?: DeepPartial<TiffGeneratorParameters>): Promise<TiffGenerator>;
     /** @param options {@displayType `DeepPartial<DocumentDataExtractorConfiguration>`} {@link DocumentDataExtractorConfiguration}*/
     createDocumentDataExtractor(options: DeepPartial<DocumentDataExtractorConfiguration>): Promise<DocumentDataExtractor>;
     imageToJpeg(image: Image, consumeImage?: ConsumeType): Promise<Uint8Array>;

package/@types/service/storage/indexed-db/sb-indexed-db.d.ts

@@ -57,4 +57,5 @@ export default class SBIndexedDB {
     generateUniqueToken(): string;
     taskMap: Map<any, any>;
     query<T>(query: SBStorageQuery): Promise<T>;
+    destroy(): void;
 }

package/@types/service/storage/sb-storage.d.ts

@@ -4,12 +4,21 @@ import { SBDocument } from "../../ui2/document/model/sb-document";
 import { SBPage } from "../../ui2/document/model/sb-page";
 import { SBPageData } from "../../ui2/document/model/utils/sb-page-data";
 import { SBDocumentData } from "../../ui2/document/model/utils/sb-document-data";
+import { SBStorageUtils } from "./utils/sb-storage-utils";
 export interface SBStoreCroppedDetectionResult extends CroppedDetectionResult {
     id: number;
 }
 export declare class SBStorage {
+    readonly utils: SBStorageUtils;
     private db;
+    /**
+     * Clears all data from storage. Retains the database itself, including indexing.
+     */
     clear(): Promise<void>;
+    /**
+     * @internal
+     * Clears all data from storage. Does not retain the database, clearing indexes.
+     * */
     delete(): Promise<void>;
     getCroppedDetectionResults(withImages?: boolean): Promise<SBStoreCroppedDetectionResult[]>;
     getCroppedDetectionResult(id: number): Promise<SBStoreCroppedDetectionResult>;
@@ -23,11 +32,17 @@ export declare class SBStorage {
      */
     storeCroppedDetectionResult(input: CroppedDetectionResult): Promise<number>;
     getSBDocumentIds(): Promise<number[]>;
+    getSBDocumentData(id: number): Promise<SBDocumentData>;
+    /** @internal */
     insertSBDocument(input: SBDocument): Promise<number>;
+    /** @internal */
     deleteSBDocument(document: SBDocument | number): Promise<boolean>;
-    getSBDocument(id: number): Promise<SBDocumentData>;
+    /** @internal */
     insertSBPageImage(input: Image): Promise<number>;
     getSBPageImage(id: number): Promise<Image>;
+    /** @internal */
     deleteImageById(id: number): Promise<boolean>;
+    /** @internal */
     deleteImages(page: SBPageData | SBPage): Promise<void>;
+    destroy(): void;
 }

package/@types/service/storage/utils/sb-storage-utils.d.ts

@@ -1,10 +1,11 @@
-export default class SBStorageUtils {
+export declare class SBStorageUtils {
     /**
      * The persist() method of the SBStorage interface requests permission to use persistent storage,
      * and returns a Promise that resolves to true if permission is granted and bucket mode is persistent, and false otherwise.
      * The browser may or may not honor the request, depending on browser-specific rules.
      * For more details, see https://developer.mozilla.org/en-US/docs/Web/API/Storage_API/Storage_quotas_and_eviction_criteria#does_browser-stored_data_persist
      */
-    static persist(): Promise<boolean>;
-    static estimate(): Promise<boolean>;
+    persist(): Promise<boolean>;
+    /** ©internal */
+    estimate(): Promise<boolean>;
 }

package/@types/ui2/configuration/document/DocumentScannerOutputSettings.d.ts

@@ -29,9 +29,9 @@ export declare class DocumentScannerOutputSettings extends PartiallyConstructibl
       */
     documentAnalysisMode: DocumentAnalysisMode;
     /**
-     Determines the image filter to apply by default.
-     @defaultValue null;
-     */
+      Determines the image filter to apply by default.
+      @defaultValue null;
+      */
     defaultFilter: ParametricFilter | null;
     /** @param source {@displayType `DeepPartial<DocumentScannerOutputSettings>`} */
     constructor(source?: DeepPartial<DocumentScannerOutputSettings>);

package/@types/ui2/configuration/native/PageData.d.ts

@@ -48,11 +48,6 @@ export declare class PageData extends PartiallyConstructible {
       @defaultValue null;
       */
     readonly documentImageId: number | null;
-    /**
-      The unique identifier of the unfiltered document image.
-      @defaultValue null;
-      */
-    readonly unfilteredDocumentImageId: number | null;
     /** @param source {@displayType `DeepPartial<PageData>`} */
     constructor(source?: DeepPartial<PageData>);
 }

package/@types/ui2/document/model/sb-document.d.ts

@@ -1,6 +1,6 @@
 import { type Point } from "../../configuration/utils";
 import ScanbotSDK from "../../../scanbot-sdk";
-import { CroppedDetectionResult, DeepPartial, PdfConfiguration, TiffWriterParameters } from "../../../core-types";
+import { CroppedDetectionResult, DeepPartial, PdfConfiguration, TiffGeneratorParameters } from "../../../core-types";
 import { SBPage } from "./sb-page";
 import { PageImageSource } from "../../configuration/native/PageImageSource";
 import { DocumentQuality } from "../../configuration/DocumentQualityAnalyzerTypes";
@@ -34,6 +34,7 @@ export declare class SBDocument {
     sdk(): ScanbotSDK;
     get pageCount(): number;
     pageAtIndex(position: number): SBPage;
+    movePage(from: number, to: number): Promise<void>;
     static loadFromStorage(documentId: number): Promise<SBDocument>;
     /** @internal */
     static create(config: SBDocumentConfig): Promise<SBDocument>;
@@ -53,10 +54,12 @@ export declare class SBDocument {
     convertToFinalVersion(): Promise<SBDocument>;
     private insertRenderedBuffer;
     createPdf(generatorOptions: DeepPartial<PdfConfiguration>): Promise<ArrayBuffer>;
-    createTiff(generatorOptions?: DeepPartial<TiffWriterParameters>, pageOptions?: Omit<TiffPageOptions, "consumeImage">): Promise<ArrayBuffer>;
+    createTiff(generatorOptions?: DeepPartial<TiffGeneratorParameters>, pageOptions?: Omit<TiffPageOptions, "consumeImage">): Promise<ArrayBuffer>;
     loadPdf(): Promise<ArrayBuffer>;
     loadTiff(): Promise<ArrayBuffer>;
     private loadBuffer;
     private saveRenderedPdf;
     private saveRenderedTiff;
+    deletePdf(): Promise<boolean>;
+    deleteTiff(): Promise<boolean>;
 }

package/@types/ui2/document/model/sb-page.d.ts

@@ -1,4 +1,3 @@
-import ScanbotSDK from "../../../scanbot-sdk";
 import { Image } from "../../../core/worker/ScanbotSDK.Core";
 import { ParametricFilter } from "../../../core/bridge/compiled/ParametricFilters";
 import { Point } from "../../../utils/dto/Point";
@@ -27,12 +26,18 @@ export declare class SBPage {
     constructor(document: SBDocument, data: SBPageData);
     private static readonly ROTATIONS;
     private static readonly FULL_SIZE_POLYGON;
-    sdk(): ScanbotSDK;
-    getOriginalImage(): Promise<Image>;
+    private sdk;
+    loadOriginalImage(): Promise<Image>;
+    loadDocumentImage(): Promise<Image | null>;
+    /** @internal */
     getPolygon(): Point[];
+    /** @internal */
     cropData(): Promise<SBPageCropData>;
     private _finalImageUrl;
+    /** @internal */
     finalRawImage(): Promise<RawImage>;
+    /** @internal */
     finalImageUrl(): Promise<string>;
+    /** @internal */
     invalidateImage(): Promise<void>;
 }

package/@types/ui2/scanbot-sdk-ui.d.ts

@@ -1,7 +1,9 @@
 import * as Config from "./configuration";
 import { BarcodeScannerUiResult } from "./configuration";
 import { DocumentScannerUIResult } from "./configuration/document/DocumentScannerUIResult";
+import { SBDocument } from "./document/model/sb-document";
 export default class ScanbotSDKUI {
+    static SBDocument: typeof SBDocument;
     static createDocumentScanner(config: Config.DocumentScanningFlow, documentId?: number): Promise<DocumentScannerUIResult | null>;
     static createBarcodeScanner(config: Config.BarcodeScannerConfiguration): Promise<BarcodeScannerUiResult | null>;
     private static createRoot;