New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More
Socket
Sign inDemoInstall
Socket

scanbot-web-sdk

Package Overview
Dependencies
Maintainers
0
Versions
252
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

scanbot-web-sdk - npm Package Compare versions

Comparing version 7.0.0-rc.2 to 7.0.0-rc.3

@types/core/bridge/compiled/SdkLicenseInfo.d.ts

1

@types/core-types.d.ts

@@ -30,2 +30,3 @@ export * from './core/bridge/compiled/BarcodeConfigurationTypes';

export * from './core/bridge/compiled/CreditCardDocumentModel';
export * from './core/bridge/compiled/SdkLicenseInfo';
export { PartiallyConstructible, type RawImage, type DeepPartial, type Point, type Rectangle } from './core/bridge/common';

33

@types/core/bridge/compiled/BarcodeConfigurationTypes.d.ts

@@ -57,3 +57,3 @@ import { BarcodeFormat } from "./BarcodeTypes";

Minimum text length. Applied only to linear barcode formats that allow variable length.
@defaultValue 0;
@defaultValue 1;
*/

@@ -109,3 +109,3 @@ minimumTextLength: number;

Minimum text length. Applied only to linear barcode formats that allow variable length.
@defaultValue 0;
@defaultValue 1;
*/

@@ -127,3 +127,3 @@ minimumTextLength: number;

/**
Code 39 barcode and derivatives configuration. Add to scanner configuration to scan Code 39, Code 32 (Italian Pharmacode) and PZN (Pharmazentralnummer) barcodes.
Code 39 barcode and derivatives configuration. Add to scanner configuration to scan Code 39, Code 32 (Italian Pharmacode), PZN7 and PZN8 (Pharmazentralnummer) barcodes.
*/

