capacitor-camera-view 1.0.0

package/dist/esm/definitions.d.ts

@@ -0,0 +1,378 @@
+import type { PermissionState, PluginListenerHandle } from '@capacitor/core';
+/**
+ * Main plugin interface for Capacitor Camera View functionality.
+ *
+ * @since 1.0.0
+ */
+export interface CameraViewPlugin {
+    /**
+     * Start the camera view with optional configuration.
+     *
+     * @param options - Configuration options for the camera session
+     * @returns A promise that resolves when the camera has started
+     *
+     * @since 1.0.0
+     */
+    start(options?: CameraSessionConfiguration): Promise<void>;
+    /**
+     * Stop the camera view and release resources.
+     *
+     * @returns A promise that resolves when the camera has stopped
+     *
+     * @since 1.0.0
+     */
+    stop(): Promise<void>;
+    /**
+     * Check if the camera view is currently running.
+     *
+     * @returns A promise that resolves with an object containing the running state of the camera
+     *
+     * @since 1.0.0
+     */
+    isRunning(): Promise<IsRunningResponse>;
+    /**
+     * Capture a photo using the current camera configuration.
+     *
+     * @param options - Capture configuration options
+     * @param options.quality - The JPEG quality of the captured photo on a scale of 0-100
+     * @returns A promise that resolves with an object containing a base64 encoded string of the captured photo
+     *
+     * @since 1.0.0
+     */
+    capture(options: {
+        quality: number;
+    }): Promise<CaptureResponse>;
+    /**
+     * Captures a frame from the current camera preview without using the full camera capture pipeline.
+     *
+     * Unlike `capture()` which may trigger hardware-level photo capture on native platforms,
+     * this method quickly samples the current video stream. This is suitable computer vision or
+     * simple snapshots where high fidelity is not required.
+     *
+     * On web this method does exactly the same as `capture()` as it only captures a frame from the video stream
+     * because unfortunately [ImageCapture API](https://developer.mozilla.org/en-US/docs/Web/API/ImageCapture) is
+     * not yet well supported on the web.
+     *
+     * @param options - Capture configuration options
+     * @param options.quality - The JPEG quality of the captured sample on a scale of 0-100
+     * @returns A promise that resolves with an object containing a base64 encoded string of the captured sample
+     *
+     * @since 1.0.0
+     */
+    captureSample(options: {
+        quality: number;
+    }): Promise<CaptureResponse>;
+    /**
+     * Switch between front and back camera.
+     *
+     * @returns A promise that resolves when the camera has been flipped
+     *
+     * @since 1.0.0
+     */
+    flipCamera(): Promise<void>;
+    /**
+     * Get available camera devices for capturing photos.
+     *
+     * @returns A promise that resolves with an object containing an array of available capture devices
+     *
+     * @since 1.0.0
+     */
+    getAvailableDevices(): Promise<GetAvailableDevicesResponse>;
+    /**
+     * Get current zoom level information and available range.
+     *
+     * @remarks
+     * Make sure the camera is properly initialized before calling this method. Otherwise, this might
+     * lead to returning default values on android.
+     *
+     * @returns A promise that resolves with an object containing min, max and current zoom levels
+     *
+     * @since 1.0.0
+     */
+    getZoom(): Promise<GetZoomResponse>;
+    /**
+     * Set the camera zoom level.
+     *
+     * @param options - Zoom configuration options
+     * @param options.level - The zoom level to set
+     * @param options.ramp - Whether to animate the zoom level change, defaults to false (iOS only)
+     * @returns A promise that resolves when the zoom level has been set
+     *
+     * @remarks
+     * On web platforms, zoom functionality may be limited by browser support.
+     * When native zoom is not available, a CSS-based zoom simulation is applied.
+     *
+     * @since 1.0.0
+     */
+    setZoom(options: {
+        level: number;
+        ramp?: boolean;
+    }): Promise<void>;
+    /**
+     * Get current flash mode setting.
+     *
+     * @returns A promise that resolves with an object containing the current flash mode
+     *
+     * @since 1.0.0
+     */
+    getFlashMode(): Promise<GetFlashModeResponse>;
+    /**
+     * Get supported flash modes for the current camera.
+     *
+     * @returns A promise that resolves with an object containing an array of supported flash modes
+     *
+     * @since 1.0.0
+     */
+    getSupportedFlashModes(): Promise<GetSupportedFlashModesResponse>;
+    /**
+     * Set the camera flash mode.
+     *
+     * @param options - Flash mode configuration options
+     * @param options.mode - The flash mode to set
+     * @returns A promise that resolves when the flash mode has been set
+     *
+     * @since 1.0.0
+     */
+    setFlashMode(options: {
+        mode: FlashMode;
+    }): Promise<void>;
+    /**
+     * Check camera permission status without requesting permissions.
+     *
+     * @returns A promise that resolves with an object containing the camera permission status
+     *
+     * @since 1.0.0
+     */
+    checkPermissions(): Promise<PermissionStatus>;
+    /**
+     * Request camera permission from the user.
+     *
+     * @returns A promise that resolves with an object containing the camera permission status
+     *
+     * @since 1.0.0
+     */
+    requestPermissions(): Promise<PermissionStatus>;
+    /**
+     * Listen for barcode detection events.
+     * This event is emitted when a barcode is detected in the camera preview.
+     *
+     * @param eventName - The name of the event to listen for ('barcodeDetected')
+     * @param listenerFunc - The callback function to execute when a barcode is detected
+     * @returns A promise that resolves with an event subscription
+     *
+     * @since 1.0.0
+     */
+    addListener(eventName: 'barcodeDetected', listenerFunc: (data: BarcodeDetectionData) => void): Promise<PluginListenerHandle>;
+    /**
+     * Remove all listeners for this plugin.
+     *
+     * @param eventName - Optional event name to remove listeners for
+     * @returns A promise that resolves when the listeners are removed
+     *
+     * @since 1.0.0
+     */
+    removeAllListeners(eventName?: string): Promise<void>;
+}
+/**
+ * Position options for the camera.
+ * - 'front': Front-facing camera
+ * - 'back': Rear-facing camera
+ *
+ * @since 1.0.0
+ */
+export declare type CameraPosition = 'front' | 'back';
+/**
+ * Flash mode options for the camera.
+ * - 'off': Flash disabled
+ * - 'on': Flash always on
+ * - 'auto': Flash automatically enabled in low-light conditions
+ *
+ * @since 1.0.0
+ */
+export declare type FlashMode = 'off' | 'on' | 'auto';
+/**
+ * Represents a physical camera device on the device.
+ *
+ * @since 1.0.0
+ */
+export interface CameraDevice {
+    /** The unique identifier of the camera device */
+    id: string;
+    /** The human-readable name of the camera device */
+    name: string;
+    /** The position of the camera device (front or back) */
+    position: CameraPosition;
+    /** The type of the camera device (e.g., wide, ultra-wide, telephoto) - iOS only */
+    deviceType?: CameraDeviceType;
+}
+/**
+ * Available camera device types for iOS.
+ * Maps to AVCaptureDevice DeviceTypes in iOS.
+ *
+ * @see https://developer.apple.com/documentation/avfoundation/avcapturedevice/devicetype-swift.struct
+ *
+ * @since 1.0.0
+ */
+export declare type CameraDeviceType = 
+/** builtInWideAngleCamera - standard camera */
+'wideAngle'
+/** builtInUltraWideCamera - 0.5x zoom level */
+ | 'ultraWide'
+/** builtInTelephotoCamera - 2x/3x zoom level */
+ | 'telephoto'
+/** builtInDualCamera - wide + telephoto combination */
+ | 'dual'
+/** builtInDualWideCamera - wide + ultraWide combination */
+ | 'dualWide'
+/** builtInTripleCamera - wide + ultraWide + telephoto */
+ | 'triple'
+/** builtInTrueDepthCamera - front-facing camera with depth sensing */
+ | 'trueDepth';
+/**
+ * Configuration options for starting a camera session.
+ *
+ * @since 1.0.0
+ */
+export interface CameraSessionConfiguration {
+    /**
+     * Enables the barcode detection functionality
+     * @default false
+     */
+    enableBarcodeDetection?: boolean;
+    /**
+     * Position of the camera to use
+     * @default 'back'
+     */
+    position?: CameraPosition;
+    /**
+     * Specific device ID of the camera to use
+     * If provided, takes precedence over position
+     */
+    deviceId?: string;
+    /**
+     * Whether to use the triple camera if available (iPhone Pro models only)
+     * @default false
+     */
+    useTripleCameraIfAvailable?: boolean;
+    /**
+     * Ordered list of preferred camera device types to use (iOS only).
+     * The system will attempt to use the first available camera type in the list.
+     * If position is also provided, the system will use the first available camera type
+     * that matches the position and is in the list.
+     *
+     * This will fallback to the default camera type if none of the preferred types are available.
+     *
+     * @example [CameraDeviceType.WideAngle, CameraDeviceType.UltraWide, CameraDeviceType.Telephoto]
+     * @default undefined - system will decide based on position/deviceId
+     */
+    preferredCameraDeviceTypes?: CameraDeviceType[];
+    /**
+     * The initial zoom factor to use
+     * @default 1.0
+     */
+    zoomFactor?: number;
+    /**
+     * Optional HTML ID of the container element where the camera view should be rendered.
+     * If not provided, the camera view will be appended to the document body. Web only.
+     * @example 'cameraContainer'
+     */
+    containerElementId?: string;
+}
+/**
+ * Response for checking if the camera view is running.
+ *
+ * @since 1.0.0
+ */
+export interface IsRunningResponse {
+    /** Indicates if the camera view is currently active and running */
+    isRunning: boolean;
+}
+/**
+ * Response for capturing a photo.
+ *
+ * @since 1.0.0
+ */
+export interface CaptureResponse {
+    /** The base64 encoded string of the captured photo */
+    photo: string;
+}
+/**
+ * Response for getting available camera devices.
+ *
+ * @since 1.0.0
+ */
+export interface GetAvailableDevicesResponse {
+    /** An array of available camera devices */
+    devices: CameraDevice[];
+}
+/**
+ * Response for getting zoom level information.
+ *
+ * @since 1.0.0
+ */
+export interface GetZoomResponse {
+    /** The minimum zoom level supported */
+    min: number;
+    /** The maximum zoom level supported */
+    max: number;
+    /** The current zoom level */
+    current: number;
+}
+/**
+ * Response for getting the current flash mode.
+ *
+ * @since 1.0.0
+ */
+export interface GetFlashModeResponse {
+    /** The current flash mode setting */
+    flashMode: FlashMode;
+}
+/**
+ * Response for getting supported flash modes.
+ *
+ * @since 1.0.0
+ */
+export interface GetSupportedFlashModesResponse {
+    /** An array of flash modes supported by the current camera */
+    flashModes: FlashMode[];
+}
+/**
+ * Data for a detected barcode.
+ *
+ * @since 1.0.0
+ */
+export interface BarcodeDetectionData {
+    /** The decoded string value of the barcode */
+    value: string;
+    /** The display value of the barcode (may differ from the raw value) */
+    displayValue?: string;
+    /** The type/format of the barcode (e.g., 'qr', 'code128', etc.) */
+    type: string;
+    /** The bounding rectangle of the barcode in the camera frame. */
+    boundingRect: BoundingRect;
+}
+/**
+ * Rectangle defining the boundary of the barcode in the camera frame.
+ * Coordinates are normalized between 0 and 1 relative to the camera frame.
+ *
+ * @since 1.0.0
+ */
+export interface BoundingRect {
+    /** X-coordinate of the top-left corner */
+    x: number;
+    /** Y-coordinate of the top-left corner */
+    y: number;
+    /** Width of the bounding rectangle (should match the actual width of the barcode) */
+    width: number;
+    /** Height of the bounding rectangle (should match the actual height of the barcode) */
+    height: number;
+}
+/**
+ * Response for the camera permission status.
+ *
+ * @since 1.0.0
+ */
+export interface PermissionStatus {
+    /** The state of the camera permission */
+    camera: PermissionState;
+}

