@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,18 +0,0 @@
1
- {
2
- "name": "Poster",
3
- "strict": true,
4
- "schema": {
5
- "description": "Generate a poster image for the video at a specific point from the timeline. The poster image size will match the size of the output video.",
6
- "properties": {
7
- "capture": {
8
- "description": "The point on the timeline in seconds to capture a single frame to use as the poster image.",
9
- "type": "number"
10
- }
11
- },
12
- "additionalProperties": false,
13
- "required": [
14
- "capture"
15
- ],
16
- "type": "object"
17
- }
18
- }
@@ -1,39 +0,0 @@
1
- {
2
- "name": "Range",
3
- "strict": true,
4
- "schema": {
5
- "description": "Specify a time range to render, i.e. to render only a portion of a video or audio file. Omit this setting to export the entire video. Range can also be used to render a frame at a specific time point - setting a range and output format as `jpg` will output a single frame image at the range `start` point.",
6
- "properties": {
7
- "start": {
8
- "anyOf": [
9
- {
10
- "type": "number",
11
- "description": "The point on the timeline, in seconds, to start the render from - i.e. start at second 3.",
12
- "minimum": 0
13
- },
14
- {
15
- "type": "null"
16
- }
17
- ]
18
- },
19
- "length": {
20
- "anyOf": [
21
- {
22
- "type": "number",
23
- "description": "The length of the portion of the video or audio to render - i.e. render 6 seconds of the video.",
24
- "minimum": 0
25
- },
26
- {
27
- "type": "null"
28
- }
29
- ]
30
- }
31
- },
32
- "additionalProperties": false,
33
- "type": "object",
34
- "required": [
35
- "start",
36
- "length"
37
- ]
38
- }
39
- }
@@ -1,106 +0,0 @@
1
- {
2
- "name": "RichCaptionActiveFont",
3
- "strict": true,
4
- "schema": {
5
- "description": "Font properties for the active/highlighted word.",
6
- "type": "object",
7
- "properties": {
8
- "family": {
9
- "anyOf": [
10
- {
11
- "type": "string",
12
- "description": "The font family for the active word. Inherits from the base font.family when not set."
13
- },
14
- {
15
- "type": "null"
16
- }
17
- ]
18
- },
19
- "weight": {
20
- "anyOf": [
21
- {
22
- "type": "string",
23
- "description": "The weight of the font for the active word. Can be a number (100-900) or a string. Inherits from the base font.weight when not set.\n"
24
- },
25
- {
26
- "type": "null"
27
- }
28
- ]
29
- },
30
- "color": {
31
- "anyOf": [
32
- {
33
- "type": "string",
34
- "description": "The active word color using hexadecimal color notation."
35
- },
36
- {
37
- "type": "null"
38
- }
39
- ]
40
- },
41
- "background": {
42
- "anyOf": [
43
- {
44
- "type": "string",
45
- "description": "The background color behind the active word using hexadecimal color notation."
46
- },
47
- {
48
- "type": "null"
49
- }
50
- ]
51
- },
52
- "opacity": {
53
- "anyOf": [
54
- {
55
- "type": "number",
56
- "description": "The opacity of the active word where 1 is opaque and 0 is transparent.",
57
- "minimum": 0,
58
- "maximum": 1
59
- },
60
- {
61
- "type": "null"
62
- }
63
- ]
64
- },
65
- "size": {
66
- "anyOf": [
67
- {
68
- "type": "number",
69
- "description": "The font size of the active word in pixels.",
70
- "minimum": 1,
71
- "maximum": 500
72
- },
73
- {
74
- "type": "null"
75
- }
76
- ]
77
- },
78
- "textDecoration": {
79
- "anyOf": [
80
- {
81
- "type": "string",
82
- "description": "Text decoration to apply to the active word.",
83
- "enum": [
84
- "none",
85
- "underline",
86
- "line-through"
87
- ]
88
- },
89
- {
90
- "type": "null"
91
- }
92
- ]
93
- }
94
- },
95
- "additionalProperties": false,
96
- "required": [
97
- "family",
98
- "weight",
99
- "color",
100
- "background",
101
- "opacity",
102
- "size",
103
- "textDecoration"
104
- ]
105
- }
106
- }
@@ -1,291 +0,0 @@
1
- {
2
- "name": "RichCaptionActive",
3
- "strict": true,
4
- "schema": {
5
- "description": "Styling properties for the active/highlighted word.",
6
- "type": "object",
7
- "properties": {
8
- "font": {
9
- "anyOf": [
10
- {
11
- "description": "Font properties for the active word.",
12
- "$ref": "#/$defs/RichCaptionActiveFont"
13
- },
14
- {
15
- "type": "null"
16
- }
17
- ]
18
- },
19
- "stroke": {
20
- "description": "Stroke properties for the active word. Set to \"none\" to explicitly remove the base stroke on the active word.",
21
- "anyOf": [
22
- {
23
- "$ref": "#/$defs/RichTextStroke"
24
- },
25
- {
26
- "type": "string",
27
- "enum": [
28
- "none"
29
- ]
30
- },
31
- {
32
- "type": "null"
33
- }
34
- ]
35
- },
36
- "shadow": {
37
- "description": "Shadow properties for the active word. Set to \"none\" to explicitly remove the base shadow on the active word.",
38
- "anyOf": [
39
- {
40
- "$ref": "#/$defs/RichTextShadow"
41
- },
42
- {
43
- "type": "string",
44
- "enum": [
45
- "none"
46
- ]
47
- },
48
- {
49
- "type": "null"
50
- }
51
- ]
52
- }
53
- },
54
- "additionalProperties": false,
55
- "required": [
56
- "font",
57
- "stroke",
58
- "shadow"
59
- ],
60
- "$defs": {
61
- "RichCaptionActiveFont": {
62
- "description": "Font properties for the active/highlighted word.",
63
- "type": "object",
64
- "properties": {
65
- "family": {
66
- "anyOf": [
67
- {
68
- "type": "string",
69
- "description": "The font family for the active word. Inherits from the base font.family when not set."
70
- },
71
- {
72
- "type": "null"
73
- }
74
- ]
75
- },
76
- "weight": {
77
- "anyOf": [
78
- {
79
- "type": "string",
80
- "description": "The weight of the font for the active word. Can be a number (100-900) or a string. Inherits from the base font.weight when not set.\n"
81
- },
82
- {
83
- "type": "null"
84
- }
85
- ]
86
- },
87
- "color": {
88
- "anyOf": [
89
- {
90
- "type": "string",
91
- "description": "The active word color using hexadecimal color notation."
92
- },
93
- {
94
- "type": "null"
95
- }
96
- ]
97
- },
98
- "background": {
99
- "anyOf": [
100
- {
101
- "type": "string",
102
- "description": "The background color behind the active word using hexadecimal color notation."
103
- },
104
- {
105
- "type": "null"
106
- }
107
- ]
108
- },
109
- "opacity": {
110
- "anyOf": [
111
- {
112
- "type": "number",
113
- "description": "The opacity of the active word where 1 is opaque and 0 is transparent.",
114
- "minimum": 0,
115
- "maximum": 1
116
- },
117
- {
118
- "type": "null"
119
- }
120
- ]
121
- },
122
- "size": {
123
- "anyOf": [
124
- {
125
- "type": "number",
126
- "description": "The font size of the active word in pixels.",
127
- "minimum": 1,
128
- "maximum": 500
129
- },
130
- {
131
- "type": "null"
132
- }
133
- ]
134
- },
135
- "textDecoration": {
136
- "anyOf": [
137
- {
138
- "type": "string",
139
- "description": "Text decoration to apply to the active word.",
140
- "enum": [
141
- "none",
142
- "underline",
143
- "line-through"
144
- ]
145
- },
146
- {
147
- "type": "null"
148
- }
149
- ]
150
- }
151
- },
152
- "additionalProperties": false,
153
- "required": [
154
- "family",
155
- "weight",
156
- "color",
157
- "background",
158
- "opacity",
159
- "size",
160
- "textDecoration"
161
- ]
162
- },
163
- "RichTextStroke": {
164
- "description": "Text stroke (outline) properties.",
165
- "properties": {
166
- "width": {
167
- "anyOf": [
168
- {
169
- "type": "number",
170
- "description": "The width of the stroke in pixels. Must be 0 or greater.",
171
- "minimum": 0
172
- },
173
- {
174
- "type": "null"
175
- }
176
- ]
177
- },
178
- "color": {
179
- "anyOf": [
180
- {
181
- "type": "string",
182
- "description": "The stroke color using hexadecimal color notation.",
183
- "enum": [
184
- "#000000"
185
- ]
186
- },
187
- {
188
- "type": "null"
189
- }
190
- ]
191
- },
192
- "opacity": {
193
- "anyOf": [
194
- {
195
- "type": "number",
196
- "description": "The opacity of the stroke where 1 is opaque and 0 is transparent.",
197
- "minimum": 0,
198
- "maximum": 1
199
- },
200
- {
201
- "type": "null"
202
- }
203
- ]
204
- }
205
- },
206
- "additionalProperties": false,
207
- "type": "object",
208
- "required": [
209
- "width",
210
- "color",
211
- "opacity"
212
- ]
213
- },
214
- "RichTextShadow": {
215
- "description": "Text shadow properties.",
216
- "properties": {
217
- "offsetX": {
218
- "anyOf": [
219
- {
220
- "type": "number",
221
- "description": "Horizontal offset of the shadow in pixels. Positive values move right, negative left."
222
- },
223
- {
224
- "type": "null"
225
- }
226
- ]
227
- },
228
- "offsetY": {
229
- "anyOf": [
230
- {
231
- "type": "number",
232
- "description": "Vertical offset of the shadow in pixels. Positive values move down, negative up."
233
- },
234
- {
235
- "type": "null"
236
- }
237
- ]
238
- },
239
- "blur": {
240
- "anyOf": [
241
- {
242
- "type": "number",
243
- "description": "The blur radius of the shadow in pixels. Must be 0 or greater.",
244
- "minimum": 0
245
- },
246
- {
247
- "type": "null"
248
- }
249
- ]
250
- },
251
- "color": {
252
- "anyOf": [
253
- {
254
- "type": "string",
255
- "description": "The shadow color using hexadecimal color notation.",
256
- "enum": [
257
- "#000000"
258
- ]
259
- },
260
- {
261
- "type": "null"
262
- }
263
- ]
264
- },
265
- "opacity": {
266
- "anyOf": [
267
- {
268
- "type": "number",
269
- "description": "The opacity of the shadow where 1 is opaque and 0 is transparent.",
270
- "minimum": 0,
271
- "maximum": 1
272
- },
273
- {
274
- "type": "null"
275
- }
276
- ]
277
- }
278
- },
279
- "additionalProperties": false,
280
- "type": "object",
281
- "required": [
282
- "offsetX",
283
- "offsetY",
284
- "blur",
285
- "color",
286
- "opacity"
287
- ]
288
- }
289
- }
290
- }
291
- }
@@ -1,46 +0,0 @@
1
- {
2
- "name": "RichCaptionAnimation",
3
- "strict": true,
4
- "schema": {
5
- "description": "Word-level animation properties for caption effects.",
6
- "type": "object",
7
- "properties": {
8
- "style": {
9
- "description": "The animation style to apply to words: <ul>\n <li>`karaoke` - Word-by-word color fill as spoken (shows all words, highlights active)</li>\n <li>`highlight` - Word changes to active color when spoken (shows all words)</li>\n <li>`pop` - Each word scales up when active</li>\n <li>`fade` - Gradual opacity transition per word</li>\n <li>`slide` - Words slide in from a direction</li>\n <li>`bounce` - Spring animation on word appearance</li>\n <li>`typewriter` - Words appear one by one and stay visible</li>\n <li>`none` - No animation, all words visible immediately</li>\n</ul>",
10
- "type": "string",
11
- "enum": [
12
- "karaoke",
13
- "highlight",
14
- "pop",
15
- "fade",
16
- "slide",
17
- "bounce",
18
- "typewriter",
19
- "none"
20
- ]
21
- },
22
- "direction": {
23
- "anyOf": [
24
- {
25
- "type": "string",
26
- "description": "Direction for directional animations (slide). Only applicable when style is `slide`.",
27
- "enum": [
28
- "left",
29
- "right",
30
- "up",
31
- "down"
32
- ]
33
- },
34
- {
35
- "type": "null"
36
- }
37
- ]
38
- }
39
- },
40
- "additionalProperties": false,
41
- "required": [
42
- "style",
43
- "direction"
44
- ]
45
- }
46
- }