@imgly/camera-react-native 1.40.0

package/ios/Model/CameraResult.swift

@@ -0,0 +1,181 @@
+import IMGLYCamera
+
+/// The result type for a camera recording session in standard or dual camera mode.
+@objc @objcMembers public class CameraRecording: NSObject {
+  /// The recorded videos.
+  public let recordings: [Recording]
+
+  /// Creates a new `CameraResult` from the `IMGLYCamera` result types.
+  /// - Parameters:
+  ///   - recordings: The recorded `IMGLYCamera.Recording` videos.
+  public convenience init(recordings: [IMGLYCamera.Recording]) {
+    self.init(
+      recordings: recordings.compactMap { Recording(recording: $0) }
+    )
+  }
+
+  /// Creates a new `CameraResult`.
+  /// - Parameters:
+  ///   - recordings: The recorded videos.
+  public init(recordings: [Recording]) {
+    self.recordings = recordings
+  }
+
+  func toDictionary() -> [String: Any] {
+    [
+      "recordings": recordings.compactMap { $0.toDictionary() },
+    ]
+  }
+}
+
+/// The result type for a camera reaction session.
+@objc @objcMembers public class CameraReaction: NSObject {
+  /// The video that was reacted to.
+  public let video: Recording
+
+  /// The recorded videos.
+  public let recordings: [Recording]
+
+  /// Creates a new `CameraReaction` from the `IMGLYCamera` result types.
+  /// - Parameters:
+  ///   - video: The `IMGLYCamera.Recording` video that was reacted to.
+  ///   - recordings: The recorded `IMGLYCamera.Recording` videos.
+  public convenience init(video: IMGLYCamera.Recording, recordings: [IMGLYCamera.Recording]) {
+    self.init(
+      video: Recording(recording: video),
+      recordings: recordings.compactMap { Recording(recording: $0) }
+    )
+  }
+
+  /// Creates a new `CameraReaction` instance..
+  /// - Parameters:
+  ///   - video: The `Recording` video that was reacted to.
+  ///   - recordings: The recorded `Recording` videos.
+  public init(video: Recording, recordings: [Recording]) {
+    self.video = video
+    self.recordings = recordings
+  }
+
+  func toDictionary() -> [String: Any] {
+    [
+      "video": video.toDictionary(),
+      "recordings": recordings.compactMap { $0.toDictionary() },
+    ]
+  }
+}
+
+/// The result of a camera session.
+@objc @objcMembers public class CameraResult: NSObject {
+  /// The video that was reacted to.
+  public let recording: CameraRecording?
+
+  /// The recorded videos.
+  public let reaction: CameraReaction?
+
+  /// The associated metadata.
+  public let metadata: [String: Any]
+
+  /// Creates a new `CameraResult`.
+  /// - Parameters:
+  ///   - video: The video that was reacted to.
+  ///   - recordings: The recorded videos.
+  ///   - metadata: The associated metadata.
+  public convenience init(recording: CameraRecording, metadata: [String: Any] = [:]) {
+    self.init(recording: recording, reaction: nil, metadata: metadata)
+  }
+
+  /// Creates a new `CameraResult` from the `IMGLYCamera` result types.
+  /// - Parameters:
+  ///   - video: The `IMGLYCamera.Recording` video that was reacted to.
+  ///   - recordings: The recorded `IMGLYCamera.Recording` videos.
+  ///   - metadata: The associated metadata.
+  public convenience init(reaction: CameraReaction, metadata: [String: Any] = [:]) {
+    self.init(recording: nil, reaction: reaction, metadata: metadata)
+  }
+
+  private init(recording: CameraRecording?, reaction: CameraReaction?, metadata: [String: Any] = [:]) {
+    self.recording = recording
+    self.reaction = reaction
+    self.metadata = metadata
+  }
+
+  /// Converts the instance to a dictionary.
+  public func toDictionary() -> [String: Any] {
+    var dictionary: [String: Any] = ["metadata": metadata]
+    if let recording {
+      dictionary["recording"] = recording.toDictionary()
+    }
+    if let reaction {
+      dictionary["reaction"] = reaction.toDictionary()
+    }
+    return dictionary
+  }
+}
+
+/// A recording of the camera that can contain multiple video sections.
+@objc @objcMembers public class Recording: NSObject {
+  /// The individual video sections.
+  public let videos: [Video]
+
+  /// The duration in milliseconds.
+  public let duration: Double
+
+  /// Creates a new `Recording` instance.
+  /// - Parameters:
+  ///   - videos: The individual video sections.
+  ///   - duration: The duration in milliseconds.
+  public init(videos: [Video], duration: Double) {
+    self.videos = videos
+    self.duration = duration
+  }
+
+  /// Creates a new `Recording` instance from a `IMGLYCamera.Recording`.
+  /// - Parameter recording: The `IMGLYCamera.Recording`.
+  public convenience init(recording: IMGLYCamera.Recording) {
+    self.init(videos: recording.videos.compactMap { Video(video: $0) }, duration: recording.duration.seconds)
+  }
+
+  func toDictionary() -> [String: Any] {
+    [
+      "videos": videos.compactMap { $0.toDictionary() },
+      "duration": duration,
+    ]
+  }
+}
+
+/// An individual video.
+@objc @objcMembers public class Video: NSObject {
+  /// The `URL` to the source of the video.
+  public let url: URL
+
+  /// The height of the video.
+  public let rect: CGRect
+
+  /// Creates a new `Video`.
+  /// - Parameters:
+  ///   - url: The `URL` to the source of the video.
+  ///   - height: The height of the video.
+  ///   - width: The width of the video.
+  public init(url: URL, rect: CGRect) {
+    self.url = url
+    self.rect = rect
+  }
+
+  /// Creates a new `Video` instance from a `IMGLYCamera.Recording.Video`.
+  /// - Parameter recording: The `IMGLYCamera.Recording.Video`.
+  public convenience init(video: IMGLYCamera.Recording.Video) {
+    self.init(url: video.url, rect: video.rect)
+  }
+
+  func toDictionary() -> [String: Any] {
+    [
+      "uri": url.absoluteString,
+      "rect": [
+        "x": rect.origin.x,
+        "y": rect.origin.y,
+        "width": Double(rect.width),
+        "height": Double(rect.height),
+      ],
+    ]
+  }
+}