package/dist/esm/definitions.js

@@ -0,0 +1,2 @@
+export {};
+//# 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":"","sourcesContent":["import type { PermissionState, PluginListenerHandle } from '@capacitor/core';\n\n/**\n * Main plugin interface for Capacitor Camera View functionality.\n *\n * @since 1.0.0\n */\nexport interface CameraViewPlugin {\n  /**\n   * Start the camera view with optional configuration.\n   *\n   * @param options - Configuration options for the camera session\n   * @returns A promise that resolves when the camera has started\n   *\n   * @since 1.0.0\n   */\n  start(options?: CameraSessionConfiguration): Promise<void>;\n\n  /**\n   * Stop the camera view and release resources.\n   *\n   * @returns A promise that resolves when the camera has stopped\n   *\n   * @since 1.0.0\n   */\n  stop(): Promise<void>;\n\n  /**\n   * Check if the camera view is currently running.\n   *\n   * @returns A promise that resolves with an object containing the running state of the camera\n   *\n   * @since 1.0.0\n   */\n  isRunning(): Promise<IsRunningResponse>;\n\n  /**\n   * Capture a photo using the current camera configuration.\n   *\n   * @param options - Capture configuration options\n   * @param options.quality - The JPEG quality of the captured photo on a scale of 0-100\n   * @returns A promise that resolves with an object containing a base64 encoded string of the captured photo\n   *\n   * @since 1.0.0\n   */\n  capture(options: { quality: number }): Promise<CaptureResponse>;\n\n  /**\n   * Captures a frame from the current camera preview without using the full camera capture pipeline.\n   *\n   * Unlike `capture()` which may trigger hardware-level photo capture on native platforms,\n   * this method quickly samples the current video stream. This is suitable computer vision or\n   * simple snapshots where high fidelity is not required.\n   *\n   * On web this method does exactly the same as `capture()` as it only captures a frame from the video stream\n   * because unfortunately [ImageCapture API](https://developer.mozilla.org/en-US/docs/Web/API/ImageCapture) is\n   * not yet well supported on the web.\n   *\n   * @param options - Capture configuration options\n   * @param options.quality - The JPEG quality of the captured sample on a scale of 0-100\n   * @returns A promise that resolves with an object containing a base64 encoded string of the captured sample\n   *\n   * @since 1.0.0\n   */\n  captureSample(options: { quality: number }): Promise<CaptureResponse>;\n\n  /**\n   * Switch between front and back camera.\n   *\n   * @returns A promise that resolves when the camera has been flipped\n   *\n   * @since 1.0.0\n   */\n  flipCamera(): Promise<void>;\n\n  /**\n   * Get available camera devices for capturing photos.\n   *\n   * @returns A promise that resolves with an object containing an array of available capture devices\n   *\n   * @since 1.0.0\n   */\n  getAvailableDevices(): Promise<GetAvailableDevicesResponse>;\n\n  /**\n   * Get current zoom level information and available range.\n   *\n   * @remarks\n   * Make sure the camera is properly initialized before calling this method. Otherwise, this might\n   * lead to returning default values on android.\n   *\n   * @returns A promise that resolves with an object containing min, max and current zoom levels\n   *\n   * @since 1.0.0\n   */\n  getZoom(): Promise<GetZoomResponse>;\n\n  /**\n   * Set the camera zoom level.\n   *\n   * @param options - Zoom configuration options\n   * @param options.level - The zoom level to set\n   * @param options.ramp - Whether to animate the zoom level change, defaults to false (iOS only)\n   * @returns A promise that resolves when the zoom level has been set\n   *\n   * @remarks\n   * On web platforms, zoom functionality may be limited by browser support.\n   * When native zoom is not available, a CSS-based zoom simulation is applied.\n   *\n   * @since 1.0.0\n   */\n  setZoom(options: { level: number; ramp?: boolean }): Promise<void>;\n\n  /**\n   * Get current flash mode setting.\n   *\n   * @returns A promise that resolves with an object containing the current flash mode\n   *\n   * @since 1.0.0\n   */\n  getFlashMode(): Promise<GetFlashModeResponse>;\n\n  /**\n   * Get supported flash modes for the current camera.\n   *\n   * @returns A promise that resolves with an object containing an array of supported flash modes\n   *\n   * @since 1.0.0\n   */\n  getSupportedFlashModes(): Promise<GetSupportedFlashModesResponse>;\n\n  /**\n   * Set the camera flash mode.\n   *\n   * @param options - Flash mode configuration options\n   * @param options.mode - The flash mode to set\n   * @returns A promise that resolves when the flash mode has been set\n   *\n   * @since 1.0.0\n   */\n  setFlashMode(options: { mode: FlashMode }): Promise<void>;\n\n  /**\n   * Check camera permission status without requesting permissions.\n   *\n   * @returns A promise that resolves with an object containing the camera permission status\n   *\n   * @since 1.0.0\n   */\n  checkPermissions(): Promise<PermissionStatus>;\n\n  /**\n   * Request camera permission from the user.\n   *\n   * @returns A promise that resolves with an object containing the camera permission status\n   *\n   * @since 1.0.0\n   */\n  requestPermissions(): Promise<PermissionStatus>;\n\n  /**\n   * Listen for barcode detection events.\n   * This event is emitted when a barcode is detected in the camera preview.\n   *\n   * @param eventName - The name of the event to listen for ('barcodeDetected')\n   * @param listenerFunc - The callback function to execute when a barcode is detected\n   * @returns A promise that resolves with an event subscription\n   *\n   * @since 1.0.0\n   */\n  addListener(\n    eventName: 'barcodeDetected',\n    listenerFunc: (data: BarcodeDetectionData) => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * Remove all listeners for this plugin.\n   *\n   * @param eventName - Optional event name to remove listeners for\n   * @returns A promise that resolves when the listeners are removed\n   *\n   * @since 1.0.0\n   */\n  removeAllListeners(eventName?: string): Promise<void>;\n}\n\n// ------------------------------------------------------------------------------\n// Camera Configuration Types\n// ------------------------------------------------------------------------------\n\n/**\n * Position options for the camera.\n * - 'front': Front-facing camera\n * - 'back': Rear-facing camera\n *\n * @since 1.0.0\n */\nexport type CameraPosition = 'front' | 'back';\n\n/**\n * Flash mode options for the camera.\n * - 'off': Flash disabled\n * - 'on': Flash always on\n * - 'auto': Flash automatically enabled in low-light conditions\n *\n * @since 1.0.0\n */\nexport type FlashMode = 'off' | 'on' | 'auto';\n\n/**\n * Represents a physical camera device on the device.\n *\n * @since 1.0.0\n */\nexport interface CameraDevice {\n  /** The unique identifier of the camera device */\n  id: string;\n\n  /** The human-readable name of the camera device */\n  name: string;\n\n  /** The position of the camera device (front or back) */\n  position: CameraPosition;\n\n  /** The type of the camera device (e.g., wide, ultra-wide, telephoto) - iOS only */\n  deviceType?: CameraDeviceType;\n}\n\n/**\n * Available camera device types for iOS.\n * Maps to AVCaptureDevice DeviceTypes in iOS.\n *\n * @see https://developer.apple.com/documentation/avfoundation/avcapturedevice/devicetype-swift.struct\n *\n * @since 1.0.0\n */\nexport type CameraDeviceType =\n  /** builtInWideAngleCamera - standard camera */\n  | 'wideAngle'\n  /** builtInUltraWideCamera - 0.5x zoom level */\n  | 'ultraWide'\n  /** builtInTelephotoCamera - 2x/3x zoom level */\n  | 'telephoto'\n  /** builtInDualCamera - wide + telephoto combination */\n  | 'dual'\n  /** builtInDualWideCamera - wide + ultraWide combination */\n  | 'dualWide'\n  /** builtInTripleCamera - wide + ultraWide + telephoto */\n  | 'triple'\n  /** builtInTrueDepthCamera - front-facing camera with depth sensing */\n  | 'trueDepth';\n\n/**\n * Configuration options for starting a camera session.\n *\n * @since 1.0.0\n */\nexport interface CameraSessionConfiguration {\n  /**\n   * Enables the barcode detection functionality\n   * @default false\n   */\n  enableBarcodeDetection?: boolean;\n\n  /**\n   * Position of the camera to use\n   * @default 'back'\n   */\n  position?: CameraPosition;\n\n  /**\n   * Specific device ID of the camera to use\n   * If provided, takes precedence over position\n   */\n  deviceId?: string;\n\n  /**\n   * Whether to use the triple camera if available (iPhone Pro models only)\n   * @default false\n   */\n  useTripleCameraIfAvailable?: boolean;\n\n  /**\n   * Ordered list of preferred camera device types to use (iOS only).\n   * The system will attempt to use the first available camera type in the list.\n   * If position is also provided, the system will use the first available camera type\n   * that matches the position and is in the list.\n   *\n   * This will fallback to the default camera type if none of the preferred types are available.\n   *\n   * @example [CameraDeviceType.WideAngle, CameraDeviceType.UltraWide, CameraDeviceType.Telephoto]\n   * @default undefined - system will decide based on position/deviceId\n   */\n  preferredCameraDeviceTypes?: CameraDeviceType[];\n\n  /**\n   * The initial zoom factor to use\n   * @default 1.0\n   */\n  zoomFactor?: number;\n\n  /**\n   * Optional HTML ID of the container element where the camera view should be rendered.\n   * If not provided, the camera view will be appended to the document body. Web only.\n   * @example 'cameraContainer'\n   */\n  containerElementId?: string;\n}\n\n// ------------------------------------------------------------------------------\n// Response Interfaces\n// ------------------------------------------------------------------------------\n\n/**\n * Response for checking if the camera view is running.\n *\n * @since 1.0.0\n */\nexport interface IsRunningResponse {\n  /** Indicates if the camera view is currently active and running */\n  isRunning: boolean;\n}\n\n/**\n * Response for capturing a photo.\n *\n * @since 1.0.0\n */\nexport interface CaptureResponse {\n  /** The base64 encoded string of the captured photo */\n  photo: string;\n}\n\n/**\n * Response for getting available camera devices.\n *\n * @since 1.0.0\n */\nexport interface GetAvailableDevicesResponse {\n  /** An array of available camera devices */\n  devices: CameraDevice[];\n}\n\n/**\n * Response for getting zoom level information.\n *\n * @since 1.0.0\n */\nexport interface GetZoomResponse {\n  /** The minimum zoom level supported */\n  min: number;\n\n  /** The maximum zoom level supported */\n  max: number;\n\n  /** The current zoom level */\n  current: number;\n}\n\n/**\n * Response for getting the current flash mode.\n *\n * @since 1.0.0\n */\nexport interface GetFlashModeResponse {\n  /** The current flash mode setting */\n  flashMode: FlashMode;\n}\n\n/**\n * Response for getting supported flash modes.\n *\n * @since 1.0.0\n */\nexport interface GetSupportedFlashModesResponse {\n  /** An array of flash modes supported by the current camera */\n  flashModes: FlashMode[];\n}\n\n/**\n * Data for a detected barcode.\n *\n * @since 1.0.0\n */\nexport interface BarcodeDetectionData {\n  /** The decoded string value of the barcode */\n  value: string;\n\n  /** The display value of the barcode (may differ from the raw value) */\n  displayValue?: string;\n\n  /** The type/format of the barcode (e.g., 'qr', 'code128', etc.) */\n  type: string;\n\n  /** The bounding rectangle of the barcode in the camera frame. */\n  boundingRect: BoundingRect;\n}\n\n/**\n * Rectangle defining the boundary of the barcode in the camera frame.\n * Coordinates are normalized between 0 and 1 relative to the camera frame.\n *\n * @since 1.0.0\n */\nexport interface BoundingRect {\n  /** X-coordinate of the top-left corner */\n  x: number;\n  /** Y-coordinate of the top-left corner */\n  y: number;\n  /** Width of the bounding rectangle (should match the actual width of the barcode) */\n  width: number;\n  /** Height of the bounding rectangle (should match the actual height of the barcode) */\n  height: number;\n}\n\n/**\n * Response for the camera permission status.\n *\n * @since 1.0.0\n */\nexport interface PermissionStatus {\n  /** The state of the camera permission */\n  camera: PermissionState;\n}\n"]}

