@capacitor/barcode-scanner 1.0.0-alpha.1

package/dist/esm/definitions.d.ts

@@ -0,0 +1,90 @@
+import { Html5QrcodeSupportedFormats } from 'html5-qrcode';
+/**
+ * Enum representing the direction of the camera to be used for barcode scanning.
+ */
+export declare enum CapacitorBarcodeScannerCameraDirection {
+    BACK = 1,
+    FRONT = 2
+}
+/**
+ * Enum representing the orientation of the scanner during barcode scanning.
+ */
+export declare enum CapacitorBarcodeScannerScanOrientation {
+    PORTRAIT = 1,
+    LANDSCAPE = 2,
+    ADAPTIVE = 3
+}
+/**
+ * Enum representing a special option to indicate that all barcode types are supported.
+ */
+export declare enum CapacitorBarcodeScannerTypeHintALLOption {
+    ALL = 17
+}
+/**
+ * Extends supported formats from Html5Qrcode with a special 'ALL' option,
+ * indicating support for all barcode types.
+ */
+export declare const CapacitorBarcodeScannerTypeHint: {
+    [x: number]: string;
+    ALL: CapacitorBarcodeScannerTypeHintALLOption.ALL;
+    QR_CODE: Html5QrcodeSupportedFormats.QR_CODE;
+    AZTEC: Html5QrcodeSupportedFormats.AZTEC;
+    CODABAR: Html5QrcodeSupportedFormats.CODABAR;
+    CODE_39: Html5QrcodeSupportedFormats.CODE_39;
+    CODE_93: Html5QrcodeSupportedFormats.CODE_93;
+    CODE_128: Html5QrcodeSupportedFormats.CODE_128;
+    DATA_MATRIX: Html5QrcodeSupportedFormats.DATA_MATRIX;
+    MAXICODE: Html5QrcodeSupportedFormats.MAXICODE;
+    ITF: Html5QrcodeSupportedFormats.ITF;
+    EAN_13: Html5QrcodeSupportedFormats.EAN_13;
+    EAN_8: Html5QrcodeSupportedFormats.EAN_8;
+    PDF_417: Html5QrcodeSupportedFormats.PDF_417;
+    RSS_14: Html5QrcodeSupportedFormats.RSS_14;
+    RSS_EXPANDED: Html5QrcodeSupportedFormats.RSS_EXPANDED;
+    UPC_A: Html5QrcodeSupportedFormats.UPC_A;
+    UPC_E: Html5QrcodeSupportedFormats.UPC_E;
+    UPC_EAN_EXTENSION: Html5QrcodeSupportedFormats.UPC_EAN_EXTENSION;
+};
+/**
+ * Type definition combining Html5QrcodeSupportedFormats and OSBarcodeTypeHintALLOption
+ * to represent the hint for the type of barcode to be scanned.
+ */
+export type CapacitorBarcodeScannerTypeHint = Html5QrcodeSupportedFormats | CapacitorBarcodeScannerTypeHintALLOption;
+/**
+ * Enum representing the library to be used for barcode scanning on Android devices.
+ */
+export declare enum CapacitorBarcodeScannerAndroidScanningLibrary {
+    ZXING = "zxing",
+    MLKIT = "mlkit"
+}
+/**
+ * Defines the structure of the result returned from a barcode scan.
+ */
+export type CapacitorBarcodeScannerScanResult = {
+    ScanResult: string;
+};
+/**
+ * Defines the options for configuring a barcode scan.
+ */
+export type CapacitorBarcodeScannerOptions = {
+    hint: CapacitorBarcodeScannerTypeHint;
+    scanInstructions?: string;
+    scanButton?: boolean;
+    scanText?: string;
+    cameraDirection?: CapacitorBarcodeScannerCameraDirection;
+    scanOrientation?: CapacitorBarcodeScannerScanOrientation;
+    android?: {
+        scanningLibrary?: CapacitorBarcodeScannerAndroidScanningLibrary;
+    };
+    web?: {
+        showCameraSelection?: boolean;
+        scannerFPS?: number;
+    };
+};
+/**
+ * Interface defining the contract for a plugin capable of scanning barcodes.
+ * Requires implementation of the scanBarcode method, which initiates a barcode scan with given options.
+ */
+export interface CapacitorBarcodeScannerPlugin {
+    scanBarcode(options: CapacitorBarcodeScannerOptions): Promise<CapacitorBarcodeScannerScanResult>;
+}

package/dist/esm/definitions.js

