@pixelverse/strichjs-sdk 0.8.7

package/dist/strich.d.ts

@@ -0,0 +1,440 @@
+/**
+ * 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
+ */
+export class SdkError extends Error {
+    /**
+     * Flag indicating if this error is related to camera access.
+     */
+    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).
+ */
+export interface FrameSourceConfiguration {
+    /**
+     * Video frame resolution.
+     *
+     * The default resolution is 720p, which is usually enough for good quality
+     * barcodes. You can try higher resolutions if you have very fine or
+     * degraded codes, at the expense of higher computational requirements.
+     *
+     * @default hd
+     */
+    resolution?: 'hd' | 'full-hd' | 'auto';
+    /**
+     * Allow other properties (for internal purposes)
+     */
+    [key: string]: unknown;
+}
+export function defaultFrameSourceConfiguration(): FrameSourceConfiguration;
+/**
+ * The region of interest is specified as an inset between screen edge and RoE on each side,
+ * expressed as a fractional value (between 0 and 0.5).
+ *
+ * For instance, to have an area that occupies the middle 80% horizontal area and 50% vertical area, you would
+ * specify the region of interest as follows:
+ *
+ * ```json
+ * { left: 0.1, right: 0.1, top: 0.25, bottom: 0.25 }
+ * ```
+ * (10% width inset on each side, 25% height inset on each side)
+ */
+export interface RegionOfInterest {
+    /**
+     * Left inset, relative [0 .. 0.5]
+     *
+     * @default A default is selected at run-time depending on enabled symbologies.
+     */
+    left: number;
+    /**
+     * Top inset, relative [0 .. 0.5]
+     *
+     * @default A default is selected at run-time depending on enabled symbologies.
+     */
+    top: number;
+    /**
+     * Right inset, relative [0 .. 0.5]
+     *
+     * @default A default is selected at run-time depending on enabled symbologies.
+     */
+    right: number;
+    /**
+     * Bottom inset, relative [0 .. 0.5]
+     *
+     * @default A default is selected at run-time depending on enabled symbologies.
+     */
+    bottom: number;
+}
+/**
+ * Locator configuration
+ */
+export interface LocatorConfiguration {
+    /**
+     * The region of interest in viewport coordinates.
+     */
+    regionOfInterest?: RegionOfInterest;
+    /**
+     * Disregard colorful areas, assumes that codes are printed black on white.
+     * This is an advanced configuration option, use with care.
+     *
+     * @default false
+     */
+    chromaReject?: boolean;
+    /**
+     * Allow other properties (for internal purposes)
+     *
+     * @internal
+     */
+    [key: string]: unknown;
+}
+/**
+ * The supported symbologies.
+ */
+export type SymbologyName = 'ean13' | 'ean8' | 'upca' | 'upce' | 'databar' | 'databar-exp' | 'code39' | 'code93' | 'code128' | 'i25' | 'codabar' | 'qr' | 'aztec' | 'datamatrix';
+/**
+ * Engine configuration
+ */
+export interface EngineConfiguration {
+    /**
+     * The enabled symbologies.
+     *
+     * It is highly recommended to configure only the symbologies required by
+     * your application.
+     *
+     * @default undefined (all symbologies enabled - NOT RECOMMENDED)
+     */
+    symbologies?: SymbologyName[];
+    /**
+     * The number of scanlines to run over a located barcode candidate.
+     *
+     * @default 10
+     */
+    numScanlines?: number;
+    /**
+     * The number of scanlines that need to decodd successfully for a valid
+     * decode.
+     *
+     * Increasing this parameter reduces the possibility of a misread, but
+     * makes it more likely for degraded codes to not be read at all.
+     *
+     * The default value is two scanlines and usually should not be changed.
+     *
+     * @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.
+     *
+     * @default false
+     */
+    invertedCodes?: boolean;
+    /**
+     * Time interval in milliseconds during which multiple detections of the same code are not repeated.
+     *
+     * The default behavior is to pass through detections as they are detected and not perform any filtering.
+     *
+     * 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
+ */
+export interface OverlayConfiguration {
+    /**
+     * Indicate if a horizontal line should be drawn to aid in positioning 1D barcodes.
+     *
+     * @default true
+     */
+    showTargetingLine?: boolean;
+    /**
+     * Indicate if the overlay should draw the bounding boxes of detected barcodes on top of the camera preview.
+     *
+     * @default true
+     */
+    showDetections?: boolean;
+    /**
+     * Indicate if the camera selector should be shown in the overlay.
+     *
+     * @default true
+     */
+    showCameraSelector?: boolean;
+    /**
+     * Indicate if the flashlight toggle should be shown in the overlay.
+     *
+     * Flashlight functionality is not supported in some browsers.
+     *
+     * @default true
+     */
+    showFlashlight?: boolean;
+    /**
+     * Allow other properties (for internal purposes)
+     *
+     * @internal
+     */
+    [key: string]: unknown;
+}
+/**
+ * User feedback configuration
+ */
+export interface FeedbackConfiguration {
+    /**
+     * If true, an audible beep will be emitted upon successful scan.
+     *
+     * @default true
+     */
+    audio?: boolean;
+    /**
+     * If true, a vibration will be emitted upon successful scan (where supported by device).
+     *
+     * @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
+     * the BarcodeReader.
+     *
+     * Make sure the selector only matches a single element.
+     */
+    selector: string;
+    /**
+     * Mode: can be 'immediate' (default) for always-on scanning, and 'touch', to only scan when a touch occurs.
+     *
+     * @default immediate
+     */
+    mode?: 'immediate' | 'touch';
+    /**
+     * Frame source configuration
+     */
+    frameSource?: FrameSourceConfiguration;
+    /**
+     * Locator configuration
+     */
+    locator?: LocatorConfiguration;
+    /**
+     * Engine configuration
+     */
+    engine?: EngineConfiguration;
+    /**
+     * Overlay configuration
+     */
+    overlay?: OverlayConfiguration;
+    /**
+     * Feedback configuration
+     */
+    feedback?: FeedbackConfiguration;
+    /**
+     * Allow other properties (for internal purposes)
+     *
+     * @internal
+     */
+    [key: string]: unknown;
+}
+/**
+ * A point in two-dimensional space.
+ *
+ * The y coordinate origin starts at the top.
+ */
+export interface Point {
+    x: number;
+    y: number;
+}
+/**
+ * The size of a bounding box, represented by its width and height.
+ */
+export interface Size {
+    width: number;
+    height: number;
+}
+/**
+ * An axis-aligned rectangle in two-dimensional space.
+ */
+export interface Rect {
+    /**
+     * The origin of the rectangle.
+     */
+    origin: Point;
+    /**
+     * The size of the rectangle.
+     */
+    size: Size;
+}
+/**
+ * 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.
+     */
+    static version(): string;
+    /**
+     * Return true if the SDK was successfully initialized, false otherwise.
+     */
+    static isInitialized(): boolean;
+    /**
+     * One-time initialization of the SDK.
+     *
+     * @param licenseKey The license key obtained from the Customer Portal.
+     */
+    static initialize(licenseKey: string): Promise<void>;
+    /**
+     * 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.
+     *
+     * If the custom ID includes user-identifying data, you are responsible for obtaining consent.
+     *
+     * @param customId The custom ID. Use `null` to unset the custom ID.
+     * @default No custom ID is set by default
+     */
+    static setCustomId(customId: string | null): void;
+}
+/**
+ * A code detection reported by the STRICH SDK.
+ */
+export interface CodeDetection {
+    /**
+     * The textual data contained in the code.
+     */
+    data: string;
+    /**
+     * The type of detected code.
+     */
+    typeName: string;
+    /**
+     * The bounding rectangle in which the code was detected.
+     *
+     * Note: this might not be precise, especially for 1D barcodes.
+     */
+    boundingRect: Rect;
+    /**
+     * The time of detection.
+     */
+    time: number;
+}
+/**
+ * BarcodeReader is the primary interface of the STRICH SDK.
+ */
+export class BarcodeReader {
+    /**
+     * User-supplied barcode detection handler.
+     *
+     * This is a synchronous call, so further processing will not happen until the handler returns.
+     */
+    detected?: (detections: CodeDetection[]) => (void);
+    /**
+     * Create a new BarcodeReader using a Configuration.
+     *
+     * @param configuration A configuration object.
+     */
+    constructor(configuration: Configuration);
+    /**
+     * Initialize the BarcodeReader instance.
+     *
+     *
+     *
+     * @return A promise resolving to an initialized BarcodeReader instance, or an error object.
+     */
+    initialize(): Promise<BarcodeReader>;
+    /**
+     * Start scanning for barcodes.
+     */
+    start(): Promise<void>;
+    /**
+     * Stop the BarcodeReader instance.
+     *
+     * This will temporarily suspend processing of camera frames / detection of codes.
+     */
+    stop(): Promise<void>;
+    /**
+     * Destroy this BarcodeReader instance, making it unusable.
+     *
+     * This will release all associated resources, and should be called whenever an application no longer needs to
+     * scan.
+     */
+    destroy(): void;
+    /**
+     * Show/hide the BarcodeReader instance.
+     *
+     * @param visible True/false for visible/hidden
+     */
+    setVisible(visible: boolean): Promise<void>;
+    /**
+     * @return the current visibility of this BarcodeReader instance
+     */
+    getVisible(): boolean;
+}
+
+//# sourceMappingURL=strich.d.ts.map