react-native-video-trim 3.0.10 → 4.1.0

package/lib/typescript/{index.d.ts → src/VideoTrim.nitro.d.ts}

@@ -1,266 +1,257 @@
-import { type ColorValue } from 'react-native';
-export interface EditorConfig {
+import type { HybridObject } from 'react-native-nitro-modules';
+export interface BaseOptions {
     /**
-     * Enable haptic feedback
-     * @default true
+     * 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
      */
-    enableHapticFeedback?: boolean;
+    saveToPhoto: 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.
+     * 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
      */
-    saveToPhoto?: boolean;
-    maxDuration?: number;
+    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;
+    /**
+     * Enable rotation
+     * @default false
+     */
+    enableRotation: boolean;
+    /**
+     * Rotation angle in degrees
+     * @default 0
+     */
+    rotationAngle: number;
+}
+export interface EditorConfig extends BaseOptions {
+    /**
+     * Enable haptic feedback
+     * @default true
+     */
+    enableHapticFeedback: boolean;
+    maxDuration: number;
     /**
      * Minimum duration for trimmer
      * @default 1000
      */
-    minDuration?: number;
+    minDuration: number;
     /**
      * Cancel button text
      * @default "Cancel"
      */
-    cancelButtonText?: string;
+    cancelButtonText: string;
     /**
      * Save button text
      * @default "Save"
      */
-    saveButtonText?: string;
+    saveButtonText: string;
     /**
      * Enable cancel dialog
      * @default true
      */
-    enableCancelDialog?: boolean;
+    enableCancelDialog: boolean;
     /**
      * Cancel dialog title
      * @default "Warning!"
      */
-    cancelDialogTitle?: string;
+    cancelDialogTitle: string;
     /**
      * Cancel dialog message
      * @default "Are you sure want to cancel?"
      */
-    cancelDialogMessage?: string;
+    cancelDialogMessage: string;
     /**
      * Cancel dialog cancel text
      * @default "Close"
      */
-    cancelDialogCancelText?: string;
+    cancelDialogCancelText: string;
     /**
      * Cancel dialog confirm text
      * @default "Proceed"
      */
-    cancelDialogConfirmText?: string;
+    cancelDialogConfirmText: string;
     /**
      * Enable save dialog
      * @default true
      */
-    enableSaveDialog?: boolean;
+    enableSaveDialog: boolean;
     /**
      * Save dialog title
      * @default "Confirmation!"
      */
-    saveDialogTitle?: string;
+    saveDialogTitle: string;
     /**
      * Save dialog message
      * @default "Are you sure want to save?"
      */
-    saveDialogMessage?: string;
+    saveDialogMessage: string;
     /**
      * Save dialog cancel text
      * @default "Close"
      */
-    saveDialogCancelText?: string;
+    saveDialogCancelText: string;
     /**
      * Save dialog confirm text
      * @default "Proceed"
      */
-    saveDialogConfirmText?: string;
+    saveDialogConfirmText: string;
     /**
      * Trimming text
      * @default "Trimming video..."
      */
-    trimmingText?: string;
+    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;
+    fullScreenModalIOS: boolean;
     /**
      * Whether to enable autoplay on load
      */
-    autoplay?: boolean;
+    autoplay: boolean;
     /**
      * Jump to position on load in milliseconds
      * @default `undefined` (beginning of the video)
      */
-    jumpToPositionOnLoad?: number;
+    jumpToPositionOnLoad: number;
     /**
      * Whether to close the editor when finish editing
      * @default true
      */
-    closeWhenFinish?: boolean;
+    closeWhenFinish: boolean;
     /**
      * Enable cancel trimming
      * @default true
      */
-    enableCancelTrimming?: boolean;
+    enableCancelTrimming: boolean;
     /**
      * Cancel trimming button text
      * @default "Cancel"
      */
-    cancelTrimmingButtonText?: string;
+    cancelTrimmingButtonText: string;
     /**
      * Enable cancel trimming dialog
      * @default true
      */
-    enableCancelTrimmingDialog?: boolean;
+    enableCancelTrimmingDialog: boolean;
     /**
      * Cancel trimming dialog title
      * @default "Warning!"
      */
-    cancelTrimmingDialogTitle?: string;
+    cancelTrimmingDialogTitle: string;
     /**
      * Cancel trimming dialog message
      * @default "Are you sure want to cancel trimming?"
      */
-    cancelTrimmingDialogMessage?: string;
+    cancelTrimmingDialogMessage: string;
     /**
      * Cancel trimming dialog cancel text
      * @default "Close"
      */
-    cancelTrimmingDialogCancelText?: string;
+    cancelTrimmingDialogCancelText: string;
     /**
      * Cancel trimming dialog confirm text
      * @default "Proceed"
      */
-    cancelTrimmingDialogConfirmText?: string;
+    cancelTrimmingDialogConfirmText: string;
     /**
      * Header text
      */
-    headerText?: string;
+    headerText: string;
     /**
      * Header text size
      * @default 16
      */
-    headerTextSize?: number;
+    headerTextSize: number;
     /**
      * Header text color
      * @default white
      */
-    headerTextColor?: ColorValue;
+    headerTextColor: number;
     /**
      * Alert on fail to load media
      * @default true
      */
-    alertOnFailToLoad?: boolean;
+    alertOnFailToLoad: boolean;
     /**
      * Alert on fail to load media title
      * @default "Error"
      */
-    alertOnFailTitle?: string;
+    alertOnFailTitle: string;
     /**
      * Alert on fail to load media message
      * @default "Fail to load media. Possibly invalid file or no network connection"
      */
-    alertOnFailMessage?: string;
+    alertOnFailMessage: string;
     /**
      * Alert on fail to load media close text
      * @default "Close"
      */
-    alertOnFailCloseText?: string;
-    /**
-     * Progress update interval in seconds
-     * @default 0.1
-     */
-    progressUpdateInterval?: number;
+    alertOnFailCloseText: string;
+}
+export interface TrimOptions extends BaseOptions {
+    startTime: number;
+    endTime: number;
+}
+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): void;
+    listFiles(): Promise<string[]>;
+    cleanFiles(): Promise<number>;
+    deleteFile(filePath: string): Promise<boolean>;
+    closeEditor(onComplete: () => void): void;
+    isValidFile(url: string): Promise<FileValidationResult>;
+    trim(url: string, options: TrimOptions): Promise<string>;
 }
