ugcinc 3.34.3 → 3.36.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -18,4 +18,4 @@ export { MediaClient } from './media';
18
18
  export { CommentsClient } from './comments';
19
19
  export type { RenderJobResponse, RenderJobStatus, SubmitImageRenderJobParams, SubmitVideoRenderJobParams, SubmitScreenshotAnimationRenderJobParams, RenderVideoEditorConfig, } from './render';
20
20
  export type { ClientConfig, } from './base';
21
- export type { SuccessResponse, ErrorResponse, ApiResponse, Account, AccountStat, AccountTask, EditProfileInfo, Task, TaskType, Post, PostType, PostStatus, PostStat, ApiKey, EditorConfig, VideoEditorNodeConfig, VideoEditorChannel, VideoEditorSegment, VideoEditorVideoSegment, VideoEditorAudioSegment, VideoEditorImageSegment, VideoEditorTextSegment, TimeMode, SegmentTimelinePosition, ImageEditorNodeConfig, ImageEditorElement, ImageEditorNodeInput, ImageEditorNodeOutput, DimensionPresetKey, EditorChannel, TimeValue, BaseSegmentProps, VisualSegmentProps, EditorSegment, VideoSegment, AudioSegment, ImageSegment, TextSegment, StaticSegment, PositionAnchor, RelativePositionConfig, GetAccountsParams, GetAccountStatsParams, GetAccountStatusParams, UpdateAccountInfoParams, UpdateAccountSocialParams, GetTasksParams, GetPostsParams, CreateSlideshowParams, GetPostStatsParams, GetPostStatusParams, CreateVideoParams, RefreshStatsParams, RefreshStatsResponse, RefreshStatsError, DailyAggregatedStat, GetDailyAggregatedStatsParams, DailyPostStat, GetDailyPostStatsParams, TopAccount, GetTopAccountsParams, TopPost, GetTopPostsParams, MediaType, NodePort, NodeControlConfig, NodeTypeEnum, WorkflowNodeDefinition, WorkflowDefinition, CanvasState, TemplateNode, AutomationTemplate, AutomationRun, NodeRun, ExecutorNode, ExecutionEdge, OutputSchemaProperty, SelectionMode, ExhaustionBehavior, SelectionConfig, SelectionState, OutputMode, NodeOutputValues, OutputInput, OutputNodeConfig, ManualTriggerOutput, ManualTriggerNodeConfig, TriggerIterationMode, IterationExhaustionBehavior, CollectionSelectionMode, TriggerCollectionConfig, DayOfWeek, RecurrenceMediaOutput, RecurrenceMediaConfig, RecurrenceNodeConfig, AccountNodeConfig, MediaNodeEnabledType, RecurrenceMediaEnabledType, MediaNodeConfig, PostSchedulingMode, PostSchedulingConfig, AutoPostMode, AutoPostInputType, AutoPostInput, AutoPostNodeConfig, SaveToMediaInput, SaveToMediaNodeConfig, DeduplicateNodeConfig, ForEachOutputProperty, ForEachInputPort, ForEachNodeConfig, RandomValueType, RandomInputPort, RandomNodeMode, RandomNodeConfig, VideoImportPlatform, VideoImportQuality, VideoImportNodeConfig, AutoCaptionPreset, AutoCaptionFontWeight, AutoCaptionPosition, AutoCaptionNodeConfig, ScreenshotAnimationNodeConfig, VideoGenerationNodeConfig, PortType, LLMOutputField, LLMNodeConfig, UserMedia, SocialAudio, Media, GetMediaParams, CreateSocialAudioParams, UploadMediaParams, UploadMediaResponse, UpdateMediaTagParams, DeleteMediaParams, DeleteMediaResponse, CreateMediaFromUrlParams, ImportTextParams, ImportTextResponse, Comment, CommentStatus, CreateCommentParams, CreateCommentResponse, GetCommentsParams, ValidationErrorType, ValidationError, ExportedNode, ExportedConnection, ExportedTemplate, AutomationExport, ExportedExecutor, ExportedEdge, ExportedRun, AutomationRunExport, } from './types';
21
+ export type { SuccessResponse, ErrorResponse, ApiResponse, Account, AccountStat, AccountTask, EditProfileInfo, Task, TaskType, Post, PostType, PostStatus, PostStat, ApiKey, EditorConfig, VideoEditorNodeConfig, VideoEditorChannel, VideoEditorSegment, VideoEditorVideoSegment, VideoEditorAudioSegment, VideoEditorImageSegment, VideoEditorTextSegment, TimeMode, SegmentTimelinePosition, ImageEditorNodeConfig, ImageEditorElement, ImageEditorNodeInput, ImageEditorNodeOutput, DimensionPresetKey, EditorChannel, TimeValue, BaseSegmentProps, VisualSegmentProps, EditorSegment, VideoSegment, AudioSegment, ImageSegment, TextSegment, StaticSegment, PositionAnchor, RelativePositionConfig, GetAccountsParams, GetAccountStatsParams, GetAccountStatusParams, UpdateAccountInfoParams, UpdateAccountSocialParams, GetTasksParams, GetPostsParams, CreateSlideshowParams, GetPostStatsParams, GetPostStatusParams, CreateVideoParams, RefreshStatsParams, RefreshStatsResponse, RefreshStatsError, DailyAggregatedStat, GetDailyAggregatedStatsParams, DailyPostStat, GetDailyPostStatsParams, TopAccount, GetTopAccountsParams, TopPost, GetTopPostsParams, MediaType, NodePort, NodeControlConfig, NodeTypeEnum, WorkflowNodeDefinition, WorkflowDefinition, CanvasState, TemplateNode, AutomationTemplate, AutomationRun, NodeRun, ExecutorNode, ExecutionEdge, OutputSchemaProperty, SelectionMode, ExhaustionBehavior, SelectionConfig, SelectionState, OutputMode, NodeOutputValues, OutputInput, OutputNodeConfig, ManualTriggerOutput, ManualTriggerNodeConfig, TriggerIterationMode, IterationExhaustionBehavior, CollectionSelectionMode, TriggerCollectionConfig, DayOfWeek, RecurrenceMediaOutput, RecurrenceMediaConfig, RecurrenceNodeConfig, AccountNodeConfig, MediaNodeEnabledType, RecurrenceMediaEnabledType, MediaNodeOutput, MediaNodeConfig, PostSchedulingMode, PostSchedulingConfig, AutoPostMode, AutoPostInputType, AutoPostInput, AutoPostNodeConfig, SaveToMediaInput, SaveToMediaNodeConfig, DeduplicateNodeConfig, ForEachOutputProperty, ForEachInputPort, ForEachNodeConfig, RandomValueType, RandomInputPort, RandomNodeMode, RandomNodeConfig, VideoImportPlatform, VideoImportQuality, VideoImportNodeConfig, AutoCaptionPreset, AutoCaptionFontWeight, AutoCaptionPosition, AutoCaptionNodeConfig, ScreenshotAnimationNodeConfig, VideoGenerationNodeConfig, MediaArrayType, PortType, LLMOutputField, LLMNodeConfig, UserMedia, SocialAudio, Media, GetMediaParams, CreateSocialAudioParams, UploadMediaParams, UploadMediaResponse, UpdateMediaTagParams, DeleteMediaParams, DeleteMediaResponse, CreateMediaFromUrlParams, ImportTextParams, ImportTextResponse, Comment, CommentStatus, CreateCommentParams, CreateCommentResponse, GetCommentsParams, ValidationErrorType, ValidationError, ExportedNode, ExportedConnection, ExportedTemplate, AutomationExport, ExportedExecutor, ExportedEdge, ExportedRun, AutomationRunExport, } from './types';
package/dist/types.d.ts CHANGED
@@ -752,10 +752,14 @@ export type StaticSegment = ImageSegment | TextSegment;
752
752
  * Automation types