package/ios/Model/CameraSettings.swift

@@ -0,0 +1,24 @@
+/// A struct containing all necessary settings to setup the camera.
+@objc @objcMembers public class CameraSettings: NSObject, Codable {
+  /// The license key.
+  public let license: String
+
+  /// The id of the current user.
+  public let userId: String?
+
+  /// Creates a new instance from a given dictionary.
+  ///
+  /// - Parameters:
+  ///   - dictionary: The dictionary to convert the instance from.
+  /// - Returns: The `CameraSettings` instance.
+  public static func fromDictionary(_ dictionary: [String: Any]) -> CameraSettings? {
+    do {
+      let data = try JSONSerialization.data(withJSONObject: dictionary, options: [])
+      let settings = try JSONDecoder().decode(CameraSettings.self, from: data)
+      return settings
+    } catch {
+      print("Error decoding dictionary: \(error)")
+      return nil
+    }
+  }
+}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@imgly/camera-react-native",
+  "version": "1.40.0",
+  "description": "Camera SDK for React Native - provide a versatile video camera to your users on iOS and Android.",
+  "react-native": "index.js",
+  "source": "index.js",
+  "types": "index.d.ts",
+  "files": [
+    "src",
+    "android",
+    "ios",
+    "IMGLYCameraModule.podspec",
+    "index.d.ts",
+    "index.js",
+    "README.md",
+    "LICENSE.md",
+    "!android/build",
+    "!ios/build",
+    "!**/__tests__",
+    "!**/__fixtures__",
+    "!**/__mocks__"
+  ],
+  "keywords": [
+    "react-native",
+    "ios",
+    "android",
+    "camera",
+    "imgly",
+    "cesdk"
+  ],
+  "author": "IMG.LY GmbH",
+  "license": "SEE LICENSE IN LICENSE.md",
+  "homepage": "https://img.ly",
+  "peerDependencies": {
+    "react": "*",
+    "react-native": "*"
+  },
+  "codegenConfig": {
+    "name": "IMGLYCameraModuleSpec",
+    "type": "modules",
+    "jsSrcsDir": "./",
+    "android": {
+      "javaPackageName": "ly.img.camera.reactnative.module"
+    }
+  }
+}

package/src/NativeIMGLYCamera.ts

