@shotstack/schemas 1.14.0 → 1.15.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.
Files changed (75) hide show
  1. package/dist/api.bundled.json +12 -13
  2. package/dist/json-schema/edit.json +3828 -4198
  3. package/dist/json-schema/index.cjs +1 -6
  4. package/dist/json-schema/index.d.ts +1 -11
  5. package/dist/json-schema/index.js +0 -5
  6. package/dist/schema.d.ts +20 -9
  7. package/dist/zod/zod.gen.cjs +12 -4
  8. package/dist/zod/zod.gen.d.ts +99 -91
  9. package/dist/zod/zod.gen.js +12 -4
  10. package/dist/zod/zod.gen.ts +12 -4
  11. package/package.json +1 -1
  12. package/dist/json-schema/asset.json +0 -2725
  13. package/dist/json-schema/audio-asset.json +0 -315
  14. package/dist/json-schema/blueprint.json +0 -380
  15. package/dist/json-schema/caption-asset.json +0 -285
  16. package/dist/json-schema/caption-background.json +0 -61
  17. package/dist/json-schema/caption-detailer.json +0 -275
  18. package/dist/json-schema/caption-font.json +0 -97
  19. package/dist/json-schema/caption-margin.json +0 -49
  20. package/dist/json-schema/chroma-key.json +0 -46
  21. package/dist/json-schema/clip.json +0 -3236
  22. package/dist/json-schema/crop.json +0 -69
  23. package/dist/json-schema/destinations.json +0 -599
  24. package/dist/json-schema/flip-transformation.json +0 -37
  25. package/dist/json-schema/font.json +0 -18
  26. package/dist/json-schema/google-cloud-storage-destination-options.json +0 -42
  27. package/dist/json-schema/google-cloud-storage-destination.json +0 -73
  28. package/dist/json-schema/google-drive-destination-options.json +0 -30
  29. package/dist/json-schema/google-drive-destination.json +0 -54
  30. package/dist/json-schema/image-asset.json +0 -173
  31. package/dist/json-schema/image-to-video-asset.json +0 -151
  32. package/dist/json-schema/luma-asset.json +0 -38
  33. package/dist/json-schema/merge-field.json +0 -23
  34. package/dist/json-schema/offset.json +0 -175
  35. package/dist/json-schema/output.json +0 -893
  36. package/dist/json-schema/poster.json +0 -18
  37. package/dist/json-schema/range.json +0 -39
  38. package/dist/json-schema/rich-caption-active-font.json +0 -106
  39. package/dist/json-schema/rich-caption-active.json +0 -291
  40. package/dist/json-schema/rich-caption-animation.json +0 -46
  41. package/dist/json-schema/rich-caption-asset.json +0 -1247
  42. package/dist/json-schema/rich-text-alignment.json +0 -47
  43. package/dist/json-schema/rich-text-animation.json +0 -74
  44. package/dist/json-schema/rich-text-asset.json +0 -761
  45. package/dist/json-schema/rich-text-background.json +0 -78
  46. package/dist/json-schema/rich-text-content.json +0 -394
  47. package/dist/json-schema/rich-text-effects.json +0 -400
  48. package/dist/json-schema/rich-text-font.json +0 -157
  49. package/dist/json-schema/rich-text-gradient.json +0 -68
  50. package/dist/json-schema/rich-text-shadow.json +0 -79
  51. package/dist/json-schema/rich-text-stroke.json +0 -55
  52. package/dist/json-schema/rich-text-style.json +0 -165
  53. package/dist/json-schema/rotate-transformation.json +0 -153
  54. package/dist/json-schema/s3destination-options.json +0 -59
  55. package/dist/json-schema/s3destination.json +0 -90
  56. package/dist/json-schema/schemas.json +0 -4716
  57. package/dist/json-schema/shape-asset.json +0 -225
  58. package/dist/json-schema/shotstack-destination.json +0 -33
  59. package/dist/json-schema/size.json +0 -41
  60. package/dist/json-schema/skew-transformation.json +0 -175
  61. package/dist/json-schema/soundtrack.json +0 -47
  62. package/dist/json-schema/svg-asset.json +0 -26
  63. package/dist/json-schema/template.json +0 -827
  64. package/dist/json-schema/text-to-image-asset.json +0 -128
  65. package/dist/json-schema/text-to-speech-asset.json +0 -239
  66. package/dist/json-schema/thumbnail.json +0 -25
  67. package/dist/json-schema/timeline.json +0 -3364
  68. package/dist/json-schema/track.json +0 -3251
  69. package/dist/json-schema/transformation.json +0 -281
  70. package/dist/json-schema/transition.json +0 -85
  71. package/dist/json-schema/tween.json +0 -120
  72. package/dist/json-schema/video-asset.json +0 -471
  73. package/dist/json-schema/vimeo-destination-options.json +0 -149
  74. package/dist/json-schema/vimeo-destination-privacy-options.json +0 -90
  75. package/dist/json-schema/vimeo-destination.json +0 -178
