ugcinc 3.11.0 → 3.13.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 +1 -1
- package/dist/types.d.ts +52 -16
- package/package.json +1 -1
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,
|
|
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
|
-
/**
|
|
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,38 @@ 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
|
+
};
|
|
1028
|
+
/** Tag to query media by at runtime (used when selectionMode is 'by-tag') */
|
|
1029
|
+
mediaTag?: string;
|
|
1030
|
+
/** How to pick from the pool for each type */
|
|
1031
|
+
selectionConfig?: {
|
|
1032
|
+
image?: {
|
|
1033
|
+
mode: 'random' | 'sequential';
|
|
1034
|
+
};
|
|
1035
|
+
video?: {
|
|
1036
|
+
mode: 'random' | 'sequential';
|
|
1037
|
+
};
|
|
1038
|
+
audio?: {
|
|
1039
|
+
mode: 'random' | 'sequential';
|
|
1040
|
+
};
|
|
1041
|
+
};
|
|
1042
|
+
}
|
|
1001
1043
|
/**
|
|
1002
1044
|
* Recurrence node configuration - defines when the automation runs on a schedule
|
|
1003
1045
|
*/
|
|
@@ -1015,8 +1057,10 @@ export interface RecurrenceNodeConfig {
|
|
|
1015
1057
|
maxRuns?: number | null;
|
|
1016
1058
|
/** End date for the recurrence in ISO format (YYYY-MM-DD) - if set, runs until this date */
|
|
1017
1059
|
endDate?: string;
|
|
1018
|
-
/** Optional collection input for iterating over multiple
|
|
1060
|
+
/** Optional collection input for iterating over multiple accounts */
|
|
1019
1061
|
collectionInput?: TriggerCollectionConfig;
|
|
1062
|
+
/** Optional media input for providing media to downstream nodes */
|
|
1063
|
+
mediaInput?: RecurrenceMediaConfig;
|
|
1020
1064
|
}
|
|
1021
1065
|
/**
|
|
1022
1066
|
* Account node configuration - source node for selecting accounts to post from
|
|
@@ -1057,21 +1101,15 @@ export interface MediaNodeConfig {
|
|
|
1057
1101
|
/**
|
|
1058
1102
|
* Scheduling mode for post nodes
|
|
1059
1103
|
* - 'scheduled': Post at a specific time (immediately or at a connected date)
|
|
1060
|
-
* - '
|
|
1104
|
+
* - 'queue': Automatically schedule based on queue constraints
|
|
1061
1105
|
*/
|
|
1062
|
-
export type PostSchedulingMode = 'scheduled' | '
|
|
1106
|
+
export type PostSchedulingMode = 'scheduled' | 'queue';
|
|
1063
1107
|
/**
|
|
1064
1108
|
* Sub-mode for scheduled posting
|
|
1065
1109
|
* - 'immediately': Posts when automation runs (no date input needed)
|
|
1066
1110
|
* - 'specific-time': Requires a date input connection
|
|
1067
1111
|
*/
|
|
1068
1112
|
export type PostScheduledSubMode = 'immediately' | 'specific-time';
|
|
1069
|
-
/**
|
|
1070
|
-
* Frequency type for rate-limited posting
|
|
1071
|
-
* - 'daily': Specifies number of posts per day
|
|
1072
|
-
* - 'periodic': Specifies days between posts (for less than 1 post per day)
|
|
1073
|
-
*/
|
|
1074
|
-
export type PostRateLimitFrequency = 'daily' | 'periodic';
|
|
1075
1113
|
/**
|
|
1076
1114
|
* Post scheduling configuration for post nodes
|
|
1077
1115
|
*/
|
|
@@ -1080,12 +1118,10 @@ export interface PostSchedulingConfig {
|
|
|
1080
1118
|
mode: PostSchedulingMode;
|
|
1081
1119
|
/** Sub-mode when mode is 'scheduled' */
|
|
1082
1120
|
scheduledSubMode?: PostScheduledSubMode;
|
|
1083
|
-
/**
|
|
1084
|
-
|
|
1085
|
-
/**
|
|
1086
|
-
|
|
1087
|
-
/** Days between posts (when frequencyType is 'periodic', e.g., 7=weekly) */
|
|
1088
|
-
periodDays?: number;
|
|
1121
|
+
/** Minimum hours between posts for this account (min 1) */
|
|
1122
|
+
minDistanceHours?: number;
|
|
1123
|
+
/** Maximum posts per day for this account (min 1) */
|
|
1124
|
+
maxPostsPerDay?: number;
|
|
1089
1125
|
/** Minimum time of day for posting (HH:mm format, e.g., '09:00') */
|
|
1090
1126
|
randomWindowStart?: string;
|
|
1091
1127
|
/** Maximum time of day for posting (HH:mm format, e.g., '21:00') */
|