@pixelverse/strichjs-sdk 1.4.9 → 1.5.1

package/dist/strich.d.ts

@@ -72,10 +72,6 @@ export declare interface CodeDetection {
      * The type of detected code.
      */
     typeName: string;
-    /**
-     * Supplemental data for this code.
-     */
-    supplementalData: string | null;
     /**
      * The bounding rectangle in which the code was detected.
      *
@@ -96,6 +92,10 @@ export declare interface CodeDetection {
      * The raw contained bytes contained in the code.
      */
     rawData: Uint8Array;
+    /**
+     * The ISO/IEC 15424 symbology identifier.
+     */
+    symbologyIdentifier: string;
 }
 
 /**
@@ -155,12 +155,6 @@ export declare interface EngineConfiguration {
      * (all symbologies enabled - NOT RECOMMENDED)
      */
     symbologies?: (SymbologyName | SymbologySpec)[];
-    /**
-     * The number of scanlines to run over a located barcode candidate.
-     *
-     * @defaultValue 10
-     */
-    numScanlines?: number;
     /**
      * The number of scanlines that need to decoded successfully for a valid decode.
      *
@@ -301,14 +295,14 @@ export declare interface LocatorConfiguration {
      */
     chromaReject?: boolean;
     /**
-     * The locator implementation to use. This should normally not be changed, unless it is specifically required
-     * to target WebGL 1.
+     * The locator implementation to use.
      *
-     * @remarks This is an advanced setting and should normally not be changed, unless targeting WebGL1 and not
-     * WebGL2 is explicitly required.
+     * @remarks This is an advanced setting and should normally not be changed. It used to be possible to force WebGL 1,
+     * but starting with 1.5, WebGL1 is no longer supported. This property might be used in the future to switch to a
+     * WebGPU-powered locator.
      * @defaultValue auto
      */
-    impl?: 'auto' | 'webgl1' | 'webgl2';
+    impl?: 'auto' | 'webgl2';
     /**
      * Disable asynchronous reads from GPU when using `webgl2` {@link LocatorConfiguration.impl}.
      *
@@ -590,8 +584,10 @@ export declare class StrichSDK {
 
 /**
  * The supported symbologies.
+ *
+ * For more information, please visit https://docs.strich.io/supported-symbologies.html
  */
-export declare type SymbologyName = 'ean13' | 'ean8' | 'ean5' | 'ean2' | 'upca' | 'upce' | 'databar' | 'databar-exp' | 'code39' | 'code93' | 'code128' | 'i25' | 'codabar' | 'qr' | 'aztec' | 'datamatrix' | 'pdf417';
+export declare type SymbologyName = 'ean13' | 'ean8' | '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.
@@ -609,6 +605,13 @@ export declare type SymbologySpec = {
      * The maximum length of the barcode, only has an effect for variable-length symbologies.
      */
     maxLen?: number;
+    /**
+     * The minimum length of the leading and trailing quiet zone for this symbology, expressed as multiples of X.
+     *
+     * @remarks
+     * There is rarely a need to change the default.
+     */
+    qz?: number;
 };
 
 export { }