package/dist/esm/index.d.ts

@@ -0,0 +1,7 @@
+import type { CameraViewPlugin } from './definitions';
+/**
+ * The main Capacitor Camera View plugin instance.
+ */
+declare const CameraView: CameraViewPlugin;
+export * from './definitions';
+export { CameraView };

package/dist/esm/index.js

@@ -0,0 +1,10 @@
+import { registerPlugin } from '@capacitor/core';
+/**
+ * The main Capacitor Camera View plugin instance.
+ */
+const CameraView = registerPlugin('CameraView', {
+    web: () => import('./web').then((m) => new m.CameraViewWeb()),
+});
+export * from './definitions';
+export { CameraView };
+//# 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;AAIjD;;GAEG;AACH,MAAM,UAAU,GAAG,cAAc,CAAmB,YAAY,EAAE;IAChE,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,CAAC;CAC9D,CAAC,CAAC;AAEH,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,UAAU,EAAE,CAAC","sourcesContent":["import { registerPlugin } from '@capacitor/core';\n\nimport type { CameraViewPlugin } from './definitions';\n\n/**\n * The main Capacitor Camera View plugin instance.\n */\nconst CameraView = registerPlugin<CameraViewPlugin>('CameraView', {\n  web: () => import('./web').then((m) => new m.CameraViewWeb()),\n});\n\nexport * from './definitions';\nexport { CameraView };\n"]}

