@symbiote-native/camera 0.0.0-stage → 0.0.0

package/src/core/types.ts

@@ -0,0 +1,223 @@
+import type {
+  IAccessibilityProps,
+  IAriaProps,
+  IResponderProps,
+} from '@symbiote-native/components';
+import type {
+  IStyleProp,
+  ISymbioteEvent,
+  IViewStyle,
+} from '@symbiote-native/engine';
+import type { IAndroidBarcode } from './android-barcode';
+
+export type ICameraType = 'front' | 'back';
+
+/**
+ * `screen` uses the display as the flash of a front camera, on iOS it maps to `on`
+ * and Retina Flash fires
+ */
+export type ICameraFlashMode = 'off' | 'on' | 'auto' | 'screen';
+
+/** `on` focuses once and locks, `off` focuses whenever needed */
+export type ICameraFocusMode = 'on' | 'off';
+
+export type ICameraMode = 'picture' | 'video';
+
+export type ICameraRatio = '4:3' | '16:9' | '1:1';
+
+/** The codec of a video recording, iOS only */
+export type ICameraVideoCodec = 'avc1' | 'hvc1' | 'jpeg' | 'apcn' | 'ap4h';
+
+/** On Android all but `off` turn the stabilization on, the device picks the method */
+export type ICameraVideoStabilization =
+  | 'off'
+  | 'standard'
+  | 'cinematic'
+  | 'auto';
+
+export type ICameraVideoQuality =
+  | '2160p'
+  | '1080p'
+  | '720p'
+  | '480p'
+  | '4:3';
+
+export type ICameraOrientation =
+  | 'portrait'
+  | 'portraitUpsideDown'
+  | 'landscapeLeft'
+  | 'landscapeRight';
+
+export type ICameraBarcodeType =
+  | 'aztec'
+  | 'ean13'
+  | 'ean8'
+  | 'qr'
+  | 'pdf417'
+  | 'upc_e'
+  | 'datamatrix'
+  | 'code39'
+  | 'code93'
+  | 'itf14'
+  | 'codabar'
+  | 'code128'
+  | 'upc_a';
+
+export type ICameraCapturedPicture = {
+  width: number;
+  height: number;
+  format: 'jpg' | 'png';
+  uri: string;
+  /** Base64 of the JPEG data, present when the `base64` option was set */
+  base64?: string;
+  /** The EXIF tags and their values, present when the `exif` option was set */
+  exif?: Record<string, unknown>;
+};
+
+export type ICameraPictureOptions = {
+  /** From `0` (small) to `1` (best), `1` by default */
+  quality?: number;
+  base64?: boolean;
+  exif?: boolean;
+  /** Extra EXIF data, takes effect with `exif` */
+  additionalExif?: Record<string, unknown>;
+  /**
+   * Called when the picture is saved, the promise then resolves at once with no data
+   * and the picture goes to this callback
+   */
+  onPictureSaved?: (picture: ICameraCapturedPicture) => void;
+  /** Returns the image as it came from the sensor, `quality` is discarded */
+  skipProcessing?: boolean;
+  /** @deprecated Use the `mirror` prop of the view */
+  mirror?: boolean;
+  id?: number;
+  fastMode?: boolean;
+  maxDownsampling?: number;
+  /** `true` by default */
+  shutterSound?: boolean;
+  /** Resolves to a reference to the native image instead of a file */
+  pictureRef?: boolean;
+};
+
+export type ICameraRecordingOptions = {
+  /** In seconds */
+  maxDuration?: number;
+  /** In bytes */
+  maxFileSize?: number;
+  /** @deprecated Use the `mirror` prop of the view */
+  mirror?: boolean;
+  /** iOS only */
+  codec?: ICameraVideoCodec;
+};
+
+export type ICameraAvailableLenses = { lenses: string[] };
+
+export type ICameraResponsiveOrientation = { orientation: ICameraOrientation };
+
+export type ICameraMountError = { message: string };
+
+export type ICameraBarcodePoint = { x: number; y: number };
+
+export type ICameraBarcodeBounds = {
+  origin: ICameraBarcodePoint;
+  size: { height: number; width: number };
+};
+
+export type ICameraBarcodeScanningResult = {
+  type: string;
+  /** The parsed information encoded in the barcode */
+  data: string;
+  /** The raw information, Android only */
+  raw?: string;
+  /** The order of the points differs per platform, and is empty for some types */
+  cornerPoints: ICameraBarcodePoint[];
+  bounds: ICameraBarcodeBounds;
+  /** Extra information of the type of barcode, Android only */
+  extra?: IAndroidBarcode;
+};
+
+export type ICameraScanningResult = Omit<
+  ICameraBarcodeScanningResult,
+  'bounds' | 'cornerPoints'
+>;
+
+export type ICameraBarcodeSettings = { barcodeTypes: ICameraBarcodeType[] };
+
+/** The options of the system scanner, iOS 16+ and Google's code scanner on Android */
+export type ICameraScanningOptions = {
+  barcodeTypes: ICameraBarcodeType[];
+  /** iOS only, `true` by default */
+  isPinchToZoomEnabled?: boolean;
+  /** iOS only, `true` by default */
+  isGuidanceEnabled?: boolean;
+  /** iOS only, `false` by default */
+  isHighlightingEnabled?: boolean;
+};
+
+export type ICameraPhotoResult = {
+  uri: string;
+  width: number;
+  height: number;
+  base64?: string;
+};
+
+export type ICameraSavePictureOptions = {
+  quality?: number;
+  metadata?: Record<string, unknown>;
+  base64?: boolean;
+};
+
+export type ICameraViewProps = IAccessibilityProps &
+  IAriaProps &
+  IResponderProps & {
+    /** `back` by default */
+    facing?: ICameraType;
+    /** `off` by default */
+    flash?: ICameraFlashMode;
+    /** From `0` to `1`, a share of the maximum zoom of the device */
+    zoom?: number;
+    /** `picture` by default */
+    mode?: ICameraMode;
+    /** Records video with no sound */
+    mute?: boolean;
+    /** Mirrors the image of the front camera */
+    mirror?: boolean;
+    /** iOS only, `off` by default */
+    autofocus?: ICameraFocusMode;
+    /** Stops the session while `false`, iOS only, `true` by default */
+    active?: boolean;
+    videoQuality?: ICameraVideoQuality;
+    /** In bits per second, on iOS needs the codec in `recordAsync` */
+    videoBitrate?: number;
+    animateShutter?: boolean;
+    /** Makes `ratio` ignored, the sizes come from `getAvailablePictureSizesAsync` */
+    pictureSize?: string;
+    /** iOS only, `builtInWideAngleCamera` by default */
+    selectedLens?: string;
+    enableTorch?: boolean;
+    /** `auto` by default */
+    videoStabilizationMode?: ICameraVideoStabilization;
+    barcodeScannerSettings?: ICameraBarcodeSettings;
+    /** Takes landscape pictures of a portrait-locked app when the device turns, iOS only */
+    responsiveOrientationWhenOrientationLocked?: boolean;
+    /** Android only, switches the preview from fill to fit */
+    ratio?: ICameraRatio;
+    onCameraReady?: () => void;
+    onMountError?: (event: ICameraMountError) => void;
+    onBarcodeScanned?: (result: ICameraBarcodeScanningResult) => void;
+    /** iOS only */
+    onResponsiveOrientationChanged?: (
+      event: ICameraResponsiveOrientation,
+    ) => void;
+    /** iOS only */
+    onAvailableLensesChanged?: (event: ICameraAvailableLenses) => void;
+    style?: IStyleProp<IViewStyle>;
+    testID?: string;
+    nativeID?: string;
+    onLayout?: (event: ISymbioteEvent) => void;
+  };
+
+export type ICameraSupportedFeatures = {
+  isModernBarcodeScannerAvailable: boolean;
+  toggleRecordingAsyncAvailable: boolean;
+};