753
753
  */
754
754
  export type MediaType = 'video' | 'image' | 'audio' | 'text' | 'account' | 'date' | 'social_audio';
755
+ /**
756
+ * Array types for media collections
757
+ */
758
+ export type MediaArrayType = 'image[]' | 'video[]' | 'audio[]';
755
759
  /**
756
760
  * Extended port types (includes non-media types for special nodes)
757
761
  */
758
- export type PortType = MediaType | 'number' | 'boolean' | 'object';
762
+ export type PortType = MediaType | 'number' | 'boolean' | 'object' | MediaArrayType;
759
763
  /**
760
764
  * Selection order configuration for media nodes
761
765
  */
@@ -1073,26 +1077,28 @@ export type MediaNodeEnabledType = 'image' | 'video' | 'audio';
1073
1077
  * Includes all media types that can be output from recurrence nodes
1074
1078
  */
1075
1079
  export type RecurrenceMediaEnabledType = 'image' | 'video' | 'audio' | 'text' | 'social_audio';
1080
+ /**
1081
+ * Media node output definition
1082
+ * Each output is a named port with a specific media type
1083
+ */
1084
+ export interface MediaNodeOutput {
1085
+ /** Unique ID for this output port (e.g., "image-1", "background-video") */
1086
+ id: string;
1087
+ /** Base media type for this port */
1088
+ type: MediaNodeEnabledType;
1089
+ /** If true, output is an array of URLs; if false, single URL */
1090
+ isArray: boolean;
1091
+ /** Selected media IDs for this output */
1092
+ selectedMediaIds: string[];
1093
+ /** Selection configuration for this output (only used when isArray is false) */
1094
+ selectionConfig?: SelectionConfig;
1095
+ }
1076
1096
  /**
1077
1097
  * Media node configuration - consolidated source node for image, video, and audio
1078
1098
  */