@@ -0,0 +1,39 @@
+import { Html5QrcodeSupportedFormats } from 'html5-qrcode';
+/**
+ * Enum representing the direction of the camera to be used for barcode scanning.
+ */
+export var CapacitorBarcodeScannerCameraDirection;
+(function (CapacitorBarcodeScannerCameraDirection) {
+    CapacitorBarcodeScannerCameraDirection[CapacitorBarcodeScannerCameraDirection["BACK"] = 1] = "BACK";
+    CapacitorBarcodeScannerCameraDirection[CapacitorBarcodeScannerCameraDirection["FRONT"] = 2] = "FRONT";
+})(CapacitorBarcodeScannerCameraDirection || (CapacitorBarcodeScannerCameraDirection = {}));
+/**
+ * Enum representing the orientation of the scanner during barcode scanning.
+ */
+export var CapacitorBarcodeScannerScanOrientation;
+(function (CapacitorBarcodeScannerScanOrientation) {
+    CapacitorBarcodeScannerScanOrientation[CapacitorBarcodeScannerScanOrientation["PORTRAIT"] = 1] = "PORTRAIT";
+    CapacitorBarcodeScannerScanOrientation[CapacitorBarcodeScannerScanOrientation["LANDSCAPE"] = 2] = "LANDSCAPE";
+    CapacitorBarcodeScannerScanOrientation[CapacitorBarcodeScannerScanOrientation["ADAPTIVE"] = 3] = "ADAPTIVE";
+})(CapacitorBarcodeScannerScanOrientation || (CapacitorBarcodeScannerScanOrientation = {}));
+/**
+ * Enum representing a special option to indicate that all barcode types are supported.
+ */
+export var CapacitorBarcodeScannerTypeHintALLOption;
+(function (CapacitorBarcodeScannerTypeHintALLOption) {
+    CapacitorBarcodeScannerTypeHintALLOption[CapacitorBarcodeScannerTypeHintALLOption["ALL"] = 17] = "ALL";
+})(CapacitorBarcodeScannerTypeHintALLOption || (CapacitorBarcodeScannerTypeHintALLOption = {}));
+/**
+ * Extends supported formats from Html5Qrcode with a special 'ALL' option,
+ * indicating support for all barcode types.
+ */
+export const CapacitorBarcodeScannerTypeHint = Object.assign(Object.assign({}, Html5QrcodeSupportedFormats), CapacitorBarcodeScannerTypeHintALLOption);
+/**
+ * Enum representing the library to be used for barcode scanning on Android devices.
+ */
+export var CapacitorBarcodeScannerAndroidScanningLibrary;
+(function (CapacitorBarcodeScannerAndroidScanningLibrary) {
+    CapacitorBarcodeScannerAndroidScanningLibrary["ZXING"] = "zxing";
+    CapacitorBarcodeScannerAndroidScanningLibrary["MLKIT"] = "mlkit";
+})(CapacitorBarcodeScannerAndroidScanningLibrary || (CapacitorBarcodeScannerAndroidScanningLibrary = {}));
+//# sourceMappingURL=definitions.js.map

package/dist/esm/definitions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,cAAc,CAAC;AAE3D;;GAEG;AACH,MAAM,CAAN,IAAY,sCAGX;AAHD,WAAY,sCAAsC;IAChD,mGAAQ,CAAA;IACR,qGAAS,CAAA;AACX,CAAC,EAHW,sCAAsC,KAAtC,sCAAsC,QAGjD;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,sCAIX;AAJD,WAAY,sCAAsC;IAChD,2GAAY,CAAA;IACZ,6GAAa,CAAA;IACb,2GAAY,CAAA;AACd,CAAC,EAJW,sCAAsC,KAAtC,sCAAsC,QAIjD;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,wCAEX;AAFD,WAAY,wCAAwC;IAClD,sGAAQ,CAAA;AACV,CAAC,EAFW,wCAAwC,KAAxC,wCAAwC,QAEnD;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,+BAA+B,mCACvC,2BAA2B,GAC3B,wCAAwC,CAC5C,CAAC;AAQF;;GAEG;AACH,MAAM,CAAN,IAAY,6CAGX;AAHD,WAAY,6CAA6C;IACvD,gEAAe,CAAA;IACf,gEAAe,CAAA;AACjB,CAAC,EAHW,6CAA6C,KAA7C,6CAA6C,QAGxD","sourcesContent":["import { Html5QrcodeSupportedFormats } from 'html5-qrcode';\n\n/**\n * Enum representing the direction of the camera to be used for barcode scanning.\n */\nexport enum CapacitorBarcodeScannerCameraDirection {\n  BACK = 1,\n  FRONT = 2,\n}\n\n/**\n * Enum representing the orientation of the scanner during barcode scanning.\n */\nexport enum CapacitorBarcodeScannerScanOrientation {\n  PORTRAIT = 1,\n  LANDSCAPE = 2,\n  ADAPTIVE = 3,\n}\n\n/**\n * Enum representing a special option to indicate that all barcode types are supported.\n */\nexport enum CapacitorBarcodeScannerTypeHintALLOption {\n  ALL = 17,\n}\n\n/**\n * Extends supported formats from Html5Qrcode with a special 'ALL' option,\n * indicating support for all barcode types.\n */\nexport const CapacitorBarcodeScannerTypeHint = {\n  ...Html5QrcodeSupportedFormats,\n  ...CapacitorBarcodeScannerTypeHintALLOption,\n};\n\n/**\n * Type definition combining Html5QrcodeSupportedFormats and OSBarcodeTypeHintALLOption\n * to represent the hint for the type of barcode to be scanned.\n */\nexport type CapacitorBarcodeScannerTypeHint = Html5QrcodeSupportedFormats | CapacitorBarcodeScannerTypeHintALLOption;\n\n/**\n * Enum representing the library to be used for barcode scanning on Android devices.\n */\nexport enum CapacitorBarcodeScannerAndroidScanningLibrary {\n  ZXING = 'zxing',\n  MLKIT = 'mlkit',\n}\n\n/**\n * Defines the structure of the result returned from a barcode scan.\n */\nexport type CapacitorBarcodeScannerScanResult = { ScanResult: string };\n\n/**\n * Defines the options for configuring a barcode scan.\n */\nexport type CapacitorBarcodeScannerOptions = {\n  hint: CapacitorBarcodeScannerTypeHint;\n  scanInstructions?: string;\n  scanButton?: boolean;\n  scanText?: string;\n  cameraDirection?: CapacitorBarcodeScannerCameraDirection;\n  scanOrientation?: CapacitorBarcodeScannerScanOrientation;\n  android?: {\n    scanningLibrary?: CapacitorBarcodeScannerAndroidScanningLibrary;\n  };\n  web?: {\n    showCameraSelection?: boolean;\n    scannerFPS?: number;\n  };\n};\n\n/**\n * Interface defining the contract for a plugin capable of scanning barcodes.\n * Requires implementation of the scanBarcode method, which initiates a barcode scan with given options.\n */\nexport interface CapacitorBarcodeScannerPlugin {\n  scanBarcode(options: CapacitorBarcodeScannerOptions): Promise<CapacitorBarcodeScannerScanResult>;\n}\n"]}

