@twick/video-editor 0.14.2 → 0.14.4

package/dist/helpers/types.d.ts

@@ -1,48 +1,67 @@
-export type MediaItem = {
-    id: string;
-    type: 'image' | 'video' | 'audio';
-    url: string;
-    arrayBuffer?: ArrayBuffer;
-    thumbnail?: string;
-    metadata?: Record<string, any>;
-};
-export type PaginationOptions = {
-    page: number;
-    limit: number;
-};
-export type SearchOptions = {
-    query: string;
-    type?: 'image' | 'video' | 'audio';
-    metadata?: Record<string, any>;
-};
-export type TextEffect = {
-    name: string;
-    delay?: number;
-    bufferTime?: number;
-    getSample: (textEffect?: TextEffect) => string;
-};
-export type Animation = {
+export interface Animation {
     name: string;
     interval?: number;
+    duration?: number;
+    intensity?: number;
     animate?: "enter" | "exit" | "both";
     mode?: "in" | "out";
     direction?: "up" | "down" | "left" | "right" | "center";
-    options?: {
-        animate?: string[];
-        direction?: string[];
-        mode?: string[];
+    options: {
+        animate?: ("enter" | "exit" | "both")[];
+        mode?: ("in" | "out")[];
+        direction?: ("left" | "right" | "center" | "up" | "down")[];
+        intensity?: [number, number];
+        interval?: [number, number];
+        duration?: [number, number];
     };
     getSample: (animation?: Animation) => string;
-};
+}
+export interface TextEffect {
+    name: string;
+    duration: number;
+    delay?: number;
+    bufferTime?: number;
+    getSample?: () => string;
+}
+export interface MediaItem {
+    id: string;
+    name: string;
+    type: string;
+    url: string;
+    thumbnail?: string;
+    duration?: number;
+    width?: number;
+    height?: number;
+    metadata?: {
+        title?: string;
+        [key: string]: any;
+    };
+    arrayBuffer?: ArrayBuffer;
+}
+export interface PaginationOptions {
+    page: number;
+    limit: number;
+}
+export interface SearchOptions {
+    query?: string;
+    type?: string;
+    sortBy?: string;
+    sortOrder?: 'asc' | 'desc';
+    metadata?: {
+        [key: string]: any;
+    };
+}
 export interface ElementColors {
-    fragment: string;
     video: string;
-    caption: string;
-    image: string;
     audio: string;
+    image: string;
     text: string;
-    element: string;
+    caption: string;
+    icon: string;
+    circle: string;
     rect: string;
+    element: string;
+    fragment: string;
     frameEffect: string;
     filters: string;
     transition: string;

package/dist/hooks/use-player-control.d.ts

@@ -1,3 +1,18 @@
+/**
+ * Custom hook to manage player control state and playback.
+ * Handles play/pause toggling and synchronization with timeline context
+ * for video editor playback control.
+ *
+ * @returns Object containing player control functions
+ *
+ * @example
+ * ```js
+ * const { togglePlayback } = usePlayerControl();
+ *
+ * // Toggle between play and pause states
+ * togglePlayback();
+ * ```
+ */
 export declare const usePlayerControl: () => {
     togglePlayback: () => void;
 };

package/dist/hooks/use-player-manager.d.ts

@@ -1,3 +1,18 @@
+/**
+ * Custom hook to manage player state and canvas interactions.
+ * Handles player data updates, canvas operations, and timeline synchronization
+ * for the video editor component.
+ *
+ * @param videoProps - Object containing video dimensions
+ * @returns Object containing player management functions and state
+ *
+ * @example
+ * ```js
+ * const { twickCanvas, projectData, updateCanvas } = usePlayerManager({
+ *   videoProps: { width: 1920, height: 1080 }
+ * });
+ * ```
+ */
 export declare const usePlayerManager: ({ videoProps, }: {
     videoProps: {
         width: number;

package/dist/hooks/use-timeline-control.d.ts

@@ -1,5 +1,23 @@
 import { TrackElement, Track } from '@twick/timeline';
 
+/**
+ * Custom hook to manage timeline control operations.
+ * Provides functions for deleting items, splitting elements,
+ * and handling undo/redo operations in the video editor.
+ *
+ * @returns Object containing timeline control functions
+ *
+ * @example
+ * ```js
+ * const { deleteItem, splitElement, handleUndo, handleRedo } = useTimelineControl();
+ *
+ * // Delete a track or element
+ * deleteItem(trackOrElement);
+ *
+ * // Split an element at current time
+ * splitElement(element, 5.5);
+ * ```
+ */
 declare const useTimelineControl: () => {
     splitElement: (element: TrackElement, currentTime: number) => void;
     deleteItem: (item: Track | TrackElement) => void;

package/dist/hooks/use-timeline-manager.d.ts

@@ -1,7 +1,26 @@
 import { TrackElement, Track } from '@twick/timeline';
 
+/**
+ * Custom hook to manage timeline operations and state.
+ * Provides functions for handling element dragging, track reordering,
+ * seeking, and selection changes in the video editor.
+ *
+ * @returns Object containing timeline management functions and state
+ *
+ * @example
+ * ```js
+ * const { timelineData, onElementDrag, onSeek, onSelectionChange } = useTimelineManager();
+ *
+ * // Handle element dragging
+ * onElementDrag({ element, dragType: "START", updates: { start: 5, end: 10 } });
+ *
+ * // Seek to specific time
+ * onSeek(15.5);
+ * ```
+ */
 export declare const useTimelineManager: () => {
     timelineData: import('@twick/timeline/dist/services/data.service').TimelineTrackData | null;
+    onAddTrack: () => void;
     onElementDrag: ({ element, dragType, updates, }: {
         updates: {
             start: number;

package/dist/index.d.ts

@@ -1,16 +1,19 @@
-import { default as VideoEditor } from './components/video-editor';
-import { default as PlayerControls } from './components/controls/player-controls';
+import { default as VideoEditor, VideoEditorProps, VideoEditorConfig } from './components/video-editor';
+import { default as PlayerControls, PlayerControlsProps } from './components/controls/player-controls';
 import { default as TimelineManager } from './components/timeline/timeline-manager';
 import { usePlayerControl } from './hooks/use-player-control';
 import { default as BrowserMediaManager } from './helpers/media-manager/browser-media-manager';
-import { MediaItem, PaginationOptions, SearchOptions, Animation } from './helpers/types';
+import { MediaItem, PaginationOptions, SearchOptions, Animation, TextEffect, ElementColors } from './helpers/types';
 import { default as BaseMediaManager } from './helpers/media-manager/base-media-manager';
 import { animationGifs, getAnimationGif } from './assets';
 import { ANIMATIONS } from './helpers/animation-manager';
 import { TEXT_EFFECTS } from './helpers/text-effects-manager';
 import { default as useTimelineControl } from './hooks/use-timeline-control';
+import { setElementColors } from './helpers/editor.utils';
 
-export type { MediaItem, PaginationOptions, SearchOptions, Animation };
+export { setElementColors };
+export type { MediaItem, PaginationOptions, SearchOptions, Animation, TextEffect, ElementColors };
+export type { PlayerControlsProps, VideoEditorProps, VideoEditorConfig };
 export { ANIMATIONS, TEXT_EFFECTS };
 export { usePlayerControl, BrowserMediaManager, BaseMediaManager, animationGifs, getAnimationGif, PlayerControls, TimelineManager, useTimelineControl };
 export * from './helpers/constants';