@pixelverse/strichjs-sdk 1.0.9 → 1.1.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [1.1.0] - 2023-05-17
+
+### Added
+
+- Added experimental support for EAN-2/EAN-5 supplements (new `ean2` and `ean5` symbology options). Note that this feature is experimental: supplemental symbologies will not be enabled if you enable all symbologies (which we do not recommend).
+- Added an optional `onError` callback to the BarcodeReader instance.
+
 ## [1.0.9] - 2023-05-15
 
 ### Fixed
@@ -11,8 +18,8 @@
 
 ### Added
 
-- Not calling BarcodeReader.destroy() after no longer needing a BarcodeReader is a common cause of camera access errors. A warning is now logged to the browser console if a BarcodeReader is initialized when another instance remains that was not destroyed yet.
-- If no Region of Interest is specified in the configuration, an appropriately sized region will now be automatically selected based on the configured symbologies.
+- Not calling `BarcodeReader.destroy()` after no longer needing a BarcodeReader is a common cause of camera access errors. A warning is now logged to the browser console if a BarcodeReader is initialized when another instance remains that was not destroyed yet.
+- If no `regionOfInterest` is specified in the configuration, an appropriately sized region will now be automatically selected based on the configured symbologies.
 
 ### Fixed
 
@@ -26,7 +33,7 @@
 
 ### Changed
 
-- Clarified acceptable use of StrichSDK.setCustomId(), personally identifying data must not be sent.
+- Clarified acceptable use of `StrichSDK.setCustomId()`, personally identifying data must not be sent.
 
 ## [1.0.6] - 2023-04-19
 
@@ -54,7 +61,7 @@
 
 ### Changed
 
-- Not setting a duplicateInterval in the engine configuration will now lead to a default 750ms interval to be used.
+- Not setting a `duplicateInterval` in the engine configuration will now lead to a default 750ms interval to be used.
 
 ### Fixed
 
@@ -75,7 +82,7 @@
 ### Fixed
 
 - Gracefully handle the situation where MediaStream does not implement getCapabilities() (e.g. Firefox Android).
-- Avoid spurious exception after BarcodeReader.destroy() from an asynchronous overlay update in destroyed state
+- Avoid spurious exception after `BarcodeReader.destroy()` from an asynchronous overlay update in destroyed state
 - Aztec code detection rectangle was not displayed on overlay for some non-compact Aztec codes.
 
 ## [1.0.0] - 2023-03-15

package/dist/strich.d.ts

@@ -82,7 +82,7 @@ export interface LocatorConfiguration {
 /**
  * The supported symbologies.
  */
-export type SymbologyName = 'ean13' | 'ean8' | 'upca' | 'upce' | 'databar' | 'databar-exp' | 'code39' | 'code93' | 'code128' | 'i25' | 'codabar' | 'qr' | 'aztec' | 'datamatrix';
+export type SymbologyName = 'ean13' | 'ean8' | 'ean5' | 'ean2' | 'upca' | 'upce' | 'databar' | 'databar-exp' | 'code39' | 'code93' | 'code128' | 'i25' | 'codabar' | 'qr' | 'aztec' | 'datamatrix';
 /**
  * Engine configuration
  */
@@ -301,6 +301,10 @@ export 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.
      *
@@ -322,6 +326,13 @@ export class BarcodeReader {
      * This is a synchronous call, so further processing will not happen until the handler returns.
      */
     detected?: (detections: CodeDetection[]) => (void);
+    /**
+     * Optional user-supplied error callback.
+     *
+     * This is invoked by the BarcodeReader if an error occurred while processing frames, and is usually not
+     * recoverable.
+     */
+    onError?: (error: Error) => (void);
     /**
      * Create a new BarcodeReader using a Configuration.
      *