@pixelverse/strichjs-sdk 1.4.3 → 1.4.4

package/dist/strich.d.ts

@@ -1,191 +1,146 @@
 /**
- * STRICH SDK error class
+ * BarcodeReader is the primary interface of the STRICH SDK.
  */
-export class SdkError extends Error {
+export declare class BarcodeReader {
+    private configuration;
     /**
-     * Flag indicating if this error is related to camera access.
+     * User-supplied barcode detection handler.
+     *
+     * This is a synchronous call, so further processing will not happen until the handler returns.
      */
-    duringCameraAccess: boolean;
+    detected?: (detections: CodeDetection[]) => (void);
     /**
-     * A localized error message, if available, otherwise this will contain the non-localized message.
+     * Optional user-supplied error callback.
+     *
+     * This is invoked by the BarcodeReader if an error occurred while processing frames, and is usually not
+     * recoverable.
      */
-    localizedMessage: string;
+    onError?: (error: Error) => (void);
     /**
-     * An optional underlying error that caused this error.
+     * Create a new BarcodeReader using a Configuration.
+     *
+     * @param configuration - A configuration object.
      */
-    cause?: Error;
+    constructor(configuration: Configuration);
     /**
-     * An optional detail message to display to disambiguate multiple errors (not-translated)
+     * Initialize the BarcodeReader instance.
+     *
+     * @returns A promise resolving to an initialized BarcodeReader instance, or an error object.
      */
-    detailMessage?: string;
-    constructor(keyOrMessage: string, cause?: Error);
+    initialize(): Promise<BarcodeReader>;
     /**
-     * Create an SDK error for a license checking error including detail.
-     *
-     * This sets the detailMessage member but also adds the detail message to
-     * message itself, as it contains valuable hints as to why the license
-     * check failed.
-     *
-     * @param detailMessage
+     * Start scanning for barcodes.
      */
-    static invalidLicenseErrorWithDetail(detailMessage: string): SdkError;
-}
-/**
- * Configuration for the frame source (camera).
- */
-export interface FrameSourceConfiguration {
+    start(): Promise<void>;
+    private tick;
     /**
-     * Video frame resolution.
-     *
-     * @remarks
-     * The default resolution is 720p, which is usually enough for good quality
-     * barcodes. You can try higher resolutions if you have very fine or
-     * degraded codes, at the expense of higher computational requirements.
+     * Stop the BarcodeReader instance.
      *
-     * @defaultValue hd
+     * This will temporarily suspend processing of camera frames / detection of codes.
      */
-    resolution?: 'hd' | 'full-hd' | 'auto';
+    stop(): Promise<void>;
     /**
-     * Remember the camera that was last used to successfully scan a code.
+     * Destroy this BarcodeReader instance, making it unusable.
      *
-     * @remarks
-     * If this is set to true, the frame source will remember the camera used
-     * whenever a code was successfully scanned, and attempt to use the same
-     * camera again when re-initialized.
+     * This will release all associated resources, and should be called whenever an application no longer needs to
+     * scan.
      *
-     * @defaultValue false
+     * @returns Promise that resolves when the BarcodeReader and its associated resources are fully destroyed.
      */
-    rememberCameraDeviceId?: boolean;
+    destroy(): Promise<void>;
     /**
-     * Allow passing in exact constraints for camera device selection via
-     * [getUserMedia](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia#constraints).
-     * If set, will override the {@link resolution} property and any other camera-related properties.
-     *
-     * @example
-     * In the example below, a camera device is explicitly selected by ID. Audio is explicitly not requested (never
-     * used by STRICH) and an HD-like resolution preference is specified by range.
-     *
-     * ```js
-     * constraints: {
-     *   video: {
-     *     deviceId: {
-     *       exact: '2d122f8e0630b5a6a19c157f066e13e05115f12f7d4dfb29e5560b4acefe7308'
-     *     },
-     *     width: {min: 800, ideal: 1280, max: 1600},
-     *     height: {min: 600, ideal: 720, max: 900}
-     *   },
-     *   audio: false
-     * }
-     * ```
-     *
-     * @remarks
-     * This is an advanced option, and should only be used if you are familiar with the
-     * [Media Capture and Streams API](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia)
-     * and have to build your own camera selection workflow.
+     * Show/hide the BarcodeReader instance.
      *
-     * @defaultValue undefined
+     * @param visible - True/false for visible/hidden
      */
-    constraints?: MediaStreamConstraints;
+    setVisible(visible: boolean): Promise<void>;
+    /**
+     * @returns the current visibility of this BarcodeReader instance
+     */
+    getVisible(): boolean;
 }
+
 /**
- * The region of interest is specified as an inset between screen edge and RoE on each side,
- * expressed as a fractional value (between 0 and 0.5).
- *
- * For instance, to have an area that occupies the middle 80% horizontal area and 50% vertical area, you would
- * specify the region of interest as follows:
- *
- * ```json
- * { left: 0.1, right: 0.1, top: 0.25, bottom: 0.25 }
- * ```
- * (10% width inset on each side, 25% height inset on each side)
+ * A code detection reported by the STRICH SDK.
  */
-export interface RegionOfInterest {
+export declare interface CodeDetection {
     /**
-     * Left inset, relative [0 .. 0.5].
-     *
-     * @example 0.1
+     * The textual data contained in the code.
      */
-    left: number;
+    data: string;
     /**
-     * Top inset, relative [0 .. 0.5].
-     *
-     * @example 0.25
+     * The type of detected code.
      */
-    top: number;
+    typeName: string;
     /**
-     * Right inset, relative [0 .. 0.5].
+     * Supplemental data for this code.
+     */
+    supplementalData: string | null;
+    /**
+     * The bounding rectangle in which the code was detected.
      *
-     * @example 0.1
+     * Note: this might not be precise, especially for 1D barcodes.
      */
-    right: number;
+    boundingRect: Rect;
     /**
-     * Bottom inset, relative [0 .. 0.5]
+     * The quadrilateral in which the code was detected.
      *
-     * @example 0.25
+     * For rotated or warped codes, this might contain a more precise location estimate than boundingRect.
      */
-    bottom: number;
+    quadrilateral: Quadrilateral;
+    /**
+     * The time of detection.
+     */
+    time: number;
+    /**
+     * The raw contained bytes contained in the code.
+     */
+    rawData: Uint8Array;
 }
+
 /**
- * Locator configuration
+ * BarcodeReader configuration object.
  */
-export interface LocatorConfiguration {
+export declare interface Configuration {
     /**
-     * The region of interest in viewport coordinates.
+     * CSS Selector or reference to the HTML element that will host the visible elements of the BarcodeReader.
      *
-     * @remarks if no region of interest is specified, an appropriate one will automatically be selected at run-time
-     * depending on the configured symbologies.
+     * @remarks
+     * When using a selector, make sure the selector only matches a single element, e.g. by using an ID.
      */
-    regionOfInterest?: RegionOfInterest;
+    selector: string | HTMLElement;
     /**
-     * Disregard colorful areas, assume barcodes are printed black on white.
+     * Mode: can be 'immediate' (default) for always-on scanning, and 'touch', to only scan when a touch occurs.
      *
-     * @remarks This is an advanced setting and should normally not be changed.
-     * @defaultValue false
+     * @defaultValue immediate
      */
-    chromaReject?: boolean;
+    mode?: 'immediate' | 'touch';
     /**
-     * The locator implementation to use. This should normally not be changed, unless it is specifically required
-     * to target WebGL 1.
-     *
-     * @remarks This is an advanced setting and should normally not be changed, unless targeting WebGL1 and not
-     * WebGL2 is explicitly required.
-     * @defaultValue auto
+     * Frame source configuration
      */
-    impl?: 'auto' | 'webgl1' | 'webgl2';
+    frameSource?: FrameSourceConfiguration;
     /**
-     * Disable asynchronous reads from GPU when using `webgl2` {@link impl}.
-     *
-     * @remarks Some older iOS versions have issues with WebGL2 asynchronous reads. There is usually no need to change
-     * this setting from its default.
-     * @defaultValue false
+     * Locator configuration
      */
-    forceSyncReadback?: boolean;
-}
-/**
- * The supported symbologies.
- */
-export type SymbologyName = 'ean13' | 'ean8' | 'ean5' | 'ean2' | 'upca' | 'upce' | 'databar' | 'databar-exp' | 'code39' | 'code93' | 'code128' | 'i25' | 'codabar' | 'qr' | 'aztec' | 'datamatrix' | 'pdf417';
-/**
- * For variable-length symbologies, min/max length can be specified in addition to the symbology.
- */
-export type SymbologySpec = {
+    locator?: LocatorConfiguration;
     /**
-     * The name of the symbology.
+     * Engine configuration
      */
-    name: SymbologyName;
+    engine?: EngineConfiguration;
     /**
-     * The minimum length of the barcode, only has an effect for variable-length symbologies.
+     * Overlay configuration
      */
-    minLen?: number;
+    overlay?: OverlayConfiguration;
     /**
-     * The maximum length of the barcode, only has an effect for variable-length symbologies.
+     * Feedback configuration
      */
-    maxLen?: number;
-};
+    feedback?: FeedbackConfiguration;
+}
+
 /**
  * Engine configuration
  */
-export interface EngineConfiguration {
+export declare interface EngineConfiguration {
     /**
      * The enabled symbologies.
      *
@@ -195,8 +150,8 @@ export interface EngineConfiguration {
      *
      * @example ['qr', 'code128']
      *
-     * @default
-     * ```undefined```
+     * @defaultValue
+     * `undefined`
      * (all symbologies enabled - NOT RECOMMENDED)
      */
     symbologies?: (SymbologyName | SymbologySpec)[];
@@ -219,60 +174,171 @@ export interface EngineConfiguration {
      */
     minScanlinesNeeded?: number;
     /**
-     * Toggle recognition of inverted barcodes (light print on dark background).
-     *
-     * @remarks
-     * This should only be enabled if you need to detect these barcodes, as additional processing will take place.
+     * Toggle recognition of inverted barcodes (light print on dark background).
+     *
+     * @remarks
+     * This should only be enabled if you need to detect these barcodes, as additional processing will take place.
+     *
+     * @defaultValue false
+     */
+    invertedCodes?: boolean;
+    /**
+     * Time interval in milliseconds during which multiple detections of the same code are not repeated.
+     *
+     * @remarks It is recommended to set a duplicateInterval as scans are metered except in Enterprise subscriptions.
+     * @defaultValue 750
+     */
+    duplicateInterval?: number;
+    /**
+     * Set the minimum occurrence count for 1D barcodes with weak checksums in a given time window for it be accepted.
+     *
+     * @remarks
+     * Setting this parameter to 0 disables hysteresis (default behavior for versions up to 1.1.0)
+     *
+     * @defaultValue 2
+     */
+    hysteresisMinCount?: number;
+    /**
+     * Set the duration of the hysteresis window in milliseconds.
+     *
+     * @defaultValue 350
+     */
+    hysteresisInterval?: number;
+}
+
+/**
+ * User feedback configuration
+ */
+export declare interface FeedbackConfiguration {
+    /**
+     * Toggle audible beep upon successful scan.
+     *
+     * @defaultValue true
+     */
+    audio?: boolean;
+    /**
+     * Toggle vibration upon successful scan, if supported by device.
+     *
+     * @defaultValue true
+     */
+    vibration?: boolean;
+}
+
+/**
+ * Configuration for the frame source (camera).
+ */
+export declare interface FrameSourceConfiguration {
+    /**
+     * Video frame resolution.
+     *
+     * @remarks
+     * The default resolution is 720p, which is usually enough for good quality
+     * barcodes. You can try higher resolutions if you have very fine or
+     * degraded codes, at the expense of higher computational requirements.
+     *
+     * @defaultValue hd
+     */
+    resolution?: 'hd' | 'full-hd' | 'auto';
+    /**
+     * Remember the camera that was last used to successfully scan a code.
+     *
+     * @remarks
+     * If this is set to true, the frame source will remember the camera used
+     * whenever a code was successfully scanned, and attempt to use the same
+     * camera again when re-initialized.
+     *
+     * @defaultValue false
+     */
+    rememberCameraDeviceId?: boolean;
+    /**
+     * Allow passing in exact constraints for camera device selection via
+     * [getUserMedia](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia#constraints).
+     * If set, will override the {@link FrameSourceConfiguration.resolution} property and any other camera-related properties.
+     *
+     * @example
+     * In the example below, a camera device is explicitly selected by ID. Audio is explicitly not requested (never
+     * used by STRICH) and an HD-like resolution preference is specified by range.
+     *
+     * ```js
+     * constraints: {
+     *   video: {
+     *     deviceId: {
+     *       exact: '2d122f8e0630b5a6a19c157f066e13e05115f12f7d4dfb29e5560b4acefe7308'
+     *     },
+     *     width: {min: 800, ideal: 1280, max: 1600},
+     *     height: {min: 600, ideal: 720, max: 900}
+     *   },
+     *   audio: false
+     * }
+     * ```
+     *
+     * @remarks
+     * This is an advanced option, and should only be used if you are familiar with the
+     * [Media Capture and Streams API](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia)
+     * and have to build your own camera selection workflow.
+     *
+     * @defaultValue undefined
+     */
+    constraints?: MediaStreamConstraints;
+}
+
+/**
+ * Locator configuration
+ */
+export declare interface LocatorConfiguration {
+    /**
+     * The region of interest in viewport coordinates.
      *
-     * @defaultValue false
+     * @remarks if no region of interest is specified, an appropriate one will automatically be selected at run-time
+     * depending on the configured symbologies.
      */
-    invertedCodes?: boolean;
+    regionOfInterest?: RegionOfInterest;
     /**
-     * Time interval in milliseconds during which multiple detections of the same code are not repeated.
+     * Disregard colorful areas, assume barcodes are printed black on white.
      *
-     * @remarks It is recommended to set a duplicateInterval as scans are metered except in Enterprise subscriptions.
-     * @defaultValue 750
+     * @remarks This is an advanced setting and should normally not be changed.
+     * @defaultValue false
      */
-    duplicateInterval?: number;
+    chromaReject?: boolean;
     /**
-     * Set the minimum occurrence count for 1D barcodes with weak checksums in a given time window for it be accepted.
-     *
-     * @remarks
-     * Setting this parameter to 0 disables hysteresis (default behavior for versions <= 1.1.0)
+     * The locator implementation to use. This should normally not be changed, unless it is specifically required
+     * to target WebGL 1.
      *
-     * @defaultValue 2
+     * @remarks This is an advanced setting and should normally not be changed, unless targeting WebGL1 and not
+     * WebGL2 is explicitly required.
+     * @defaultValue auto
      */
-    hysteresisMinCount?: number;
+    impl?: 'auto' | 'webgl1' | 'webgl2';
     /**
-     * Set the duration of the hysteresis window in milliseconds.
+     * Disable asynchronous reads from GPU when using `webgl2` {@link LocatorConfiguration.impl}.
      *
-     * @defaultValue 350
+     * @remarks Some older iOS versions have issues with WebGL2 asynchronous reads. There is usually no need to change
+     * this setting from its default.
+     * @defaultValue false
      */
-    hysteresisInterval?: number;
+    forceSyncReadback?: boolean;
 }
+
 /**
  * Overlay configuration
  */
-export interface OverlayConfiguration {
+export declare interface OverlayConfiguration {
     /**
      * Indicate if a horizontal line should be drawn to aid in positioning 1D barcodes.
      *
      * @defaultValue true
-     * @category Styling
      */
     showTargetingLine?: boolean;
     /**
      * Indicate if the overlay should draw the bounding boxes of detected barcodes on top of the camera preview.
      *
      * @defaultValue true
-     * @category Styling
      */
     showDetections?: boolean;
     /**
      * Indicate if the camera selector should be shown in the overlay.
      *
      * @defaultValue true
-     * @category Interaction
      */
     showCameraSelector?: boolean;
     /**
@@ -282,7 +348,6 @@ export interface OverlayConfiguration {
      * offered in the camera selector.
      *
      * @defaultValue true
-     * @category Interaction
      */
     filterCameras?: boolean;
     /**
@@ -290,7 +355,6 @@ export interface OverlayConfiguration {
      *
      * @remarks Flashlight functionality is not supported in some browsers.
      * @defaultValue true
-     * @category Interaction
      */
     showFlashlight?: boolean;
     /**
@@ -298,7 +362,6 @@ export interface OverlayConfiguration {
      *
      * @remarks Triggering autofocus is currently only available on Android devices.
      * @defaultValue true
-     * @category Interaction
      */
     focusOnTap?: boolean;
     /**
@@ -306,7 +369,6 @@ export interface OverlayConfiguration {
      * format, with the color components given as integers with no separating whitespace.
      *
      * @defaultValue rgb(255,255,255)
-     * @category Styling
      */
     primaryColor?: string;
     /**
@@ -314,9 +376,8 @@ export interface OverlayConfiguration {
      * components given as integers with no separating whitespace. The fill will become transparent when the
      * detection becomes stale.
      *
-     * @remarks Only has an effect if {@link showDetections} is true.
+     * @remarks Only has an effect if {@link OverlayConfiguration.showDetections} is true.
      * @defaultValue rgb(0,0,255)
-     * @category Styling
      */
     detectionFillColor?: string;
     /**
@@ -324,9 +385,8 @@ export interface OverlayConfiguration {
      * with the color components given as integers with no separating whitespace. The border will become transparent
      * when the detection becomes stale.
      *
-     * @remarks Only has an effect if {@link showDetections} is true.
+     * @remarks Only has an effect if {@link OverlayConfiguration.showDetections} is true.
      * @defaultValue undefined
-     * @category Styling
      */
     detectionBorderColor?: string;
     /**
@@ -336,7 +396,6 @@ export interface OverlayConfiguration {
      * The allowed range is 0 to 4 pixels. Values outside the range are clamped.
      *
      * @defaultValue 0
-     * @category Styling
      */
     detectionBorderWidth?: number;
     /**
@@ -344,7 +403,6 @@ export interface OverlayConfiguration {
      * Must be specified in rgb() format, with the color components given as integers with no separating whitespace.
      *
      * @defaultvalue rgb(255,0,0)
-     * @category Styling
      */
     targetingLineActiveColor?: string;
     /**
@@ -353,7 +411,6 @@ export interface OverlayConfiguration {
      * The allowed range of the corner radius is 0 to 8 pixels.
      *
      * @defaultValue 0
-     * @category Styling
      */
     cornerRadius?: number;
     /**
@@ -363,84 +420,116 @@ export interface OverlayConfiguration {
      * should have a transparent background (WebP or PNG format). The recommended size is 140x30 pixels.
      *
      * @remarks This is an enterprise-only capability.
-     * @category Styling
      */
     customLogoSrc?: string;
 }
+
 /**
- * User feedback configuration
+ * A point in two-dimensional space.
+ *
+ * The y coordinate origin starts at the top.
  */
-export interface FeedbackConfiguration {
+export declare interface Point {
     /**
-     * Toggle audible beep upon successful scan.
-     *
-     * @defaultValue true
+     * The x-coordinate in pixels.
      */
-    audio?: boolean;
+    x: number;
     /**
-     * Toggle vibration upon successful scan, if supported by device.
-     *
-     * @defaultValue true
+     * The y-coordinate in pixels.
      */
-    vibration?: boolean;
+    y: number;
 }
+
 /**
- * BarcodeReader configuration object.
+ * A non-intersecting polygon with four points.
  */
-export interface Configuration {
+export declare interface Quadrilateral {
     /**
-     * CSS Selector or reference to the HTML element that will host the visible elements of the BarcodeReader.
-     *
-     * @remarks
-     * When using a selector, make sure the selector only matches a single element, e.g. by using an ID.
+     * The 4 points forming the quadrilateral.
      */
-    selector: string | HTMLElement;
+    points: Point[];
+}
+
+/**
+ * An axis-aligned rectangle in two-dimensional space.
+ */
+export declare interface Rect {
     /**
-     * Mode: can be 'immediate' (default) for always-on scanning, and 'touch', to only scan when a touch occurs.
-     *
-     * @defaultValue immediate
+     * The origin of the rectangle.
      */
-    mode?: 'immediate' | 'touch';
+    origin: Point;
     /**
-     * Frame source configuration
+     * The size of the rectangle.
      */
-    frameSource?: FrameSourceConfiguration;
+    size: Size;
+}
+
+/**
+ * The region of interest is specified as an inset between screen edge and RoE on each side,
+ * expressed as a fractional value (between 0 and 0.5).
+ *
+ * For instance, to have an area that occupies the middle 80% horizontal area and 50% vertical area, you would
+ * specify the region of interest as follows:
+ *
+ * ```json
+ * { left: 0.1, right: 0.1, top: 0.25, bottom: 0.25 }
+ * ```
+ * (10% width inset on each side, 25% height inset on each side)
+ */
+export declare interface RegionOfInterest {
     /**
-     * Locator configuration
+     * Left inset, relative [0 .. 0.5].
+     *
+     * @example 0.1
      */
-    locator?: LocatorConfiguration;
+    left: number;
     /**
-     * Engine configuration
+     * Top inset, relative [0 .. 0.5].
+     *
+     * @example 0.25
      */
-    engine?: EngineConfiguration;
+    top: number;
     /**
-     * Overlay configuration
+     * Right inset, relative [0 .. 0.5].
+     *
+     * @example 0.1
      */
-    overlay?: OverlayConfiguration;
+    right: number;
     /**
-     * Feedback configuration
+     * Bottom inset, relative [0 .. 0.5]
+     *
+     * @example 0.25
      */
-    feedback?: FeedbackConfiguration;
+    bottom: number;
 }
+
 /**
- * A point in two-dimensional space.
- *
- * The y coordinate origin starts at the top.
+ * STRICH SDK error class
  */
-export interface Point {
+export declare class SdkError extends Error {
     /**
-     * The x-coordinate in pixels.
+     * Flag indicating if this error is related to camera access.
      */
-    x: number;
+    duringCameraAccess: boolean;
     /**
-     * The y-coordinate in pixels.
+     * A localized error message, if available, otherwise this will contain the non-localized message.
      */
-    y: number;
+    localizedMessage: string;
+    /**
+     * An optional underlying error that caused this error.
+     */
+    cause?: Error;
+    /**
+     * An optional detail message to display to disambiguate multiple errors (not-translated)
+     */
+    detailMessage?: string;
+    constructor(keyOrMessage: string, cause?: Error);
 }
+
 /**
  * The size of a bounding box, represented by its width and height.
  */
-export interface Size {
+export declare interface Size {
     /**
      * The width in pixels.
      */
@@ -450,32 +539,11 @@ export interface Size {
      */
     height: number;
 }
-/**
- * An axis-aligned rectangle in two-dimensional space.
- */
-export interface Rect {
-    /**
-     * The origin of the rectangle.
-     */
-    origin: Point;
-    /**
-     * The size of the rectangle.
-     */
-    size: Size;
-}
-/**
- * A non-intersecting polygon with four points.
- */
-export interface Quadrilateral {
-    /**
-     * The 4 points forming the quadrilateral.
-     */
-    points: Point[];
-}
+
 /**
  * Before the STRICH SDK {@link BarcodeReader} can be used, a one-time initialization of the SDK must be performed.
  */
-export class StrichSDK {
+export declare class StrichSDK {
     /**
      * Return the version of the STRICH SDK.
      */
@@ -487,7 +555,7 @@ export class StrichSDK {
     /**
      * One-time initialization of the SDK.
      *
-     * @param licenseKey The license key obtained from the Customer Portal.
+     * @param licenseKey - The license key obtained from the Customer Portal.
      */
     static initialize(licenseKey: string): Promise<void>;
     /**
@@ -499,14 +567,14 @@ export class StrichSDK {
      * USING THE CUSTOM ID TO TRANSMIT PERSONALLY IDENTIFYING DATA IS FORBIDDEN AND
      * CONSTITUTES A BREACH OF THE TERMS OF THE LICENSE AGREEMENT.
      *
-     * @param customId The custom ID. Use `null` to unset the custom ID.
-     * @default No custom ID is set by default
+     * @param customId - The custom ID. Use `null` to unset the custom ID.
+     * @defaultValue No custom ID is set by default
      */
     static setCustomId(customId: string | null): void;
     /**
      * Override the language that was detected from the browser's language (navigator.language)
      *
-     * @param lang ISO language code, e.g. 'en'
+     * @param lang - The ISO language code, e.g. 'en'
      */
     static setLanguage(lang: string): void;
     /**
@@ -514,108 +582,33 @@ export class StrichSDK {
      * This can be used as a check if a BarcodeReader should be presented, or a fallback to a manual input method
      * or error page should be displayed.
      *
-     * @return A Promise that resolves to a boolean value indicating if a camera is available. The Promise will reject
+     * @returns A Promise that resolves to a boolean value indicating if a camera is available. The Promise will reject
      * if the check fails for any reason (including missing/denied permissions).
      */
     static hasCameraDevice(): Promise<boolean>;
 }
+
 /**
- * A code detection reported by the STRICH SDK.
+ * The supported symbologies.
  */
-export interface CodeDetection {
-    /**
-     * The textual data contained in the code.
-     */
-    data: string;
-    /**
-     * The type of detected code.
-     */
-    typeName: string;
-    /**
-     * Supplemental data for this code.
-     */
-    supplementalData: string | null;
-    /**
-     * The bounding rectangle in which the code was detected.
-     *
-     * Note: this might not be precise, especially for 1D barcodes.
-     */
-    boundingRect: Rect;
-    /**
-     * The quadrilateral in which the code was detected.
-     *
-     * For rotated or warped codes, this might contain a more precise location estimate than boundingRect.
-     */
-    quadrilateral: Quadrilateral;
-    /**
-     * The time of detection.
-     */
-    time: number;
-    /**
-     * The raw contained bytes contained in the code.
-     */
-    rawData: Uint8Array;
-}
+export declare type SymbologyName = 'ean13' | 'ean8' | 'ean5' | 'ean2' | 'upca' | 'upce' | 'databar' | 'databar-exp' | 'code39' | 'code93' | 'code128' | 'i25' | 'codabar' | 'qr' | 'aztec' | 'datamatrix' | 'pdf417';
+
 /**
- * BarcodeReader is the primary interface of the STRICH SDK.
+ * For variable-length symbologies, min/max length can be specified in addition to the symbology.
  */
-export class BarcodeReader {
-    /**
-     * User-supplied barcode detection handler.
-     *
-     * This is a synchronous call, so further processing will not happen until the handler returns.
-     */
-    detected?: (detections: CodeDetection[]) => (void);
-    /**
-     * Optional user-supplied error callback.
-     *
-     * This is invoked by the BarcodeReader if an error occurred while processing frames, and is usually not
-     * recoverable.
-     */
-    onError?: (error: Error) => (void);
-    /**
-     * Create a new BarcodeReader using a Configuration.
-     *
-     * @param configuration A configuration object.
-     */
-    constructor(configuration: Configuration);
-    /**
-     * Initialize the BarcodeReader instance.
-     *
-     *
-     *
-     * @return A promise resolving to an initialized BarcodeReader instance, or an error object.
-     */
-    initialize(): Promise<BarcodeReader>;
-    /**
-     * Start scanning for barcodes.
-     */
-    start(): Promise<void>;
+export declare type SymbologySpec = {
     /**
-     * Stop the BarcodeReader instance.
-     *
-     * This will temporarily suspend processing of camera frames / detection of codes.
-     */
-    stop(): Promise<void>;
-    /**
-     * Destroy this BarcodeReader instance, making it unusable.
-     *
-     * This will release all associated resources, and should be called whenever an application no longer needs to
-     * scan.
-     *
-     * @return Promise that resolves when the BarcodeReader and its associated resources are fully destroyed.
+     * The name of the symbology.
      */
-    destroy(): Promise<void>;
+    name: SymbologyName;
     /**
-     * Show/hide the BarcodeReader instance.
-     *
-     * @param visible True/false for visible/hidden
+     * The minimum length of the barcode, only has an effect for variable-length symbologies.
      */
-    setVisible(visible: boolean): Promise<void>;
+    minLen?: number;
     /**
-     * @return the current visibility of this BarcodeReader instance
+     * The maximum length of the barcode, only has an effect for variable-length symbologies.
      */
-    getVisible(): boolean;
-}
+    maxLen?: number;
+};
 
-//# sourceMappingURL=strich.d.ts.map
+export { }