@shotstack/schemas 1.18.0 → 1.18.1
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/api.bundled.json +7 -5
- package/dist/json-schema/edit.json +5 -4
- package/dist/json-schema/index.cjs +1 -1
- package/dist/json-schema/index.js +1 -1
- package/dist/schema.d.ts +14 -8
- package/dist/zod/zod.gen.cjs +12 -5
- package/dist/zod/zod.gen.d.ts +16 -5
- package/dist/zod/zod.gen.js +12 -5
- package/dist/zod/zod.gen.ts +12 -5
- package/package.json +1 -1
package/dist/schema.d.ts
CHANGED
|
@@ -684,8 +684,9 @@ export interface components {
|
|
|
684
684
|
*
|
|
685
685
|
* - **Source URL:** set `src` to the URL of an mp4 (or compatible) video file.
|
|
686
686
|
* - **Generated:** set `prompt` to describe the motion. Choose a generator
|
|
687
|
-
* with `model` and configure it with model-specific `options
|
|
688
|
-
* starting image
|
|
687
|
+
* with `model` and configure it with model-specific `options`. Models that
|
|
688
|
+
* animate a starting image take it as `options.inputSrc`; the default model
|
|
689
|
+
* generates from the prompt alone. The generated `src` is filled in
|
|
689
690
|
* automatically.
|
|
690
691
|
* - **Both:** `src` acts as a preview placeholder while `prompt` drives
|
|
691
692
|
* generation — the video is regenerated from the prompt at render time.
|
|
@@ -703,7 +704,7 @@ export interface components {
|
|
|
703
704
|
*/
|
|
704
705
|
src?: string;
|
|
705
706
|
/**
|
|
706
|
-
* @description A text prompt to generate the video from. The engine generates a video at render time and fills `src` automatically; an existing `src` is treated as a preview placeholder and replaced. Use `model` to choose the generator and `options` to configure it
|
|
707
|
+
* @description A text prompt to generate the video from. The engine generates a video at render time and fills `src` automatically; an existing `src` is treated as a preview placeholder and replaced. Use `model` to choose the generator and `options` to configure it. A starting image goes in `options.inputSrc`, on the models that accept one.
|
|
707
708
|
* @example Slowly zoom out and orbit left around the object.
|
|
708
709
|
*/
|
|
709
710
|
prompt?: string;
|
|
@@ -1127,7 +1128,10 @@ export interface components {
|
|
|
1127
1128
|
trim?: number;
|
|
1128
1129
|
};
|
|
1129
1130
|
/**
|
|
1130
|
-
* @
|
|
1131
|
+
* @deprecated
|
|
1132
|
+
* @description **Notice: The CaptionAsset is deprecated, use the [RichCaptionAsset](#tocs_richcaptionasset) instead.**
|
|
1133
|
+
*
|
|
1134
|
+
* The CaptionAsset is used to add captions (subtitles) to a video. It uses a supplied SRT or VTT file which will
|
|
1131
1135
|
* be read and burnt to the video.
|
|
1132
1136
|
*
|
|
1133
1137
|
* Captions can be applied independently from a video or audio file for greater
|
|
@@ -1390,9 +1394,10 @@ export interface components {
|
|
|
1390
1394
|
/**
|
|
1391
1395
|
* @deprecated
|
|
1392
1396
|
* @description **Notice: ImageToVideoAsset is deprecated. Use [VideoAsset](#tocs_videoasset)
|
|
1393
|
-
* with `prompt
|
|
1394
|
-
*
|
|
1395
|
-
*
|
|
1397
|
+
* with `prompt`, a `model` that accepts a starting image, and that image in
|
|
1398
|
+
* `options.inputSrc` — for example `shotstack-itv-mini`.** This type continues to
|
|
1399
|
+
* function and is internally rewritten to VideoAsset; no behaviour change for
|
|
1400
|
+
* existing integrations.
|
|
1396
1401
|
*
|
|
1397
1402
|
* The ImageToVideoAsset lets you create a video from an image and a text prompt.
|
|
1398
1403
|
*/
|
|
@@ -3018,6 +3023,7 @@ export interface components {
|
|
|
3018
3023
|
* <li>`fetching` - assets are being fetched</li>
|
|
3019
3024
|
* <li>`preprocessing` - video assets are being processed for compatibility</li>
|
|
3020
3025
|
* <li>`rendering` - the asset is being rendered</li>
|
|
3026
|
+
* <li>`generating` - AI/media generation is in progress</li>
|
|
3021
3027
|
* <li>`saving` - the final asset is being saved to storage</li>
|
|
3022
3028
|
* <li>`done` - the asset is ready to be downloaded</li>
|
|
3023
3029
|
* <li>`failed` - there was an error rendering the asset</li>
|
|
@@ -3025,7 +3031,7 @@ export interface components {
|
|
|
3025
3031
|
* @example done
|
|
3026
3032
|
* @enum {string}
|
|
3027
3033
|
*/
|
|
3028
|
-
status: "queued" | "fetching" | "preprocessing" | "rendering" | "saving" | "done" | "failed";
|
|
3034
|
+
status: "queued" | "fetching" | "preprocessing" | "rendering" | "generating" | "saving" | "done" | "failed";
|
|
3029
3035
|
/**
|
|
3030
3036
|
* @description An error message, only displayed if an error occurred.
|
|
3031
3037
|
* @example
|
package/dist/zod/zod.gen.cjs
CHANGED
|
@@ -120,6 +120,8 @@ exports.captionpropertiesCaptionMarginSchema = zod_1.z.object({
|
|
|
120
120
|
}).strict();
|
|
121
121
|
exports.captionMarginSchema = exports.captionpropertiesCaptionMarginSchema;
|
|
122
122
|
/**
|
|
123
|
+
* **Notice: The CaptionAsset is deprecated, use the [RichCaptionAsset](#tocs_richcaptionasset) instead.**
|
|
124
|
+
*
|
|
123
125
|
* The CaptionAsset is used to add captions (subtitles) to a video. It uses a supplied SRT or VTT file which will
|
|
124
126
|
* be read and burnt to the video.
|
|
125
127
|
*
|
|
@@ -130,6 +132,8 @@ exports.captionMarginSchema = exports.captionpropertiesCaptionMarginSchema;
|
|
|
130
132
|
* To sync captions with a video or audio file use a [Video](#tocs_videoasset) or [Audio](#tocs_audioasset) with
|
|
131
133
|
* matching start and end time.
|
|
132
134
|
*
|
|
135
|
+
*
|
|
136
|
+
* @deprecated
|
|
133
137
|
*/
|
|
134
138
|
exports.captionassetCaptionAssetSchema = zod_1.z.object({
|
|
135
139
|
type: zod_1.z.enum(['caption']),
|
|
@@ -555,9 +559,10 @@ exports.imageassetImageAssetSchema = zod_1.z.object({
|
|
|
555
559
|
exports.imageAssetSchema = exports.imageassetImageAssetSchema;
|
|
556
560
|
/**
|
|
557
561
|
* **Notice: ImageToVideoAsset is deprecated. Use [VideoAsset](#tocs_videoasset)
|
|
558
|
-
* with `prompt
|
|
559
|
-
*
|
|
560
|
-
*
|
|
562
|
+
* with `prompt`, a `model` that accepts a starting image, and that image in
|
|
563
|
+
* `options.inputSrc` — for example `shotstack-itv-mini`.** This type continues to
|
|
564
|
+
* function and is internally rewritten to VideoAsset; no behaviour change for
|
|
565
|
+
* existing integrations.
|
|
561
566
|
*
|
|
562
567
|
* The ImageToVideoAsset lets you create a video from an image and a text prompt.
|
|
563
568
|
*
|
|
@@ -2500,8 +2505,9 @@ exports.transformationSchema = exports.transformationTransformationSchema;
|
|
|
2500
2505
|
*
|
|
2501
2506
|
* - **Source URL:** set `src` to the URL of an mp4 (or compatible) video file.
|
|
2502
2507
|
* - **Generated:** set `prompt` to describe the motion. Choose a generator
|
|
2503
|
-
* with `model` and configure it with model-specific `options
|
|
2504
|
-
* starting image
|
|
2508
|
+
* with `model` and configure it with model-specific `options`. Models that
|
|
2509
|
+
* animate a starting image take it as `options.inputSrc`; the default model
|
|
2510
|
+
* generates from the prompt alone. The generated `src` is filled in
|
|
2505
2511
|
* automatically.
|
|
2506
2512
|
* - **Both:** `src` acts as a preview placeholder while `prompt` drives
|
|
2507
2513
|
* generation — the video is regenerated from the prompt at render time.
|
|
@@ -2753,6 +2759,7 @@ exports.renderresponsedataRenderResponseDataSchema = zod_1.z.object({
|
|
|
2753
2759
|
'fetching',
|
|
2754
2760
|
'preprocessing',
|
|
2755
2761
|
'rendering',
|
|
2762
|
+
'generating',
|
|
2756
2763
|
'saving',
|
|
2757
2764
|
'done',
|
|
2758
2765
|
'failed'
|
package/dist/zod/zod.gen.d.ts
CHANGED
|
@@ -67,6 +67,8 @@ export declare const captionMarginSchema: z.ZodObject<{
|
|
|
67
67
|
right: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodNumber>, z.ZodString]>>;
|
|
68
68
|
}, z.core.$strict>;
|
|
69
69
|
/**
|
|
70
|
+
* **Notice: The CaptionAsset is deprecated, use the [RichCaptionAsset](#tocs_richcaptionasset) instead.**
|
|
71
|
+
*
|
|
70
72
|
* The CaptionAsset is used to add captions (subtitles) to a video. It uses a supplied SRT or VTT file which will
|
|
71
73
|
* be read and burnt to the video.
|
|
72
74
|
*
|
|
@@ -77,6 +79,8 @@ export declare const captionMarginSchema: z.ZodObject<{
|
|
|
77
79
|
* To sync captions with a video or audio file use a [Video](#tocs_videoasset) or [Audio](#tocs_audioasset) with
|
|
78
80
|
* matching start and end time.
|
|
79
81
|
*
|
|
82
|
+
*
|
|
83
|
+
* @deprecated
|
|
80
84
|
*/
|
|
81
85
|
export declare const captionassetCaptionAssetSchema: z.ZodObject<{
|
|
82
86
|
type: z.ZodEnum<{
|
|
@@ -913,9 +917,10 @@ export declare const imageAssetSchema: z.ZodObject<{
|
|
|
913
917
|
}, z.core.$strict>;
|
|
914
918
|
/**
|
|
915
919
|
* **Notice: ImageToVideoAsset is deprecated. Use [VideoAsset](#tocs_videoasset)
|
|
916
|
-
* with `prompt
|
|
917
|
-
*
|
|
918
|
-
*
|
|
920
|
+
* with `prompt`, a `model` that accepts a starting image, and that image in
|
|
921
|
+
* `options.inputSrc` — for example `shotstack-itv-mini`.** This type continues to
|
|
922
|
+
* function and is internally rewritten to VideoAsset; no behaviour change for
|
|
923
|
+
* existing integrations.
|
|
919
924
|
*
|
|
920
925
|
* The ImageToVideoAsset lets you create a video from an image and a text prompt.
|
|
921
926
|
*
|
|
@@ -6980,8 +6985,9 @@ export declare const transformationSchema: z.ZodObject<{
|
|
|
6980
6985
|
*
|
|
6981
6986
|
* - **Source URL:** set `src` to the URL of an mp4 (or compatible) video file.
|
|
6982
6987
|
* - **Generated:** set `prompt` to describe the motion. Choose a generator
|
|
6983
|
-
* with `model` and configure it with model-specific `options
|
|
6984
|
-
* starting image
|
|
6988
|
+
* with `model` and configure it with model-specific `options`. Models that
|
|
6989
|
+
* animate a starting image take it as `options.inputSrc`; the default model
|
|
6990
|
+
* generates from the prompt alone. The generated `src` is filled in
|
|
6985
6991
|
* automatically.
|
|
6986
6992
|
* - **Both:** `src` acts as a preview placeholder while `prompt` drives
|
|
6987
6993
|
* generation — the video is regenerated from the prompt at render time.
|
|
@@ -24575,6 +24581,7 @@ export declare const renderresponsedataRenderResponseDataSchema: z.ZodObject<{
|
|
|
24575
24581
|
fetching: "fetching";
|
|
24576
24582
|
preprocessing: "preprocessing";
|
|
24577
24583
|
rendering: "rendering";
|
|
24584
|
+
generating: "generating";
|
|
24578
24585
|
saving: "saving";
|
|
24579
24586
|
}>;
|
|
24580
24587
|
error: z.ZodOptional<z.ZodString>;
|
|
@@ -26957,6 +26964,7 @@ export declare const renderResponseDataSchema: z.ZodObject<{
|
|
|
26957
26964
|
fetching: "fetching";
|
|
26958
26965
|
preprocessing: "preprocessing";
|
|
26959
26966
|
rendering: "rendering";
|
|
26967
|
+
generating: "generating";
|
|
26960
26968
|
saving: "saving";
|
|
26961
26969
|
}>;
|
|
26962
26970
|
error: z.ZodOptional<z.ZodString>;
|
|
@@ -29345,6 +29353,7 @@ export declare const renderresponseRenderResponseSchema: z.ZodObject<{
|
|
|
29345
29353
|
fetching: "fetching";
|
|
29346
29354
|
preprocessing: "preprocessing";
|
|
29347
29355
|
rendering: "rendering";
|
|
29356
|
+
generating: "generating";
|
|
29348
29357
|
saving: "saving";
|
|
29349
29358
|
}>;
|
|
29350
29359
|
error: z.ZodOptional<z.ZodString>;
|
|
@@ -31731,6 +31740,7 @@ export declare const renderResponseSchema: z.ZodObject<{
|
|
|
31731
31740
|
fetching: "fetching";
|
|
31732
31741
|
preprocessing: "preprocessing";
|
|
31733
31742
|
rendering: "rendering";
|
|
31743
|
+
generating: "generating";
|
|
31734
31744
|
saving: "saving";
|
|
31735
31745
|
}>;
|
|
31736
31746
|
error: z.ZodOptional<z.ZodString>;
|
|
@@ -50708,6 +50718,7 @@ export declare const getRenderResponse: z.ZodObject<{
|
|
|
50708
50718
|
fetching: "fetching";
|
|
50709
50719
|
preprocessing: "preprocessing";
|
|
50710
50720
|
rendering: "rendering";
|
|
50721
|
+
generating: "generating";
|
|
50711
50722
|
saving: "saving";
|
|
50712
50723
|
}>;
|
|
50713
50724
|
error: z.ZodOptional<z.ZodString>;
|
package/dist/zod/zod.gen.js
CHANGED
|
@@ -111,6 +111,8 @@ export const captionpropertiesCaptionMarginSchema = z.object({
|
|
|
111
111
|
}).strict();
|
|
112
112
|
export const captionMarginSchema = captionpropertiesCaptionMarginSchema;
|
|
113
113
|
/**
|
|
114
|
+
* **Notice: The CaptionAsset is deprecated, use the [RichCaptionAsset](#tocs_richcaptionasset) instead.**
|
|
115
|
+
*
|
|
114
116
|
* The CaptionAsset is used to add captions (subtitles) to a video. It uses a supplied SRT or VTT file which will
|
|
115
117
|
* be read and burnt to the video.
|
|
116
118
|
*
|
|
@@ -121,6 +123,8 @@ export const captionMarginSchema = captionpropertiesCaptionMarginSchema;
|
|
|
121
123
|
* To sync captions with a video or audio file use a [Video](#tocs_videoasset) or [Audio](#tocs_audioasset) with
|
|
122
124
|
* matching start and end time.
|
|
123
125
|
*
|
|
126
|
+
*
|
|
127
|
+
* @deprecated
|
|
124
128
|
*/
|
|
125
129
|
export const captionassetCaptionAssetSchema = z.object({
|
|
126
130
|
type: z.enum(['caption']),
|
|
@@ -546,9 +550,10 @@ export const imageassetImageAssetSchema = z.object({
|
|
|
546
550
|
export const imageAssetSchema = imageassetImageAssetSchema;
|
|
547
551
|
/**
|
|
548
552
|
* **Notice: ImageToVideoAsset is deprecated. Use [VideoAsset](#tocs_videoasset)
|
|
549
|
-
* with `prompt
|
|
550
|
-
*
|
|
551
|
-
*
|
|
553
|
+
* with `prompt`, a `model` that accepts a starting image, and that image in
|
|
554
|
+
* `options.inputSrc` — for example `shotstack-itv-mini`.** This type continues to
|
|
555
|
+
* function and is internally rewritten to VideoAsset; no behaviour change for
|
|
556
|
+
* existing integrations.
|
|
552
557
|
*
|
|
553
558
|
* The ImageToVideoAsset lets you create a video from an image and a text prompt.
|
|
554
559
|
*
|
|
@@ -2491,8 +2496,9 @@ export const transformationSchema = transformationTransformationSchema;
|
|
|
2491
2496
|
*
|
|
2492
2497
|
* - **Source URL:** set `src` to the URL of an mp4 (or compatible) video file.
|
|
2493
2498
|
* - **Generated:** set `prompt` to describe the motion. Choose a generator
|
|
2494
|
-
* with `model` and configure it with model-specific `options
|
|
2495
|
-
* starting image
|
|
2499
|
+
* with `model` and configure it with model-specific `options`. Models that
|
|
2500
|
+
* animate a starting image take it as `options.inputSrc`; the default model
|
|
2501
|
+
* generates from the prompt alone. The generated `src` is filled in
|
|
2496
2502
|
* automatically.
|
|
2497
2503
|
* - **Both:** `src` acts as a preview placeholder while `prompt` drives
|
|
2498
2504
|
* generation — the video is regenerated from the prompt at render time.
|
|
@@ -2744,6 +2750,7 @@ export const renderresponsedataRenderResponseDataSchema = z.object({
|
|
|
2744
2750
|
'fetching',
|
|
2745
2751
|
'preprocessing',
|
|
2746
2752
|
'rendering',
|
|
2753
|
+
'generating',
|
|
2747
2754
|
'saving',
|
|
2748
2755
|
'done',
|
|
2749
2756
|
'failed'
|
package/dist/zod/zod.gen.ts
CHANGED
|
@@ -77,6 +77,8 @@ export const captionpropertiesCaptionMarginSchema = z.object({
|
|
|
77
77
|
export const captionMarginSchema = captionpropertiesCaptionMarginSchema;
|
|
78
78
|
|
|
79
79
|
/**
|
|
80
|
+
* **Notice: The CaptionAsset is deprecated, use the [RichCaptionAsset](#tocs_richcaptionasset) instead.**
|
|
81
|
+
*
|
|
80
82
|
* The CaptionAsset is used to add captions (subtitles) to a video. It uses a supplied SRT or VTT file which will
|
|
81
83
|
* be read and burnt to the video.
|
|
82
84
|
*
|
|
@@ -87,6 +89,8 @@ export const captionMarginSchema = captionpropertiesCaptionMarginSchema;
|
|
|
87
89
|
* To sync captions with a video or audio file use a [Video](#tocs_videoasset) or [Audio](#tocs_audioasset) with
|
|
88
90
|
* matching start and end time.
|
|
89
91
|
*
|
|
92
|
+
*
|
|
93
|
+
* @deprecated
|
|
90
94
|
*/
|
|
91
95
|
export const captionassetCaptionAssetSchema = z.object({
|
|
92
96
|
type: z.enum(['caption']),
|
|
@@ -490,9 +494,10 @@ export const imageAssetSchema = imageassetImageAssetSchema;
|
|
|
490
494
|
|
|
491
495
|
/**
|
|
492
496
|
* **Notice: ImageToVideoAsset is deprecated. Use [VideoAsset](#tocs_videoasset)
|
|
493
|
-
* with `prompt
|
|
494
|
-
*
|
|
495
|
-
*
|
|
497
|
+
* with `prompt`, a `model` that accepts a starting image, and that image in
|
|
498
|
+
* `options.inputSrc` — for example `shotstack-itv-mini`.** This type continues to
|
|
499
|
+
* function and is internally rewritten to VideoAsset; no behaviour change for
|
|
500
|
+
* existing integrations.
|
|
496
501
|
*
|
|
497
502
|
* The ImageToVideoAsset lets you create a video from an image and a text prompt.
|
|
498
503
|
*
|
|
@@ -2051,8 +2056,9 @@ export const transformationSchema = transformationTransformationSchema;
|
|
|
2051
2056
|
*
|
|
2052
2057
|
* - **Source URL:** set `src` to the URL of an mp4 (or compatible) video file.
|
|
2053
2058
|
* - **Generated:** set `prompt` to describe the motion. Choose a generator
|
|
2054
|
-
* with `model` and configure it with model-specific `options
|
|
2055
|
-
* starting image
|
|
2059
|
+
* with `model` and configure it with model-specific `options`. Models that
|
|
2060
|
+
* animate a starting image take it as `options.inputSrc`; the default model
|
|
2061
|
+
* generates from the prompt alone. The generated `src` is filled in
|
|
2056
2062
|
* automatically.
|
|
2057
2063
|
* - **Both:** `src` acts as a preview placeholder while `prompt` drives
|
|
2058
2064
|
* generation — the video is regenerated from the prompt at render time.
|
|
@@ -2263,6 +2269,7 @@ export const renderresponsedataRenderResponseDataSchema = z.object({
|
|
|
2263
2269
|
'fetching',
|
|
2264
2270
|
'preprocessing',
|
|
2265
2271
|
'rendering',
|
|
2272
|
+
'generating',
|
|
2266
2273
|
'saving',
|
|
2267
2274
|
'done',
|
|
2268
2275
|
'failed'
|