@@ -0,0 +1,191 @@
+import { TurboModule, TurboModuleRegistry } from 'react-native';
+
+/**
+ * A recording of the camera that can
+ * contain multiple videos.
+ */
+export interface Recording {
+  /** The individual videos of the recording. */
+  videos: Video[];
+
+  /** The overall duration in milliseconds. */
+  duration: number;
+}
+
+/** An individual video. */
+export interface Video {
+  /**
+   * A url to the video file that is stored
+   * in a temporary location.
+   */
+  uri: string;
+
+  /**
+   * A rect that contains the position of
+   * each video as it was shown in the
+   * camera preview (iOS only).
+   */
+  rect: Rect;
+}
+
+/**
+ * A rect used to determine video
+ * dimensions on the canvas.
+ */
+export interface Rect {
+  /** The x coordinate of the top-left corner. */
+  x: number;
+
+  /** The y coordinate of the top-left corner. */
+  y: number;
+
+  /** The width. */
+  width: number;
+
+  /** The height. */
+  height: number;
+}
+
+/** The result for a default camera recording session. */
+interface CameraRecording {
+  /** The recorded videos. */
+  recordings: Recording[];
+}
+
+/** The result for a reaction camera recording session. */
+interface CameraReaction {
+  /** The video that was reacted to (iOS only). */
+  video: Recording;
+
+  /** The recorded videos. */
+  recordings: Recording[];
+}
+
+/** The result of a camera session. */
+interface CameraResult {
+  /** The video that was reacted to (iOS only). */
+  recording?: CameraRecording;
+
+  /** The recorded videos. */
+  reaction?: CameraReaction;
+
+  /** The associated metadata. */
+  metadata: { [key: string]: unknown };
+}
+
+/** A class containing all necessary settings to setup the camera. */
+export interface CameraSettings {
+  /** The license of the editor. */
+  license: string;
+
+  /**
+   * Unique ID tied to your application's user.
+   * This helps us accurately calculate monthly
+   * active users (MAU).
+   */
+  userId?: string;
+}
+
+/** TurboModule Spec. */
+interface Spec extends TurboModule {
+  /**
+   * Open the Camera.
+   * @param settings The `CameraSettings`.
+   * @param video The video to react to (iOS only).
+   * @param metadata The metadata to pass to the native module.
+   */
+  openCamera(
+    settings: CameraSettings,
+    video?: string,
+    metadata?: { [key: string]: unknown }
+  ): Promise<CameraResult | null>;
+}
+
+/** The native module. */
+const NativeModule = TurboModuleRegistry.get<Spec>(
+  'IMGLYCamera'
+) as Spec | null;
+
+/** The result for a default camera recording session. */
+export interface CameraRecordingResult {
+  /** The recorded videos. */
+  recordings: Recording[];
+
+  /** The associated metadata. */
+  metadata: { [key: string]: unknown };
+}
+
+/** The result for a reaction camera recording session. */
+export interface CameraReactionResult {
+  /** The video that was reacted to (iOS only). */
+  video: Recording;
+
+  /** The recorded videos. */
+  recordings: Recording[];
+
+  /** The associated metadata. */
+  metadata: { [key: string]: unknown };
+}
+
+/** The IMG.LY Camera. */
+class IMGLYCamera {
+  /**
+   * Opens the camera for reaction mode (iOS only).
+   * @param settings - Configuration settings for the camera.
+   * @param video - Optional video input to trigger reactions.
+   * @param metadata - Optional metadata to pass to the native module.
+   * @returns A promise that resolves to the reaction result, or null if cancelled.
+   */
+  static async openCamera(
+    settings: CameraSettings,
+    video: string,
+    metadata?: { [key: string]: unknown }
+  ): Promise<CameraReactionResult | null>;
+
+  /**
+   * Opens the standard camera.
+   * @param settings - Configuration settings for the camera.
+   * @param metadata - Optional metadata to pass to the native module.
+   * @returns A promise that resolves to the recording result, or null if cancelled.
+   */
+  static async openCamera(
+    settings: CameraSettings,
+    metadata?: { [key: string]: unknown }
+  ): Promise<CameraRecordingResult | null>;
+
+  /**
+   * Opens the camera with the specified settings and optional video or metadata.
+   * @param settings - Configuration settings for the camera.
+   * @param video - Optional video input to trigger reactions (iOS only) or metadata object.
+   * @param metadata - Optional metadata to pass to the native module.
+   * @returns A promise that resolves to either the recording result, reaction result, or null if unsuccessful.
+   */
+  static async openCamera(
+    settings: CameraSettings,
+    video?: string | { [key: string]: unknown },
+    metadata: { [key: string]: unknown } = {}
+  ): Promise<CameraRecordingResult | CameraReactionResult | null> {
+    if (!NativeModule) return null;
+    const videoInput = typeof video === 'string' ? video : undefined;
+    const metadataInput =
+      typeof video === 'object' && video !== null ? video : metadata;
+    const result = await NativeModule.openCamera(
+      settings,
+      videoInput,
+      metadataInput
+    );
+    if (result?.reaction) {
+      const { video, recordings } = result.reaction;
+      return { video, recordings, metadata: result.metadata };
+    }
+    if (result?.recording) {
+      return {
+        recordings: result.recording.recordings,
+        metadata: result.metadata
+      };
+    }
+    return null;
+  }
+}
+
+export default IMGLYCamera;