@capgo/camera-preview 7.1.0 → 7.2.2

package/README.md

@@ -12,9 +12,9 @@
 </p>
 <br>
 
-This plugin is compatible Capacitor 6 and above.
+This plugin is compatible Capacitor 7 and above.
 
-Use v5 for Capacitor 5 and below.
+Use v6 for Capacitor 6 and below.
 
 **PR's are greatly appreciated.**
 
@@ -69,6 +69,13 @@ If it don't work in dark mode here is issue who explain how to fix it: https://g
   <li>Tap to focus</li>
 </ul> -->
 
+## Good to know
+
+Video and photo taken with the plugin are never removed, so do not forget to remove them after used to not bloat the user phone.
+
+use https://capacitorjs.com/docs/apis/filesystem#deletefile for that
+
+
 # Installation
 
 ```
@@ -385,6 +392,7 @@ Start recording video.
 | **`height`**                       | <code>number</code>  | The preview height in pixels, default window.screen.height                                                                                                    |
 | **`x`**                            | <code>number</code>  | The x origin, default 0 (applicable to the android and ios platforms only)                                                                                    |
 | **`y`**                            | <code>number</code>  | The y origin, default 0 (applicable to the android and ios platforms only)                                                                                    |
+| **`includeSafeAreaInsets`**        | <code>boolean</code> | Whether to include safe area insets in y-position calculation, default false (applicable to the ios platform only)                                            |
 | **`toBack`**                       | <code>boolean</code> | Brings your html in front of your preview, default false (applicable to the android only)                                                                     |
 | **`paddingBottom`**                | <code>number</code>  | The preview bottom padding in pixes. Useful to keep the appropriate preview sizes when orientation changes (applicable to the android and ios platforms only) |
 | **`rotateWhenOrientationChanged`** | <code>boolean</code> | Rotate preview when orientation changes (applicable to the ios platforms only; default value is true)                                                         |

package/android/build.gradle

@@ -48,7 +48,7 @@ dependencies {
     implementation fileTree(dir: 'libs', include: ['*.jar'])
     implementation project(':capacitor-android')
     implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
-    implementation 'androidx.exifinterface:exifinterface:1.3.7'
+    implementation 'androidx.exifinterface:exifinterface:1.4.0'
     testImplementation "junit:junit:$junitVersion"
     androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"
     androidTestImplementation "androidx.test.espresso:espresso-core:$androidxEspressoCoreVersion"

package/android/gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.12.1-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.13-all.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME

package/android/gradlew

@@ -86,8 +86,7 @@ done
 # shellcheck disable=SC2034
 APP_BASE_NAME=${0##*/}
 # Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
-APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s
-' "$PWD" ) || exit
+APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit
 
 # Use the maximum available, or set MAX_FD != -1 to use that value.
 MAX_FD=maximum
@@ -206,7 +205,7 @@ fi
 DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
 
 # Collect all arguments for the java command:
-#   * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
+#   * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
 #     and any embedded shellness will be escaped.
 #   * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
 #     treated as '${Hostname}' itself on the command line.

package/dist/docs.json

@@ -408,6 +408,13 @@
           "complexTypes": [],
           "type": "number | undefined"
         },
+        {
+          "name": "includeSafeAreaInsets",
+          "tags": [],
+          "docs": "Whether to include safe area insets in y-position calculation, default false (applicable to the ios platform only)",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
         {
           "name": "toBack",
           "tags": [],

package/dist/esm/definitions.d.ts

@@ -12,6 +12,8 @@ export interface CameraPreviewOptions {
     x?: number;
     /** The y origin, default 0 (applicable to the android and ios platforms only) */
     y?: number;
+    /** Whether to include safe area insets in y-position calculation, default false (applicable to the ios platform only) */
+    includeSafeAreaInsets?: boolean;
     /**  Brings your html in front of your preview, default false (applicable to the android only) */
     toBack?: boolean;
     /** The preview bottom padding in pixes. Useful to keep the appropriate preview sizes when orientation changes (applicable to the android and ios platforms only) */

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["export type CameraPosition = \"rear\" | \"front\";\nexport interface CameraPreviewOptions {\n  /** Parent element to attach the video preview element to (applicable to the web platform only) */\n  parent?: string;\n  /** Class name to add to the video preview element (applicable to the web platform only) */\n  className?: string;\n  /** The preview width in pixels, default window.screen.width */\n  width?: number;\n  /** The preview height in pixels, default window.screen.height */\n  height?: number;\n  /** The x origin, default 0 (applicable to the android and ios platforms only) */\n  x?: number;\n  /** The y origin, default 0 (applicable to the android and ios platforms only) */\n  y?: number;\n  /**  Brings your html in front of your preview, default false (applicable to the android only) */\n  toBack?: boolean;\n  /** The preview bottom padding in pixes. Useful to keep the appropriate preview sizes when orientation changes (applicable to the android and ios platforms only) */\n  paddingBottom?: number;\n  /** Rotate preview when orientation changes (applicable to the ios platforms only; default value is true) */\n  rotateWhenOrientationChanged?: boolean;\n  /** Choose the camera to use 'front' or 'rear', default 'front' */\n  position?: CameraPosition | string;\n  /** Defaults to false - Capture images to a file and return the file path instead of returning base64 encoded data */\n  storeToFile?: boolean;\n  /** Defaults to false - Android Only - Disable automatic rotation of the image, and let the browser deal with it (keep reading on how to achieve it) */\n  disableExifHeaderStripping?: boolean;\n  /** Defaults to false - iOS only - Activate high resolution image capture so that output images are from the highest resolution possible on the device **/\n  enableHighResolution?: boolean;\n  /** Defaults to false - Disables audio stream to prevent permission requests and output switching */\n  disableAudio?: boolean;\n  /**  Android Only - Locks device orientation when camera is showing. */\n  lockAndroidOrientation?: boolean;\n  /** Defaults to false - Android and Web only.  Set if camera preview can change opacity. */\n  enableOpacity?: boolean;\n  /** Defaults to false - Android only.  Set if camera preview will support pinch to zoom. */\n  enableZoom?: boolean;\n  /** default to false - IOS only. Set the CameraPreview to use the video mode preset */\n  cameraMode?: boolean;\n}\n\nexport interface CameraPreviewPictureOptions {\n  /** The picture height, optional, default 0 (Device default) */\n  height?: number;\n  /** The picture width, optional, default 0 (Device default) */\n  width?: number;\n  /** The picture quality, 0 - 100, default 85 */\n  quality?: number;\n  /** The picture format, jpeg or png, default jpeg on `Web`.\n   *\n   * quality has no effect on png */\n  format?: PictureFormat;\n}\n\nexport type PictureFormat = \"jpeg\" | \"png\";\n\nexport interface CameraSampleOptions {\n  /** The picture quality, 0 - 100, default 85 */\n  quality?: number;\n}\n\nexport type CameraPreviewFlashMode =\n  | \"off\"\n  | \"on\"\n  | \"auto\"\n  | \"red-eye\"\n  | \"torch\";\n\nexport interface CameraOpacityOptions {\n  /** The percent opacity to set for camera view, default 1 */\n  opacity?: number;\n}\n\nexport interface CameraPreviewPlugin {\n  /**\n   * Start the camera preview instance.\n   * @param {CameraPreviewOptions} options the options to start the camera preview with\n   * @returns {Promise<void>} an Promise that resolves when the instance is started\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  start(options: CameraPreviewOptions): Promise<void>;\n  /**\n   * Stop the camera preview instance.\n   * @returns {Promise<void>} an Promise that resolves when the instance is stopped\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  stop(): Promise<void>;\n  /**\n   * Switch camera.\n   * @param {CameraPreviewOptions} options the options to switch the camera with\n   * @returns {Promise<void>} an Promise that resolves when the camera is switched\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  capture(options: CameraPreviewPictureOptions): Promise<{ value: string }>;\n  /**\n   * Capture a sample image.\n   * @param {CameraSampleOptions} options the options to capture the sample image with\n   * @returns {Promise<string>} an Promise that resolves with the sample image as a base64 encoded string\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  captureSample(options: CameraSampleOptions): Promise<{ value: string }>;\n  /**\n   * Get supported flash modes.\n   * @returns {Promise<CameraPreviewFlashMode[]>} an Promise that resolves with the supported flash modes\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  getSupportedFlashModes(): Promise<{\n    result: CameraPreviewFlashMode[];\n  }>;\n  /**\n   * Get horizontal field of view.\n   * @returns {Promise<any>} an Promise that resolves with the horizontal field of view\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  getHorizontalFov(): Promise<{\n    result: any;\n  }>;\n  /**\n   * Gets the supported picture sizes for a given device.\n   * @returns {Promise<any>} an Promise that resolves with the supported picture sizes for a given device\n   * @throws An error if the something goes wrong\n   */\n  getSupportedPictureSizes(): Promise<{\n    supportedPictureSizes: {\n      facing: string;\n      supportedPictureSizes: { width: number; height: number }[];\n    }[];\n  }>;\n  /**\n   * Set flash mode.\n   * @param options the options to set the flash mode with\n   * @returns {Promise<void>} an Promise that resolves when the flash mode is set\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  setFlashMode(options: {\n    flashMode: CameraPreviewFlashMode | string;\n  }): Promise<void>;\n  /**\n   * Flip camera.\n   * @returns {Promise<void>} an Promise that resolves when the camera is flipped\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  flip(): Promise<void>;\n  /**\n   * Set opacity.\n   * @param {CameraOpacityOptions} options the options to set the camera opacity with\n   * @returns {Promise<void>} an Promise that resolves when the camera color effect is set\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  setOpacity(options: CameraOpacityOptions): Promise<void>;\n  /**\n   * Stop recording video.\n   * @param {CameraPreviewOptions} options the options to stop recording video with\n   * @returns {Promise<{videoFilePath: string}>} an Promise that resolves when the camera zoom is set\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  stopRecordVideo(): Promise<{ videoFilePath: string }>;\n  /**\n   * Start recording video.\n   * @param {CameraPreviewOptions} options the options to start recording video with\n   * @returns {Promise<void>} an Promise that resolves when the video recording is started\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  startRecordVideo(options: CameraPreviewOptions): Promise<void>;\n}\n"]}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["export type CameraPosition = \"rear\" | \"front\";\nexport interface CameraPreviewOptions {\n  /** Parent element to attach the video preview element to (applicable to the web platform only) */\n  parent?: string;\n  /** Class name to add to the video preview element (applicable to the web platform only) */\n  className?: string;\n  /** The preview width in pixels, default window.screen.width */\n  width?: number;\n  /** The preview height in pixels, default window.screen.height */\n  height?: number;\n  /** The x origin, default 0 (applicable to the android and ios platforms only) */\n  x?: number;\n  /** The y origin, default 0 (applicable to the android and ios platforms only) */\n  y?: number;\n  /** Whether to include safe area insets in y-position calculation, default false (applicable to the ios platform only) */\n  includeSafeAreaInsets?: boolean;\n  /**  Brings your html in front of your preview, default false (applicable to the android only) */\n  toBack?: boolean;\n  /** The preview bottom padding in pixes. Useful to keep the appropriate preview sizes when orientation changes (applicable to the android and ios platforms only) */\n  paddingBottom?: number;\n  /** Rotate preview when orientation changes (applicable to the ios platforms only; default value is true) */\n  rotateWhenOrientationChanged?: boolean;\n  /** Choose the camera to use 'front' or 'rear', default 'front' */\n  position?: CameraPosition | string;\n  /** Defaults to false - Capture images to a file and return the file path instead of returning base64 encoded data */\n  storeToFile?: boolean;\n  /** Defaults to false - Android Only - Disable automatic rotation of the image, and let the browser deal with it (keep reading on how to achieve it) */\n  disableExifHeaderStripping?: boolean;\n  /** Defaults to false - iOS only - Activate high resolution image capture so that output images are from the highest resolution possible on the device **/\n  enableHighResolution?: boolean;\n  /** Defaults to false - Disables audio stream to prevent permission requests and output switching */\n  disableAudio?: boolean;\n  /**  Android Only - Locks device orientation when camera is showing. */\n  lockAndroidOrientation?: boolean;\n  /** Defaults to false - Android and Web only.  Set if camera preview can change opacity. */\n  enableOpacity?: boolean;\n  /** Defaults to false - Android only.  Set if camera preview will support pinch to zoom. */\n  enableZoom?: boolean;\n  /** default to false - IOS only. Set the CameraPreview to use the video mode preset */\n  cameraMode?: boolean;\n}\n\nexport interface CameraPreviewPictureOptions {\n  /** The picture height, optional, default 0 (Device default) */\n  height?: number;\n  /** The picture width, optional, default 0 (Device default) */\n  width?: number;\n  /** The picture quality, 0 - 100, default 85 */\n  quality?: number;\n  /** The picture format, jpeg or png, default jpeg on `Web`.\n   *\n   * quality has no effect on png */\n  format?: PictureFormat;\n}\n\nexport type PictureFormat = \"jpeg\" | \"png\";\n\nexport interface CameraSampleOptions {\n  /** The picture quality, 0 - 100, default 85 */\n  quality?: number;\n}\n\nexport type CameraPreviewFlashMode =\n  | \"off\"\n  | \"on\"\n  | \"auto\"\n  | \"red-eye\"\n  | \"torch\";\n\nexport interface CameraOpacityOptions {\n  /** The percent opacity to set for camera view, default 1 */\n  opacity?: number;\n}\n\nexport interface CameraPreviewPlugin {\n  /**\n   * Start the camera preview instance.\n   * @param {CameraPreviewOptions} options the options to start the camera preview with\n   * @returns {Promise<void>} an Promise that resolves when the instance is started\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  start(options: CameraPreviewOptions): Promise<void>;\n  /**\n   * Stop the camera preview instance.\n   * @returns {Promise<void>} an Promise that resolves when the instance is stopped\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  stop(): Promise<void>;\n  /**\n   * Switch camera.\n   * @param {CameraPreviewOptions} options the options to switch the camera with\n   * @returns {Promise<void>} an Promise that resolves when the camera is switched\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  capture(options: CameraPreviewPictureOptions): Promise<{ value: string }>;\n  /**\n   * Capture a sample image.\n   * @param {CameraSampleOptions} options the options to capture the sample image with\n   * @returns {Promise<string>} an Promise that resolves with the sample image as a base64 encoded string\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  captureSample(options: CameraSampleOptions): Promise<{ value: string }>;\n  /**\n   * Get supported flash modes.\n   * @returns {Promise<CameraPreviewFlashMode[]>} an Promise that resolves with the supported flash modes\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  getSupportedFlashModes(): Promise<{\n    result: CameraPreviewFlashMode[];\n  }>;\n  /**\n   * Get horizontal field of view.\n   * @returns {Promise<any>} an Promise that resolves with the horizontal field of view\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  getHorizontalFov(): Promise<{\n    result: any;\n  }>;\n  /**\n   * Gets the supported picture sizes for a given device.\n   * @returns {Promise<any>} an Promise that resolves with the supported picture sizes for a given device\n   * @throws An error if the something goes wrong\n   */\n  getSupportedPictureSizes(): Promise<{\n    supportedPictureSizes: {\n      facing: string;\n      supportedPictureSizes: { width: number; height: number }[];\n    }[];\n  }>;\n  /**\n   * Set flash mode.\n   * @param options the options to set the flash mode with\n   * @returns {Promise<void>} an Promise that resolves when the flash mode is set\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  setFlashMode(options: {\n    flashMode: CameraPreviewFlashMode | string;\n  }): Promise<void>;\n  /**\n   * Flip camera.\n   * @returns {Promise<void>} an Promise that resolves when the camera is flipped\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  flip(): Promise<void>;\n  /**\n   * Set opacity.\n   * @param {CameraOpacityOptions} options the options to set the camera opacity with\n   * @returns {Promise<void>} an Promise that resolves when the camera color effect is set\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  setOpacity(options: CameraOpacityOptions): Promise<void>;\n  /**\n   * Stop recording video.\n   * @param {CameraPreviewOptions} options the options to stop recording video with\n   * @returns {Promise<{videoFilePath: string}>} an Promise that resolves when the camera zoom is set\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  stopRecordVideo(): Promise<{ videoFilePath: string }>;\n  /**\n   * Start recording video.\n   * @param {CameraPreviewOptions} options the options to start recording video with\n   * @returns {Promise<void>} an Promise that resolves when the video recording is started\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  startRecordVideo(options: CameraPreviewOptions): Promise<void>;\n}\n"]}

package/ios/Plugin/Plugin.swift

@@ -206,7 +206,7 @@ public class CameraPreview: CAPPlugin, CAPBridgedPlugin {
             self.height = UIScreen.main.bounds.size.height
         }
         self.posX = call.getInt("x") != nil ? CGFloat(call.getInt("x")!)/UIScreen.main.scale: 0
-        self.posY = call.getInt("y") != nil ? CGFloat(call.getInt("y")!)/UIScreen.main.scale: 0
+        self.posY = call.getInt("y") != nil ? CGFloat(call.getInt("y")!) / (call.getBool("includeSafeAreaInsets") ?? false ? 1.0 : UIScreen.main.scale) + (call.getBool("includeSafeAreaInsets") ?? false ? UIApplication.shared.windows.first?.safeAreaInsets.top ?? 0 : 0) : 0
         if call.getInt("paddingBottom") != nil {
             self.paddingBottom = CGFloat(call.getInt("paddingBottom")!)
         }

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@capgo/camera-preview",
-  "version": "7.1.0",
+  "version": "7.2.2",
   "description": "Camera preview",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/Cap-go/camera-preview.git"
+    "url": "https://github.com/Cap-go/capacitor-camera-preview"
   },
   "bugs": {
     "url": "https://github.com/Cap-go/camera-preview/issues"