package/dist/esm/index.d.ts

@@ -0,0 +1,9 @@
+import type { CapacitorBarcodeScannerPlugin } from './definitions';
+/**
+ * Registers the `OSBarcode` plugin with Capacitor.
+ * For web platforms, it applies necessary CSS for the barcode scanner and dynamically imports the web implementation.
+ * This allows for lazy loading of the web code only when needed, optimizing overall bundle size.
+ */
+declare const CapacitorBarcodeScanner: CapacitorBarcodeScannerPlugin;
+export * from './definitions';
+export { CapacitorBarcodeScanner };

package/dist/esm/index.js

@@ -0,0 +1,16 @@
+import { registerPlugin } from '@capacitor/core';
+import { applyCss, barcodeScannerCss } from './utils'; // Import utilities for applying CSS.
+/**
+ * Registers the `OSBarcode` plugin with Capacitor.
+ * For web platforms, it applies necessary CSS for the barcode scanner and dynamically imports the web implementation.
+ * This allows for lazy loading of the web code only when needed, optimizing overall bundle size.
+ */
+const CapacitorBarcodeScanner = registerPlugin('CapacitorBarcodeScanner', {
+    web: () => {
+        applyCss(barcodeScannerCss); // Apply the CSS styles necessary for the web implementation of the barcode scanner.
+        return import('./web').then((m) => new m.CapacitorBarcodeScannerWeb()); // Dynamically import the web implementation and instantiate it.
+    },
+});
+export * from './definitions'; // Re-export all exports from the definitions file.
+export { CapacitorBarcodeScanner }; // Export the OSBarcode plugin for use in Capacitor projects.
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAGjD,OAAO,EAAE,QAAQ,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC,CAAC,qCAAqC;AAE5F;;;;GAIG;AACH,MAAM,uBAAuB,GAAG,cAAc,CAAgC,yBAAyB,EAAE;IACvG,GAAG,EAAE,GAAG,EAAE;QACR,QAAQ,CAAC,iBAAiB,CAAC,CAAC,CAAC,oFAAoF;QACjH,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,0BAA0B,EAAE,CAAC,CAAC,CAAC,gEAAgE;IAC1I,CAAC;CACF,CAAC,CAAC;AAEH,cAAc,eAAe,CAAC,CAAC,mDAAmD;AAClF,OAAO,EAAE,uBAAuB,EAAE,CAAC,CAAC,6DAA6D","sourcesContent":["import { registerPlugin } from '@capacitor/core';\n\nimport type { CapacitorBarcodeScannerPlugin } from './definitions'; // Importing the interface for type checking.\nimport { applyCss, barcodeScannerCss } from './utils'; // Import utilities for applying CSS.\n\n/**\n * Registers the `OSBarcode` plugin with Capacitor.\n * For web platforms, it applies necessary CSS for the barcode scanner and dynamically imports the web implementation.\n * This allows for lazy loading of the web code only when needed, optimizing overall bundle size.\n */\nconst CapacitorBarcodeScanner = registerPlugin<CapacitorBarcodeScannerPlugin>('CapacitorBarcodeScanner', {\n  web: () => {\n    applyCss(barcodeScannerCss); // Apply the CSS styles necessary for the web implementation of the barcode scanner.\n    return import('./web').then((m) => new m.CapacitorBarcodeScannerWeb()); // Dynamically import the web implementation and instantiate it.\n  },\n});\n\nexport * from './definitions'; // Re-export all exports from the definitions file.\nexport { CapacitorBarcodeScanner }; // Export the OSBarcode plugin for use in Capacitor projects.\n"]}

package/dist/esm/utils.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Predefined CSS rules for styling barcode scanner components.
+ * Each object in the array defines a CSS rule, with a selector and the CSS properties to apply.
+ */
+export declare const barcodeScannerCss: {
+    selector: string;
+    css: string;
+}[];
+/**
+ * Dynamically applies a set of CSS rules to the document.
+ * If a custom style element with a specific ID does not exist, it is created and appended to the document's head.
+ * Existing rules in the style element are cleared before new ones are applied.
+ * This function supports both modern and older browsers by using `CSSStyleSheet.insertRule` and `textContent` respectively.
+ *
+ * @param {Array<{selector: string, css: string}>} cssRules - An array of objects containing CSS selectors and styles to apply.
+ */
+export declare function applyCss(cssRules: {
+    selector: string;
+    css: string;
+}[]): void;

package/dist/esm/utils.js