package/src/react/camera-view.ts

@@ -0,0 +1,17 @@
+import type { ReactElement, Ref } from 'react';
+import { useNativeViewController } from '@symbiote-native/react';
+import { createCameraView } from '../core';
+import type { ICameraViewHandle, ICameraViewProps } from '../core';
+
+export type ICameraViewReactProps = ICameraViewProps & {
+  ref?: Ref<ICameraViewHandle>;
+  className?: string;
+};
+
+/** React twin of `expo-camera`'s `CameraView` */
+export function CameraView({
+  ref,
+  ...props
+}: ICameraViewReactProps): ReactElement | null {
+  return useNativeViewController(ref, createCameraView, props);
+}

package/src/react/index.ts

@@ -0,0 +1,7 @@
+// @symbiote-native/camera/react: камера, съёмка, запись видео и сканирование кодов на общем ядре
+
+export { CameraView } from './camera-view';
+export type { ICameraViewReactProps } from './camera-view';
+export { useCameraPermissions, useMicrophonePermissions } from './use-camera-permissions';
+export type { IUseCameraPermissionsHook } from './use-camera-permissions';
+export * from '../core';

package/src/react/use-camera-permissions.ts

@@ -0,0 +1,21 @@
+import { createPermissionHook } from '@symbiote-native/react';
+import {
+  cameraPermissionMethods,
+  microphonePermissionMethods,
+} from '../core/camera-api';
+import type { IPermissionHookBehavior } from '@symbiote-native/engine';
+import type { PermissionResponse } from 'expo-modules-core';
+
+export type IUseCameraPermissionsHook = (
+  options?: IPermissionHookBehavior,
+) => [
+  PermissionResponse | null,
+  () => Promise<PermissionResponse>,
+  () => Promise<PermissionResponse>,
+];
+
+// React twin of `expo-camera`'s permission hooks
+export const useCameraPermissions: IUseCameraPermissionsHook =
+  createPermissionHook(cameraPermissionMethods);
+export const useMicrophonePermissions: IUseCameraPermissionsHook =
+  createPermissionHook(microphonePermissionMethods);

