@pixelverse/strichjs-sdk 0.8.7 → 0.9.1

package/README.md

@@ -1,6 +1,7 @@
 # STRICH JavaScript SDK
 
- * [Getting Started](https://docs.strich.io/getting-started)
- * [API Reference Documentation](https://docs.strich.io)
- * [Customer Portal](https://portal.strich.io)
+Fast, reliable barcode scanning for web apps.
 
+Get started with the STRICH SDK by visiting the [Customer Portal](https://portal.strich.io) and signing up for a license key.
+
+STRICH is commercial software, its use is governed by the terms available in the Customer Portal.

package/dist/strich.d.ts

@@ -1,20 +1,3 @@
-/**
- * Encapsulation of a JWT-based license.
- *
- * @internal
- */
-interface License {
-    iss: string;
-    sub: string;
-    iat: number;
-    nbf: number;
-    aud: string[];
-    exp?: number;
-    capabilities: {
-        [key: string]: unknown;
-    };
-    version: number;
-}
 /**
  * STRICH SDK error class
  */
@@ -24,13 +7,6 @@ export class SdkError extends Error {
      */
     duringCameraAccess: boolean;
     constructor(message: string, cause?: Error);
-    /**
-     * Create an SDK error from a getUserMedia exception.
-     * See: https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia#exceptions
-     *
-     * @internal
-     */
-    static fromGetUserMediaError(err: Error): SdkError;
 }
 /**
  * Configuration for the frame source (camera).
@@ -46,10 +22,6 @@ export interface FrameSourceConfiguration {
      * @default hd
      */
     resolution?: 'hd' | 'full-hd' | 'auto';
-    /**
-     * Allow other properties (for internal purposes)
-     */
-    [key: string]: unknown;
 }
 export function defaultFrameSourceConfiguration(): FrameSourceConfiguration;
 /**
@@ -105,12 +77,6 @@ export interface LocatorConfiguration {
      * @default false
      */
     chromaReject?: boolean;
-    /**
-     * Allow other properties (for internal purposes)
-     *
-     * @internal
-     */
-    [key: string]: unknown;
 }
 /**
  * The supported symbologies.
@@ -147,28 +113,6 @@ export interface EngineConfiguration {
      * @default 2
      */
     minScanlinesNeeded?: number;
-    /**
-     * Toggle fallback scanning.
-     *
-     * Enables additional scan passes if no barcodes were found in areas identified as candidates in the
-     * location process. Can help with obscured/low contrast barcodes, at the expension of minor additional
-     * complexity.
-     *
-     * @default true
-     * @internal
-     */
-    fallbackScan?: boolean;
-    /**
-     * Toggle image preprocessing for 1D barcodes.
-     *
-     * Can help with degraded/damaged barcodes, at the expense of additional computational complexity.
-     *
-     * @default true
-     * @internal
-     */
-    preProcess1D?: boolean;
-    /** @internal */
-    simple1DMode?: boolean;
     /**
      * Toggle recognition of inverted 2D codes (light on dark background).
      * Currently, this is only supported for 2D codes.
@@ -184,12 +128,6 @@ export interface EngineConfiguration {
      * It is recommended to set a low duplicateInterval as scans are metered in non-Enterprise subscriptions.
      */
     duplicateInterval?: number;
-    /**
-     * Allow other properties (for internal purposes)
-     *
-     * @internal
-     */
-    [key: string]: unknown;
 }
 /**
  * Overlay configuration
@@ -221,12 +159,6 @@ export interface OverlayConfiguration {
      * @default true
      */
     showFlashlight?: boolean;
-    /**
-     * Allow other properties (for internal purposes)
-     *
-     * @internal
-     */
-    [key: string]: unknown;
 }
 /**
  * User feedback configuration
@@ -244,24 +176,18 @@ export interface FeedbackConfiguration {
      * @default true
      */
     vibration?: boolean;
-    /**
-     * Allow other properties (for internal purposes)
-     *
-     * @internal
-     */
-    [key: string]: unknown;
 }
 /**
  * BarcodeReader configuration object.
  */
 export interface Configuration {
     /**
-     * CSS Selector referencing an element that will host the visible elements of
+     * CSS Selector or reference to the HTML element that will host the visible elements of
      * the BarcodeReader.
      *
-     * Make sure the selector only matches a single element.
+     * When using a selector, make sure the selector only matches a single element.
      */
-    selector: string;
+    selector: string | HTMLElement;
     /**
      * Mode: can be 'immediate' (default) for always-on scanning, and 'touch', to only scan when a touch occurs.
      *
@@ -288,12 +214,6 @@ export interface Configuration {
      * Feedback configuration
      */
     feedback?: FeedbackConfiguration;
-    /**
-     * Allow other properties (for internal purposes)
-     *
-     * @internal
-     */
-    [key: string]: unknown;
 }
 /**
  * A point in two-dimensional space.
@@ -328,12 +248,6 @@ export interface Rect {
  * Before the STRICH SDK {@link BarcodeReader} can be used, a one-time initialization of the SDK must be performed.
  */
 export class StrichSDK {
-    /** @internal */
-    static license: License;
-    /** @internal */
-    static deviceId: string | null;
-    /** @internal */
-    static customId: string | null;
     /**
      * Return the version of the STRICH SDK.
      */