ugcinc 3.12.0 → 3.14.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
@@ -17,4 +17,4 @@ export { MediaClient } from './media';
17
17
  export { CommentsClient } from './comments';
18
18
  export type { RenderJobResponse, RenderJobStatus, SubmitImageRenderJobParams, SubmitVideoRenderJobParams, RenderVideoEditorConfig, } from './render';
19
19
  export type { ClientConfig, } from './base';
20
- 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, TriggerCollectionConfig, DayOfWeek, RecurrenceNodeConfig, AccountNodeConfig, MediaNodeEnabledType, MediaNodeConfig, PostSchedulingMode, PostScheduledSubMode, PostSchedulingConfig, PostVideoNodeConfig, PostSlideshowInput, PostSlideshowNodeConfig, SaveToMediaInput, SaveToMediaNodeConfig, DeduplicateNodeConfig, ForEachOutputProperty, ForEachInputPort, ForEachNodeConfig, VideoImportPlatform, VideoImportQuality, VideoImportNodeConfig, AutoCaptionPreset, AutoCaptionFontWeight, AutoCaptionPosition, AutoCaptionNodeConfig, VideoGenerationNodeConfig, PortType, LLMOutputField, LLMNodeConfig, UserMedia, SocialAudio, Media, GetMediaParams, UploadMediaParams, UploadMediaResponse, UpdateMediaTagParams, DeleteMediaParams, DeleteMediaResponse, CreateSocialAudioParams, CreateMediaFromUrlParams, ImportTextParams, ImportTextResponse, Comment, CommentStatus, CreateCommentParams, CreateCommentResponse, GetCommentsParams, ValidationErrorType, ValidationError, ExportedNode, ExportedConnection, ExportedTemplate, AutomationExport, ExportedExecutor, ExportedEdge, ExportedRun, AutomationRunExport, } from './types';
20
+ 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, RecurrenceMediaConfig, RecurrenceNodeConfig, AccountNodeConfig, MediaNodeEnabledType, MediaNodeConfig, PostSchedulingMode, PostScheduledSubMode, PostSchedulingConfig, PostVideoNodeConfig, PostSlideshowInput, PostSlideshowNodeConfig, SaveToMediaInput, SaveToMediaNodeConfig, DeduplicateNodeConfig, ForEachOutputProperty, ForEachInputPort, ForEachNodeConfig, VideoImportPlatform, VideoImportQuality, VideoImportNodeConfig, AutoCaptionPreset, AutoCaptionFontWeight, AutoCaptionPosition, AutoCaptionNodeConfig, VideoGenerationNodeConfig, PortType, LLMOutputField, LLMNodeConfig, UserMedia, SocialAudio, Media, GetMediaParams, UploadMediaParams, UploadMediaResponse, UpdateMediaTagParams, DeleteMediaParams, DeleteMediaResponse, CreateSocialAudioParams, 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
@@ -972,6 +972,12 @@ export type TriggerIterationMode = 'fan-out' | 'sequential';
972
972
  * - 'stop': Stop the automation (disable schedule for recurrence)
973
973
  */
974
974
  export type IterationExhaustionBehavior = 'repeat' | 'stop';
975
+ /**
976
+ * Selection mode for collection inputs
977
+ * - 'specific': Use hardcoded IDs configured at design time
978
+ * - 'by-tag': Query items by tag at runtime (allows dynamic collections)
979
+ */
980
+ export type CollectionSelectionMode = 'specific' | 'by-tag';
975
981
  /**
976
982
  * Account iteration configuration for trigger nodes
977
983
  * When enabled, the trigger iterates over a collection of accounts
@@ -983,8 +989,12 @@ export interface TriggerCollectionConfig {
983
989
  iterationMode: TriggerIterationMode;
984
990
  /** What to do when sequential iteration exhausts all accounts */
985
991
  exhaustionBehavior?: IterationExhaustionBehavior;
986
- /** Account IDs to iterate over */
992
+ /** Selection mode: 'specific' uses accountIds, 'by-tag' queries at runtime */
993
+ selectionMode?: CollectionSelectionMode;
994
+ /** Account IDs to iterate over (used when selectionMode is 'specific' or undefined) */
987
995
  accountIds?: string[];
996
+ /** Tag to query accounts by at runtime (used when selectionMode is 'by-tag') */
997
+ accountTag?: string;
988
998
  }
989
999
  /**
990
1000
  * Manual Trigger node configuration - defines outputs that users provide when running
@@ -998,6 +1008,42 @@ export interface ManualTriggerNodeConfig {
998
1008
  * Days of the week for recurrence scheduling
999
1009
  */
1000
1010
  export type DayOfWeek = 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday' | 'sunday';
1011
+ /**
1012
+ * Media input configuration for recurrence nodes
1013
+ * Allows selecting media by specific IDs or by tag (queried at runtime)
1014
+ */
1015
+ export interface RecurrenceMediaConfig {
1016
+ /** Whether media input is enabled */
1017
+ enabled: boolean;
1018
+ /** Which media types to output (determines output ports) */
1019
+ enabledTypes: MediaNodeEnabledType[];
1020
+ /** Selection mode: 'specific' uses selectedMediaIds, 'by-tag' queries at runtime */
1021
+ selectionMode: CollectionSelectionMode;
1022
+ /** Media IDs per type (used when selectionMode is 'specific') */
1023
+ selectedMediaIds?: {
1024
+ image?: string[];
1025
+ video?: string[];
1026
+ audio?: string[];
1027
+ text?: string[];
1028
+ };
1029
+ /** Tag to query media by at runtime (used when selectionMode is 'by-tag') */
1030
+ mediaTag?: string;
1031
+ /** How to pick from the pool for each type */
1032
+ selectionConfig?: {
1033
+ image?: {
1034
+ mode: 'random' | 'sequential';
1035
+ };
1036
+ video?: {
1037
+ mode: 'random' | 'sequential';
1038
+ };
1039
+ audio?: {
1040
+ mode: 'random' | 'sequential';
1041
+ };
1042
+ text?: {
1043
+ mode: 'random' | 'sequential';
1044
+ };
1045
+ };
1046
+ }
1001
1047
  /**
1002
1048
  * Recurrence node configuration - defines when the automation runs on a schedule
1003
1049
  */
@@ -1015,8 +1061,10 @@ export interface RecurrenceNodeConfig {
1015
1061
  maxRuns?: number | null;
1016
1062
  /** End date for the recurrence in ISO format (YYYY-MM-DD) - if set, runs until this date */
1017
1063
  endDate?: string;
1018
- /** Optional collection input for iterating over multiple elements */
1064
+ /** Optional collection input for iterating over multiple accounts */
1019
1065
  collectionInput?: TriggerCollectionConfig;
1066
+ /** Optional media input for providing media to downstream nodes */
1067
+ mediaInput?: RecurrenceMediaConfig;
1020
1068
  }
1021
1069
  /**
1022
1070
  * Account node configuration - source node for selecting accounts to post from
@@ -1030,9 +1078,9 @@ export interface AccountNodeConfig {
1030
1078
  };
1031
1079
  }
1032
1080
  /**
1033
- * Media node enabled type (image, video, or audio)
1081
+ * Media node enabled type (image, video, audio, or text)
1034
1082
  */
1035
- export type MediaNodeEnabledType = 'image' | 'video' | 'audio';
1083
+ export type MediaNodeEnabledType = 'image' | 'video' | 'audio' | 'text';
1036
1084
  /**
1037
1085
  * Media node configuration - consolidated source node for image, video, and audio
1038
1086
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ugcinc",
3
- "version": "3.12.0",
3
+ "version": "3.14.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",