1079
1099
  export interface MediaNodeConfig {
1080
- /** Which media types are enabled for this node */
1081
- enabledTypes: MediaNodeEnabledType[];
1082
- /** Selected media IDs per type */
1083
- selectedMediaIds?: {
1084
- image?: string[];
1085
- video?: string[];
1086
- audio?: string[];
1087
- };
1088
- /** Selection configuration per type */
1089
- selectionConfig?: {
1090
- image?: SelectionConfig;
1091
- video?: SelectionConfig;
1092
- audio?: SelectionConfig;
1093
- };
1094
- /** Output mode */
1095
- outputMode?: OutputMode;
1100
+ /** Output ports for this media node */
1101
+ outputs: MediaNodeOutput[];
1096
1102
  }
1097
1103
  /**
1098
1104
  * Scheduling mode for post nodes
@@ -1187,15 +1193,17 @@ export interface DeduplicateNodeConfig {
1187
1193
  }
1188
1194
  /**
1189
1195
  * For-each output property configuration
1190
- * Maps a property path from the item object to an output port
1196
+ * Maps a property path from the item object to an output port.
1197
+ * For media array elements (image[], video[], audio[]), use empty propertyPath
1198
+ * with the corresponding media type.
1191
1199
  */
1192
1200
  export interface ForEachOutputProperty {
1193
1201
  /** The output port ID (lowercase, hyphens/underscores only) */
1194
1202
  portId: string;
1195
- /** The property path to extract from each item (e.g., "startMs", "data.value") */
1203
+ /** The property path to extract from each item (e.g., "startMs", "data.value"). Empty string means the whole element. */
1196
1204
  propertyPath: string;
1197
1205
  /** The output type for the port */
1198
- type: 'text' | 'object';
1206
+ type: 'text' | 'object' | 'image' | 'video' | 'audio';
1199
1207
  }
1200
1208
  /**
1201
1209
  * For-each input port configuration
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ugcinc",
3
- "version": "3.34.3",
3
+ "version": "3.36.0",
4
4
  "description": "TypeScript/JavaScript client for the UGC Inc API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",