@pixelverse/strichjs-sdk 1.7.5 → 1.8.1

package/dist/strich.d.ts

@@ -334,6 +334,71 @@ export declare interface FrameSourceConfiguration {
     constraints?: MediaStreamConstraints;
 }
 
+/**
+ * Configuration object for {@link ImageScanner}.
+ *
+ * Specify which kind of 1D/2D barcodes should be detected using the
+ * {@link EngineConfiguration.symbologies} field.
+ *
+ * @example
+ * To read a QR Code from an image, use this configuration:
+ *
+ * ```javascript
+ * const cfg = {
+ *   engine: { symbologies: ['qr'] }
+ * }
+ * ```
+ */
+export declare interface ImageConfiguration {
+    /**
+     * Engine configuration
+     */
+    engine?: EngineConfiguration;
+}
+
+/**
+ * Scanner for static images, typically provided via an HTML input element.
+ *
+ * @remarks
+ * Make sure that the input image is sharp, and that the code to be scanned is in focus. Some images might not scan
+ * using ImageScanner, but can be scanned using camera-based scanning (BarcodeReader, PopupScanner). This is due to
+ * more frames being available for decoding, increasing the chances of getting a good quality sample.
+ *
+ * @example
+ * HTML:
+ * ```html
+ * <input id="image-input" type="file" accept="image/*" />
+ * ```
+ *
+ * JavaScript:
+ * ```javascript
+ * const imageInput = document.getElementById('image-input');
+ * imageInput.onchange = async () => {
+ *  const detections = await ImageScanner.scan(image.files[0], {
+ *    engine: { symbologies: ['qr'] }
+ *  });
+ * }
+ * ```
+ */
+export declare class ImageScanner {
+    /**
+     * Decode a barcode in a static image.
+     *
+     * @remarks
+     * By default, a single barcode is detected. In a future release, an option to detect multiple barcodes
+     * will be added.
+     *
+     * @param image - The image source, can be a HTMLImageElement, ImageData, ImageBitmap, File, Blob or a data URL.
+     * @param cfg - The engine configuration to use for barcode detection.
+     */
+    static scan(image: ImageSource, cfg: ImageConfiguration): Promise<CodeDetection[]>;
+}
+
+/**
+ * The types of image input {@link ImageScanner.scan} can process.
+ */
+export declare type ImageSource = HTMLImageElement | ImageData | ImageBitmap | File | Blob | string;
+
 /**
  * Locator configuration
  */
@@ -713,6 +778,10 @@ export declare class SdkError extends Error {
      */
     detailMessage?: string;
     constructor(keyOrMessage: string, cause?: Error);
+    /**
+     * Create an SDK error with 'invalid input' semantics.
+     */
+    static invalidInputError(cause?: Error): SdkError;
 }
 
 /**