@@ -0,0 +1,55 @@
+/**
+ * Predefined CSS rules for styling barcode scanner components.
+ * Each object in the array defines a CSS rule, with a selector and the CSS properties to apply.
+ */
+export const barcodeScannerCss = [
+    { selector: '.scanner-container-display', css: 'display: block;' },
+    {
+        selector: '.scanner-dialog',
+        css: 'display: none; position: fixed; z-index: 999; left: 0; top: 0; width: 100%; height: 100%; overflow: auto; background-color: rgba(0,0,0,0.4);',
+    },
+    {
+        selector: '.scanner-dialog-inner',
+        css: 'background-color: #fefefe; margin: 2% auto; padding: 20px; border: 1px solid #888; width: 96%;',
+    },
+    { selector: '.close-button', css: 'color: #aaa; float: right; font-size: 28px; font-weight: bold; cursor: pointer;' },
+    { selector: '.close-button:hover', css: 'color: #222;' },
+    { selector: '.scanner-container-full-width', css: 'width: 100%;' },
+];
+/**
+ * Dynamically applies a set of CSS rules to the document.
+ * If a custom style element with a specific ID does not exist, it is created and appended to the document's head.
+ * Existing rules in the style element are cleared before new ones are applied.
+ * This function supports both modern and older browsers by using `CSSStyleSheet.insertRule` and `textContent` respectively.
+ *
+ * @param {Array<{selector: string, css: string}>} cssRules - An array of objects containing CSS selectors and styles to apply.
+ */
+export function applyCss(cssRules) {
+    const styleId = 'custom-style-os-cap-barcode'; // Unique identifier for the style element.
+    let styleElement = document.getElementById(styleId);
+    if (!styleElement) {
+        // Create and append a new style element if it does not exist.
+        styleElement = document.createElement('style');
+        styleElement.type = 'text/css';
+        styleElement.id = styleId;
+        document.head.appendChild(styleElement);
+    }
+    if (styleElement.sheet) {
+        // Clear existing CSS rules.
+        while (styleElement.sheet.cssRules.length) {
+            styleElement.sheet.deleteRule(0);
+        }
+        // Insert new CSS rules.
+        for (const { selector, css } of cssRules) {
+            styleElement.sheet.insertRule(`${selector} { ${css} }`);
+        }
+    }
+    else {
+        // Fallback for older browsers using textContent.
+        styleElement.textContent = '';
+        for (const { selector, css } of cssRules) {
+            styleElement.textContent += `${selector} { ${css} }`;
+        }
+    }
+}
+//# sourceMappingURL=utils.js.map

