@capgo/camera-preview 7.4.0-alpha.13 → 7.4.0-alpha.18

package/dist/docs.json

@@ -161,7 +161,11 @@
           },
           {
             "name": "since",
-            "text": "7.4.0"
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
           }
         ],
         "docs": "Set the aspect ratio of the camera preview.",
@@ -180,7 +184,11 @@
           },
           {
             "name": "since",
-            "text": "7.4.0"
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
           }
         ],
         "docs": "Gets the current aspect ratio of the camera preview.",
@@ -422,7 +430,11 @@
           },
           {
             "name": "since",
-            "text": "7.4.0"
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
           }
         ],
         "docs": "Checks if the camera preview is currently running.",
@@ -441,7 +453,11 @@
           },
           {
             "name": "since",
-            "text": "7.4.0"
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
           }
         ],
         "docs": "Gets all available camera devices.",
@@ -462,7 +478,11 @@
           },
           {
             "name": "since",
-            "text": "7.4.0"
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
           }
         ],
         "docs": "Gets the current zoom state, including min/max and current lens info.",
@@ -476,7 +496,16 @@
         "signature": "() => Promise<{ values: number[]; }>",
         "parameters": [],
         "returns": "Promise<{ values: number[]; }>",
-        "tags": [],
+        "tags": [
+          {
+            "name": "since",
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
+          }
+        ],
         "docs": "Returns zoom button values for quick switching.\n- iOS/Android: includes 0.5 if ultra-wide available; 1 and 2 if wide available; 3 if telephoto available\n- Web: unsupported",
         "complexTypes": [],
         "slug": "getzoombuttonvalues"
@@ -503,7 +532,11 @@
           },
           {
             "name": "since",
-            "text": "7.4.0"
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
           }
         ],
         "docs": "Sets the zoom level of the camera.",
@@ -522,7 +555,11 @@
           },
           {
             "name": "since",
-            "text": "7.4.0"
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
           }
         ],
         "docs": "Gets the current flash mode.",
@@ -539,7 +576,11 @@
         "tags": [
           {
             "name": "since",
-            "text": "7.4.0"
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
           }
         ],
         "docs": "Removes all registered listeners.",
@@ -568,7 +609,11 @@
           },
           {
             "name": "since",
-            "text": "7.4.0"
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
           }
         ],
         "docs": "Switches the active camera to the one with the specified `deviceId`.",
@@ -587,7 +632,11 @@
           },
           {
             "name": "since",
-            "text": "7.4.0"
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
           }
         ],
         "docs": "Gets the ID of the currently active camera device.",
@@ -602,6 +651,14 @@
         "tags": [
           {
             "name": "returns"
+          },
+          {
+            "name": "since",
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
           }
         ],
         "docs": "Gets the current preview size and position.",
@@ -627,6 +684,14 @@
           {
             "name": "returns",
             "text": "A promise that resolves with the actual preview dimensions and position."
+          },
+          {
+            "name": "since",
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
           }
         ],
         "docs": "Sets the preview size and position.",
@@ -655,7 +720,11 @@
           },
           {
             "name": "since",
-            "text": "8.1.0"
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
           }
         ],
         "docs": "Sets the camera focus to a specific point in the preview.",
@@ -668,22 +737,151 @@
         "parameters": [
           {
             "name": "eventName",
-            "docs": "",
+            "docs": "- The event name to listen for.",
             "type": "'screenResize'"
           },
           {
             "name": "listenerFunc",
-            "docs": "",
+            "docs": "- The function to call when the event is triggered.",
             "type": "(data: { width: number; height: number; x: number; y: number; }) => void"
           }
         ],
         "returns": "Promise<PluginListenerHandle>",
-        "tags": [],
-        "docs": "",
+        "tags": [
+          {
+            "name": "param",
+            "text": "eventName - The event name to listen for."
+          },
+          {
+            "name": "param",
+            "text": "listenerFunc - The function to call when the event is triggered."
+          },
+          {
+            "name": "returns",
+            "text": "A promise that resolves with a handle to the listener."
+          },
+          {
+            "name": "since",
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
+          }
+        ],
+        "docs": "Adds a listener for screen resize events.",
         "complexTypes": [
           "PluginListenerHandle"
         ],
         "slug": "addlistenerscreenresize-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: \"orientationChange\", listenerFunc: (data: { orientation: DeviceOrientation; }) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "- The event name to listen for.",
