@pixelverse/strichjs-sdk 1.5.5 → 1.6.1

package/dist/strich.d.ts

@@ -2,7 +2,6 @@
  * BarcodeReader is the primary interface of the STRICH SDK.
  */
 export declare class BarcodeReader {
-    private configuration;
     /**
      * User-supplied barcode detection handler.
      *
@@ -21,7 +20,7 @@ export declare class BarcodeReader {
      *
      * @param configuration - A configuration object.
      */
-    constructor(configuration: Configuration);
+    constructor(/* @internal */ configuration: Configuration);
     /**
      * Initialize the BarcodeReader instance.
      *
@@ -32,7 +31,6 @@ export declare class BarcodeReader {
      * Start scanning for barcodes.
      */
     start(): Promise<void>;
-    private tick;
     /**
      * Stop the BarcodeReader instance.
      *
@@ -107,8 +105,9 @@ export declare interface Configuration {
      *
      * @remarks
      * When using a selector, make sure the selector only matches a single element, e.g. by using an ID.
+     * When using the popup scanner, do not pass a selector.
      */
-    selector: string | HTMLElement;
+    selector: string | HTMLElement | undefined;
     /**
      * Mode: can be 'immediate' (default) for always-on scanning, and 'touch', to only scan when a touch occurs.
      *
@@ -142,7 +141,9 @@ export declare interface Configuration {
  */
 export declare interface EngineConfiguration {
     /**
-     * The enabled symbologies.
+     * The enabled barcode symbologies.
+     *
+     * See https://docs.strich.io/supported-symbologies.html for an exhaustive list of supported symbologies.
      *
      * @remarks
      * It is highly recommended to configure only the symbologies required by your application.
@@ -359,7 +360,7 @@ export declare interface OverlayConfiguration {
      */
     focusOnTap?: boolean;
     /**
-     * Color to use for drawing UI elements such as the view finder and camera selector. Must be specified in rgb()
+     * Color to use for drawing UI elements such as the viewfinder and camera selector. Must be specified in rgb()
      * format, with the color components given as integers with no separating whitespace.
      *
      * @defaultValue rgb(255,255,255)
@@ -400,20 +401,51 @@ export declare interface OverlayConfiguration {
      */
     targetingLineActiveColor?: string;
     /**
-     * Corner radius in pixels for rectangular elements such as view finder and camera selector.
+     * Corner radius in pixels for rectangular elements such as viewfinder and camera selector.
      *
      * The allowed range of the corner radius is 0 to 8 pixels.
      *
      * @defaultValue 0
      */
     cornerRadius?: number;
+    /**
+     * Border width in pixels of the viewfinder, the rectangle around the region of interest.
+     *
+     * @remarks
+     * The allowed range is 1 to 20 pixels. Values outside the range are clamped.
+     *
+     * @defaultValue 1
+     */
+    viewfinderBorderWidth?: number;
+    /**
+     * Corner radius in pixels of the viewfinder, the rectangle around the region of interest.
+     *
+     * This property applies only to the viewfinder and overrides the {@link OverlayConfiguration.cornerRadius} property.
+     *
+     * The allowed range of the corner radius is 0 to 20 pixels.
+     *
+     * @defaultValue 0
+     */
+    viewfinderCornerRadius?: number;
+    /**
+     * Color to use for de-emphasizing the area around the viewfinder.
+     *
+     * The color will be used to create a mask around the viewfinder/region of interest to aid the user in focusing
+     * the camera on the barcode.
+     *
+     * A semi-translucent dark color works best, e.g. rgba(0,0,0,0.5) would use a semi-translucent black.
+     *
+     * @defaultValue undefined
+     */
+    maskColor?: string;
     /**
      * Override the STRICH logo displayed in the bottom-right corner with a custom image.
      *
      * The image is supplied as an absolute URL or inline as a data URL. The image should have a transparent background
      * (WebP or PNG format). The recommended size is 140x30 pixels.
      *
-     * @remarks This is a capability that is only available as a paid add-on for Enterprise licenses.
+     * @remarks This is a capability that is only available as a paid add-on for Enterprise licenses. Please note that
+     * attempting to hide or replace the STRICH logo by other means is a violation of the License Agreement.
      */
     customLogoSrc?: string;
 }
@@ -434,6 +466,107 @@ export declare interface Point {
     y: number;
 }
 
+/**
+ * Popup scanner configuration
+ */
+export declare interface PopupConfiguration {
+    /**
+     * The barcode symbologies that should be detected.
+     *
+     * See {@link EngineConfiguration#symbologies} for details.
+     */
+    symbologies: (SymbologyName | SymbologySpec)[];
+    /**
+     * An optional handler for detections.
+     *
+     * Receives barcode detections and must return `true` if scanning should stop, or `false` if scanning should
+     * continue. Any truthy value will be interpreted as `true`.
+     */
+    detectionHandler?: (detections: CodeDetection[]) => boolean;
+    /**
+     * The camera resolution to use.
+     *
+     * @defaultValue full-hd
+     */
+    resolution?: 'hd' | 'full-hd';
+    /**
+     * Optional overrides for textual content.
+     */
+    labels?: {
+        /**
+         * The text to display in the dialog header area.
+         *
+         * @remarks
+         * If no value is supplied, a locale-dependent default text will be used.
+         */
+        title?: string;
+        /**
+         * The text to display on the cancel button in the dialog bottom area.
+         *
+         * @remarks
+         * If no value is supplied, a locale-dependent default text will be used.
+         */
+        cancel?: string;
+    };
+    /**
+     * Optional overrides for title area and cancel button.
+     */
+    style?: {
+        /**
+         * Background color to use for title. Must be specified in rgb() or rgba() notation.
+         *
+         * @defaultValue rgba(15,42,66,0.9)
+         */
+        titleBackgroundColor?: string;
+        /**
+         * Background color to use for title text. Must be specified in rgb() notation.
+         *
+         * @defaultValue rgb(236,237,237)
+         */
+        titleColor?: string;
+        /**
+         * Background color to use for cancel button. Must be specified in rgb() or rgba() notation.
+         *
+         * @defaultValue transparent
+         */
+        cancelButtonBackgroundColor?: string;
+        /**
+         * Color to use for cancel button outline and text. Must be specified in rgb() or rgba() notation.
+         *
+         * @defaultValue rgba(15,42,66,0.9)
+         */
+        cancelButtonColor?: string;
+    };
+    /**
+     * Optional configuration for audible and haptic feedback.
+     */
+    feedback?: FeedbackConfiguration;
+}
+
+/**
+ * Pre-built modal scanning interface, intended for simple use cases that do not require a lot of customization.
+ *
+ * For more advanced use cases and user interface customization, you can provide your own host element and integrate
+ * a {@link BarcodeReader} directly.
+ *
+ * @remarks
+ * Requires browser support for the &lt;dialog&gt; element, which is widely available since early 2022.
+ */
+export declare class PopupScanner {
+    /**
+     * Scan barcodes using a pre-built, modal popup interface.
+     *
+     * Scanning is active until one or more barcodes of the configured symbologies
+     * (see {@link PopupConfiguration#symbologies}) are detected. If a detection handler is provided
+     * (see {@link PopupConfiguration#detectionHandler}), scanning will continue until the detection
+     * handler returns a truthy value.
+     *
+     * @param configuration - The popup scanner configuration
+     * @returns Promise that resolves into the detected barcodes or undefined (user cancellation)
+     */
+    static scan(configuration: PopupConfiguration): Promise<CodeDetection[] | undefined>;
+}
+
 /**
  * A non-intersecting polygon with four points.
  */