package/dist/esm/utils.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Converts canvas to base64 string
+ */
+export declare function canvasToBase64(canvas: HTMLCanvasElement, quality: number): string;
+/**
+ * Calculates the visible area of the video based on object-fit: cover
+ */
+export declare function calculateVisibleArea(video: HTMLVideoElement): {
+    sourceX: number;
+    sourceY: number;
+    sourceWidth: number;
+    sourceHeight: number;
+    displayWidth: number;
+    displayHeight: number;
+};
+/**
+ * Draws the visible area of the video to the canvas
+ */
+export declare function drawVisibleAreaToCanvas(canvas: HTMLCanvasElement, videoElement: HTMLVideoElement, area: {
+    sourceX: number;
+    sourceY: number;
+    sourceWidth: number;
+    sourceHeight: number;
+    displayWidth: number;
+    displayHeight: number;
+}): void;
+/**
+ * Transforms barcode coordinates from the video source space to display space
+ * accounting for object-fit: cover scaling and cropping.
+ *
+ * @param barcodeBoundingBox The original barcode bounding box from the detector
+ * @param videoElement The video element with the camera stream
+ * @returns The transformed bounding box coordinates in display space
+ */
+export declare function transformBarcodeBoundingBox(barcodeBoundingBox: {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}, videoElement: HTMLVideoElement): {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+};

