@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,128 +0,0 @@
1
- {
2
- "name": "TextToImageAsset",
3
- "strict": true,
4
- "schema": {
5
- "description": "**Notice: TextToImageAsset is deprecated. Use [ImageAsset](#tocs_imageasset)\nwith `prompt` instead.** This type continues to function and is internally\nrewritten to ImageAsset; no behaviour change for existing integrations.\n\nThe TextToImageAsset lets you create a dynamic image from a text prompt.\n",
6
- "properties": {
7
- "type": {
8
- "type": "string",
9
- "description": "The type of asset to generate - set to `text-to-image` for text-to-image.",
10
- "enum": [
11
- "text-to-image"
12
- ]
13
- },
14
- "prompt": {
15
- "type": "string",
16
- "description": "The text prompt to generate an image from."
17
- },
18
- "width": {
19
- "anyOf": [
20
- {
21
- "type": "integer",
22
- "description": "The width of the image in pixels."
23
- },
24
- {
25
- "type": "null"
26
- }
27
- ]
28
- },
29
- "height": {
30
- "anyOf": [
31
- {
32
- "type": "integer",
33
- "description": "The height of the image in pixels."
34
- },
35
- {
36
- "type": "null"
37
- }
38
- ]
39
- },
40
- "crop": {
41
- "anyOf": [
42
- {
43
- "$ref": "#/$defs/Crop"
44
- },
45
- {
46
- "type": "null"
47
- }
48
- ]
49
- }
50
- },
51
- "additionalProperties": false,
52
- "type": "object",
53
- "required": [
54
- "type",
55
- "prompt",
56
- "width",
57
- "height",
58
- "crop"
59
- ],
60
- "$defs": {
61
- "Crop": {
62
- "description": "Crop the sides of an asset by a relative amount. The size of the crop is specified using a scale between 0 and 1, relative to the screen width - i.e a left crop of 0.5 will crop half of the asset from the left, a top crop of 0.25 will crop the top by quarter of the asset.",
63
- "properties": {
64
- "top": {
65
- "anyOf": [
66
- {
67
- "type": "number",
68
- "description": "Crop from the top of the asset",
69
- "minimum": 0,
70
- "maximum": 1
71
- },
72
- {
73
- "type": "null"
74
- }
75
- ]
76
- },
77
- "bottom": {
78
- "anyOf": [
79
- {
80
- "type": "number",
81
- "description": "Crop from the bottom of the asset",
82
- "minimum": 0,
83
- "maximum": 1
84
- },
85
- {
86
- "type": "null"
87
- }
88
- ]
89
- },
90
- "left": {
91
- "anyOf": [
92
- {
93
- "type": "number",
94
- "description": "Crop from the left of the asset",
95
- "minimum": 0,
96
- "maximum": 1
97
- },
98
- {
99
- "type": "null"
100
- }
101
- ]
102
- },
103
- "right": {
104
- "anyOf": [
105
- {
106
- "type": "number",
107
- "description": "Crop from the left of the asset",
108
- "minimum": 0,
109
- "maximum": 1
110
- },
111
- {
112
- "type": "null"
113
- }
114
- ]
115
- }
116
- },
117
- "additionalProperties": false,
118
- "type": "object",
119
- "required": [
120
- "top",
121
- "bottom",
122
- "left",
123
- "right"
124
- ]
125
- }
126
- }
127
- }
128
- }
@@ -1,239 +0,0 @@
1
- {
2
- "name": "TextToSpeechAsset",
3
- "strict": true,
4
- "schema": {
5
- "description": "**Notice: TextToSpeechAsset is deprecated. Use [AudioAsset](#tocs_audioasset)\nwith `prompt` (the spoken text) and `voice` instead.** This type continues to\nfunction and is internally rewritten to AudioAsset; no behaviour change for\nexisting integrations.\n\nThe TextToSpeechAsset lets you generate a voice over from text using a text-to-speech service.\nThe generated audio can be trimmed, faded and have its volume and speed adjusted using the\nsame properties availabl...",
6
- "type": "object",
7
- "properties": {
8
- "type": {
9
- "type": "string",
10
- "description": "The type of asset - set to `text-to-speech` for text-to-s...",
11
- "enum": [
12
- "text-to-speech"
13
- ]
14
- },
15
- "text": {
16
- "type": "string",
17
- "description": "The text to convert to sp..."
18
- },
19
- "voice": {
20
- "type": "string",
21
- "description": "The voice to use for the text-to-speech conver..."
22
- },
23
- "language": {
24
- "anyOf": [
25
- {
26
- "type": "string",
27
- "description": "The language code for the text-to-speech conver..."
28
- },
29
- {
30
- "type": "null"
31
- }
32
- ]
33
- },
34
- "newscaster": {
35
- "anyOf": [
36
- {
37
- "type": "boolean",
38
- "description": "Set the voice to newscaster ..."
39
- },
40
- {
41
- "type": "null"
42
- }
43
- ]
44
- },
45
- "trim": {
46
- "anyOf": [
47
- {
48
- "type": "number",
49
- "description": "The start trim point of the audio clip, in seconds (defaults to 0). Audio will start from the trim point. The audio will play until the file ends or the Clip length i..."
50
- },
51
- {
52
- "type": "null"
53
- }
54
- ]
55
- },
56
- "volume": {
57
- "description": "Set the volume of the audio clip. Use a number or an array of [Tween](./#tocs_tween) objects to create custom volume tran...",
58
- "anyOf": [
59
- {
60
- "type": "number",
61
- "description": "The volume level for the audio clip. Range varies from 0 to 1 where 0 is muted and 1 is full volume (default...",
62
- "minimum": 0,
63
- "maximum": 1
64
- },
65
- {
66
- "type": "array",
67
- "description": "An array of [Tween](./#tocs_tween) objects used to create a custom volume effect. Modify the volume of an asset ov...",
68
- "items": {
69
- "$ref": "#/$defs/Tween"
70
- }
71
- },
72
- {
73
- "type": "null"
74
- }
75
- ]
76
- },
77
- "speed": {
78
- "anyOf": [
79
- {
80
- "type": "number",
81
- "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 ...",
82
- "minimum": 0,
83
- "maximum": 10
84
- },
85
- {
86
- "type": "null"
87
- }
88
- ]
89
- },
90
- "effect": {
91
- "anyOf": [
92
- {
93
- "type": "string",
94
- "description": "The effect to apply to the audio asset <ul>\n <li>`fadeIn` - fade volume in only</li>\n <li>`fadeOut` - fade volume out only</li>\n <li>`fadeInFadeOut` - fade volume in and out<...",
95
- "enum": [
96
- "none",
97
- "fadeIn",
98
- "fadeOut",
99
- "fadeInFadeOut"
100
- ]
101
- },
102
- {
103
- "type": "null"
104
- }
105
- ]
106
- }
107
- },
108
- "additionalProperties": false,
109
- "required": [
110
- "type",
111
- "text",
112
- "voice",
113
- "language",
114
- "newscaster",
115
- "trim",
116
- "volume",
117
- "speed",
118
- "effect"
119
- ],
120
- "$defs": {
121
- "Tween": {
122
- "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 the x and y position of a clip.</li>\n <li>Rotation - animate the rotation of a clip.</li>\n <li>Skew - animate the horizontal and vertical shearing effect.</li>\n <li>Volume - animate the audio volume of...",
123
- "properties": {
124
- "from": {
125
- "anyOf": [
126
- {
127
- "type": "string",
128
- "description": "The initial property value at the start of the anim..."
129
- },
130
- {
131
- "type": "null"
132
- }
133
- ]
134
- },
135
- "to": {
136
- "anyOf": [
137
- {
138
- "type": "string",
139
- "description": "The final property value at the end of the anima..."
140
- },
141
- {
142
- "type": "null"
143
- }
144
- ]
145
- },
146
- "start": {
147
- "anyOf": [
148
- {
149
- "type": "number",
150
- "description": "The time in seconds when the animation starts, relative to the clip, not the ti..."
151
- },
152
- {
153
- "type": "null"
154
- }
155
- ]
156
- },
157
- "length": {
158
- "anyOf": [
159
- {
160
- "type": "number",
161
- "description": "The duration of the animation in sec..."
162
- },
163
- {
164
- "type": "null"
165
- }
166
- ]
167
- },
168
- "interpolation": {
169
- "anyOf": [
170
- {
171
- "type": "string",
172
- "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 between the start and end values.</li>\n <li>`constant` - an interpolation where the property instantly jumps from the start to the end value, without any gradual trans...",
173
- "enum": [
174
- "linear",
175
- "bezier",
176
- "constant"
177
- ]
178
- },
179
- {
180
- "type": "null"
181
- }
182
- ]
183
- },
184
- "easing": {
185
- "anyOf": [
186
- {
187
- "type": "string",
188
- "description": "The easing function to use for the animation. Easing controls the rate of change of the animated value, allowing for more natural motion by speeding up or slowing down the animation at different points. Only applicable if interpolation is set...",
189
- "enum": [
190
- "ease",
191
- "easeIn",
192
- "easeOut",
193
- "easeInOut",
194
- "easeInQuad",
195
- "easeInCubic",
196
- "easeInQuart",
197
- "easeInQuint",
198
- "easeInSine",
199
- "easeInExpo",
200
- "easeInCirc",
201
- "easeInBack",
202
- "easeOutQuad",
203
- "easeOutCubic",
204
- "easeOutQuart",
205
- "easeOutQuint",
206
- "easeOutSine",
207
- "easeOutExpo",
208
- "easeOutCirc",
209
- "easeOutBack",
210
- "easeInOutQuad",
211
- "easeInOutCubic",
212
- "easeInOutQuart",
213
- "easeInOutQuint",
214
- "easeInOutSine",
215
- "easeInOutExpo",
216
- "easeInOutCirc",
217
- "easeInOutBack"
218
- ]
219
- },
220
- {
221
- "type": "null"
222
- }
223
- ]
224
- }
225
- },
226
- "additionalProperties": false,
227
- "type": "object",
228
- "required": [
229
- "from",
230
- "to",
231
- "start",
232
- "length",
233
- "interpolation",
234
- "easing"
235
- ]
236
- }
237
- }
238
- }
239
- }
@@ -1,25 +0,0 @@
1
- {
2
- "name": "Thumbnail",
3
- "strict": true,
4
- "schema": {
5
- "description": "Generate a thumbnail image for the video or image at a specific point from the timeline.",
6
- "properties": {
7
- "capture": {
8
- "description": "The point on the timeline in seconds to capture a single frame to use as the thumbnail image.",
9
- "type": "number"
10
- },
11
- "scale": {
12
- "description": "Scale the thumbnail size to a fraction of the viewport size - i.e. setting the scale to 0.5 will scale the thumbnail to half the size of the viewport.",
13
- "type": "number",
14
- "minimum": 0,
15
- "maximum": 1
16
- }
17
- },
18
- "additionalProperties": false,
19
- "required": [
20
- "capture",
21
- "scale"
22
- ],
23
- "type": "object"
24
- }
25
- }