scanbot-web-sdk
Advanced tools
Comparing version 6.0.0-dev.2 to 6.0.0-dev.3
/** | ||
* ConsumeImage describes how a SDK method should handle image data. | ||
* | ||
* - `CONSUME_IMAGE` - This will use less memory but the caller can no longer access the image data. | ||
* - `CONSUME_IMAGE` - This will use less memory but the caller can no longer access the original image data after the call to the SDK function. | ||
* Internally, the image data is transferred to a web worker, see https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Transferable_objects | ||
* - `COPY_IMAGE` - For processing the image, a copy is made. The caller can still access the original image data. This approach uses more memory. | ||
*/ | ||
export type ConsumeType = 'CONSUME_IMAGE' | 'COPY_IMAGE'; |
@@ -10,3 +10,5 @@ export * as BarcodeConfigs from './core/bridge/compiled/BarcodeConfigs'; | ||
export * as GenericDocument from './core/bridge/compiled/GenericDocument'; | ||
export * as GenericDocumentRecognizerConfigs from './core/bridge/compiled/GenericDocumentRecognizerConfigs'; | ||
export * as GenericDocumentRecognizerTypes from './core/bridge/compiled/GenericDocumentRecognizerTypes'; | ||
export * as GenericDocumentTypes from './core/bridge/compiled/GenericDocumentTypes'; | ||
export * as GenericTextLineScannerTypes from './core/bridge/compiled/GenericTextLineScannerTypes'; | ||
@@ -24,2 +26,2 @@ export * as Geometry from './core/bridge/compiled/Geometry'; | ||
export type { ObjectId, Image, CroppedDetectionResult } from './core/worker/ScanbotSDK.Core'; | ||
export type { PartiallyConstructible, RawImage, DeepPartial, Point, Rectangle } from './core/bridge/common'; | ||
export { PartiallyConstructible, type RawImage, type DeepPartial, type Point, type Rectangle } from './core/bridge/common'; |
@@ -7,3 +7,3 @@ export declare class PartiallyConstructible { | ||
[P in keyof T]?: DeepPartial<T[P]>; | ||
} : T; | ||
} : T extends Array<infer I> ? DeepPartial<I>[] : T; | ||
export type RawImage = { | ||
@@ -10,0 +10,0 @@ width: number; |
@@ -75,7 +75,9 @@ import { BarcodeConfig } from "./BarcodeConfigs"; | ||
- `NEXT_GEN`: | ||
Main engine mode. Supports all barcodes types. Typically produces results faster than NEXT_GEN_LOW_POWER on most devices in live mode. | ||
Main engine mode for high-power devices. Supports all barcodes types. | ||
- `NEXT_GEN_LOW_POWER_AR`: | ||
Similar to NEXT_GEN_LOW_POWER, but optimized for AR. | ||
- `NEXT_GEN_AR`: | ||
Similar to NEXT_GEN, but optimized for AR. | ||
*/ | ||
export type EngineMode = "LEGACY" | "NEXT_GEN_LOW_POWER" | "NEXT_GEN" | "NEXT_GEN_AR"; | ||
export type EngineMode = "LEGACY" | "NEXT_GEN_LOW_POWER" | "NEXT_GEN" | "NEXT_GEN_LOW_POWER_AR" | "NEXT_GEN_AR"; | ||
/** | ||
@@ -149,3 +151,3 @@ Type of barcode document format used. | ||
The engine mode for barcode scanning | ||
@defaultValue "NEXT_GEN"; | ||
@defaultValue "NEXT_GEN_LOW_POWER"; | ||
*/ | ||
@@ -152,0 +154,0 @@ engineMode: EngineMode; |
@@ -72,2 +72,35 @@ import { CommonFieldType } from "./CommonFieldType"; | ||
/** | ||
Type of parsing applied to field. | ||
- `ISO_DATE`: | ||
Field value is parsed as ISO 8601 date in format YYYY-MM-DD. | ||
- `ISO_COUNTRY_ALPHA_2`: | ||
Field value is parsed as ISO 3166-1 alpha-2 country code. E.g. "DE" for Germany. | ||
- `ISO_COUNTRY_ALPHA_3`: | ||
Field value is parsed as ISO 3166-1 alpha-3 country code. E.g. "DEU" for Germany. | ||
- `ISO_COUNTRY_NUMERIC`: | ||
Field value is parsed as ISO 3166-1 numeric country code. E.g. "276" for Germany. | ||
- `ISO_COUNTRY_NAME`: | ||
Field value is parsed as ISO 3166-1 country name. E.g. "Germany". | ||
- `GENDER`: | ||
Field value is parsed as "Male", "Female". | ||
*/ | ||
export type DataFormat = "ISO_DATE" | "ISO_COUNTRY_ALPHA_2" | "ISO_COUNTRY_ALPHA_3" | "ISO_COUNTRY_NUMERIC" | "ISO_COUNTRY_NAME" | "GENDER"; | ||
/** | ||
Parsed data | ||
*/ | ||
export declare class ParsedData extends PartiallyConstructible { | ||
/** | ||
Parsing type | ||
*/ | ||
readonly type: DataFormat; | ||
/** | ||
Parsed value | ||
*/ | ||
readonly value: string; | ||
/** @param source {@displayType `DeepPartial<ParsedData>`} */ | ||
constructor(source?: DeepPartial<ParsedData>); | ||
} | ||
/** | ||
Generic Document Type | ||
@@ -131,2 +164,7 @@ */ | ||
readonly validationStatus: ValidationStatus; | ||
/** | ||
Parsed data | ||
@defaultValue []; | ||
*/ | ||
readonly parsedData: ParsedData[]; | ||
/** @param source {@displayType `DeepPartial<Field>`} */ | ||
@@ -133,0 +171,0 @@ constructor(source?: DeepPartial<Field>); |
import { DeepPartial, PartiallyConstructible } from "../common"; | ||
import { GDRConfig } from "./GenericDocumentRecognizerConfigs"; | ||
import { GenericDocument } from "./GenericDocument"; | ||
@@ -86,3 +87,3 @@ import { Point } from "../common"; | ||
*/ | ||
export declare class GenericDocumentRecognizerConfig extends PartiallyConstructible { | ||
export declare class GenericDocumentRecognizerParameters extends PartiallyConstructible { | ||
/** | ||
@@ -99,8 +100,8 @@ Configuration for how to accumulate results | ||
/** | ||
Names of documents that should be recognized | ||
@defaultValue []; | ||
Options for generic document decoding | ||
@defaultValue [new GDRGroupConfig({})]; | ||
*/ | ||
acceptedDocumentTypes: string[]; | ||
/** @param source {@displayType `DeepPartial<GenericDocumentRecognizerConfig>`} */ | ||
constructor(source?: DeepPartial<GenericDocumentRecognizerConfig>); | ||
configurations: GDRConfig[]; | ||
/** @param source {@displayType `DeepPartial<GenericDocumentRecognizerParameters>`} */ | ||
constructor(source?: DeepPartial<GenericDocumentRecognizerParameters>); | ||
} |
@@ -20,3 +20,3 @@ import { DeepPartial, PartiallyConstructible } from "../common"; | ||
- `PRESET_2`: | ||
Usually performs well even if there are shadows. | ||
Usually performs well even if there are shadows and barcodes. | ||
- `PRESET_3`: | ||
@@ -26,4 +26,6 @@ Usually performs well even if there are shadows. | ||
Usually performs well even if there are shadows. | ||
- `PRESET_5`: | ||
Usually performs well even if there are shadows and barcodes. | ||
*/ | ||
export type BinarizationFilterPreset = "PRESET_1" | "PRESET_2" | "PRESET_3" | "PRESET_4"; | ||
export type BinarizationFilterPreset = "PRESET_1" | "PRESET_2" | "PRESET_3" | "PRESET_4" | "PRESET_5"; | ||
/** | ||
@@ -30,0 +32,0 @@ Base class for all parametric filters. |
@@ -12,5 +12,7 @@ import type { commands } from "../worker/ScanbotSDK.Core"; | ||
private nextTicketId; | ||
private errorInWorker; | ||
constructor(basePath: string, options: WorkerBridgeInitOptions); | ||
private post; | ||
private createProxy; | ||
private handleUnrecoverableError; | ||
readonly copyArgs: { | ||
@@ -29,3 +31,7 @@ initialize: (licenseKey?: string, engine?: string, appId?: string, cdnPath?: string, options?: { | ||
acceptedBrightnessThreshold?: number; | ||
requiredAspectRatios?: import("./compiled/Geometry").AspectRatio[]; | ||
requiredAspectRatios?: { | ||
readonly width?: number; | ||
readonly height?: number; | ||
_marker?: () => void; | ||
}[]; | ||
rectangleOfInterest?: import("./common").Rectangle; | ||
@@ -39,10 +45,229 @@ _marker?: () => void; | ||
acceptedBrightnessThreshold?: number; | ||
requiredAspectRatios?: import("./compiled/Geometry").AspectRatio[]; | ||
requiredAspectRatios?: { | ||
readonly width?: number; | ||
readonly height?: number; | ||
_marker?: () => void; | ||
}[]; | ||
rectangleOfInterest?: import("./common").Rectangle; | ||
_marker?: () => void; | ||
}) => Promise<import("../worker/ScanbotSDK.Core").ObjectId<"DocumentDetector">>; | ||
documentDetectorDetect: (documentDetectorToken: import("../worker/ScanbotSDK.Core").ObjectId<"DocumentDetector">, image: import("../worker/ScanbotSDK.Core").Image) => Promise<import("./compiled/DocumentDetectorTypes").DetectionResult>; | ||
documentDetectorDetect: <ImageType extends import("../worker/ScanbotSDK.Core").Image>(documentDetectorToken: import("../worker/ScanbotSDK.Core").ObjectId<"DocumentDetector">, image: ImageType) => Promise<import("./compiled/DocumentDetectorTypes").DetectionResult & { | ||
originalImage: ImageType; | ||
}>; | ||
parseBarcodeDocument: (options: import("./compiled/BarcodeScannerTypes").BarcodeDocumentFormat[], data: string) => Promise<import("./compiled/GenericDocument").GenericDocument>; | ||
createBarcodeRecognizer: (options: { | ||
configurators?: import("./compiled/BarcodeConfigs").BarcodeConfig[]; | ||
configurators?: ({ | ||
readonly _type?: "CodabarConfig"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
readonly returnStartEnd?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "Code11Config"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly stripCheckDigits?: boolean; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
readonly checksum?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "Code39Config"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly stripCheckDigits?: boolean; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
readonly code32?: boolean; | ||
readonly code39?: boolean; | ||
readonly pzn?: boolean; | ||
readonly tryCode39ExtendedMode?: boolean; | ||
readonly useCode39CheckDigit?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "Code93Config"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "Code128Config"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: import("./compiled/BarcodeTypes").GS1Handling; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "Code2Of5Config"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly stripCheckDigits?: boolean; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
readonly iata2of5?: boolean; | ||
readonly code25?: boolean; | ||
readonly industrial2of5?: boolean; | ||
readonly useIATA2OF5Checksum?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "DataBarConfig"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: import("./compiled/BarcodeTypes").GS1Handling; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "DataBarExpandedConfig"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: import("./compiled/BarcodeTypes").GS1Handling; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "DataBarLimitedConfig"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: import("./compiled/BarcodeTypes").GS1Handling; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "ITFConfig"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "MSIPlesseyConfig"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly stripCheckDigits?: boolean; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
readonly checksumAlgorithms?: import("./compiled/BarcodeConfigs").MSIPlesseyChecksumAlgorithm[]; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "UpcEanConfig"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly stripCheckDigits?: boolean; | ||
readonly ean8?: boolean; | ||
readonly ean13?: boolean; | ||
readonly upca?: boolean; | ||
readonly upce?: boolean; | ||
readonly extensions?: import("./compiled/BarcodeTypes").UpcEanExtensionBehavior; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "PharmaCodeConfig"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly minimumValue?: number; | ||
readonly allowNarrowBarsOnly?: boolean; | ||
readonly allowWideBarsOnly?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "AztecConfig"; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: import("./compiled/BarcodeTypes").GS1Handling; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "QRCodeConfig"; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: import("./compiled/BarcodeTypes").GS1Handling; | ||
readonly strictMode?: boolean; | ||
readonly qr?: boolean; | ||
readonly microQr?: boolean; | ||
readonly rmqr?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "PDF417Config"; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: import("./compiled/BarcodeTypes").GS1Handling; | ||
readonly strictMode?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "MicroPDF417Config"; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: import("./compiled/BarcodeTypes").GS1Handling; | ||
readonly strictMode?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "DataMatrixConfig"; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: import("./compiled/BarcodeTypes").GS1Handling; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "MaxiCodeConfig"; | ||
readonly regexFilter?: string; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "AustraliaPostConfig"; | ||
readonly regexFilter?: string; | ||
readonly australiaPostCustomerFormat?: import("./compiled/BarcodeConfigs").AustraliaPostCustomerFormat; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "JapanPostConfig"; | ||
readonly regexFilter?: string; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "RoyalMailConfig"; | ||
readonly regexFilter?: string; | ||
readonly stripCheckDigits?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "RoyalTNTPostConfig"; | ||
readonly regexFilter?: string; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "USPSIntelligentMailConfig"; | ||
readonly regexFilter?: string; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "PharmaCodeTwoTrackConfig"; | ||
readonly regexFilter?: string; | ||
readonly minimumValue?: number; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "GS1CompositeConfig"; | ||
readonly regexFilter?: string; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly gs1Handling?: import("./compiled/BarcodeTypes").GS1Handling; | ||
readonly strictMode?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "GroupOneDConfig"; | ||
readonly regexFilter?: string; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly stripCheckDigits?: boolean; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
readonly gs1Handling?: import("./compiled/BarcodeTypes").GS1Handling; | ||
readonly strictMode?: boolean; | ||
readonly formats?: import("./compiled/BarcodeTypes").BarcodeFormat[]; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "GroupTwoDConfig"; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: import("./compiled/BarcodeTypes").GS1Handling; | ||
readonly strictMode?: boolean; | ||
readonly formats?: import("./compiled/BarcodeTypes").BarcodeFormat[]; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "GroupFourStateConfig"; | ||
readonly regexFilter?: string; | ||
readonly formats?: import("./compiled/BarcodeTypes").BarcodeFormat[]; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "GroupCommonConfig"; | ||
readonly regexFilter?: string; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly stripCheckDigits?: boolean; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
readonly gs1Handling?: import("./compiled/BarcodeTypes").GS1Handling; | ||
readonly strictMode?: boolean; | ||
readonly formats?: import("./compiled/BarcodeTypes").BarcodeFormat[]; | ||
_marker?: () => void; | ||
})[]; | ||
engineMode?: import("./compiled/BarcodeScannerTypes").EngineMode; | ||
@@ -54,3 +279,5 @@ live?: boolean; | ||
}) => Promise<import("../worker/ScanbotSDK.Core").ObjectId<"BarcodeRecognizer">>; | ||
recognizeBarcodes: (barcodeRecognizerToken: import("../worker/ScanbotSDK.Core").ObjectId<"BarcodeRecognizer">, image: import("../worker/ScanbotSDK.Core").Image) => Promise<import("./compiled/BarcodeScannerTypes").BarcodeScannerResult>; | ||
recognizeBarcodes: <ImageType_1 extends import("../worker/ScanbotSDK.Core").Image>(barcodeRecognizerToken: import("../worker/ScanbotSDK.Core").ObjectId<"BarcodeRecognizer">, image: ImageType_1) => Promise<import("./compiled/BarcodeScannerTypes").BarcodeScannerResult & { | ||
originalImage: ImageType_1; | ||
}>; | ||
beginPdf: (options: { | ||
@@ -80,3 +307,20 @@ readonly attributes?: { | ||
dpi?: number; | ||
userFields?: import("./compiled/TiffTypes").UserField[]; | ||
userFields?: { | ||
readonly tag?: number; | ||
readonly name?: string; | ||
readonly value?: { | ||
readonly _type?: "UserFieldDoubleValue"; | ||
readonly value?: number; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "UserFieldStringValue"; | ||
readonly value?: string; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "UserFieldIntValue"; | ||
readonly value?: number; | ||
_marker?: () => void; | ||
}; | ||
_marker?: () => void; | ||
}[]; | ||
binarizationFilter?: { | ||
@@ -132,3 +376,5 @@ readonly _type?: "ScanbotBinarizationFilter"; | ||
}) => Promise<import("../worker/ScanbotSDK.Core").ObjectId<"MrzRecognizerContext">>; | ||
recognizeMRZ: (mrzRecognizerToken: import("../worker/ScanbotSDK.Core").ObjectId<"MrzRecognizerContext">, image: import("../worker/ScanbotSDK.Core").Image) => Promise<import("./compiled/MRZTypes").RecognitionResult>; | ||
recognizeMRZ: <ImageType_2 extends import("../worker/ScanbotSDK.Core").Image>(mrzRecognizerToken: import("../worker/ScanbotSDK.Core").ObjectId<"MrzRecognizerContext">, image: ImageType_2) => Promise<import("./compiled/MRZTypes").RecognitionResult & { | ||
originalImage: ImageType_2; | ||
}>; | ||
releaseObject: <T>(objectToken: import("../worker/ScanbotSDK.Core").ObjectId<T>) => Promise<void>; | ||
@@ -158,6 +404,12 @@ createOcrEngine: () => Promise<import("../worker/ScanbotSDK.Core").ObjectId<"TLDROcrContext">>; | ||
}) => Promise<import("../worker/ScanbotSDK.Core").ObjectId<"GenericTextLineScanner">>; | ||
recognizeTextLine: (scannerToken: import("../worker/ScanbotSDK.Core").ObjectId<"GenericTextLineScanner">, image: import("../worker/ScanbotSDK.Core").Image) => Promise<import("./compiled/GenericTextLineScannerTypes").ScannerResult>; | ||
recognizeTextLine: <ImageType_3 extends import("../worker/ScanbotSDK.Core").Image>(scannerToken: import("../worker/ScanbotSDK.Core").ObjectId<"GenericTextLineScanner">, image: ImageType_3) => Promise<import("./compiled/GenericTextLineScannerTypes").ScannerResult & { | ||
originalImage: ImageType_3; | ||
}>; | ||
cleanTextLineRecognitionQueue: (scannerToken: import("../worker/ScanbotSDK.Core").ObjectId<"GenericTextLineScanner">) => Promise<void>; | ||
createDocumentQualityAnalyzer: (options: { | ||
readonly qualityThresholds?: import("./compiled/DocumentQualityAnalyzerTypes").QualityThreshold[]; | ||
readonly qualityThresholds?: { | ||
readonly symbolQuality?: number; | ||
readonly symbolRatio?: number; | ||
_marker?: () => void; | ||
}[]; | ||
readonly qualityIndices?: import("./compiled/DocumentQualityAnalyzerTypes").Quality[]; | ||
@@ -177,3 +429,3 @@ readonly maxImageSize?: number; | ||
imageRotate: (image: import("../worker/ScanbotSDK.Core").Image, rotations: import("./compiled/ImageProcessorTypes").ImageRotation) => Promise<import("./common").RawImage>; | ||
genericDocumentRecognizerCreate: (config: { | ||
genericDocumentRecognizerCreate: (parameters: { | ||
resultAccumulationConfig?: { | ||
@@ -186,9 +438,37 @@ minConfirmations?: number; | ||
fieldExcludeList?: string[]; | ||
acceptedDocumentTypes?: string[]; | ||
configurations?: ({ | ||
readonly _type?: "DateValidationConfig"; | ||
readonly minBirthYear?: number; | ||
readonly maxBirthYear?: number; | ||
readonly minExpirationYear?: number; | ||
readonly maxExpirationYear?: number; | ||
readonly documentTypes?: import("./compiled/GenericDocumentTypes").DocumentType[]; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "EuropeanHealthInsuranceCardConfig"; | ||
readonly minBirthYear?: number; | ||
readonly maxBirthYear?: number; | ||
readonly minExpirationYear?: number; | ||
readonly maxExpirationYear?: number; | ||
readonly expectedCountry?: import("./compiled/GenericDocumentRecognizerConfigs").EHICIssuingCountry; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "MRZFallbackConfig"; | ||
readonly acceptedCountries?: string[]; | ||
readonly acceptedMRZTypes?: import("./compiled/MRZTypes").DocumentType[]; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "GDRGroupConfig"; | ||
readonly acceptedDocumentTypes?: import("./compiled/GenericDocumentTypes").DocumentType[]; | ||
_marker?: () => void; | ||
})[]; | ||
_marker?: () => void; | ||
}) => Promise<import("../worker/ScanbotSDK.Core").ObjectId<"GenericDocumentRecognizer">>; | ||
genericDocumentRecognizerRecognize: (gdrToken: import("../worker/ScanbotSDK.Core").ObjectId<"GenericDocumentRecognizer">, image: import("../worker/ScanbotSDK.Core").Image, parameters: { | ||
genericDocumentRecognizerRecognize: <ImageType_4 extends import("../worker/ScanbotSDK.Core").Image>(gdrToken: import("../worker/ScanbotSDK.Core").ObjectId<"GenericDocumentRecognizer">, image: ImageType_4, parameters: { | ||
mode?: import("./compiled/GenericDocumentRecognizerTypes").RecognitionMode; | ||
_marker?: () => void; | ||
}) => Promise<import("./compiled/GenericDocumentRecognizerTypes").RecognitionResult>; | ||
}) => Promise<import("./compiled/GenericDocumentRecognizerTypes").RecognitionResult & { | ||
originalImage: ImageType_4; | ||
}>; | ||
version: () => Promise<string>; | ||
__hasModuleFunction: (functionName: string) => Promise<any>; | ||
@@ -210,3 +490,7 @@ __callModuleFunction: (functionName: string, args?: any[]) => Promise<any>; | ||
acceptedBrightnessThreshold?: number; | ||
requiredAspectRatios?: import("./compiled/Geometry").AspectRatio[]; | ||
requiredAspectRatios?: { | ||
readonly width?: number; | ||
readonly height?: number; | ||
_marker?: () => void; | ||
}[]; | ||
rectangleOfInterest?: import("./common").Rectangle; | ||
@@ -220,10 +504,229 @@ _marker?: () => void; | ||
acceptedBrightnessThreshold?: number; | ||
requiredAspectRatios?: import("./compiled/Geometry").AspectRatio[]; | ||
requiredAspectRatios?: { | ||
readonly width?: number; | ||
readonly height?: number; | ||
_marker?: () => void; | ||
}[]; | ||
rectangleOfInterest?: import("./common").Rectangle; | ||
_marker?: () => void; | ||
}) => Promise<import("../worker/ScanbotSDK.Core").ObjectId<"DocumentDetector">>; | ||
documentDetectorDetect: (documentDetectorToken: import("../worker/ScanbotSDK.Core").ObjectId<"DocumentDetector">, image: import("../worker/ScanbotSDK.Core").Image) => Promise<import("./compiled/DocumentDetectorTypes").DetectionResult>; | ||
documentDetectorDetect: <ImageType extends import("../worker/ScanbotSDK.Core").Image>(documentDetectorToken: import("../worker/ScanbotSDK.Core").ObjectId<"DocumentDetector">, image: ImageType) => Promise<import("./compiled/DocumentDetectorTypes").DetectionResult & { | ||
originalImage: ImageType; | ||
}>; | ||
parseBarcodeDocument: (options: import("./compiled/BarcodeScannerTypes").BarcodeDocumentFormat[], data: string) => Promise<import("./compiled/GenericDocument").GenericDocument>; | ||
createBarcodeRecognizer: (options: { | ||
configurators?: import("./compiled/BarcodeConfigs").BarcodeConfig[]; | ||
configurators?: ({ | ||
readonly _type?: "CodabarConfig"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
readonly returnStartEnd?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "Code11Config"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly stripCheckDigits?: boolean; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
readonly checksum?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "Code39Config"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly stripCheckDigits?: boolean; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
readonly code32?: boolean; | ||
readonly code39?: boolean; | ||
readonly pzn?: boolean; | ||
readonly tryCode39ExtendedMode?: boolean; | ||
readonly useCode39CheckDigit?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "Code93Config"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "Code128Config"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: import("./compiled/BarcodeTypes").GS1Handling; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "Code2Of5Config"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly stripCheckDigits?: boolean; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
readonly iata2of5?: boolean; | ||
readonly code25?: boolean; | ||
readonly industrial2of5?: boolean; | ||
readonly useIATA2OF5Checksum?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "DataBarConfig"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: import("./compiled/BarcodeTypes").GS1Handling; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "DataBarExpandedConfig"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: import("./compiled/BarcodeTypes").GS1Handling; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "DataBarLimitedConfig"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: import("./compiled/BarcodeTypes").GS1Handling; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "ITFConfig"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "MSIPlesseyConfig"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly stripCheckDigits?: boolean; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
readonly checksumAlgorithms?: import("./compiled/BarcodeConfigs").MSIPlesseyChecksumAlgorithm[]; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "UpcEanConfig"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly stripCheckDigits?: boolean; | ||
readonly ean8?: boolean; | ||
readonly ean13?: boolean; | ||
readonly upca?: boolean; | ||
readonly upce?: boolean; | ||
readonly extensions?: import("./compiled/BarcodeTypes").UpcEanExtensionBehavior; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "PharmaCodeConfig"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly minimumValue?: number; | ||
readonly allowNarrowBarsOnly?: boolean; | ||
readonly allowWideBarsOnly?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "AztecConfig"; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: import("./compiled/BarcodeTypes").GS1Handling; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "QRCodeConfig"; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: import("./compiled/BarcodeTypes").GS1Handling; | ||
readonly strictMode?: boolean; | ||
readonly qr?: boolean; | ||
readonly microQr?: boolean; | ||
readonly rmqr?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "PDF417Config"; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: import("./compiled/BarcodeTypes").GS1Handling; | ||
readonly strictMode?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "MicroPDF417Config"; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: import("./compiled/BarcodeTypes").GS1Handling; | ||
readonly strictMode?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "DataMatrixConfig"; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: import("./compiled/BarcodeTypes").GS1Handling; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "MaxiCodeConfig"; | ||
readonly regexFilter?: string; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "AustraliaPostConfig"; | ||
readonly regexFilter?: string; | ||
readonly australiaPostCustomerFormat?: import("./compiled/BarcodeConfigs").AustraliaPostCustomerFormat; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "JapanPostConfig"; | ||
readonly regexFilter?: string; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "RoyalMailConfig"; | ||
readonly regexFilter?: string; | ||
readonly stripCheckDigits?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "RoyalTNTPostConfig"; | ||
readonly regexFilter?: string; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "USPSIntelligentMailConfig"; | ||
readonly regexFilter?: string; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "PharmaCodeTwoTrackConfig"; | ||
readonly regexFilter?: string; | ||
readonly minimumValue?: number; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "GS1CompositeConfig"; | ||
readonly regexFilter?: string; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly gs1Handling?: import("./compiled/BarcodeTypes").GS1Handling; | ||
readonly strictMode?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "GroupOneDConfig"; | ||
readonly regexFilter?: string; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly stripCheckDigits?: boolean; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
readonly gs1Handling?: import("./compiled/BarcodeTypes").GS1Handling; | ||
readonly strictMode?: boolean; | ||
readonly formats?: import("./compiled/BarcodeTypes").BarcodeFormat[]; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "GroupTwoDConfig"; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: import("./compiled/BarcodeTypes").GS1Handling; | ||
readonly strictMode?: boolean; | ||
readonly formats?: import("./compiled/BarcodeTypes").BarcodeFormat[]; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "GroupFourStateConfig"; | ||
readonly regexFilter?: string; | ||
readonly formats?: import("./compiled/BarcodeTypes").BarcodeFormat[]; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "GroupCommonConfig"; | ||
readonly regexFilter?: string; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly stripCheckDigits?: boolean; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
readonly gs1Handling?: import("./compiled/BarcodeTypes").GS1Handling; | ||
readonly strictMode?: boolean; | ||
readonly formats?: import("./compiled/BarcodeTypes").BarcodeFormat[]; | ||
_marker?: () => void; | ||
})[]; | ||
engineMode?: import("./compiled/BarcodeScannerTypes").EngineMode; | ||
@@ -235,3 +738,5 @@ live?: boolean; | ||
}) => Promise<import("../worker/ScanbotSDK.Core").ObjectId<"BarcodeRecognizer">>; | ||
recognizeBarcodes: (barcodeRecognizerToken: import("../worker/ScanbotSDK.Core").ObjectId<"BarcodeRecognizer">, image: import("../worker/ScanbotSDK.Core").Image) => Promise<import("./compiled/BarcodeScannerTypes").BarcodeScannerResult>; | ||
recognizeBarcodes: <ImageType_1 extends import("../worker/ScanbotSDK.Core").Image>(barcodeRecognizerToken: import("../worker/ScanbotSDK.Core").ObjectId<"BarcodeRecognizer">, image: ImageType_1) => Promise<import("./compiled/BarcodeScannerTypes").BarcodeScannerResult & { | ||
originalImage: ImageType_1; | ||
}>; | ||
beginPdf: (options: { | ||
@@ -261,3 +766,20 @@ readonly attributes?: { | ||
dpi?: number; | ||
userFields?: import("./compiled/TiffTypes").UserField[]; | ||
userFields?: { | ||
readonly tag?: number; | ||
readonly name?: string; | ||
readonly value?: { | ||
readonly _type?: "UserFieldDoubleValue"; | ||
readonly value?: number; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "UserFieldStringValue"; | ||
readonly value?: string; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "UserFieldIntValue"; | ||
readonly value?: number; | ||
_marker?: () => void; | ||
}; | ||
_marker?: () => void; | ||
}[]; | ||
binarizationFilter?: { | ||
@@ -313,3 +835,5 @@ readonly _type?: "ScanbotBinarizationFilter"; | ||
}) => Promise<import("../worker/ScanbotSDK.Core").ObjectId<"MrzRecognizerContext">>; | ||
recognizeMRZ: (mrzRecognizerToken: import("../worker/ScanbotSDK.Core").ObjectId<"MrzRecognizerContext">, image: import("../worker/ScanbotSDK.Core").Image) => Promise<import("./compiled/MRZTypes").RecognitionResult>; | ||
recognizeMRZ: <ImageType_2 extends import("../worker/ScanbotSDK.Core").Image>(mrzRecognizerToken: import("../worker/ScanbotSDK.Core").ObjectId<"MrzRecognizerContext">, image: ImageType_2) => Promise<import("./compiled/MRZTypes").RecognitionResult & { | ||
originalImage: ImageType_2; | ||
}>; | ||
releaseObject: <T>(objectToken: import("../worker/ScanbotSDK.Core").ObjectId<T>) => Promise<void>; | ||
@@ -339,6 +863,12 @@ createOcrEngine: () => Promise<import("../worker/ScanbotSDK.Core").ObjectId<"TLDROcrContext">>; | ||
}) => Promise<import("../worker/ScanbotSDK.Core").ObjectId<"GenericTextLineScanner">>; | ||
recognizeTextLine: (scannerToken: import("../worker/ScanbotSDK.Core").ObjectId<"GenericTextLineScanner">, image: import("../worker/ScanbotSDK.Core").Image) => Promise<import("./compiled/GenericTextLineScannerTypes").ScannerResult>; | ||
recognizeTextLine: <ImageType_3 extends import("../worker/ScanbotSDK.Core").Image>(scannerToken: import("../worker/ScanbotSDK.Core").ObjectId<"GenericTextLineScanner">, image: ImageType_3) => Promise<import("./compiled/GenericTextLineScannerTypes").ScannerResult & { | ||
originalImage: ImageType_3; | ||
}>; | ||
cleanTextLineRecognitionQueue: (scannerToken: import("../worker/ScanbotSDK.Core").ObjectId<"GenericTextLineScanner">) => Promise<void>; | ||
createDocumentQualityAnalyzer: (options: { | ||
readonly qualityThresholds?: import("./compiled/DocumentQualityAnalyzerTypes").QualityThreshold[]; | ||
readonly qualityThresholds?: { | ||
readonly symbolQuality?: number; | ||
readonly symbolRatio?: number; | ||
_marker?: () => void; | ||
}[]; | ||
readonly qualityIndices?: import("./compiled/DocumentQualityAnalyzerTypes").Quality[]; | ||
@@ -358,3 +888,3 @@ readonly maxImageSize?: number; | ||
imageRotate: (image: import("../worker/ScanbotSDK.Core").Image, rotations: import("./compiled/ImageProcessorTypes").ImageRotation) => Promise<import("./common").RawImage>; | ||
genericDocumentRecognizerCreate: (config: { | ||
genericDocumentRecognizerCreate: (parameters: { | ||
resultAccumulationConfig?: { | ||
@@ -367,9 +897,37 @@ minConfirmations?: number; | ||
fieldExcludeList?: string[]; | ||
acceptedDocumentTypes?: string[]; | ||
configurations?: ({ | ||
readonly _type?: "DateValidationConfig"; | ||
readonly minBirthYear?: number; | ||
readonly maxBirthYear?: number; | ||
readonly minExpirationYear?: number; | ||
readonly maxExpirationYear?: number; | ||
readonly documentTypes?: import("./compiled/GenericDocumentTypes").DocumentType[]; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "EuropeanHealthInsuranceCardConfig"; | ||
readonly minBirthYear?: number; | ||
readonly maxBirthYear?: number; | ||
readonly minExpirationYear?: number; | ||
readonly maxExpirationYear?: number; | ||
readonly expectedCountry?: import("./compiled/GenericDocumentRecognizerConfigs").EHICIssuingCountry; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "MRZFallbackConfig"; | ||
readonly acceptedCountries?: string[]; | ||
readonly acceptedMRZTypes?: import("./compiled/MRZTypes").DocumentType[]; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "GDRGroupConfig"; | ||
readonly acceptedDocumentTypes?: import("./compiled/GenericDocumentTypes").DocumentType[]; | ||
_marker?: () => void; | ||
})[]; | ||
_marker?: () => void; | ||
}) => Promise<import("../worker/ScanbotSDK.Core").ObjectId<"GenericDocumentRecognizer">>; | ||
genericDocumentRecognizerRecognize: (gdrToken: import("../worker/ScanbotSDK.Core").ObjectId<"GenericDocumentRecognizer">, image: import("../worker/ScanbotSDK.Core").Image, parameters: { | ||
genericDocumentRecognizerRecognize: <ImageType_4 extends import("../worker/ScanbotSDK.Core").Image>(gdrToken: import("../worker/ScanbotSDK.Core").ObjectId<"GenericDocumentRecognizer">, image: ImageType_4, parameters: { | ||
mode?: import("./compiled/GenericDocumentRecognizerTypes").RecognitionMode; | ||
_marker?: () => void; | ||
}) => Promise<import("./compiled/GenericDocumentRecognizerTypes").RecognitionResult>; | ||
}) => Promise<import("./compiled/GenericDocumentRecognizerTypes").RecognitionResult & { | ||
originalImage: ImageType_4; | ||
}>; | ||
version: () => Promise<string>; | ||
__hasModuleFunction: (functionName: string) => Promise<any>; | ||
@@ -376,0 +934,0 @@ __callModuleFunction: (functionName: string, args?: any[]) => Promise<any>; |
@@ -10,3 +10,3 @@ import { PdfConfig } from "../bridge/compiled/PdfConfig"; | ||
import { type BarcodeDocumentFormat, BarcodeRecognizerParameters, type BarcodeScannerResult } from "../bridge/compiled/BarcodeScannerTypes"; | ||
import { GenericDocumentRecognizerConfig, RecognitionParameters as GdrRecognitionParameters, type RecognitionResult as GdrRecognitionResult } from "../bridge/compiled/GenericDocumentRecognizerTypes"; | ||
import { GenericDocumentRecognizerParameters, RecognitionParameters as GdrRecognitionParameters, type RecognitionResult as GdrRecognitionResult } from "../bridge/compiled/GenericDocumentRecognizerTypes"; | ||
import { type Binarize, TIFFWriterParameters } from "../bridge/compiled/TiffTypes"; | ||
@@ -43,6 +43,10 @@ import type { RawImage, Point, DeepPartial } from "../bridge/common"; | ||
createDocumentDetector: (options: DeepPartial<DetectionParameters>) => Promise<ObjectId<"DocumentDetector">>; | ||
documentDetectorDetect: (documentDetectorToken: ObjectId<"DocumentDetector">, image: Image) => Promise<DetectionResult>; | ||
documentDetectorDetect: <ImageType extends Image>(documentDetectorToken: ObjectId<"DocumentDetector">, image: ImageType) => Promise<DetectionResult & { | ||
originalImage: ImageType; | ||
}>; | ||
parseBarcodeDocument: (options: BarcodeDocumentFormat[], data: string) => Promise<GenericDocument | null>; | ||
createBarcodeRecognizer: (options: DeepPartial<BarcodeRecognizerParameters>) => Promise<ObjectId<"BarcodeRecognizer">>; | ||
recognizeBarcodes: (barcodeRecognizerToken: ObjectId<"BarcodeRecognizer">, image: Image) => Promise<BarcodeScannerResult>; | ||
recognizeBarcodes: <ImageType_1 extends Image>(barcodeRecognizerToken: ObjectId<"BarcodeRecognizer">, image: ImageType_1) => Promise<BarcodeScannerResult & { | ||
originalImage: ImageType_1; | ||
}>; | ||
beginPdf: (options: DeepPartial<PdfConfig>) => Promise<ObjectId<"PdfGenerationContext">>; | ||
@@ -55,3 +59,5 @@ addPageToPdf: (pdfOperation: ObjectId<"PdfGenerationContext">, image: Image) => Promise<void>; | ||
createMRZRecognizer: (configuration: DeepPartial<MrzRecognizerConfig>) => Promise<ObjectId<"MrzRecognizerContext">>; | ||
recognizeMRZ: (mrzRecognizerToken: ObjectId<"MrzRecognizerContext">, image: Image) => Promise<MrzRecognitionResult>; | ||
recognizeMRZ: <ImageType_2 extends Image>(mrzRecognizerToken: ObjectId<"MrzRecognizerContext">, image: ImageType_2) => Promise<MrzRecognitionResult & { | ||
originalImage: ImageType_2; | ||
}>; | ||
releaseObject: <T>(objectToken: ObjectId<T>) => Promise<void>; | ||
@@ -61,3 +67,5 @@ createOcrEngine: () => Promise<ObjectId<"TLDROcrContext">>; | ||
createGenericTextLineScanner: (configuration: DeepPartial<GtsConfig>) => Promise<ObjectId<"GenericTextLineScanner">>; | ||
recognizeTextLine: (scannerToken: ObjectId<"GenericTextLineScanner">, image: Image) => Promise<GtsResult>; | ||
recognizeTextLine: <ImageType_3 extends Image>(scannerToken: ObjectId<"GenericTextLineScanner">, image: ImageType_3) => Promise<GtsResult & { | ||
originalImage: ImageType_3; | ||
}>; | ||
cleanTextLineRecognitionQueue: (scannerToken: ObjectId<"GenericTextLineScanner">) => Promise<void>; | ||
@@ -70,4 +78,7 @@ createDocumentQualityAnalyzer: (options: DeepPartial<DqaConfig>) => Promise<ObjectId<"DocumentQualityAnalyzer">>; | ||
imageRotate: (image: Image, rotations: ImageRotation) => Promise<RawImage>; | ||
genericDocumentRecognizerCreate: (config: DeepPartial<GenericDocumentRecognizerConfig>) => Promise<ObjectId<"GenericDocumentRecognizer">>; | ||
genericDocumentRecognizerRecognize: (gdrToken: ObjectId<"GenericDocumentRecognizer">, image: Image, parameters: DeepPartial<GdrRecognitionParameters>) => Promise<GdrRecognitionResult>; | ||
genericDocumentRecognizerCreate: (parameters: DeepPartial<GenericDocumentRecognizerParameters>) => Promise<ObjectId<"GenericDocumentRecognizer">>; | ||
genericDocumentRecognizerRecognize: <ImageType_4 extends Image>(gdrToken: ObjectId<"GenericDocumentRecognizer">, image: ImageType_4, parameters: DeepPartial<GdrRecognitionParameters>) => Promise<GdrRecognitionResult & { | ||
originalImage: ImageType_4; | ||
}>; | ||
version: () => Promise<string>; | ||
__hasModuleFunction: (functionName: string) => Promise<any>; | ||
@@ -74,0 +85,0 @@ __callModuleFunction: (functionName: string, args?: any[]) => Promise<any>; |
@@ -44,3 +44,5 @@ import React from "react"; | ||
getStatusString(detectionResult: DocumentDetectorTypes.DetectionResult): DocumentDetectorTypes.DetectionStatus; | ||
detectInWebWorker(): Promise<DocumentDetectorTypes.DetectionResult>; | ||
detectInWebWorker(): Promise<DocumentDetectorTypes.DetectionResult & { | ||
originalImage: ImageData; | ||
}>; | ||
preventAutoCapture?: boolean; | ||
@@ -47,0 +49,0 @@ handleAutoCapture(statusOk: boolean, polygon?: Polygon): Promise<void>; |
@@ -31,3 +31,2 @@ export { IDocumentScannerHandle } from "./interfaces/i-document-scanner-handle"; | ||
export { OcrData, default as OcrEngine, Rect } from "./service/ocr-engine"; | ||
export { Point } from "./utils/dto/Point"; | ||
export { MagneticLine } from "./utils/dto/MagneticLine"; | ||
@@ -37,3 +36,3 @@ | ||
export { default as PublicUtils } from "./service/public-utils"; | ||
export { PublicUtils } from "./service/public-utils"; | ||
export { Size } from "./utils/dto/Size"; | ||
@@ -44,5 +43,7 @@ export { VideoSize } from "./utils/dto/VideoSize"; | ||
export { BinarizationFilter, ColorFilter } from "./model/filter-types"; | ||
export { Polygon } from "./utils/dto/Polygon"; | ||
//TODO We currently have two implementations of Point in: utils/dto/Point & core-types. Should this be refactored? | ||
export { Point as Point2 } from "./utils/dto/Point"; | ||
export { InitializationOptions } from "./model/configuration/initialization-options"; | ||
@@ -54,4 +55,38 @@ export { LicenseInfo } from "./model/response/license-info"; | ||
export { BrowserCameras, CameraDetectionStrategy, DiscoverCameraMode } from './utils/browser-cameras'; | ||
export { default as ScanbotSDKUI2 } from "./ui2/scanbot-sdk-ui"; | ||
export * as UIConfig from "./ui2/configuration"; | ||
export * as Config from "./core-types"; | ||
export { | ||
BarcodeConfigs, | ||
BarcodeScannerTypes, | ||
BarcodeTypes, | ||
CheckRecognizerTypes, | ||
CommonFieldType, | ||
DocumentDetectorTypes, | ||
DocumentQualityAnalyzerTypes, | ||
EhicTypes, | ||
GenericDocument, | ||
GenericDocumentRecognizerConfigs, | ||
GenericDocumentRecognizerTypes, | ||
GenericDocumentTypes, | ||
GenericTextLineScannerTypes, | ||
Geometry, | ||
ImageProcessorTypes, | ||
LicensePlateScannerTypes, | ||
MedicalCertificateTypes, | ||
MRZTypes, | ||
OcrElements, | ||
ParametricFilters, | ||
PdfConfig, | ||
TiffTypes, | ||
FrameUtilities, | ||
ObjectId, Image, CroppedDetectionResult, | ||
PartiallyConstructible, RawImage, DeepPartial, Point, Rectangle | ||
} from "./core-types"; | ||
// We also need to export the Config-namespace as a whole, because it is directly used in | ||
// ScanbotSDK.ts and without it, the API docs would be incomplete. | ||
// In the API docs, Config and the types that are directly exported from ./core-types above are | ||
// automatically reconciled. | ||
export * as Config from "./core-types"; |
import { Size } from "../../utils/dto/Size"; | ||
import type { BarcodeScannerTypes } from "../../core-types"; | ||
export declare class BarcodeScannerResultWithSize { | ||
coreResult: { | ||
barcodes: BarcodeScannerTypes.BarcodeItem[]; | ||
originalImage?: ImageData; | ||
}; | ||
barcodes: BarcodeScannerTypes.BarcodeItem[]; | ||
originalImageSize: Size; | ||
constructor(barcodes: BarcodeScannerTypes.BarcodeItem[], originalImageSize: Size); | ||
originalImageSize: Size | null; | ||
/** | ||
* @internal | ||
*/ | ||
constructor(coreResult: { | ||
barcodes: BarcodeScannerTypes.BarcodeItem[]; | ||
originalImage?: ImageData; | ||
}); | ||
isEmpty(): boolean; | ||
} |
@@ -1,3 +0,4 @@ | ||
import type { BarcodeScannerTypes } from "../../core-types"; | ||
import { BarcodeScannerTypes } from "../../core-types"; | ||
export declare function barcodesEqual(barcodeItem1: BarcodeScannerTypes.BarcodeItem, barcodeItem2: BarcodeScannerTypes.BarcodeItem): boolean; | ||
export declare function barcodeId(barcode: BarcodeScannerTypes.BarcodeItem): string; | ||
export declare function barcodeItemFromText(text: string): BarcodeScannerTypes.BarcodeItem; |
@@ -5,4 +5,5 @@ export type CameraFacingMode = 'front' | 'back' | 'unknown'; | ||
label: string; | ||
facingMode?: CameraFacingMode; | ||
supportsTorchControl?: boolean; | ||
maxNumPixels: number | undefined; | ||
supportsTorchControl: boolean | undefined; | ||
facingMode: CameraFacingMode; | ||
} |
@@ -5,3 +5,2 @@ import { SelectionOverlayConfiguration } from "./selection-overlay-configuration"; | ||
import { BarcodeScannerTypes, type DeepPartial } from "../../core-types"; | ||
import type { Size } from "../../utils/dto/Size"; | ||
import type { BarcodeScannerResultWithSize } from "../barcode/barcode-result"; | ||
@@ -32,5 +31,9 @@ export declare class BarcodeScannerConfiguration extends ViewFinderScannerConfiguration { | ||
onBarcodesDetected?: (e: BarcodeScannerResultWithSize) => void; | ||
/** @internal */ | ||
_onDetectionFailed?: (originalImageSize: Size) => void; | ||
/** | ||
* Note that the ImageData is only available at the point in time when _onDetectionFailed is invoked. | ||
* The underlying buffer will be reused in the next detection cycle and will not be available anymore. | ||
* @internal | ||
* */ | ||
_onDetectionFailed?: (originalImageSize: ImageData) => void; | ||
/** | ||
* If set, limit the resolution of the image that is used for barcode recognition. | ||
@@ -37,0 +40,0 @@ * A lower value will result in faster processing times but may reduce recognition quality. |
@@ -46,2 +46,7 @@ import { Polygon } from "../../utils/dto/Polygon"; | ||
disableScroll?: boolean; | ||
/** | ||
* The polygon that defines the initial cropping area. | ||
* All points should have relative coordinates between 0 and 1. | ||
* If this is not set, the cropping area is initialized with an automatically detected outline of the document. | ||
*/ | ||
polygon?: Polygon; | ||
@@ -48,0 +53,0 @@ image: Image; |
import { ScannerConfiguration } from "./scanner-configuration"; | ||
import { DocumentDetectorTypes, DeepPartial } from "../../core-types"; | ||
import { DocumentDetectorTypes, DeepPartial, CroppedDetectionResult } from "../../core-types"; | ||
export declare class TextConfiguration { | ||
@@ -95,11 +95,5 @@ constructor(hint?: HintTextConfiguration); | ||
* stopped only when detection is stopped or camera widget is disposed. | ||
* Result contains the following properties: | ||
* detectionStatus: "OK", | ||
* success: true, | ||
* cropped: "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD...", | ||
* original: "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD...", | ||
* polygon: Array(4)} | ||
*/ | ||
onDocumentDetected?: (e: any) => void; | ||
onDocumentDetected?: (result: CroppedDetectionResult) => void; | ||
static fromJson(json: any): DocumentScannerConfiguration; | ||
} |
@@ -5,3 +5,3 @@ import type { DeepPartial, GenericDocumentRecognizerTypes } from "../../core-types"; | ||
constructor(); | ||
detectorParameters?: DeepPartial<GenericDocumentRecognizerTypes.GenericDocumentRecognizerConfig>; | ||
detectorParameters?: DeepPartial<GenericDocumentRecognizerTypes.GenericDocumentRecognizerParameters>; | ||
/** Callback is called for every analyzed frame. */ | ||
@@ -8,0 +8,0 @@ onDocumentDetected?: (result: GenericDocumentRecognizerTypes.RecognitionResult) => void; |
@@ -0,1 +1,2 @@ | ||
import { CameraDetectionStrategy } from "../../utils/browser-cameras"; | ||
export interface InitializationOptions { | ||
@@ -32,2 +33,9 @@ /** | ||
requestSuffix?: string; | ||
/** | ||
* On devices with multiple cameras, it is difficult to choose which camera to use for scanning. | ||
* You can choose from several different automatic detection strategies described by | ||
* {@link CameraDetectionStrategy}. | ||
* Defaults to `FAST_DEFERRED`. | ||
*/ | ||
bestCameraDetectionStrategy?: CameraDetectionStrategy; | ||
} |
@@ -13,3 +13,3 @@ import { DeepPartial, MRZTypes } from "../../core-types"; | ||
/** {@displayType `DeepPartial<MRZTypes.RecognizerConfiguration>`} {@link Config.MRZTypes.RecognizerConfiguration}*/ | ||
recognizerConfiguration: DeepPartial<MRZTypes.RecognizerConfiguration>; | ||
recognizerConfiguration?: DeepPartial<MRZTypes.RecognizerConfiguration>; | ||
onMrzDetected?: (e: MRZTypes.RecognitionResult) => void; | ||
@@ -16,0 +16,0 @@ _onDetectionFailed?: (e: ImageData) => void; |
@@ -19,2 +19,6 @@ import { BaseConfiguration } from "./base-configuration"; | ||
mirrored?: boolean; | ||
/** | ||
* Camera id or camera label. | ||
* A list of available cameras can be obtained from {@link ScanbotSDK.cameras}. | ||
**/ | ||
preferredCamera?: string; | ||
@@ -31,4 +35,7 @@ spinnerColor?: string; | ||
* Error callback of the SDK. | ||
* If any error was reported, your scanner might not be scanning anymore, e.g. due to an out-of-memory error. | ||
* You should dispose the scanner and use {@link ScanbotSDK.destroy} and {@link ScanbotSDK.initialize} to | ||
* re-initialize the SDK. | ||
*/ | ||
onError?: (e: any) => void; | ||
} |
import type { BarcodeScannerTypes } from "../../core-types"; | ||
export type SelectionOverlayTextFormat = "Text" | "TextAndFormat" | "None"; | ||
export declare class BarcodePolygonStyle { | ||
fill?: string; | ||
stroke?: string; | ||
fillColor?: string; | ||
strokeColor?: string; | ||
strokeWidth?: number; | ||
@@ -7,0 +7,0 @@ cornerRadius?: number; |
import { ScannerConfiguration } from "./scanner-configuration"; | ||
import { ViewFinderConfiguration, UserGuidanceConfiguration } from "../../ui2/configuration"; | ||
import { DeepPartial } from "../../ui2/configuration/utils"; | ||
import { DeepPartial } from "../../ui2/common"; | ||
export declare class ViewFinderScannerConfiguration extends ScannerConfiguration { | ||
@@ -5,0 +5,0 @@ constructor(resolution: { |
@@ -27,2 +27,3 @@ export declare class MediaError extends Error { | ||
static hasCheckedPermission(): boolean; | ||
static createFromDOMException(err: DOMException | unknown): MediaError; | ||
} |
@@ -14,3 +14,2 @@ import { WorkerBridge } from "./worker/worker-bridge"; | ||
import { Polygon } from "./utils/dto/Polygon"; | ||
import { BarcodeScannerResultWithSize } from "./model/barcode/barcode-result"; | ||
import { MrzScannerConfiguration } from "./model/configuration/mrz-scanner-configuration"; | ||
@@ -25,3 +24,3 @@ import { IMrzScannerHandle } from "./interfaces/i-mrz-scanner-handle"; | ||
import ScanbotSDKUI from "./ui2/scanbot-sdk-ui"; | ||
import { Image, DeepPartial, RawImage, ObjectId } from "./core-types"; | ||
import { Image, DeepPartial, RawImage, ObjectId, Point, GenericTextLineScannerTypes, GenericDocumentRecognizerTypes, TiffTypes, PdfConfig, ParametricFilters, ImageProcessorTypes, DocumentQualityAnalyzerTypes, MRZTypes, BarcodeScannerTypes, CroppedDetectionResult, DocumentDetectorTypes } from "./core-types"; | ||
import * as Config from "./core-types"; | ||
@@ -31,2 +30,4 @@ import GenericDocumentRecognizer from "./service/generic-document-recognizer"; | ||
import { ConsumeType } from "./consume-type"; | ||
import { Stats } from "./utils/stats"; | ||
import { BrowserCameras } from "./utils/browser-cameras"; | ||
export default class ScanbotSDK { | ||
@@ -56,14 +57,19 @@ /** @internal */ | ||
toDataUrl(imageBuffer: ArrayBuffer): Promise<string>; | ||
/** @param detectionParameters {@displayType `DeepPartial<Config.DocumentDetectorTypes.DetectionParameters>`} {@link Config.DocumentDetectorTypes.DetectionParameters}*/ | ||
detectDocument(imageBuffer: Image, detectionParameters?: DeepPartial<Config.DocumentDetectorTypes.DetectionParameters>, consumeImage?: ConsumeType): Promise<Config.DocumentDetectorTypes.DetectionResult>; | ||
detectAndCropDocument(imageBuffer: Image, consumeImage?: ConsumeType): Promise<Config.CroppedDetectionResult>; | ||
/** @param detectionParameters {@displayType `Omit<DeepPartial<Config.BarcodeScannerTypes.BarcodeRecognizerParameters>, "live">`} {@link Config.BarcodeScannerTypes.BarcodeRecognizerParameters}*/ | ||
detectBarcodes(base64: string, detectionParameters: Omit<DeepPartial<Config.BarcodeScannerTypes.BarcodeRecognizerParameters>, "live">): Promise<BarcodeScannerResultWithSize>; | ||
parseBarcodeDocument(acceptedDocumentFormats: Config.BarcodeScannerTypes.BarcodeDocumentFormat[], rawBarcodeData: string): Promise<Config.GenericDocument.GenericDocument>; | ||
/** @param detectionParameters {@displayType `DeepPartial<DocumentDetectorTypes.DetectionParameters>`} {@link DocumentDetectorTypes.DetectionParameters}*/ | ||
detectDocument(imageBuffer: Image, detectionParameters?: DeepPartial<DocumentDetectorTypes.DetectionParameters>, consumeImage?: ConsumeType): Promise<DocumentDetectorTypes.DetectionResult>; | ||
detectAndCropDocument(imageBuffer: Image, consumeImage?: ConsumeType): Promise<CroppedDetectionResult>; | ||
/** | ||
* @param image An image URL (e.g. Data URL or HTTP URL) or an Image object | ||
* @param detectionParameters {@displayType `Omit<DeepPartial<BarcodeScannerTypes.BarcodeRecognizerParameters>, "live">`} {@link BarcodeScannerTypes.BarcodeRecognizerParameters} | ||
* */ | ||
detectBarcodes(image: string | Image, partialDetectionParameters?: DeepPartial<Omit<BarcodeScannerTypes.BarcodeRecognizerParameters, "live">>, consumeImage?: ConsumeType): Promise<BarcodeScannerTypes.BarcodeScannerResult & { | ||
originalImage: Image; | ||
}>; | ||
parseBarcodeDocument(acceptedDocumentFormats: BarcodeScannerTypes.BarcodeDocumentFormat[], rawBarcodeData: string): Promise<Config.GenericDocument.GenericDocument>; | ||
createSimpleMRZRecognizer(): Promise<SimpleMrzRecognizer>; | ||
createOcrEngine(): Promise<OcrEngine>; | ||
/** @param config {@displayType `DeepPartial<Config.DocumentQualityAnalyzerTypes.Config>`} {@link Config.DocumentQualityAnalyzerTypes.Config}*/ | ||
createDocumentQualityAnalyzer(config?: DeepPartial<Config.DocumentQualityAnalyzerTypes.Config>): Promise<DocumentQualityAnalyzer>; | ||
imageRotate(image: Image, rotation: Config.ImageProcessorTypes.ImageRotation, consumeImage?: ConsumeType): Promise<RawImage>; | ||
imageFilter(image: Image, filter: Config.ParametricFilters.ParametricFilter, consumeImage?: ConsumeType): Promise<RawImage>; | ||
/** @param config {@displayType `DeepPartial<DocumentQualityAnalyzerTypes.Config>`} {@link DocumentQualityAnalyzerTypes.Config}*/ | ||
createDocumentQualityAnalyzer(config?: DeepPartial<DocumentQualityAnalyzerTypes.Config>): Promise<DocumentQualityAnalyzer>; | ||
imageRotate(image: Image, rotation: ImageProcessorTypes.ImageRotation, consumeImage?: ConsumeType): Promise<RawImage>; | ||
imageFilter(image: Image, filter: ParametricFilters.ParametricFilter, consumeImage?: ConsumeType): Promise<RawImage>; | ||
/** Crops and stretches the image to the convex hull of the supplied points. All points should have relative coordinates between 0 and 1. */ | ||
@@ -76,8 +82,8 @@ imageCrop(image: Image, polygon: Polygon, consumeImage?: ConsumeType): Promise<RawImage>; | ||
getLicenseInfo(): Promise<LicenseInfo>; | ||
/** @param options {@displayType `DeepPartial<Config.PdfConfig.PdfConfig>`} {@link Config.PdfConfig.PdfConfig}*/ | ||
beginPdf(options: DeepPartial<Config.PdfConfig.PdfConfig>): Promise<PdfGenerator>; | ||
/** @param options {@displayType `DeepPartial<Config.TiffTypes.TIFFWriterParameters>`} {@link Config.TiffTypes.TIFFWriterParameters} */ | ||
beginTiff(options?: DeepPartial<Config.TiffTypes.TIFFWriterParameters>): Promise<TiffGenerator>; | ||
/** @param options {@displayType `DeepPartial<Config.GenericDocumentRecognizerTypes.GenericDocumentRecognizerConfig>`} {@link Config.GenericDocumentRecognizerTypes.GenericDocumentRecognizerConfig}*/ | ||
createGenericDocumentRecognizer(options: DeepPartial<Config.GenericDocumentRecognizerTypes.GenericDocumentRecognizerConfig>): Promise<GenericDocumentRecognizer>; | ||
/** @param options {@displayType `DeepPartial<PdfConfig.PdfConfig>`} {@link PdfConfig.PdfConfig}*/ | ||
beginPdf(options: DeepPartial<PdfConfig.PdfConfig>): Promise<PdfGenerator>; | ||
/** @param options {@displayType `DeepPartial<TiffTypes.TIFFWriterParameters>`} {@link TiffTypes.TIFFWriterParameters} */ | ||
beginTiff(options?: DeepPartial<TiffTypes.TIFFWriterParameters>): Promise<TiffGenerator>; | ||
/** @param options {@displayType `DeepPartial<GenericDocumentRecognizerTypes.GenericDocumentRecognizerParameters>`} {@link GenericDocumentRecognizerTypes.GenericDocumentRecognizerParameters}*/ | ||
createGenericDocumentRecognizer(options: DeepPartial<GenericDocumentRecognizerTypes.GenericDocumentRecognizerParameters>): Promise<GenericDocumentRecognizer>; | ||
imageToJpeg(image: Image, consumeImage?: ConsumeType): Promise<Uint8Array>; | ||
@@ -102,7 +108,11 @@ get version(): string; | ||
acceptedBrightnessThreshold?: number; | ||
requiredAspectRatios?: Config.Geometry.AspectRatio[]; | ||
requiredAspectRatios?: { | ||
readonly width?: number; | ||
readonly height?: number; | ||
_marker?: () => void; | ||
}[]; | ||
rectangleOfInterest?: Config.Rectangle; | ||
_marker?: () => void; | ||
}) => Promise<Config.DocumentDetectorTypes.DetectionResult>; | ||
detectAndCropDocument: (image: Image) => Promise<Config.CroppedDetectionResult>; | ||
}) => Promise<DocumentDetectorTypes.DetectionResult>; | ||
detectAndCropDocument: (image: Image) => Promise<CroppedDetectionResult>; | ||
createDocumentDetector: (options: { | ||
@@ -112,17 +122,238 @@ acceptedAngleScore?: number; | ||
acceptedBrightnessThreshold?: number; | ||
requiredAspectRatios?: Config.Geometry.AspectRatio[]; | ||
requiredAspectRatios?: { | ||
readonly width?: number; | ||
readonly height?: number; | ||
_marker?: () => void; | ||
}[]; | ||
rectangleOfInterest?: Config.Rectangle; | ||
_marker?: () => void; | ||
}) => Promise<ObjectId<"DocumentDetector">>; | ||
documentDetectorDetect: (documentDetectorToken: ObjectId<"DocumentDetector">, image: Image) => Promise<Config.DocumentDetectorTypes.DetectionResult>; | ||
parseBarcodeDocument: (options: Config.BarcodeScannerTypes.BarcodeDocumentFormat[], data: string) => Promise<Config.GenericDocument.GenericDocument>; | ||
documentDetectorDetect: <ImageType extends Image>(documentDetectorToken: ObjectId<"DocumentDetector">, image: ImageType) => Promise<DocumentDetectorTypes.DetectionResult & { | ||
originalImage: ImageType; | ||
}>; | ||
parseBarcodeDocument: (options: BarcodeScannerTypes.BarcodeDocumentFormat[], data: string) => Promise<Config.GenericDocument.GenericDocument>; | ||
createBarcodeRecognizer: (options: { | ||
configurators?: Config.BarcodeConfigs.BarcodeConfig[]; | ||
engineMode?: Config.BarcodeScannerTypes.EngineMode; | ||
configurators?: ({ | ||
readonly _type?: "CodabarConfig"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
readonly returnStartEnd?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "Code11Config"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly stripCheckDigits?: boolean; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
readonly checksum?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "Code39Config"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly stripCheckDigits?: boolean; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
readonly code32?: boolean; | ||
readonly code39?: boolean; | ||
readonly pzn?: boolean; | ||
readonly tryCode39ExtendedMode?: boolean; | ||
readonly useCode39CheckDigit?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "Code93Config"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "Code128Config"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: Config.BarcodeTypes.GS1Handling; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "Code2Of5Config"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly stripCheckDigits?: boolean; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
readonly iata2of5?: boolean; | ||
readonly code25?: boolean; | ||
readonly industrial2of5?: boolean; | ||
readonly useIATA2OF5Checksum?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "DataBarConfig"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: Config.BarcodeTypes.GS1Handling; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "DataBarExpandedConfig"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: Config.BarcodeTypes.GS1Handling; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "DataBarLimitedConfig"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: Config.BarcodeTypes.GS1Handling; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "ITFConfig"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "MSIPlesseyConfig"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly stripCheckDigits?: boolean; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
readonly checksumAlgorithms?: Config.BarcodeConfigs.MSIPlesseyChecksumAlgorithm[]; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "UpcEanConfig"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly stripCheckDigits?: boolean; | ||
readonly ean8?: boolean; | ||
readonly ean13?: boolean; | ||
readonly upca?: boolean; | ||
readonly upce?: boolean; | ||
readonly extensions?: Config.BarcodeTypes.UpcEanExtensionBehavior; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "PharmaCodeConfig"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly minimumValue?: number; | ||
readonly allowNarrowBarsOnly?: boolean; | ||
readonly allowWideBarsOnly?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "AztecConfig"; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: Config.BarcodeTypes.GS1Handling; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "QRCodeConfig"; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: Config.BarcodeTypes.GS1Handling; | ||
readonly strictMode?: boolean; | ||
readonly qr?: boolean; | ||
readonly microQr?: boolean; | ||
readonly rmqr?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "PDF417Config"; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: Config.BarcodeTypes.GS1Handling; | ||
readonly strictMode?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "MicroPDF417Config"; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: Config.BarcodeTypes.GS1Handling; | ||
readonly strictMode?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "DataMatrixConfig"; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: Config.BarcodeTypes.GS1Handling; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "MaxiCodeConfig"; | ||
readonly regexFilter?: string; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "AustraliaPostConfig"; | ||
readonly regexFilter?: string; | ||
readonly australiaPostCustomerFormat?: Config.BarcodeConfigs.AustraliaPostCustomerFormat; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "JapanPostConfig"; | ||
readonly regexFilter?: string; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "RoyalMailConfig"; | ||
readonly regexFilter?: string; | ||
readonly stripCheckDigits?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "RoyalTNTPostConfig"; | ||
readonly regexFilter?: string; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "USPSIntelligentMailConfig"; | ||
readonly regexFilter?: string; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "PharmaCodeTwoTrackConfig"; | ||
readonly regexFilter?: string; | ||
readonly minimumValue?: number; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "GS1CompositeConfig"; | ||
readonly regexFilter?: string; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly gs1Handling?: Config.BarcodeTypes.GS1Handling; | ||
readonly strictMode?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "GroupOneDConfig"; | ||
readonly regexFilter?: string; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly stripCheckDigits?: boolean; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
readonly gs1Handling?: Config.BarcodeTypes.GS1Handling; | ||
readonly strictMode?: boolean; | ||
readonly formats?: Config.BarcodeTypes.BarcodeFormat[]; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "GroupTwoDConfig"; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: Config.BarcodeTypes.GS1Handling; | ||
readonly strictMode?: boolean; | ||
readonly formats?: Config.BarcodeTypes.BarcodeFormat[]; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "GroupFourStateConfig"; | ||
readonly regexFilter?: string; | ||
readonly formats?: Config.BarcodeTypes.BarcodeFormat[]; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "GroupCommonConfig"; | ||
readonly regexFilter?: string; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly stripCheckDigits?: boolean; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
readonly gs1Handling?: Config.BarcodeTypes.GS1Handling; | ||
readonly strictMode?: boolean; | ||
readonly formats?: Config.BarcodeTypes.BarcodeFormat[]; | ||
_marker?: () => void; | ||
})[]; | ||
engineMode?: BarcodeScannerTypes.EngineMode; | ||
live?: boolean; | ||
acceptedDocumentFormats?: Config.BarcodeScannerTypes.BarcodeDocumentFormat[]; | ||
acceptedDocumentFormats?: BarcodeScannerTypes.BarcodeDocumentFormat[]; | ||
returnBarcodeImage?: boolean; | ||
_marker?: () => void; | ||
}) => Promise<ObjectId<"BarcodeRecognizer">>; | ||
recognizeBarcodes: (barcodeRecognizerToken: ObjectId<"BarcodeRecognizer">, image: Image) => Promise<Config.BarcodeScannerTypes.BarcodeScannerResult>; | ||
recognizeBarcodes: <ImageType_1 extends Image>(barcodeRecognizerToken: ObjectId<"BarcodeRecognizer">, image: ImageType_1) => Promise<BarcodeScannerTypes.BarcodeScannerResult & { | ||
originalImage: ImageType_1; | ||
}>; | ||
beginPdf: (options: { | ||
@@ -137,8 +368,8 @@ readonly attributes?: { | ||
}; | ||
readonly pageSize?: Config.PdfConfig.PageSize; | ||
readonly pageDirection?: Config.PdfConfig.PageDirection; | ||
readonly pageFit?: Config.PdfConfig.PageFit; | ||
readonly pageSize?: PdfConfig.PageSize; | ||
readonly pageDirection?: PdfConfig.PageDirection; | ||
readonly pageFit?: PdfConfig.PageFit; | ||
readonly dpi?: number; | ||
readonly jpegQuality?: number; | ||
readonly resamplingMethod?: Config.PdfConfig.ResamplingMethod; | ||
readonly resamplingMethod?: PdfConfig.ResamplingMethod; | ||
_marker?: () => void; | ||
@@ -149,17 +380,34 @@ }) => Promise<ObjectId<"PdfGenerationContext">>; | ||
beginTiff: (options: { | ||
compression?: Config.TiffTypes.CompressionMode; | ||
compression?: TiffTypes.CompressionMode; | ||
jpegQuality?: number; | ||
zipCompressionLevel?: number; | ||
dpi?: number; | ||
userFields?: Config.TiffTypes.UserField[]; | ||
userFields?: { | ||
readonly tag?: number; | ||
readonly name?: string; | ||
readonly value?: { | ||
readonly _type?: "UserFieldDoubleValue"; | ||
readonly value?: number; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "UserFieldStringValue"; | ||
readonly value?: string; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "UserFieldIntValue"; | ||
readonly value?: number; | ||
_marker?: () => void; | ||
}; | ||
_marker?: () => void; | ||
}[]; | ||
binarizationFilter?: { | ||
readonly _type?: "ScanbotBinarizationFilter"; | ||
outputMode?: Config.ParametricFilters.OutputMode; | ||
outputMode?: ParametricFilters.OutputMode; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "CustomBinarizationFilter"; | ||
outputMode?: Config.ParametricFilters.OutputMode; | ||
outputMode?: ParametricFilters.OutputMode; | ||
denoise?: number; | ||
radius?: number; | ||
preset?: Config.ParametricFilters.BinarizationFilterPreset; | ||
preset?: ParametricFilters.BinarizationFilterPreset; | ||
_marker?: () => void; | ||
@@ -195,3 +443,3 @@ } | { | ||
}) => Promise<ObjectId<"TiffGenerationContext">>; | ||
addPageToTiff: (tiffOperation: ObjectId<"TiffGenerationContext">, image: Image, binarize: Config.TiffTypes.Binarize) => Promise<unknown>; | ||
addPageToTiff: (tiffOperation: ObjectId<"TiffGenerationContext">, image: Image, binarize: TiffTypes.Binarize) => Promise<unknown>; | ||
completeTiff: (tiffOperation: ObjectId<"TiffGenerationContext">) => Promise<Uint8Array>; | ||
@@ -206,3 +454,5 @@ createMRZRecognizer: (configuration: { | ||
}) => Promise<ObjectId<"MrzRecognizerContext">>; | ||
recognizeMRZ: (mrzRecognizerToken: ObjectId<"MrzRecognizerContext">, image: Image) => Promise<Config.MRZTypes.RecognitionResult>; | ||
recognizeMRZ: <ImageType_2 extends Image>(mrzRecognizerToken: ObjectId<"MrzRecognizerContext">, image: ImageType_2) => Promise<MRZTypes.RecognitionResult & { | ||
originalImage: ImageType_2; | ||
}>; | ||
releaseObject: <T>(objectToken: ObjectId<T>) => Promise<void>; | ||
@@ -232,7 +482,13 @@ createOcrEngine: () => Promise<ObjectId<"TLDROcrContext">>; | ||
}) => Promise<ObjectId<"GenericTextLineScanner">>; | ||
recognizeTextLine: (scannerToken: ObjectId<"GenericTextLineScanner">, image: Image) => Promise<Config.GenericTextLineScannerTypes.ScannerResult>; | ||
recognizeTextLine: <ImageType_3 extends Image>(scannerToken: ObjectId<"GenericTextLineScanner">, image: ImageType_3) => Promise<GenericTextLineScannerTypes.ScannerResult & { | ||
originalImage: ImageType_3; | ||
}>; | ||
cleanTextLineRecognitionQueue: (scannerToken: ObjectId<"GenericTextLineScanner">) => Promise<void>; | ||
createDocumentQualityAnalyzer: (options: { | ||
readonly qualityThresholds?: Config.DocumentQualityAnalyzerTypes.QualityThreshold[]; | ||
readonly qualityIndices?: Config.DocumentQualityAnalyzerTypes.Quality[]; | ||
readonly qualityThresholds?: { | ||
readonly symbolQuality?: number; | ||
readonly symbolRatio?: number; | ||
_marker?: () => void; | ||
}[]; | ||
readonly qualityIndices?: DocumentQualityAnalyzerTypes.Quality[]; | ||
readonly maxImageSize?: number; | ||
@@ -246,8 +502,8 @@ minEstimatedNumberOfSymbolsForDocument?: number; | ||
}) => Promise<ObjectId<"DocumentQualityAnalyzer">>; | ||
documentQualityAnalyzerAnalyze: (dqaToken: ObjectId<"DocumentQualityAnalyzer">, image: Image) => Promise<Config.DocumentQualityAnalyzerTypes.AnalysisResult>; | ||
imageApplyFilter: (image: Image, filter: DeepPartial<Config.ParametricFilters.ParametricFilter>) => Promise<RawImage>; | ||
imageCrop: (image: Image, polygon: [Config.Point, Config.Point, Config.Point, Config.Point]) => Promise<RawImage>; | ||
documentQualityAnalyzerAnalyze: (dqaToken: ObjectId<"DocumentQualityAnalyzer">, image: Image) => Promise<DocumentQualityAnalyzerTypes.AnalysisResult>; | ||
imageApplyFilter: (image: Image, filter: DeepPartial<ParametricFilters.ParametricFilter>) => Promise<RawImage>; | ||
imageCrop: (image: Image, polygon: [Point, Point, Point, Point]) => Promise<RawImage>; | ||
imageResize: (image: Image, destinationSize: number) => Promise<RawImage>; | ||
imageRotate: (image: Image, rotations: Config.ImageProcessorTypes.ImageRotation) => Promise<RawImage>; | ||
genericDocumentRecognizerCreate: (config: { | ||
imageRotate: (image: Image, rotations: ImageProcessorTypes.ImageRotation) => Promise<RawImage>; | ||
genericDocumentRecognizerCreate: (parameters: { | ||
resultAccumulationConfig?: { | ||
@@ -260,9 +516,37 @@ minConfirmations?: number; | ||
fieldExcludeList?: string[]; | ||
acceptedDocumentTypes?: string[]; | ||
configurations?: ({ | ||
readonly _type?: "DateValidationConfig"; | ||
readonly minBirthYear?: number; | ||
readonly maxBirthYear?: number; | ||
readonly minExpirationYear?: number; | ||
readonly maxExpirationYear?: number; | ||
readonly documentTypes?: Config.GenericDocumentTypes.DocumentType[]; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "EuropeanHealthInsuranceCardConfig"; | ||
readonly minBirthYear?: number; | ||
readonly maxBirthYear?: number; | ||
readonly minExpirationYear?: number; | ||
readonly maxExpirationYear?: number; | ||
readonly expectedCountry?: Config.GenericDocumentRecognizerConfigs.EHICIssuingCountry; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "MRZFallbackConfig"; | ||
readonly acceptedCountries?: string[]; | ||
readonly acceptedMRZTypes?: MRZTypes.DocumentType[]; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "GDRGroupConfig"; | ||
readonly acceptedDocumentTypes?: Config.GenericDocumentTypes.DocumentType[]; | ||
_marker?: () => void; | ||
})[]; | ||
_marker?: () => void; | ||
}) => Promise<ObjectId<"GenericDocumentRecognizer">>; | ||
genericDocumentRecognizerRecognize: (gdrToken: ObjectId<"GenericDocumentRecognizer">, image: Image, parameters: { | ||
mode?: Config.GenericDocumentRecognizerTypes.RecognitionMode; | ||
genericDocumentRecognizerRecognize: <ImageType_4 extends Image>(gdrToken: ObjectId<"GenericDocumentRecognizer">, image: ImageType_4, parameters: { | ||
mode?: GenericDocumentRecognizerTypes.RecognitionMode; | ||
_marker?: () => void; | ||
}) => Promise<Config.GenericDocumentRecognizerTypes.RecognitionResult>; | ||
}) => Promise<GenericDocumentRecognizerTypes.RecognitionResult & { | ||
originalImage: ImageType_4; | ||
}>; | ||
version: () => Promise<string>; | ||
__hasModuleFunction: (functionName: string) => Promise<any>; | ||
@@ -272,5 +556,24 @@ __callModuleFunction: (functionName: string, args?: any[]) => Promise<any>; | ||
private licenseCheck; | ||
/** @param partialConfig {@displayType `DeepPartial<Config.GenericTextLineScannerTypes.ScannerConfiguration>`} {@link Config.GenericTextLineScannerTypes.ScannerConfiguration}*/ | ||
/** @param partialConfig {@displayType `DeepPartial<GenericTextLineScannerTypes.ScannerConfiguration>`} {@link GenericTextLineScannerTypes.ScannerConfiguration}*/ | ||
private createGenericTextLineScanner; | ||
/** | ||
* This method will destroy all web workers and free the memory held by the | ||
* SDK (after the next run of the garbage collector). | ||
* | ||
* This function should not be called while a scanner is open or an API call is pending. | ||
* If you do call this function while a scanner is open, the scanner will stop detecting anything, | ||
* but the video will keep running. If you call this function while an API call is pending, that | ||
* pending API call might never finish. | ||
* | ||
* After calling this function, no further calls to this object are allowed. To further use the SDK, | ||
* it needs to be initialized again. | ||
*/ | ||
destroy(): void; | ||
static cameras: BrowserCameras; | ||
static Config: typeof Config; | ||
/** | ||
* Used for testing purposes only. | ||
* @internal | ||
*/ | ||
static _stats: Stats; | ||
} |
@@ -9,4 +9,6 @@ import ScanbotSDK from '../scanbot-sdk'; | ||
constructor(_sdk: ScanbotSDK, _recognizer: ObjectId<"GenericDocumentRecognizer">); | ||
recognize(image: Image, parameters: DeepPartial<GenericDocumentRecognizerTypes.RecognitionParameters>, consumeImage?: ConsumeType): Promise<GenericDocumentRecognizerTypes.RecognitionResult>; | ||
recognize<ImageType extends Image>(image: ImageType, parameters: DeepPartial<GenericDocumentRecognizerTypes.RecognitionParameters>, consumeImage?: ConsumeType): Promise<GenericDocumentRecognizerTypes.RecognitionResult & { | ||
originalImage: ImageType; | ||
}>; | ||
release(): Promise<void>; | ||
} |
@@ -8,5 +8,7 @@ import ScanbotSDK from '../scanbot-sdk'; | ||
constructor(_sdk: ScanbotSDK, _mrzRecognizerToken: Promise<ObjectId<"MrzRecognizerContext">>); | ||
recognize(image: Image, consumeImage?: ConsumeType): Promise<MRZTypes.RecognitionResult | undefined>; | ||
recognize<ImageType extends Image>(image: ImageType, consumeImage?: ConsumeType): Promise<MRZTypes.RecognitionResult & { | ||
originalImage: ImageType; | ||
}>; | ||
recognizeURL(imageURL: string): Promise<MRZTypes.RecognitionResult | undefined>; | ||
release(): Promise<void>; | ||
} |
@@ -8,3 +8,5 @@ import ScanbotSDK from '../scanbot-sdk'; | ||
constructor(_sdk: ScanbotSDK, _textDataScannerToken: Promise<ObjectId<"GenericTextLineScanner">>); | ||
recognize(image: Image, consumeImage?: ConsumeType): Promise<GenericTextLineScannerTypes.ScannerResult>; | ||
recognize<ImageType extends Image>(image: ImageType, consumeImage?: ConsumeType): Promise<GenericTextLineScannerTypes.ScannerResult & { | ||
originalImage: ImageType; | ||
}>; | ||
cleanRecognitionQueue(): Promise<void>; | ||
@@ -11,0 +13,0 @@ recognizeURL(imageURL: string): Promise<GenericTextLineScannerTypes.ScannerResult>; |
@@ -15,3 +15,4 @@ export * from "./configuration/SingleScanningModeUseCase"; | ||
export * from "./configuration/BarcodeScannerConfiguration"; | ||
export * from "./configuration/BarcodeItem"; | ||
export * from "./configuration/BarcodeScannerUIResult"; | ||
export * from "./configuration/GenericDocument"; | ||
export * from "./configuration/MultipleScanningModeUseCase"; | ||
@@ -18,0 +19,0 @@ export * from "./configuration/ScanbotAlertDialog"; |
@@ -1,39 +0,39 @@ | ||
import { DeepPartial, PartiallyConstructible } from "./utils"; | ||
import { DeepPartial, PartiallyConstructible } from "../common"; | ||
import { RoundButton } from "./Common"; | ||
/** | ||
Configuration of the buttons available in the action bar. | ||
*/ | ||
Configuration of the buttons available in the action bar. | ||
*/ | ||
export declare class ActionBarConfiguration extends PartiallyConstructible { | ||
/** | ||
Appearance of the flash button. | ||
@defaultValue new RoundButton({ | ||
"visible": true, | ||
"backgroundColor": "?sbColorSurfaceHigh", | ||
"foregroundColor": "?sbColorOnPrimary", | ||
"activeBackgroundColor": "?sbColorWarning", | ||
"activeForegroundColor": "#1C1B1F" | ||
}); | ||
*/ | ||
Appearance of the flash button. | ||
@defaultValue new RoundButton({ | ||
"visible": true, | ||
"backgroundColor": "?sbColorSurfaceHigh", | ||
"foregroundColor": "?sbColorOnPrimary", | ||
"activeBackgroundColor": "?sbColorWarning", | ||
"activeForegroundColor": "#1C1B1F" | ||
}); | ||
*/ | ||
flashButton: RoundButton; | ||
/** | ||
Appearance of the zoom button. | ||
@defaultValue new RoundButton({ | ||
"visible": true, | ||
"backgroundColor": "?sbColorSurfaceHigh", | ||
"foregroundColor": "?sbColorOnPrimary", | ||
"activeBackgroundColor": "?sbColorSurfaceHigh", | ||
"activeForegroundColor": "?sbColorOnPrimary" | ||
}); | ||
*/ | ||
Appearance of the zoom button. | ||
@defaultValue new RoundButton({ | ||
"visible": true, | ||
"backgroundColor": "?sbColorSurfaceHigh", | ||
"foregroundColor": "?sbColorOnPrimary", | ||
"activeBackgroundColor": "?sbColorSurfaceHigh", | ||
"activeForegroundColor": "?sbColorOnPrimary" | ||
}); | ||
*/ | ||
zoomButton: RoundButton; | ||
/** | ||
Appearance of the flip camera button. | ||
@defaultValue new RoundButton({ | ||
"visible": true, | ||
"backgroundColor": "?sbColorSurfaceHigh", | ||
"foregroundColor": "?sbColorOnPrimary", | ||
"activeBackgroundColor": "?sbColorSurfaceHigh", | ||
"activeForegroundColor": "?sbColorOnPrimary" | ||
}); | ||
*/ | ||
Appearance of the flip camera button. | ||
@defaultValue new RoundButton({ | ||
"visible": true, | ||
"backgroundColor": "?sbColorSurfaceHigh", | ||
"foregroundColor": "?sbColorOnPrimary", | ||
"activeBackgroundColor": "?sbColorSurfaceHigh", | ||
"activeForegroundColor": "?sbColorOnPrimary" | ||
}); | ||
*/ | ||
flipCameraButton: RoundButton; | ||
@@ -40,0 +40,0 @@ /** @param source {@displayType `DeepPartial<ActionBarConfiguration>`} */ |
import { BackgroundStyle } from "./Common"; | ||
import { DeepPartial, PartiallyConstructible } from "./utils"; | ||
import { DeepPartial, PartiallyConstructible } from "../common"; | ||
import { PolygonStyle } from "./Common"; | ||
import { StyledText } from "./Common"; | ||
/** | ||
Configuration of the overlay polygon displayed on top of a barcode in the camera preview. | ||
*/ | ||
Configuration of the overlay polygon displayed on top of a barcode in the camera preview. | ||
*/ | ||
export declare class ArOverlayPolygonConfiguration extends PartiallyConstructible { | ||
/** | ||
Control the visibility of the overlay polygon. | ||
@defaultValue true; | ||
*/ | ||
Control the visibility of the overlay polygon. | ||
@defaultValue true; | ||
*/ | ||
visible: boolean; | ||
/** | ||
Appearance of the overlay polygon when a barcode is not selected. | ||
@defaultValue new PolygonStyle({ | ||
"strokeColor": "?sbColorSurface", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 2.0, | ||
"cornerRadius": 2.0 | ||
}); | ||
*/ | ||
Appearance of the overlay polygon when a barcode is not selected. | ||
@defaultValue new PolygonStyle({ | ||
"strokeColor": "?sbColorSurface", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 2.0, | ||
"cornerRadius": 2.0 | ||
}); | ||
*/ | ||
deselected: PolygonStyle; | ||
/** | ||
Appearance of the overlay polygon after a barcode has been selected. | ||
@defaultValue new PolygonStyle({ | ||
"strokeColor": "?sbColorPositive", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 2.0, | ||
"cornerRadius": 2.0 | ||
}); | ||
*/ | ||
Appearance of the overlay polygon after a barcode has been selected. | ||
@defaultValue new PolygonStyle({ | ||
"strokeColor": "?sbColorPositive", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 2.0, | ||
"cornerRadius": 2.0 | ||
}); | ||
*/ | ||
selected: PolygonStyle; | ||
@@ -38,74 +38,74 @@ /** @param source {@displayType `DeepPartial<ArOverlayPolygonConfiguration>`} */ | ||
/** | ||
Where to display the barcode info box in the camera preview. | ||
Where to display the barcode info box in the camera preview. | ||
- `DISABLED`: | ||
Don't display any barcode info. | ||
- `STACKED`: | ||
Display the barcode info box in the center of the overlay polygon. | ||
- `BELOW`: | ||
Display the barcode info box below the overlay polygon. | ||
- `ABOVE`: | ||
Display the barcode info box above the overlay polygon. | ||
*/ | ||
- `DISABLED`: | ||
Don't display any barcode info. | ||
- `STACKED`: | ||
Display the barcode info box in the center of the overlay polygon. | ||
- `BELOW`: | ||
Display the barcode info box below the overlay polygon. | ||
- `ABOVE`: | ||
Display the barcode info box above the overlay polygon. | ||
*/ | ||
export type BarcodeItemInfoPosition = "DISABLED" | "STACKED" | "BELOW" | "ABOVE"; | ||
/** | ||
Configuration of the barcode info box displayed in the camera preview. | ||
*/ | ||
Configuration of the barcode info box displayed in the camera preview. | ||
*/ | ||
export declare class BarcodeItemConfiguration extends PartiallyConstructible { | ||
/** | ||
Control the visibility of the barcode image in the info box. | ||
@defaultValue true; | ||
*/ | ||
Control the visibility of the barcode image in the info box. | ||
@defaultValue true; | ||
*/ | ||
imageVisible: boolean; | ||
/** | ||
Configuration of the text displaying a barcode's value in the info box when the barcode has been selected. | ||
@defaultValue new StyledText({ | ||
"text": "BARCODE_TITLE", | ||
"color": "?sbColorOnSurface" | ||
Configuration of the text displaying a barcode's value in the info box when the barcode has been selected. | ||
@defaultValue new StyledText({ | ||
"text": "BARCODE_TITLE", | ||
"color": "?sbColorOnSurface" | ||
}); | ||
*/ | ||
*/ | ||
titleSelected: StyledText; | ||
/** | ||
Configuration of the text displaying a barcode's symbology in the info box when the barcode has been selected. | ||
@defaultValue new StyledText({ | ||
"text": "BARCODE_SUBTITLE", | ||
"color": "?sbColorOnSurfaceVariant" | ||
}); | ||
*/ | ||
Configuration of the text displaying a barcode's symbology in the info box when the barcode has been selected. | ||
@defaultValue new StyledText({ | ||
"text": "BARCODE_SUBTITLE", | ||
"color": "?sbColorOnSurfaceVariant" | ||
}); | ||
*/ | ||
subtitleSelected: StyledText; | ||
/** | ||
Configuration of the text displaying a barcode's value in the info box when the barcode is yet to be selected. | ||
@defaultValue new StyledText({ | ||
"text": "BARCODE_TITLE", | ||
"color": "?sbColorOnSurface" | ||
Configuration of the text displaying a barcode's value in the info box when the barcode is yet to be selected. | ||
@defaultValue new StyledText({ | ||
"text": "BARCODE_TITLE", | ||
"color": "?sbColorOnSurface" | ||
}); | ||
*/ | ||
*/ | ||
titleDeselected: StyledText; | ||
/** | ||
Configuration of the text displaying a barcode's symbology in the info box when the barcode is yet to be selected. | ||
@defaultValue new StyledText({ | ||
"text": "BARCODE_SUBTITLE", | ||
"color": "?sbColorOnSurfaceVariant" | ||
}); | ||
*/ | ||
Configuration of the text displaying a barcode's symbology in the info box when the barcode is yet to be selected. | ||
@defaultValue new StyledText({ | ||
"text": "BARCODE_SUBTITLE", | ||
"color": "?sbColorOnSurfaceVariant" | ||
}); | ||
*/ | ||
subtitleDeselected: StyledText; | ||
/** | ||
Appearance of the barcode info box's background when a barcode has been selected. | ||
@defaultValue new PolygonStyle({ | ||
"strokeColor": "?sbColorPositive", | ||
"fillColor": "?sbColorPositive", | ||
"strokeWidth": 0.0, | ||
"cornerRadius": 10.0 | ||
}); | ||
*/ | ||
Appearance of the barcode info box's background when a barcode has been selected. | ||
@defaultValue new PolygonStyle({ | ||
"strokeColor": "?sbColorPositive", | ||
"fillColor": "?sbColorPositive", | ||
"strokeWidth": 0.0, | ||
"cornerRadius": 10.0 | ||
}); | ||
*/ | ||
backgroundSelected: PolygonStyle; | ||
/** | ||
Appearance of the barcode info box's background when a barcode is yet to be selected. | ||
@defaultValue new PolygonStyle({ | ||
"strokeColor": "?sbColorSurface", | ||
"fillColor": "?sbColorSurface", | ||
"strokeWidth": 0.0, | ||
"cornerRadius": 10.0 | ||
}); | ||
*/ | ||
Appearance of the barcode info box's background when a barcode is yet to be selected. | ||
@defaultValue new PolygonStyle({ | ||
"strokeColor": "?sbColorSurface", | ||
"fillColor": "?sbColorSurface", | ||
"strokeWidth": 0.0, | ||
"cornerRadius": 10.0 | ||
}); | ||
*/ | ||
backgroundDeselected: PolygonStyle; | ||
@@ -116,18 +116,18 @@ /** @param source {@displayType `DeepPartial<BarcodeItemConfiguration>`} */ | ||
/** | ||
Configuration of the round button. | ||
*/ | ||
Configuration of the round button. | ||
*/ | ||
export declare class BadgeStyle extends PartiallyConstructible { | ||
/** | ||
Control the visibility of the badge. | ||
@defaultValue true; | ||
*/ | ||
Control the visibility of the badge. | ||
@defaultValue true; | ||
*/ | ||
visible: boolean; | ||
/** | ||
The style of the button's background. | ||
*/ | ||
The style of the button's background. | ||
*/ | ||
background: BackgroundStyle; | ||
/** | ||
Color of the button foreground (icon, text). | ||
@defaultValue "?sbColorOnSurface"; | ||
*/ | ||
Color of the button foreground (icon, text). | ||
@defaultValue "?sbColorOnSurface"; | ||
*/ | ||
foregroundColor: string; | ||
@@ -138,71 +138,71 @@ /** @param source {@displayType `DeepPartial<BadgeStyle>`} */ | ||
/** | ||
Configuration of the AR overlay displayed on top of barcodes in the camera preview. | ||
*/ | ||
Configuration of the AR overlay displayed on top of barcodes in the camera preview. | ||
*/ | ||
export declare class ArOverlayGeneralConfiguration extends PartiallyConstructible { | ||
/** | ||
Control the visibility of the user guidance. | ||
@defaultValue false; | ||
*/ | ||
Control the visibility of the user guidance. | ||
@defaultValue false; | ||
*/ | ||
visible: boolean; | ||
/** | ||
Parameters of the counter badge appearance e.g. color of background its stroke and text/icon color. | ||
@defaultValue new BadgeStyle({ | ||
"background": new BackgroundStyle({}), | ||
"foregroundColor": "?sbColorOnSurface" | ||
}); | ||
*/ | ||
Parameters of the counter badge appearance e.g. color of background its stroke and text/icon color. | ||
@defaultValue new BadgeStyle({ | ||
"background": new BackgroundStyle({}), | ||
"foregroundColor": "?sbColorOnSurface" | ||
}); | ||
*/ | ||
counterBadge: BadgeStyle; | ||
/** | ||
If enabled, the scanner will always immediately scan a barcode in the viewfinder or the camera view. The overlay will mark the scanned barcodes and stays above them. | ||
@defaultValue false; | ||
*/ | ||
If enabled, the scanner will always immediately scan a barcode in the viewfinder or the camera view. The overlay will mark the scanned barcodes and stays above them. | ||
@defaultValue false; | ||
*/ | ||
automaticSelectionEnabled: boolean; | ||
/** | ||
Where to display the barcode info box in the camera preview. | ||
@defaultValue "BELOW"; | ||
*/ | ||
Where to display the barcode info box in the camera preview. | ||
@defaultValue "BELOW"; | ||
*/ | ||
barcodeItemInfoPosition: BarcodeItemInfoPosition; | ||
/** | ||
Configuration of the overlay polygon displayed on top of a barcode in the camera preview. | ||
@defaultValue new ArOverlayPolygonConfiguration({ | ||
"visible": true, | ||
"deselected": new PolygonStyle({}), | ||
"selected": new PolygonStyle({}) | ||
}); | ||
*/ | ||
Configuration of the overlay polygon displayed on top of a barcode in the camera preview. | ||
@defaultValue new ArOverlayPolygonConfiguration({ | ||
"visible": true, | ||
"deselected": new PolygonStyle({}), | ||
"selected": new PolygonStyle({}) | ||
}); | ||
*/ | ||
polygon: ArOverlayPolygonConfiguration; | ||
/** | ||
Configuration of the barcode info box displayed in the camera preview. | ||
@defaultValue new BarcodeItemConfiguration({ | ||
"imageVisible": true, | ||
"titleSelected": new StyledText({ | ||
"text": "BARCODE_TITLE", | ||
"color": "?sbColorOnSurface" | ||
}), | ||
"subtitleSelected": new StyledText({ | ||
"text": "BARCODE_SUBTITLE", | ||
"color": "?sbColorOnSurfaceVariant" | ||
}), | ||
"titleDeselected": new StyledText({ | ||
"text": "BARCODE_TITLE", | ||
"color": "?sbColorOnSurface" | ||
}), | ||
"subtitleDeselected": new StyledText({ | ||
"text": "BARCODE_SUBTITLE", | ||
"color": "?sbColorOnSurfaceVariant" | ||
}), | ||
"backgroundSelected": new PolygonStyle({ | ||
"strokeColor": "?sbColorPositive", | ||
"fillColor": "?sbColorPositive", | ||
"strokeWidth": 1.0, | ||
"cornerRadius": 5.0 | ||
}), | ||
"backgroundDeselected": new PolygonStyle({ | ||
"strokeColor": "?sbColorSurface", | ||
"fillColor": "?sbColorSurface", | ||
"strokeWidth": 1.0, | ||
"cornerRadius": 5.0 | ||
}) | ||
}); | ||
*/ | ||
Configuration of the barcode info box displayed in the camera preview. | ||
@defaultValue new BarcodeItemConfiguration({ | ||
"imageVisible": true, | ||
"titleSelected": new StyledText({ | ||
"text": "BARCODE_TITLE", | ||
"color": "?sbColorOnSurface" | ||
}), | ||
"subtitleSelected": new StyledText({ | ||
"text": "BARCODE_SUBTITLE", | ||
"color": "?sbColorOnSurfaceVariant" | ||
}), | ||
"titleDeselected": new StyledText({ | ||
"text": "BARCODE_TITLE", | ||
"color": "?sbColorOnSurface" | ||
}), | ||
"subtitleDeselected": new StyledText({ | ||
"text": "BARCODE_SUBTITLE", | ||
"color": "?sbColorOnSurfaceVariant" | ||
}), | ||
"backgroundSelected": new PolygonStyle({ | ||
"strokeColor": "?sbColorPositive", | ||
"fillColor": "?sbColorPositive", | ||
"strokeWidth": 1.0, | ||
"cornerRadius": 5.0 | ||
}), | ||
"backgroundDeselected": new PolygonStyle({ | ||
"strokeColor": "?sbColorSurface", | ||
"fillColor": "?sbColorSurface", | ||
"strokeWidth": 1.0, | ||
"cornerRadius": 5.0 | ||
}) | ||
}); | ||
*/ | ||
barcodeItemConfiguration: BarcodeItemConfiguration; | ||
@@ -213,39 +213,39 @@ /** @param source {@displayType `DeepPartial<ArOverlayGeneralConfiguration>`} */ | ||
/** | ||
Configuration of the overlay polygon displayed on top of a barcode in the camera preview. | ||
*/ | ||
Configuration of the overlay polygon displayed on top of a barcode in the camera preview. | ||
*/ | ||
export declare class FindAndPickArOverlayPolygonConfiguration extends PartiallyConstructible { | ||
/** | ||
Control the visibility of the overlay polygon. | ||
@defaultValue true; | ||
*/ | ||
Control the visibility of the overlay polygon. | ||
@defaultValue true; | ||
*/ | ||
visible: boolean; | ||
/** | ||
Appearance of the overlay polygon when a barcode is partially scanned. | ||
@defaultValue new PolygonStyle({ | ||
"strokeColor": "?sbColorWarning", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 3.0, | ||
"cornerRadius": 5.0 | ||
}); | ||
*/ | ||
Appearance of the overlay polygon when a barcode is partially scanned. | ||
@defaultValue new PolygonStyle({ | ||
"strokeColor": "?sbColorWarning", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 3.0, | ||
"cornerRadius": 5.0 | ||
}); | ||
*/ | ||
partiallyScanned: PolygonStyle; | ||
/** | ||
Appearance of the overlay polygon when a barcode is rejected. | ||
@defaultValue new PolygonStyle({ | ||
"strokeColor": "?sbColorSurface", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 3.0, | ||
"cornerRadius": 5.0 | ||
}); | ||
*/ | ||
Appearance of the overlay polygon when a barcode is rejected. | ||
@defaultValue new PolygonStyle({ | ||
"strokeColor": "?sbColorSurface", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 3.0, | ||
"cornerRadius": 5.0 | ||
}); | ||
*/ | ||
rejected: PolygonStyle; | ||
/** | ||
Appearance of the overlay polygon when a barcode is completed. | ||
@defaultValue new PolygonStyle({ | ||
"strokeColor": "?sbColorPositive", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 3.0, | ||
"cornerRadius": 5.0 | ||
}); | ||
*/ | ||
Appearance of the overlay polygon when a barcode is completed. | ||
@defaultValue new PolygonStyle({ | ||
"strokeColor": "?sbColorPositive", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 3.0, | ||
"cornerRadius": 5.0 | ||
}); | ||
*/ | ||
completed: PolygonStyle; | ||
@@ -256,43 +256,43 @@ /** @param source {@displayType `DeepPartial<FindAndPickArOverlayPolygonConfiguration>`} */ | ||
/** | ||
Configuration of the round badge on find and pick ar layer. | ||
*/ | ||
Configuration of the round badge on find and pick ar layer. | ||
*/ | ||
export declare class FindAndPickBadgeConfiguration extends PartiallyConstructible { | ||
/** | ||
Appearance of the badge when a barcode is partially scanned. | ||
@defaultValue new BadgeStyle({ | ||
"visible": true, | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "#FFFFFF30", | ||
"fillColor": "?sbColorWarning", | ||
"strokeWidth": 0.0 | ||
}), | ||
"foregroundColor": "?sbColorOnSurface" | ||
}); | ||
*/ | ||
Appearance of the badge when a barcode is partially scanned. | ||
@defaultValue new BadgeStyle({ | ||
"visible": true, | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "#FFFFFF30", | ||
"fillColor": "?sbColorWarning", | ||
"strokeWidth": 0.0 | ||
}), | ||
"foregroundColor": "?sbColorOnSurface" | ||
}); | ||
*/ | ||
partiallyScanned: BadgeStyle; | ||
/** | ||
Appearance of the badge when a barcode is rejected. | ||
@defaultValue new BadgeStyle({ | ||
"visible": true, | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "#FFFFFF30", | ||
"fillColor": "?sbColorNegative", | ||
"strokeWidth": 0.0 | ||
}), | ||
"foregroundColor": "?sbColorOnSurface" | ||
}); | ||
*/ | ||
Appearance of the badge when a barcode is rejected. | ||
@defaultValue new BadgeStyle({ | ||
"visible": true, | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "#FFFFFF30", | ||
"fillColor": "?sbColorNegative", | ||
"strokeWidth": 0.0 | ||
}), | ||
"foregroundColor": "?sbColorOnSurface" | ||
}); | ||
*/ | ||
rejected: BadgeStyle; | ||
/** | ||
Appearance of the badge when a barcode is completed. | ||
@defaultValue new BadgeStyle({ | ||
"visible": true, | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "#FFFFFF30", | ||
"fillColor": "?sbColorPositive", | ||
"strokeWidth": 0.0 | ||
}), | ||
"foregroundColor": "?sbColorOnSurface" | ||
}); | ||
*/ | ||
Appearance of the badge when a barcode is completed. | ||
@defaultValue new BadgeStyle({ | ||
"visible": true, | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "#FFFFFF30", | ||
"fillColor": "?sbColorPositive", | ||
"strokeWidth": 0.0 | ||
}), | ||
"foregroundColor": "?sbColorOnSurface" | ||
}); | ||
*/ | ||
completed: BadgeStyle; | ||
@@ -303,24 +303,24 @@ /** @param source {@displayType `DeepPartial<FindAndPickBadgeConfiguration>`} */ | ||
/** | ||
Configuration of the AR overlay. | ||
*/ | ||
Configuration of the AR overlay. | ||
*/ | ||
export declare class ArOverlayFindAndPickConfiguration extends PartiallyConstructible { | ||
/** | ||
Control the visibility of the user guidance. | ||
@defaultValue false; | ||
*/ | ||
Control the visibility of the user guidance. | ||
@defaultValue false; | ||
*/ | ||
visible: boolean; | ||
/** | ||
If enabled, the scanner will always immediately scan a barcode in the viewfinder or the camera view. The overlay will mark the scanned barcodes and stays above them. | ||
@defaultValue true; | ||
*/ | ||
If enabled, the scanner will always immediately scan a barcode in the viewfinder or the camera view. The overlay will mark the scanned barcodes and stays above them. | ||
@defaultValue true; | ||
*/ | ||
automaticSelectionEnabled: boolean; | ||
/** | ||
Configuration of the overlay polygon displayed on top of a barcode in the camera preview. | ||
@defaultValue new FindAndPickArOverlayPolygonConfiguration({}); | ||
*/ | ||
Configuration of the overlay polygon displayed on top of a barcode in the camera preview. | ||
@defaultValue new FindAndPickArOverlayPolygonConfiguration({}); | ||
*/ | ||
polygon: FindAndPickArOverlayPolygonConfiguration; | ||
/** | ||
Configuration of the round badge on find and pick ar layer. | ||
@defaultValue new FindAndPickBadgeConfiguration({}); | ||
*/ | ||
Configuration of the round badge on find and pick ar layer. | ||
@defaultValue new FindAndPickBadgeConfiguration({}); | ||
*/ | ||
badge: FindAndPickBadgeConfiguration; | ||
@@ -327,0 +327,0 @@ /** @param source {@displayType `DeepPartial<ArOverlayFindAndPickConfiguration>`} */ |
import { BarcodeItemMapper } from "./BarcodeItemMapper"; | ||
import { ButtonConfiguration } from "./Common"; | ||
import { DeepPartial, PartiallyConstructible } from "./utils"; | ||
import { DeepPartial, PartiallyConstructible } from "../common"; | ||
import { StyledText } from "./Common"; | ||
/** | ||
Configuration of the the mapper's error dialog. | ||
*/ | ||
Configuration of the the mapper's error dialog. | ||
*/ | ||
export declare class BarcodeItemErrorState extends PartiallyConstructible { | ||
/** | ||
Title displayed above the error message. | ||
@defaultValue new StyledText({ | ||
"text": "Connection Error!", | ||
"color": "?sbColorOnSurface" | ||
Title displayed above the error message. | ||
@defaultValue new StyledText({ | ||
"text": "Connection Error!", | ||
"color": "?sbColorOnSurface" | ||
}); | ||
*/ | ||
*/ | ||
title: StyledText; | ||
/** | ||
Error message. | ||
@defaultValue new StyledText({ | ||
"text": "There was an issue and the data requested was not fetched. You could try again or discard this result to start a new scan.", | ||
"color": "?sbColorOnSurfaceVariant" | ||
}); | ||
*/ | ||
Error message. | ||
@defaultValue new StyledText({ | ||
"text": "There was an issue and the data requested was not fetched. You could try again or discard this result to start a new scan.", | ||
"color": "?sbColorOnSurfaceVariant" | ||
}); | ||
*/ | ||
subtitle: StyledText; | ||
/** | ||
Configuration of the retry button. | ||
@defaultValue new ButtonConfiguration({}); | ||
*/ | ||
Configuration of the retry button. | ||
@defaultValue new ButtonConfiguration({}); | ||
*/ | ||
retryButton: ButtonConfiguration; | ||
/** | ||
Configuration of the cancel button. | ||
@defaultValue new ButtonConfiguration({}); | ||
*/ | ||
Configuration of the cancel button. | ||
@defaultValue new ButtonConfiguration({}); | ||
*/ | ||
cancelButton: ButtonConfiguration; | ||
@@ -39,16 +39,16 @@ /** @param source {@displayType `DeepPartial<BarcodeItemErrorState>`} */ | ||
/** | ||
Format of the mapped barcode data. | ||
*/ | ||
Format of the mapped barcode data. | ||
*/ | ||
export declare class BarcodeMappedData extends PartiallyConstructible { | ||
/** | ||
Title of the barcode. | ||
*/ | ||
Title of the barcode. | ||
*/ | ||
title: string; | ||
/** | ||
Subtitle of the barcode. | ||
*/ | ||
Subtitle of the barcode. | ||
*/ | ||
subtitle: string; | ||
/** | ||
Image of the barcode. | ||
*/ | ||
Image of the barcode. | ||
*/ | ||
barcodeImage: string; | ||
@@ -59,37 +59,37 @@ /** @param source {@displayType `DeepPartial<BarcodeMappedData>`} */ | ||
/** | ||
Configuration of the barcode data mapping. | ||
*/ | ||
Configuration of the barcode data mapping. | ||
*/ | ||
export declare class BarcodeInfoMapping extends PartiallyConstructible { | ||
/** | ||
Callback to map the barcode data to the data of the corresponding product. | ||
@defaultValue null; | ||
*/ | ||
Callback to map the barcode data to the data of the corresponding product. | ||
@defaultValue null; | ||
*/ | ||
barcodeItemMapper: BarcodeItemMapper | null; | ||
/** | ||
Background color of the barcode info dialog. | ||
@defaultValue "?sbColorSurface"; | ||
*/ | ||
Background color of the barcode info dialog. | ||
@defaultValue "?sbColorSurface"; | ||
*/ | ||
sheetColor: string; | ||
/** | ||
Color of the divider and separator lines in the barcode info dialog. | ||
@defaultValue "?sbColorOutline"; | ||
*/ | ||
Color of the divider and separator lines in the barcode info dialog. | ||
@defaultValue "?sbColorOutline"; | ||
*/ | ||
dividerColor: string; | ||
/** | ||
Background color of the overlay surrounding the barcode mapping error dialog. | ||
@defaultValue "?sbColorModalOverlay"; | ||
*/ | ||
Background color of the overlay surrounding the barcode mapping error dialog. | ||
@defaultValue "?sbColorModalOverlay"; | ||
*/ | ||
modalOverlayColor: string; | ||
/** | ||
Text being displayed while a barcode is being mapped. | ||
@defaultValue new StyledText({ | ||
"text": "Loading message for barcode info mapping.", | ||
"color": "?sbColorPrimary" | ||
}); | ||
*/ | ||
Text being displayed while a barcode is being mapped. | ||
@defaultValue new StyledText({ | ||
"text": "Loading message for barcode info mapping.", | ||
"color": "?sbColorPrimary" | ||
}); | ||
*/ | ||
loadingMessage: StyledText; | ||
/** | ||
Configuration of the error state displayed when processing a barcode fails. | ||
@defaultValue new BarcodeItemErrorState({}); | ||
*/ | ||
Configuration of the error state displayed when processing a barcode fails. | ||
@defaultValue new BarcodeItemErrorState({}); | ||
*/ | ||
errorState: BarcodeItemErrorState; | ||
@@ -96,0 +96,0 @@ /** @param source {@displayType `DeepPartial<BarcodeInfoMapping>`} */ |
import { BarcodeMappedData } from "./BarcodeInfoMapping"; | ||
import { BarcodeItem } from "./BarcodeItem"; | ||
import { BarcodeScannerUIItem } from "./BarcodeScannerUIResult"; | ||
/** | ||
* Maps a barcode's data to the data of the corresponding product. | ||
* */ | ||
export type BarcodeItemMapper = (barcodeItem: BarcodeItem) => Promise<BarcodeMappedData>; | ||
export type BarcodeItemMapper = (BarcodeScannerUIItem: BarcodeScannerUIItem) => Promise<BarcodeMappedData>; |
import { BarcodeFormat } from "./BarcodeTypes"; | ||
import { DeepPartial, PartiallyConstructible } from "./utils"; | ||
import { DeepPartial, PartiallyConstructible } from "../common"; | ||
import { EngineMode } from "./BarcodeScannerTypes"; | ||
import { GS1Handling } from "./BarcodeTypes"; | ||
/** | ||
Expected quantity of QR codes in an image. | ||
Expected quantity of QR codes in an image. | ||
- `LOW`: | ||
Up to 6 QR codes per image. | ||
- `HIGH`: | ||
Up to 24 QR codes per image. | ||
*/ | ||
- `LOW`: | ||
Up to 6 QR codes per image. | ||
- `HIGH`: | ||
Up to 24 QR codes per image. | ||
*/ | ||
export type CodeDensity = "LOW" | "HIGH"; | ||
/** | ||
Filter for extended EAN and UPC barcodes. | ||
Filter for extended EAN and UPC barcodes. | ||
- `NO_FILTER`: | ||
EAN and UPC codes are not filtered. Both are returned regardless if they have an extension or not. | ||
- `ONLY_WITH_EXTENSIONS`: | ||
Only EAN and UPC codes with extensions are returned. | ||
- `ONLY_WITHOUT_EXTENSIONS`: | ||
Only EAN and UPC codes without extensions are returned. | ||
*/ | ||
- `NO_FILTER`: | ||
EAN and UPC codes are not filtered. Both are returned regardless if they have an extension or not. | ||
- `ONLY_WITH_EXTENSIONS`: | ||
Only EAN and UPC codes with extensions are returned. | ||
- `ONLY_WITHOUT_EXTENSIONS`: | ||
Only EAN and UPC codes without extensions are returned. | ||
*/ | ||
export type BarcodesExtensionFilter = "NO_FILTER" | "ONLY_WITH_EXTENSIONS" | "ONLY_WITHOUT_EXTENSIONS"; | ||
/** | ||
Configuration of the scanning behavior. | ||
*/ | ||
Configuration of the scanning behavior. | ||
*/ | ||
export declare class BarcodeRecognizerConfiguration extends PartiallyConstructible { | ||
/** | ||
Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off). This option overrides `barcodesExtensionFilter` option. | ||
@defaultValue ""; | ||
*/ | ||
Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off). This option overrides `barcodesExtensionFilter` option. | ||
@defaultValue ""; | ||
*/ | ||
barcodesRegexFilter: string; | ||
/** | ||
List of accepted barcode symbologies. | ||
@defaultValue []; | ||
*/ | ||
List of accepted barcode symbologies. | ||
@defaultValue []; | ||
*/ | ||
barcodeFormats: BarcodeFormat[]; | ||
/** | ||
The expected way of handling GS1_COMPOSITE barcodes. | ||
@defaultValue "PARSE"; | ||
*/ | ||
The expected way of handling GS1_COMPOSITE barcodes. | ||
@defaultValue "PARSE"; | ||
*/ | ||
gs1Handling: GS1Handling; | ||
/** | ||
The engine mode to use for barcode recognition. | ||
@defaultValue "NEXT_GEN_LOW_POWER"; | ||
*/ | ||
The engine mode to use for barcode recognition. | ||
@defaultValue "NEXT_GEN_LOW_POWER"; | ||
*/ | ||
engineMode: EngineMode; | ||
/** | ||
Maximum resolution of the image processed by the barcode recognizer. Smaller values mean faster processing but lower recognition quality. The value is limited by the resolution of the preview. | ||
@defaultValue 600; | ||
*/ | ||
Maximum resolution of the image processed by the barcode recognizer. Smaller values mean faster processing but lower recognition quality. The value is limited by the resolution of the preview. | ||
@defaultValue 600; | ||
*/ | ||
maximumRecognizerResolution: number; | ||
@@ -54,0 +54,0 @@ /** @param source {@displayType `DeepPartial<BarcodeRecognizerConfiguration>`} */ |
@@ -7,3 +7,3 @@ import { ActionBarConfiguration } from "./ActionBarConfiguration"; | ||
import { CameraPermissionScreen } from "./CameraPermission"; | ||
import { DeepPartial, PartiallyConstructible } from "./utils"; | ||
import { DeepPartial, PartiallyConstructible } from "../common"; | ||
import { Palette } from "./Common"; | ||
@@ -17,204 +17,204 @@ import { Sound } from "./Common"; | ||
/** | ||
Configuration of the barcode scanner screen. | ||
*/ | ||
Configuration of the barcode scanner screen. | ||
*/ | ||
export declare class BarcodeScannerConfiguration extends PartiallyConstructible { | ||
/** | ||
Version number of the configuration object. | ||
@defaultValue "1.0"; | ||
*/ | ||
Version number of the configuration object. | ||
@defaultValue "1.0"; | ||
*/ | ||
readonly version: string; | ||
/** | ||
The configuration object should be applied for this screen. | ||
@defaultValue "BarcodeScanner"; | ||
*/ | ||
The configuration object should be applied for this screen. | ||
@defaultValue "BarcodeScanner"; | ||
*/ | ||
readonly screen: string; | ||
/** | ||
Define the screen's base color values from which other colors are derived. | ||
@defaultValue new Palette({ | ||
"sbColorPrimary": "#C8193C", | ||
"sbColorPrimaryDisabled": "#F5F5F5", | ||
"sbColorNegative": "#FF3737", | ||
"sbColorPositive": "#4EFFB4", | ||
"sbColorWarning": "#FFCE5C", | ||
"sbColorSecondary": "#FFEDEE", | ||
"sbColorSecondaryDisabled": "#F5F5F5", | ||
"sbColorOnPrimary": "#FFFFFF", | ||
"sbColorOnSecondary": "#C8193C", | ||
"sbColorSurface": "#FFFFFF", | ||
"sbColorOutline": "#EFEFEF", | ||
"sbColorOnSurfaceVariant": "#707070", | ||
"sbColorOnSurface": "#000000", | ||
"sbColorSurfaceLow": "#00000026", | ||
"sbColorSurfaceHigh": "#0000007A", | ||
"sbColorModalOverlay": "#000000A3" | ||
}); | ||
*/ | ||
Define the screen's base color values from which other colors are derived. | ||
@defaultValue new Palette({ | ||
"sbColorPrimary": "#C8193C", | ||
"sbColorPrimaryDisabled": "#F5F5F5", | ||
"sbColorNegative": "#FF3737", | ||
"sbColorPositive": "#4EFFB4", | ||
"sbColorWarning": "#FFCE5C", | ||
"sbColorSecondary": "#FFEDEE", | ||
"sbColorSecondaryDisabled": "#F5F5F5", | ||
"sbColorOnPrimary": "#FFFFFF", | ||
"sbColorOnSecondary": "#C8193C", | ||
"sbColorSurface": "#FFFFFF", | ||
"sbColorOutline": "#EFEFEF", | ||
"sbColorOnSurfaceVariant": "#707070", | ||
"sbColorOnSurface": "#000000", | ||
"sbColorSurfaceLow": "#00000026", | ||
"sbColorSurfaceHigh": "#0000007A", | ||
"sbColorModalOverlay": "#000000A3" | ||
}); | ||
*/ | ||
palette: Palette; | ||
/** | ||
Configuration of the all strings for barcode scanner. | ||
@defaultValue new BarcodeTextLocalization({}); | ||
*/ | ||
Configuration of the all strings for barcode scanner. | ||
@defaultValue new BarcodeTextLocalization({}); | ||
*/ | ||
localization: BarcodeTextLocalization; | ||
/** | ||
Color of the screen's background. | ||
@defaultValue "?sbColorSurfaceLow"; | ||
*/ | ||
Color of the screen's background. | ||
@defaultValue "?sbColorSurfaceLow"; | ||
*/ | ||
backgroundColor: string; | ||
/** | ||
Configuration of the top bar. | ||
@defaultValue new TopBarConfiguration({ | ||
"title": new StyledText({ | ||
"text": "?topBarTitle", | ||
"color": "?sbColorOnPrimary" | ||
}), | ||
"mode": "SOLID", | ||
"backgroundColor": "?sbColorPrimary", | ||
"cancelButton": new ButtonConfiguration({ | ||
"visible": true, | ||
"text": "?topBarCancelButton", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "#00000000", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 0.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"iconVisible": true, | ||
"color": "?sbColorOnPrimary", | ||
"useShadow": false | ||
}) | ||
}) | ||
}); | ||
*/ | ||
Configuration of the top bar. | ||
@defaultValue new TopBarConfiguration({ | ||
"title": new StyledText({ | ||
"text": "?topBarTitle", | ||
"color": "?sbColorOnPrimary" | ||
}), | ||
"mode": "SOLID", | ||
"backgroundColor": "?sbColorPrimary", | ||
"cancelButton": new ButtonConfiguration({ | ||
"visible": true, | ||
"text": "?topBarCancelButton", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "#00000000", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 0.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"iconVisible": true, | ||
"color": "?sbColorOnPrimary", | ||
"useShadow": false | ||
}) | ||
}) | ||
}); | ||
*/ | ||
topBar: TopBarConfiguration; | ||
/** | ||
Configuration of the action bar. | ||
@defaultValue new ActionBarConfiguration({ | ||
"flashButton": new RoundButton({ | ||
"visible": true, | ||
"backgroundColor": "?sbColorSurfaceHigh", | ||
"foregroundColor": "?sbColorOnPrimary", | ||
"activeBackgroundColor": "?sbColorWarning", | ||
"activeForegroundColor": "#1C1B1F" | ||
}), | ||
"zoomButton": new RoundButton({ | ||
"visible": true, | ||
"backgroundColor": "?sbColorSurfaceHigh", | ||
"foregroundColor": "?sbColorOnPrimary", | ||
"activeBackgroundColor": "?sbColorSurfaceHigh", | ||
"activeForegroundColor": "?sbColorOnPrimary" | ||
}), | ||
"flipCameraButton": new RoundButton({ | ||
"visible": true, | ||
"backgroundColor": "?sbColorSurfaceHigh", | ||
"foregroundColor": "?sbColorOnPrimary", | ||
"activeBackgroundColor": "?sbColorSurfaceHigh", | ||
"activeForegroundColor": "?sbColorOnPrimary" | ||
}) | ||
}); | ||
*/ | ||
Configuration of the action bar. | ||
@defaultValue new ActionBarConfiguration({ | ||
"flashButton": new RoundButton({ | ||
"visible": true, | ||
"backgroundColor": "?sbColorSurfaceHigh", | ||
"foregroundColor": "?sbColorOnPrimary", | ||
"activeBackgroundColor": "?sbColorWarning", | ||
"activeForegroundColor": "#1C1B1F" | ||
}), | ||
"zoomButton": new RoundButton({ | ||
"visible": true, | ||
"backgroundColor": "?sbColorSurfaceHigh", | ||
"foregroundColor": "?sbColorOnPrimary", | ||
"activeBackgroundColor": "?sbColorSurfaceHigh", | ||
"activeForegroundColor": "?sbColorOnPrimary" | ||
}), | ||
"flipCameraButton": new RoundButton({ | ||
"visible": true, | ||
"backgroundColor": "?sbColorSurfaceHigh", | ||
"foregroundColor": "?sbColorOnPrimary", | ||
"activeBackgroundColor": "?sbColorSurfaceHigh", | ||
"activeForegroundColor": "?sbColorOnPrimary" | ||
}) | ||
}); | ||
*/ | ||
actionBar: ActionBarConfiguration; | ||
/** | ||
Configuration of the view finder. | ||
@defaultValue new ViewFinderConfiguration({ | ||
"visible": true, | ||
"style": new FinderCorneredStyle({ | ||
"strokeColor": "?sbColorSurface", | ||
"strokeWidth": 2.0, | ||
"cornerRadius": 10.0 | ||
}), | ||
"overlayColor": "?sbColorSurfaceLow", | ||
"aspectRatio": new AspectRatio({ | ||
"width": 1.0, | ||
"height": 1.0 | ||
}) | ||
}); | ||
*/ | ||
Configuration of the view finder. | ||
@defaultValue new ViewFinderConfiguration({ | ||
"visible": true, | ||
"style": new FinderCorneredStyle({ | ||
"strokeColor": "?sbColorSurface", | ||
"strokeWidth": 2.0, | ||
"cornerRadius": 10.0 | ||
}), | ||
"overlayColor": "?sbColorSurfaceLow", | ||
"aspectRatio": new AspectRatio({ | ||
"width": 1.0, | ||
"height": 1.0 | ||
}) | ||
}); | ||
*/ | ||
viewFinder: ViewFinderConfiguration; | ||
/** | ||
Configuration of the text hint guiding users to move the view finder over a barcode. | ||
@defaultValue new UserGuidanceConfiguration({ | ||
"visible": true, | ||
"title": new StyledText({ | ||
"text": "?userGuidance", | ||
"color": "?sbColorOnPrimary" | ||
}), | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "#00000000", | ||
"fillColor": "?sbColorSurfaceLow", | ||
"strokeWidth": 0.0 | ||
}) | ||
}); | ||
*/ | ||
Configuration of the text hint guiding users to move the view finder over a barcode. | ||
@defaultValue new UserGuidanceConfiguration({ | ||
"visible": true, | ||
"title": new StyledText({ | ||
"text": "?userGuidance", | ||
"color": "?sbColorOnPrimary" | ||
}), | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "#00000000", | ||
"fillColor": "?sbColorSurfaceLow", | ||
"strokeWidth": 0.0 | ||
}) | ||
}); | ||
*/ | ||
userGuidance: UserGuidanceConfiguration; | ||
/** | ||
Configuration of the dialog for requesting camera permissions. | ||
@defaultValue new CameraPermissionScreen({ | ||
"background": "?sbColorSurface", | ||
"iconBackground": "?sbColorOutline", | ||
"icon": new IconStyle({ | ||
"visible": true, | ||
"color": "?sbColorOnSurface" | ||
}), | ||
"closeButton": new ButtonConfiguration({ | ||
"visible": true, | ||
"text": "?cameraPermissionCloseButton", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "#00000000", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 0.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"iconVisible": false, | ||
"color": "?sbColorPrimary", | ||
"useShadow": false | ||
}) | ||
}), | ||
"enableCameraTitle": new StyledText({ | ||
"text": "?cameraPermissionEnableCameraTitle", | ||
"color": "?sbColorOnSurface" | ||
}), | ||
"enableCameraExplanation": new StyledText({ | ||
"text": "?cameraPermissionEnableCameraExplanation", | ||
"color": "?sbColorOnSurfaceVariant" | ||
}) | ||
}); | ||
*/ | ||
Configuration of the dialog for requesting camera permissions. | ||
@defaultValue new CameraPermissionScreen({ | ||
"background": "?sbColorSurface", | ||
"iconBackground": "?sbColorOutline", | ||
"icon": new IconStyle({ | ||
"visible": true, | ||
"color": "?sbColorOnSurface" | ||
}), | ||
"closeButton": new ButtonConfiguration({ | ||
"visible": true, | ||
"text": "?cameraPermissionCloseButton", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "#00000000", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 0.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"iconVisible": false, | ||
"color": "?sbColorPrimary", | ||
"useShadow": false | ||
}) | ||
}), | ||
"enableCameraTitle": new StyledText({ | ||
"text": "?cameraPermissionEnableCameraTitle", | ||
"color": "?sbColorOnSurface" | ||
}), | ||
"enableCameraExplanation": new StyledText({ | ||
"text": "?cameraPermissionEnableCameraExplanation", | ||
"color": "?sbColorOnSurfaceVariant" | ||
}) | ||
}); | ||
*/ | ||
cameraPermission: CameraPermissionScreen; | ||
/** | ||
Configuration of the camera behavior. | ||
@defaultValue new CameraConfiguration({}); | ||
*/ | ||
Configuration of the camera behavior. | ||
@defaultValue new CameraConfiguration({}); | ||
*/ | ||
cameraConfiguration: CameraConfiguration; | ||
/** | ||
Configuration of the scanning behavior. | ||
@defaultValue new BarcodeRecognizerConfiguration({}); | ||
*/ | ||
Configuration of the scanning behavior. | ||
@defaultValue new BarcodeRecognizerConfiguration({}); | ||
*/ | ||
recognizerConfiguration: BarcodeRecognizerConfiguration; | ||
/** | ||
Configuration of the barcode scanner screen's behavior. | ||
@defaultValue new SingleScanningMode({}); | ||
*/ | ||
Configuration of the barcode scanner screen's behavior. | ||
@defaultValue new SingleScanningMode({}); | ||
*/ | ||
useCase: BarcodeUseCase; | ||
/** | ||
Configuration of the scan confirmation sound. | ||
@defaultValue new Sound({ | ||
"successBeepEnabled": true, | ||
"soundType": "MODERN_BEEP" | ||
Configuration of the scan confirmation sound. | ||
@defaultValue new Sound({ | ||
"successBeepEnabled": true, | ||
"soundType": "MODERN_BEEP" | ||
}); | ||
*/ | ||
*/ | ||
sound: Sound; | ||
/** | ||
Configuration of the scan scan confirmation vibration. | ||
@defaultValue new Vibration({ | ||
"enabled": true | ||
Configuration of the scan scan confirmation vibration. | ||
@defaultValue new Vibration({ | ||
"enabled": true | ||
}); | ||
*/ | ||
*/ | ||
vibration: Vibration; | ||
/** | ||
Configuration of timeouts. | ||
@defaultValue new Timeouts({ | ||
"autoCancelTimeout": 0, | ||
"initialScanDelay": 0 | ||
Configuration of timeouts. | ||
@defaultValue new Timeouts({ | ||
"autoCancelTimeout": 0, | ||
"initialScanDelay": 0 | ||
}); | ||
*/ | ||
*/ | ||
timeouts: Timeouts; | ||
@@ -221,0 +221,0 @@ /** @param source {@displayType `DeepPartial<BarcodeScannerConfiguration>`} */ |
@@ -1,6 +0,1 @@ | ||
import { BarcodeItem } from "./BarcodeItem"; | ||
export type { EngineMode } from "../../core/bridge/compiled/BarcodeScannerTypes"; | ||
export declare class BarcodeScannerResult { | ||
items: BarcodeItem[]; | ||
constructor(items: BarcodeItem[]); | ||
} | ||
export { BarcodeItem, type EngineMode, type BarcodeDocumentFormat, BarcodeDocumentFormats } from "../../core/bridge/compiled/BarcodeScannerTypes"; |
@@ -1,118 +0,173 @@ | ||
import { DeepPartial, PartiallyConstructible } from "./utils"; | ||
import { DeepPartial, PartiallyConstructible } from "../common"; | ||
/** | ||
Configuration of the all strings for barcode scanner. | ||
*/ | ||
Configuration of the all strings for barcode scanner. | ||
*/ | ||
export declare class BarcodeTextLocalization extends PartiallyConstructible { | ||
/** | ||
Title for the camera permission dialog. | ||
@defaultValue "Camera permission denied!"; | ||
*/ | ||
Title for the camera permission dialog. | ||
@defaultValue "Camera permission denied!"; | ||
*/ | ||
cameraPermissionEnableCameraTitle: string; | ||
/** | ||
Explanation for the camera permission dialog. | ||
@defaultValue "Please allow the usage of the camera to start the scanning process."; | ||
*/ | ||
Explanation for the camera permission dialog. | ||
@defaultValue "Please allow the usage of the camera to start the scanning process."; | ||
*/ | ||
cameraPermissionEnableCameraExplanation: string; | ||
/** | ||
Close button text for the camera permission dialog. | ||
@defaultValue "Close"; | ||
*/ | ||
Close button text for the camera permission dialog. | ||
@defaultValue "Close"; | ||
*/ | ||
cameraPermissionCloseButton: string; | ||
/** | ||
Cancel button text for the top bar. | ||
@defaultValue "Cancel"; | ||
*/ | ||
Cancel button text for the top bar. | ||
@defaultValue "Cancel"; | ||
*/ | ||
topBarCancelButton: string; | ||
/** | ||
Title for the top bar. | ||
@defaultValue "Scan Item"; | ||
*/ | ||
Title for the top bar. | ||
@defaultValue "Scan Item"; | ||
*/ | ||
topBarTitle: string; | ||
/** | ||
User guidance text. | ||
@defaultValue "Move the finder over a barcode"; | ||
*/ | ||
User guidance text. | ||
@defaultValue "Move the finder over a barcode"; | ||
*/ | ||
userGuidance: string; | ||
/** | ||
Loading message for barcode info mapping. | ||
@defaultValue "Loading details..."; | ||
*/ | ||
Loading message for barcode info mapping. | ||
@defaultValue "Loading details..."; | ||
*/ | ||
barcodeInfoMappingLoadingMessage: string; | ||
/** | ||
Title for the barcode info mapping error state. | ||
@defaultValue "Connection Error!"; | ||
*/ | ||
Title for the barcode info mapping error state. | ||
@defaultValue "Connection Error!"; | ||
*/ | ||
barcodeInfoMappingErrorStateTitle: string; | ||
/** | ||
Subtitle for the barcode info mapping error state. | ||
@defaultValue "There was an issue and the data requested was not fetched. You could try again or discard this result to start a new scan."; | ||
*/ | ||
Subtitle for the barcode info mapping error state. | ||
@defaultValue "There was an issue and the data requested was not fetched. You could try again or discard this result to start a new scan."; | ||
*/ | ||
barcodeInfoMappingErrorStateSubtitle: string; | ||
/** | ||
Retry button text for the barcode info mapping error state. | ||
@defaultValue "Retry"; | ||
*/ | ||
Retry button text for the barcode info mapping error state. | ||
@defaultValue "Retry"; | ||
*/ | ||
barcodeInfoMappingErrorStateRetryButton: string; | ||
/** | ||
Cancel button text for the barcode info mapping error state. | ||
@defaultValue "Cancel"; | ||
*/ | ||
Cancel button text for the barcode info mapping error state. | ||
@defaultValue "Cancel"; | ||
*/ | ||
barcodeInfoMappingErrorStateCancelButton: string; | ||
/** | ||
Title for the manual count edit dialog. | ||
@defaultValue "Update count"; | ||
*/ | ||
Title for the manual count edit dialog. | ||
@defaultValue "Update count"; | ||
*/ | ||
manualCountEditDialogTitle: string; | ||
/** | ||
Info for the manual count edit dialog. | ||
@defaultValue "Adjust the number of items you scanned."; | ||
*/ | ||
Info for the manual count edit dialog. | ||
@defaultValue "Adjust the number of items you scanned."; | ||
*/ | ||
manualCountEditDialogInfo: string; | ||
/** | ||
Update button text for the manual count edit dialog. | ||
@defaultValue "Update"; | ||
*/ | ||
Update button text for the manual count edit dialog. | ||
@defaultValue "Update"; | ||
*/ | ||
manualCountEditDialogUpdateButton: string; | ||
/** | ||
Cancel button text for the manual count edit dialog. | ||
@defaultValue "Cancel"; | ||
*/ | ||
Cancel button text for the manual count edit dialog. | ||
@defaultValue "Cancel"; | ||
*/ | ||
manualCountEditDialogCancelButton: string; | ||
/** | ||
Clear all button text for the barcode sheet. | ||
@defaultValue "Clear all"; | ||
*/ | ||
Reset button text for the barcode sheet. | ||
@defaultValue "Reset"; | ||
*/ | ||
sheetResetButton: string; | ||
/** | ||
Clear all button text for the barcode sheet. | ||
@defaultValue "Clear all"; | ||
*/ | ||
sheetClearAllButton: string; | ||
/** | ||
Submit button text for the barcode sheet. | ||
@defaultValue "Submit"; | ||
*/ | ||
Submit button text for the barcode sheet. | ||
@defaultValue "Submit"; | ||
*/ | ||
sheetSubmitButton: string; | ||
/** | ||
Start scanning button text for the barcode sheet. | ||
@defaultValue "Start scanning"; | ||
*/ | ||
Start scanning button text for the barcode sheet. | ||
@defaultValue "Start scanning"; | ||
*/ | ||
sheetStartScanningButton: string; | ||
/** | ||
Title for the barcode sheet placeholder. | ||
@defaultValue "No barcodes here!"; | ||
*/ | ||
Title for the barcode sheet placeholder. | ||
@defaultValue "No barcodes here!"; | ||
*/ | ||
sheetPlaceholderTitle: string; | ||
/** | ||
Subtitle for the barcode sheet placeholder. | ||
@defaultValue "The barcode list is currently empty. Close this sheet and scan your items to add them."; | ||
*/ | ||
Subtitle for the barcode sheet placeholder. | ||
@defaultValue "The barcode list is currently empty. Close this sheet and scan your items to add them."; | ||
*/ | ||
sheetPlaceholderSubtitle: string; | ||
/** | ||
Cancel button text for the single mode confirmation dialog. | ||
@defaultValue "Close"; | ||
*/ | ||
Cancel button text for the single mode confirmation dialog. | ||
@defaultValue "Close"; | ||
*/ | ||
singleModeConfirmationCancelButton: string; | ||
/** | ||
Title for the multiple mode barcode sheet. | ||
@defaultValue "%d items"; | ||
*/ | ||
Title for the multiple mode barcode sheet. | ||
@defaultValue "%d items"; | ||
*/ | ||
multipleModeSheetTitle: string; | ||
/** | ||
Title for the find and pick barcode sheet. | ||
@defaultValue "%d/%d scanned"; | ||
*/ | ||
findAndPickSheetTitle: string; | ||
/** | ||
Subtitle for the find and pick barcode sheet. | ||
@defaultValue "%d/%d added"; | ||
*/ | ||
findAndPickSheetBarcodeItemSubtitle: string; | ||
/** | ||
Title for the find and pick partial alert. | ||
@defaultValue "Incomplete scan!"; | ||
*/ | ||
findAndPickPartialAlertTitle: string; | ||
/** | ||
Subtitle for the find and pick partial alert. | ||
@defaultValue "Some codes are yet to be scanned. Proceed with submission anyway?"; | ||
*/ | ||
findAndPickPartialAlertSubtitle: string; | ||
/** | ||
Cancel button text for the find and pick partial alert. | ||
@defaultValue "Cancel"; | ||
*/ | ||
findAndPickPartialAlertCancelButton: string; | ||
/** | ||
Submit button text for the find and pick partial alert. | ||
@defaultValue "Yes, Submit"; | ||
*/ | ||
findAndPickPartialAlertSubmitButton: string; | ||
/** | ||
Title for the find and pick complete alert. | ||
@defaultValue "All codes found!"; | ||
*/ | ||
findAndPickCompleteAlertTitle: string; | ||
/** | ||
Subtitle for the find and pick complete alert. | ||
@defaultValue "You have successfully scanned all codes. Proceed with submission?"; | ||
*/ | ||
findAndPickCompleteAlertSubtitle: string; | ||
/** | ||
Cancel button text for the find and pick complete alert. | ||
@defaultValue "Dismiss"; | ||
*/ | ||
findAndPickCompleteAlertCancelButton: string; | ||
/** | ||
Submit button text for the find and pick complete alert. | ||
@defaultValue "Submit"; | ||
*/ | ||
findAndPickCompleteAlertSubmitButton: string; | ||
/** @param source {@displayType `DeepPartial<BarcodeTextLocalization>`} */ | ||
constructor(source?: DeepPartial<BarcodeTextLocalization>); | ||
} |
@@ -1,1 +0,1 @@ | ||
export type { BarcodeFormat, GS1Handling } from "../../core/bridge/compiled/BarcodeTypes"; | ||
export type { BarcodeFormat, GS1Handling, } from "../../core/bridge/compiled/BarcodeTypes"; |
@@ -0,7 +1,8 @@ | ||
import { FindAndPickScanningMode } from "./FindAndPickScanningModeUseCase"; | ||
import { MultipleScanningMode } from "./MultipleScanningModeUseCase"; | ||
import { SingleScanningMode } from "./SingleScanningModeUseCase"; | ||
/** | ||
Configuration of the barcode scanner screen's behavior. | ||
*/ | ||
export type BarcodeUseCase = SingleScanningMode | MultipleScanningMode; | ||
Configuration of the barcode scanner screen's behavior. | ||
*/ | ||
export type BarcodeUseCase = SingleScanningMode | MultipleScanningMode | FindAndPickScanningMode; | ||
/** @internal */ | ||
@@ -8,0 +9,0 @@ export declare namespace BarcodeUseCase { |
@@ -1,13 +0,13 @@ | ||
import { DeepPartial, PartiallyConstructible } from "./utils"; | ||
import { DeepPartial, PartiallyConstructible } from "../common"; | ||
/** | ||
Ideal resolution of the camera preview. | ||
*/ | ||
Ideal resolution of the camera preview. | ||
*/ | ||
export declare class Resolution extends PartiallyConstructible { | ||
/** | ||
Width of the resolution. | ||
*/ | ||
Width of the resolution. | ||
*/ | ||
width: number; | ||
/** | ||
Height of the resolution. | ||
*/ | ||
Height of the resolution. | ||
*/ | ||
height: number; | ||
@@ -18,41 +18,41 @@ /** @param source {@displayType `DeepPartial<Resolution>`} */ | ||
/** | ||
Determine which camera module to use on start-up. | ||
Determine which camera module to use on start-up. | ||
- `FRONT`: | ||
Use the front camera. | ||
- `BACK`: | ||
Use the default back camera. | ||
*/ | ||
- `FRONT`: | ||
Use the front camera. | ||
- `BACK`: | ||
Use the default back camera. | ||
*/ | ||
export type CameraModule = "FRONT" | "BACK"; | ||
/** | ||
Configuration of the camera settings to be used while scanning. | ||
*/ | ||
Configuration of the camera settings to be used while scanning. | ||
*/ | ||
export declare class CameraConfiguration extends PartiallyConstructible { | ||
/** | ||
Which camera module to use on start-up. | ||
@defaultValue "BACK"; | ||
*/ | ||
Which camera module to use on start-up. | ||
@defaultValue "BACK"; | ||
*/ | ||
cameraModule: CameraModule; | ||
/** | ||
The number of zoom steps available to the user. | ||
@defaultValue [1.0, 2.0, 5.0]; | ||
*/ | ||
The number of zoom steps available to the user. | ||
@defaultValue [1.0, 2.0, 5.0]; | ||
*/ | ||
zoomSteps: number[]; | ||
/** | ||
The default zoom factor on start-up. | ||
@defaultValue 1.0; | ||
*/ | ||
The default zoom factor on start-up. | ||
@defaultValue 1.0; | ||
*/ | ||
defaultZoomFactor: number; | ||
/** | ||
Whether the flash is enabled by default. | ||
@defaultValue false; | ||
*/ | ||
Whether the flash is enabled by default. | ||
@defaultValue false; | ||
*/ | ||
flashEnabled: boolean; | ||
/** | ||
The ideal resolution for the camera preview. Actual resolution may vary depending on browser and device capabilities. | ||
@defaultValue new Resolution({ | ||
"width": 1920, | ||
"height": 1080 | ||
The ideal resolution for the camera preview. Actual resolution may vary depending on browser and device capabilities. | ||
@defaultValue new Resolution({ | ||
"width": 1920, | ||
"height": 1080 | ||
}); | ||
*/ | ||
*/ | ||
idealPreviewResolution: Resolution; | ||
@@ -59,0 +59,0 @@ /** @param source {@displayType `DeepPartial<CameraConfiguration>`} */ |
import { ButtonConfiguration } from "./Common"; | ||
import { DeepPartial, PartiallyConstructible } from "./utils"; | ||
import { DeepPartial, PartiallyConstructible } from "../common"; | ||
import { IconStyle } from "./Common"; | ||
import { StyledText } from "./Common"; | ||
/** | ||
Configuration of the camera permission request view. | ||
*/ | ||
Configuration of the camera permission request view. | ||
*/ | ||
export declare class CameraPermissionScreen extends PartiallyConstructible { | ||
/** | ||
Background color of the camera permission request. | ||
@defaultValue "?sbColorSurface"; | ||
*/ | ||
Background color of the camera permission request. | ||
@defaultValue "?sbColorSurface"; | ||
*/ | ||
background: string; | ||
/** | ||
Background color of the icon used in the camera permission request. | ||
@defaultValue "?sbColorOutline"; | ||
*/ | ||
Background color of the icon used in the camera permission request. | ||
@defaultValue "?sbColorOutline"; | ||
*/ | ||
iconBackground: string; | ||
/** | ||
Configuration of the icon used in the camera permission request. | ||
@defaultValue new IconStyle({ | ||
"visible": true, | ||
"color": "?sbColorOnSurface" | ||
Configuration of the icon used in the camera permission request. | ||
@defaultValue new IconStyle({ | ||
"visible": true, | ||
"color": "?sbColorOnSurface" | ||
}); | ||
*/ | ||
*/ | ||
icon: IconStyle; | ||
/** | ||
Configuration of the camera permission request's close button. | ||
@defaultValue new ButtonConfiguration({ | ||
"text": "Close", | ||
"background": new BackgroundStyle({}), | ||
"foreground": new ForegroundStyle({}) | ||
}); | ||
*/ | ||
Configuration of the camera permission request's close button. | ||
@defaultValue new ButtonConfiguration({ | ||
"text": "Close", | ||
"background": new BackgroundStyle({}), | ||
"foreground": new ForegroundStyle({}) | ||
}); | ||
*/ | ||
closeButton: ButtonConfiguration; | ||
/** | ||
Configuration of the camera permission request's title. | ||
@defaultValue new StyledText({ | ||
"text": "Camera permission denied!", | ||
"color": "?colorOnSurface" | ||
}); | ||
*/ | ||
Configuration of the camera permission request's title. | ||
@defaultValue new StyledText({ | ||
"text": "Camera permission denied!", | ||
"color": "?colorOnSurface" | ||
}); | ||
*/ | ||
enableCameraTitle: StyledText; | ||
/** | ||
Configuration of the camera permission request's explanatory text. | ||
@defaultValue new StyledText({ | ||
"text": "Please allow the usage of the camera to start the scanning process.", | ||
"color": "?sbColorOnSurfaceVariant" | ||
}); | ||
*/ | ||
Configuration of the camera permission request's explanatory text. | ||
@defaultValue new StyledText({ | ||
"text": "Please allow the usage of the camera to start the scanning process.", | ||
"color": "?sbColorOnSurfaceVariant" | ||
}); | ||
*/ | ||
enableCameraExplanation: StyledText; | ||
@@ -52,0 +52,0 @@ /** @param source {@displayType `DeepPartial<CameraPermissionScreen>`} */ |
@@ -1,85 +0,85 @@ | ||
import { DeepPartial, PartiallyConstructible } from "./utils"; | ||
import { DeepPartial, PartiallyConstructible } from "../common"; | ||
/** | ||
Value palette describing the colors of the scanner screens. | ||
*/ | ||
Value palette describing the colors of the scanner screens. | ||
*/ | ||
export declare class Palette extends PartiallyConstructible { | ||
/** | ||
Primary color used for enabled elements. | ||
@defaultValue "#C8193C"; | ||
*/ | ||
Primary color used for enabled elements. | ||
@defaultValue "#C8193C"; | ||
*/ | ||
sbColorPrimary: string; | ||
/** | ||
Primary color used for disabled elements. | ||
@defaultValue "#F5F5F5"; | ||
*/ | ||
Primary color used for disabled elements. | ||
@defaultValue "#F5F5F5"; | ||
*/ | ||
sbColorPrimaryDisabled: string; | ||
/** | ||
Color used to convey a negative meaning. | ||
@defaultValue "#FF3737"; | ||
*/ | ||
Color used to convey a negative meaning. | ||
@defaultValue "#FF3737"; | ||
*/ | ||
sbColorNegative: string; | ||
/** | ||
Color used to convey a positive meaning. | ||
@defaultValue "#4EFFB4"; | ||
*/ | ||
Color used to convey a positive meaning. | ||
@defaultValue "#4EFFB4"; | ||
*/ | ||
sbColorPositive: string; | ||
/** | ||
Color used to convey warnings. | ||
@defaultValue "#FFCE5C"; | ||
*/ | ||
Color used to convey warnings. | ||
@defaultValue "#FFCE5C"; | ||
*/ | ||
sbColorWarning: string; | ||
/** | ||
Secondary color used for enabled elements. | ||
@defaultValue "#FFEDEE"; | ||
*/ | ||
Secondary color used for enabled elements. | ||
@defaultValue "#FFEDEE"; | ||
*/ | ||
sbColorSecondary: string; | ||
/** | ||
Secondary color used for disabled elements. | ||
@defaultValue "#F5F5F5"; | ||
*/ | ||
Secondary color used for disabled elements. | ||
@defaultValue "#F5F5F5"; | ||
*/ | ||
sbColorSecondaryDisabled: string; | ||
/** | ||
Color used for displaying elements on top of the primary color. | ||
@defaultValue "#FFFFFF"; | ||
*/ | ||
Color used for displaying elements on top of the primary color. | ||
@defaultValue "#FFFFFF"; | ||
*/ | ||
sbColorOnPrimary: string; | ||
/** | ||
Color used for displaying elements on top of the secondary color. | ||
@defaultValue "#C8193C"; | ||
*/ | ||
Color used for displaying elements on top of the secondary color. | ||
@defaultValue "#C8193C"; | ||
*/ | ||
sbColorOnSecondary: string; | ||
/** | ||
Color used for surfaces. | ||
@defaultValue "#FFFFFF"; | ||
*/ | ||
Color used for surfaces. | ||
@defaultValue "#FFFFFF"; | ||
*/ | ||
sbColorSurface: string; | ||
/** | ||
Color used for outlines. | ||
@defaultValue "#EFEFEF"; | ||
*/ | ||
Color used for outlines. | ||
@defaultValue "#EFEFEF"; | ||
*/ | ||
sbColorOutline: string; | ||
/** | ||
Alternative color used on top of surfaces. | ||
@defaultValue "#707070"; | ||
*/ | ||
Alternative color used on top of surfaces. | ||
@defaultValue "#707070"; | ||
*/ | ||
sbColorOnSurfaceVariant: string; | ||
/** | ||
Color used on top of surfaces. | ||
@defaultValue "#000000"; | ||
*/ | ||
Color used on top of surfaces. | ||
@defaultValue "#000000"; | ||
*/ | ||
sbColorOnSurface: string; | ||
/** | ||
Transparent color with a low alpha value used for certain surfaces. | ||
@defaultValue "#00000026"; | ||
*/ | ||
Transparent color with a low alpha value used for certain surfaces. | ||
@defaultValue "#00000026"; | ||
*/ | ||
sbColorSurfaceLow: string; | ||
/** | ||
Transparent color with a high alpha value used for certain surfaces. | ||
@defaultValue "#0000007A"; | ||
*/ | ||
Transparent color with a high alpha value used for certain surfaces. | ||
@defaultValue "#0000007A"; | ||
*/ | ||
sbColorSurfaceHigh: string; | ||
/** | ||
Transparent color with a very high alpha value used to fill certain overlays. | ||
@defaultValue "#000000A3"; | ||
*/ | ||
Transparent color with a very high alpha value used to fill certain overlays. | ||
@defaultValue "#000000A3"; | ||
*/ | ||
sbColorModalOverlay: string; | ||
@@ -90,24 +90,24 @@ /** @param source {@displayType `DeepPartial<Palette>`} */ | ||
/** | ||
Configuration of the text field appearance. | ||
*/ | ||
Configuration of the text field appearance. | ||
*/ | ||
export declare class StyledText extends PartiallyConstructible { | ||
/** | ||
Whether the text field is visible. | ||
@defaultValue true; | ||
*/ | ||
Whether the text field is visible. | ||
@defaultValue true; | ||
*/ | ||
visible: boolean; | ||
/** | ||
Value of the text field. | ||
@defaultValue ""; | ||
*/ | ||
Value of the text field. | ||
@defaultValue ""; | ||
*/ | ||
text: string; | ||
/** | ||
Text color. | ||
@defaultValue "#FFFFFF"; | ||
*/ | ||
Text color. | ||
@defaultValue "#FFFFFF"; | ||
*/ | ||
color: string; | ||
/** | ||
Whether to enable drop shadows for the text. | ||
@defaultValue false; | ||
*/ | ||
Whether to enable drop shadows for the text. | ||
@defaultValue false; | ||
*/ | ||
useShadow: boolean; | ||
@@ -118,14 +118,14 @@ /** @param source {@displayType `DeepPartial<StyledText>`} */ | ||
/** | ||
Configuration of the icon appearance. | ||
*/ | ||
Configuration of the icon appearance. | ||
*/ | ||
export declare class IconStyle extends PartiallyConstructible { | ||
/** | ||
Whether the icon is visible on the button. | ||
@defaultValue true; | ||
*/ | ||
Whether the icon is visible on the button. | ||
@defaultValue true; | ||
*/ | ||
visible: boolean; | ||
/** | ||
Icon color. | ||
@defaultValue "#FFFFFF"; | ||
*/ | ||
Icon color. | ||
@defaultValue "#FFFFFF"; | ||
*/ | ||
color: string; | ||
@@ -136,24 +136,24 @@ /** @param source {@displayType `DeepPartial<IconStyle>`} */ | ||
/** | ||
Configuration of the polygon appearance. | ||
*/ | ||
Configuration of the polygon appearance. | ||
*/ | ||
export declare class PolygonStyle extends PartiallyConstructible { | ||
/** | ||
Color of the polygon outline. | ||
@defaultValue "#FFFFFFFF"; | ||
*/ | ||
Color of the polygon outline. | ||
@defaultValue "#FFFFFFFF"; | ||
*/ | ||
strokeColor: string; | ||
/** | ||
Polygon color. | ||
@defaultValue "#30FFFFFF"; | ||
*/ | ||
Polygon color. | ||
@defaultValue "#FFFFFF30"; | ||
*/ | ||
fillColor: string; | ||
/** | ||
Width of the polygon outline in dp. | ||
@defaultValue 2.0; | ||
*/ | ||
Width of the polygon outline in dp. | ||
@defaultValue 2.0; | ||
*/ | ||
strokeWidth: number; | ||
/** | ||
Polygon corner radius in dp. | ||
@defaultValue 0.0; | ||
*/ | ||
Polygon corner radius in dp. | ||
@defaultValue 0.0; | ||
*/ | ||
cornerRadius: number; | ||
@@ -164,19 +164,19 @@ /** @param source {@displayType `DeepPartial<PolygonStyle>`} */ | ||
/** | ||
Appearance of the polygon used for buttons and hint backgrounds. | ||
*/ | ||
Appearance of the polygon used for buttons and hint backgrounds. | ||
*/ | ||
export declare class BackgroundStyle extends PartiallyConstructible { | ||
/** | ||
Color of the polygon outline. | ||
@defaultValue "#FFFFFFFF"; | ||
*/ | ||
Color of the polygon outline. | ||
@defaultValue "#FFFFFFFF"; | ||
*/ | ||
strokeColor: string; | ||
/** | ||
Polygon color. | ||
@defaultValue "#FFFFFF30"; | ||
*/ | ||
Polygon color. | ||
@defaultValue "#FFFFFF30"; | ||
*/ | ||
fillColor: string; | ||
/** | ||
Width of the polygon outline in dp. | ||
@defaultValue 2.0; | ||
*/ | ||
Width of the polygon outline in dp. | ||
@defaultValue 2.0; | ||
*/ | ||
strokeWidth: number; | ||
@@ -187,19 +187,19 @@ /** @param source {@displayType `DeepPartial<BackgroundStyle>`} */ | ||
/** | ||
Configuration of the appearance of foreground elements (e.g. text and/or icons on buttons, etc). | ||
*/ | ||
Configuration of the appearance of foreground elements (e.g. text and/or icons on buttons, etc). | ||
*/ | ||
export declare class ForegroundStyle extends PartiallyConstructible { | ||
/** | ||
Whether the icon is visible. | ||
@defaultValue true; | ||
*/ | ||
Whether the icon is visible. | ||
@defaultValue true; | ||
*/ | ||
iconVisible: boolean; | ||
/** | ||
Color used for foreground elements. | ||
@defaultValue "#FFFFFF"; | ||
*/ | ||
Color used for foreground elements. | ||
@defaultValue "#FFFFFF"; | ||
*/ | ||
color: string; | ||
/** | ||
Whether to use drop shadows for foreground elements. | ||
@defaultValue false; | ||
*/ | ||
Whether to use drop shadows for foreground elements. | ||
@defaultValue false; | ||
*/ | ||
useShadow: boolean; | ||
@@ -210,29 +210,29 @@ /** @param source {@displayType `DeepPartial<ForegroundStyle>`} */ | ||
/** | ||
Configuration of the round button. | ||
*/ | ||
Configuration of the round button. | ||
*/ | ||
export declare class RoundButton extends PartiallyConstructible { | ||
/** | ||
Whether to display the button. | ||
@defaultValue true; | ||
*/ | ||
Whether to display the button. | ||
@defaultValue true; | ||
*/ | ||
visible: boolean; | ||
/** | ||
Color of the button background shape. | ||
@defaultValue "#0000007A"; | ||
*/ | ||
Color of the button background shape. | ||
@defaultValue "#0000007A"; | ||
*/ | ||
backgroundColor: string; | ||
/** | ||
Color of the button foreground (icon, text). | ||
@defaultValue "#FFFFFF"; | ||
*/ | ||
Color of the button foreground (icon, text). | ||
@defaultValue "#FFFFFF"; | ||
*/ | ||
foregroundColor: string; | ||
/** | ||
Color of the button background shape when the button is active (selected, toggled). | ||
@defaultValue "#FFCE5C"; | ||
*/ | ||
Color of the button background shape when the button is active (selected, toggled). | ||
@defaultValue "#FFCE5C"; | ||
*/ | ||
activeBackgroundColor: string; | ||
/** | ||
Color of the button foreground (icon, text) when the button is active (selected, toggled). | ||
@defaultValue "#1C1B1F"; | ||
*/ | ||
Color of the button foreground (icon, text) when the button is active (selected, toggled). | ||
@defaultValue "#1C1B1F"; | ||
*/ | ||
activeForegroundColor: string; | ||
@@ -243,39 +243,39 @@ /** @param source {@displayType `DeepPartial<RoundButton>`} */ | ||
/** | ||
Configuration of the round button with badge. | ||
*/ | ||
Configuration of the round button with badge. | ||
*/ | ||
export declare class BadgedButton extends PartiallyConstructible { | ||
/** | ||
Color of the badge's background shape. | ||
@defaultValue "#FFFFFF"; | ||
*/ | ||
Color of the badge's background shape. | ||
@defaultValue "#FFFFFF"; | ||
*/ | ||
badgeBackgroundColor: string; | ||
/** | ||
Color of the badge foreground (icon, text). | ||
@defaultValue "#C8193C"; | ||
*/ | ||
Color of the badge foreground (icon, text). | ||
@defaultValue "#C8193C"; | ||
*/ | ||
badgeForegroundColor: string; | ||
/** | ||
Whether the button is visible. | ||
@defaultValue true; | ||
*/ | ||
Whether the button is visible. | ||
@defaultValue true; | ||
*/ | ||
visible: boolean; | ||
/** | ||
Color of the button background shape. | ||
@defaultValue "#0000007A"; | ||
*/ | ||
Color of the button background shape. | ||
@defaultValue "#0000007A"; | ||
*/ | ||
backgroundColor: string; | ||
/** | ||
Color of the button foreground (icon, text). | ||
@defaultValue "#FFFFFF"; | ||
*/ | ||
Color of the button foreground (icon, text). | ||
@defaultValue "#FFFFFF"; | ||
*/ | ||
foregroundColor: string; | ||
/** | ||
Color of the button background shape when the button is active (selected, toggled). | ||
@defaultValue "#FFCE5C"; | ||
*/ | ||
Color of the button background shape when the button is active (selected, toggled). | ||
@defaultValue "#FFCE5C"; | ||
*/ | ||
activeBackgroundColor: string; | ||
/** | ||
Color of the button foreground (icon, text) when the button is active (selected, toggled). | ||
@defaultValue "#1C1B1F"; | ||
*/ | ||
Color of the button foreground (icon, text) when the button is active (selected, toggled). | ||
@defaultValue "#1C1B1F"; | ||
*/ | ||
activeForegroundColor: string; | ||
@@ -286,24 +286,24 @@ /** @param source {@displayType `DeepPartial<BadgedButton>`} */ | ||
/** | ||
Button configuration. | ||
*/ | ||
Button configuration. | ||
*/ | ||
export declare class ButtonConfiguration extends PartiallyConstructible { | ||
/** | ||
Whether the button is visible or not. | ||
@defaultValue true; | ||
*/ | ||
Whether the button is visible or not. | ||
@defaultValue true; | ||
*/ | ||
visible: boolean; | ||
/** | ||
The text to be displayed on the button. | ||
@defaultValue ""; | ||
*/ | ||
The text to be displayed on the button. | ||
@defaultValue ""; | ||
*/ | ||
text: string; | ||
/** | ||
The style of the button's background. | ||
@defaultValue new BackgroundStyle({}); | ||
*/ | ||
The style of the button's background. | ||
@defaultValue new BackgroundStyle({}); | ||
*/ | ||
background: BackgroundStyle; | ||
/** | ||
The style of the button's foreground (icon, text). | ||
@defaultValue new ForegroundStyle({}); | ||
*/ | ||
The style of the button's foreground (icon, text). | ||
@defaultValue new ForegroundStyle({}); | ||
*/ | ||
foreground: ForegroundStyle; | ||
@@ -314,23 +314,23 @@ /** @param source {@displayType `DeepPartial<ButtonConfiguration>`} */ | ||
/** | ||
The sound selection type. | ||
The sound selection type. | ||
- `MODERN_BEEP`: | ||
To choose a modern beep sound. | ||
- `CLASSIC_BEEP`: | ||
To choose the old classic beep sound. | ||
*/ | ||
- `MODERN_BEEP`: | ||
To choose a modern beep sound. | ||
- `CLASSIC_BEEP`: | ||
To choose the old classic beep sound. | ||
*/ | ||
export type SoundType = "MODERN_BEEP" | "CLASSIC_BEEP"; | ||
/** | ||
Sound configuration. | ||
*/ | ||
Sound configuration. | ||
*/ | ||
export declare class Sound extends PartiallyConstructible { | ||
/** | ||
Enable or disable the beep sound when a barcode is detected. | ||
@defaultValue true; | ||
*/ | ||
Enable or disable the beep sound when a barcode is detected. | ||
@defaultValue true; | ||
*/ | ||
successBeepEnabled: boolean; | ||
/** | ||
The beep type. | ||
@defaultValue "MODERN_BEEP"; | ||
*/ | ||
The beep type. | ||
@defaultValue "MODERN_BEEP"; | ||
*/ | ||
soundType: SoundType; | ||
@@ -341,9 +341,9 @@ /** @param source {@displayType `DeepPartial<Sound>`} */ | ||
/** | ||
Vibration configuration. | ||
*/ | ||
Vibration configuration. | ||
*/ | ||
export declare class Vibration extends PartiallyConstructible { | ||
/** | ||
Enable or disable vibration when a barcode is detected. | ||
@defaultValue false; | ||
*/ | ||
Enable or disable vibration when a barcode is detected. | ||
@defaultValue false; | ||
*/ | ||
enabled: boolean; | ||
@@ -354,14 +354,14 @@ /** @param source {@displayType `DeepPartial<Vibration>`} */ | ||
/** | ||
Configuration of timeouts. | ||
*/ | ||
Configuration of timeouts. | ||
*/ | ||
export declare class Timeouts extends PartiallyConstructible { | ||
/** | ||
Sets the auto close timer in ms. Default is 0 (disabled). | ||
@defaultValue 0; | ||
*/ | ||
Sets the auto close timer in ms. Default is 0 (disabled). | ||
@defaultValue 0; | ||
*/ | ||
autoCancelTimeout: number; | ||
/** | ||
Sets the time in ms the first scan is delayed by. Default is 0 (disabled). | ||
@defaultValue 0; | ||
*/ | ||
Sets the time in ms the first scan is delayed by. Default is 0 (disabled). | ||
@defaultValue 0; | ||
*/ | ||
initialScanDelay: number; | ||
@@ -368,0 +368,0 @@ /** @param source {@displayType `DeepPartial<Timeouts>`} */ |
@@ -1,22 +0,27 @@ | ||
import { DeepPartial, PartiallyConstructible } from "./utils"; | ||
import { ArOverlayFindAndPickConfiguration } from "./ArTrackingOverlayConfiguration"; | ||
import { DeepPartial, PartiallyConstructible } from "../common"; | ||
import { ManualCountEditDialog } from "./MultipleScanningModeUseCase"; | ||
import { ScanbotAlertDialog } from "./ScanbotAlertDialog"; | ||
import { SheetContent } from "./MultipleScanningModeUseCase"; | ||
import { Sheet } from "./MultipleScanningModeUseCase"; | ||
/** | ||
Configuration of the barcode to find and scan. | ||
*/ | ||
Configuration of the barcode to find and scan. | ||
*/ | ||
export declare class ExpectedBarcode extends PartiallyConstructible { | ||
/** | ||
Value of the barcode to find. If not set, any barcode value will be accepted. | ||
*/ | ||
Value of the barcode to find. If not set, any barcode value will be accepted. | ||
*/ | ||
barcodeValue: string; | ||
/** | ||
Title of the barcode to find. | ||
*/ | ||
Title of the barcode to find. | ||
*/ | ||
title: string | null; | ||
/** | ||
Image of the barcode to find. | ||
*/ | ||
Image of the barcode to find. | ||
*/ | ||
image: string | null; | ||
/** | ||
Number of barcodes with given symbology/value required to scan. | ||
@defaultValue 1; | ||
*/ | ||
Number of barcodes with given symbology/value required to scan. | ||
@defaultValue 1; | ||
*/ | ||
count: number; | ||
@@ -26,1 +31,348 @@ /** @param source {@displayType `DeepPartial<ExpectedBarcode>`} */ | ||
} | ||
/** | ||
Configuration of the Find and Pick barcode scanning mode. | ||
*/ | ||
export declare class FindAndPickScanningMode extends PartiallyConstructible { | ||
readonly _type: "FindAndPickScanningMode"; | ||
/** | ||
Color of the selected barcode. | ||
@defaultValue "?sbColorPositive"; | ||
*/ | ||
scanningCompletedColor: string; | ||
/** | ||
Color of the partially scanned barcode. | ||
@defaultValue "?sbColorWarning"; | ||
*/ | ||
scanningPartiallyColor: string; | ||
/** | ||
Color of the not scanned barcode . | ||
@defaultValue "?sbColorOutline"; | ||
*/ | ||
scanningNotScannedColor: string; | ||
/** | ||
If the user is allowed to finish the scanning process without scanning all the expected barcodes. | ||
@defaultValue false; | ||
*/ | ||
allowPartialScan: boolean; | ||
/** | ||
List of barcodes that the user has to find and scan. | ||
@defaultValue []; | ||
*/ | ||
expectedBarcodes: ExpectedBarcode[]; | ||
/** | ||
Time interval in milliseconds before a barcode is counted again. 0 = no delay. The default value is 1000. | ||
@defaultValue 1000; | ||
*/ | ||
countingRepeatDelay: number; | ||
/** | ||
Configuration of the preview mode for the barcodes required to be found and scanned. | ||
@defaultValue new Sheet({ | ||
"mode": "COLLAPSED_SHEET", | ||
"collapsedVisibleHeight": "SMALL", | ||
"listButton": new BadgedButton({ | ||
"badgeBackgroundColor": "?sbColorSurface", | ||
"badgeForegroundColor": "?sbColorPrimary", | ||
"visible": true, | ||
"backgroundColor": "?sbColorSurfaceHigh", | ||
"foregroundColor": "?sbColorOnPrimary", | ||
"activeBackgroundColor": "?sbColorSurfaceHigh", | ||
"activeForegroundColor": "?sbColorOnPrimary" | ||
}) | ||
}); | ||
*/ | ||
sheet: Sheet; | ||
/** | ||
Configuration of the list of barcodes required to be found and scanned. | ||
@defaultValue new SheetContent({ | ||
"sheetColor": "?sbColorSurface", | ||
"dividerColor": "?sbColorOutline", | ||
"manualCountChangeEnabled": true, | ||
"manualCountOutlineColor": "?sbColorOutline", | ||
"manualCountChangeColor": "?sbColorPrimary", | ||
"title": new StyledText({ | ||
"visible": true, | ||
"text": "?findAndPickSheetTitle", | ||
"color": "?sbColorOnSurface", | ||
"useShadow": false | ||
}), | ||
"clearAllButton": new ButtonConfiguration({ | ||
"visible": true, | ||
"text": "?sheetResetButton", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "#00000000", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 1.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"iconVisible": false, | ||
"color": "?sbColorOnSurface", | ||
"useShadow": false | ||
}) | ||
}), | ||
"barcodeItemTitle": new StyledText({ | ||
"text": "BARCODE_TITLE", | ||
"color": "?sbColorOnSurface" | ||
}), | ||
"barcodeItemSubtitle": new StyledText({ | ||
"text": "?findAndPickSheetBarcodeItemSubtitle", | ||
"color": "?sbColorOnSurfaceVariant" | ||
}), | ||
"barcodeItemImageVisible": true, | ||
"submitButton": new ButtonConfiguration({ | ||
"visible": true, | ||
"text": "?sheetSubmitButton", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "#00000000", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 1.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"iconVisible": false, | ||
"color": "?sbColorOnSurface", | ||
"useShadow": false | ||
}) | ||
}), | ||
"startScanningButton": new ButtonConfiguration({ | ||
"visible": true, | ||
"text": "?sheetStartScanningButton", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "?sbColorPrimary", | ||
"fillColor": "?sbColorPrimary", | ||
"strokeWidth": 1.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"iconVisible": false, | ||
"color": "?sbColorOnPrimary", | ||
"useShadow": false | ||
}) | ||
}), | ||
"placeholderTitle": new StyledText({ | ||
"text": "?sheetPlaceholderTitle", | ||
"color": "?sbColorOnSurface" | ||
}), | ||
"placeholderSubtitle": new StyledText({ | ||
"text": "?sheetPlaceholderSubtitle", | ||
"color": "?sbColorOnSurfaceVariant" | ||
}), | ||
"placeholderIconBackground": "?sbColorOutline", | ||
"placeholderIcon": new IconStyle({ | ||
"visible": true, | ||
"color": "?sbColorOnSurface" | ||
}), | ||
"swipeToDelete": new SwipeToDelete({ | ||
"enabled": false, | ||
"backgroundColor": "?sbColorNegative", | ||
"iconColor": "?sbColorOnPrimary" | ||
}) | ||
}); | ||
*/ | ||
sheetContent: SheetContent; | ||
/** | ||
Configuration of the dialog to manually edit the barcode count. | ||
@defaultValue new ManualCountEditDialog({ | ||
"sheetColor": "?sbColorSurface", | ||
"dividerColor": "?sbColorOutline", | ||
"modalOverlayColor": "?sbColorModalOverlay", | ||
"title": new StyledText({ | ||
"text": "?manualCountEditDialogTitle", | ||
"color": "?sbColorOnSurface" | ||
}), | ||
"info": new StyledText({ | ||
"text": "?manualCountEditDialogInfo", | ||
"color": "?sbColorOnSurfaceVariant" | ||
}), | ||
"updateButton": new ButtonConfiguration({ | ||
"visible": true, | ||
"text": "?manualCountEditDialogUpdateButton", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "?sbColorPrimary", | ||
"fillColor": "?sbColorPrimary", | ||
"strokeWidth": 1.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"iconVisible": false, | ||
"color": "?sbColorOnPrimary", | ||
"useShadow": false | ||
}) | ||
}), | ||
"cancelButton": new ButtonConfiguration({ | ||
"visible": true, | ||
"text": "?manualCountEditDialogCancelButton", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "#00000000", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 1.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"iconVisible": false, | ||
"color": "?sbColorPrimary", | ||
"useShadow": false | ||
}) | ||
}), | ||
"clearTextButton": new IconStyle({ | ||
"visible": true, | ||
"color": "?sbColorOnSurfaceVariant" | ||
}) | ||
}); | ||
*/ | ||
manualCountEditDialog: ManualCountEditDialog; | ||
/** | ||
Configuration of the AR overlay. | ||
@defaultValue new ArOverlayFindAndPickConfiguration({ | ||
"visible": false, | ||
"automaticSelectionEnabled": true, | ||
"polygon": new FindAndPickArOverlayPolygonConfiguration({ | ||
"partiallyScanned": new PolygonStyle({ | ||
"strokeColor": "?sbColorWarning", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 3.0, | ||
"cornerRadius": 5.0 | ||
}), | ||
"rejected": new PolygonStyle({ | ||
"strokeColor": "?sbColorSurface", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 3.0, | ||
"cornerRadius": 5.0 | ||
}), | ||
"completed": new PolygonStyle({ | ||
"strokeColor": "?sbColorPositive", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 3.0, | ||
"cornerRadius": 5.0 | ||
}) | ||
}), | ||
"badge": new FindAndPickBadgeConfiguration({ | ||
"partiallyScanned": new BadgeStyle({ | ||
"visible": true, | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "#000000FF", | ||
"fillColor": "?sbColorWarning", | ||
"strokeWidth": 0.0 | ||
}), | ||
"foregroundColor": "?sbColorOnSurface" | ||
}), | ||
"rejected": new BadgeStyle({ | ||
"visible": true, | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "#000000FF", | ||
"fillColor": "?sbColorSurface", | ||
"strokeWidth": 0.0 | ||
}), | ||
"foregroundColor": "?sbColorOnSurface" | ||
}), | ||
"completed": new BadgeStyle({ | ||
"visible": true, | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "#000000FF", | ||
"fillColor": "?sbColorPositive", | ||
"strokeWidth": 0.0 | ||
}), | ||
"foregroundColor": "?sbColorOnSurface" | ||
}) | ||
}) | ||
}); | ||
*/ | ||
arOverlay: ArOverlayFindAndPickConfiguration; | ||
/** | ||
If the partial scanned alert dialog is enabled. | ||
@defaultValue true; | ||
*/ | ||
partialScannedAlertDialogEnabled: boolean; | ||
/** | ||
Configuration of the partial scanned alert dialog. | ||
@defaultValue new ScanbotAlertDialog({ | ||
"title": new StyledText({ | ||
"text": "?findAndPickPartialAlertTitle", | ||
"color": "?sbColorOnSurface" | ||
}), | ||
"subtitle": new StyledText({ | ||
"text": "?findAndPickPartialAlertSubtitle", | ||
"color": "?sbColorOnSurfaceVariant" | ||
}), | ||
"sheetColor": "?sbColorSurface", | ||
"modalOverlayColor": "?sbColorModalOverlay", | ||
"dividerColor": "?sbColorOutline", | ||
"okButton": new ButtonConfiguration({ | ||
"visible": true, | ||
"text": "?findAndPickPartialAlertSubmitButton", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "?sbColorPrimary", | ||
"fillColor": "?sbColorPrimary", | ||
"strokeWidth": 1.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"iconVisible": true, | ||
"color": "?sbColorOnPrimary", | ||
"useShadow": false | ||
}) | ||
}), | ||
"cancelButton": new ButtonConfiguration({ | ||
"visible": true, | ||
"text": "?findAndPickPartialAlertCancelButton", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "#00000000", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 1.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"iconVisible": false, | ||
"color": "?sbColorPrimary", | ||
"useShadow": false | ||
}) | ||
}) | ||
}); | ||
*/ | ||
partialScannedAlertDialog: ScanbotAlertDialog; | ||
/** | ||
If the confirmation alert dialog is enabled. | ||
@defaultValue false; | ||
*/ | ||
confirmationAlertDialogEnabled: boolean; | ||
/** | ||
Configuration of the confirmation alert dialog. | ||
@defaultValue new ScanbotAlertDialog({ | ||
"title": new StyledText({ | ||
"text": "?findAndPickCompleteAlertTitle", | ||
"color": "?sbColorOnSurface" | ||
}), | ||
"subtitle": new StyledText({ | ||
"text": "?findAndPickCompleteAlertSubtitle", | ||
"color": "?sbColorOnSurfaceVariant" | ||
}), | ||
"sheetColor": "?sbColorSurface", | ||
"modalOverlayColor": "?sbColorModalOverlay", | ||
"dividerColor": "?sbColorOutline", | ||
"okButton": new ButtonConfiguration({ | ||
"visible": true, | ||
"text": "?findAndPickCompleteAlertSubmitButton", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "?sbColorPrimary", | ||
"fillColor": "?sbColorPrimary", | ||
"strokeWidth": 1.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"iconVisible": true, | ||
"color": "?sbColorOnPrimary", | ||
"useShadow": false | ||
}) | ||
}), | ||
"cancelButton": new ButtonConfiguration({ | ||
"visible": true, | ||
"text": "?findAndPickCompleteAlertCancelButton", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "#00000000", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 1.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"iconVisible": false, | ||
"color": "?sbColorPrimary", | ||
"useShadow": false | ||
}) | ||
}) | ||
}); | ||
*/ | ||
confirmationAlertDialog: ScanbotAlertDialog; | ||
/** @param source {@displayType `DeepPartial<FindAndPickScanningMode>`} */ | ||
constructor(source?: DeepPartial<FindAndPickScanningMode>); | ||
} |
@@ -5,50 +5,50 @@ import { ArOverlayGeneralConfiguration } from "./ArTrackingOverlayConfiguration"; | ||
import { ButtonConfiguration } from "./Common"; | ||
import { DeepPartial, PartiallyConstructible } from "./utils"; | ||
import { DeepPartial, PartiallyConstructible } from "../common"; | ||
import { IconStyle } from "./Common"; | ||
import { StyledText } from "./Common"; | ||
/** | ||
Configuration of the mode used for scanning multiple barcodes. | ||
Configuration of the mode used for scanning multiple barcodes. | ||
- `COUNTING`: | ||
Scan barcodes even if they have the same value and count the number of repeated barcodes. | ||
- `UNIQUE`: | ||
Only scan barcodes with unique values. Subsequent barcodes with the same values will be ignored. | ||
*/ | ||
- `COUNTING`: | ||
Scan barcodes even if they have the same value and count the number of repeated barcodes. | ||
- `UNIQUE`: | ||
Only scan barcodes with unique values. Subsequent barcodes with the same values will be ignored. | ||
*/ | ||
export type MultipleBarcodesScanningMode = "COUNTING" | "UNIQUE"; | ||
/** | ||
Configuration of the barcode result sheet's default visibility state. | ||
Configuration of the barcode result sheet's default visibility state. | ||
- `BUTTON`: | ||
Result sheet is hidden and can be opened by pressing the button. The button can show the total barcode count. | ||
- `COLLAPSED_SHEET`: | ||
Result sheet is visible and collapsed and can be expanded by dragging it up. | ||
*/ | ||
- `BUTTON`: | ||
Result sheet is hidden and can be opened by pressing the button. The button can show the total barcode count. | ||
- `COLLAPSED_SHEET`: | ||
Result sheet is visible and collapsed and can be expanded by dragging it up. | ||
*/ | ||
export type SheetMode = "BUTTON" | "COLLAPSED_SHEET"; | ||
/** | ||
Configuration of the barcodes result sheet's height while collapsed. | ||
Configuration of the barcodes result sheet's height while collapsed. | ||
- `SMALL`: | ||
Result sheet is collapsed as much as possible, showing only the top part. | ||
- `LARGE`: | ||
Result sheet is not completely collapsed, revealing more information. | ||
*/ | ||
- `SMALL`: | ||
Result sheet is collapsed as much as possible, showing only the top part. | ||
- `LARGE`: | ||
Result sheet is not completely collapsed, revealing more information. | ||
*/ | ||
export type CollapsedVisibleHeight = "SMALL" | "LARGE"; | ||
/** | ||
Configuration of the preview mode for scanning multiple barcodes. | ||
*/ | ||
Configuration of the preview mode for scanning multiple barcodes. | ||
*/ | ||
export declare class Sheet extends PartiallyConstructible { | ||
/** | ||
Mode used for the preview for scanning multiple barcodes. | ||
@defaultValue "COLLAPSED_SHEET"; | ||
*/ | ||
Mode used for the preview for scanning multiple barcodes. | ||
@defaultValue "COLLAPSED_SHEET"; | ||
*/ | ||
mode: SheetMode; | ||
/** | ||
Height of the collapsed result sheet. | ||
@defaultValue "SMALL"; | ||
*/ | ||
Height of the collapsed result sheet. | ||
@defaultValue "SMALL"; | ||
*/ | ||
collapsedVisibleHeight: CollapsedVisibleHeight; | ||
/** | ||
Configuration of the list button. | ||
@defaultValue new BadgedButton({}); | ||
*/ | ||
Configuration of the list button. | ||
@defaultValue new BadgedButton({}); | ||
*/ | ||
listButton: BadgedButton; | ||
@@ -59,19 +59,19 @@ /** @param source {@displayType `DeepPartial<Sheet>`} */ | ||
/** | ||
Configuration of the swipe-to-delete button. | ||
*/ | ||
Configuration of the swipe-to-delete button. | ||
*/ | ||
export declare class SwipeToDelete extends PartiallyConstructible { | ||
/** | ||
Whether swipe to delete is enabled or not. | ||
@defaultValue true; | ||
*/ | ||
Whether swipe to delete is enabled or not. | ||
@defaultValue true; | ||
*/ | ||
enabled: boolean; | ||
/** | ||
Color of the swipe-to-delete button. | ||
@defaultValue "?sbColorNegative"; | ||
*/ | ||
Color of the swipe-to-delete button. | ||
@defaultValue "?sbColorNegative"; | ||
*/ | ||
backgroundColor: string; | ||
/** | ||
Color of the icon on the swipe-to-delete button. | ||
@defaultValue "?sbColorOnPrimary"; | ||
*/ | ||
Color of the icon on the swipe-to-delete button. | ||
@defaultValue "?sbColorOnPrimary"; | ||
*/ | ||
iconColor: string; | ||
@@ -82,79 +82,79 @@ /** @param source {@displayType `DeepPartial<SwipeToDelete>`} */ | ||
/** | ||
Configuration of the dialog to manually edit the barcode count. | ||
*/ | ||
Configuration of the dialog to manually edit the barcode count. | ||
*/ | ||
export declare class ManualCountEditDialog extends PartiallyConstructible { | ||
/** | ||
Color of the edit dialog's background. | ||
@defaultValue "?sbColorSurface"; | ||
*/ | ||
Color of the edit dialog's background. | ||
@defaultValue "?sbColorSurface"; | ||
*/ | ||
sheetColor: string; | ||
/** | ||
Color of the divider and separator lines in the edit dialog. | ||
@defaultValue "?sbColorOutline"; | ||
*/ | ||
Color of the divider and separator lines in the edit dialog. | ||
@defaultValue "?sbColorOutline"; | ||
*/ | ||
dividerColor: string; | ||
/** | ||
Background color of the overlay surrounding the edit dialog. | ||
@defaultValue "?sbColorModalOverlay"; | ||
*/ | ||
Background color of the overlay surrounding the edit dialog. | ||
@defaultValue "?sbColorModalOverlay"; | ||
*/ | ||
modalOverlayColor: string; | ||
/** | ||
Configuration of the edit dialog's title. | ||
@defaultValue new StyledText({ | ||
"text": "Update count", | ||
"color": "?sbColorOnSurface" | ||
Configuration of the edit dialog's title. | ||
@defaultValue new StyledText({ | ||
"text": "Update count", | ||
"color": "?sbColorOnSurface" | ||
}); | ||
*/ | ||
*/ | ||
title: StyledText; | ||
/** | ||
Configuration of the edit dialog's info text. | ||
@defaultValue new StyledText({ | ||
"text": "Adjust the number of items you scanned.", | ||
"color": "?sbColorOnSurfaceVariant" | ||
}); | ||
*/ | ||
Configuration of the edit dialog's info text. | ||
@defaultValue new StyledText({ | ||
"text": "Adjust the number of items you scanned.", | ||
"color": "?sbColorOnSurfaceVariant" | ||
}); | ||
*/ | ||
info: StyledText; | ||
/** | ||
Configuration of the edit dialog's confirm button. Hiding both the update and cancel buttons simultaneously is an undefined behavior. | ||
@defaultValue new ButtonConfiguration({ | ||
"visible": true, | ||
"text": "Update", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "?sbColorPrimary", | ||
"fillColor": "?sbColorPrimary", | ||
"strokeWidth": 1.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"iconVisible": false, | ||
"color": "?sbColorOnPrimary", | ||
"useShadow": false | ||
}) | ||
}); | ||
*/ | ||
Configuration of the edit dialog's confirm button. Hiding both the update and cancel buttons simultaneously is an undefined behavior. | ||
@defaultValue new ButtonConfiguration({ | ||
"visible": true, | ||
"text": "Update", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "?sbColorPrimary", | ||
"fillColor": "?sbColorPrimary", | ||
"strokeWidth": 1.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"iconVisible": false, | ||
"color": "?sbColorOnPrimary", | ||
"useShadow": false | ||
}) | ||
}); | ||
*/ | ||
updateButton: ButtonConfiguration; | ||
/** | ||
Configuration of the edit dialog's cancel button. Hiding both the update and cancel buttons simultaneously is an undefined behavior. | ||
@defaultValue new ButtonConfiguration({ | ||
"visible": true, | ||
"text": "Cancel", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "#00000000", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 1.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"iconVisible": false, | ||
"color": "?sbColorPrimary", | ||
"useShadow": false | ||
}) | ||
}); | ||
*/ | ||
Configuration of the edit dialog's cancel button. Hiding both the update and cancel buttons simultaneously is an undefined behavior. | ||
@defaultValue new ButtonConfiguration({ | ||
"visible": true, | ||
"text": "Cancel", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "#00000000", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 1.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"iconVisible": false, | ||
"color": "?sbColorPrimary", | ||
"useShadow": false | ||
}) | ||
}); | ||
*/ | ||
cancelButton: ButtonConfiguration; | ||
/** | ||
Configuration of the edit dialog's button to clear the entered count number. | ||
@defaultValue new IconStyle({ | ||
"visible": true, | ||
"color": "?sbColorOnSurfaceVariant" | ||
Configuration of the edit dialog's button to clear the entered count number. | ||
@defaultValue new IconStyle({ | ||
"visible": true, | ||
"color": "?sbColorOnSurfaceVariant" | ||
}); | ||
*/ | ||
*/ | ||
clearTextButton: IconStyle; | ||
@@ -165,152 +165,152 @@ /** @param source {@displayType `DeepPartial<ManualCountEditDialog>`} */ | ||
/** | ||
Configuration of the list containing the barcodes that have already been scanned. | ||
*/ | ||
Configuration of the list containing the barcodes that have already been scanned. | ||
*/ | ||
export declare class SheetContent extends PartiallyConstructible { | ||
/** | ||
Color of the list's background. | ||
@defaultValue "?sbColorSurface"; | ||
*/ | ||
Color of the list's background. | ||
@defaultValue "?sbColorSurface"; | ||
*/ | ||
sheetColor: string; | ||
/** | ||
The color of the dividers in the list sheet. | ||
@defaultValue "?sbColorOutline"; | ||
*/ | ||
The color of the dividers in the list sheet. | ||
@defaultValue "?sbColorOutline"; | ||
*/ | ||
dividerColor: string; | ||
/** | ||
Enables the user to change the number of scanned items by pressing +,-, or changing the number using a keyboard. | ||
@defaultValue true; | ||
*/ | ||
Enables the user to change the number of scanned items by pressing +,-, or changing the number using a keyboard. | ||
@defaultValue true; | ||
*/ | ||
manualCountChangeEnabled: boolean; | ||
/** | ||
The color of the outline of the manual counting buttons in the list sheet. | ||
@defaultValue "?sbColorOutline"; | ||
*/ | ||
The color of the outline of the manual counting buttons in the list sheet. | ||
@defaultValue "?sbColorOutline"; | ||
*/ | ||
manualCountOutlineColor: string; | ||
/** | ||
Color of the buttons for manually changing the barcode count. | ||
@defaultValue "?sbColorPrimary"; | ||
*/ | ||
Color of the buttons for manually changing the barcode count. | ||
@defaultValue "?sbColorPrimary"; | ||
*/ | ||
manualCountChangeColor: string; | ||
/** | ||
Configuration of the barcode list's title. By default displays the total number of scanned barcodes. | ||
@defaultValue new StyledText({ | ||
"text": "%d items", | ||
"color": "?sbColorOnSurface" | ||
Configuration of the barcode list's title. By default displays the total number of scanned barcodes. | ||
@defaultValue new StyledText({ | ||
"text": "%d items", | ||
"color": "?sbColorOnSurface" | ||
}); | ||
*/ | ||
*/ | ||
title: StyledText; | ||
/** | ||
Configuration of the button for clearing the barcode list. | ||
@defaultValue new ButtonConfiguration({ | ||
"visible": true, | ||
"text": "Clear all", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "#00000000", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 1.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"iconVisible": false, | ||
"color": "?sbColorOnSurface", | ||
"useShadow": false | ||
}) | ||
}); | ||
*/ | ||
Configuration of the button for clearing the barcode list. | ||
@defaultValue new ButtonConfiguration({ | ||
"visible": true, | ||
"text": "Clear all", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "#00000000", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 1.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"iconVisible": false, | ||
"color": "?sbColorOnSurface", | ||
"useShadow": false | ||
}) | ||
}); | ||
*/ | ||
clearAllButton: ButtonConfiguration; | ||
/** | ||
Configuration of the title of a barcode list entry (displaying the barcode's value). | ||
@defaultValue new StyledText({ | ||
"visible": true, | ||
"text": "BARCODE_TITLE", | ||
"color": "?sbColorOnSurface", | ||
"useShadow": false | ||
}); | ||
*/ | ||
Configuration of the title of a barcode list entry (displaying the barcode's value). | ||
@defaultValue new StyledText({ | ||
"visible": true, | ||
"text": "BARCODE_TITLE", | ||
"color": "?sbColorOnSurface", | ||
"useShadow": false | ||
}); | ||
*/ | ||
barcodeItemTitle: StyledText; | ||
/** | ||
Configuration of the subtitle of a barcode list entry (displaying the barcode's symbology). | ||
@defaultValue new StyledText({ | ||
"text": "BARCODE_SUBTITLE", | ||
"color": "?sbColorOnSurfaceVariant" | ||
}); | ||
*/ | ||
Configuration of the subtitle of a barcode list entry (displaying the barcode's symbology). | ||
@defaultValue new StyledText({ | ||
"text": "BARCODE_SUBTITLE", | ||
"color": "?sbColorOnSurfaceVariant" | ||
}); | ||
*/ | ||
barcodeItemSubtitle: StyledText; | ||
/** | ||
Visibility of the barcode image in a barcode list entry. | ||
@defaultValue true; | ||
*/ | ||
Visibility of the barcode image in a barcode list entry. | ||
@defaultValue true; | ||
*/ | ||
barcodeItemImageVisible: boolean; | ||
/** | ||
Configuration of the barcode list's submit button. | ||
@defaultValue new ButtonConfiguration({ | ||
"visible": true, | ||
"text": "Submit", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "#00000000", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 1.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"iconVisible": false, | ||
"color": "?sbColorOnSurface", | ||
"useShadow": false | ||
}) | ||
}); | ||
*/ | ||
Configuration of the barcode list's submit button. | ||
@defaultValue new ButtonConfiguration({ | ||
"visible": true, | ||
"text": "Submit", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "#00000000", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 1.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"iconVisible": false, | ||
"color": "?sbColorOnSurface", | ||
"useShadow": false | ||
}) | ||
}); | ||
*/ | ||
submitButton: ButtonConfiguration; | ||
/** | ||
Configuration of the button to start scanning displayed in an empty barcode list. | ||
@defaultValue new ButtonConfiguration({ | ||
"visible": true, | ||
"text": "Start scanning", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "?sbColorPrimary", | ||
"fillColor": "?sbColorPrimary", | ||
"strokeWidth": 1.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"iconVisible": true, | ||
"color": "?sbColorOnPrimary", | ||
"useShadow": false | ||
}) | ||
}); | ||
*/ | ||
Configuration of the button to start scanning displayed in an empty barcode list. | ||
@defaultValue new ButtonConfiguration({ | ||
"visible": true, | ||
"text": "Start scanning", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "?sbColorPrimary", | ||
"fillColor": "?sbColorPrimary", | ||
"strokeWidth": 1.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"iconVisible": true, | ||
"color": "?sbColorOnPrimary", | ||
"useShadow": false | ||
}) | ||
}); | ||
*/ | ||
startScanningButton: ButtonConfiguration; | ||
/** | ||
Configuration of the title displayed in an empty barcode list. | ||
@defaultValue new StyledText({ | ||
"text": "No barcodes here!", | ||
"color": "?sbColorOnSurface" | ||
Configuration of the title displayed in an empty barcode list. | ||
@defaultValue new StyledText({ | ||
"text": "No barcodes here!", | ||
"color": "?sbColorOnSurface" | ||
}); | ||
*/ | ||
*/ | ||
placeholderTitle: StyledText; | ||
/** | ||
Configuration of the subtitle displayed in an empty barcode list. | ||
@defaultValue new StyledText({ | ||
"text": "The barcode list is currently empty. Close this sheet and scan your items to add them.", | ||
"color": "?sbColorOnSurfaceVariant" | ||
}); | ||
*/ | ||
Configuration of the subtitle displayed in an empty barcode list. | ||
@defaultValue new StyledText({ | ||
"text": "The barcode list is currently empty. Close this sheet and scan your items to add them.", | ||
"color": "?sbColorOnSurfaceVariant" | ||
}); | ||
*/ | ||
placeholderSubtitle: StyledText; | ||
/** | ||
Background color of the icon displayed in an empty barcode list. | ||
@defaultValue "?sbColorOutline"; | ||
*/ | ||
Background color of the icon displayed in an empty barcode list. | ||
@defaultValue "?sbColorOutline"; | ||
*/ | ||
placeholderIconBackground: string; | ||
/** | ||
Configuration of the icon displayed in an empty barcode list. | ||
@defaultValue new IconStyle({ | ||
"visible": true, | ||
"color": "?sbColorOnSurface" | ||
Configuration of the icon displayed in an empty barcode list. | ||
@defaultValue new IconStyle({ | ||
"visible": true, | ||
"color": "?sbColorOnSurface" | ||
}); | ||
*/ | ||
*/ | ||
placeholderIcon: IconStyle; | ||
/** | ||
The style of the swipe-to-delete button. | ||
@defaultValue new SwipeToDelete({ | ||
"enabled": true, | ||
"backgroundColor": "?sbColorNegative", | ||
"iconColor": "?sbColorOnPrimary" | ||
}); | ||
*/ | ||
The style of the swipe-to-delete button. | ||
@defaultValue new SwipeToDelete({ | ||
"enabled": true, | ||
"backgroundColor": "?sbColorNegative", | ||
"iconColor": "?sbColorOnPrimary" | ||
}); | ||
*/ | ||
swipeToDelete: SwipeToDelete; | ||
@@ -321,292 +321,292 @@ /** @param source {@displayType `DeepPartial<SheetContent>`} */ | ||
/** | ||
Configuration of the mode for scanning multiple barcodes. | ||
*/ | ||
Configuration of the mode for scanning multiple barcodes. | ||
*/ | ||
export declare class MultipleScanningMode extends PartiallyConstructible { | ||
readonly _type: "MultipleScanningMode"; | ||
/** | ||
Time interval in milliseconds before a barcode is counted again. 0 = no delay. The default value is 1000. | ||
@defaultValue 1000; | ||
*/ | ||
Time interval in milliseconds before a barcode is counted again. 0 = no delay. The default value is 1000. | ||
@defaultValue 1000; | ||
*/ | ||
countingRepeatDelay: number; | ||
/** | ||
Mode used for scanning multiple barcodes. | ||
@defaultValue "COUNTING"; | ||
*/ | ||
Mode used for scanning multiple barcodes. | ||
@defaultValue "COUNTING"; | ||
*/ | ||
mode: MultipleBarcodesScanningMode; | ||
/** | ||
Configuration of the preview mode for scanning multiple barcodes. | ||
@defaultValue new Sheet({ | ||
"mode": "COLLAPSED_SHEET", | ||
"collapsedVisibleHeight": "SMALL", | ||
"listButton": new BadgedButton({ | ||
"badgeBackgroundColor": "?sbColorSurface", | ||
"badgeForegroundColor": "?sbColorPrimary", | ||
"visible": true, | ||
"backgroundColor": "?sbColorSurfaceHigh", | ||
"foregroundColor": "?sbColorOnPrimary", | ||
"activeBackgroundColor": "?sbColorSurfaceHigh", | ||
"activeForegroundColor": "?sbColorOnPrimary" | ||
}) | ||
}); | ||
*/ | ||
Configuration of the preview mode for scanning multiple barcodes. | ||
@defaultValue new Sheet({ | ||
"mode": "COLLAPSED_SHEET", | ||
"collapsedVisibleHeight": "SMALL", | ||
"listButton": new BadgedButton({ | ||
"badgeBackgroundColor": "?sbColorSurface", | ||
"badgeForegroundColor": "?sbColorPrimary", | ||
"visible": true, | ||
"backgroundColor": "?sbColorSurfaceHigh", | ||
"foregroundColor": "?sbColorOnPrimary", | ||
"activeBackgroundColor": "?sbColorSurfaceHigh", | ||
"activeForegroundColor": "?sbColorOnPrimary" | ||
}) | ||
}); | ||
*/ | ||
sheet: Sheet; | ||
/** | ||
Configuration of the list containing the barcodes that have already been scanned. | ||
@defaultValue new SheetContent({ | ||
"sheetColor": "?sbColorSurface", | ||
"dividerColor": "?sbColorOutline", | ||
"manualCountChangeEnabled": true, | ||
"manualCountOutlineColor": "?sbColorOutline", | ||
"manualCountChangeColor": "?sbColorPrimary", | ||
"title": new StyledText({ | ||
"text": "?multipleModeSheetTitle", | ||
"color": "?sbColorOnSurface" | ||
}), | ||
"clearAllButton": new ButtonConfiguration({ | ||
"visible": true, | ||
"text": "?sheetClearAllButton", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "#00000000", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 1.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"iconVisible": false, | ||
"color": "?sbColorOnSurface", | ||
"useShadow": false | ||
}) | ||
}), | ||
"barcodeItemTitle": new StyledText({ | ||
"visible": true, | ||
"text": "BARCODE_TITLE", | ||
"color": "?sbColorOnSurface", | ||
"useShadow": false | ||
}), | ||
"barcodeItemSubtitle": new StyledText({ | ||
"visible": true, | ||
"text": "BARCODE_SUBTITLE", | ||
"color": "?sbColorOnSurfaceVariant", | ||
"useShadow": false | ||
}), | ||
"barcodeItemImageVisible": true, | ||
"submitButton": new ButtonConfiguration({ | ||
"visible": true, | ||
"text": "?sheetSubmitButton", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "#00000000", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 1.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"iconVisible": false, | ||
"color": "?sbColorOnSurface", | ||
"useShadow": false | ||
}) | ||
}), | ||
"startScanningButton": new ButtonConfiguration({ | ||
"visible": true, | ||
"text": "?sheetStartScanningButton", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "?sbColorPrimary", | ||
"fillColor": "?sbColorPrimary", | ||
"strokeWidth": 1.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"iconVisible": false, | ||
"color": "?sbColorOnPrimary", | ||
"useShadow": false | ||
}) | ||
}), | ||
"placeholderTitle": new StyledText({ | ||
"visible": true, | ||
"text": "?sheetPlaceholderTitle", | ||
"color": "?sbColorOnSurface", | ||
"useShadow": false | ||
}), | ||
"placeholderSubtitle": new StyledText({ | ||
"visible": true, | ||
"text": "?sheetPlaceholderSubtitle", | ||
"color": "?sbColorOnSurfaceVariant", | ||
"useShadow": false | ||
}), | ||
"placeholderIconBackground": "?sbColorOutline", | ||
"placeholderIcon": new IconStyle({ | ||
"visible": true, | ||
"color": "?sbColorOnSurface" | ||
}), | ||
"swipeToDelete": new SwipeToDelete({ | ||
"enabled": true, | ||
"backgroundColor": "?sbColorNegative", | ||
"iconColor": "?sbColorOnPrimary" | ||
}) | ||
}); | ||
*/ | ||
Configuration of the list containing the barcodes that have already been scanned. | ||
@defaultValue new SheetContent({ | ||
"sheetColor": "?sbColorSurface", | ||
"dividerColor": "?sbColorOutline", | ||
"manualCountChangeEnabled": true, | ||
"manualCountOutlineColor": "?sbColorOutline", | ||
"manualCountChangeColor": "?sbColorPrimary", | ||
"title": new StyledText({ | ||
"text": "?multipleModeSheetTitle", | ||
"color": "?sbColorOnSurface" | ||
}), | ||
"clearAllButton": new ButtonConfiguration({ | ||
"visible": true, | ||
"text": "?sheetClearAllButton", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "#00000000", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 1.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"iconVisible": false, | ||
"color": "?sbColorOnSurface", | ||
"useShadow": false | ||
}) | ||
}), | ||
"barcodeItemTitle": new StyledText({ | ||
"visible": true, | ||
"text": "BARCODE_TITLE", | ||
"color": "?sbColorOnSurface", | ||
"useShadow": false | ||
}), | ||
"barcodeItemSubtitle": new StyledText({ | ||
"visible": true, | ||
"text": "BARCODE_SUBTITLE", | ||
"color": "?sbColorOnSurfaceVariant", | ||
"useShadow": false | ||
}), | ||
"barcodeItemImageVisible": true, | ||
"submitButton": new ButtonConfiguration({ | ||
"visible": true, | ||
"text": "?sheetSubmitButton", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "#00000000", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 1.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"iconVisible": false, | ||
"color": "?sbColorOnSurface", | ||
"useShadow": false | ||
}) | ||
}), | ||
"startScanningButton": new ButtonConfiguration({ | ||
"visible": true, | ||
"text": "?sheetStartScanningButton", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "?sbColorPrimary", | ||
"fillColor": "?sbColorPrimary", | ||
"strokeWidth": 1.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"iconVisible": false, | ||
"color": "?sbColorOnPrimary", | ||
"useShadow": false | ||
}) | ||
}), | ||
"placeholderTitle": new StyledText({ | ||
"visible": true, | ||
"text": "?sheetPlaceholderTitle", | ||
"color": "?sbColorOnSurface", | ||
"useShadow": false | ||
}), | ||
"placeholderSubtitle": new StyledText({ | ||
"visible": true, | ||
"text": "?sheetPlaceholderSubtitle", | ||
"color": "?sbColorOnSurfaceVariant", | ||
"useShadow": false | ||
}), | ||
"placeholderIconBackground": "?sbColorOutline", | ||
"placeholderIcon": new IconStyle({ | ||
"visible": true, | ||
"color": "?sbColorOnSurface" | ||
}), | ||
"swipeToDelete": new SwipeToDelete({ | ||
"enabled": true, | ||
"backgroundColor": "?sbColorNegative", | ||
"iconColor": "?sbColorOnPrimary" | ||
}) | ||
}); | ||
*/ | ||
sheetContent: SheetContent; | ||
/** | ||
Configuration of the dialog to manually edit the barcode count. | ||
@defaultValue new ManualCountEditDialog({ | ||
"sheetColor": "?sbColorSurface", | ||
"dividerColor": "?sbColorOutline", | ||
"modalOverlayColor": "?sbColorModalOverlay", | ||
"title": new StyledText({ | ||
"text": "?manualCountEditDialogTitle", | ||
"color": "?sbColorOnSurface" | ||
}), | ||
"info": new StyledText({ | ||
"text": "?manualCountEditDialogInfo", | ||
"color": "?sbColorOnSurfaceVariant" | ||
}), | ||
"updateButton": new ButtonConfiguration({ | ||
"visible": true, | ||
"text": "?manualCountEditDialogUpdateButton", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "?sbColorPrimary", | ||
"fillColor": "?sbColorPrimary", | ||
"strokeWidth": 1.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"iconVisible": false, | ||
"color": "?sbColorOnPrimary", | ||
"useShadow": false | ||
}) | ||
}), | ||
"cancelButton": new ButtonConfiguration({ | ||
"visible": true, | ||
"text": "?manualCountEditDialogCancelButton", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "#00000000", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 1.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"iconVisible": false, | ||
"color": "?sbColorPrimary", | ||
"useShadow": false | ||
}) | ||
}), | ||
"clearTextButton": new IconStyle({ | ||
"visible": true, | ||
"color": "?sbColorOnSurfaceVariant" | ||
}) | ||
}); | ||
*/ | ||
Configuration of the dialog to manually edit the barcode count. | ||
@defaultValue new ManualCountEditDialog({ | ||
"sheetColor": "?sbColorSurface", | ||
"dividerColor": "?sbColorOutline", | ||
"modalOverlayColor": "?sbColorModalOverlay", | ||
"title": new StyledText({ | ||
"text": "?manualCountEditDialogTitle", | ||
"color": "?sbColorOnSurface" | ||
}), | ||
"info": new StyledText({ | ||
"text": "?manualCountEditDialogInfo", | ||
"color": "?sbColorOnSurfaceVariant" | ||
}), | ||
"updateButton": new ButtonConfiguration({ | ||
"visible": true, | ||
"text": "?manualCountEditDialogUpdateButton", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "?sbColorPrimary", | ||
"fillColor": "?sbColorPrimary", | ||
"strokeWidth": 1.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"iconVisible": false, | ||
"color": "?sbColorOnPrimary", | ||
"useShadow": false | ||
}) | ||
}), | ||
"cancelButton": new ButtonConfiguration({ | ||
"visible": true, | ||
"text": "?manualCountEditDialogCancelButton", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "#00000000", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 1.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"iconVisible": false, | ||
"color": "?sbColorPrimary", | ||
"useShadow": false | ||
}) | ||
}), | ||
"clearTextButton": new IconStyle({ | ||
"visible": true, | ||
"color": "?sbColorOnSurfaceVariant" | ||
}) | ||
}); | ||
*/ | ||
manualCountEditDialog: ManualCountEditDialog; | ||
/** | ||
Appearance of the barcode info mapping. | ||
@defaultValue new BarcodeInfoMapping({ | ||
"sheetColor": "?sbColorSurface", | ||
"dividerColor": "?sbColorOutline", | ||
"modalOverlayColor": "?sbColorModalOverlay", | ||
"loadingMessage": new StyledText({ | ||
"text": "?barcodeInfoMappingLoadingMessage", | ||
"color": "?sbColorPrimary" | ||
}), | ||
"errorState": new BarcodeItemErrorState({ | ||
"title": new StyledText({ | ||
"text": "?barcodeInfoMappingErrorStateTitle", | ||
"color": "?sbColorOnSurface" | ||
}), | ||
"subtitle": new StyledText({ | ||
"text": "?barcodeInfoMappingErrorStateSubtitle", | ||
"color": "?sbColorOnSurfaceVariant" | ||
}), | ||
"retryButton": new ButtonConfiguration({ | ||
"visible": true, | ||
"text": "?barcodeInfoMappingErrorStateRetryButton", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "?sbColorPrimary", | ||
"fillColor": "?sbColorPrimary", | ||
"strokeWidth": 1.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"iconVisible": true, | ||
"color": "?sbColorOnPrimary", | ||
"useShadow": false | ||
}) | ||
}), | ||
"cancelButton": new ButtonConfiguration({ | ||
"visible": true, | ||
"text": "?barcodeInfoMappingErrorStateCancelButton", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "#00000000", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 1.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"iconVisible": false, | ||
"color": "?sbColorPrimary", | ||
"useShadow": false | ||
}) | ||
}) | ||
}) | ||
}); | ||
*/ | ||
Appearance of the barcode info mapping. | ||
@defaultValue new BarcodeInfoMapping({ | ||
"sheetColor": "?sbColorSurface", | ||
"dividerColor": "?sbColorOutline", | ||
"modalOverlayColor": "?sbColorModalOverlay", | ||
"loadingMessage": new StyledText({ | ||
"text": "?barcodeInfoMappingLoadingMessage", | ||
"color": "?sbColorPrimary" | ||
}), | ||
"errorState": new BarcodeItemErrorState({ | ||
"title": new StyledText({ | ||
"text": "?barcodeInfoMappingErrorStateTitle", | ||
"color": "?sbColorOnSurface" | ||
}), | ||
"subtitle": new StyledText({ | ||
"text": "?barcodeInfoMappingErrorStateSubtitle", | ||
"color": "?sbColorOnSurfaceVariant" | ||
}), | ||
"retryButton": new ButtonConfiguration({ | ||
"visible": true, | ||
"text": "?barcodeInfoMappingErrorStateRetryButton", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "?sbColorPrimary", | ||
"fillColor": "?sbColorPrimary", | ||
"strokeWidth": 1.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"iconVisible": true, | ||
"color": "?sbColorOnPrimary", | ||
"useShadow": false | ||
}) | ||
}), | ||
"cancelButton": new ButtonConfiguration({ | ||
"visible": true, | ||
"text": "?barcodeInfoMappingErrorStateCancelButton", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "#00000000", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 1.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"iconVisible": false, | ||
"color": "?sbColorPrimary", | ||
"useShadow": false | ||
}) | ||
}) | ||
}) | ||
}); | ||
*/ | ||
barcodeInfoMapping: BarcodeInfoMapping; | ||
/** | ||
Configuration of the AR overlay. | ||
@defaultValue new ArOverlayGeneralConfiguration({ | ||
"visible": false, | ||
"counterBadge": new BadgeStyle({ | ||
"visible": true, | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "#FF000000", | ||
"fillColor": "?sbColorPositive", | ||
"strokeWidth": 0.0 | ||
}), | ||
"foregroundColor": "?sbColorOnSurface" | ||
}), | ||
"automaticSelectionEnabled": false, | ||
"barcodeItemInfoPosition": "BELOW", | ||
"polygon": new ArOverlayPolygonConfiguration({ | ||
"visible": true, | ||
"deselected": new PolygonStyle({ | ||
"strokeColor": "?sbColorSurface", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 3.0, | ||
"cornerRadius": 5.0 | ||
}), | ||
"selected": new PolygonStyle({ | ||
"strokeColor": "?sbColorPositive", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 3.0, | ||
"cornerRadius": 5.0 | ||
}) | ||
}), | ||
"barcodeItemConfiguration": new BarcodeItemConfiguration({ | ||
"imageVisible": true, | ||
"titleSelected": new StyledText({ | ||
"text": "BARCODE_TITLE", | ||
"color": "?sbColorOnSurface" | ||
}), | ||
"subtitleSelected": new StyledText({ | ||
"visible": true, | ||
"text": "BARCODE_SUBTITLE", | ||
"color": "?sbColorOnSurfaceVariant", | ||
"useShadow": false | ||
}), | ||
"titleDeselected": new StyledText({ | ||
"visible": true, | ||
"text": "BARCODE_TITLE", | ||
"color": "?sbColorOnSurface", | ||
"useShadow": false | ||
}), | ||
"subtitleDeselected": new StyledText({ | ||
"text": "BARCODE_SUBTITLE", | ||
"color": "?sbColorOnSurfaceVariant" | ||
}), | ||
"backgroundSelected": new PolygonStyle({ | ||
"strokeColor": "?sbColorPositive", | ||
"fillColor": "?sbColorPositive", | ||
"strokeWidth": 1.0, | ||
"cornerRadius": 5.0 | ||
}), | ||
"backgroundDeselected": new PolygonStyle({ | ||
"strokeColor": "?sbColorSurface", | ||
"fillColor": "?sbColorSurface", | ||
"strokeWidth": 1.0, | ||
"cornerRadius": 5.0 | ||
}) | ||
}) | ||
}); | ||
*/ | ||
Configuration of the AR overlay. | ||
@defaultValue new ArOverlayGeneralConfiguration({ | ||
"visible": false, | ||
"counterBadge": new BadgeStyle({ | ||
"visible": true, | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "#FF000000", | ||
"fillColor": "?sbColorPositive", | ||
"strokeWidth": 0.0 | ||
}), | ||
"foregroundColor": "?sbColorOnSurface" | ||
}), | ||
"automaticSelectionEnabled": false, | ||
"barcodeItemInfoPosition": "BELOW", | ||
"polygon": new ArOverlayPolygonConfiguration({ | ||
"visible": true, | ||
"deselected": new PolygonStyle({ | ||
"strokeColor": "?sbColorSurface", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 3.0, | ||
"cornerRadius": 5.0 | ||
}), | ||
"selected": new PolygonStyle({ | ||
"strokeColor": "?sbColorPositive", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 3.0, | ||
"cornerRadius": 5.0 | ||
}) | ||
}), | ||
"barcodeItemConfiguration": new BarcodeItemConfiguration({ | ||
"imageVisible": true, | ||
"titleSelected": new StyledText({ | ||
"text": "BARCODE_TITLE", | ||
"color": "?sbColorOnSurface" | ||
}), | ||
"subtitleSelected": new StyledText({ | ||
"visible": true, | ||
"text": "BARCODE_SUBTITLE", | ||
"color": "?sbColorOnSurfaceVariant", | ||
"useShadow": false | ||
}), | ||
"titleDeselected": new StyledText({ | ||
"visible": true, | ||
"text": "BARCODE_TITLE", | ||
"color": "?sbColorOnSurface", | ||
"useShadow": false | ||
}), | ||
"subtitleDeselected": new StyledText({ | ||
"text": "BARCODE_SUBTITLE", | ||
"color": "?sbColorOnSurfaceVariant" | ||
}), | ||
"backgroundSelected": new PolygonStyle({ | ||
"strokeColor": "?sbColorPositive", | ||
"fillColor": "?sbColorPositive", | ||
"strokeWidth": 1.0, | ||
"cornerRadius": 5.0 | ||
}), | ||
"backgroundDeselected": new PolygonStyle({ | ||
"strokeColor": "?sbColorSurface", | ||
"fillColor": "?sbColorSurface", | ||
"strokeWidth": 1.0, | ||
"cornerRadius": 5.0 | ||
}) | ||
}) | ||
}); | ||
*/ | ||
arOverlay: ArOverlayGeneralConfiguration; | ||
@@ -613,0 +613,0 @@ /** @param source {@displayType `DeepPartial<MultipleScanningMode>`} */ |
import { ButtonConfiguration } from "./Common"; | ||
import { DeepPartial, PartiallyConstructible } from "./utils"; | ||
import { DeepPartial, PartiallyConstructible } from "../common"; | ||
import { StyledText } from "./Common"; | ||
/** | ||
Configuration of the the standard alert dialog. | ||
*/ | ||
Configuration of the the standard alert dialog. | ||
*/ | ||
export declare class ScanbotAlertDialog extends PartiallyConstructible { | ||
/** | ||
Title displayed above the message. | ||
@defaultValue new StyledText({ | ||
"text": "Title", | ||
"color": "?sbColorOnSurface" | ||
Title displayed above the message. | ||
@defaultValue new StyledText({ | ||
"text": "Title", | ||
"color": "?sbColorOnSurface" | ||
}); | ||
*/ | ||
*/ | ||
title: StyledText; | ||
/** | ||
Explanation message message. | ||
@defaultValue new StyledText({ | ||
"text": "Standard explanation message text.", | ||
"color": "?sbColorOnSurfaceVariant" | ||
}); | ||
*/ | ||
Explanation message message. | ||
@defaultValue new StyledText({ | ||
"text": "Standard explanation message text.", | ||
"color": "?sbColorOnSurfaceVariant" | ||
}); | ||
*/ | ||
subtitle: StyledText; | ||
/** | ||
Background color of the alert dialog. | ||
@defaultValue "?sbColorSurface"; | ||
*/ | ||
Background color of the alert dialog. | ||
@defaultValue "?sbColorSurface"; | ||
*/ | ||
sheetColor: string; | ||
/** | ||
Dialog overlay color. | ||
@defaultValue "?sbColorModalOverlay"; | ||
*/ | ||
Dialog overlay color. | ||
@defaultValue "?sbColorModalOverlay"; | ||
*/ | ||
modalOverlayColor: string; | ||
/** | ||
Color of the divider line. | ||
@defaultValue "?sbColorOutline"; | ||
*/ | ||
Color of the divider line. | ||
@defaultValue "?sbColorOutline"; | ||
*/ | ||
dividerColor: string; | ||
/** | ||
Configuration of the retry button. | ||
*/ | ||
Configuration of the retry button. | ||
*/ | ||
okButton: ButtonConfiguration; | ||
/** | ||
Configuration of the cancel button. | ||
*/ | ||
Configuration of the cancel button. | ||
*/ | ||
cancelButton: ButtonConfiguration; | ||
@@ -47,0 +47,0 @@ /** @param source {@displayType `DeepPartial<ScanbotAlertDialog>`} */ |
import { ArOverlayGeneralConfiguration } from "./ArTrackingOverlayConfiguration"; | ||
import { BarcodeInfoMapping } from "./BarcodeInfoMapping"; | ||
import { ButtonConfiguration } from "./Common"; | ||
import { DeepPartial, PartiallyConstructible } from "./utils"; | ||
import { DeepPartial, PartiallyConstructible } from "../common"; | ||
import { StyledText } from "./Common"; | ||
/** | ||
Configuration of the single barcode scanning mode. | ||
*/ | ||
Configuration of the single barcode scanning mode. | ||
*/ | ||
export declare class SingleScanningMode extends PartiallyConstructible { | ||
readonly _type: "SingleScanningMode"; | ||
/** | ||
If enabled, the confirmation sheet will be shown after the barcode has been scanned. | ||
@defaultValue false; | ||
*/ | ||
If enabled, the confirmation sheet will be shown after the barcode has been scanned. | ||
@defaultValue false; | ||
*/ | ||
confirmationSheetEnabled: boolean; | ||
/** | ||
If enabled, the barcode image will be shown on the confirmation sheet. | ||
@defaultValue true; | ||
*/ | ||
If enabled, the barcode image will be shown on the confirmation sheet. | ||
@defaultValue true; | ||
*/ | ||
barcodeImageVisible: boolean; | ||
/** | ||
Color of the confirmation sheet's background. | ||
@defaultValue "?sbColorSurface"; | ||
*/ | ||
Color of the confirmation sheet's background. | ||
@defaultValue "?sbColorSurface"; | ||
*/ | ||
sheetColor: string; | ||
/** | ||
Color of the divider and separator lines in the confirmation sheet. | ||
@defaultValue "?sbColorOutline"; | ||
*/ | ||
Color of the divider and separator lines in the confirmation sheet. | ||
@defaultValue "?sbColorOutline"; | ||
*/ | ||
dividerColor: string; | ||
/** | ||
Background color of the overlay surrounding the confirmation sheet. | ||
@defaultValue "?sbColorModalOverlay"; | ||
*/ | ||
Background color of the overlay surrounding the confirmation sheet. | ||
@defaultValue "?sbColorModalOverlay"; | ||
*/ | ||
modalOverlayColor: string; | ||
/** | ||
Appearance of the barcode title (the barcode's value) on the confirmation sheet. | ||
@defaultValue new StyledText({ | ||
"text": "BARCODE_TITLE", | ||
"color": "?sbColorOnSurface" | ||
Appearance of the barcode title (the barcode's value) on the confirmation sheet. | ||
@defaultValue new StyledText({ | ||
"text": "BARCODE_TITLE", | ||
"color": "?sbColorOnSurface" | ||
}); | ||
*/ | ||
*/ | ||
barcodeTitle: StyledText; | ||
/** | ||
Appearance of the barcode subtitle (the barcode's symbology) on the confirmation sheet. | ||
@defaultValue new StyledText({ | ||
"text": "BARCODE_SUBTITLE", | ||
"color": "?sbColorOnSurfaceVariant" | ||
}); | ||
*/ | ||
Appearance of the barcode subtitle (the barcode's symbology) on the confirmation sheet. | ||
@defaultValue new StyledText({ | ||
"text": "BARCODE_SUBTITLE", | ||
"color": "?sbColorOnSurfaceVariant" | ||
}); | ||
*/ | ||
barcodeSubtitle: StyledText; | ||
/** | ||
Appearance of the confirm button on the confirmation sheet. | ||
@defaultValue new ButtonConfiguration({ | ||
"visible": true, | ||
"text": "?sheetSubmitButton", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "?sbColorPrimary", | ||
"fillColor": "?sbColorPrimary", | ||
"strokeWidth": 1.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"iconVisible": true, | ||
"color": "?sbColorOnPrimary" | ||
}) | ||
}); | ||
*/ | ||
Appearance of the confirm button on the confirmation sheet. | ||
@defaultValue new ButtonConfiguration({ | ||
"visible": true, | ||
"text": "?sheetSubmitButton", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "?sbColorPrimary", | ||
"fillColor": "?sbColorPrimary", | ||
"strokeWidth": 1.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"iconVisible": true, | ||
"color": "?sbColorOnPrimary" | ||
}) | ||
}); | ||
*/ | ||
submitButton: ButtonConfiguration; | ||
/** | ||
Appearance of the cancel button on the confirmation sheet. | ||
@defaultValue new ButtonConfiguration({ | ||
"visible": true, | ||
"text": "?singleModeConfirmationCancelButton", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "#00000000", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 1.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"iconVisible": false, | ||
"color": "?sbColorPrimary" | ||
}) | ||
}); | ||
*/ | ||
Appearance of the cancel button on the confirmation sheet. | ||
@defaultValue new ButtonConfiguration({ | ||
"visible": true, | ||
"text": "?singleModeConfirmationCancelButton", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "#00000000", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 1.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"iconVisible": false, | ||
"color": "?sbColorPrimary" | ||
}) | ||
}); | ||
*/ | ||
cancelButton: ButtonConfiguration; | ||
/** | ||
Appearance of the barcode info mapping. | ||
@defaultValue new BarcodeInfoMapping({ | ||
"sheetColor": "?sbColorSurface", | ||
"dividerColor": "?sbColorOutline", | ||
"modalOverlayColor": "?sbColorModalOverlay", | ||
"loadingMessage": new StyledText({ | ||
"text": "?barcodeInfoMappingLoadingMessage", | ||
"color": "?sbColorPrimary" | ||
}), | ||
"errorState": new BarcodeItemErrorState({ | ||
"title": new StyledText({ | ||
"text": "?barcodeInfoMappingErrorStateTitle", | ||
"color": "?sbColorOnSurface" | ||
}), | ||
"subtitle": new StyledText({ | ||
"text": "?barcodeInfoMappingErrorStateSubtitle", | ||
"color": "?sbColorOnSurfaceVariant" | ||
}), | ||
"retryButton": new ButtonConfiguration({ | ||
"visible": true, | ||
"text": "?barcodeInfoMappingErrorStateRetryButton", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "?sbColorPrimary", | ||
"fillColor": "?sbColorPrimary", | ||
"strokeWidth": 1.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"iconVisible": true, | ||
"color": "?sbColorOnPrimary" | ||
}) | ||
}), | ||
"cancelButton": new ButtonConfiguration({ | ||
"text": "?barcodeInfoMappingErrorStateCancelButton", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "#00000000", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 1.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"iconVisible": false, | ||
"color": "?sbColorPrimary" | ||
}) | ||
}) | ||
}) | ||
}); | ||
*/ | ||
Appearance of the barcode info mapping. | ||
@defaultValue new BarcodeInfoMapping({ | ||
"sheetColor": "?sbColorSurface", | ||
"dividerColor": "?sbColorOutline", | ||
"modalOverlayColor": "?sbColorModalOverlay", | ||
"loadingMessage": new StyledText({ | ||
"text": "?barcodeInfoMappingLoadingMessage", | ||
"color": "?sbColorPrimary" | ||
}), | ||
"errorState": new BarcodeItemErrorState({ | ||
"title": new StyledText({ | ||
"text": "?barcodeInfoMappingErrorStateTitle", | ||
"color": "?sbColorOnSurface" | ||
}), | ||
"subtitle": new StyledText({ | ||
"text": "?barcodeInfoMappingErrorStateSubtitle", | ||
"color": "?sbColorOnSurfaceVariant" | ||
}), | ||
"retryButton": new ButtonConfiguration({ | ||
"visible": true, | ||
"text": "?barcodeInfoMappingErrorStateRetryButton", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "?sbColorPrimary", | ||
"fillColor": "?sbColorPrimary", | ||
"strokeWidth": 1.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"iconVisible": true, | ||
"color": "?sbColorOnPrimary" | ||
}) | ||
}), | ||
"cancelButton": new ButtonConfiguration({ | ||
"text": "?barcodeInfoMappingErrorStateCancelButton", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "#00000000", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 1.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"iconVisible": false, | ||
"color": "?sbColorPrimary" | ||
}) | ||
}) | ||
}) | ||
}); | ||
*/ | ||
barcodeInfoMapping: BarcodeInfoMapping; | ||
/** | ||
Configuration of the AR overlay. | ||
@defaultValue new ArOverlayGeneralConfiguration({ | ||
"visible": false, | ||
"counterBadge": new BadgeStyle({ | ||
"visible": true, | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "#000000FF", | ||
"fillColor": "?sbColorPositive", | ||
"strokeWidth": 0.0 | ||
}), | ||
"foregroundColor": "?sbColorOnSurface" | ||
}), | ||
"automaticSelectionEnabled": false, | ||
"barcodeItemInfoPosition": "BELOW", | ||
"polygon": new ArOverlayPolygonConfiguration({ | ||
"visible": true, | ||
"deselected": new PolygonStyle({ | ||
"strokeColor": "?sbColorSurface", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 3.0, | ||
"cornerRadius": 5.0 | ||
}), | ||
"selected": new PolygonStyle({ | ||
"strokeColor": "?sbColorPositive", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 3.0, | ||
"cornerRadius": 5.0 | ||
}) | ||
}), | ||
"barcodeItemConfiguration": new BarcodeItemConfiguration({ | ||
"imageVisible": true, | ||
"titleSelected": new StyledText({ | ||
"text": "BARCODE_TITLE", | ||
"color": "?sbColorOnSurface" | ||
}), | ||
"subtitleSelected": new StyledText({ | ||
"text": "BARCODE_SUBTITLE", | ||
"color": "?sbColorOnSurfaceVariant" | ||
}), | ||
"titleDeselected": new StyledText({ | ||
"text": "BARCODE_TITLE", | ||
"color": "?sbColorOnSurface" | ||
}), | ||
"subtitleDeselected": new StyledText({ | ||
"visible": true, | ||
"text": "BARCODE_SUBTITLE", | ||
"color": "?sbColorOnSurfaceVariant", | ||
"useShadow": false | ||
}), | ||
"backgroundSelected": new PolygonStyle({ | ||
"strokeColor": "?sbColorPositive", | ||
"fillColor": "?sbColorPositive", | ||
"strokeWidth": 1.0, | ||
"cornerRadius": 5.0 | ||
}), | ||
"backgroundDeselected": new PolygonStyle({ | ||
"strokeColor": "?sbColorSurface", | ||
"fillColor": "?sbColorSurface", | ||
"strokeWidth": 1.0, | ||
"cornerRadius": 5.0 | ||
}) | ||
}) | ||
}); | ||
*/ | ||
Configuration of the AR overlay. | ||
@defaultValue new ArOverlayGeneralConfiguration({ | ||
"visible": false, | ||
"counterBadge": new BadgeStyle({ | ||
"visible": true, | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "#000000FF", | ||
"fillColor": "?sbColorPositive", | ||
"strokeWidth": 0.0 | ||
}), | ||
"foregroundColor": "?sbColorOnSurface" | ||
}), | ||
"automaticSelectionEnabled": false, | ||
"barcodeItemInfoPosition": "BELOW", | ||
"polygon": new ArOverlayPolygonConfiguration({ | ||
"visible": true, | ||
"deselected": new PolygonStyle({ | ||
"strokeColor": "?sbColorSurface", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 3.0, | ||
"cornerRadius": 5.0 | ||
}), | ||
"selected": new PolygonStyle({ | ||
"strokeColor": "?sbColorPositive", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 3.0, | ||
"cornerRadius": 5.0 | ||
}) | ||
}), | ||
"barcodeItemConfiguration": new BarcodeItemConfiguration({ | ||
"imageVisible": true, | ||
"titleSelected": new StyledText({ | ||
"text": "BARCODE_TITLE", | ||
"color": "?sbColorOnSurface" | ||
}), | ||
"subtitleSelected": new StyledText({ | ||
"text": "BARCODE_SUBTITLE", | ||
"color": "?sbColorOnSurfaceVariant" | ||
}), | ||
"titleDeselected": new StyledText({ | ||
"text": "BARCODE_TITLE", | ||
"color": "?sbColorOnSurface" | ||
}), | ||
"subtitleDeselected": new StyledText({ | ||
"visible": true, | ||
"text": "BARCODE_SUBTITLE", | ||
"color": "?sbColorOnSurfaceVariant", | ||
"useShadow": false | ||
}), | ||
"backgroundSelected": new PolygonStyle({ | ||
"strokeColor": "?sbColorPositive", | ||
"fillColor": "?sbColorPositive", | ||
"strokeWidth": 1.0, | ||
"cornerRadius": 5.0 | ||
}), | ||
"backgroundDeselected": new PolygonStyle({ | ||
"strokeColor": "?sbColorSurface", | ||
"fillColor": "?sbColorSurface", | ||
"strokeWidth": 1.0, | ||
"cornerRadius": 5.0 | ||
}) | ||
}) | ||
}); | ||
*/ | ||
arOverlay: ArOverlayGeneralConfiguration; | ||
@@ -200,0 +200,0 @@ /** @param source {@displayType `DeepPartial<SingleScanningMode>`} */ |
import { ButtonConfiguration } from "./Common"; | ||
import { DeepPartial, PartiallyConstructible } from "./utils"; | ||
import { DeepPartial, PartiallyConstructible } from "../common"; | ||
import { StyledText } from "./Common"; | ||
/** | ||
Configuration of the top screen bar's appearance. | ||
*/ | ||
Configuration of the top screen bar's appearance. | ||
*/ | ||
export declare class TopBarConfiguration extends PartiallyConstructible { | ||
/** | ||
Appearance of the top bar's title. | ||
@defaultValue new StyledText({ | ||
"visible": false, | ||
"text": "Scan Item", | ||
"color": "?sbColorOnPrimary" | ||
Appearance of the top bar's title. | ||
@defaultValue new StyledText({ | ||
"visible": false, | ||
"text": "Scan Item", | ||
"color": "?sbColorOnPrimary" | ||
}); | ||
*/ | ||
*/ | ||
title: StyledText; | ||
/** | ||
Visual mode used for the top bar. | ||
@defaultValue "SOLID"; | ||
*/ | ||
Visual mode used for the top bar. | ||
@defaultValue "SOLID"; | ||
*/ | ||
mode: TopBarMode; | ||
/** | ||
Background color of the top bar to be used when the visual mode is specified as SOLID. Otherwise ignored. | ||
@defaultValue "?sbColorPrimary"; | ||
*/ | ||
Background color of the top bar to be used when the visual mode is specified as SOLID. Otherwise ignored. | ||
@defaultValue "?sbColorPrimary"; | ||
*/ | ||
backgroundColor: string; | ||
/** | ||
Configuration of the cancel button's appearance. | ||
@defaultValue new ButtonConfiguration({ | ||
"text": "Cancel", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "#00000000", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 0.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"color": "?sbColorOnPrimary" | ||
}) | ||
}); | ||
*/ | ||
Configuration of the cancel button's appearance. | ||
@defaultValue new ButtonConfiguration({ | ||
"text": "Cancel", | ||
"background": new BackgroundStyle({ | ||
"strokeColor": "#00000000", | ||
"fillColor": "#00000000", | ||
"strokeWidth": 0.0 | ||
}), | ||
"foreground": new ForegroundStyle({ | ||
"color": "?sbColorOnPrimary" | ||
}) | ||
}); | ||
*/ | ||
cancelButton: ButtonConfiguration; | ||
@@ -46,11 +46,11 @@ /** @param source {@displayType `DeepPartial<TopBarConfiguration>`} */ | ||
/** | ||
Visual mode used for the top bar. | ||
Visual mode used for the top bar. | ||
- `SOLID`: | ||
Display the top bar with a background color or with transparency. | ||
- `GRADIENT`: | ||
Display the top bar with a gradient background color or a transparent gradient. The buttons will still be visible. | ||
- `HIDDEN`: | ||
Hide the top bar completely. | ||
*/ | ||
- `SOLID`: | ||
Display the top bar with a background color or with transparency. | ||
- `GRADIENT`: | ||
Display the top bar with a gradient background color or a transparent gradient. The buttons will still be visible. | ||
- `HIDDEN`: | ||
Hide the top bar completely. | ||
*/ | ||
export type TopBarMode = "SOLID" | "GRADIENT" | "HIDDEN"; |
import { BackgroundStyle } from "./Common"; | ||
import { DeepPartial, PartiallyConstructible } from "./utils"; | ||
import { DeepPartial, PartiallyConstructible } from "../common"; | ||
import { StyledText } from "./Common"; | ||
/** | ||
Configuration of the hint guiding users through the scanning process. | ||
*/ | ||
Configuration of the hint guiding users through the scanning process. | ||
*/ | ||
export declare class UserGuidanceConfiguration extends PartiallyConstructible { | ||
/** | ||
Whether the user guidance is visible. | ||
@defaultValue true; | ||
*/ | ||
Whether the user guidance is visible. | ||
@defaultValue true; | ||
*/ | ||
visible: boolean; | ||
/** | ||
Title of the user guidance. | ||
@defaultValue new StyledText({ | ||
"color": "?sbColorOnPrimary" | ||
Title of the user guidance. | ||
@defaultValue new StyledText({ | ||
"color": "?sbColorOnPrimary" | ||
}); | ||
*/ | ||
*/ | ||
title: StyledText; | ||
/** | ||
Background style used for the user guidance. | ||
@defaultValue new BackgroundStyle({ | ||
"strokeColor": "#00000000", | ||
"fillColor": "?sbColorSurfaceLow" | ||
}); | ||
*/ | ||
Background style used for the user guidance. | ||
@defaultValue new BackgroundStyle({ | ||
"strokeColor": "#00000000", | ||
"fillColor": "?sbColorSurfaceLow" | ||
}); | ||
*/ | ||
background: BackgroundStyle; | ||
@@ -28,0 +28,0 @@ /** @param source {@displayType `DeepPartial<UserGuidanceConfiguration>`} */ |
import { AspectRatio } from "./Geometry"; | ||
import { DeepPartial, PartiallyConstructible } from "./utils"; | ||
import { DeepPartial, PartiallyConstructible } from "../common"; | ||
/** | ||
Configuration of the scanning interface's viewfinder, serving as guidance to the user. | ||
*/ | ||
Configuration of the scanning interface's viewfinder, serving as guidance to the user. | ||
*/ | ||
export declare class ViewFinderConfiguration extends PartiallyConstructible { | ||
/** | ||
Whether the viewfinder is visible. | ||
@defaultValue true; | ||
*/ | ||
Whether the viewfinder is visible. | ||
@defaultValue true; | ||
*/ | ||
visible: boolean; | ||
/** | ||
Visual appearance of the viewfinder. | ||
@defaultValue new FinderCorneredStyle({ | ||
"strokeColor": "?sbColorSurface", | ||
"strokeWidth": 2.0, | ||
"cornerRadius": 10.0 | ||
}); | ||
*/ | ||
Visual appearance of the viewfinder. | ||
@defaultValue new FinderCorneredStyle({ | ||
"strokeColor": "?sbColorSurface", | ||
"strokeWidth": 2.0, | ||
"cornerRadius": 10.0 | ||
}); | ||
*/ | ||
style: FinderStyle; | ||
/** | ||
Color of the viewfinder overlay. | ||
@defaultValue "?sbColorSurfaceLow"; | ||
*/ | ||
Color of the viewfinder overlay. | ||
@defaultValue "?sbColorSurfaceLow"; | ||
*/ | ||
overlayColor: string; | ||
/** | ||
The viewfinder's aspect ratio. | ||
@defaultValue new AspectRatio({ | ||
"width": 1.0, | ||
"height": 1.0 | ||
The viewfinder's aspect ratio. | ||
@defaultValue new AspectRatio({ | ||
"width": 1.0, | ||
"height": 1.0 | ||
}); | ||
*/ | ||
*/ | ||
aspectRatio: AspectRatio; | ||
@@ -38,4 +38,4 @@ /** @param source {@displayType `DeepPartial<ViewFinderConfiguration>`} */ | ||
/** | ||
Visual appearance of the viewfinder. | ||
*/ | ||
Visual appearance of the viewfinder. | ||
*/ | ||
export type FinderStyle = FinderCorneredStyle | FinderStrokedStyle; | ||
@@ -50,20 +50,20 @@ /** @internal */ | ||
/** | ||
Variant of the viewfinder displaying only the four corners of the scanning area as user guidance. | ||
*/ | ||
Variant of the viewfinder displaying only the four corners of the scanning area as user guidance. | ||
*/ | ||
export declare class FinderCorneredStyle extends PartiallyConstructible { | ||
readonly _type: "FinderCorneredStyle"; | ||
/** | ||
Color of the viewfinder corner's outlines. | ||
@defaultValue "#FFFFFFFF"; | ||
*/ | ||
Color of the viewfinder corner's outlines. | ||
@defaultValue "#FFFFFFFF"; | ||
*/ | ||
strokeColor: string; | ||
/** | ||
Width of the viewfinder corner's outlines. | ||
@defaultValue 3.0; | ||
*/ | ||
Width of the viewfinder corner's outlines. | ||
@defaultValue 3.0; | ||
*/ | ||
strokeWidth: number; | ||
/** | ||
Radius of the viewfinder's corners. | ||
@defaultValue 10.0; | ||
*/ | ||
Radius of the viewfinder's corners. | ||
@defaultValue 10.0; | ||
*/ | ||
cornerRadius: number; | ||
@@ -74,20 +74,20 @@ /** @param source {@displayType `DeepPartial<FinderCorneredStyle>`} */ | ||
/** | ||
Variant of the viewfinder displaying a full outline of the scanning area as user guidance. | ||
*/ | ||
Variant of the viewfinder displaying a full outline of the scanning area as user guidance. | ||
*/ | ||
export declare class FinderStrokedStyle extends PartiallyConstructible { | ||
readonly _type: "FinderStrokedStyle"; | ||
/** | ||
Color of the viewfinder's outline. | ||
@defaultValue "#FFFFFFFF"; | ||
*/ | ||
Color of the viewfinder's outline. | ||
@defaultValue "#FFFFFFFF"; | ||
*/ | ||
strokeColor: string; | ||
/** | ||
Width of the viewfinder's outline. | ||
@defaultValue 3.0; | ||
*/ | ||
Width of the viewfinder's outline. | ||
@defaultValue 3.0; | ||
*/ | ||
strokeWidth: number; | ||
/** | ||
The viewfinder's corner radius. | ||
@defaultValue 10.0; | ||
*/ | ||
The viewfinder's corner radius. | ||
@defaultValue 10.0; | ||
*/ | ||
cornerRadius: number; | ||
@@ -94,0 +94,0 @@ /** @param source {@displayType `DeepPartial<FinderStrokedStyle>`} */ |
import React from 'react'; | ||
import { BarcodeScannerConfiguration, BarcodeScannerResult } from '../configuration'; | ||
import { BarcodeScannerConfiguration, BarcodeScannerUIResult } from '../configuration'; | ||
export declare class Props { | ||
configuration: BarcodeScannerConfiguration; | ||
onClose: () => void; | ||
onSubmit: (barcodeScannerResult: BarcodeScannerResult) => void; | ||
onSubmit: (barcodeScannerResult: BarcodeScannerUIResult) => void; | ||
onError: (error: Error) => void; | ||
} | ||
export declare function BarcodeScannerController(props: Props): React.JSX.Element; |
import React from "react"; | ||
import { BarcodeScannerConfiguration, BarcodeScannerResult } from "../configuration"; | ||
import { BarcodeScannerConfiguration, BarcodeScannerUIResult } from "../configuration"; | ||
import { IBarcodeMapper } from "../utils/barcode-mapper/i-barcode-mapper"; | ||
declare class Props { | ||
configuration: BarcodeScannerConfiguration; | ||
onCameraPermissionDenied: () => void; | ||
onSubmit: (barcodeScannerResult: BarcodeScannerResult) => void; | ||
onSubmit: (barcodeScannerResult: BarcodeScannerUIResult) => void; | ||
onError: (error?: Error) => void; | ||
scanningEnabled: React.MutableRefObject<boolean>; | ||
barcodeMapper: IBarcodeMapper; | ||
} | ||
export declare function MultipleScanningModeController(props: Props): React.JSX.Element; | ||
export {}; |
import React from "react"; | ||
import { BarcodeScannerConfiguration, BarcodeScannerResult } from "../configuration"; | ||
import { BarcodeScannerConfiguration, BarcodeScannerUIResult } from "../configuration"; | ||
import { IBarcodeMapper } from "../utils/barcode-mapper/i-barcode-mapper"; | ||
declare class Props { | ||
configuration: BarcodeScannerConfiguration; | ||
onClose: () => void; | ||
onSubmit: (barcodeScannerResult: BarcodeScannerResult) => void; | ||
onSubmit: (barcodeScannerUIResult: BarcodeScannerUIResult) => void; | ||
onError: (error?: Error) => void; | ||
onCameraPermissionDenied: () => void; | ||
scanningEnabled: React.MutableRefObject<boolean>; | ||
barcodeMapper: IBarcodeMapper; | ||
} | ||
export declare function SingleScanningModeController(props: Props): React.JSX.Element; | ||
export {}; |
import BarcodePolygon from "../../view/barcode-polygon/barocode-polygon"; | ||
import { ArOverlayBarcodeInfo } from "../views/ar/ar-overlay-barcode-info"; | ||
import type { CoreBarcodeItem } from "../configuration/BarcodeItem"; | ||
import { BarcodeItem } from "../configuration"; | ||
export type CountedBarcode = { | ||
barcode: CoreBarcodeItem; | ||
barcode: BarcodeItem; | ||
count: number; | ||
@@ -14,20 +14,13 @@ labelElement?: ArOverlayBarcodeInfo; | ||
**/ | ||
type ComputeNewCountFunction = (oldCount: number) => number; | ||
export type CountedBarcodeAction = { | ||
type: 'setCount'; | ||
barcodes: CoreBarcodeItem[]; | ||
computeNewCount: ComputeNewCountFunction; | ||
} | { | ||
type: 'remove'; | ||
barcode: CoreBarcodeItem; | ||
} | { | ||
type: 'clear'; | ||
} | { | ||
type: 'setHtmlElements'; | ||
barcode: CoreBarcodeItem; | ||
labelElement: ArOverlayBarcodeInfo; | ||
polygonElement: BarcodePolygon; | ||
}; | ||
export declare const barcodesEqual: (a: CoreBarcodeItem, b: CoreBarcodeItem) => boolean; | ||
type ComputeNewCountFunction = (oldCount?: number, item?: CountedBarcode) => number; | ||
export declare class CountedBarcodeAction { | ||
type: 'setCount' | 'remove' | 'clear' | 'setHtmlElements'; | ||
barcodes?: BarcodeItem[]; | ||
barcode?: BarcodeItem; | ||
computeNewCount?: ComputeNewCountFunction; | ||
labelElement?: ArOverlayBarcodeInfo; | ||
polygonElement?: BarcodePolygon; | ||
} | ||
export declare const barcodesEqual: (a: BarcodeItem, b: BarcodeItem) => boolean; | ||
export declare function countedBarcodesReducer(countedBarcodes: Readonly<Readonly<CountedBarcode>[]>, action: CountedBarcodeAction): CountedBarcode[]; | ||
export {}; |
import * as Config from "./configuration"; | ||
import { BarcodeScannerResult } from "./configuration/BarcodeScannerTypes"; | ||
import { BarcodeScannerUIResult } from "./configuration"; | ||
export default class ScanbotSDKUI { | ||
static createBarcodeScanner(config: Config.BarcodeScannerConfiguration): Promise<BarcodeScannerResult | null>; | ||
static createBarcodeScanner(config: Config.BarcodeScannerConfiguration): Promise<BarcodeScannerUIResult | null>; | ||
private static createContainer; | ||
static readonly Config: typeof Config; | ||
} |
/// <reference types="react" /> | ||
import { BarcodeTextLocalization, Palette } from "./configuration"; | ||
import { BarcodeTextLocalization, Palette, PolygonStyle } from "./configuration"; | ||
export type getColorValueFunctionType = (colorValueFromConfig: string) => string; | ||
@@ -16,3 +16,4 @@ export declare const SBPaletteContext: import("react").Context<{ | ||
static getColorValue(color: string): string; | ||
static getLocalizedBarcodeText(text: string): string; | ||
static getPolygonColorValues(input: PolygonStyle, visible: boolean): PolygonStyle; | ||
static getLocalizedBarcodeText(text: string, replacementArgs?: string[]): string; | ||
} |
@@ -5,3 +5,3 @@ import React from "react"; | ||
backgroundColor: string; | ||
count: number; | ||
text: string; | ||
children: React.ReactNode; | ||
@@ -8,0 +8,0 @@ } |
@@ -1,2 +0,2 @@ | ||
import React from "react"; | ||
import React, { ReactNode } from "react"; | ||
import BarcodePolygonLabel, { BarcodePolygonLabelProps } from "../../../view/barcode-polygon/barcode-polygon-label"; | ||
@@ -17,4 +17,8 @@ import { BadgeStyle, BarcodeItemConfiguration, BarcodeItemInfoPosition } from "../../configuration"; | ||
setCount: (count: number) => void; | ||
customBadgeStyle: BadgeStyle; | ||
customBadgeContent: string | ReactNode; | ||
styleBadge(style: BadgeStyle, content: string | ReactNode): void; | ||
badgeContent(): string | number | true | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode>; | ||
render(): React.ReactNode; | ||
} | ||
export {}; |
import React from "react"; | ||
import { StyledText as StyledTextConfig } from "../../configuration"; | ||
import { BarcodeMappedDataLoadingState } from "../../utils/barcode-mapper"; | ||
import { BarcodeMappedDataLoadingState } from "../../utils/barcode-mapper/i-barcode-mapper"; | ||
export interface CounterForm { | ||
@@ -10,2 +10,4 @@ counter: number; | ||
manualCountChangeColor: string; | ||
removeButtonEnabled?: boolean; | ||
addButtonEnabled?: boolean; | ||
} | ||
@@ -12,0 +14,0 @@ export interface BarcodeInfoPropsBase { |
import React from "react"; | ||
import { ArOverlayGeneralConfiguration } from "../configuration/ArTrackingOverlayConfiguration"; | ||
import { ArOverlayFindAndPickConfiguration, ArOverlayGeneralConfiguration } from "../configuration/ArTrackingOverlayConfiguration"; | ||
import { ActionBarConfiguration } from "../configuration/ActionBarConfiguration"; | ||
@@ -9,10 +9,10 @@ import { BarcodeScannerConfiguration as BarcodeScannerViewConfig } from "../../model/configuration/barcode-scanner-configuration"; | ||
import { CameraConfiguration } from "../configuration/CameraConfiguration"; | ||
import type { CoreBarcodeItem } from "../configuration/BarcodeItem"; | ||
import type { BarcodeItem } from "../configuration"; | ||
export declare class Props { | ||
cameraConfiguration: CameraConfiguration; | ||
arOverlay: ArOverlayGeneralConfiguration; | ||
arOverlay: ArOverlayGeneralConfiguration | ArOverlayFindAndPickConfiguration; | ||
actionBarConfig: ActionBarConfiguration; | ||
actionBarBottomPadding: number; | ||
arOnBarcodeEnter: (code: CoreBarcodeItem, polygon: BarcodePolygon, label: BarcodePolygonLabel) => void; | ||
arOnBarcodeClick: (barcode: CoreBarcodeItem) => void; | ||
arOnBarcodeEnter: (code: BarcodeItem, polygon: BarcodePolygon, label: BarcodePolygonLabel) => void; | ||
arOnBarcodeClick: (barcode: BarcodeItem) => void; | ||
scanningPaused: boolean; | ||
@@ -19,0 +19,0 @@ barcodeScannerViewConfig: BarcodeScannerViewConfig; |
@@ -6,3 +6,3 @@ import * as React from 'react'; | ||
declare class Props { | ||
numBarcodes: number; | ||
isPlaceholderVisible: boolean; | ||
sheetStyle: Sheet; | ||
@@ -9,0 +9,0 @@ contentStyle: SheetContent; |
import React from "react"; | ||
import { BadgedButton } from "../../configuration"; | ||
interface Props { | ||
count: number; | ||
text: string; | ||
onClick: () => void; | ||
@@ -6,0 +6,0 @@ style?: React.CSSProperties; |
import React from "react"; | ||
import { SheetContent } from "../../../configuration"; | ||
export declare class Props { | ||
numBarcodes: number; | ||
isVisible: boolean; | ||
style: SheetContent; | ||
@@ -6,0 +6,0 @@ onStartClick?: () => void; |
import React from "react"; | ||
import { BarcodeInfoPropsBase } from "../../barcode-info/barcode-info"; | ||
import { SwipeToDelete } from "../../../configuration"; | ||
import { BarcodeScannerTypes } from "../../../../core-types"; | ||
import { BarcodeItem, ExpectedBarcode, SwipeToDelete } from "../../../configuration"; | ||
export interface Props extends BarcodeInfoPropsBase { | ||
barcode: BarcodeScannerTypes.BarcodeItem; | ||
onDelete: (barcode: BarcodeScannerTypes.BarcodeItem) => void; | ||
barcode: BarcodeItem; | ||
expectedBarcode?: ExpectedBarcode; | ||
onDelete: (barcode: BarcodeItem) => void; | ||
readonlyCount: number | null; | ||
swipeToDeleteConfig: SwipeToDelete; | ||
sheetColor: string; | ||
animateBackAfterDelete: boolean; | ||
} | ||
export default function BarcodeListItem(props: Props): React.JSX.Element; |
import React from "react"; | ||
import { CountedBarcode, CountedBarcodeAction } from "../../../model/counted-barcodes"; | ||
import { MultipleBarcodesScanningMode, SheetContent } from "../../../configuration"; | ||
import { ExpectedBarcode, MultipleBarcodesScanningMode, SheetContent } from "../../../configuration"; | ||
interface Props { | ||
barcodes: CountedBarcode[]; | ||
expectedBarcodes?: ExpectedBarcode[]; | ||
onBarcodeChange: (action: CountedBarcodeAction) => void; | ||
@@ -10,4 +11,10 @@ onNumberClick: (countedBarcode: CountedBarcode) => void; | ||
mode: MultipleBarcodesScanningMode; | ||
animateBackAfterDelete: boolean; | ||
indicatorColor: { | ||
partial: string; | ||
complete: string; | ||
notScanned: string; | ||
}; | ||
} | ||
export declare function BarcodeList(props: Props): React.JSX.Element; | ||
export {}; |
@@ -5,3 +5,3 @@ import React from "react"; | ||
export declare class DrawerHeaderContentProps { | ||
numBarcodes: number; | ||
textReplacementArgs: string[]; | ||
leftButton: ButtonProps; | ||
@@ -8,0 +8,0 @@ rightButton: ButtonProps; |
import { Point } from "./Point"; | ||
export type Polygon = [Point, Point, Point, Point]; | ||
/** Quads described by exactly four points are the only supported polygon type. */ | ||
export type Polygon = Point[]; |
import React, { ReactNode } from 'react'; | ||
export interface VideoStreamProps { | ||
videoConstraints: any; | ||
videoConstraints: MediaTrackConstraints; | ||
preferredCamera?: string; | ||
@@ -17,7 +17,7 @@ onReady: () => void; | ||
orientationChanged(e: Event): void; | ||
setDeviceIdInConstraints(constraints: any): Promise<any>; | ||
setDeviceIdInConstraints(constraints: MediaTrackConstraints): Promise<MediaTrackConstraints>; | ||
private readonly orientationchangeCallback; | ||
componentDidMount(): Promise<void>; | ||
refreshStream(): Promise<void>; | ||
stopCurrentStreams(): Promise<void>; | ||
stopCurrentStreams(): void; | ||
componentWillUnmount(): void; | ||
@@ -24,0 +24,0 @@ /** |
@@ -29,2 +29,3 @@ import React from "react"; | ||
export default class AnimatedBarcodeSelectionOverlay extends React.Component<SelectionOverlayProps, any> { | ||
container: HTMLDivElement; | ||
constructor(props: SelectionOverlayProps); | ||
@@ -31,0 +32,0 @@ update(finderRect: Frame, camera: ScanbotCameraView, originalImageSize: Size, codes: BarcodeScannerTypes.BarcodeItem[]): void; |
@@ -7,2 +7,3 @@ import React from "react"; | ||
import { ScannerConfiguration } from "../model/configuration/scanner-configuration"; | ||
import { VideoToImageData } from "../utils/video-to-image-data/video-to-image-data"; | ||
export interface ScanbotCameraViewProps { | ||
@@ -25,3 +26,3 @@ configuration?: ScannerConfiguration; | ||
videoStream: VideoStream | null; | ||
canvas: HTMLCanvasElement | null; | ||
canvas: VideoToImageData | null; | ||
videoLoaded: boolean; | ||
@@ -43,4 +44,9 @@ reloadCanvas: boolean; | ||
private imageCapture; | ||
private _reusableImageBuffer; | ||
/** | ||
* If set and the provided buffer has the correct size, `createImageData` will write the ImageData into this buffer. | ||
* Otherwise, `createImageData` will create a new Buffer. | ||
**/ | ||
set reusableImageBuffer(buffer: Uint8ClampedArray); | ||
createImageData(maxLargerLength?: number, useImageCaptureAPI?: boolean): Promise<ImageData>; | ||
drawVideoOnCanvasAndExtractFrameFromIt(frame: Frame): Promise<void>; | ||
windowSize(): Frame; | ||
@@ -58,3 +64,3 @@ /** | ||
calculateFrameSize(maxLargerLength: number, videoWidth: number, videoHeight: number): Size; | ||
getCanvasRenderingContext(): CanvasRenderingContext2D; | ||
getCanvasRenderingContext(): VideoToImageData; | ||
releaseCanvas(): void; | ||
@@ -61,0 +67,0 @@ componentWillUnmount(): void; |
@@ -22,3 +22,7 @@ import { WorkerBridge as CoreWorkerBridge, WorkerBridgeInitOptions } from "../core/bridge/worker-bridge"; | ||
acceptedBrightnessThreshold?: number; | ||
requiredAspectRatios?: import("../ui2/configuration/Geometry").AspectRatio[]; | ||
requiredAspectRatios?: { | ||
readonly width?: number; | ||
readonly height?: number; | ||
_marker?: () => void; | ||
}[]; | ||
rectangleOfInterest?: import("../core-types").Rectangle; | ||
@@ -32,17 +36,238 @@ _marker?: () => void; | ||
acceptedBrightnessThreshold?: number; | ||
requiredAspectRatios?: import("../ui2/configuration/Geometry").AspectRatio[]; | ||
requiredAspectRatios?: { | ||
readonly width?: number; | ||
readonly height?: number; | ||
_marker?: () => void; | ||
}[]; | ||
rectangleOfInterest?: import("../core-types").Rectangle; | ||
_marker?: () => void; | ||
}) => Promise<import("../core-types").ObjectId<"DocumentDetector">>; | ||
documentDetectorDetect: (documentDetectorToken: import("../core-types").ObjectId<"DocumentDetector">, image: import("../core-types").Image) => Promise<import("../core/bridge/compiled/DocumentDetectorTypes").DetectionResult>; | ||
parseBarcodeDocument: (options: import("../core/bridge/compiled/BarcodeScannerTypes").BarcodeDocumentFormat[], data: string) => Promise<import("../core/bridge/compiled/GenericDocument").GenericDocument>; | ||
documentDetectorDetect: <ImageType extends import("../core-types").Image>(documentDetectorToken: import("../core-types").ObjectId<"DocumentDetector">, image: ImageType) => Promise<import("../core/bridge/compiled/DocumentDetectorTypes").DetectionResult & { | ||
originalImage: ImageType; | ||
}>; | ||
parseBarcodeDocument: (options: import("../ui2/configuration").BarcodeDocumentFormat[], data: string) => Promise<import("../ui2/configuration").GenericDocument>; | ||
createBarcodeRecognizer: (options: { | ||
configurators?: import("../core/bridge/compiled/BarcodeConfigs").BarcodeConfig[]; | ||
configurators?: ({ | ||
readonly _type?: "CodabarConfig"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
readonly returnStartEnd?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "Code11Config"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly stripCheckDigits?: boolean; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
readonly checksum?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "Code39Config"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly stripCheckDigits?: boolean; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
readonly code32?: boolean; | ||
readonly code39?: boolean; | ||
readonly pzn?: boolean; | ||
readonly tryCode39ExtendedMode?: boolean; | ||
readonly useCode39CheckDigit?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "Code93Config"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "Code128Config"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: import("../ui2/configuration/BarcodeTypes").GS1Handling; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "Code2Of5Config"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly stripCheckDigits?: boolean; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
readonly iata2of5?: boolean; | ||
readonly code25?: boolean; | ||
readonly industrial2of5?: boolean; | ||
readonly useIATA2OF5Checksum?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "DataBarConfig"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: import("../ui2/configuration/BarcodeTypes").GS1Handling; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "DataBarExpandedConfig"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: import("../ui2/configuration/BarcodeTypes").GS1Handling; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "DataBarLimitedConfig"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: import("../ui2/configuration/BarcodeTypes").GS1Handling; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "ITFConfig"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "MSIPlesseyConfig"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly stripCheckDigits?: boolean; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
readonly checksumAlgorithms?: import("../core/bridge/compiled/BarcodeConfigs").MSIPlesseyChecksumAlgorithm[]; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "UpcEanConfig"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly stripCheckDigits?: boolean; | ||
readonly ean8?: boolean; | ||
readonly ean13?: boolean; | ||
readonly upca?: boolean; | ||
readonly upce?: boolean; | ||
readonly extensions?: import("../core/bridge/compiled/BarcodeTypes").UpcEanExtensionBehavior; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "PharmaCodeConfig"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly minimumValue?: number; | ||
readonly allowNarrowBarsOnly?: boolean; | ||
readonly allowWideBarsOnly?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "AztecConfig"; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: import("../ui2/configuration/BarcodeTypes").GS1Handling; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "QRCodeConfig"; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: import("../ui2/configuration/BarcodeTypes").GS1Handling; | ||
readonly strictMode?: boolean; | ||
readonly qr?: boolean; | ||
readonly microQr?: boolean; | ||
readonly rmqr?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "PDF417Config"; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: import("../ui2/configuration/BarcodeTypes").GS1Handling; | ||
readonly strictMode?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "MicroPDF417Config"; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: import("../ui2/configuration/BarcodeTypes").GS1Handling; | ||
readonly strictMode?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "DataMatrixConfig"; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: import("../ui2/configuration/BarcodeTypes").GS1Handling; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "MaxiCodeConfig"; | ||
readonly regexFilter?: string; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "AustraliaPostConfig"; | ||
readonly regexFilter?: string; | ||
readonly australiaPostCustomerFormat?: import("../core/bridge/compiled/BarcodeConfigs").AustraliaPostCustomerFormat; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "JapanPostConfig"; | ||
readonly regexFilter?: string; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "RoyalMailConfig"; | ||
readonly regexFilter?: string; | ||
readonly stripCheckDigits?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "RoyalTNTPostConfig"; | ||
readonly regexFilter?: string; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "USPSIntelligentMailConfig"; | ||
readonly regexFilter?: string; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "PharmaCodeTwoTrackConfig"; | ||
readonly regexFilter?: string; | ||
readonly minimumValue?: number; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "GS1CompositeConfig"; | ||
readonly regexFilter?: string; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly gs1Handling?: import("../ui2/configuration/BarcodeTypes").GS1Handling; | ||
readonly strictMode?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "GroupOneDConfig"; | ||
readonly regexFilter?: string; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly stripCheckDigits?: boolean; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
readonly gs1Handling?: import("../ui2/configuration/BarcodeTypes").GS1Handling; | ||
readonly strictMode?: boolean; | ||
readonly formats?: import("../ui2/configuration/BarcodeTypes").BarcodeFormat[]; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "GroupTwoDConfig"; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: import("../ui2/configuration/BarcodeTypes").GS1Handling; | ||
readonly strictMode?: boolean; | ||
readonly formats?: import("../ui2/configuration/BarcodeTypes").BarcodeFormat[]; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "GroupFourStateConfig"; | ||
readonly regexFilter?: string; | ||
readonly formats?: import("../ui2/configuration/BarcodeTypes").BarcodeFormat[]; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "GroupCommonConfig"; | ||
readonly regexFilter?: string; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly stripCheckDigits?: boolean; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
readonly gs1Handling?: import("../ui2/configuration/BarcodeTypes").GS1Handling; | ||
readonly strictMode?: boolean; | ||
readonly formats?: import("../ui2/configuration/BarcodeTypes").BarcodeFormat[]; | ||
_marker?: () => void; | ||
})[]; | ||
engineMode?: import("../ui2/configuration").EngineMode; | ||
live?: boolean; | ||
acceptedDocumentFormats?: import("../core/bridge/compiled/BarcodeScannerTypes").BarcodeDocumentFormat[]; | ||
acceptedDocumentFormats?: import("../ui2/configuration").BarcodeDocumentFormat[]; | ||
returnBarcodeImage?: boolean; | ||
_marker?: () => void; | ||
}) => Promise<import("../core-types").ObjectId<"BarcodeRecognizer">>; | ||
recognizeBarcodes: (barcodeRecognizerToken: import("../core-types").ObjectId<"BarcodeRecognizer">, image: import("../core-types").Image) => Promise<import("../core/bridge/compiled/BarcodeScannerTypes").BarcodeScannerResult>; | ||
recognizeBarcodes: <ImageType_1 extends import("../core-types").Image>(barcodeRecognizerToken: import("../core-types").ObjectId<"BarcodeRecognizer">, image: ImageType_1) => Promise<import("../core/bridge/compiled/BarcodeScannerTypes").BarcodeScannerResult & { | ||
originalImage: ImageType_1; | ||
}>; | ||
beginPdf: (options: { | ||
@@ -72,3 +297,20 @@ readonly attributes?: { | ||
dpi?: number; | ||
userFields?: import("../core/bridge/compiled/TiffTypes").UserField[]; | ||
userFields?: { | ||
readonly tag?: number; | ||
readonly name?: string; | ||
readonly value?: { | ||
readonly _type?: "UserFieldDoubleValue"; | ||
readonly value?: number; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "UserFieldStringValue"; | ||
readonly value?: string; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "UserFieldIntValue"; | ||
readonly value?: number; | ||
_marker?: () => void; | ||
}; | ||
_marker?: () => void; | ||
}[]; | ||
binarizationFilter?: { | ||
@@ -124,3 +366,5 @@ readonly _type?: "ScanbotBinarizationFilter"; | ||
}) => Promise<import("../core-types").ObjectId<"MrzRecognizerContext">>; | ||
recognizeMRZ: (mrzRecognizerToken: import("../core-types").ObjectId<"MrzRecognizerContext">, image: import("../core-types").Image) => Promise<import("../core/bridge/compiled/MRZTypes").RecognitionResult>; | ||
recognizeMRZ: <ImageType_2 extends import("../core-types").Image>(mrzRecognizerToken: import("../core-types").ObjectId<"MrzRecognizerContext">, image: ImageType_2) => Promise<import("../core/bridge/compiled/MRZTypes").RecognitionResult & { | ||
originalImage: ImageType_2; | ||
}>; | ||
releaseObject: <T>(objectToken: import("../core-types").ObjectId<T>) => Promise<void>; | ||
@@ -150,6 +394,12 @@ createOcrEngine: () => Promise<import("../core-types").ObjectId<"TLDROcrContext">>; | ||
}) => Promise<import("../core-types").ObjectId<"GenericTextLineScanner">>; | ||
recognizeTextLine: (scannerToken: import("../core-types").ObjectId<"GenericTextLineScanner">, image: import("../core-types").Image) => Promise<import("../core/bridge/compiled/GenericTextLineScannerTypes").ScannerResult>; | ||
recognizeTextLine: <ImageType_3 extends import("../core-types").Image>(scannerToken: import("../core-types").ObjectId<"GenericTextLineScanner">, image: ImageType_3) => Promise<import("../core/bridge/compiled/GenericTextLineScannerTypes").ScannerResult & { | ||
originalImage: ImageType_3; | ||
}>; | ||
cleanTextLineRecognitionQueue: (scannerToken: import("../core-types").ObjectId<"GenericTextLineScanner">) => Promise<void>; | ||
createDocumentQualityAnalyzer: (options: { | ||
readonly qualityThresholds?: import("../core/bridge/compiled/DocumentQualityAnalyzerTypes").QualityThreshold[]; | ||
readonly qualityThresholds?: { | ||
readonly symbolQuality?: number; | ||
readonly symbolRatio?: number; | ||
_marker?: () => void; | ||
}[]; | ||
readonly qualityIndices?: import("../core/bridge/compiled/DocumentQualityAnalyzerTypes").Quality[]; | ||
@@ -169,3 +419,3 @@ readonly maxImageSize?: number; | ||
imageRotate: (image: import("../core-types").Image, rotations: import("../core/bridge/compiled/ImageProcessorTypes").ImageRotation) => Promise<import("../core-types").RawImage>; | ||
genericDocumentRecognizerCreate: (config: { | ||
genericDocumentRecognizerCreate: (parameters: { | ||
resultAccumulationConfig?: { | ||
@@ -178,9 +428,37 @@ minConfirmations?: number; | ||
fieldExcludeList?: string[]; | ||
acceptedDocumentTypes?: string[]; | ||
configurations?: ({ | ||
readonly _type?: "DateValidationConfig"; | ||
readonly minBirthYear?: number; | ||
readonly maxBirthYear?: number; | ||
readonly minExpirationYear?: number; | ||
readonly maxExpirationYear?: number; | ||
readonly documentTypes?: import("../core/bridge/compiled/GenericDocumentTypes").DocumentType[]; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "EuropeanHealthInsuranceCardConfig"; | ||
readonly minBirthYear?: number; | ||
readonly maxBirthYear?: number; | ||
readonly minExpirationYear?: number; | ||
readonly maxExpirationYear?: number; | ||
readonly expectedCountry?: import("../core/bridge/compiled/GenericDocumentRecognizerConfigs").EHICIssuingCountry; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "MRZFallbackConfig"; | ||
readonly acceptedCountries?: string[]; | ||
readonly acceptedMRZTypes?: import("../core/bridge/compiled/MRZTypes").DocumentType[]; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "GDRGroupConfig"; | ||
readonly acceptedDocumentTypes?: import("../core/bridge/compiled/GenericDocumentTypes").DocumentType[]; | ||
_marker?: () => void; | ||
})[]; | ||
_marker?: () => void; | ||
}) => Promise<import("../core-types").ObjectId<"GenericDocumentRecognizer">>; | ||
genericDocumentRecognizerRecognize: (gdrToken: import("../core-types").ObjectId<"GenericDocumentRecognizer">, image: import("../core-types").Image, parameters: { | ||
genericDocumentRecognizerRecognize: <ImageType_4 extends import("../core-types").Image>(gdrToken: import("../core-types").ObjectId<"GenericDocumentRecognizer">, image: ImageType_4, parameters: { | ||
mode?: import("../core/bridge/compiled/GenericDocumentRecognizerTypes").RecognitionMode; | ||
_marker?: () => void; | ||
}) => Promise<import("../core/bridge/compiled/GenericDocumentRecognizerTypes").RecognitionResult>; | ||
}) => Promise<import("../core/bridge/compiled/GenericDocumentRecognizerTypes").RecognitionResult & { | ||
originalImage: ImageType_4; | ||
}>; | ||
version: () => Promise<string>; | ||
__hasModuleFunction: (functionName: string) => Promise<any>; | ||
@@ -202,3 +480,7 @@ __callModuleFunction: (functionName: string, args?: any[]) => Promise<any>; | ||
acceptedBrightnessThreshold?: number; | ||
requiredAspectRatios?: import("../ui2/configuration/Geometry").AspectRatio[]; | ||
requiredAspectRatios?: { | ||
readonly width?: number; | ||
readonly height?: number; | ||
_marker?: () => void; | ||
}[]; | ||
rectangleOfInterest?: import("../core-types").Rectangle; | ||
@@ -212,17 +494,238 @@ _marker?: () => void; | ||
acceptedBrightnessThreshold?: number; | ||
requiredAspectRatios?: import("../ui2/configuration/Geometry").AspectRatio[]; | ||
requiredAspectRatios?: { | ||
readonly width?: number; | ||
readonly height?: number; | ||
_marker?: () => void; | ||
}[]; | ||
rectangleOfInterest?: import("../core-types").Rectangle; | ||
_marker?: () => void; | ||
}) => Promise<import("../core-types").ObjectId<"DocumentDetector">>; | ||
documentDetectorDetect: (documentDetectorToken: import("../core-types").ObjectId<"DocumentDetector">, image: import("../core-types").Image) => Promise<import("../core/bridge/compiled/DocumentDetectorTypes").DetectionResult>; | ||
parseBarcodeDocument: (options: import("../core/bridge/compiled/BarcodeScannerTypes").BarcodeDocumentFormat[], data: string) => Promise<import("../core/bridge/compiled/GenericDocument").GenericDocument>; | ||
documentDetectorDetect: <ImageType extends import("../core-types").Image>(documentDetectorToken: import("../core-types").ObjectId<"DocumentDetector">, image: ImageType) => Promise<import("../core/bridge/compiled/DocumentDetectorTypes").DetectionResult & { | ||
originalImage: ImageType; | ||
}>; | ||
parseBarcodeDocument: (options: import("../ui2/configuration").BarcodeDocumentFormat[], data: string) => Promise<import("../ui2/configuration").GenericDocument>; | ||
createBarcodeRecognizer: (options: { | ||
configurators?: import("../core/bridge/compiled/BarcodeConfigs").BarcodeConfig[]; | ||
configurators?: ({ | ||
readonly _type?: "CodabarConfig"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
readonly returnStartEnd?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "Code11Config"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly stripCheckDigits?: boolean; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
readonly checksum?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "Code39Config"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly stripCheckDigits?: boolean; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
readonly code32?: boolean; | ||
readonly code39?: boolean; | ||
readonly pzn?: boolean; | ||
readonly tryCode39ExtendedMode?: boolean; | ||
readonly useCode39CheckDigit?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "Code93Config"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "Code128Config"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: import("../ui2/configuration/BarcodeTypes").GS1Handling; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "Code2Of5Config"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly stripCheckDigits?: boolean; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
readonly iata2of5?: boolean; | ||
readonly code25?: boolean; | ||
readonly industrial2of5?: boolean; | ||
readonly useIATA2OF5Checksum?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "DataBarConfig"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: import("../ui2/configuration/BarcodeTypes").GS1Handling; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "DataBarExpandedConfig"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: import("../ui2/configuration/BarcodeTypes").GS1Handling; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "DataBarLimitedConfig"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: import("../ui2/configuration/BarcodeTypes").GS1Handling; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "ITFConfig"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "MSIPlesseyConfig"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly stripCheckDigits?: boolean; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
readonly checksumAlgorithms?: import("../core/bridge/compiled/BarcodeConfigs").MSIPlesseyChecksumAlgorithm[]; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "UpcEanConfig"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly stripCheckDigits?: boolean; | ||
readonly ean8?: boolean; | ||
readonly ean13?: boolean; | ||
readonly upca?: boolean; | ||
readonly upce?: boolean; | ||
readonly extensions?: import("../core/bridge/compiled/BarcodeTypes").UpcEanExtensionBehavior; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "PharmaCodeConfig"; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly regexFilter?: string; | ||
readonly minimumValue?: number; | ||
readonly allowNarrowBarsOnly?: boolean; | ||
readonly allowWideBarsOnly?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "AztecConfig"; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: import("../ui2/configuration/BarcodeTypes").GS1Handling; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "QRCodeConfig"; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: import("../ui2/configuration/BarcodeTypes").GS1Handling; | ||
readonly strictMode?: boolean; | ||
readonly qr?: boolean; | ||
readonly microQr?: boolean; | ||
readonly rmqr?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "PDF417Config"; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: import("../ui2/configuration/BarcodeTypes").GS1Handling; | ||
readonly strictMode?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "MicroPDF417Config"; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: import("../ui2/configuration/BarcodeTypes").GS1Handling; | ||
readonly strictMode?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "DataMatrixConfig"; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: import("../ui2/configuration/BarcodeTypes").GS1Handling; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "MaxiCodeConfig"; | ||
readonly regexFilter?: string; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "AustraliaPostConfig"; | ||
readonly regexFilter?: string; | ||
readonly australiaPostCustomerFormat?: import("../core/bridge/compiled/BarcodeConfigs").AustraliaPostCustomerFormat; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "JapanPostConfig"; | ||
readonly regexFilter?: string; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "RoyalMailConfig"; | ||
readonly regexFilter?: string; | ||
readonly stripCheckDigits?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "RoyalTNTPostConfig"; | ||
readonly regexFilter?: string; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "USPSIntelligentMailConfig"; | ||
readonly regexFilter?: string; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "PharmaCodeTwoTrackConfig"; | ||
readonly regexFilter?: string; | ||
readonly minimumValue?: number; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "GS1CompositeConfig"; | ||
readonly regexFilter?: string; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly gs1Handling?: import("../ui2/configuration/BarcodeTypes").GS1Handling; | ||
readonly strictMode?: boolean; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "GroupOneDConfig"; | ||
readonly regexFilter?: string; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly stripCheckDigits?: boolean; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
readonly gs1Handling?: import("../ui2/configuration/BarcodeTypes").GS1Handling; | ||
readonly strictMode?: boolean; | ||
readonly formats?: import("../ui2/configuration/BarcodeTypes").BarcodeFormat[]; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "GroupTwoDConfig"; | ||
readonly regexFilter?: string; | ||
readonly gs1Handling?: import("../ui2/configuration/BarcodeTypes").GS1Handling; | ||
readonly strictMode?: boolean; | ||
readonly formats?: import("../ui2/configuration/BarcodeTypes").BarcodeFormat[]; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "GroupFourStateConfig"; | ||
readonly regexFilter?: string; | ||
readonly formats?: import("../ui2/configuration/BarcodeTypes").BarcodeFormat[]; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "GroupCommonConfig"; | ||
readonly regexFilter?: string; | ||
readonly minimum1DQuietZoneSize?: number; | ||
readonly stripCheckDigits?: boolean; | ||
readonly minimumTextLength?: number; | ||
readonly maximumTextLength?: number; | ||
readonly gs1Handling?: import("../ui2/configuration/BarcodeTypes").GS1Handling; | ||
readonly strictMode?: boolean; | ||
readonly formats?: import("../ui2/configuration/BarcodeTypes").BarcodeFormat[]; | ||
_marker?: () => void; | ||
})[]; | ||
engineMode?: import("../ui2/configuration").EngineMode; | ||
live?: boolean; | ||
acceptedDocumentFormats?: import("../core/bridge/compiled/BarcodeScannerTypes").BarcodeDocumentFormat[]; | ||
acceptedDocumentFormats?: import("../ui2/configuration").BarcodeDocumentFormat[]; | ||
returnBarcodeImage?: boolean; | ||
_marker?: () => void; | ||
}) => Promise<import("../core-types").ObjectId<"BarcodeRecognizer">>; | ||
recognizeBarcodes: (barcodeRecognizerToken: import("../core-types").ObjectId<"BarcodeRecognizer">, image: import("../core-types").Image) => Promise<import("../core/bridge/compiled/BarcodeScannerTypes").BarcodeScannerResult>; | ||
recognizeBarcodes: <ImageType_1 extends import("../core-types").Image>(barcodeRecognizerToken: import("../core-types").ObjectId<"BarcodeRecognizer">, image: ImageType_1) => Promise<import("../core/bridge/compiled/BarcodeScannerTypes").BarcodeScannerResult & { | ||
originalImage: ImageType_1; | ||
}>; | ||
beginPdf: (options: { | ||
@@ -252,3 +755,20 @@ readonly attributes?: { | ||
dpi?: number; | ||
userFields?: import("../core/bridge/compiled/TiffTypes").UserField[]; | ||
userFields?: { | ||
readonly tag?: number; | ||
readonly name?: string; | ||
readonly value?: { | ||
readonly _type?: "UserFieldDoubleValue"; | ||
readonly value?: number; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "UserFieldStringValue"; | ||
readonly value?: string; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "UserFieldIntValue"; | ||
readonly value?: number; | ||
_marker?: () => void; | ||
}; | ||
_marker?: () => void; | ||
}[]; | ||
binarizationFilter?: { | ||
@@ -304,3 +824,5 @@ readonly _type?: "ScanbotBinarizationFilter"; | ||
}) => Promise<import("../core-types").ObjectId<"MrzRecognizerContext">>; | ||
recognizeMRZ: (mrzRecognizerToken: import("../core-types").ObjectId<"MrzRecognizerContext">, image: import("../core-types").Image) => Promise<import("../core/bridge/compiled/MRZTypes").RecognitionResult>; | ||
recognizeMRZ: <ImageType_2 extends import("../core-types").Image>(mrzRecognizerToken: import("../core-types").ObjectId<"MrzRecognizerContext">, image: ImageType_2) => Promise<import("../core/bridge/compiled/MRZTypes").RecognitionResult & { | ||
originalImage: ImageType_2; | ||
}>; | ||
releaseObject: <T>(objectToken: import("../core-types").ObjectId<T>) => Promise<void>; | ||
@@ -330,6 +852,12 @@ createOcrEngine: () => Promise<import("../core-types").ObjectId<"TLDROcrContext">>; | ||
}) => Promise<import("../core-types").ObjectId<"GenericTextLineScanner">>; | ||
recognizeTextLine: (scannerToken: import("../core-types").ObjectId<"GenericTextLineScanner">, image: import("../core-types").Image) => Promise<import("../core/bridge/compiled/GenericTextLineScannerTypes").ScannerResult>; | ||
recognizeTextLine: <ImageType_3 extends import("../core-types").Image>(scannerToken: import("../core-types").ObjectId<"GenericTextLineScanner">, image: ImageType_3) => Promise<import("../core/bridge/compiled/GenericTextLineScannerTypes").ScannerResult & { | ||
originalImage: ImageType_3; | ||
}>; | ||
cleanTextLineRecognitionQueue: (scannerToken: import("../core-types").ObjectId<"GenericTextLineScanner">) => Promise<void>; | ||
createDocumentQualityAnalyzer: (options: { | ||
readonly qualityThresholds?: import("../core/bridge/compiled/DocumentQualityAnalyzerTypes").QualityThreshold[]; | ||
readonly qualityThresholds?: { | ||
readonly symbolQuality?: number; | ||
readonly symbolRatio?: number; | ||
_marker?: () => void; | ||
}[]; | ||
readonly qualityIndices?: import("../core/bridge/compiled/DocumentQualityAnalyzerTypes").Quality[]; | ||
@@ -349,3 +877,3 @@ readonly maxImageSize?: number; | ||
imageRotate: (image: import("../core-types").Image, rotations: import("../core/bridge/compiled/ImageProcessorTypes").ImageRotation) => Promise<import("../core-types").RawImage>; | ||
genericDocumentRecognizerCreate: (config: { | ||
genericDocumentRecognizerCreate: (parameters: { | ||
resultAccumulationConfig?: { | ||
@@ -358,9 +886,37 @@ minConfirmations?: number; | ||
fieldExcludeList?: string[]; | ||
acceptedDocumentTypes?: string[]; | ||
configurations?: ({ | ||
readonly _type?: "DateValidationConfig"; | ||
readonly minBirthYear?: number; | ||
readonly maxBirthYear?: number; | ||
readonly minExpirationYear?: number; | ||
readonly maxExpirationYear?: number; | ||
readonly documentTypes?: import("../core/bridge/compiled/GenericDocumentTypes").DocumentType[]; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "EuropeanHealthInsuranceCardConfig"; | ||
readonly minBirthYear?: number; | ||
readonly maxBirthYear?: number; | ||
readonly minExpirationYear?: number; | ||
readonly maxExpirationYear?: number; | ||
readonly expectedCountry?: import("../core/bridge/compiled/GenericDocumentRecognizerConfigs").EHICIssuingCountry; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "MRZFallbackConfig"; | ||
readonly acceptedCountries?: string[]; | ||
readonly acceptedMRZTypes?: import("../core/bridge/compiled/MRZTypes").DocumentType[]; | ||
_marker?: () => void; | ||
} | { | ||
readonly _type?: "GDRGroupConfig"; | ||
readonly acceptedDocumentTypes?: import("../core/bridge/compiled/GenericDocumentTypes").DocumentType[]; | ||
_marker?: () => void; | ||
})[]; | ||
_marker?: () => void; | ||
}) => Promise<import("../core-types").ObjectId<"GenericDocumentRecognizer">>; | ||
genericDocumentRecognizerRecognize: (gdrToken: import("../core-types").ObjectId<"GenericDocumentRecognizer">, image: import("../core-types").Image, parameters: { | ||
genericDocumentRecognizerRecognize: <ImageType_4 extends import("../core-types").Image>(gdrToken: import("../core-types").ObjectId<"GenericDocumentRecognizer">, image: ImageType_4, parameters: { | ||
mode?: import("../core/bridge/compiled/GenericDocumentRecognizerTypes").RecognitionMode; | ||
_marker?: () => void; | ||
}) => Promise<import("../core/bridge/compiled/GenericDocumentRecognizerTypes").RecognitionResult>; | ||
}) => Promise<import("../core/bridge/compiled/GenericDocumentRecognizerTypes").RecognitionResult & { | ||
originalImage: ImageType_4; | ||
}>; | ||
version: () => Promise<string>; | ||
__hasModuleFunction: (functionName: string) => Promise<any>; | ||
@@ -370,2 +926,3 @@ __callModuleFunction: (functionName: string, args?: any[]) => Promise<any>; | ||
private getCoreForCommand; | ||
destroy(): void; | ||
} |
{ | ||
"name": "scanbot-web-sdk", | ||
"title": "Web Scan SDK", | ||
"version": "6.0.0-dev.2", | ||
"version": "6.0.0-dev.3", | ||
"description": "Scanbot Web Document and Barcode Scanner SDK", | ||
@@ -53,3 +53,3 @@ "keywords": [ | ||
"start-example": "open \"http://localhost:8000\" && python3 -m http.server --directory internal-dev-app", | ||
"transpile": "npx tsc --declaration", | ||
"transpile": "npx tsc --declaration --skipLibCheck", | ||
"cp-typings": "rsync -aL --include '*/' --include '*.d.ts' --exclude '*' ./component/ ./@types/ && rsync -aL --include '*/' --include '*.d.ts' --exclude '*' ./src/core/ ./@types/core/ && cp src/_typings-entrypoint.d.ts ./@types/index.d.ts", | ||
@@ -56,0 +56,0 @@ "prepack": "npm run clean && npm run build-lib && npm run transpile && npm run cp-typings && npm run build-src && rm bundle/ScanbotSDK.min.js.LICENSE.txt", |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
57
110665934
254
16196