+            "type": "'orientationChange'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "- The function to call when the event is triggered.",
+            "type": "(data: { orientation: DeviceOrientation; }) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "eventName - The event name to listen for."
+          },
+          {
+            "name": "param",
+            "text": "listenerFunc - The function to call when the event is triggered."
+          },
+          {
+            "name": "returns",
+            "text": "A promise that resolves with a handle to the listener."
+          },
+          {
+            "name": "since",
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
+          }
+        ],
+        "docs": "Adds a listener for orientation change events.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "DeviceOrientation"
+        ],
+        "slug": "addlistenerorientationchange-"
+      },
+      {
+        "name": "deleteFile",
+        "signature": "(options: { path: string; }) => Promise<{ success: boolean; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ path: string; }"
+          }
+        ],
+        "returns": "Promise<{ success: boolean; }>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
+          }
+        ],
+        "docs": "Deletes a file at the given absolute path on the device.\nUse this to quickly clean up temporary images created with `storeToFile`.\nOn web, this is not supported and will throw.",
+        "complexTypes": [],
+        "slug": "deletefile"
+      },
+      {
+        "name": "getSafeAreaInsets",
+        "signature": "() => Promise<SafeAreaInsets>",
+        "parameters": [],
+        "returns": "Promise<SafeAreaInsets>",
+        "tags": [
+          {
+            "name": "platform",
+            "text": "android"
+          }
+        ],
+        "docs": "Gets the safe area insets for Android devices.\nReturns the top and bottom insets in dp and the current orientation.",
+        "complexTypes": [
+          "SafeAreaInsets"
+        ],
+        "slug": "getsafeareainsets"
+      },
+      {
+        "name": "getOrientation",
+        "signature": "() => Promise<{ orientation: DeviceOrientation; }>",
+        "parameters": [],
+        "returns": "Promise<{ orientation: DeviceOrientation; }>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
+          }
+        ],
+        "docs": "Gets the current device orientation in a cross-platform format.",
+        "complexTypes": [
+          "DeviceOrientation"
+        ],
+        "slug": "getorientation"
       }
     ],
     "properties": []
@@ -1406,6 +1604,36 @@
           "type": "() => Promise<void>"
         }
       ]
+    },
+    {
+      "name": "SafeAreaInsets",
+      "slug": "safeareainsets",
+      "docs": "Represents safe area insets on Android.\nValues are expressed in logical pixels (dp) to match JS layout units.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "orientation",
+          "tags": [],
+          "docs": "Current device orientation as reported by Android configuration.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "top",
+          "tags": [],
+          "docs": "Top inset (e.g., status bar or cutout) in dp.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "bottom",
+          "tags": [],
+          "docs": "Bottom inset (e.g., navigation bar) in dp.",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
     }
   ],
   "enums": [
@@ -1562,6 +1790,37 @@
           ]
         }
       ]
+    },
+    {
+      "name": "DeviceOrientation",
+      "slug": "deviceorientation",
+      "docs": "Canonical device orientation values across platforms.",
+      "types": [
+        {
+          "text": "\"portrait\"",
+          "complexTypes": []
+        },
+        {
+          "text": "\"landscape\"",
+          "complexTypes": []
+        },
+        {
+          "text": "\"landscape-left\"",
+          "complexTypes": []
+        },
+        {
+          "text": "\"landscape-right\"",
+          "complexTypes": []
+        },
+        {
+          "text": "\"portrait-upside-down\"",
+          "complexTypes": []
+        },
+        {
+          "text": "\"unknown\"",
+          "complexTypes": []
+        }
+      ]
     }
   ],
   "pluginConfigs": []

package/dist/esm/definitions.d.ts

@@ -290,6 +290,22 @@ export interface CameraOpacityOptions {
      */
     opacity?: number;
 }