-/**
- * Delete a file
- *
- * @param {string} videoPath: absolute non-empty file path to edit
- * @param {EditorConfig} config: editor configuration
- * @returns {void} A **Promise** which resolves `void`
- */
-export declare function showEditor(filePath: string, config?: EditorConfig): void;
-/**
- * Clean output files generated at all time
- *
- * @returns {Promise<string[]>} A **Promise** which resolves to array of files
- */
-export declare function listFiles(): Promise<string[]>;
-/**
- * Clean output files generated at all time
- *
- * @returns {Promise} A **Promise** which resolves to number of deleted files
- */
-export declare function cleanFiles(): Promise<number>;
-/**
- * Delete a file
- *
- * @param {string} filePath: absolute non-empty file path to delete
- * @returns {Promise} A **Promise** which resolves `true` if successful
- */
-export declare function deleteFile(filePath: string): Promise<boolean>;
-/**
- * Close editor
- */
-export declare function closeEditor(): void;
-/**
- * Check if a file is valid audio or video file
- *
- * @returns {Promise} A **Promise** which resolves file info if successful
- */
-export declare function isValidFile(url: string): Promise<boolean>;
-//# sourceMappingURL=index.d.ts.map
+//# sourceMappingURL=VideoTrim.nitro.d.ts.map

