@shotstack/schemas 1.14.1 → 1.15.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.
Files changed (75) hide show
  1. package/dist/api.bundled.json +8 -5
  2. package/dist/json-schema/edit.json +3823 -4207
  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 +1 -8
  6. package/dist/schema.d.ts +16 -5
  7. package/dist/zod/zod.gen.cjs +10 -2
  8. package/dist/zod/zod.gen.d.ts +10 -2
  9. package/dist/zod/zod.gen.js +10 -2
  10. package/dist/zod/zod.gen.ts +10 -2
  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 -613
  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 -37
  29. package/dist/json-schema/google-drive-destination.json +0 -68
  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 -907
  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 -4730
  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,315 +0,0 @@
1
- {
2
- "name": "AudioAsset",
3
- "strict": true,
4
- "schema": {
5
- "description": "The AudioAsset adds audio to a Clip. The audio can be sourced from a URL\n(`src`) or generated from a text prompt (`prompt`). Exactly one of `src` or\n`prompt` must be provided.\n\n- **Source URL:** set `src` to a publicly accessible audio URL (e.g. mp3).\n- **Generated speech:** set `prompt` to the spoken t...",
6
- "type": "object",
7
- "properties": {
8
- "type": {
9
- "enum": [
10
- "audio"
11
- ],
12
- "description": "The type of asset - set t...",
13
- "type": "string"
14
- },
15
- "src": {
16
- "anyOf": [
17
- {
18
- "type": "string",
19
- "description": "The audio source URL. The URL must be publicly accessible or inc..."
20
- },
21
- {
22
- "type": "null"
23
- }
24
- ]
25
- },
26
- "prompt": {
27
- "anyOf": [
28
- {
29
- "type": "string",
30
- "description": "A text prompt. When `voice` is set, the prompt is the spoken text (text-to-speech). Without `voice`, the p..."
31
- },
32
- {
33
- "type": "null"
34
- }
35
- ]
36
- },
37
- "voice": {
38
- "anyOf": [
39
- {
40
- "type": "string",
41
- "description": "Voice identifier for text-to-speech generation (e.g. `Mat..."
42
- },
43
- {
44
- "type": "null"
45
- }
46
- ]
47
- },
48
- "language": {
49
- "anyOf": [
50
- {
51
- "type": "string",
52
- "description": "Optional BCP-47 language code (e.g. `en-US`) for text-to-sp..."
53
- },
54
- {
55
- "type": "null"
56
- }
57
- ]
58
- },
59
- "newscaster": {
60
- "anyOf": [
61
- {
62
- "type": "boolean",
63
- "description": "Set to `true` to use the voice's newscaster mode when suppo..."
64
- },
65
- {
66
- "type": "null"
67
- }
68
- ]
69
- },
70
- "model": {
71
- "anyOf": [
72
- {
73
- "type": "string",
74
- "description": "The generation model to use when `prompt` is set (e.g. `polly-neural`, `fal/elevenlabs-tts`, `fal/minim..."
75
- },
76
- {
77
- "type": "null"
78
- }
79
- ]
80
- },
81
- "musicLengthMs": {
82
- "anyOf": [
83
- {
84
- "type": "number",
85
- "description": "Target duration in milliseconds for generated music (3,000–600,000). Only meaningful when...",
86
- "minimum": 3000,
87
- "maximum": 600000
88
- },
89
- {
90
- "type": "null"
91
- }
92
- ]
93
- },
94
- "forceInstrumental": {
95
- "anyOf": [
96
- {
97
- "type": "boolean",
98
- "description": "Set to `true` to force instrumental music (no voca..."
99
- },
100
- {
101
- "type": "null"
102
- }
103
- ]
104
- },
105
- "compositionPlan": {
106
- "anyOf": [
107
- {
108
- "type": "string",
109
- "description": "An optional structured composition plan for music generation. Only mea..."
110
- },
111
- {
112
- "type": "null"
113
- }
114
- ]
115
- },
116
- "trim": {
117
- "anyOf": [
118
- {
119
- "type": "number",
120
- "description": "The start trim point of the audio clip, in seconds (defaults to 0). Audio will start from the..."
121
- },
122
- {
123
- "type": "null"
124
- }
125
- ]
126
- },
127
- "volume": {
128
- "description": "Set the volume of the audio clip. Use a number or an array of [Twe...",
129
- "anyOf": [
130
- {
131
- "type": "number",
132
- "description": "The volume level for the audio clip. Range varies from 0 to...",
133
- "minimum": 0,
134
- "maximum": 1
135
- },
136
- {
137
- "type": "array",
138
- "description": "An array of [Tween](./#tocs_tween) objects used to create a cu...",
139
- "items": {
140
- "$ref": "#/$defs/Tween"
141
- }
142
- },
143
- {
144
- "type": "null"
145
- }
146
- ]
147
- },
148
- "speed": {
149
- "anyOf": [
150
- {
151
- "type": "number",
152
- "description": "Adjust the playback speed of the audio clip between 0 (paused) and 10 (10x normal speed), where 1 is normal speed (defaults to 1). Adjusting the speed will also adjust the duration of the clip and may require you to adjust the Clip length. For example, if ...",
153
- "minimum": 0,
154
- "maximum": 10
155
- },
156
- {
157
- "type": "null"
158
- }
159
- ]
160
- },
161
- "effect": {
162
- "anyOf": [
163
- {
164
- "type": "string",
165
- "description": "The effect to apply to the audio asset <ul>\n <li>`fadeIn` - fade volume in only</li>\n <li>`fade...",
166
- "enum": [
167
- "none",
168
- "fadeIn",
169
- "fadeOut",
170
- "fadeInFadeOut"
171
- ]
172
- },
173
- {
174
- "type": "null"
175
- }
176
- ]
177
- }
178
- },
179
- "additionalProperties": false,
180
- "required": [
181
- "type",
182
- "src",
183
- "prompt",
184
- "voice",
185
- "language",
186
- "newscaster",
187
- "model",
188
- "musicLengthMs",
189
- "forceInstrumental",
190
- "compositionPlan",
191
- "trim",
192
- "volume",
193
- "speed",
194
- "effect"
195
- ],
196
- "$defs": {
197
- "Tween": {
198
- "description": "Use a Tween to [animate properties over time](/docs/guide/architecting-an-application/animations/). The following properties are currently supported and can be animated:\n <ul>\n <li>Opacity - animate the transparency of a clip.</li>\n <li>Offset - animate t...",
199
- "properties": {
200
- "from": {
201
- "anyOf": [
202
- {
203
- "type": "string",
204
- "description": "The initial property value ..."
205
- },
206
- {
207
- "type": "null"
208
- }
209
- ]
210
- },
211
- "to": {
212
- "anyOf": [
213
- {
214
- "type": "string",
215
- "description": "The final property value ..."
216
- },
217
- {
218
- "type": "null"
219
- }
220
- ]
221
- },
222
- "start": {
223
- "anyOf": [
224
- {
225
- "type": "number",
226
- "description": "The time in seconds when the animation star..."
227
- },
228
- {
229
- "type": "null"
230
- }
231
- ]
232
- },
233
- "length": {
234
- "anyOf": [
235
- {
236
- "type": "number",
237
- "description": "The duration of the..."
238
- },
239
- {
240
- "type": "null"
241
- }
242
- ]
243
- },
244
- "interpolation": {
245
- "anyOf": [
246
- {
247
- "type": "string",
248
- "description": "The interpolation method to use for the animation. Available options are: <ul>\n <li>`linear` - a linear interpolation between the start and end values.</li>\n <li>`bezier` - a bezier curve interpolation be...",
249
- "enum": [
250
- "linear",
251
- "bezier",
252
- "constant"
253
- ]
254
- },
255
- {
256
- "type": "null"
257
- }
258
- ]
259
- },
260
- "easing": {
261
- "anyOf": [
262
- {
263
- "type": "string",
264
- "description": "The easing function to use for the animation. Easing controls the rate of change of the animated value, allowing for more natural moti...",
265
- "enum": [
266
- "ease",
267
- "easeIn",
268
- "easeOut",
269
- "easeInOut",
270
- "easeInQuad",
271
- "easeInCubic",
272
- "easeInQuart",
273
- "easeInQuint",
274
- "easeInSine",
275
- "easeInExpo",
276
- "easeInCirc",
277
- "easeInBack",
278
- "easeOutQuad",
279
- "easeOutCubic",
280
- "easeOutQuart",
281
- "easeOutQuint",
282
- "easeOutSine",
283
- "easeOutExpo",
284
- "easeOutCirc",
285
- "easeOutBack",
286
- "easeInOutQuad",
287
- "easeInOutCubic",
288
- "easeInOutQuart",
289
- "easeInOutQuint",
290
- "easeInOutSine",
291
- "easeInOutExpo",
292
- "easeInOutCirc",
293
- "easeInOutBack"
294
- ]
295
- },
296
- {
297
- "type": "null"
298
- }
299
- ]
300
- }
301
- },
302
- "additionalProperties": false,
303
- "type": "object",
304
- "required": [
305
- "from",
306
- "to",
307
- "start",
308
- "length",
309
- "interpolation",
310
- "easing"
311
- ]
312
- }
313
- }
314
- }
315
- }
@@ -1,380 +0,0 @@
1
- {
2
- "name": "Blueprint",
3
- "strict": true,
4
- "schema": {
5
- "type": "object",
6
- "properties": {
7
- "output": {
8
- "$ref": "#/$defs/Output"
9
- },
10
- "merge": {
11
- "anyOf": [
12
- {
13
- "type": "array",
14
- "items": {
15
- "$ref": "#/$defs/MergeField"
16
- }
17
- },
18
- {
19
- "type": "null"
20
- }
21
- ]
22
- },
23
- "timeline": {
24
- "type": "object",
25
- "properties": {
26
- "tracks": {
27
- "type": "array",
28
- "items": {
29
- "type": "object",
30
- "properties": {
31
- "clips": {
32
- "type": "array",
33
- "items": {
34
- "$ref": "#/$defs/BlueprintClip"
35
- }
36
- }
37
- },
38
- "additionalProperties": false,
39
- "required": [
40
- "clips"
41
- ]
42
- }
43
- }
44
- },
45
- "additionalProperties": false,
46
- "required": [
47
- "tracks"
48
- ]
49
- }
50
- },
51
- "additionalProperties": false,
52
- "required": [
53
- "output",
54
- "merge",
55
- "timeline"
56
- ],
57
- "$defs": {
58
- "BlueprintClip": {
59
- "type": "object",
60
- "properties": {
61
- "asset": {
62
- "type": "string",
63
- "enum": [
64
- "video",
65
- "image",
66
- "audio",
67
- "rich-text",
68
- "svg",
69
- "caption"
70
- ]
71
- },
72
- "start": {
73
- "anyOf": [
74
- {
75
- "type": "number",
76
- "minimum": 0
77
- },
78
- {
79
- "type": "string"
80
- }
81
- ]
82
- },
83
- "length": {
84
- "anyOf": [
85
- {
86
- "type": "number",
87
- "minimum": 0
88
- },
89
- {
90
- "type": "string"
91
- }
92
- ]
93
- },
94
- "fit": {
95
- "anyOf": [
96
- {
97
- "type": "string",
98
- "enum": [
99
- "cover",
100
- "contain",
101
- "crop",
102
- "none"
103
- ]
104
- },
105
- {
106
- "type": "null"
107
- }
108
- ]
109
- },
110
- "position": {
111
- "anyOf": [
112
- {
113
- "type": "string",
114
- "enum": [
115
- "top",
116
- "topRight",
117
- "right",
118
- "bottomRight",
119
- "bottom",
120
- "bottomLeft",
121
- "left",
122
- "topLeft",
123
- "center"
124
- ]
125
- },
126
- {
127
- "type": "null"
128
- }
129
- ]
130
- },
131
- "transition": {
132
- "anyOf": [
133
- {
134
- "$ref": "#/$defs/Transition"
135
- },
136
- {
137
- "type": "null"
138
- }
139
- ]
140
- },
141
- "effect": {
142
- "anyOf": [
143
- {
144
- "type": "string"
145
- },
146
- {
147
- "type": "null"
148
- }
149
- ]
150
- },
151
- "mergeField": {
152
- "anyOf": [
153
- {
154
- "type": "string"
155
- },
156
- {
157
- "type": "null"
158
- }
159
- ]
160
- },
161
- "textHint": {
162
- "anyOf": [
163
- {
164
- "type": "string"
165
- },
166
- {
167
- "type": "null"
168
- }
169
- ]
170
- }
171
- },
172
- "additionalProperties": false,
173
- "required": [
174
- "asset",
175
- "start",
176
- "length",
177
- "fit",
178
- "position",
179
- "transition",
180
- "effect",
181
- "mergeField",
182
- "textHint"
183
- ]
184
- },
185
- "Transition": {
186
- "properties": {
187
- "in": {
188
- "anyOf": [
189
- {
190
- "type": "string",
191
- "enum": [
192
- "none",
193
- "fade",
194
- "reveal",
195
- "wipeLeft",
196
- "wipeRight",
197
- "slideLeft",
198
- "slideRight",
199
- "slideUp",
200
- "slideDown",
201
- "carouselLeft",
202
- "carouselRight",
203
- "carouselUp",
204
- "carouselDown",
205
- "shuffleTopRight",
206
- "shuffleRightTop",
207
- "shuffleRightBottom",
208
- "shuffleBottomRight",
209
- "shuffleBottomLeft",
210
- "shuffleLeftBottom",
211
- "shuffleLeftTop",
212
- "shuffleTopLeft",
213
- "zoom"
214
- ]
215
- },
216
- {
217
- "type": "null"
218
- }
219
- ]
220
- },
221
- "out": {
222
- "anyOf": [
223
- {
224
- "type": "string",
225
- "enum": [
226
- "none",
227
- "fade",
228
- "reveal",
229
- "wipeLeft",
230
- "wipeRight",
231
- "slideLeft",
232
- "slideRight",
233
- "slideUp",
234
- "slideDown",
235
- "carouselLeft",
236
- "carouselRight",
237
- "carouselUp",
238
- "carouselDown",
239
- "shuffleTopRight",
240
- "shuffleRightTop",
241
- "shuffleRightBottom",
242
- "shuffleBottomRight",
243
- "shuffleBottomLeft",
244
- "shuffleLeftBottom",
245
- "shuffleLeftTop",
246
- "shuffleTopLeft",
247
- "zoom"
248
- ]
249
- },
250
- {
251
- "type": "null"
252
- }
253
- ]
254
- }
255
- },
256
- "additionalProperties": false,
257
- "type": "object",
258
- "required": [
259
- "in",
260
- "out"
261
- ]
262
- },
263
- "Output": {
264
- "properties": {
265
- "format": {
266
- "enum": [
267
- "mp4",
268
- "gif",
269
- "mp3",
270
- "jpg",
271
- "png",
272
- "bmp"
273
- ],
274
- "type": "string"
275
- },
276
- "resolution": {
277
- "anyOf": [
278
- {
279
- "type": "string",
280
- "enum": [
281
- "preview",
282
- "mobile",
283
- "sd",
284
- "hd",
285
- "1080",
286
- "4k"
287
- ]
288
- },
289
- {
290
- "type": "null"
291
- }
292
- ]
293
- },
294
- "aspectRatio": {
295
- "anyOf": [
296
- {
297
- "type": "string",
298
- "enum": [
299
- "16:9",
300
- "9:16",
301
- "1:1",
302
- "4:5",
303
- "4:3"
304
- ]
305
- },
306
- {
307
- "type": "null"
308
- }
309
- ]
310
- },
311
- "fps": {
312
- "anyOf": [
313
- {
314
- "type": "number",
315
- "enum": [
316
- 12,
317
- 15,
318
- 23.976,
319
- 24,
320
- 25,
321
- 29.97,
322
- 30,
323
- 48,
324
- 50,
325
- 59.94,
326
- 60
327
- ]
328
- },
329
- {
330
- "type": "null"
331
- }
332
- ]
333
- },
334
- "quality": {
335
- "anyOf": [
336
- {
337
- "type": "string",
338
- "enum": [
339
- "verylow",
340
- "low",
341
- "medium",
342
- "high",
343
- "veryhigh"
344
- ]
345
- },
346
- {
347
- "type": "null"
348
- }
349
- ]
350
- }
351
- },
352
- "additionalProperties": false,
353
- "required": [
354
- "format",
355
- "resolution",
356
- "aspectRatio",
357
- "fps",
358
- "quality"
359
- ],
360
- "type": "object"
361
- },
362
- "MergeField": {
363
- "type": "object",
364
- "properties": {
365
- "find": {
366
- "type": "string"
367
- },
368
- "replace": {
369
- "type": "string"
370
- }
371
- },
372
- "additionalProperties": false,
373
- "required": [
374
- "find",
375
- "replace"
376
- ]
377
- }
378
- }
379
- }
380
- }