@pixelverse/strichjs-sdk 1.0.6 → 1.0.8

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## [1.0.8] - 2023-05-11
+
+### 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.
+
+### Fixed
+
+- The horizontal targeting line in the scanning overlay was not being shown if all symbologies were enabled.
+
+## [1.0.7] - 2023-05-06
+
+### Fixed
+
+- When a BarcodeReader was used in standalone display mode on iOS (PWA, added to home screen), camera access was lost when the user unfocused the PWA. An error is now displayed in this case, along with a button to resume scanning.
+
+### Changed
+
+- Clarified acceptable use of StrichSDK.setCustomId(), personally identifying data must not be sent.
+
 ## [1.0.6] - 2023-04-19
 
 ### Fixed

package/README.md

@@ -1,7 +1,10 @@
 # STRICH JavaScript SDK
 
-Fast, reliable barcode scanning for web apps.
+To get started with the STRICH SDK, check out the [Getting Started](https://strich.io/getting-started.html) guide.
 
-Get started with the STRICH SDK by visiting the [Customer Portal](https://portal.strich.io) and signing up for a license key.
+For detailed information on the API, refer to the [Reference Documentation](https://docs.strich.io/).
 
-STRICH is commercial software, its use is governed by the terms available in the Customer Portal.
+For a list of recent changes, please refer to the [Changelog](https://docs.strich.io/CHANGELOG.md).
+
+STRICH is commercial software, its use is governed by the terms of the
+Subscription License Agreement available in the Customer Portal.

package/dist/strich.d.ts

@@ -93,6 +93,8 @@ export interface EngineConfiguration {
      * It is highly recommended to configure only the symbologies required by
      * your application.
      *
+     * An empty array or undefined is interpreted as 'all symbologies enabled'.
+     *
      * @default undefined (all symbologies enabled - NOT RECOMMENDED)
      */
     symbologies?: SymbologyName[];
@@ -276,10 +278,11 @@ export class StrichSDK {
     /**
      * Set custom ID for analytics.
      *
-     * The custom ID is independent of the device ID, and can be used for machine identifiers, user identifiers or any
-     * other identifiers.
+     * The custom ID is independent of the device ID, and can be used for custom device
+     * identifiers, location identifiers or anonymous user identifiers.
      *
-     * If the custom ID includes user-identifying data, you are responsible for obtaining consent.
+     * USING THE CUSTOM ID TO TRANSMIT PERSONALLY IDENTIFYING DATA IS FORBIDDEN AND
+     * CONSTITUTES A BREACH OF THE TERMS OF THE LICENSE AGREEMENT.
      *
      * @param customId The custom ID. Use `null` to unset the custom ID.
      * @default No custom ID is set by default