package/dist/esm/utils.js

@@ -0,0 +1,108 @@
+/**
+ * Converts canvas to base64 string
+ */
+export function canvasToBase64(canvas, quality) {
+    const dataUrl = canvas.toDataURL('image/jpeg', quality);
+    return dataUrl.split(',')[1];
+}
+/**
+ * Calculates the visible area of the video based on object-fit: cover
+ */
+export function calculateVisibleArea(video) {
+    // Get the displayed dimensions of the video element
+    const videoRect = video.getBoundingClientRect();
+    const displayWidth = videoRect.width;
+    const displayHeight = videoRect.height;
+    // Get the intrinsic dimensions of the video
+    const videoWidth = video.videoWidth;
+    const videoHeight = video.videoHeight;
+    // Calculate which portion of the video is visible (for object-fit: cover)
+    const videoAspect = videoWidth / videoHeight;
+    const displayAspect = displayWidth / displayHeight;
+    let sourceX = 0;
+    let sourceY = 0;
+    let sourceWidth = videoWidth;
+    let sourceHeight = videoHeight;
+    // If video aspect ratio is greater than display aspect ratio,
+    // the video is cropped on the sides
+    if (videoAspect > displayAspect) {
+        sourceWidth = videoHeight * displayAspect;
+        sourceX = (videoWidth - sourceWidth) / 2;
+    }
+    // Otherwise the video is cropped on the top and bottom
+    else {
+        sourceHeight = videoWidth / displayAspect;
+        sourceY = (videoHeight - sourceHeight) / 2;
+    }
+    return {
+        sourceX,
+        sourceY,
+        sourceWidth,
+        sourceHeight,
+        displayWidth,
+        displayHeight,
+    };
+}
+/**
+ * Draws the visible area of the video to the canvas
+ */
+export function drawVisibleAreaToCanvas(canvas, videoElement, area) {
+    const { sourceX, sourceY, sourceWidth, sourceHeight, displayWidth, displayHeight } = area;
+    // Set canvas size to match the displayed dimensions
+    canvas.width = displayWidth;
+    canvas.height = displayHeight;
+    const ctx = canvas.getContext('2d', { alpha: false });
+    if (!ctx) {
+        throw new Error('Could not get canvas context');
+    }
+    // Draw only the visible portion of the video to match what the user sees
+    ctx.drawImage(videoElement, sourceX, sourceY, sourceWidth, sourceHeight, 0, 0, displayWidth, displayHeight);
+}
+/**
+ * Transforms barcode coordinates from the video source space to display space
+ * accounting for object-fit: cover scaling and cropping.
+ *
+ * @param barcodeBoundingBox The original barcode bounding box from the detector
+ * @param videoElement The video element with the camera stream
+ * @returns The transformed bounding box coordinates in display space
+ */
+export function transformBarcodeBoundingBox(barcodeBoundingBox, videoElement) {
+    // Get the video element's displayed dimensions
+    const videoRect = videoElement.getBoundingClientRect();
+    const displayWidth = videoRect.width;
+    const displayHeight = videoRect.height;
+    // Get original video dimensions
+    const videoWidth = videoElement.videoWidth;
+    const videoHeight = videoElement.videoHeight;
+    // Calculate scaling and positioning for object-fit: cover
+    const videoAspect = videoWidth / videoHeight;
+    const displayAspect = displayWidth / displayHeight;
+    let scaledX, scaledY, scaledWidth, scaledHeight;
+    if (videoAspect > displayAspect) {
+        // Video is wider than display area - height matches, width is centered and cropped
+        const scale = displayHeight / videoHeight;
+        const scaledVideoWidth = videoWidth * scale;
+        const cropX = (scaledVideoWidth - displayWidth) / 2;
+        scaledWidth = barcodeBoundingBox.width * scale;
+        scaledHeight = barcodeBoundingBox.height * scale;
+        scaledX = barcodeBoundingBox.x * scale - cropX;
+        scaledY = barcodeBoundingBox.y * scale;
+    }
+    else {
+        // Video is taller than display area - width matches, height is centered and cropped
+        const scale = displayWidth / videoWidth;
+        const scaledVideoHeight = videoHeight * scale;
+        const cropY = (scaledVideoHeight - displayHeight) / 2;
+        scaledWidth = barcodeBoundingBox.width * scale;
+        scaledHeight = barcodeBoundingBox.height * scale;
+        scaledX = barcodeBoundingBox.x * scale;
+        scaledY = barcodeBoundingBox.y * scale - cropY;
+    }
+    return {
+        x: scaledX,
+        y: scaledY,
+        width: scaledWidth,
+        height: scaledHeight,
+    };
+}
+//# 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;;GAEG;AACH,MAAM,UAAU,cAAc,CAAC,MAAyB,EAAE,OAAe;IACvE,MAAM,OAAO,GAAG,MAAM,CAAC,SAAS,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;IACxD,OAAO,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;AAC/B,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,oBAAoB,CAAC,KAAuB;IAQ1D,oDAAoD;IACpD,MAAM,SAAS,GAAG,KAAK,CAAC,qBAAqB,EAAE,CAAC;IAChD,MAAM,YAAY,GAAG,SAAS,CAAC,KAAK,CAAC;IACrC,MAAM,aAAa,GAAG,SAAS,CAAC,MAAM,CAAC;IAEvC,4CAA4C;IAC5C,MAAM,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC;IACpC,MAAM,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;IAEtC,0EAA0E;IAC1E,MAAM,WAAW,GAAG,UAAU,GAAG,WAAW,CAAC;IAC7C,MAAM,aAAa,GAAG,YAAY,GAAG,aAAa,CAAC;IAEnD,IAAI,OAAO,GAAG,CAAC,CAAC;IAChB,IAAI,OAAO,GAAG,CAAC,CAAC;IAChB,IAAI,WAAW,GAAG,UAAU,CAAC;IAC7B,IAAI,YAAY,GAAG,WAAW,CAAC;IAE/B,8DAA8D;IAC9D,oCAAoC;IACpC,IAAI,WAAW,GAAG,aAAa,EAAE;QAC/B,WAAW,GAAG,WAAW,GAAG,aAAa,CAAC;QAC1C,OAAO,GAAG,CAAC,UAAU,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;KAC1C;IACD,uDAAuD;SAClD;QACH,YAAY,GAAG,UAAU,GAAG,aAAa,CAAC;QAC1C,OAAO,GAAG,CAAC,WAAW,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC;KAC5C;IAED,OAAO;QACL,OAAO;QACP,OAAO;QACP,WAAW;QACX,YAAY;QACZ,YAAY;QACZ,aAAa;KACd,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,uBAAuB,CACrC,MAAyB,EACzB,YAA8B,EAC9B,IAOC;IAED,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,YAAY,EAAE,aAAa,EAAE,GAAG,IAAI,CAAC;IAE1F,oDAAoD;IACpD,MAAM,CAAC,KAAK,GAAG,YAAY,CAAC;IAC5B,MAAM,CAAC,MAAM,GAAG,aAAa,CAAC;IAE9B,MAAM,GAAG,GAAG,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;IACtD,IAAI,CAAC,GAAG,EAAE;QACR,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;KACjD;IAED,yEAAyE;IACzE,GAAG,CAAC,SAAS,CAAC,YAAY,EAAE,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,CAAC,EAAE,CAAC,EAAE,YAAY,EAAE,aAAa,CAAC,CAAC;AAC9G,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,2BAA2B,CACzC,kBAKC,EACD,YAA8B;IAO9B,+CAA+C;IAC/C,MAAM,SAAS,GAAG,YAAY,CAAC,qBAAqB,EAAE,CAAC;IACvD,MAAM,YAAY,GAAG,SAAS,CAAC,KAAK,CAAC;IACrC,MAAM,aAAa,GAAG,SAAS,CAAC,MAAM,CAAC;IAEvC,gCAAgC;IAChC,MAAM,UAAU,GAAG,YAAY,CAAC,UAAU,CAAC;IAC3C,MAAM,WAAW,GAAG,YAAY,CAAC,WAAW,CAAC;IAE7C,0DAA0D;IAC1D,MAAM,WAAW,GAAG,UAAU,GAAG,WAAW,CAAC;IAC7C,MAAM,aAAa,GAAG,YAAY,GAAG,aAAa,CAAC;IAEnD,IAAI,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,YAAY,CAAC;IAEhD,IAAI,WAAW,GAAG,aAAa,EAAE;QAC/B,mFAAmF;QACnF,MAAM,KAAK,GAAG,aAAa,GAAG,WAAW,CAAC;QAC1C,MAAM,gBAAgB,GAAG,UAAU,GAAG,KAAK,CAAC;QAC5C,MAAM,KAAK,GAAG,CAAC,gBAAgB,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC;QAEpD,WAAW,GAAG,kBAAkB,CAAC,KAAK,GAAG,KAAK,CAAC;QAC/C,YAAY,GAAG,kBAAkB,CAAC,MAAM,GAAG,KAAK,CAAC;QACjD,OAAO,GAAG,kBAAkB,CAAC,CAAC,GAAG,KAAK,GAAG,KAAK,CAAC;QAC/C,OAAO,GAAG,kBAAkB,CAAC,CAAC,GAAG,KAAK,CAAC;KACxC;SAAM;QACL,oFAAoF;QACpF,MAAM,KAAK,GAAG,YAAY,GAAG,UAAU,CAAC;QACxC,MAAM,iBAAiB,GAAG,WAAW,GAAG,KAAK,CAAC;QAC9C,MAAM,KAAK,GAAG,CAAC,iBAAiB,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC;QAEtD,WAAW,GAAG,kBAAkB,CAAC,KAAK,GAAG,KAAK,CAAC;QAC/C,YAAY,GAAG,kBAAkB,CAAC,MAAM,GAAG,KAAK,CAAC;QACjD,OAAO,GAAG,kBAAkB,CAAC,CAAC,GAAG,KAAK,CAAC;QACvC,OAAO,GAAG,kBAAkB,CAAC,CAAC,GAAG,KAAK,GAAG,KAAK,CAAC;KAChD;IAED,OAAO;QACL,CAAC,EAAE,OAAO;QACV,CAAC,EAAE,OAAO;QACV,KAAK,EAAE,WAAW;QAClB,MAAM,EAAE,YAAY;KACrB,CAAC;AACJ,CAAC","sourcesContent":["/**\n * Converts canvas to base64 string\n */\nexport function canvasToBase64(canvas: HTMLCanvasElement, quality: number): string {\n  const dataUrl = canvas.toDataURL('image/jpeg', quality);\n  return dataUrl.split(',')[1];\n}\n\n/**\n * Calculates the visible area of the video based on object-fit: cover\n */\nexport function calculateVisibleArea(video: HTMLVideoElement): {\n  sourceX: number;\n  sourceY: number;\n  sourceWidth: number;\n  sourceHeight: number;\n  displayWidth: number;\n  displayHeight: number;\n} {\n  // Get the displayed dimensions of the video element\n  const videoRect = video.getBoundingClientRect();\n  const displayWidth = videoRect.width;\n  const displayHeight = videoRect.height;\n\n  // Get the intrinsic dimensions of the video\n  const videoWidth = video.videoWidth;\n  const videoHeight = video.videoHeight;\n\n  // Calculate which portion of the video is visible (for object-fit: cover)\n  const videoAspect = videoWidth / videoHeight;\n  const displayAspect = displayWidth / displayHeight;\n\n  let sourceX = 0;\n  let sourceY = 0;\n  let sourceWidth = videoWidth;\n  let sourceHeight = videoHeight;\n\n  // If video aspect ratio is greater than display aspect ratio,\n  // the video is cropped on the sides\n  if (videoAspect > displayAspect) {\n    sourceWidth = videoHeight * displayAspect;\n    sourceX = (videoWidth - sourceWidth) / 2;\n  }\n  // Otherwise the video is cropped on the top and bottom\n  else {\n    sourceHeight = videoWidth / displayAspect;\n    sourceY = (videoHeight - sourceHeight) / 2;\n  }\n\n  return {\n    sourceX,\n    sourceY,\n    sourceWidth,\n    sourceHeight,\n    displayWidth,\n    displayHeight,\n  };\n}\n\n/**\n * Draws the visible area of the video to the canvas\n */\nexport function drawVisibleAreaToCanvas(\n  canvas: HTMLCanvasElement,\n  videoElement: HTMLVideoElement,\n  area: {\n    sourceX: number;\n    sourceY: number;\n    sourceWidth: number;\n    sourceHeight: number;\n    displayWidth: number;\n    displayHeight: number;\n  },\n): void {\n  const { sourceX, sourceY, sourceWidth, sourceHeight, displayWidth, displayHeight } = area;\n\n  // Set canvas size to match the displayed dimensions\n  canvas.width = displayWidth;\n  canvas.height = displayHeight;\n\n  const ctx = canvas.getContext('2d', { alpha: false });\n  if (!ctx) {\n    throw new Error('Could not get canvas context');\n  }\n\n  // Draw only the visible portion of the video to match what the user sees\n  ctx.drawImage(videoElement, sourceX, sourceY, sourceWidth, sourceHeight, 0, 0, displayWidth, displayHeight);\n}\n\n/**\n * Transforms barcode coordinates from the video source space to display space\n * accounting for object-fit: cover scaling and cropping.\n *\n * @param barcodeBoundingBox The original barcode bounding box from the detector\n * @param videoElement The video element with the camera stream\n * @returns The transformed bounding box coordinates in display space\n */\nexport function transformBarcodeBoundingBox(\n  barcodeBoundingBox: {\n    x: number;\n    y: number;\n    width: number;\n    height: number;\n  },\n  videoElement: HTMLVideoElement,\n): {\n  x: number;\n  y: number;\n  width: number;\n  height: number;\n} {\n  // Get the video element's displayed dimensions\n  const videoRect = videoElement.getBoundingClientRect();\n  const displayWidth = videoRect.width;\n  const displayHeight = videoRect.height;\n\n  // Get original video dimensions\n  const videoWidth = videoElement.videoWidth;\n  const videoHeight = videoElement.videoHeight;\n\n  // Calculate scaling and positioning for object-fit: cover\n  const videoAspect = videoWidth / videoHeight;\n  const displayAspect = displayWidth / displayHeight;\n\n  let scaledX, scaledY, scaledWidth, scaledHeight;\n\n  if (videoAspect > displayAspect) {\n    // Video is wider than display area - height matches, width is centered and cropped\n    const scale = displayHeight / videoHeight;\n    const scaledVideoWidth = videoWidth * scale;\n    const cropX = (scaledVideoWidth - displayWidth) / 2;\n\n    scaledWidth = barcodeBoundingBox.width * scale;\n    scaledHeight = barcodeBoundingBox.height * scale;\n    scaledX = barcodeBoundingBox.x * scale - cropX;\n    scaledY = barcodeBoundingBox.y * scale;\n  } else {\n    // Video is taller than display area - width matches, height is centered and cropped\n    const scale = displayWidth / videoWidth;\n    const scaledVideoHeight = videoHeight * scale;\n    const cropY = (scaledVideoHeight - displayHeight) / 2;\n\n    scaledWidth = barcodeBoundingBox.width * scale;\n    scaledHeight = barcodeBoundingBox.height * scale;\n    scaledX = barcodeBoundingBox.x * scale;\n    scaledY = barcodeBoundingBox.y * scale - cropY;\n  }\n\n  return {\n    x: scaledX,\n    y: scaledY,\n    width: scaledWidth,\n    height: scaledHeight,\n  };\n}\n"]}