@pixelverse/strichjs-sdk 1.1.3 → 1.2.0

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # Changelog
 
+## [1.2.0] - 2023-07-12
+
+### Added
+
+- The GPU-accelerated barcode locator is now based on WebGL 2, which is widely supported by now. If you are for some reason required to use WebGL 1, set the new `impl` field on the locator configuration to `webgl1`. WebGL 2 supports asynchronous reads which we use to decrease the load on the main thread. Some older Safari versions have reported issues using the asynchronous reads, which is why for the moment we have disabled asynchronous reads on iOS. This will likely change in the future.
+
+### Fixed
+
+- Fixed a rare engine crash that resulted from incorrect error handling.
+
+### Changed
+
+- Changed the default values for `hysteresisMinCount` to `2` and `hysteresisInterval` to `350`. The previous defaults were causing EAN/UPC codes to be unreadable on low-end Android devices.
+
+## [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

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).
@@ -78,6 +89,20 @@ export interface LocatorConfiguration {
      * @default false
      */
     chromaReject?: boolean;
+    /**
+     * The locator implementation to use. This should normally not be changed, unless it is specifically required
+     * to target WebGL 1.
+     *
+     * @default 'auto'
+     */
+    impl?: 'auto' | 'webgl1' | 'webgl2';
+    /**
+     * An advanced option for disabling asynchronous reads from GPU when using 'webgl2'.
+     * Some older iOS versions have issues with WebGL2 asynchronous readbacks.
+     *
+     * @default false
+     */
+    forceSyncReadback?: boolean;
 }
 /**
  * The supported symbologies.
@@ -156,7 +181,7 @@ export interface EngineConfiguration {
      *
      * Setting this parameter to 0 disables hysteresis (default behavior for versions <= 1.1.0)
      *
-     * @default 3
+     * @default 2
      */
     hysteresisMinCount?: number;
     /**
@@ -164,7 +189,7 @@ export interface EngineConfiguration {
      *
      * This parameter sets the size of the hysteresis window in milliseconds.
      *
-     * @default 250
+     * @default 350
      */
     hysteresisInterval?: number;
 }
@@ -324,6 +349,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.