@@ -162,3 +162,3 @@ export declare class BarcodeFormatCode39Configuration extends PartiallyConstructible {

Minimum text length. Applied only to linear barcode formats that allow variable length.
@defaultValue 0;
@defaultValue 1;
*/

@@ -182,7 +182,12 @@ minimumTextLength: number;

/**
If true, scan PZN (Pharmazentralnummer) barcodes. If false, PZN barcodes are not decoded and are returned as CODE_39 instead.
If true, scan PZN7 (legacy Pharmazentralnummer) barcodes. If false, PZN7 barcodes are not decoded and are returned as CODE_39 instead.
@defaultValue true;
*/
pzn: boolean;
pzn7: boolean;
/**
If true, scan PZN8 (Pharmazentralnummer) barcodes. If false, PZN8 barcodes are not decoded and are returned as CODE_39 instead.
@defaultValue true;
*/
pzn8: boolean;
/**
If true, try to scan CODE_39 in extended mode.

@@ -230,3 +235,3 @@ @defaultValue false;

Minimum text length. Applied only to linear barcode formats that allow variable length.
@defaultValue 0;
@defaultValue 1;
*/

@@ -277,3 +282,3 @@ minimumTextLength: number;

Minimum text length. Applied only to linear barcode formats that allow variable length.
@defaultValue 0;
@defaultValue 1;
*/

@@ -328,3 +333,3 @@ minimumTextLength: number;

Minimum text length. Applied only to linear barcode formats that allow variable length.
@defaultValue 0;
@defaultValue 1;
*/

@@ -498,3 +503,3 @@ minimumTextLength: number;

Minimum text length. Applied only to linear barcode formats that allow variable length.
@defaultValue 0;
@defaultValue 1;
*/

@@ -563,3 +568,3 @@ minimumTextLength: number;

Minimum text length. Applied only to linear barcode formats that allow variable length.
@defaultValue 0;
@defaultValue 1;
*/

@@ -1195,3 +1200,3 @@ minimumTextLength: number;

Minimum text length. Applied only to linear barcode formats that allow variable length.
@defaultValue 0;
@defaultValue 1;
*/

@@ -1216,3 +1221,3 @@ minimumTextLength: number;

List of linear (1D) barcode formats to scan.
@defaultValue ["CODABAR", "CODE_11", "CODE_25", "CODE_32", "CODE_39", "CODE_93", "CODE_128", "DATABAR", "DATABAR_EXPANDED", "DATABAR_LIMITED", "EAN_8", "EAN_13", "IATA_2_OF_5", "INDUSTRIAL_2_OF_5", "ITF", "MSI_PLESSEY", "PHARMA_CODE", "PZN", "UPC_A", "UPC_E"];
@defaultValue ["CODABAR", "CODE_11", "CODE_25", "CODE_32", "CODE_39", "CODE_93", "CODE_128", "DATABAR", "DATABAR_EXPANDED", "DATABAR_LIMITED", "EAN_8", "EAN_13", "IATA_2_OF_5", "INDUSTRIAL_2_OF_5", "ITF", "MSI_PLESSEY", "PHARMA_CODE", "PZN_7", "PZN_8", "UPC_A", "UPC_E"];
*/

@@ -1345,3 +1350,3 @@ formats: BarcodeFormat[];

Minimum text length. Applied only to linear barcode formats that allow variable length.
@defaultValue 0;
@defaultValue 1;
*/

@@ -1348,0 +1353,0 @@ minimumTextLength: number;

@@ -75,6 +75,8 @@ import { DeepPartial, PartiallyConstructible } from "../common";

Two-Track Pharmacode, a.k.a. Pharmaceutical Binary Code.
- `PZN`:
Pharmazentralnummer, a.k.a. PZN, PZN8, German Pharmaceutical Central Number (1D).
- `PZN_7`:
PZN7, legacy PZN (Pharmazentralnummer), invalid since 01.01.2020 (1D).
- `PZN_8`:
PZN8, a.k.a. PZN, Pharmazentralnummer, German Pharmaceutical Central Number (1D).
*/
export type BarcodeFormat = "NONE" | "AZTEC" | "CODABAR" | "CODE_39" | "CODE_93" | "CODE_128" | "DATA_MATRIX" | "EAN_8" | "EAN_13" | "ITF" | "MAXI_CODE" | "PDF_417" | "QR_CODE" | "DATABAR" | "DATABAR_EXPANDED" | "UPC_A" | "UPC_E" | "MSI_PLESSEY" | "IATA_2_OF_5" | "INDUSTRIAL_2_OF_5" | "CODE_25" | "MICRO_QR_CODE" | "USPS_INTELLIGENT_MAIL" | "ROYAL_MAIL" | "JAPAN_POST" | "ROYAL_TNT_POST" | "AUSTRALIA_POST" | "DATABAR_LIMITED" | "MICRO_PDF_417" | "GS1_COMPOSITE" | "RMQR_CODE" | "CODE_11" | "CODE_32" | "PHARMA_CODE" | "PHARMA_CODE_TWO_TRACK" | "PZN";
export type BarcodeFormat = "NONE" | "AZTEC" | "CODABAR" | "CODE_39" | "CODE_93" | "CODE_128" | "DATA_MATRIX" | "EAN_8" | "EAN_13" | "ITF" | "MAXI_CODE" | "PDF_417" | "QR_CODE" | "DATABAR" | "DATABAR_EXPANDED" | "UPC_A" | "UPC_E" | "MSI_PLESSEY" | "IATA_2_OF_5" | "INDUSTRIAL_2_OF_5" | "CODE_25" | "MICRO_QR_CODE" | "USPS_INTELLIGENT_MAIL" | "ROYAL_MAIL" | "JAPAN_POST" | "ROYAL_TNT_POST" | "AUSTRALIA_POST" | "DATABAR_LIMITED" | "MICRO_PDF_417" | "GS1_COMPOSITE" | "RMQR_CODE" | "CODE_11" | "CODE_32" | "PHARMA_CODE" | "PHARMA_CODE_TWO_TRACK" | "PZN_7" | "PZN_8";
export declare const BarcodeFormatValues: BarcodeFormat[];

@@ -91,3 +93,3 @@ /**

List of 1D barcode formats.
@defaultValue ["CODABAR", "CODE_11", "CODE_25", "CODE_32", "CODE_39", "CODE_93", "CODE_128", "DATABAR", "DATABAR_EXPANDED", "DATABAR_LIMITED", "EAN_8", "EAN_13", "IATA_2_OF_5", "INDUSTRIAL_2_OF_5", "ITF", "MSI_PLESSEY", "PHARMA_CODE", "PZN", "UPC_A", "UPC_E"];
@defaultValue ["CODABAR", "CODE_11", "CODE_25", "CODE_32", "CODE_39", "CODE_93", "CODE_128", "DATABAR", "DATABAR_EXPANDED", "DATABAR_LIMITED", "EAN_8", "EAN_13", "IATA_2_OF_5", "INDUSTRIAL_2_OF_5", "ITF", "MSI_PLESSEY", "PHARMA_CODE", "PZN_7", "PZN_8", "UPC_A", "UPC_E"];
*/

@@ -107,3 +109,3 @@ const oned: BarcodeFormat[];

List of pharmaceutical barcode formats.
@defaultValue ["CODE_32", "PHARMA_CODE", "PHARMA_CODE_TWO_TRACK", "PZN"];
@defaultValue ["CODE_32", "PHARMA_CODE", "PHARMA_CODE_TWO_TRACK", "PZN_7", "PZN_8"];
*/

@@ -118,3 +120,3 @@ const pharma: BarcodeFormat[];

List of all barcode formats.
@defaultValue ["AUSTRALIA_POST", "AZTEC", "CODABAR", "CODE_11", "CODE_25", "CODE_32", "CODE_39", "CODE_93", "CODE_128", "DATA_MATRIX", "DATABAR", "DATABAR_EXPANDED", "DATABAR_LIMITED", "EAN_13", "EAN_8", "GS1_COMPOSITE", "IATA_2_OF_5", "INDUSTRIAL_2_OF_5", "ITF", "JAPAN_POST", "MAXI_CODE", "MICRO_PDF_417", "MICRO_QR_CODE", "MSI_PLESSEY", "PDF_417", "PHARMA_CODE", "PHARMA_CODE_TWO_TRACK", "PZN", "QR_CODE", "RMQR_CODE", "ROYAL_MAIL", "ROYAL_TNT_POST", "UPC_A", "UPC_E", "USPS_INTELLIGENT_MAIL"];
@defaultValue ["AUSTRALIA_POST", "AZTEC", "CODABAR", "CODE_11", "CODE_25", "CODE_32", "CODE_39", "CODE_93", "CODE_128", "DATA_MATRIX", "DATABAR", "DATABAR_EXPANDED", "DATABAR_LIMITED", "EAN_13", "EAN_8", "GS1_COMPOSITE", "IATA_2_OF_5", "INDUSTRIAL_2_OF_5", "ITF", "JAPAN_POST", "MAXI_CODE", "MICRO_PDF_417", "MICRO_QR_CODE", "MSI_PLESSEY", "PDF_417", "PHARMA_CODE", "PHARMA_CODE_TWO_TRACK", "PZN_7", "PZN_8", "QR_CODE", "RMQR_CODE", "ROYAL_MAIL", "ROYAL_TNT_POST", "UPC_A", "UPC_E", "USPS_INTELLIGENT_MAIL"];
*/

@@ -121,0 +123,0 @@ const all: BarcodeFormat[];

@@ -24,3 +24,3 @@ import type { commands } from "../worker/ScanbotSDK.Core";

}) => Promise<any>;
getLicenseInfo: () => Promise<any>;
getLicenseInfo: () => Promise<import("./compiled/SdkLicenseInfo").SdkLicenseInfo>;
encodeJpeg: (image: import("../worker/ScanbotSDK.Core").Image) => Promise<Uint8Array>;