@@ -1,471 +0,0 @@
1
- {
2
- "name": "VideoAsset",
3
- "strict": true,
4
- "schema": {
5
- "description": "The VideoAsset adds a video to a Clip. The video can be sourced from a URL\n(`src`) or generated from a text prompt (`prom...",
6
- "type": "object",
7
- "properties": {
8
- "type": {
9
- "enum": [
10
- "video"
11
- ],
12
- "description": "The typ...",
13
- "type": "string"
14
- },
15
- "src": {
16
- "anyOf": [
17
- {
18
- "type": "string",
19
- "description": "The video source URL. The..."
20
- },
21
- {
22
- "type": "null"
23
- }
24
- ]
25
- },
26
- "prompt": {
27
- "anyOf": [
28
- {
29
- "type": "string",
30
- "description": "A text prompt to generate the video from. Whe..."
31
- },
32
- {
33
- "type": "null"
34
- }
35
- ]
36
- },
37
- "inputSrc": {
38
- "anyOf": [
39
- {
40
- "type": "string",
41
- "description": "Input image URL for image-to-vid..."
42
- },
43
- {
44
- "type": "null"
45
- }
46
- ]
47
- },
48
- "model": {
49
- "anyOf": [
50
- {
51
- "type": "string",
52
- "description": "The generation model to use when `..."
53
- },
54
- {
55
- "type": "null"
56
- }
57
- ]
58
- },
59
- "resolution": {
60
- "anyOf": [
61
- {
62
- "type": "string",
63
- "description": "Output resolution for vid...",
64
- "enum": [
65
- "480p",
66
- "720p",
67
- "1080p"
68
- ]
69
- },
70
- {
71
- "type": "null"
72
- }
73
- ]
74
- },
75
- "duration": {
76
- "anyOf": [
77
- {
78
- "type": "string",
79
- "description": "Target video duration in sec...",
80
- "enum": [
81
- "auto",
82
- "4",
83
- "5",
84
- "6",
85
- "7",
86
- "8",
87
- "9",
88
- "10",
89
- "11",
90
- "12",
91
- "13",
92
- "14",
93
- "15"
94
- ]
95
- },
96
- {
97
- "type": "null"
98
- }
99
- ]
100
- },
101
- "aspectRatio": {
102
- "anyOf": [
103
- {
104
- "type": "string",
105
- "description": "Aspect ratio for th...",
106
- "enum": [
107
- "1:1",
108
- "16:9",
109
- "9:16",
110
- "4:3",
111
- "3:4",
112
- "21:9",
113
- "9:21"
114
- ]
115
- },
116
- {
117
- "type": "null"
118
- }
119
- ]
120
- },
121
- "generateAudio": {
122
- "anyOf": [
123
- {
124
- "type": "boolean",
125
- "description": "Set to `true` to request audio..."
126
- },
127
- {
128
- "type": "null"
129
- }
130
- ]
131
- },
132
- "transcode": {
133
- "anyOf": [
134
- {
135
- "type": "boolean",
136
- "description": "Set to `true` to force re-encoding of the video during ..."
137
- },
138
- {
139
- "type": "null"
140
- }
141
- ]
142
- },
143
- "trim": {
144
- "anyOf": [
145
- {
146
- "type": "number",
147
- "description": "The start trim point of the video cli..."
148
- },
149
- {
150
- "type": "null"
151
- }
152
- ]
153
- },
154
- "volume": {
155
- "description": "Set the volume of the vid...",
156
- "anyOf": [
157
- {
158
- "type": "number",
159
- "description": "The volume level for th...",
160
- "minimum": 0,
161
- "maximum": 1
162
- },
163
- {
164
- "type": "array",
165
- "description": "An array of [Tween](./#t...",
166
- "items": {
167
- "$ref": "#/$defs/Tween"
168
- }
169
- },
170
- {
171
- "type": "null"
172
- }
173
- ]
174
- },
175
- "volumeEffect": {
176
- "anyOf": [
177
- {
178
- "type": "string",
179
- "description": "Preset volume effects to apply to the vid...",
180
- "enum": [
181
- "none",
182
- "fadeIn",
183
- "fadeOut",
184
- "fadeInFadeOut"
185
- ]
186
- },
187
- {
188
- "type": "null"
189
- }
190
- ]
191
- },
192
- "speed": {
193
- "anyOf": [
194
- {
195
- "type": "number",
196
- "description": "Adjust the playback speed of the video clip between 0 (paused) and 10 (10x normal speed) where 1 is norma...",
197
- "minimum": 0,
198
- "maximum": 10
199
- },
200
- {
201
- "type": "null"
202
- }
203
- ]
204
- },
205
- "crop": {
206
- "anyOf": [
207
- {
208
- "$ref": "#/$defs/Crop"
209
- },
210
- {
211
- "type": "null"
212
- }
213
- ]
214
- },
215
- "chromaKey": {
216
- "anyOf": [
217
- {
218
- "$ref": "#/$defs/ChromaKey"
219
- },
220
- {
221
- "type": "null"
222
- }
223
- ]
224
- }
225
- },
226
- "additionalProperties": false,
227
- "required": [
228
- "type",
229
- "src",
230
- "prompt",
231
- "inputSrc",
232
- "model",
233
- "resolution",
234
- "duration",
235
- "aspectRatio",
236
- "generateAudio",
237
- "transcode",
238
- "trim",
239
- "volume",
240
- "volumeEffect",
241
- "speed",
242
- "crop",
243
- "chromaKey"
244
- ],
245
- "$defs": {
246
- "Tween": {
247
- "description": "Use a Tween to [animate properties over time](/docs/guide/architecting-an-application/animations/). The fol...",
248
- "properties": {
249
- "from": {
250
- "anyOf": [
251
- {
252
- "type": "string",
253
- "description": "The initi..."
254
- },
255
- {
256
- "type": "null"
257
- }
258
- ]
259
- },
260
- "to": {
261
- "anyOf": [
262
- {
263
- "type": "string",
264
- "description": "The fina..."
265
- },
266
- {
267
- "type": "null"
268
- }
269
- ]
270
- },
271
- "start": {
272
- "anyOf": [
273
- {
274
- "type": "number",
275
- "description": "The time in seco..."
276
- },
277
- {
278
- "type": "null"
279
- }
280
- ]
281
- },
282
- "length": {
283
- "anyOf": [
284
- {
285
- "type": "number",
286
- "description": "The du..."
287
- },
288
- {
289
- "type": "null"
290
- }
291
- ]
292
- },
293
- "interpolation": {
294
- "anyOf": [
295
- {
296
- "type": "string",
297
- "description": "The interpolation method to use for the animation. Available options are: <ul>\n <li...",
298
- "enum": [
299
- "linear",
300
- "bezier",
301
- "constant"
302
- ]
303
- },
304
- {
305
- "type": "null"
306
- }
307
- ]
308
- },
309
- "easing": {
310
- "anyOf": [
311
- {
312
- "type": "string",
313
- "description": "The easing function to use for the animation. Easing c...",
314
- "enum": [
315
- "ease",
316
- "easeIn",
317
- "easeOut",
318
- "easeInOut",
319
- "easeInQuad",
320
- "easeInCubic",
321
- "easeInQuart",
322
- "easeInQuint",
323
- "easeInSine",
324
- "easeInExpo",
325
- "easeInCirc",
326
- "easeInBack",
327
- "easeOutQuad",
328
- "easeOutCubic",
329
- "easeOutQuart",
330
- "easeOutQuint",
331
- "easeOutSine",
332
- "easeOutExpo",
333
- "easeOutCirc",
334
- "easeOutBack",
335
- "easeInOutQuad",
336
- "easeInOutCubic",
337
- "easeInOutQuart",
338
- "easeInOutQuint",
339
- "easeInOutSine",
340
- "easeInOutExpo",
341
- "easeInOutCirc",
342
- "easeInOutBack"
343
- ]
344
- },
345
- {
346
- "type": "null"
347
- }
348
- ]
349
- }
350
- },
351
- "additionalProperties": false,
352
- "type": "object",
353
- "required": [
354
- "from",
355
- "to",
356
- "start",
357
- "length",
358
- "interpolation",
359
- "easing"
360
- ]
361
- },
362
- "Crop": {
363
- "description": "Crop the sides of an asset by a relative amount. The size ...",
364
- "properties": {
365
- "top": {
366
- "anyOf": [
367
- {
368
- "type": "number",
369
- "description": "Cro...",
370
- "minimum": 0,
371
- "maximum": 1
372
- },
373
- {
374
- "type": "null"
375
- }
376
- ]
377
- },
378
- "bottom": {
379
- "anyOf": [
380
- {
381
- "type": "number",
382
- "description": "Crop...",
383
- "minimum": 0,
384
- "maximum": 1
385
- },
386
- {
387
- "type": "null"
388
- }
389
- ]
390
- },
391
- "left": {
392
- "anyOf": [
393
- {
394
- "type": "number",
395
- "description": "Cro...",
396
- "minimum": 0,
397
- "maximum": 1
398
- },
399
- {
400
- "type": "null"
401
- }
402
- ]
403
- },
404
- "right": {
405
- "anyOf": [
406
- {
407
- "type": "number",
408
- "description": "Cro...",
409
- "minimum": 0,
410
- "maximum": 1
411
- },
412
- {
413
- "type": "null"
414
- }
415
- ]
416
- }
417
- },
418
- "additionalProperties": false,
419
- "type": "object",
420
- "required": [
421
- "top",
422
- "bottom",
423
- "left",
424
- "right"
425
- ]
426
- },
427
- "ChromaKey": {
428
- "description": "Chroma key is a technique that replaces a spec...",
429
- "properties": {
430
- "color": {
431
- "description": "The chroma key color as a hex va...",
432
- "type": "string"
433
- },
434
- "threshold": {
435
- "anyOf": [
436
- {
437
- "type": "integer",
438
- "description": "Pixels within this ...",
439
- "minimum": 0,
440
- "maximum": 250
441
- },
442
- {
443
- "type": "null"
444
- }
445
- ]
446
- },
447
- "halo": {
448
- "anyOf": [
449
- {
450
- "type": "integer",
451
- "description": "Pixels within the halo dista...",
452
- "minimum": 0,
453
- "maximum": 250
454
- },
455
- {
456
- "type": "null"
457
- }
458
- ]
459
- }
460
- },
461
- "additionalProperties": false,
462
- "required": [
463
- "color",
464
- "threshold",
465
- "halo"
466
- ],
467
- "type": "object"
468
- }
469
- }
470
- }
471
- }
@@ -1,149 +0,0 @@
1
- {
2
- "name": "VimeoDestinationOptions",
3
- "strict": true,
4
- "schema": {
5
- "description": "Pass additional options to control how Vimeo publishes video, including name, description and privacy settings.",
6
- "properties": {
7
- "name": {
8
- "anyOf": [
9
- {
10
- "type": "string",
11
- "description": "A name or title for the video that will be displayed on the Vimeo website."
12
- },
13
- {
14
- "type": "null"
15
- }
16
- ]
17
- },
18
- "description": {
19
- "anyOf": [
20
- {
21
- "type": "string",
22
- "description": "A description of the video that will be displayed on the Vimeo website."
23
- },
24
- {
25
- "type": "null"
26
- }
27
- ]
28
- },
29
- "privacy": {
30
- "anyOf": [
31
- {
32
- "description": "Options to control the visibility of videos and privacy features.",
33
- "$ref": "#/$defs/VimeoDestinationPrivacyOptions"
34
- },
35
- {
36
- "type": "null"
37
- }
38
- ]
39
- },
40
- "folderUri": {
41
- "anyOf": [
42
- {
43
- "type": "string",
44
- "description": "The Vimeo folder URI to upload the video to. The folder must already exist in your Vimeo account."
45
- },
46
- {
47
- "type": "null"
48
- }
49
- ]
50
- }
51
- },
52
- "type": "object",
53
- "additionalProperties": false,
54
- "required": [
55
- "name",
56
- "description",
57
- "privacy",
58
- "folderUri"
59
- ],
60
- "$defs": {
61
- "VimeoDestinationPrivacyOptions": {
62
- "description": "Options to control the visibility of videos and privacy features.",
63
- "properties": {
64
- "view": {
65
- "anyOf": [
66
- {
67
- "type": "string",
68
- "description": "Set who can view the videos. Available options are: <ul>\n <li>`anybody` - Anyone can view the video.</li>\n <li>`nobody` - Only the video owner can view the video.</li>\n <li>`contacts` - Only contacts can view the video.</li>\n <li>`password` - A password is required to view the video.</li>\n <li>`unlisted` - The video is not listed on Vimeo.</li>\n</ul>",
69
- "enum": [
70
- "anybody",
71
- "nobody",
72
- "contacts",
73
- "password",
74
- "unlisted"
75
- ]
76
- },
77
- {
78
- "type": "null"
79
- }
80
- ]
81
- },
82
- "embed": {
83
- "anyOf": [
84
- {
85
- "type": "string",
86
- "description": "Set who can embed the video. Available options are: <ul>\n <li>`public` - Anyone can embed the video.</li>\n <li>`private` - Only the video owner can embed the video.</li>\n <li>`whitelist` - Only whitelisted domains can embed the video.</li>\n</ul>",
87
- "enum": [
88
- "public",
89
- "private",
90
- "whitelist"
91
- ]
92
- },
93
- {
94
- "type": "null"
95
- }
96
- ]
97
- },
98
- "comments": {
99
- "anyOf": [
100
- {
101
- "type": "string",
102
- "description": "Set who can comment on the video. Available options are: <ul>\n <li>`anybody` - Anyone can comment on the video.</li>\n <li>`nobody` - Only the video owner can comment on the video.</li>\n <li>`contacts` - Only contacts can comment on the video.</li>\n</ul>",
103
- "enum": [
104
- "anybody",
105
- "nobody",
106
- "contacts"
107
- ]
108
- },
109
- {
110
- "type": "null"
111
- }
112
- ]
113
- },
114
- "download": {
115
- "anyOf": [
116
- {
117
- "type": "boolean",
118
- "description": "Set whether the video can be downloaded."
119
- },
120
- {
121
- "type": "null"
122
- }
123
- ]
124
- },
125
- "add": {
126
- "anyOf": [
127
- {
128
- "type": "boolean",
129
- "description": "Set whether other users can add the video to their collections."
130
- },
131
- {
132
- "type": "null"
133
- }
134
- ]
135
- }
136
- },
137
- "type": "object",
138
- "additionalProperties": false,
139
- "required": [
140
- "view",
141
- "embed",
142
- "comments",
143
- "download",
144
- "add"
145
- ]
146
- }
147
- }
148
- }
149
- }
@@ -1,90 +0,0 @@
1
- {
2
- "name": "VimeoDestinationPrivacyOptions",
3
- "strict": true,
4
- "schema": {
5
- "description": "Options to control the visibility of videos and privacy features.",
6
- "properties": {
7
- "view": {
8
- "anyOf": [
9
- {
10
- "type": "string",
11
- "description": "Set who can view the videos. Available options are: <ul>\n <li>`anybody` - Anyone can view the video.</li>\n <li>`nobody` - Only the video owner can view the video.</li>\n <li>`contacts` - Only contacts can view the video.</li>\n <li>`password` - A password is required to view the video.</li>\n <li>`unlisted` - The video is not listed on Vimeo.</li>\n</ul>",
12
- "enum": [
13
- "anybody",
14
- "nobody",
15
- "contacts",
16
- "password",
17
- "unlisted"
18
- ]
19
- },
20
- {
21
- "type": "null"
22
- }
23
- ]
24
- },
25
- "embed": {
26
- "anyOf": [
27
- {
28
- "type": "string",
29
- "description": "Set who can embed the video. Available options are: <ul>\n <li>`public` - Anyone can embed the video.</li>\n <li>`private` - Only the video owner can embed the video.</li>\n <li>`whitelist` - Only whitelisted domains can embed the video.</li>\n</ul>",
30
- "enum": [
31
- "public",
32
- "private",
33
- "whitelist"
34
- ]
35
- },
36
- {
37
- "type": "null"
38
- }
39
- ]
40
- },
41
- "comments": {
42
- "anyOf": [
43
- {
44
- "type": "string",
45
- "description": "Set who can comment on the video. Available options are: <ul>\n <li>`anybody` - Anyone can comment on the video.</li>\n <li>`nobody` - Only the video owner can comment on the video.</li>\n <li>`contacts` - Only contacts can comment on the video.</li>\n</ul>",
46
- "enum": [
47
- "anybody",
48
- "nobody",
49
- "contacts"
50
- ]
51
- },
52
- {
53
- "type": "null"
54
- }
55
- ]
56
- },
57
- "download": {
58
- "anyOf": [
59
- {
60
- "type": "boolean",
61
- "description": "Set whether the video can be downloaded."
62
- },
63
- {
64
- "type": "null"
65
- }
66
- ]
67
- },
68
- "add": {
69
- "anyOf": [
70
- {
71
- "type": "boolean",
72
- "description": "Set whether other users can add the video to their collections."
73
- },
74
- {
75
- "type": "null"
76
- }
77
- ]
78
- }
79
- },
80
- "type": "object",
81
- "additionalProperties": false,
82
- "required": [
83
- "view",
84
- "embed",
85
- "comments",
86
- "download",
87
- "add"
88
- ]
89
- }
90
- }