@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,225 +0,0 @@
1
- {
2
- "name": "ShapeAsset",
3
- "strict": true,
4
- "schema": {
5
- "description": "The ShapeAsset is used to add shapes to a video. The shape can be styled with a fill and a stroke.\nYou can manipulate properties such as rotation to create dynamic effects like a diamond shape or stripes.\n",
6
- "type": "object",
7
- "properties": {
8
- "type": {
9
- "enum": [
10
- "shape"
11
- ],
12
- "description": "The type of asset - set to `shape` for shape.",
13
- "type": "string"
14
- },
15
- "shape": {
16
- "description": "The shape to display.",
17
- "type": "string",
18
- "enum": [
19
- "rectangle",
20
- "circle",
21
- "line"
22
- ]
23
- },
24
- "width": {
25
- "anyOf": [
26
- {
27
- "type": "integer",
28
- "description": "Sets the width of the bounding box in pixels. This value should be larger than the shape's width. If omitted, the entire viewport width and height will be used."
29
- },
30
- {
31
- "type": "null"
32
- }
33
- ]
34
- },
35
- "height": {
36
- "anyOf": [
37
- {
38
- "type": "integer",
39
- "description": "Sets the height of the bounding box in pixels. This value should be larger than the shape's height. If omitted, the entire viewport width and height will be used."
40
- },
41
- {
42
- "type": "null"
43
- }
44
- ]
45
- },
46
- "fill": {
47
- "anyOf": [
48
- {
49
- "type": "object",
50
- "description": "Specifies the fill style of the shape.",
51
- "properties": {
52
- "color": {
53
- "anyOf": [
54
- {
55
- "type": "string",
56
- "description": "The color of the fill using hexadecimal color notation."
57
- },
58
- {
59
- "type": "null"
60
- }
61
- ]
62
- },
63
- "opacity": {
64
- "anyOf": [
65
- {
66
- "type": "number",
67
- "description": "The opacity of the fill where 1 is opaque and 0 is transparent."
68
- },
69
- {
70
- "type": "null"
71
- }
72
- ]
73
- }
74
- },
75
- "additionalProperties": false,
76
- "required": [
77
- "color",
78
- "opacity"
79
- ]
80
- },
81
- {
82
- "type": "null"
83
- }
84
- ]
85
- },
86
- "stroke": {
87
- "anyOf": [
88
- {
89
- "type": "object",
90
- "description": "Specifies the stroke style of the shape.",
91
- "properties": {
92
- "color": {
93
- "anyOf": [
94
- {
95
- "type": "string",
96
- "description": "The stroke color of the font using hexadecimal color notation."
97
- },
98
- {
99
- "type": "null"
100
- }
101
- ]
102
- },
103
- "width": {
104
- "anyOf": [
105
- {
106
- "type": "number",
107
- "description": "The width of the stroke in pixels."
108
- },
109
- {
110
- "type": "null"
111
- }
112
- ]
113
- }
114
- },
115
- "additionalProperties": false,
116
- "required": [
117
- "color",
118
- "width"
119
- ]
120
- },
121
- {
122
- "type": "null"
123
- }
124
- ]
125
- },
126
- "rectangle": {
127
- "anyOf": [
128
- {
129
- "type": "object",
130
- "description": "Configuration settings for the rectangle shape. Required when `shape` is set to `rectangle`.",
131
- "properties": {
132
- "width": {
133
- "description": "Set the width of the rectangle shape in pixels.",
134
- "type": "integer"
135
- },
136
- "height": {
137
- "description": "Set the height of the rectangle shape in pixels.",
138
- "type": "integer"
139
- },
140
- "cornerRadius": {
141
- "anyOf": [
142
- {
143
- "type": "integer",
144
- "description": "Set the corner radius of the rectangle shape."
145
- },
146
- {
147
- "type": "null"
148
- }
149
- ]
150
- }
151
- },
152
- "additionalProperties": false,
153
- "required": [
154
- "width",
155
- "height",
156
- "cornerRadius"
157
- ]
158
- },
159
- {
160
- "type": "null"
161
- }
162
- ]
163
- },
164
- "circle": {
165
- "anyOf": [
166
- {
167
- "type": "object",
168
- "description": "Configuration settings for the circle shape. Required when `shape` is set to `circle`.",
169
- "properties": {
170
- "radius": {
171
- "description": "Set the radius of the circle shape in pixels.",
172
- "type": "integer"
173
- }
174
- },
175
- "additionalProperties": false,
176
- "required": [
177
- "radius"
178
- ]
179
- },
180
- {
181
- "type": "null"
182
- }
183
- ]
184
- },
185
- "line": {
186
- "anyOf": [
187
- {
188
- "type": "object",
189
- "description": "Configuration settings for the line shape. Required when `shape` is set to `line`.",
190
- "properties": {
191
- "length": {
192
- "description": "Set the length of the line shape in pixels.",
193
- "type": "integer"
194
- },
195
- "thickness": {
196
- "description": "Set the thickness of the line in pixels.",
197
- "type": "integer"
198
- }
199
- },
200
- "additionalProperties": false,
201
- "required": [
202
- "length",
203
- "thickness"
204
- ]
205
- },
206
- {
207
- "type": "null"
208
- }
209
- ]
210
- }
211
- },
212
- "additionalProperties": false,
213
- "required": [
214
- "type",
215
- "shape",
216
- "width",
217
- "height",
218
- "fill",
219
- "stroke",
220
- "rectangle",
221
- "circle",
222
- "line"
223
- ]
224
- }
225
- }
@@ -1,33 +0,0 @@
1
- {
2
- "name": "ShotstackDestination",
3
- "strict": true,
4
- "schema": {
5
- "description": "Send videos and assets to the [Shotstack hosting and CDN](https://shotstack.io/docs/guide/serving-assets/destinations/shotstack/) service. This destination is enabled by default.",
6
- "properties": {
7
- "provider": {
8
- "description": "The destination to send assets to - set to `shotstack` for Shotstack hosting and CDN.",
9
- "type": "string",
10
- "enum": [
11
- "shotstack"
12
- ]
13
- },
14
- "exclude": {
15
- "anyOf": [
16
- {
17
- "type": "boolean",
18
- "description": "Set to `true` to [opt-out](https://shotstack.io/docs/guide/serving-assets/self-host/) from the Shotstack hosting and CDN service. All files must be downloaded within 24 hours of rendering."
19
- },
20
- {
21
- "type": "null"
22
- }
23
- ]
24
- }
25
- },
26
- "type": "object",
27
- "required": [
28
- "provider",
29
- "exclude"
30
- ],
31
- "additionalProperties": false
32
- }
33
- }
@@ -1,41 +0,0 @@
1
- {
2
- "name": "Size",
3
- "strict": true,
4
- "schema": {
5
- "description": "Set a custom size for a video or image in pixels. When using a custom size omit the `resolution` and `aspectRatio`. Custom sizes must be divisible by 2 based on the encoder specifications.",
6
- "properties": {
7
- "width": {
8
- "anyOf": [
9
- {
10
- "type": "integer",
11
- "description": "Set a custom width for the video or image file in pixels. Value must be divisible by 2. Maximum video width is 1920px, maximum image width is 4096px.",
12
- "minimum": 1,
13
- "maximum": 4096
14
- },
15
- {
16
- "type": "null"
17
- }
18
- ]
19
- },
20
- "height": {
21
- "anyOf": [
22
- {
23
- "type": "integer",
24
- "description": "Set a custom height for the video or image file in pixels. Value must be divisible by 2. Maximum video height is 1920px, maximum image height is 4096px.",
25
- "minimum": 1,
26
- "maximum": 4096
27
- },
28
- {
29
- "type": "null"
30
- }
31
- ]
32
- }
33
- },
34
- "additionalProperties": false,
35
- "type": "object",
36
- "required": [
37
- "width",
38
- "height"
39
- ]
40
- }
41
- }
@@ -1,175 +0,0 @@
1
- {
2
- "name": "SkewTransformation",
3
- "strict": true,
4
- "schema": {
5
- "description": "Skew a clip so its edges are sheared at an angle. Use values between -100 and 100. Values over 3 or under -3 will skew the clip almost flat.",
6
- "type": "object",
7
- "additionalProperties": false,
8
- "properties": {
9
- "x": {
10
- "description": "Skew the clip along it's x axis.",
11
- "anyOf": [
12
- {
13
- "type": "number",
14
- "description": "Range varies from -100 to 100. Positive numbers skew the asset right, negative left. The distance moved is relative to the width of the viewport - i.e. an X skew of 0.5 will skew the asset half the screen width to the right.",
15
- "minimum": -100,
16
- "maximum": 100
17
- },
18
- {
19
- "type": "array",
20
- "description": "An array of [Tween](./#tocs_tween) objects used to create a custom animation. Animate the X skew of an asset over time.",
21
- "items": {
22
- "$ref": "#/$defs/Tween"
23
- }
24
- },
25
- {
26
- "type": "null"
27
- }
28
- ]
29
- },
30
- "y": {
31
- "description": "Skew the clip along it's y axis.",
32
- "anyOf": [
33
- {
34
- "type": "number",
35
- "description": "Range varies from -100 to 100. Positive numbers skew the asset up, negative down. The distance moved is relative to the height of the viewport - i.e. an Y skew of 0.5 will skew the asset half the screen height up.",
36
- "minimum": -100,
37
- "maximum": 100
38
- },
39
- {
40
- "type": "array",
41
- "description": "An array of [Tween](./#tocs_tween) objects used to create a custom animation. Animate the Y skew of an asset over time.",
42
- "items": {
43
- "$ref": "#/$defs/Tween"
44
- }
45
- },
46
- {
47
- "type": "null"
48
- }
49
- ]
50
- }
51
- },
52
- "required": [
53
- "x",
54
- "y"
55
- ],
56
- "$defs": {
57
- "Tween": {
58
- "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 a clip.</li>\n </ul>",
59
- "properties": {
60
- "from": {
61
- "anyOf": [
62
- {
63
- "type": "string",
64
- "description": "The initial property value at the start of the animation."
65
- },
66
- {
67
- "type": "null"
68
- }
69
- ]
70
- },
71
- "to": {
72
- "anyOf": [
73
- {
74
- "type": "string",
75
- "description": "The final property value at the end of the animation."
76
- },
77
- {
78
- "type": "null"
79
- }
80
- ]
81
- },
82
- "start": {
83
- "anyOf": [
84
- {
85
- "type": "number",
86
- "description": "The time in seconds when the animation starts, relative to the clip, not the timeline."
87
- },
88
- {
89
- "type": "null"
90
- }
91
- ]
92
- },
93
- "length": {
94
- "anyOf": [
95
- {
96
- "type": "number",
97
- "description": "The duration of the animation in seconds."
98
- },
99
- {
100
- "type": "null"
101
- }
102
- ]
103
- },
104
- "interpolation": {
105
- "anyOf": [
106
- {
107
- "type": "string",
108
- "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 transition.</li>\n</ul>",
109
- "enum": [
110
- "linear",
111
- "bezier",
112
- "constant"
113
- ]
114
- },
115
- {
116
- "type": "null"
117
- }
118
- ]
119
- },
120
- "easing": {
121
- "anyOf": [
122
- {
123
- "type": "string",
124
- "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 to `bezier`.",
125
- "enum": [
126
- "ease",
127
- "easeIn",
128
- "easeOut",
129
- "easeInOut",
130
- "easeInQuad",
131
- "easeInCubic",
132
- "easeInQuart",
133
- "easeInQuint",
134
- "easeInSine",
135
- "easeInExpo",
136
- "easeInCirc",
137
- "easeInBack",
138
- "easeOutQuad",
139
- "easeOutCubic",
140
- "easeOutQuart",
141
- "easeOutQuint",
142
- "easeOutSine",
143
- "easeOutExpo",
144
- "easeOutCirc",
145
- "easeOutBack",
146
- "easeInOutQuad",
147
- "easeInOutCubic",
148
- "easeInOutQuart",
149
- "easeInOutQuint",
150
- "easeInOutSine",
151
- "easeInOutExpo",
152
- "easeInOutCirc",
153
- "easeInOutBack"
154
- ]
155
- },
156
- {
157
- "type": "null"
158
- }
159
- ]
160
- }
161
- },
162
- "additionalProperties": false,
163
- "type": "object",
164
- "required": [
165
- "from",
166
- "to",
167
- "start",
168
- "length",
169
- "interpolation",
170
- "easing"
171
- ]
172
- }
173
- }
174
- }
175
- }
@@ -1,47 +0,0 @@
1
- {
2
- "name": "Soundtrack",
3
- "strict": true,
4
- "schema": {
5
- "description": "A music or audio file in mp3 format that plays for the duration of the rendered video or the length of the audio file, which ever is shortest.",
6
- "properties": {
7
- "src": {
8
- "description": "The URL of the mp3 audio file. The URL must be publicly accessible or include credentials.",
9
- "type": "string"
10
- },
11
- "effect": {
12
- "anyOf": [
13
- {
14
- "type": "string",
15
- "description": "The effect to apply to the audio file <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</li>\n</ul>",
16
- "enum": [
17
- "fadeIn",
18
- "fadeOut",
19
- "fadeInFadeOut"
20
- ]
21
- },
22
- {
23
- "type": "null"
24
- }
25
- ]
26
- },
27
- "volume": {
28
- "anyOf": [
29
- {
30
- "type": "number",
31
- "description": "Set the volume for the soundtrack between 0 and 1 where 0 is muted and 1 is full volume (defaults to 1)."
32
- },
33
- {
34
- "type": "null"
35
- }
36
- ]
37
- }
38
- },
39
- "additionalProperties": false,
40
- "required": [
41
- "src",
42
- "effect",
43
- "volume"
44
- ],
45
- "type": "object"
46
- }
47
- }
@@ -1,26 +0,0 @@
1
- {
2
- "name": "SvgAsset",
3
- "strict": true,
4
- "schema": {
5
- "description": "The SvgAsset is used to add scalable vector graphics (SVG) to a video using raw SVG markup.\n\n**Supported elements:** `<path>`, `<rect>`, `<circle>`, `<ellipse>`,\n`<line>`, `<polygon>`, `<polyline>`\n\n**Automatically extracted from SVG markup:**\n- Path data (converted to a single combined path)\n- Fill color (from `fill` attribute or `style`)\n- Stroke color and width (from attributes or `style`)\n- Dimensions (from `width`/`height` or `viewBox`)\n- Opacity (from `opacity` attribute)\n\nSee [W3C SVG 2 Specification](https://www.w3.org/TR/SVG2/) for path data syntax.\n",
6
- "type": "object",
7
- "properties": {
8
- "type": {
9
- "description": "The asset type - set to `svg` for SVG assets.",
10
- "type": "string",
11
- "enum": [
12
- "svg"
13
- ]
14
- },
15
- "src": {
16
- "description": "Raw SVG markup string. The SVG must contain valid SVG elements. The shape,\nfill, stroke, dimensions and opacity are automatically extracted from the\nSVG content.\n",
17
- "type": "string"
18
- }
19
- },
20
- "additionalProperties": false,
21
- "required": [
22
- "type",
23
- "src"
24
- ]
25
- }
26
- }