@@ -93,3 +93,4 @@ detectDocument: (image: import("../worker/ScanbotSDK.Core").Image, options: {

code39?: boolean;
pzn?: boolean;
pzn7?: boolean;
pzn8?: boolean;
tryCode39ExtendedMode?: boolean;

@@ -547,3 +548,3 @@ useCode39CheckDigit?: boolean;

}) => Promise<any>;
getLicenseInfo: () => Promise<any>;
getLicenseInfo: () => Promise<import("./compiled/SdkLicenseInfo").SdkLicenseInfo>;
encodeJpeg: (image: import("../worker/ScanbotSDK.Core").Image) => Promise<Uint8Array>;

@@ -616,3 +617,4 @@ detectDocument: (image: import("../worker/ScanbotSDK.Core").Image, options: {

code39?: boolean;
pzn?: boolean;
pzn7?: boolean;
pzn8?: boolean;
tryCode39ExtendedMode?: boolean;

@@ -619,0 +621,0 @@ useCode39CheckDigit?: boolean;

@@ -16,2 +16,3 @@ import { PdfConfiguration } from "../bridge/compiled/PdfConfigurationTypes";

import type { GenericDocument } from "../bridge/compiled/GenericDocument";
import { SdkLicenseInfo } from "../bridge/compiled/SdkLicenseInfo";
/** Represents an object of type T residing in the WASM's memory. */

@@ -40,3 +41,3 @@ export declare class ObjectId<T> {

initialize: (licenseKey?: string, engine?: string, appId?: string, cdnPath?: string, options?: InitializeOptions) => Promise<any>;
getLicenseInfo: () => Promise<any>;
getLicenseInfo: () => Promise<SdkLicenseInfo>;
encodeJpeg: (image: Image) => Promise<Uint8Array>;

@@ -43,0 +44,0 @@ detectDocument: (image: Image, options: DeepPartial<DocumentScannerParameters>) => Promise<DocumentDetectionResult>;

import { ScannerConfiguration } from "./scanner-configuration";
import { CroppedDetectionResult, DocumentDetectionStatus, DocumentScannerParameters } from "../../core-types";
import type { ViewFinderConfiguration } from "../../ui2/configuration";
import type { DeepPartial } from "../../ui2/common";
import type { DeepPartial } from "../../ui2/configuration/utils";
export type EnabledText = {

@@ -6,0 +6,0 @@ enabled?: boolean;

import { ScannerConfiguration } from "./scanner-configuration";
import { ViewFinderConfiguration, UserGuidanceConfiguration } from "../../ui2/configuration";
import { DeepPartial } from "../../ui2/common";
import { DeepPartial } from "../../ui2/configuration/utils";
export declare function finderDefaultConfig(): ViewFinderConfiguration;

@@ -5,0 +5,0 @@ export declare class ViewFinderScannerConfiguration extends ScannerConfiguration {

@@ -1,6 +0,6 @@

export declare class LicenseInfo {
status: string;
description: string;
import { SdkLicenseInfo } from "../../core-types";
export declare class LicenseInfo extends SdkLicenseInfo {
isValid(): boolean;
static fromJson(json: any): LicenseInfo;
/** @internal */
constructor(info: SdkLicenseInfo);
}

@@ -99,3 +99,3 @@ import { WorkerBridge } from "./worker/worker-bridge";

}) => Promise<any>;
getLicenseInfo: () => Promise<any>;
getLicenseInfo: () => Promise<Config.SdkLicenseInfo>;
encodeJpeg: (image: Image) => Promise<Uint8Array>;

@@ -168,3 +168,4 @@ detectDocument: (image: Image, options: {

code39?: boolean;
pzn?: boolean;
pzn7?: boolean;
pzn8?: boolean;
tryCode39ExtendedMode?: boolean;

@@ -171,0 +172,0 @@ useCode39CheckDigit?: boolean;

import React from 'react';
import { BarcodeScannerConfiguration, BarcodeScannerUiResult } from '../../configuration';
import { BarcodeScannerScreenConfiguration, BarcodeScannerUiResult } from '../../configuration';
export declare class Props {
configuration: BarcodeScannerConfiguration;
configuration: BarcodeScannerScreenConfiguration;
onClose: () => void;

@@ -6,0 +6,0 @@ onSubmit: (barcodeScannerResult: BarcodeScannerUiResult) => void;

import React from "react";
import { BarcodeScannerUiResult, BarcodeScannerConfiguration } from "../../configuration";
import { BarcodeScannerUiResult, BarcodeScannerScreenConfiguration } from "../../configuration";
import { IBarcodeMapper } from "../utils/barcode-mapper/i-barcode-mapper";
declare class Props {
configuration: BarcodeScannerConfiguration;
configuration: BarcodeScannerScreenConfiguration;
onCameraPermissionDenied: () => void;

@@ -7,0 +7,0 @@ onSubmit: (barcodeScannerResult: BarcodeScannerUiResult) => void;

import React from "react";
import { BarcodeScannerConfiguration, BarcodeScannerUiResult } from "../../configuration";
import { BarcodeScannerScreenConfiguration, BarcodeScannerUiResult } from "../../configuration";
import { IBarcodeMapper } from "../utils/barcode-mapper/i-barcode-mapper";
declare class Props {
configuration: BarcodeScannerConfiguration;
configuration: BarcodeScannerScreenConfiguration;
onClose: () => void;

@@ -7,0 +7,0 @@ onSubmit: (barcodeScannerUIResult: BarcodeScannerUiResult) => void;

import BarcodePolygon from "../../../view/barcode-polygon/barocode-polygon";
import { ArOverlayBarcodeInfo } from "../views/ar/ar-overlay-barcode-info";
import { BarcodeItem, BarcodeScannerConfiguration, ExpectedBarcode } from "../../configuration";
import { BarcodeItem, BarcodeScannerScreenConfiguration, ExpectedBarcode } from "../../configuration";
import type React from "react";

@@ -28,3 +28,3 @@ export type CountedBarcode = {

export declare const findExpectedBarcode: (expectedBarcodes: ExpectedBarcode[], barcode: BarcodeItem) => ExpectedBarcode;
export declare function createCountedBarcodesReducer(configuration: BarcodeScannerConfiguration, lastCaptureTime: React.MutableRefObject<Date>, scanningEnabled: React.MutableRefObject<boolean>, beepAndVibrate: () => void): (countedBarcodes: Readonly<Readonly<CountedBarcode>[]>, action: CountedBarcodeAction) => Readonly<CountedBarcode>[];
export declare function createCountedBarcodesReducer(configuration: BarcodeScannerScreenConfiguration, lastCaptureTime: React.MutableRefObject<Date>, scanningEnabled: React.MutableRefObject<boolean>, beepAndVibrate: () => void): (countedBarcodes: Readonly<Readonly<CountedBarcode>[]>, action: CountedBarcodeAction) => Readonly<CountedBarcode>[];
export {};

@@ -1,3 +0,3 @@

import { BarcodeScannerViewConfiguration as BarcodeScannerViewConfig } from "../../../model/configuration/barcode-scanner-view-configuration";
import { BarcodeScannerConfiguration } from "../../configuration/barcode/BarcodeScannerConfiguration";
export declare function barcodeScannerViewConfigFromRtuUiConfig(config: BarcodeScannerConfiguration): Partial<BarcodeScannerViewConfig>;
import { BarcodeScannerViewConfiguration } from "../../../model/configuration/barcode-scanner-view-configuration";
import { BarcodeScannerScreenConfiguration } from "../../configuration/barcode/BarcodeScannerScreenConfiguration";
export declare function barcodeScannerViewConfigFromRtuUiConfig(config: BarcodeScannerScreenConfiguration): Partial<BarcodeScannerViewConfiguration>;

@@ -5,5 +5,5 @@ import { BoxProps } from "@mui/material";

interface Props extends BoxProps {
styleConfig: PolygonStyle;
polygonConfig: PolygonStyle;
}
export declare function StyledBox(props: Readonly<Props>): React.JSX.Element;
export {};

@@ -25,3 +25,4 @@ import React from "react";

barcodeMappedData: BarcodeMappedDataLoadingState | null;
readonlyCount?: number;
}
export declare function BarcodeInfo(props: BarcodeInfoProps): React.JSX.Element;

@@ -6,5 +6,5 @@ export * from "./configuration/barcode/SingleScanningModeUseCase";

export * from "./configuration/barcode/BarcodeTextLocalization";
export * from "./configuration/barcode/BarcodeRecognizerConfiguration";
export * from "./configuration/barcode/BarcodeScannerConfiguration";
export * from "./configuration/barcode/ArTrackingOverlayConfiguration";
export * from "./configuration/barcode/BarcodeScannerConfiguration";
export * from "./configuration/barcode/BarcodeScannerScreenConfiguration";
export * from "./configuration/barcode/BarcodeScannerUIResult";

@@ -11,0 +11,0 @@ export * from "./configuration/barcode/MultipleScanningModeUseCase";

import { BadgeStyle } from "../common/Common";
import { DeepPartial, PartiallyConstructible } from "../../common";
import { DeepPartial, PartiallyConstructible } from "../utils";
import { PolygonStyle } from "../common/Common";

@@ -4,0 +4,0 @@ import { StyledText } from "../common/Common";

import { BarcodeItemMapper } from "../BarcodeItemMapper";
import { ButtonConfiguration } from "../common/Common";
import { DeepPartial, PartiallyConstructible } from "../../common";
import { DeepPartial, PartiallyConstructible } from "../utils";
import { StyledText } from "../common/Common";

@@ -5,0 +5,0 @@ /**

@@ -1,221 +0,110 @@

import { ActionBarConfiguration } from "../common/ActionBarConfiguration";
import { BarcodeRecognizerConfiguration } from "../barcode/BarcodeRecognizerConfiguration";
import { BarcodeTextLocalization } from "../barcode/BarcodeTextLocalization";
import { BarcodeUseCase } from "../barcode/BarcodeUseCase";
import { CameraConfiguration } from "../common/CameraConfiguration";
import { CameraPermissionScreen } from "../common/CameraPermission";
import { DeepPartial, PartiallyConstructible } from "../../common";
import { Palette } from "../common/Common";
import { Sound } from "../common/Common";
import { Timeouts } from "../common/Common";
import { TopBarConfiguration } from "../common/TopBarConfiguration";
import { UserGuidanceConfiguration } from "../common/UserGuidanceConfiguration";
import { Vibration } from "../common/Common";
import { ViewFinderConfiguration } from "../common/ViewFinderConfiguration";
import { AustraliaPostCustomerFormat } from "../BarcodeConfigurationTypes";
import { BarcodeDocumentFormat } from "../BarcodeDocumentTypes";
import { BarcodeFormat } from "../BarcodeTypes";
import { BarcodeScannerEngineMode } from "../BarcodeScannerTypes";
import { DeepPartial, PartiallyConstructible } from "../utils";
import { Gs1Handling } from "../BarcodeTypes";
import { MsiPlesseyChecksumAlgorithm } from "../BarcodeConfigurationTypes";
/**
Configuration of the barcode scanner screen.
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.
*/
export type BarcodesExtensionFilter = "NO_FILTER" | "ONLY_WITH_EXTENSIONS" | "ONLY_WITHOUT_EXTENSIONS";
export declare const BarcodesExtensionFilterValues: BarcodesExtensionFilter[];
/**
Configuration of the scanning behavior.
*/
export declare class BarcodeScannerConfiguration extends PartiallyConstructible {
/**
Version number of the configuration object.
@defaultValue "1.0";
List of document formats to be extracted.
Defaults to all document formats.
@defaultValue ["AAMVA", "BOARDING_PASS", "DE_MEDICAL_PLAN", "MEDICAL_CERTIFICATE", "ID_CARD_PDF_417", "SEPA", "SWISS_QR", "VCARD", "GS1", "HIBC"];
*/
readonly version: string;
extractedDocumentFormats: BarcodeDocumentFormat[];
/**
The configuration object should be applied for this screen.
@defaultValue "BarcodeScanner";
Filter for extended EAN and UPC barcodes.
@defaultValue "NO_FILTER";
*/
readonly screen: string;
barcodesExtensionFilter: BarcodesExtensionFilter;
/**
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"
});
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 "";
*/
palette: Palette;
barcodesRegexFilter: string;
/**
Configuration of the all strings for barcode scanner.
@defaultValue new BarcodeTextLocalization({});
Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Barcodes with a sizeScore less than this value will not be scanned. When set to 0, barcodes are returned no matter what their size is.
@defaultValue 0.0;
*/
localization: BarcodeTextLocalization;
minimumSizeScore: number;
/**
Color of the screen's background.
@defaultValue "?sbColorSurfaceLow";
Optional minimum required text length of the detected barcode. The default is 0 (setting is turned off). NOTE - This feature works on ITF barcodes only.
@defaultValue 0;
*/
backgroundColor: string;
minimumTextLength: number;
/**
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
})
})
});
Optional maximum text length of the detected barcode. The default is 0 (setting is turned off). NOTE - This feature works on ITF barcodes only.
@defaultValue 0;
*/
topBar: TopBarConfiguration;
maximumTextLength: number;
/**
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"
})
});
Optional minimum required quiet zone on the barcode. Measured in modules (the smallest bar size on a barcode). The default is 10. NOTE - This feature works on ITF barcodes only.
@defaultValue 10;
*/
actionBar: ActionBarConfiguration;
minimum1DBarcodesQuietZone: number;
/**
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
})
});
If `true`, check digits for UPC, EAN and MSI Plessey codes are removed from the result. Has no effect if both single and double digit MSI Plessey checksums are enabled. The default is `false`.
@defaultValue false;
*/
viewFinder: ViewFinderConfiguration;
stripCheckDigits: boolean;
/**
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
})
});
If `true`, the optional check digit for IATA_2_OF_5 codes is used in validation. The default is `true`.
@defaultValue true;
*/
userGuidance: UserGuidanceConfiguration;
useIATA2OF5Checksum: boolean;
/**
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"
})
});
If `true`, the optional check digit for CODE_11 codes is used in validation. The default is `true`.
@defaultValue true;
*/
cameraPermission: CameraPermissionScreen;
useCode11Checksum: boolean;
/**
Configuration of the camera behavior.
@defaultValue new CameraConfiguration({});
List of accepted barcode symbologies.
Defaults to common types.
@defaultValue ["AZTEC", "CODABAR", "CODE_39", "CODE_93", "CODE_128", "DATA_MATRIX", "DATABAR", "DATABAR_EXPANDED", "DATABAR_LIMITED", "EAN_13", "EAN_8", "ITF", "MICRO_QR_CODE", "PDF_417", "QR_CODE", "UPC_A", "UPC_E"];
*/
cameraConfiguration: CameraConfiguration;
barcodeFormats: BarcodeFormat[];
/**
Configuration of the scanning behavior.
@defaultValue new BarcodeRecognizerConfiguration({});
Checksum algorithm used for MSI Plessey barcodes. The default value is MOD_10.
@defaultValue "MOD_10";
*/
recognizerConfiguration: BarcodeRecognizerConfiguration;
msiPlesseyChecksumAlgorithm: MsiPlesseyChecksumAlgorithm;
/**
Configuration of the barcode scanner screen's behavior.
@defaultValue new SingleScanningMode({});
The customer format used in AUSTRALIA_POST codes. The default value is ALPHA_NUMERIC.
@defaultValue "ALPHA_NUMERIC";
*/
useCase: BarcodeUseCase;
australiaPostCustomerFormat: AustraliaPostCustomerFormat;
/**
Configuration of the scan confirmation sound.
@defaultValue new Sound({
"successBeepEnabled": true,
"soundType": "MODERN_BEEP"
});
The expected way of handling GS1_COMPOSITE barcodes.
@defaultValue "PARSE";
*/
sound: Sound;
gs1Handling: Gs1Handling;
/**
Configuration of the scan scan confirmation vibration.
@defaultValue new Vibration({
"enabled": true
});
The engine mode to use for barcode scanning.
@defaultValue "NEXT_GEN_LOW_POWER";
*/
vibration: Vibration;
engineMode: BarcodeScannerEngineMode;
/**
Configuration of timeouts.
@defaultValue new Timeouts({
"autoCancelTimeout": 0,
"initialScanDelay": 0
});
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;
*/
timeouts: Timeouts;
maximumRecognizerResolution: number;
/** @param source {@displayType `DeepPartial<BarcodeScannerConfiguration>`} */
constructor(source?: DeepPartial<BarcodeScannerConfiguration>);
}
import { BarcodeItem } from "../BarcodeScannerTypes";
import { DeepPartial, PartiallyConstructible } from "../../common";
import { DeepPartial, PartiallyConstructible } from "../utils";
/**

@@ -8,7 +8,7 @@ Data about the scanned barcode.

/**
Recognized barcode.
Scanned barcode.
*/
readonly barcode: BarcodeItem;
/**
Number of recognized barcodes of this symbology and value.
Number of scanned barcodes of this symbology and value.
*/

@@ -24,3 +24,3 @@ readonly count: number;

/**
Recognized barcode items.
Scanned barcode items.
@defaultValue [];

@@ -27,0 +27,0 @@ */

@@ -1,2 +0,2 @@

import { DeepPartial, PartiallyConstructible } from "../../common";
import { DeepPartial, PartiallyConstructible } from "../utils";
/**

@@ -3,0 +3,0 @@ Configuration of the all strings for barcode scanner.

import { ArOverlayFindAndPickConfiguration } from "../barcode/ArTrackingOverlayConfiguration";
import { DeepPartial, PartiallyConstructible } from "../../common";
import { DeepPartial, PartiallyConstructible } from "../utils";
import { ManualCountEditDialog } from "../barcode/MultipleScanningModeUseCase";

@@ -4,0 +4,0 @@ import { ScanbotAlertDialog } from "../common/ScanbotAlertDialog";

@@ -5,3 +5,3 @@ import { ArOverlayGeneralConfiguration } from "../barcode/ArTrackingOverlayConfiguration";

import { ButtonConfiguration } from "../common/Common";
import { DeepPartial, PartiallyConstructible } from "../../common";
import { DeepPartial, PartiallyConstructible } from "../utils";
import { IconStyle } from "../common/Common";

@@ -8,0 +8,0 @@ import { StyledText } from "../common/Common";

import { ArOverlayGeneralConfiguration } from "../barcode/ArTrackingOverlayConfiguration";
import { BarcodeInfoMapping } from "../barcode/BarcodeInfoMapping";
import { ButtonConfiguration } from "../common/Common";
import { DeepPartial, PartiallyConstructible } from "../../common";
import { DeepPartial, PartiallyConstructible } from "../utils";
import { StyledText } from "../common/Common";

@@ -6,0 +6,0 @@ /**

@@ -1,2 +0,2 @@

export { BarcodeItem, BarcodeScannerEngineModeValues } from "../../core/bridge/compiled/BarcodeScannerTypes";
export { BarcodeItem, BarcodeScannerEngineModeValues, } from "../../core/bridge/compiled/BarcodeScannerTypes";
export type { BarcodeScannerEngineMode } from "../../core/bridge/compiled/BarcodeScannerTypes";

@@ -1,1 +0,1 @@

export type { BarcodeFormat, Gs1Handling, Gs1HandlingValues, BarcodeFormatValues } from "../../core/bridge/compiled/BarcodeTypes";
export type { BarcodeFormat, Gs1Handling, Gs1HandlingValues, BarcodeFormatValues, } from "../../core/bridge/compiled/BarcodeTypes";

@@ -1,2 +0,2 @@

import { DeepPartial, PartiallyConstructible } from "../../common";
import { DeepPartial, PartiallyConstructible } from "../utils";
import { RoundButton } from "../common/Common";

@@ -3,0 +3,0 @@ /**

@@ -1,2 +0,2 @@

import { DeepPartial, PartiallyConstructible } from "../../common";
import { DeepPartial, PartiallyConstructible } from "../utils";
/**

@@ -3,0 +3,0 @@ Ideal resolution of the camera preview.

import { ButtonConfiguration } from "../common/Common";
import { DeepPartial, PartiallyConstructible } from "../../common";
import { DeepPartial, PartiallyConstructible } from "../utils";
import { IconStyle } from "../common/Common";

@@ -4,0 +4,0 @@ import { StyledText } from "../common/Common";

@@ -1,2 +0,2 @@

import { DeepPartial, PartiallyConstructible } from "../../common";
import { DeepPartial, PartiallyConstructible } from "../utils";
/**

@@ -3,0 +3,0 @@ Value palette describing the colors of the scanner screens.

import { ButtonConfiguration } from "../common/Common";
import { DeepPartial, PartiallyConstructible } from "../../common";
import { DeepPartial, PartiallyConstructible } from "../utils";
import { StyledText } from "../common/Common";

@@ -4,0 +4,0 @@ /**

import { ButtonConfiguration } from "../common/Common";
import { DeepPartial, PartiallyConstructible } from "../../common";
import { DeepPartial, PartiallyConstructible } from "../utils";
import { StyledText } from "../common/Common";

@@ -4,0 +4,0 @@ /**

import { BackgroundStyle } from "../common/Common";
import { DeepPartial, PartiallyConstructible } from "../../common";
import { DeepPartial, PartiallyConstructible } from "../utils";
import { IconStyle } from "../common/Common";

@@ -4,0 +4,0 @@ import { StyledText } from "../common/Common";

import { AspectRatio } from "../Geometry";
import { DeepPartial, PartiallyConstructible } from "../../common";
import { DeepPartial, PartiallyConstructible } from "../utils";
/**

@@ -4,0 +4,0 @@ Configuration of the scanning interface's viewfinder, serving as guidance to the user.

import { BarButtonConfiguration } from "../common/Common";
import { DeepPartial, PartiallyConstructible } from "../../common";
import { DeepPartial, PartiallyConstructible } from "../utils";
import { DocumentQuality } from "../DocumentQualityAnalyzerTypes";
import { IconUserGuidanceConfiguration } from "../common/UserGuidanceConfiguration";
import { StyledText } from "../common/Common";
/**

@@ -86,2 +87,11 @@ Determines, after each page is snapped, whether the acknowledgment screen should be displayed or not.

/**
Configuration of the title, located in the top bar.
@defaultValue new StyledText({
"visible": false,
"text": "?acknowledgementTitle",
"color": "?sbColorOnPrimary"
});
*/
topBarTitle: StyledText;
/**
The minimum quality of a scanned page to be deemed acceptable. Used in conjunction with the acknowledgement mode.

@@ -88,0 +98,0 @@ @defaultValue "POOR";

@@ -6,3 +6,3 @@ import { AcknowledgementScreenConfiguration } from "../document/AcknowledgementScreenConfiguration";

import { CameraPermissionScreen } from "../common/CameraPermission";
import { DeepPartial, PartiallyConstructible } from "../../common";
import { DeepPartial, PartiallyConstructible } from "../utils";
import { DocumentScannerCameraConfiguration } from "../document/DocumentScannerCameraConfiguration";

@@ -9,0 +9,0 @@ import { DocumentScannerUserGuidance } from "../document/DocumentScannerUserGuidance";

import { BarButtonConfiguration } from "../common/Common";
import { ButtonConfiguration } from "../common/Common";
import { DeepPartial, PartiallyConstructible } from "../../common";
import { DeepPartial, PartiallyConstructible } from "../utils";
import { StyledText } from "../common/Common";

@@ -135,2 +135,7 @@ /**

/**
The color of the magnetic lines on the cropping polygon.
@defaultValue "?sbColorSurface";
*/
croppingPolygonMagneticLineColor: string;
/**
Configuration of the bottom bar for the cropping screen.

@@ -137,0 +142,0 @@ @defaultValue new CroppingBottomBar({});

import { AspectRatio } from "../Geometry";
import { CameraModule } from "../common/CameraConfiguration";
import { DeepPartial, PartiallyConstructible } from "../../common";
import { DeepPartial, PartiallyConstructible } from "../utils";
import { Resolution } from "../common/CameraConfiguration";
/**

@@ -14,2 +15,7 @@ Configuration of the camera behavior.

/**
Determines whether the document should be cropped automatically after a manual snap or not.
@defaultValue true;
*/
autoCropOnManualSnap: boolean;
/**
Determines whether the flashlight is enabled or not on start-up.

@@ -20,2 +26,10 @@ @defaultValue false;

/**
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;
/**
The minimum pitch/skew angle of the document to be accepted. The value must be between 0.0 and 1.0.

@@ -22,0 +36,0 @@ @defaultValue 0.75;

@@ -1,2 +0,2 @@

import { DeepPartial, PartiallyConstructible } from "../../common";
import { DeepPartial, PartiallyConstructible } from "../utils";
import { ParametricFilter } from "../ParametricFilters";

@@ -3,0 +3,0 @@ /**

import { CameraScreenConfiguration } from "../document/CameraScreenConfiguration";
import { CroppingScreenConfiguration } from "../document/CroppingScreenConfiguration";
import { DeepPartial, PartiallyConstructible } from "../../common";
import { DeepPartial, PartiallyConstructible } from "../utils";
import { ReviewScreenConfiguration } from "../document/ReviewScreenConfiguration";

@@ -5,0 +5,0 @@ /**

@@ -1,2 +0,2 @@

import { DeepPartial, PartiallyConstructible } from "../../common";
import { DeepPartial, PartiallyConstructible } from "../utils";
/**

@@ -332,2 +332,7 @@ Configuration of all the strings for the standalone cropping screen.

/**
The title of the acknowledgement screen, located in the top bar.
@defaultValue "Acknowledgement";
*/
acknowledgementTitle: string;
/**
The text for the static user guidance, located just below the top bar of the reorder pages screen.

@@ -334,0 +339,0 @@ @defaultValue "Drag pages to reorder";

import { BackgroundStyle } from "../common/Common";
import { DeepPartial, PartiallyConstructible } from "../../common";
import { DeepPartial, PartiallyConstructible } from "../utils";
import { StyledText } from "../common/Common";

@@ -4,0 +4,0 @@ import { UserGuidanceVisibility } from "../document/DocumentScannerGuidanceVisibility";

@@ -1,2 +0,2 @@

import { DeepPartial, PartiallyConstructible } from "../../common";
import { DeepPartial, PartiallyConstructible } from "../utils";
import { DocumentScannerOutputSettings } from "../document/DocumentScannerOutputSettings";

@@ -3,0 +3,0 @@ import { DocumentScannerScreens } from "../document/DocumentScannerScreens";

import { ButtonConfiguration } from "../common/Common";
import { DeepPartial, PartiallyConstructible } from "../../common";
import { DeepPartial, PartiallyConstructible } from "../utils";
import { StyledText } from "../common/Common";

@@ -4,0 +4,0 @@ /**

import { BarButtonConfiguration } from "../common/Common";
import { ButtonConfiguration } from "../common/Common";
import { DeepPartial, PartiallyConstructible } from "../../common";
import { DeepPartial, PartiallyConstructible } from "../utils";
import { IconButton } from "../common/Common";

@@ -5,0 +5,0 @@ import { PopupMenuItem } from "../common/Common";

@@ -1,2 +0,2 @@

import { DeepPartial, PartiallyConstructible } from "../../common";
import { DeepPartial, PartiallyConstructible } from "../utils";
import { PageData } from "../native/PageData";

@@ -3,0 +3,0 @@ /**

@@ -1,2 +0,2 @@

import { DeepPartial, PartiallyConstructible } from "../../common";
import { DeepPartial, PartiallyConstructible } from "../utils";
import { DocumentDetectionStatus } from "../DocumentScannerTypes";

@@ -6,3 +6,3 @@ import { DocumentQuality } from "../DocumentQualityAnalyzerTypes";

import { ParametricFilter } from "../ParametricFilters";
import { Point } from "../../common";
import { Point } from "../utils";
/**

@@ -9,0 +9,0 @@ The result of the health insurance card recognition.

@@ -1,2 +0,2 @@

import { type Point } from "../../common";
import { type Point } from "../../configuration/utils";
import ScanbotSDK from "../../../scanbot-sdk";

@@ -3,0 +3,0 @@ import { CroppedDetectionResult, DeepPartial, PdfConfiguration, TiffGeneratorParameters } from "../../../core-types";

@@ -8,3 +8,3 @@ import * as Config from "./configuration";

static createDocumentScanner(config: Config.DocumentScanningFlow, documentId?: number): Promise<DocumentScannerUIResult | null>;
static createBarcodeScanner(config: Config.BarcodeScannerConfiguration): Promise<BarcodeScannerUiResult | null>;
static createBarcodeScanner(config: Config.BarcodeScannerScreenConfiguration): Promise<BarcodeScannerUiResult | null>;
private static createRoot;

@@ -11,0 +11,0 @@ private static checkLicense;

@@ -16,3 +16,3 @@ import { WorkerBridge as CoreWorkerBridge, WorkerBridgeInitOptions } from "../core/bridge/worker-bridge";

}) => Promise<any>;
getLicenseInfo: () => Promise<any>;
getLicenseInfo: () => Promise<import("../core-types").SdkLicenseInfo>;
encodeJpeg: (image: import("../core-types").Image) => Promise<Uint8Array>;

@@ -85,3 +85,4 @@ detectDocument: (image: import("../core-types").Image, options: {

code39?: boolean;
pzn?: boolean;
pzn7?: boolean;
pzn8?: boolean;
tryCode39ExtendedMode?: boolean;

@@ -539,3 +540,3 @@ useCode39CheckDigit?: boolean;

}) => Promise<any>;
getLicenseInfo: () => Promise<any>;
getLicenseInfo: () => Promise<import("../core-types").SdkLicenseInfo>;
encodeJpeg: (image: import("../core-types").Image) => Promise<Uint8Array>;

@@ -608,3 +609,4 @@ detectDocument: (image: import("../core-types").Image, options: {

code39?: boolean;
pzn?: boolean;
pzn7?: boolean;
pzn8?: boolean;
tryCode39ExtendedMode?: boolean;

@@ -611,0 +613,0 @@ useCode39CheckDigit?: boolean;

{
"name": "scanbot-web-sdk",
"title": "Web Scan SDK",
"version": "7.0.0-rc.2",
"version": "7.0.0-rc.3",
"description": "Scanbot Web Document and Barcode Scanner SDK",

@@ -6,0 +6,0 @@ "keywords": [

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

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc