ugcinc 2.4.4 → 2.5.0

package/dist/index.d.ts

@@ -11,4 +11,4 @@ export { StatsClient } from './stats';
 export { OrganizationClient } from './org';
 export { RenderClient } from './render';
 export type { ClientConfig, } from './base';
-export type { SuccessResponse, ErrorResponse, ApiResponse, Account, AccountStat, AccountTask, EditProfileInfo, Task, TaskType, Post, PostType, PostStat, ApiKey, EditorConfig, VideoEditorConfig, ImageEditorConfig, EditorChannel, EditorSegment, VideoSegment, AudioSegment, ImageSegment, TextSegment, StaticSegment, RenderJobSubmit, RenderVideoRequest, RenderImageRequest, RenderJobResponse, RenderJobStatus, GetAccountsParams, GetAccountStatsParams, GetAccountStatusParams, UpdateAccountInfoParams, UpdateAccountSocialParams, GetTasksParams, GetPostsParams, CreateSlideshowParams, GetPostStatsParams, GetPostStatusParams, CreateVideoParams, RefreshStatsParams, RefreshStatsResponse, RefreshStatsError, } from './types';
+export type { SuccessResponse, ErrorResponse, ApiResponse, Account, AccountStat, AccountTask, EditProfileInfo, Task, TaskType, Post, PostType, PostStat, ApiKey, EditorConfig, VideoEditorConfig, ImageEditorConfig, EditorChannel, TimeValue, BaseSegmentProps, VisualSegmentProps, EditorSegment, VideoSegment, AudioSegment, ImageSegment, TextSegment, StaticSegment, RenderJobSubmit, RenderVideoRequest, RenderImageRequest, RenderJobResponse, RenderJobStatus, GetAccountsParams, GetAccountStatsParams, GetAccountStatusParams, UpdateAccountInfoParams, UpdateAccountSocialParams, GetTasksParams, GetPostsParams, CreateSlideshowParams, GetPostStatsParams, GetPostStatusParams, CreateVideoParams, RefreshStatsParams, RefreshStatsResponse, RefreshStatsError, } from './types';

package/dist/types.d.ts

@@ -265,65 +265,158 @@ export interface EditorChannel {
     id: string;
     segments: EditorSegment[];
 }
-interface BaseSegmentProps {
+/**
+ * Time value - can be absolute (milliseconds) or relative (0-1 percentage)
+ *
+ * @example
+ * // Absolute: 500 milliseconds
+ * { type: 'absolute', value: 500 }
+ *
+ * @example
+ * // Relative: 50% of total duration
+ * { type: 'relative', value: 0.5 }
+ */
+export interface TimeValue {
+    type: 'absolute' | 'relative';
+    value: number;
+}
+/**
+ * Base properties for all segments
+ */
+export interface BaseSegmentProps {
+    /** Unique segment identifier */
     id: string;
+    /** Public URL to media file */
     source: string;
+    /** Sequence order within channel (0-based) */
     order: number;
-    offset: {
-        type: 'absolute' | 'relative';
-        value: number;
-    };
+    /** Time offset after previous segment starts */
+    offset: TimeValue;
+    /** Trim from start in milliseconds (default: 0) */
     startTrim?: number;
+    /** Trim from end in milliseconds (default: 0) */
     endTrim?: number;
-    duration?: {
-        type: 'absolute' | 'relative';
-        value: number;
-    };
-    xOffset?: number;
-    yOffset?: number;
-    width?: number;
-    height?: number;
+    /** Override segment duration (auto-calculated if omitted) */
+    duration?: TimeValue;
+}
+/**
+ * Visual segment properties (video, image, text, editor)
+ */
+export interface VisualSegmentProps extends BaseSegmentProps {
+    /** Horizontal position from left edge in pixels */
+    xOffset: number;
+    /** Vertical position from top edge in pixels */
+    yOffset: number;
+    /** Width in pixels */
+    width: number;
+    /** Height in pixels */
+    height: number;
+    /** Layer order - higher values appear on top (default: 0) */
     zIndex?: number;
+    /** Scale multiplier (1.0 = 100%, 2.0 = 200%) (default: 1) */
     scale?: number;
+    /** Rotation in degrees clockwise (default: 0) */
     rotation?: number;
+    /** Opacity percentage 0-100 (default: 100) */
     opacity?: number;
 }
-export interface VideoSegment extends BaseSegmentProps {
+/**
+ * Video segment - displays video content with optional audio
+ * Only available for video output type
+ */
+export interface VideoSegment extends VisualSegmentProps {
     type: 'video';
+    /** How video fits in bounds: cover (fill+crop), contain (fit+letterbox), fill (stretch) (default: 'cover') */
     fit?: 'cover' | 'contain' | 'fill';
+    /** Playback speed multiplier (0.5 = half speed, 2.0 = double speed) (default: 1) */
     speed?: number;
+    /** Audio volume percentage 0-100 (0 = muted, 100 = full) (default: 100) */
     volume?: number;
 }
-export interface AudioSegment extends Omit<BaseSegmentProps, 'xOffset' | 'yOffset' | 'width' | 'height' | 'zIndex' | 'scale' | 'rotation' | 'opacity'> {
+/**
+ * Audio segment - background audio or music
+ * Only available for video output type
+ */
+export interface AudioSegment extends BaseSegmentProps {
     type: 'audio';
+    /** Audio volume percentage 0-100 (default: 100) */
     volume?: number;
 }
-export interface ImageSegment extends BaseSegmentProps {
+/**
+ * Image segment - static images or animated GIFs
+ * Available for both video and image output types
+ */
+export interface ImageSegment extends VisualSegmentProps {
     type: 'image';
+    /** How image fits in bounds (default: 'contain') */
     fit?: 'cover' | 'contain' | 'fill';
+    /** Loop animated GIFs (default: false) */
     loop?: boolean;
 }
-export interface TextSegment extends Omit<BaseSegmentProps, 'source'> {
+/**
+ * Text segment - rich text overlays with full typography control
+ * Available for both video and image output types
+ */
+export interface TextSegment extends VisualSegmentProps {
     type: 'text';
     source: '';
-    text?: string;
-    alignment?: 'left' | 'center' | 'right';
+    /** The text content (supports emojis) */
+    text: string;
+    /** Horizontal alignment (default: 'left') */
+    alignment?: 'left' | 'center' | 'right' | 'justify';
+    /** Vertical alignment within bounds (default: 'top') */
     verticalAlign?: 'top' | 'middle' | 'bottom';
+    /** Text direction (default: 'ltr') */
     direction?: 'ltr' | 'rtl';
+    /** Inner padding in pixels (default: 0) */
     padding?: number;
-    fontType?: string;
+    /** Font family (default: 'tiktok') */
+    fontType?: 'tiktok' | 'apple' | 'arial';
+    /** Font size in pixels (default: 40) */
     fontSize?: number;
-    fontWeight?: string;
+    /** Font weight (default: 'normal') */
+    fontWeight?: 'normal' | 'bold';
+    /** Line height multiplier (default: 1.2) */
     lineHeight?: number;
+    /** Letter spacing in pixels (default: 0) */
     letterSpacing?: number;
-    textWrap?: string;
-    wordBreak?: string;
+    /** How text wraps to new lines (default: 'word') */
+    textWrap?: 'word' | 'char' | 'none';
+    /** How words break across lines (default: 'normal') */
+    wordBreak?: 'normal' | 'break-all' | 'break-word';
+    /** Automatic hyphenation (default: 'none') */
+    hyphenation?: 'none' | 'auto';
+    /** Maximum lines (0 = unlimited) (default: 0) */
+    maxLines?: number;
+    /** How overflow is handled (default: 'clip') */
+    textOverflow?: 'clip' | 'ellipsis';
+    /** Ellipsis string for overflow (default: '...') */
+    ellipsis?: string;
+    /** Text color (default: '#FFFFFF') */
     color?: string;
+    /** Background color with optional alpha (default: transparent) */
     backgroundColor?: string;
+    /** Text outline color (default: none) */
     strokeColor?: string;
+    /** Outline width in pixels (default: 0) */
     strokeWidth?: number;
 }
-export type EditorSegment = VideoSegment | AudioSegment | ImageSegment | TextSegment;
+/**
+ * Editor segment - nested composition (editor within editor)
+ * Only available for video output type
+ */
+export interface EditorSegment_Nested extends VisualSegmentProps {
+    type: 'editor';
+    /** Nested editor configuration */
+    editor: EditorConfig;
+    /** How rendered video fits in bounds (default: 'contain') */
+    fit?: 'cover' | 'contain' | 'fill';
+    /** Playback speed of nested composition (default: 1) */
+    speed?: number;
+    /** Audio volume of nested composition 0-100 (default: 100) */
+    volume?: number;
+}
+export type EditorSegment = VideoSegment | AudioSegment | ImageSegment | TextSegment | EditorSegment_Nested;
 export type StaticSegment = ImageSegment | TextSegment;
 export interface RenderVideoRequest {
     editor?: VideoEditorConfig;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ugcinc",
-  "version": "2.4.4",
+  "version": "2.5.0",
   "description": "TypeScript/JavaScript client for the UGC Inc API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",