+/**
+ * Represents safe area insets on Android.
+ * Values are expressed in logical pixels (dp) to match JS layout units.
+ */
+export interface SafeAreaInsets {
+    /** Current device orientation as reported by Android configuration. */
+    orientation: number;
+    /** Top inset (e.g., status bar or cutout) in dp. */
+    top: number;
+    /** Bottom inset (e.g., navigation bar) in dp. */
+    bottom: number;
+}
+/**
+ * Canonical device orientation values across platforms.
+ */
+export type DeviceOrientation = "portrait" | "landscape" | "landscape-left" | "landscape-right" | "portrait-upside-down" | "unknown";
 /**
  * The main interface for the CameraPreview plugin.
  */
@@ -357,7 +373,8 @@ export interface CameraPreviewPlugin {
      *   - x: Optional x coordinate for positioning. If not provided, view will be auto-centered horizontally.
      *   - y: Optional y coordinate for positioning. If not provided, view will be auto-centered vertically.
      * @returns {Promise<{ width: number; height: number; x: number; y: number }>} A promise that resolves with the actual preview dimensions and position.
-     * @since 7.4.0
+     * @since 7.5.0
+     * @platform android, ios
      */
     setAspectRatio(options: {
         aspectRatio: "4:3" | "16:9";
@@ -373,7 +390,8 @@ export interface CameraPreviewPlugin {
      * Gets the current aspect ratio of the camera preview.
      *
      * @returns {Promise<{ aspectRatio: '4:3' | '16:9' }>} A promise that resolves with the current aspect ratio.
-     * @since 7.4.0
+     * @since 7.5.0
+     * @platform android, ios
      */
     getAspectRatio(): Promise<{
         aspectRatio: "4:3" | "16:9";
@@ -462,7 +480,8 @@ export interface CameraPreviewPlugin {
      * Checks if the camera preview is currently running.
      *
      * @returns {Promise<{ isRunning: boolean }>} A promise that resolves with the running state.
-     * @since 7.4.0
+     * @since 7.5.0
+     * @platform android, ios
      */
     isRunning(): Promise<{
         isRunning: boolean;
@@ -471,7 +490,8 @@ export interface CameraPreviewPlugin {
      * Gets all available camera devices.
      *
      * @returns {Promise<{ devices: CameraDevice[] }>} A promise that resolves with the list of available camera devices.
-     * @since 7.4.0
+     * @since 7.5.0
+     * @platform android, ios
      */
     getAvailableDevices(): Promise<{
         devices: CameraDevice[];
@@ -480,7 +500,8 @@ export interface CameraPreviewPlugin {
      * Gets the current zoom state, including min/max and current lens info.
      *
      * @returns {Promise<{ min: number; max: number; current: number; lens: LensInfo }>} A promise that resolves with the zoom state.
-     * @since 7.4.0
+     * @since 7.5.0
+     * @platform android, ios
      */
     getZoom(): Promise<{
         min: number;
@@ -492,6 +513,8 @@ export interface CameraPreviewPlugin {
      * Returns zoom button values for quick switching.
      * - iOS/Android: includes 0.5 if ultra-wide available; 1 and 2 if wide available; 3 if telephoto available
      * - Web: unsupported
+     * @since 7.5.0
+     * @platform android, ios
      */
     getZoomButtonValues(): Promise<{
         values: number[];
@@ -501,7 +524,8 @@ export interface CameraPreviewPlugin {
      *
      * @param {{ level: number; ramp?: boolean; autoFocus?: boolean }} options - The desired zoom level. `ramp` is currently unused. `autoFocus` defaults to true.
      * @returns {Promise<void>} A promise that resolves when the zoom level is set.
-     * @since 7.4.0
+     * @since 7.5.0
+     * @platform android, ios
      */
     setZoom(options: {
         level: number;
@@ -512,7 +536,8 @@ export interface CameraPreviewPlugin {
      * Gets the current flash mode.
      *
      * @returns {Promise<{ flashMode: FlashMode }>} A promise that resolves with the current flash mode.
-     * @since 7.4.0
+     * @since 7.5.0
+     * @platform android, ios
      */
     getFlashMode(): Promise<{
         flashMode: FlashMode;
@@ -520,7 +545,8 @@ export interface CameraPreviewPlugin {
     /**
      * Removes all registered listeners.
      *
-     * @since 7.4.0
+     * @since 7.5.0
+     * @platform android, ios
      */
     removeAllListeners(): Promise<void>;
     /**
@@ -528,7 +554,8 @@ export interface CameraPreviewPlugin {
      *
      * @param {{ deviceId: string }} options - The ID of the device to switch to.
      * @returns {Promise<void>} A promise that resolves when the camera is switched.
-     * @since 7.4.0
+     * @since 7.5.0
+     * @platform android, ios
      */
     setDeviceId(options: {
         deviceId: string;
@@ -537,7 +564,8 @@ export interface CameraPreviewPlugin {
      * Gets the ID of the currently active camera device.
      *
      * @returns {Promise<{ deviceId: string }>} A promise that resolves with the current device ID.
-     * @since 7.4.0
+     * @since 7.5.0
+     * @platform android, ios
      */
     getDeviceId(): Promise<{
         deviceId: string;
@@ -545,6 +573,8 @@ export interface CameraPreviewPlugin {
     /**
      * Gets the current preview size and position.
      * @returns {Promise<{x: number, y: number, width: number, height: number}>}
+     * @since 7.5.0
+     * @platform android, ios
      */
     getPreviewSize(): Promise<{
         x: number;
@@ -556,6 +586,8 @@ export interface CameraPreviewPlugin {
      * Sets the preview size and position.
      * @param options The new position and dimensions.
      * @returns {Promise<{ width: number; height: number; x: number; y: number }>} A promise that resolves with the actual preview dimensions and position.
+     * @since 7.5.0
+     * @platform android, ios
      */
     setPreviewSize(options: {
         x?: number;
@@ -575,16 +607,63 @@ export interface CameraPreviewPlugin {
      * @param {number} options.x - The x coordinate in the preview view to focus on (0-1 normalized).
      * @param {number} options.y - The y coordinate in the preview view to focus on (0-1 normalized).
      * @returns {Promise<void>} A promise that resolves when the focus is set.
-     * @since 8.1.0
+     * @since 7.5.0
+     * @platform android, ios
      */
     setFocus(options: {
         x: number;
         y: number;
     }): Promise<void>;
+    /**
+     * Adds a listener for screen resize events.
+     * @param {string} eventName - The event name to listen for.
+     * @param {Function} listenerFunc - The function to call when the event is triggered.
+     * @returns {Promise<PluginListenerHandle>} A promise that resolves with a handle to the listener.
+     * @since 7.5.0
+     * @platform android, ios
+     */
     addListener(eventName: "screenResize", listenerFunc: (data: {
         width: number;
         height: number;
         x: number;
         y: number;
     }) => void): Promise<PluginListenerHandle>;
+    /**
+     * Adds a listener for orientation change events.
+     * @param {string} eventName - The event name to listen for.
+     * @param {Function} listenerFunc - The function to call when the event is triggered.
+     * @returns {Promise<PluginListenerHandle>} A promise that resolves with a handle to the listener.
+     * @since 7.5.0
+     * @platform android, ios
+     */
+    addListener(eventName: "orientationChange", listenerFunc: (data: {
+        orientation: DeviceOrientation;
+    }) => void): Promise<PluginListenerHandle>;
+    /**
+     * Deletes a file at the given absolute path on the device.
+     * Use this to quickly clean up temporary images created with `storeToFile`.
+     * On web, this is not supported and will throw.
+     * @since 7.5.0
+     * @platform android, ios
+     */
+    deleteFile(options: {
+        path: string;
+    }): Promise<{
+        success: boolean;
+    }>;
+    /**
+     * Gets the safe area insets for Android devices.
+     * Returns the top and bottom insets in dp and the current orientation.
+     *
+     * @platform android
+     */
+    getSafeAreaInsets(): Promise<SafeAreaInsets>;
+    /**
+     * Gets the current device orientation in a cross-platform format.
+     * @since 7.5.0
+     * @platform android, ios
+     */
+    getOrientation(): Promise<{
+        orientation: DeviceOrientation;
+    }>;
 }