react-native-video-trim 3.0.10 → 4.0.0

package/src/VideoTrim.nitro.ts

@@ -0,0 +1,244 @@
+import type { HybridObject } from 'react-native-nitro-modules';
+
+export interface EditorConfig {
+  /**
+   * Enable haptic feedback
+   * @default true
+   */
+  enableHapticFeedback: boolean;
+  /**
+   * Save the output file to Photos Library. Only video is supported. Note that you have to make sure you have permission to save to Photos Library.
+   * @default false
+   */
+  saveToPhoto: boolean;
+  maxDuration: number;
+  /**
+   * Minimum duration for trimmer
+   * @default 1000
+   */
+  minDuration: number;
+  /**
+   * Cancel button text
+   * @default "Cancel"
+   */
+  cancelButtonText: string;
+  /**
+   * Save button text
+   * @default "Save"
+   */
+  saveButtonText: string;
+  /**
+   * Enable cancel dialog
+   * @default true
+   */
+  enableCancelDialog: boolean;
+  /**
+   * Cancel dialog title
+   * @default "Warning!"
+   */
+  cancelDialogTitle: string;
+  /**
+   * Cancel dialog message
+   * @default "Are you sure want to cancel?"
+   */
+  cancelDialogMessage: string;
+  /**
+   * Cancel dialog cancel text
+   * @default "Close"
+   */
+  cancelDialogCancelText: string;
+  /**
+   * Cancel dialog confirm text
+   * @default "Proceed"
+   */
+  cancelDialogConfirmText: string;
+  /**
+   * Enable save dialog
+   * @default true
+   */
+  enableSaveDialog: boolean;
+  /**
+   * Save dialog title
+   * @default "Confirmation!"
+   */
+  saveDialogTitle: string;
+  /**
+   * Save dialog message
+   * @default "Are you sure want to save?"
+   */
+  saveDialogMessage: string;
+  /**
+   * Save dialog cancel text
+   * @default "Close"
+   */
+  saveDialogCancelText: string;
+  /**
+   * Save dialog confirm text
+   * @default "Proceed"
+   */
+  saveDialogConfirmText: string;
+  /**
+   * Trimming text
+   * @default "Trimming video..."
+   */
+  trimmingText: string;
+  /**
+   * By default, on iOS the editor will be presented as a modal. If you want to present it as a full screen modal, set this to `true`.
+   * @default false
+   */
+  fullScreenModalIOS: boolean;
+  /**
+   * Type of the file to edit. If video file, recommend to use `video`. If audio file, recommend to use `audio`.
+   * @default "video"
+   */
+  type: string;
+  /**
+   * Output file extension. If video file, recommend to use `mp4` or `mov`. If audio file, recommend to use `wav` or `m4a`.
+   * @default "mp4"
+   * @example "mp4", "mov", "wav", "m4a", "3gp", "avi", "mkv", "flv", "wmv", "webm"
+   */
+  outputExt: string;
+  /**
+   * Whether to open Documents app after finish editing
+   * @default false
+   */
+  openDocumentsOnFinish: boolean;
+  /**
+   * Whether to open Share Sheet after finish editing
+   * @default false
+   */
+  openShareSheetOnFinish: boolean;
+  /**
+   * Remove the file after saved to Photos Library
+   * @default false
+   */
+  removeAfterSavedToPhoto: boolean;
+  /**
+   * Remove the file after failed to save to Photos Library
+   * @default false
+   */
+  removeAfterFailedToSavePhoto: boolean;
+  /**
+   * Remove the file after saved to Documents app
+   * @default false
+   */
+  removeAfterSavedToDocuments: boolean;
+  /**
+   * Remove the file after failed to save to Documents app
+   * @default false
+   */
+  removeAfterFailedToSaveDocuments: boolean;
+  /**
+   * Remove the file after shared to other apps. Currently only support iOS, on Android there's no way to detect if the file is shared or not.
+   * @default false
+   */
+  removeAfterShared: boolean;
+  /**
+   * Remove the file after failed to share to other apps. Currently only support iOS, on Android there's no way to detect if the file is shared or not.
+   * @default false
+   */
+  removeAfterFailedToShare: boolean;
+  /**
+   * Whether to enable autoplay on load
+   */
+  autoplay: boolean;
+  /**
+   * Jump to position on load in milliseconds
+   * @default `undefined` (beginning of the video)
+   */
+  jumpToPositionOnLoad: number;
+  /**
+   * Whether to close the editor when finish editing
+   * @default true
+   */
+  closeWhenFinish: boolean;
+  /**
+   * Enable cancel trimming
+   * @default true
+   */
+  enableCancelTrimming: boolean;
+  /**
+   * Cancel trimming button text
+   * @default "Cancel"
+   */
+  cancelTrimmingButtonText: string;
+  /**
+   * Enable cancel trimming dialog
+   * @default true
+   */
+  enableCancelTrimmingDialog: boolean;
+  /**
+   * Cancel trimming dialog title
+   * @default "Warning!"
+   */
+  cancelTrimmingDialogTitle: string;
+  /**
+   * Cancel trimming dialog message
+   * @default "Are you sure want to cancel trimming?"
+   */
+  cancelTrimmingDialogMessage: string;
+  /**
+   * Cancel trimming dialog cancel text
+   * @default "Close"
+   */
+  cancelTrimmingDialogCancelText: string;
+  /**
+   * Cancel trimming dialog confirm text
+   * @default "Proceed"
+   */
+  cancelTrimmingDialogConfirmText: string;
+  /**
+   * Header text
+   */
+  headerText: string;
+  /**
+   * Header text size
+   * @default 16
+   */
+  headerTextSize: number;
+  /**
+   * Header text color
+   * @default white
+   */
+  headerTextColor: number;
+  /**
+   * Alert on fail to load media
+   * @default true
+   */
+  alertOnFailToLoad: boolean;
+  /**
+   * Alert on fail to load media title
+   * @default "Error"
+   */
+  alertOnFailTitle: string;
+  /**
+   * Alert on fail to load media message
+   * @default "Fail to load media. Possibly invalid file or no network connection"
+   */
+  alertOnFailMessage: string;
+  /**
+   * Alert on fail to load media close text
+   * @default "Close"
+   */
+  alertOnFailCloseText: string;
+}
+
+export interface FileValidationResult {
+  isValid: boolean;
+  fileType: string;
+  duration: number;
+}
+
+export interface VideoTrim
+  extends HybridObject<{ ios: 'swift'; android: 'kotlin' }> {
+  showEditor(
+    filePath: string,
+    config: EditorConfig,
+    onEvent: (eventName: string, payload: Record<string, string>) => void // currently nitro modules will fail if there are 2 optional callbacks, to make if work, we need to pass the onEvent as the last parameter
+  ): void;
+  listFiles(): Promise<string[]>;
+  cleanFiles(): Promise<number>;
+  deleteFile(filePath: string): Promise<boolean>;
+  closeEditor(onComplete: () => void): void;
+  isValidFile(url: string): Promise<FileValidationResult>;
+}