package/src/solid/camera-view.ts

@@ -0,0 +1,9 @@
+import { defineNativeViewComponent } from '@symbiote-native/solid';
+import { createCameraView } from '../core';
+import type { ICameraViewHandle, ICameraViewProps } from '../core';
+
+/** Solid twin of `expo-camera`'s `CameraView`, `ref` gets the handle of the view */
+export const CameraView = defineNativeViewComponent<
+  ICameraViewHandle,
+  ICameraViewProps
+>(createCameraView);

package/src/solid/index.ts

@@ -0,0 +1,6 @@
+// @symbiote-native/camera/solid: камера, съёмка, запись видео и сканирование кодов на общем ядре
+
+export { CameraView } from './camera-view';
+export { useCameraPermissions, useMicrophonePermissions } from './use-camera-permissions';
+export type { IUseCameraPermissionsHook } from './use-camera-permissions';
+export * from '../core';

package/src/solid/use-camera-permissions.ts

@@ -0,0 +1,22 @@
+import { createPermissionHook } from '@symbiote-native/solid';
+import {
+  cameraPermissionMethods,
+  microphonePermissionMethods,
+} from '../core/camera-api';
+import type { IPermissionHookBehavior } from '@symbiote-native/engine';
+import type { PermissionResponse } from 'expo-modules-core';
+import type { Accessor } from 'solid-js';
+
+export type IUseCameraPermissionsHook = (
+  options?: IPermissionHookBehavior,
+) => [
+  Accessor<PermissionResponse | null>,
+  () => Promise<PermissionResponse>,
+  () => Promise<PermissionResponse>,
+];
+
+// Solid twin of `../react`'s camera permission hooks
+export const useCameraPermissions: IUseCameraPermissionsHook =
+  createPermissionHook(cameraPermissionMethods);
+export const useMicrophonePermissions: IUseCameraPermissionsHook =
+  createPermissionHook(microphonePermissionMethods);

package/src/svelte/camera-view.svelte

