@pixelverse/strichjs-sdk 1.3.2 → 1.3.4

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## [1.3.4] - 2023-11-28
+
+### Fixed
+
+- Significantly improved Aztec Code recognition rates for full-range codes.
+- Removed transmission of unnecessary URL parts in license verification and usage tracking.
+
+## [1.3.3] - 2023-11-07
+
+### Fixed
+
+- Fixed an issue on iOS where camera access failed with a  _camera device is not compatible_ error message `rememberCameraDeviceId` was set to `true` and the user's device changed, leading to the remembered camera device id no longer being valid.
+
+### Changed
+
+- Expose detail message when license check fails, providing potentially useful information on how to resolve the issue (e.g. URL not in scope)
+
+### Added
+
+- Throw a dedicated error if the SDK is initialized in an insecure context (non-HTTPS, non-localhost). Previously this was reported in a confusing fashion (invalid license).
+
 ## [1.3.2] - 2023-10-26
 
 ### Fixed

package/README.md

@@ -1,11 +1,11 @@
 # STRICH JavaScript SDK
 
-To get started with the STRICH SDK, check out the [Getting Started](https://strich.io/getting-started.html) guide.
+To get started with the STRICH SDK, check out the [Getting Started](https://docs.strich.io/getting-started.html) guide.
 
-For detailed information on the API, refer to the [Reference Documentation](https://docs.strich.io/).
-For a list of recent changes, please refer to the [Changelog](https://docs.strich.io/CHANGELOG.md).
+For detailed information on the API, refer to the [Reference Documentation](https://docs.strich.io/reference/index.html).
+For a list of recent changes, please refer to the [Changelog](https://docs.strich.io/release-notes.html).
 
-Sample code showing how to integrate into popular web frameworks such as Angular, React and Vue is available on [Github][https://github.com/topics/strich-sdk].
+Sample code showing how to integrate into popular web frameworks such as Angular, React and Vue is available on [Github](https://github.com/topics/strich-sdk).
 
 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

@@ -19,6 +19,16 @@ export class SdkError extends Error {
      */
     detailMessage?: string;
     constructor(keyOrMessage: string, cause?: Error);
+    /**
+     * Create an SDK error for a license checking error including detail.
+     *
+     * This sets the detailMessage member but also adds the detail message to
+     * message itself, as it contains valuable hints as to why the license
+     * check failed.
+     *
+     * @param detailMessage
+     */
+    static invalidLicenseErrorWithDetail(detailMessage: string): SdkError;
 }
 /**
  * Configuration for the frame source (camera).
@@ -308,14 +318,26 @@ export interface Configuration {
  * The y coordinate origin starts at the top.
  */
 export interface Point {
+    /**
+     * The x-coordinate in pixels.
+     */
     x: number;
+    /**
+     * The y-coordinate in pixels.
+     */
     y: number;
 }
 /**
  * The size of a bounding box, represented by its width and height.
  */
 export interface Size {
+    /**
+     * The width in pixels.
+     */
     width: number;
+    /**
+     * The height in pixels.
+     */
     height: number;
 }
 /**