package/dist/esm/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,EAAE,QAAQ,EAAE,4BAA4B,EAAE,GAAG,EAAE,iBAAiB,EAAE;IAClE;QACE,QAAQ,EAAE,iBAAiB;QAC3B,GAAG,EAAE,8IAA8I;KACpJ;IACD;QACE,QAAQ,EAAE,uBAAuB;QACjC,GAAG,EAAE,gGAAgG;KACtG;IACD,EAAE,QAAQ,EAAE,eAAe,EAAE,GAAG,EAAE,iFAAiF,EAAE;IACrH,EAAE,QAAQ,EAAE,qBAAqB,EAAE,GAAG,EAAE,cAAc,EAAE;IACxD,EAAE,QAAQ,EAAE,+BAA+B,EAAE,GAAG,EAAE,cAAc,EAAE;CACnE,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,UAAU,QAAQ,CAAC,QAA6C;IACpE,MAAM,OAAO,GAAG,6BAA6B,CAAC,CAAC,2CAA2C;IAC1F,IAAI,YAAY,GAAG,QAAQ,CAAC,cAAc,CAAC,OAAO,CAA4B,CAAC;IAC/E,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,8DAA8D;QAC9D,YAAY,GAAG,QAAQ,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAC/C,YAAY,CAAC,IAAI,GAAG,UAAU,CAAC;QAC/B,YAAY,CAAC,EAAE,GAAG,OAAO,CAAC;QAC1B,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;IAC1C,CAAC;IACD,IAAI,YAAY,CAAC,KAAK,EAAE,CAAC;QACvB,4BAA4B;QAC5B,OAAO,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YAC1C,YAAY,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QACnC,CAAC;QACD,wBAAwB;QACxB,KAAK,MAAM,EAAE,QAAQ,EAAE,GAAG,EAAE,IAAI,QAAQ,EAAE,CAAC;YACzC,YAAY,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,QAAQ,MAAM,GAAG,IAAI,CAAC,CAAC;QAC1D,CAAC;IACH,CAAC;SAAM,CAAC;QACN,iDAAiD;QACjD,YAAY,CAAC,WAAW,GAAG,EAAE,CAAC;QAC9B,KAAK,MAAM,EAAE,QAAQ,EAAE,GAAG,EAAE,IAAI,QAAQ,EAAE,CAAC;YACzC,YAAY,CAAC,WAAW,IAAI,GAAG,QAAQ,MAAM,GAAG,IAAI,CAAC;QACvD,CAAC;IACH,CAAC;AACH,CAAC","sourcesContent":["/**\n * Predefined CSS rules for styling barcode scanner components.\n * Each object in the array defines a CSS rule, with a selector and the CSS properties to apply.\n */\nexport const barcodeScannerCss = [\n  { selector: '.scanner-container-display', css: 'display: block;' },\n  {\n    selector: '.scanner-dialog',\n    css: 'display: none; position: fixed; z-index: 999; left: 0; top: 0; width: 100%; height: 100%; overflow: auto; background-color: rgba(0,0,0,0.4);',\n  },\n  {\n    selector: '.scanner-dialog-inner',\n    css: 'background-color: #fefefe; margin: 2% auto; padding: 20px; border: 1px solid #888; width: 96%;',\n  },\n  { selector: '.close-button', css: 'color: #aaa; float: right; font-size: 28px; font-weight: bold; cursor: pointer;' },\n  { selector: '.close-button:hover', css: 'color: #222;' },\n  { selector: '.scanner-container-full-width', css: 'width: 100%;' },\n];\n\n/**\n * Dynamically applies a set of CSS rules to the document.\n * If a custom style element with a specific ID does not exist, it is created and appended to the document's head.\n * Existing rules in the style element are cleared before new ones are applied.\n * This function supports both modern and older browsers by using `CSSStyleSheet.insertRule` and `textContent` respectively.\n *\n * @param {Array<{selector: string, css: string}>} cssRules - An array of objects containing CSS selectors and styles to apply.\n */\nexport function applyCss(cssRules: { selector: string; css: string }[]): void {\n  const styleId = 'custom-style-os-cap-barcode'; // Unique identifier for the style element.\n  let styleElement = document.getElementById(styleId) as HTMLStyleElement | null;\n  if (!styleElement) {\n    // Create and append a new style element if it does not exist.\n    styleElement = document.createElement('style');\n    styleElement.type = 'text/css';\n    styleElement.id = styleId;\n    document.head.appendChild(styleElement);\n  }\n  if (styleElement.sheet) {\n    // Clear existing CSS rules.\n    while (styleElement.sheet.cssRules.length) {\n      styleElement.sheet.deleteRule(0);\n    }\n    // Insert new CSS rules.\n    for (const { selector, css } of cssRules) {\n      styleElement.sheet.insertRule(`${selector} { ${css} }`);\n    }\n  } else {\n    // Fallback for older browsers using textContent.\n    styleElement.textContent = '';\n    for (const { selector, css } of cssRules) {\n      styleElement.textContent += `${selector} { ${css} }`;\n    }\n  }\n}\n"]}

package/dist/esm/web.d.ts

@@ -0,0 +1,27 @@
+import { WebPlugin } from '@capacitor/core';
+import type { CapacitorBarcodeScannerPlugin, CapacitorBarcodeScannerOptions, CapacitorBarcodeScannerScanResult } from './definitions';
+/**
+ * Implements OSBarcodePlugin to provide web functionality for barcode scanning.
+ */
+export declare class CapacitorBarcodeScannerWeb extends WebPlugin implements CapacitorBarcodeScannerPlugin {
+    /**
+     * Stops the barcode scanner and hides its UI.
+     * @private
+     * @returns {Promise<void>} A promise that resolves when the scanner has stopped and its UI is hidden.
+     */
+    private stopAndHideScanner;
+    /**
+     * Builds the HTML elements necessary for the barcode scanner UI.
+     * This method checks if the scanner container exists before creating it to avoid duplicates.
+     * It also sets up the close button to stop and hide the scanner on click.
+     * @private
+     */
+    private buildScannerElement;
+    /**
+     * Initiates a barcode scan using the user's camera and HTML5 QR code scanner.
+     * Displays the scanner UI and waits for a scan to complete or fail.
+     * @param {OSBarcodeScanOptions} options Configuration options for the scan, including camera direction and UI preferences.
+     * @returns {Promise<OSBarcodeScanResult>} A promise that resolves with the scan result or rejects with an error.
+     */
+    scanBarcode(options: CapacitorBarcodeScannerOptions): Promise<CapacitorBarcodeScannerScanResult>;
+}

package/dist/esm/web.js

@@ -0,0 +1,116 @@
+import { WebPlugin } from '@capacitor/core';
+import { Html5Qrcode } from 'html5-qrcode';
+import { CapacitorBarcodeScannerScanOrientation } from './definitions';
+/**
+ * Implements OSBarcodePlugin to provide web functionality for barcode scanning.
+ */
+export class CapacitorBarcodeScannerWeb extends WebPlugin {
+    /**
+     * Stops the barcode scanner and hides its UI.
+     * @private
+     * @returns {Promise<void>} A promise that resolves when the scanner has stopped and its UI is hidden.
+     */
+    async stopAndHideScanner() {
+        console.log(window.OSBarcodeWebScanner);
+        if (window.OSBarcodeWebScanner) {
+            await window.OSBarcodeWebScanner.stop();
+            window.OSBarcodeWebScanner = null;
+        }
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        document.getElementById('cap-os-barcode-scanner-container-dialog').style.display = 'none';
+    }
+    /**
+     * Builds the HTML elements necessary for the barcode scanner UI.
+     * This method checks if the scanner container exists before creating it to avoid duplicates.
+     * It also sets up the close button to stop and hide the scanner on click.
+     * @private
+     */
+    buildScannerElement() {
+        if (document.getElementById('cap-os-barcode-scanner-container')) {
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            document.getElementById('cap-os-barcode-scanner-container').className = 'scanner-container-display';
+            return;
+        }
+        // Create and configure scanner container elements
+        const caposbarcodescannercontainer = document.body.appendChild(document.createElement('div'));
+        caposbarcodescannercontainer.id = 'cap-os-barcode-scanner-container';
+        const caposbarcodescannercontainerdialog = document.createElement('div');
+        caposbarcodescannercontainerdialog.id = 'cap-os-barcode-scanner-container-dialog';
+        caposbarcodescannercontainerdialog.className = 'scanner-dialog';
+        // Inner dialog elements including the close button and scanner view
+        const caposbarcodescannercontainerdialoginner = document.createElement('div');
+        caposbarcodescannercontainerdialoginner.className = 'scanner-dialog-inner';
+        const caposbarcodescannercontainerdialoginnerclose = document.createElement('span');
+        caposbarcodescannercontainerdialoginnerclose.className = 'close-button';
+        caposbarcodescannercontainerdialoginnerclose.innerHTML = '&times;';
+        caposbarcodescannercontainerdialoginner.appendChild(caposbarcodescannercontainerdialoginnerclose);
+        const caposbarcodescannercontainerdialoginnercontainerp = document.createElement('p');
+        caposbarcodescannercontainerdialoginnercontainerp.innerHTML = '&nbsp;';
+        caposbarcodescannercontainerdialoginner.appendChild(caposbarcodescannercontainerdialoginnercontainerp);
+        const caposbarcodescannercontainerdialoginnercontainer = document.createElement('div');
+        caposbarcodescannercontainerdialoginnercontainer.className = 'scanner-container-full-width';
+        caposbarcodescannercontainerdialoginnercontainer.id = 'cap-os-barcode-scanner-container-scanner';
+        caposbarcodescannercontainerdialoginner.appendChild(caposbarcodescannercontainerdialoginnercontainer);
+        caposbarcodescannercontainerdialog.appendChild(caposbarcodescannercontainerdialoginner);
+        caposbarcodescannercontainer.appendChild(caposbarcodescannercontainerdialog);
+        caposbarcodescannercontainerdialoginnerclose.onclick = this.stopAndHideScanner;
+    }
+    /**
+     * Initiates a barcode scan using the user's camera and HTML5 QR code scanner.
+     * Displays the scanner UI and waits for a scan to complete or fail.
+     * @param {OSBarcodeScanOptions} options Configuration options for the scan, including camera direction and UI preferences.
+     * @returns {Promise<OSBarcodeScanResult>} A promise that resolves with the scan result or rejects with an error.
+     */
+    async scanBarcode(options) {
+        this.buildScannerElement();
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        document.getElementById('cap-os-barcode-scanner-container-dialog').style.display = 'block';
+        return new Promise((resolve, reject) => {
+            var _a, _b;
+            const param = {
+                facingMode: options.cameraDirection === 1 ? 'environment' : 'user',
+                hasScannerButton: false,
+                scanButton: options.scanButton === undefined ? false : options.scanButton,
+                showScanLine: false,
+                scanInstructions: options.scanInstructions ? options.scanInstructions : '',
+                orientation: options.scanOrientation
+                    ? options.scanOrientation
+                    : CapacitorBarcodeScannerScanOrientation.PORTRAIT,
+                showCameraSelection: ((_a = options.web) === null || _a === void 0 ? void 0 : _a.showCameraSelection) ? options.web.showCameraSelection : false,
+                typeHint: options.hint === 17 ? undefined : options.hint,
+                scannerFPS: ((_b = options.web) === null || _b === void 0 ? void 0 : _b.scannerFPS) ? options.web.scannerFPS : 50,
+            };
+            // Set up and start the scanner
+            const scannerElement = document.getElementById('cap-os-barcode-scanner-container-scanner');
+            if (!scannerElement) {
+                throw new Error('Scanner Element is required for web');
+            }
+            window.OSBarcodeWebScanner = new Html5Qrcode(scannerElement.id);
+            const Html5QrcodeConfig = {
+                fps: param.scannerFPS,
+                qrbox: scannerElement.getBoundingClientRect().width * (9 / 16) - 10,
+                aspectRatio: 16 / 9,
+                videoConstraints: {
+                    focusMode: 'continuous',
+                    height: { min: 576, ideal: 1920 },
+                    deviceId: undefined,
+                    facingMode: undefined,
+                },
+            };
+            // Success and error callbacks for the scanner
+            const OSBarcodeWebScannerSuccessCallback = (decodedText, _decodedResult) => {
+                this.stopAndHideScanner();
+                resolve({ ScanResult: decodedText });
+            };
+            const OSBarcodeWebScannerErrorCallback = (error) => {
+                if (error.indexOf('NotFoundException') === -1) {
+                    this.stopAndHideScanner();
+                    console.error(`[Scanner Web Error] ${error}`);
+                    reject(error);
+                }
+            };
+            window.OSBarcodeWebScanner.start({ facingMode: param.facingMode }, Html5QrcodeConfig, OSBarcodeWebScannerSuccessCallback, OSBarcodeWebScannerErrorCallback);
+        });
+    }
+}
+//# sourceMappingURL=web.js.map

package/dist/esm/web.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"web.js","sourceRoot":"","sources":["../../src/web.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAO3C,OAAO,EAAE,sCAAsC,EAAE,MAAM,eAAe,CAAC;AAEvE;;GAEG;AACH,MAAM,OAAO,0BAA2B,SAAQ,SAAS;IACvD;;;;OAIG;IACK,KAAK,CAAC,kBAAkB;QAC9B,OAAO,CAAC,GAAG,CAAE,MAAc,CAAC,mBAAmB,CAAC,CAAC;QACjD,IAAK,MAAc,CAAC,mBAAmB,EAAE,CAAC;YACxC,MAAO,MAAc,CAAC,mBAAmB,CAAC,IAAI,EAAE,CAAC;YAChD,MAAc,CAAC,mBAAmB,GAAG,IAAI,CAAC;QAC7C,CAAC;QACD,oEAAoE;QACpE,QAAQ,CAAC,cAAc,CAAC,yCAAyC,CAAE,CAAC,KAAK,CAAC,OAAO,GAAG,MAAM,CAAC;IAC7F,CAAC;IAED;;;;;OAKG;IACK,mBAAmB;QACzB,IAAI,QAAQ,CAAC,cAAc,CAAC,kCAAkC,CAAC,EAAE,CAAC;YAChE,oEAAoE;YACpE,QAAQ,CAAC,cAAc,CAAC,kCAAkC,CAAE,CAAC,SAAS,GAAG,2BAA2B,CAAC;YACrG,OAAO;QACT,CAAC;QACD,kDAAkD;QAClD,MAAM,4BAA4B,GAAG,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;QAC9F,4BAA4B,CAAC,EAAE,GAAG,kCAAkC,CAAC;QACrE,MAAM,kCAAkC,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QACzE,kCAAkC,CAAC,EAAE,GAAG,yCAAyC,CAAC;QAClF,kCAAkC,CAAC,SAAS,GAAG,gBAAgB,CAAC;QAEhE,oEAAoE;QACpE,MAAM,uCAAuC,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC9E,uCAAuC,CAAC,SAAS,GAAG,sBAAsB,CAAC;QAE3E,MAAM,4CAA4C,GAAG,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QACpF,4CAA4C,CAAC,SAAS,GAAG,cAAc,CAAC;QACxE,4CAA4C,CAAC,SAAS,GAAG,SAAS,CAAC;QACnE,uCAAuC,CAAC,WAAW,CAAC,4CAA4C,CAAC,CAAC;QAElG,MAAM,iDAAiD,GAAG,QAAQ,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;QACtF,iDAAiD,CAAC,SAAS,GAAG,QAAQ,CAAC;QACvE,uCAAuC,CAAC,WAAW,CAAC,iDAAiD,CAAC,CAAC;QAEvG,MAAM,gDAAgD,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QACvF,gDAAgD,CAAC,SAAS,GAAG,8BAA8B,CAAC;QAC5F,gDAAgD,CAAC,EAAE,GAAG,0CAA0C,CAAC;QACjG,uCAAuC,CAAC,WAAW,CAAC,gDAAgD,CAAC,CAAC;QAEtG,kCAAkC,CAAC,WAAW,CAAC,uCAAuC,CAAC,CAAC;QACxF,4BAA4B,CAAC,WAAW,CAAC,kCAAkC,CAAC,CAAC;QAE7E,4CAA4C,CAAC,OAAO,GAAG,IAAI,CAAC,kBAAkB,CAAC;IACjF,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,WAAW,CAAC,OAAuC;QACvD,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC3B,oEAAoE;QACpE,QAAQ,CAAC,cAAc,CAAC,yCAAyC,CAAE,CAAC,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC;QAC5F,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;;YACrC,MAAM,KAAK,GAAG;gBACZ,UAAU,EAAE,OAAO,CAAC,eAAe,KAAK,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM;gBAClE,gBAAgB,EAAE,KAAK;gBACvB,UAAU,EAAE,OAAO,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU;gBACzE,YAAY,EAAE,KAAK;gBACnB,gBAAgB,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE;gBAC1E,WAAW,EAAE,OAAO,CAAC,eAAe;oBAClC,CAAC,CAAC,OAAO,CAAC,eAAe;oBACzB,CAAC,CAAC,sCAAsC,CAAC,QAAQ;gBACnD,mBAAmB,EAAE,CAAA,MAAA,OAAO,CAAC,GAAG,0CAAE,mBAAmB,EAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC,CAAC,KAAK;gBAC/F,QAAQ,EAAE,OAAO,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI;gBACxD,UAAU,EAAE,CAAA,MAAA,OAAO,CAAC,GAAG,0CAAE,UAAU,EAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE;aAClE,CAAC;YAEF,+BAA+B;YAC/B,MAAM,cAAc,GAAG,QAAQ,CAAC,cAAc,CAAC,0CAA0C,CAAC,CAAC;YAC3F,IAAI,CAAC,cAAc,EAAE,CAAC;gBACpB,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;YACzD,CAAC;YAEA,MAAc,CAAC,mBAAmB,GAAG,IAAI,WAAW,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;YACzE,MAAM,iBAAiB,GAAG;gBACxB,GAAG,EAAE,KAAK,CAAC,UAAU;gBACrB,KAAK,EAAE,cAAc,CAAC,qBAAqB,EAAE,CAAC,KAAK,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE;gBACnE,WAAW,EAAE,EAAE,GAAG,CAAC;gBACnB,gBAAgB,EAAE;oBAChB,SAAS,EAAE,YAAY;oBACvB,MAAM,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE;oBACjC,QAAQ,EAAE,SAAS;oBACnB,UAAU,EAAE,SAAS;iBACtB;aACF,CAAC;YAEF,8CAA8C;YAC9C,MAAM,kCAAkC,GAAG,CAAC,WAAmB,EAAE,cAAiC,EAAE,EAAE;gBACpG,IAAI,CAAC,kBAAkB,EAAE,CAAC;gBAC1B,OAAO,CAAC,EAAE,UAAU,EAAE,WAAW,EAAE,CAAC,CAAC;YACvC,CAAC,CAAC;YAEF,MAAM,gCAAgC,GAAG,CAAC,KAAa,EAAE,EAAE;gBACzD,IAAI,KAAK,CAAC,OAAO,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;oBAC9C,IAAI,CAAC,kBAAkB,EAAE,CAAC;oBAC1B,OAAO,CAAC,KAAK,CAAC,uBAAuB,KAAK,EAAE,CAAC,CAAC;oBAC9C,MAAM,CAAC,KAAK,CAAC,CAAC;gBAChB,CAAC;YACH,CAAC,CAAC;YAED,MAAc,CAAC,mBAAmB,CAAC,KAAK,CACvC,EAAE,UAAU,EAAE,KAAK,CAAC,UAAU,EAAE,EAChC,iBAAiB,EACjB,kCAAkC,EAClC,gCAAgC,CACjC,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;CACF","sourcesContent":["import { WebPlugin } from '@capacitor/core';\nimport type { Html5QrcodeResult } from 'html5-qrcode';\nimport { Html5Qrcode } from 'html5-qrcode';\n\nimport type {\n  CapacitorBarcodeScannerPlugin,\n  CapacitorBarcodeScannerOptions,\n  CapacitorBarcodeScannerScanResult,\n} from './definitions';\nimport { CapacitorBarcodeScannerScanOrientation } from './definitions';\n\n/**\n * Implements OSBarcodePlugin to provide web functionality for barcode scanning.\n */\nexport class CapacitorBarcodeScannerWeb extends WebPlugin implements CapacitorBarcodeScannerPlugin {\n  /**\n   * Stops the barcode scanner and hides its UI.\n   * @private\n   * @returns {Promise<void>} A promise that resolves when the scanner has stopped and its UI is hidden.\n   */\n  private async stopAndHideScanner(): Promise<void> {\n    console.log((window as any).OSBarcodeWebScanner);\n    if ((window as any).OSBarcodeWebScanner) {\n      await (window as any).OSBarcodeWebScanner.stop();\n      (window as any).OSBarcodeWebScanner = null;\n    }\n    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n    document.getElementById('cap-os-barcode-scanner-container-dialog')!.style.display = 'none';\n  }\n\n  /**\n   * Builds the HTML elements necessary for the barcode scanner UI.\n   * This method checks if the scanner container exists before creating it to avoid duplicates.\n   * It also sets up the close button to stop and hide the scanner on click.\n   * @private\n   */\n  private buildScannerElement(): void {\n    if (document.getElementById('cap-os-barcode-scanner-container')) {\n      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n      document.getElementById('cap-os-barcode-scanner-container')!.className = 'scanner-container-display';\n      return;\n    }\n    // Create and configure scanner container elements\n    const caposbarcodescannercontainer = document.body.appendChild(document.createElement('div'));\n    caposbarcodescannercontainer.id = 'cap-os-barcode-scanner-container';\n    const caposbarcodescannercontainerdialog = document.createElement('div');\n    caposbarcodescannercontainerdialog.id = 'cap-os-barcode-scanner-container-dialog';\n    caposbarcodescannercontainerdialog.className = 'scanner-dialog';\n\n    // Inner dialog elements including the close button and scanner view\n    const caposbarcodescannercontainerdialoginner = document.createElement('div');\n    caposbarcodescannercontainerdialoginner.className = 'scanner-dialog-inner';\n\n    const caposbarcodescannercontainerdialoginnerclose = document.createElement('span');\n    caposbarcodescannercontainerdialoginnerclose.className = 'close-button';\n    caposbarcodescannercontainerdialoginnerclose.innerHTML = '&times;';\n    caposbarcodescannercontainerdialoginner.appendChild(caposbarcodescannercontainerdialoginnerclose);\n\n    const caposbarcodescannercontainerdialoginnercontainerp = document.createElement('p');\n    caposbarcodescannercontainerdialoginnercontainerp.innerHTML = '&nbsp;';\n    caposbarcodescannercontainerdialoginner.appendChild(caposbarcodescannercontainerdialoginnercontainerp);\n\n    const caposbarcodescannercontainerdialoginnercontainer = document.createElement('div');\n    caposbarcodescannercontainerdialoginnercontainer.className = 'scanner-container-full-width';\n    caposbarcodescannercontainerdialoginnercontainer.id = 'cap-os-barcode-scanner-container-scanner';\n    caposbarcodescannercontainerdialoginner.appendChild(caposbarcodescannercontainerdialoginnercontainer);\n\n    caposbarcodescannercontainerdialog.appendChild(caposbarcodescannercontainerdialoginner);\n    caposbarcodescannercontainer.appendChild(caposbarcodescannercontainerdialog);\n\n    caposbarcodescannercontainerdialoginnerclose.onclick = this.stopAndHideScanner;\n  }\n\n  /**\n   * Initiates a barcode scan using the user's camera and HTML5 QR code scanner.\n   * Displays the scanner UI and waits for a scan to complete or fail.\n   * @param {OSBarcodeScanOptions} options Configuration options for the scan, including camera direction and UI preferences.\n   * @returns {Promise<OSBarcodeScanResult>} A promise that resolves with the scan result or rejects with an error.\n   */\n  async scanBarcode(options: CapacitorBarcodeScannerOptions): Promise<CapacitorBarcodeScannerScanResult> {\n    this.buildScannerElement();\n    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n    document.getElementById('cap-os-barcode-scanner-container-dialog')!.style.display = 'block';\n    return new Promise((resolve, reject) => {\n      const param = {\n        facingMode: options.cameraDirection === 1 ? 'environment' : 'user',\n        hasScannerButton: false,\n        scanButton: options.scanButton === undefined ? false : options.scanButton,\n        showScanLine: false,\n        scanInstructions: options.scanInstructions ? options.scanInstructions : '',\n        orientation: options.scanOrientation\n          ? options.scanOrientation\n          : CapacitorBarcodeScannerScanOrientation.PORTRAIT,\n        showCameraSelection: options.web?.showCameraSelection ? options.web.showCameraSelection : false,\n        typeHint: options.hint === 17 ? undefined : options.hint,\n        scannerFPS: options.web?.scannerFPS ? options.web.scannerFPS : 50,\n      };\n\n      // Set up and start the scanner\n      const scannerElement = document.getElementById('cap-os-barcode-scanner-container-scanner');\n      if (!scannerElement) {\n        throw new Error('Scanner Element is required for web');\n      }\n\n      (window as any).OSBarcodeWebScanner = new Html5Qrcode(scannerElement.id);\n      const Html5QrcodeConfig = {\n        fps: param.scannerFPS,\n        qrbox: scannerElement.getBoundingClientRect().width * (9 / 16) - 10,\n        aspectRatio: 16 / 9,\n        videoConstraints: {\n          focusMode: 'continuous',\n          height: { min: 576, ideal: 1920 },\n          deviceId: undefined,\n          facingMode: undefined,\n        },\n      };\n\n      // Success and error callbacks for the scanner\n      const OSBarcodeWebScannerSuccessCallback = (decodedText: string, _decodedResult: Html5QrcodeResult) => {\n        this.stopAndHideScanner();\n        resolve({ ScanResult: decodedText });\n      };\n\n      const OSBarcodeWebScannerErrorCallback = (error: string) => {\n        if (error.indexOf('NotFoundException') === -1) {\n          this.stopAndHideScanner();\n          console.error(`[Scanner Web Error] ${error}`);\n          reject(error);\n        }\n      };\n\n      (window as any).OSBarcodeWebScanner.start(\n        { facingMode: param.facingMode },\n        Html5QrcodeConfig,\n        OSBarcodeWebScannerSuccessCallback,\n        OSBarcodeWebScannerErrorCallback\n      );\n    });\n  }\n}\n"]}