@@ -0,0 +1,32 @@
+<script lang="ts">
+  // The native view name is mixed-case, which a literal tag would parse as a component reference,
+  // so the tag is dynamic
+  import { hostProps } from '@symbiote-native/svelte/native-view-bridge';
+  import { useNativeViewController } from '@symbiote-native/svelte/runes/use-native-view-controller';
+  import { createCameraView } from '../core';
+  import type { ICameraViewProps } from '../core';
+
+  const props: ICameraViewProps = $props();
+  const view = useNativeViewController(createCameraView, () => ({ ...props }));
+
+  // The functions of the view are instance members, `bind:this` reaches them
+  export const takePictureAsync = view.handle.takePictureAsync;
+  export const recordAsync = view.handle.recordAsync;
+  export const toggleRecordingAsync = view.handle.toggleRecordingAsync;
+  export const stopRecording = view.handle.stopRecording;
+  export const pausePreview = view.handle.pausePreview;
+  export const resumePreview = view.handle.resumePreview;
+  export const getAvailablePictureSizesAsync =
+    view.handle.getAvailablePictureSizesAsync;
+  export const getAvailableLensesAsync = view.handle.getAvailableLensesAsync;
+  export const getSupportedFeatures = view.handle.getSupportedFeatures;
+  export const getHostNode = view.handle.getHostNode;
+</script>
+
+{#if view.descriptor}
+  <svelte:element
+    this={view.descriptor.type}
+    {@attach view.attachHost}
+    {@attach hostProps(view.descriptor.props)}
+  />
+{/if}

package/src/svelte/index.ts

@@ -0,0 +1,9 @@
+// @symbiote-native/camera/svelte: камера, съёмка, запись видео и сканирование кодов на общем ядре
+
+export { default as CameraView } from './camera-view.svelte';
+export {
+  useCameraPermissions,
+  useMicrophonePermissions,
+} from './use-camera-permissions.svelte';
+export type { IUseCameraPermissionsHook } from './use-camera-permissions.svelte';
+export * from '../core';

package/src/svelte/svelte-ambient.d.ts

@@ -0,0 +1,3 @@
+// Pulls in svelte's ambient globals ($state/$effect/...) for this package's tsc program
+// This package has no value import from 'svelte', so a triple-slash reference does it explicitly
+/// <reference types="svelte" />

package/src/svelte/svelte-compile.test-helper.ts

@@ -0,0 +1,6 @@
+// Re-exports the existing harness instead of another copy
+export {
+  createSvelteHarness,
+  loadComponent,
+  type ISvelteHarness,
+} from '../../../sqlite/src/svelte/svelte-compile.test-helper';

package/src/svelte/use-camera-permissions.svelte.ts

@@ -0,0 +1,21 @@
+import { createPermissionHook } from '@symbiote-native/svelte/runes/create-permission-hook';
+import {
+  cameraPermissionMethods,
+  microphonePermissionMethods,
+} from '../core/camera-api';
+import type { IPermissionHookBehavior } from '@symbiote-native/engine';
+import type { PermissionResponse } from 'expo-modules-core';
+
+export type IUseCameraPermissionsHook = (
+  options?: IPermissionHookBehavior,
+) => {
+  readonly status: PermissionResponse | null;
+  requestPermission: () => Promise<PermissionResponse>;
+  getPermission: () => Promise<PermissionResponse>;
+};
+
+// Svelte twin of `../react`'s camera permission hooks
+export const useCameraPermissions: IUseCameraPermissionsHook =
+  createPermissionHook(cameraPermissionMethods);
+export const useMicrophonePermissions: IUseCameraPermissionsHook =
+  createPermissionHook(microphonePermissionMethods);

package/src/vue/camera-view.ts

@@ -0,0 +1,5 @@
+import { defineNativeViewComponent } from '@symbiote-native/vue';
+import { createCameraView } from '../core';
+
+/** Vue twin of `expo-camera`'s `CameraView` */
+export const CameraView = defineNativeViewComponent('CameraView', createCameraView);

package/src/vue/index.ts

@@ -0,0 +1,6 @@
+// @symbiote-native/camera/vue: камера, съёмка, запись видео и сканирование кодов на общем ядре
+
+export { CameraView } from './camera-view';
+export { useCameraPermissions, useMicrophonePermissions } from './use-camera-permissions';
+export type { IUseCameraPermissionsHook } from './use-camera-permissions';
+export * from '../core';

package/src/vue/use-camera-permissions.ts

@@ -0,0 +1,22 @@
+import { createPermissionHook } from '@symbiote-native/vue';
+import {
+  cameraPermissionMethods,
+  microphonePermissionMethods,
+} from '../core/camera-api';
+import type { IPermissionHookBehavior } from '@symbiote-native/engine';
+import type { PermissionResponse } from 'expo-modules-core';
+import type { Ref } from '@vue/runtime-core';
+
+export type IUseCameraPermissionsHook = (
+  options?: IPermissionHookBehavior,
+) => [
+  Ref<PermissionResponse | null>,
+  () => Promise<PermissionResponse>,
+  () => Promise<PermissionResponse>,
+];
+
+// Vue twin of `../react`'s camera permission hooks
+export const useCameraPermissions: IUseCameraPermissionsHook =
+  createPermissionHook(cameraPermissionMethods);
+export const useMicrophonePermissions: IUseCameraPermissionsHook =
+  createPermissionHook(microphonePermissionMethods);