package/src/index.tsx

@@ -1,255 +1,70 @@
-import {
-  NativeModules,
-  Platform,
-  processColor,
-  type ColorValue,
-} from 'react-native';
+import { NitroModules } from 'react-native-nitro-modules';
+import type {
+  EditorConfig,
+  FileValidationResult,
+  VideoTrim,
+} from './VideoTrim.nitro';
+import { processColor } from 'react-native';
 
-const LINKING_ERROR =
-  `The package 'react-native-video-trim' doesn't seem to be linked. Make sure: \n\n` +
-  Platform.select({ ios: "- You have run 'pod install'\n", default: '' }) +
-  '- You rebuilt the app after installing the package\n' +
-  '- You are not using Expo Go\n';
+const VideoTrimHybridObject =
+  NitroModules.createHybridObject<VideoTrim>('VideoTrim');
 
-const VideoTrim = NativeModules.VideoTrim
-  ? NativeModules.VideoTrim
-  : new Proxy(
-      {},
-      {
-        get() {
-          throw new Error(LINKING_ERROR);
-        },
-      }
-    );
-
-export interface EditorConfig {
-  /**
-   * Enable haptic feedback
-   * @default true
-   */
-  enableHapticFeedback?: boolean;
-  /**
-   * Save the output file to Photos Library. Only video is supported. Note that you have to make sure you have permission to save to Photos Library.
-   * @default false
-   */
-  saveToPhoto?: boolean;
-  maxDuration?: number;
-  /**
-   * Minimum duration for trimmer
-   * @default 1000
-   */
-  minDuration?: number;
-  /**
-   * Cancel button text
-   * @default "Cancel"
-   */
-  cancelButtonText?: string;
-  /**
-   * Save button text
-   * @default "Save"
-   */
-  saveButtonText?: string;
-  /**
-   * Enable cancel dialog
-   * @default true
-   */
-  enableCancelDialog?: boolean;
-  /**
-   * Cancel dialog title
-   * @default "Warning!"
-   */
-  cancelDialogTitle?: string;
-  /**
-   * Cancel dialog message
-   * @default "Are you sure want to cancel?"
-   */
-  cancelDialogMessage?: string;
-  /**
-   * Cancel dialog cancel text
-   * @default "Close"
-   */
-  cancelDialogCancelText?: string;
-  /**
-   * Cancel dialog confirm text
-   * @default "Proceed"
-   */
-  cancelDialogConfirmText?: string;
-  /**
-   * Enable save dialog
-   * @default true
-   */
-  enableSaveDialog?: boolean;
-  /**
-   * Save dialog title
-   * @default "Confirmation!"
-   */
-  saveDialogTitle?: string;
-  /**
-   * Save dialog message
-   * @default "Are you sure want to save?"
-   */
-  saveDialogMessage?: string;
-  /**
-   * Save dialog cancel text
-   * @default "Close"
-   */
-  saveDialogCancelText?: string;
-  /**
-   * Save dialog confirm text
-   * @default "Proceed"
-   */
-  saveDialogConfirmText?: string;
-  /**
-   * Trimming text
-   * @default "Trimming video..."
-   */
-  trimmingText?: string;
-  /**
-   * By default, on iOS the editor will be presented as a modal. If you want to present it as a full screen modal, set this to `true`.
-   * @default false
-   */
-  fullScreenModalIOS?: boolean;
-  /**
-   * Type of the file to edit. If video file, recommend to use `video`. If audio file, recommend to use `audio`.
-   * @default "video"
-   */
-  type?: 'video' | 'audio';
-  /**
-   * Output file extension. If video file, recommend to use `mp4` or `mov`. If audio file, recommend to use `wav` or `m4a`.
-   * @default "mp4"
-   * @example "mp4", "mov", "wav", "m4a", "3gp", "avi", "mkv", "flv", "wmv", "webm"
-   */
-  outputExt?: string;
-  /**
-   * Whether to open Documents app after finish editing
-   * @default false
-   */
-  openDocumentsOnFinish?: boolean;
-  /**
-   * Whether to open Share Sheet after finish editing
-   * @default false
-   */
-  openShareSheetOnFinish?: boolean;
-  /**
-   * Remove the file after saved to Photos Library
-   * @default false
-   */
-  removeAfterSavedToPhoto?: boolean;
-  /**
-   * Remove the file after failed to save to Photos Library
-   * @default false
-   */
-  removeAfterFailedToSavePhoto?: boolean;
-  /**
-   * Remove the file after saved to Documents app
-   * @default false
-   */
-  removeAfterSavedToDocuments?: boolean;
-  /**
-   * Remove the file after failed to save to Documents app
-   * @default false
-   */
-  removeAfterFailedToSaveDocuments?: boolean;
-  /**
-   * Remove the file after shared to other apps. Currently only support iOS, on Android there's no way to detect if the file is shared or not.
-   * @default false
-   */
-  removeAfterShared?: boolean;
-  /**
-   * Remove the file after failed to share to other apps. Currently only support iOS, on Android there's no way to detect if the file is shared or not.
-   * @default false
-   */
-  removeAfterFailedToShare?: boolean;
-  /**
-   * Whether to enable autoplay on load
-   */
-  autoplay?: boolean;
-  /**
-   * Jump to position on load in milliseconds
-   * @default `undefined` (beginning of the video)
-   */
-  jumpToPositionOnLoad?: number;
-  /**
-   * Whether to close the editor when finish editing
-   * @default true
-   */
-  closeWhenFinish?: boolean;
-  /**
-   * Enable cancel trimming
-   * @default true
-   */
-  enableCancelTrimming?: boolean;
-  /**
-   * Cancel trimming button text
-   * @default "Cancel"
-   */
-  cancelTrimmingButtonText?: string;
-  /**
-   * Enable cancel trimming dialog
-   * @default true
-   */
-  enableCancelTrimmingDialog?: boolean;
-  /**
-   * Cancel trimming dialog title
-   * @default "Warning!"
-   */
-  cancelTrimmingDialogTitle?: string;
-  /**
-   * Cancel trimming dialog message
-   * @default "Are you sure want to cancel trimming?"
-   */
-  cancelTrimmingDialogMessage?: string;
-  /**
-   * Cancel trimming dialog cancel text
-   * @default "Close"
-   */
-  cancelTrimmingDialogCancelText?: string;
-  /**
-   * Cancel trimming dialog confirm text
-   * @default "Proceed"
-   */
-  cancelTrimmingDialogConfirmText?: string;
-  /**
-   * Header text
-   */
-  headerText?: string;
-  /**
-   * Header text size
-   * @default 16
-   */
-  headerTextSize?: number;
-  /**
-   * Header text color
-   * @default white
-   */
-  headerTextColor?: ColorValue;
-  /**
-   * Alert on fail to load media
-   * @default true
-   */
-  alertOnFailToLoad?: boolean;
-  /**
-   * Alert on fail to load media title
-   * @default "Error"
-   */
-  alertOnFailTitle?: string;
-  /**
-   * Alert on fail to load media message
-   * @default "Fail to load media. Possibly invalid file or no network connection"
-   */
-  alertOnFailMessage?: string;
-  /**
-   * Alert on fail to load media close text
-   * @default "Close"
-   */
-  alertOnFailCloseText?: string;
-  /**
-   * Progress update interval in seconds
-   * @default 0.1
-   */
-  progressUpdateInterval?: number;
+function createEditorConfig(
+  overrides: Partial<EditorConfig> = {}
+): EditorConfig {
+  return {
+    enableHapticFeedback: true,
+    saveToPhoto: false,
+    maxDuration: -1, // Adjust default as needed
+    minDuration: 1000,
+    cancelButtonText: 'Cancel',
+    saveButtonText: 'Save',
+    enableCancelDialog: true,
+    cancelDialogTitle: 'Warning!',
+    cancelDialogMessage: 'Are you sure want to cancel?',
+    cancelDialogCancelText: 'Close',
+    cancelDialogConfirmText: 'Proceed',
+    enableSaveDialog: true,
+    saveDialogTitle: 'Confirmation!',
+    saveDialogMessage: 'Are you sure want to save?',
+    saveDialogCancelText: 'Close',
+    saveDialogConfirmText: 'Proceed',
+    trimmingText: 'Trimming video...',
+    fullScreenModalIOS: false,
+    type: 'video',
+    outputExt: 'mp4',
+    openDocumentsOnFinish: false,
+    openShareSheetOnFinish: false,
+    removeAfterSavedToPhoto: false,
+    removeAfterFailedToSavePhoto: false,
+    removeAfterSavedToDocuments: false,
+    removeAfterFailedToSaveDocuments: false,
+    removeAfterShared: false,
+    removeAfterFailedToShare: false,
+    autoplay: false, // Adjust default as needed
+    jumpToPositionOnLoad: -1,
+    closeWhenFinish: true,
+    enableCancelTrimming: true,
+    cancelTrimmingButtonText: 'Cancel',
+    enableCancelTrimmingDialog: true,
+    cancelTrimmingDialogTitle: 'Warning!',
+    cancelTrimmingDialogMessage: 'Are you sure want to cancel trimming?',
+    cancelTrimmingDialogCancelText: 'Close',
+    cancelTrimmingDialogConfirmText: 'Proceed',
+    headerText: '', // Adjust default as needed
+    headerTextSize: 16,
+    headerTextColor: processColor('white') as number,
+    alertOnFailToLoad: true,
+    alertOnFailTitle: 'Error',
+    alertOnFailMessage:
+      'Fail to load media. Possibly invalid file or no network connection',
+    alertOnFailCloseText: 'Close',
+    ...overrides,
+  };
 }
 
+function noop() {}
+
 /**
  * Delete a file
  *
@@ -257,10 +72,24 @@ export interface EditorConfig {
  * @param {EditorConfig} config: editor configuration
  * @returns {void} A **Promise** which resolves `void`
  */
-export function showEditor(filePath: string, config: EditorConfig = {}): void {
+export function showEditor(
+  filePath: string,
+  config: Partial<Omit<EditorConfig, 'headerTextColor'>> & {
+    headerTextColor?: string;
+  },
+  onEvent?: (eventName: string, payload: Record<string, string>) => void
+): void {
   const { headerTextColor } = config;
-  const color = processColor(headerTextColor);
-  VideoTrim.showEditor(filePath, { ...config, headerTextColor: color });
+  const color = processColor(headerTextColor || 'white');
+
+  VideoTrimHybridObject.showEditor(
+    filePath,
+    createEditorConfig({
+      ...config,
+      headerTextColor: color as any,
+    }),
+    onEvent || noop
+  );
 }
 
 /**
@@ -269,7 +98,7 @@ export function showEditor(filePath: string, config: EditorConfig = {}): void {
  * @returns {Promise<string[]>} A **Promise** which resolves to array of files
  */
 export function listFiles(): Promise<string[]> {
-  return VideoTrim.listFiles();
+  return VideoTrimHybridObject.listFiles();
 }
 
 /**
@@ -278,7 +107,7 @@ export function listFiles(): Promise<string[]> {
  * @returns {Promise} A **Promise** which resolves to number of deleted files
  */
 export function cleanFiles(): Promise<number> {
-  return VideoTrim.cleanFiles();
+  return VideoTrimHybridObject.cleanFiles();
 }
 
 /**
@@ -291,14 +120,14 @@ export function deleteFile(filePath: string): Promise<boolean> {
   if (!filePath?.trim().length) {
     throw new Error('File path cannot be empty!');
   }
-  return VideoTrim.deleteFile(filePath);
+  return VideoTrimHybridObject.deleteFile(filePath);
 }
 
 /**
  * Close editor
  */
-export function closeEditor(): void {
-  return VideoTrim.closeEditor();
+export function closeEditor(onComplete?: () => void): void {
+  return VideoTrimHybridObject.closeEditor(onComplete || noop);
 }
 
 /**
@@ -306,6 +135,6 @@ export function closeEditor(): void {
  *
  * @returns {Promise} A **Promise** which resolves file info if successful
  */
-export function isValidFile(url: string): Promise<boolean> {
-  return VideoTrim.isValidFile(url);
+export function isValidFile(url: string): Promise<FileValidationResult> {
+  return VideoTrimHybridObject.isValidFile(url);
 }

package/android/src/main/AndroidManifestDeprecated.xml

@@ -1,3 +0,0 @@
-<manifest xmlns:android="http://schemas.android.com/apk/res/android"
-          package="com.videotrim">
-</manifest>