ugcinc-render 1.4.0 → 1.5.0

package/dist/index.d.mts

@@ -337,27 +337,47 @@ interface ImageEditorNodeConfig {
 }
 
 /**
- * Video editor types for rendering
+ * Video editor types for the WEBAPP UI
+ *
+ * These types include UI-only fields (marked with comments).
+ * The renderer uses types from editor.ts and segment.ts instead.
+ *
+ * UI-only fields are stripped before sending to renderer:
+ * - timeMode: UI helper for displaying timing mode
+ * - inputRef/textInputRef: Resolved to source/text before rendering
+ * - dimensionPreset: Renderer uses width/height directly
+ * - previewUrls/previewTextValues: Only for UI preview
  */
 
 /**
- * UI helper for timing mode
+ * UI helper for timing mode - not sent to renderer
  */
 type TimeMode = 'fixed' | 'flexible';
 /**
- * Base properties for all video editor segments
+ * Base properties for all video editor segments (UI)
  */
 interface VideoEditorBaseSegment {
+    /** Unique segment identifier */
     id: string;
+    /** Order in the channel (0-based) */
     order: number;
+    /** Time offset from previous segment or absolute position */
     offset: TimeValue;
+    /** Segment duration - required for sequential playback */
     duration?: TimeValue;
+    /** Trim from start in milliseconds */
     startTrim?: number;
+    /** Trim from end in milliseconds */
     endTrim?: number;
+    /** UI-only: helper for timing mode display - stripped before rendering */
     timeMode?: TimeMode;
+    /** Parent segment ID for overlays */
     parentId?: string;
+    /** Relative start (0-1) within parent for overlays */
     relativeStart?: number;
+    /** Relative end (0-1) within parent for overlays */
     relativeEnd?: number;
+    /** Fade-in duration in milliseconds */
     fadeIn?: number;
 }
 /**
@@ -374,11 +394,13 @@ interface VideoEditorVisualSegment extends VideoEditorBaseSegment {
     opacity?: number;
 }
 /**
- * Video segment
+ * Video segment (UI)
  */
 interface VideoEditorVideoSegment extends VideoEditorVisualSegment {
     type: 'video';
+    /** UI-only: reference to input node - resolved to source before rendering */
     inputRef?: string;
+    /** Actual source URL (set after inputRef is resolved) */
     source?: string;
     fit?: FitMode;
     speed?: number;
@@ -386,31 +408,37 @@ interface VideoEditorVideoSegment extends VideoEditorVisualSegment {
     borderRadius?: number | BorderRadiusConfig;
 }
 /**
- * Audio segment
+ * Audio segment (UI)
  */
 interface VideoEditorAudioSegment extends VideoEditorBaseSegment {
     type: 'audio';
+    /** UI-only: reference to input node - resolved to source before rendering */
     inputRef?: string;
+    /** Actual source URL (set after inputRef is resolved) */
     source?: string;
     volume?: number;
 }
 /**
- * Image segment
+ * Image segment (UI)
  */
 interface VideoEditorImageSegment extends VideoEditorVisualSegment {
     type: 'image';
+    /** UI-only: reference to input node - resolved to source before rendering */
     inputRef?: string;
+    /** Actual source URL (set after inputRef is resolved) */
     source?: string;
     fit?: FitMode;
     loop?: boolean;
     borderRadius?: number | BorderRadiusConfig;
 }
 /**
- * Text segment
+ * Text segment (UI)
  */
 interface VideoEditorTextSegment extends VideoEditorVisualSegment {
     type: 'text';
+    /** UI-only: reference to text input - resolved to text before rendering */
     textInputRef?: string;
+    /** Actual text content (set after textInputRef is resolved) */
     text?: string;
     alignment?: 'left' | 'center' | 'right' | 'justify';
     verticalAlign?: 'top' | 'middle' | 'bottom';
@@ -445,16 +473,25 @@ interface VideoEditorChannel {
     segments: VideoEditorSegment[];
 }
 /**
- * Video editor node configuration
+ * Video editor node configuration for WEBAPP UI
+ *
+ * Duration is NOT stored - it's calculated from segment durations.
+ * dimensionPreset, previewUrls, previewTextValues are UI-only.
  */
 interface VideoEditorNodeConfig {
+    /** Canvas width in pixels */
     width: number;
+    /** Canvas height in pixels */
     height: number;
+    /** Frames per second */
     fps: number;
-    duration?: number;
+    /** UI-only: dimension preset selector */
     dimensionPreset: DimensionPresetKey;
+    /** Channels containing segments */
     channels: VideoEditorChannel[];
+    /** UI-only: preview URLs for displaying in editor */
     previewUrls?: Record<string, string>;
+    /** UI-only: preview text values for displaying in editor */
     previewTextValues?: Record<string, string>;
 }
 /**
@@ -644,15 +681,16 @@ type VisualSegmentUnion = VideoSegment | ImageSegment | TextSegment;
 type StaticSegment = ImageSegment | TextSegment;
 
 /**
- * Editor configuration types
+ * Editor configuration types for RENDERING
+ *
+ * These types define what the renderer receives.
+ * Duration is always calculated from segments - there is no duration field.
  *
- * Editors are the top-level containers that define the canvas dimensions,
- * timing, and channels containing segments.
+ * Note: UI-specific types (with previewUrls, dimensionPreset, etc.) are in video.ts
  */
 
 /**
- * A channel (track) containing segments
- * Channels allow for parallel playback of segments
+ * A channel (track) containing segments for rendering
  */
 interface Channel<T extends Segment = Segment> {
     /** Unique channel identifier */
@@ -661,17 +699,16 @@ interface Channel<T extends Segment = Segment> {
     segments: T[];
 }
 /**
- * Base editor configuration shared by all editor types
+ * Base editor configuration for rendering
+ * Duration is calculated from segments, not stored.
  */
 interface BaseEditorConfig {
     /** Canvas width in pixels */
     width: number;
     /** Canvas height in pixels */
     height: number;
-    /** Frames per second (video only) */
+    /** Frames per second */
     fps: number;
-    /** Total duration in milliseconds (auto-calculated if 0 or undefined) */
-    duration?: number;
 }
 /**
  * Full editor configuration with all segment types

package/dist/index.d.ts

@@ -337,27 +337,47 @@ interface ImageEditorNodeConfig {
 }
 
 /**
- * Video editor types for rendering
+ * Video editor types for the WEBAPP UI
+ *
+ * These types include UI-only fields (marked with comments).
+ * The renderer uses types from editor.ts and segment.ts instead.
+ *
+ * UI-only fields are stripped before sending to renderer:
+ * - timeMode: UI helper for displaying timing mode
+ * - inputRef/textInputRef: Resolved to source/text before rendering
+ * - dimensionPreset: Renderer uses width/height directly
+ * - previewUrls/previewTextValues: Only for UI preview
  */
 
 /**
- * UI helper for timing mode
+ * UI helper for timing mode - not sent to renderer
  */
 type TimeMode = 'fixed' | 'flexible';
 /**
- * Base properties for all video editor segments
+ * Base properties for all video editor segments (UI)
  */
 interface VideoEditorBaseSegment {
+    /** Unique segment identifier */
     id: string;
+    /** Order in the channel (0-based) */
     order: number;
+    /** Time offset from previous segment or absolute position */
     offset: TimeValue;
+    /** Segment duration - required for sequential playback */
     duration?: TimeValue;
+    /** Trim from start in milliseconds */
     startTrim?: number;
+    /** Trim from end in milliseconds */
     endTrim?: number;
+    /** UI-only: helper for timing mode display - stripped before rendering */
     timeMode?: TimeMode;
+    /** Parent segment ID for overlays */
     parentId?: string;
+    /** Relative start (0-1) within parent for overlays */
     relativeStart?: number;
+    /** Relative end (0-1) within parent for overlays */
     relativeEnd?: number;
+    /** Fade-in duration in milliseconds */
     fadeIn?: number;
 }
 /**
@@ -374,11 +394,13 @@ interface VideoEditorVisualSegment extends VideoEditorBaseSegment {
     opacity?: number;
 }
 /**
- * Video segment
+ * Video segment (UI)
  */
 interface VideoEditorVideoSegment extends VideoEditorVisualSegment {
     type: 'video';
+    /** UI-only: reference to input node - resolved to source before rendering */
     inputRef?: string;
+    /** Actual source URL (set after inputRef is resolved) */
     source?: string;
     fit?: FitMode;
     speed?: number;
@@ -386,31 +408,37 @@ interface VideoEditorVideoSegment extends VideoEditorVisualSegment {
     borderRadius?: number | BorderRadiusConfig;
 }
 /**
- * Audio segment
+ * Audio segment (UI)
  */
 interface VideoEditorAudioSegment extends VideoEditorBaseSegment {
     type: 'audio';
+    /** UI-only: reference to input node - resolved to source before rendering */
     inputRef?: string;
+    /** Actual source URL (set after inputRef is resolved) */
     source?: string;
     volume?: number;
 }
 /**
- * Image segment
+ * Image segment (UI)
  */
 interface VideoEditorImageSegment extends VideoEditorVisualSegment {
     type: 'image';
+    /** UI-only: reference to input node - resolved to source before rendering */
     inputRef?: string;
+    /** Actual source URL (set after inputRef is resolved) */
     source?: string;
     fit?: FitMode;
     loop?: boolean;
     borderRadius?: number | BorderRadiusConfig;
 }
 /**
- * Text segment
+ * Text segment (UI)
  */
 interface VideoEditorTextSegment extends VideoEditorVisualSegment {
     type: 'text';
+    /** UI-only: reference to text input - resolved to text before rendering */
     textInputRef?: string;
+    /** Actual text content (set after textInputRef is resolved) */
     text?: string;
     alignment?: 'left' | 'center' | 'right' | 'justify';
     verticalAlign?: 'top' | 'middle' | 'bottom';
@@ -445,16 +473,25 @@ interface VideoEditorChannel {
     segments: VideoEditorSegment[];
 }
 /**
- * Video editor node configuration
+ * Video editor node configuration for WEBAPP UI
+ *
+ * Duration is NOT stored - it's calculated from segment durations.
+ * dimensionPreset, previewUrls, previewTextValues are UI-only.
  */
 interface VideoEditorNodeConfig {
+    /** Canvas width in pixels */
     width: number;
+    /** Canvas height in pixels */
     height: number;
+    /** Frames per second */
     fps: number;
-    duration?: number;
+    /** UI-only: dimension preset selector */
     dimensionPreset: DimensionPresetKey;
+    /** Channels containing segments */
     channels: VideoEditorChannel[];
+    /** UI-only: preview URLs for displaying in editor */
     previewUrls?: Record<string, string>;
+    /** UI-only: preview text values for displaying in editor */
     previewTextValues?: Record<string, string>;
 }
 /**
@@ -644,15 +681,16 @@ type VisualSegmentUnion = VideoSegment | ImageSegment | TextSegment;
 type StaticSegment = ImageSegment | TextSegment;
 
 /**
- * Editor configuration types
+ * Editor configuration types for RENDERING
+ *
+ * These types define what the renderer receives.
+ * Duration is always calculated from segments - there is no duration field.
  *
- * Editors are the top-level containers that define the canvas dimensions,
- * timing, and channels containing segments.
+ * Note: UI-specific types (with previewUrls, dimensionPreset, etc.) are in video.ts
  */
 
 /**
- * A channel (track) containing segments
- * Channels allow for parallel playback of segments
+ * A channel (track) containing segments for rendering
  */
 interface Channel<T extends Segment = Segment> {
     /** Unique channel identifier */
@@ -661,17 +699,16 @@ interface Channel<T extends Segment = Segment> {
     segments: T[];
 }
 /**
- * Base editor configuration shared by all editor types
+ * Base editor configuration for rendering
+ * Duration is calculated from segments, not stored.
  */
 interface BaseEditorConfig {
     /** Canvas width in pixels */
     width: number;
     /** Canvas height in pixels */
     height: number;
-    /** Frames per second (video only) */
+    /** Frames per second */
     fps: number;
-    /** Total duration in milliseconds (auto-calculated if 0 or undefined) */
-    duration?: number;
 }
 /**
  * Full editor configuration with all segment types

package/dist/index.js

@@ -1245,9 +1245,9 @@ function calculateSegmentTimings(config, fps) {
       const startFrame = currentFrame + offsetFrames;
       let durationMs;
       if (segment.duration) {
-        durationMs = segment.duration.type === "absolute" ? segment.duration.value : segment.duration.value * (config.duration ?? 1e4);
+        durationMs = segment.duration.type === "absolute" ? segment.duration.value : 5e3;
       } else {
-        durationMs = (config.duration ?? 1e4) - startFrame / fps * 1e3;
+        durationMs = 5e3;
       }
       const durationInFrames = Math.max(1, Math.round(durationMs / 1e3 * fps));
       const endFrame = startFrame + durationInFrames;
@@ -1666,7 +1666,6 @@ var defaultVideoProps = {
     width: 1080,
     height: 1920,
     fps: 30,
-    duration: 5e3,
     channels: []
   },
   sources: {},

package/dist/index.mjs

@@ -1171,9 +1171,9 @@ function calculateSegmentTimings(config, fps) {
       const startFrame = currentFrame + offsetFrames;
       let durationMs;
       if (segment.duration) {
-        durationMs = segment.duration.type === "absolute" ? segment.duration.value : segment.duration.value * (config.duration ?? 1e4);
+        durationMs = segment.duration.type === "absolute" ? segment.duration.value : 5e3;
       } else {
-        durationMs = (config.duration ?? 1e4) - startFrame / fps * 1e3;
+        durationMs = 5e3;
       }
       const durationInFrames = Math.max(1, Math.round(durationMs / 1e3 * fps));
       const endFrame = startFrame + durationInFrames;
@@ -1592,7 +1592,6 @@ var defaultVideoProps = {
     width: 1080,
     height: 1920,
     fps: 30,
-    duration: 5e3,
     channels: []
   },
   sources: {},

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ugcinc-render",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "Unified rendering package for UGC Inc - shared types, components, and compositions for pixel-perfect client/server rendering",
   "main": "dist/index.js",
   "module": "dist/index.mjs",