package/lib/typescript/src/VideoTrim.nitro.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"VideoTrim.nitro.d.ts","sourceRoot":"","sources":["../../../src/VideoTrim.nitro.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAE/D,MAAM,WAAW,WAAW;IAC1B;;;OAGG;IACH,WAAW,EAAE,OAAO,CAAC;IACrB;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,qBAAqB,EAAE,OAAO,CAAC;IAC/B;;;OAGG;IACH,sBAAsB,EAAE,OAAO,CAAC;IAChC;;;OAGG;IACH,uBAAuB,EAAE,OAAO,CAAC;IACjC;;;OAGG;IACH,4BAA4B,EAAE,OAAO,CAAC;IACtC;;;OAGG;IACH,2BAA2B,EAAE,OAAO,CAAC;IACrC;;;OAGG;IACH,gCAAgC,EAAE,OAAO,CAAC;IAC1C;;;OAGG;IACH,iBAAiB,EAAE,OAAO,CAAC;IAC3B;;;OAGG;IACH,wBAAwB,EAAE,OAAO,CAAC;IAClC;;;OAGG;IACH,cAAc,EAAE,OAAO,CAAC;IACxB;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,YAAa,SAAQ,WAAW;IAC/C;;;OAGG;IACH,oBAAoB,EAAE,OAAO,CAAC;IAC9B,WAAW,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,gBAAgB,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,kBAAkB,EAAE,OAAO,CAAC;IAC5B;;;OAGG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;;OAGG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAC5B;;;OAGG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAC/B;;;OAGG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAChC;;;OAGG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAC1B;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;;OAGG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAC7B;;;OAGG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAC9B;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,kBAAkB,EAAE,OAAO,CAAC;IAC5B;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB;;;OAGG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAC7B;;;OAGG;IACH,eAAe,EAAE,OAAO,CAAC;IACzB;;;OAGG;IACH,oBAAoB,EAAE,OAAO,CAAC;IAC9B;;;OAGG;IACH,wBAAwB,EAAE,MAAM,CAAC;IACjC;;;OAGG;IACH,0BAA0B,EAAE,OAAO,CAAC;IACpC;;;OAGG;IACH,yBAAyB,EAAE,MAAM,CAAC;IAClC;;;OAGG;IACH,2BAA2B,EAAE,MAAM,CAAC;IACpC;;;OAGG;IACH,8BAA8B,EAAE,MAAM,CAAC;IACvC;;;OAGG;IACH,+BAA+B,EAAE,MAAM,CAAC;IACxC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,iBAAiB,EAAE,OAAO,CAAC;IAC3B;;;OAGG;IACH,gBAAgB,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,oBAAoB,EAAE,MAAM,CAAC;CAC9B;AAED,MAAM,WAAW,WAAY,SAAQ,WAAW;IAC9C,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,SACf,SAAQ,YAAY,CAAC;IAAE,GAAG,EAAE,OAAO,CAAC;IAAC,OAAO,EAAE,QAAQ,CAAA;CAAE,CAAC;IACzD,UAAU,CACR,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,YAAY,EACpB,OAAO,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,IAAI,GACpE,IAAI,CAAC;IACR,SAAS,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAC/B,UAAU,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAC9B,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC/C,WAAW,CAAC,UAAU,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;IAC1C,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACxD,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CAC1D"}

package/lib/typescript/src/index.d.ts

@@ -0,0 +1,49 @@
+import type { EditorConfig, FileValidationResult, TrimOptions } from './VideoTrim.nitro';
+/**
+ * Delete a file
+ *
+ * @param {string} videoPath: absolute non-empty file path to edit
+ * @param {EditorConfig} config: editor configuration
+ * @returns {void} A **Promise** which resolves `void`
+ */
+export declare function showEditor(filePath: string, config: Partial<Omit<EditorConfig, 'headerTextColor'>> & {
+    headerTextColor?: string;
+}, onEvent?: (eventName: string, payload: Record<string, string>) => void): void;
+/**
+ * Clean output files generated at all time
+ *
+ * @returns {Promise<string[]>} A **Promise** which resolves to array of files
+ */
+export declare function listFiles(): Promise<string[]>;
+/**
+ * Clean output files generated at all time
+ *
+ * @returns {Promise} A **Promise** which resolves to number of deleted files
+ */
+export declare function cleanFiles(): Promise<number>;
+/**
+ * Delete a file
+ *
+ * @param {string} filePath: absolute non-empty file path to delete
+ * @returns {Promise} A **Promise** which resolves `true` if successful
+ */
+export declare function deleteFile(filePath: string): Promise<boolean>;
+/**
+ * Close editor
+ */
+export declare function closeEditor(onComplete?: () => void): void;
+/**
+ * Check if a file is valid audio or video file
+ *
+ * @returns {Promise} A **Promise** which resolves file info if successful
+ */
+export declare function isValidFile(url: string): Promise<FileValidationResult>;
+/**
+ * Trim a video file
+ *
+ * @param {string} url: absolute non-empty file path to edit
+ * @param {TrimOptions} options: trim options
+ * @returns {Promise<string>} A **Promise** which resolves to the trimmed file path
+ */
+export declare function trim(url: string, options: Partial<TrimOptions>): Promise<string>;
+//# sourceMappingURL=index.d.ts.map

package/lib/typescript/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAEV,YAAY,EACZ,oBAAoB,EACpB,WAAW,EAEZ,MAAM,mBAAmB,CAAC;AAgF3B;;;;;;GAMG;AACH,wBAAgB,UAAU,CACxB,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,iBAAiB,CAAC,CAAC,GAAG;IACvD,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B,EACD,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,IAAI,GACrE,IAAI,CAYN;AAED;;;;GAIG;AACH,wBAAgB,SAAS,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAE7C;AAED;;;;GAIG;AACH,wBAAgB,UAAU,IAAI,OAAO,CAAC,MAAM,CAAC,CAE5C;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAK7D;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,UAAU,CAAC,EAAE,MAAM,IAAI,GAAG,IAAI,CAEzD;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAEtE;AAED;;;;;;GAMG;AACH,wBAAgB,IAAI,CAClB,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,OAAO,CAAC,WAAW,CAAC,GAC5B,OAAO,CAAC,MAAM,CAAC,CAEjB"}