@pixelverse/strichjs-sdk 1.1.2 → 1.1.4

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## [1.1.4] - 2023-06-26
+
+### Added
+
+- User-facing error messages (e.g. "Access to camera not permitted") are now localized. English, Spanish, German, French and Italian are the currently supported languages, with more to come.
+- Prepared support for iOS 17 Safari OffscreenCanvas+WebGL support. STRICH will utilize a GPU-accelerated OffscreenCanvas if the browser supports it. 
+
+### Fixed
+
+- Improved performance when scanning EAN/UPC codes with hysteresis enabled.
+
+## [1.1.3] - 2023-06-07
+
+### Added
+
+- Configurable min/max length for variable-length symbologies. Instead of just the name, specify an object with `name`, `minLen` and/or `maxLen` in the `symbologies` array. Example: `symbologies: ['ean13', { name: 'code128', minLen: 8, maxLen: 12 }]`
+
+### Fixed
+
+- Removed a stray console output statement that was meant for debugging purposes only.
+
 ## [1.1.2] - 2023-06-06
 
 ### Fixed

package/dist/strich.d.ts

@@ -6,8 +6,19 @@ export class SdkError extends Error {
      * Flag indicating if this error is related to camera access.
      */
     duringCameraAccess: boolean;
+    /**
+     * A localized error message, if available, otherwise this will contain the non-localized message.
+     */
+    localizedMessage: string;
+    /**
+     * An optional underlying error that caused this error.
+     */
     cause?: Error;
-    constructor(message: string, cause?: Error);
+    /**
+     * An optional detail message to display to disambiguate multiple errors (not-translated)
+     */
+    detailMessage?: string;
+    constructor(keyOrMessage: string, cause?: Error);
 }
 /**
  * Configuration for the frame source (camera).
@@ -83,6 +94,23 @@ export interface LocatorConfiguration {
  * The supported symbologies.
  */
 export type SymbologyName = 'ean13' | 'ean8' | 'ean5' | 'ean2' | 'upca' | 'upce' | 'databar' | 'databar-exp' | 'code39' | 'code93' | 'code128' | 'i25' | 'codabar' | 'qr' | 'aztec' | 'datamatrix';
+/**
+ * For variable-length symbologies, min/max length can be specified in addition to the symbology.
+ */
+export type SymbologySpec = {
+    /**
+     * The name of the symbology.
+     */
+    name: SymbologyName;
+    /**
+     * The minimum length of the barcode, only has an effect for variable-length symbologies.
+     */
+    minLen?: number;
+    /**
+     * The maximum length of the barcode, only has an effect for variable-length symbologies.
+     */
+    maxLen?: number;
+};
 /**
  * Engine configuration
  */
@@ -97,7 +125,7 @@ export interface EngineConfiguration {
      *
      * @default undefined (all symbologies enabled - NOT RECOMMENDED)
      */
-    symbologies?: SymbologyName[];
+    symbologies?: (SymbologyName | SymbologySpec)[];
     /**
      * The number of scanlines to run over a located barcode candidate.
      *
@@ -307,6 +335,12 @@ export class StrichSDK {
      * @default 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'
+     */
+    static setLanguage(lang: string): void;
 }
 /**
  * A code detection reported by the STRICH SDK.