@pixelverse/strichjs-sdk 1.6.0 → 1.7.0

package/dist/strich.d.ts

@@ -360,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)
@@ -401,13 +401,43 @@ 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.
      *
@@ -460,7 +490,7 @@ export declare interface PopupConfiguration {
      */
     resolution?: 'hd' | 'full-hd';
     /**
-     * Optional overrides for textual popup elements.
+     * Optional overrides for textual content.
      */
     labels?: {
         /**
@@ -478,6 +508,9 @@ export declare interface PopupConfiguration {
          */
         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.
@@ -708,9 +741,9 @@ export declare type SymbologyName = 'ean13' | 'ean8' | 'upca' | 'upce' | 'databa
  */
 export declare type SymbologySpec = {
     /**
-     * The name of the symbology.
+     * The name of the 1D barcode symbology.
      */
-    name: SymbologyName;
+    name: 'ean13' | 'ean8' | 'upca' | 'upce' | 'databar' | 'databar-exp' | 'code39' | 'code93' | 'code128' | 'i25' | 'codabar';
     /**
      * The minimum length of the barcode, only has an effect for variable-length symbologies.
      */
@@ -741,6 +774,35 @@ export declare type SymbologySpec = {
      * @defaultValue 0
      */
     checksumMode?: number;
+} | {
+    /** The name of the QR Code symbology */
+    name: 'qr';
+    /**
+     * Enable detection of QR Codes with rounded finder patterns.
+     *
+     * @remarks
+     * The finder patterns of a QR Code are nominally square with straight edges. The straight edges
+     * are useful in optimizing the detection of finder pattern triplets and mapping of the QR Code.
+     * The ISO specification mandates square finder patterns, but rounded finder patterns are used
+     * in practice, especially outside of industrial use cases.
+     *
+     * @defaultValue false
+     */
+    roundedFPs: boolean;
+    /**
+     * Enable detection of QR Codes on curved/bent surfaces.
+     *
+     * @remarks
+     * More advanced algorithms will be used to read QR Codes from curved or bent surfaces. This option
+     * incurs extra processing time and only makes sense if your QR Codes are printed on curved surfaces
+     * such as bottles, barrels and other cylindrical or spherical items.
+     *
+     * @defaultValue false
+     */
+    curved: boolean;
+} | {
+    /** The name of the 2D symbology */
+    name: 'aztec' | 'datamatrix' | 'pdf417';
 };
 
 export { }