@shotstack/schemas 1.7.1 → 1.8.2

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 (36) hide show
  1. package/README.md +89 -89
  2. package/dist/api.bundled.json +49 -833
  3. package/dist/json-schema/asset.json +84 -855
  4. package/dist/json-schema/clip.json +84 -855
  5. package/dist/json-schema/edit.json +84 -855
  6. package/dist/json-schema/rich-caption-asset.json +221 -140
  7. package/dist/json-schema/schemas.json +93 -951
  8. package/dist/json-schema/svg-asset.json +6 -857
  9. package/dist/json-schema/timeline.json +84 -855
  10. package/dist/json-schema/track.json +84 -855
  11. package/dist/schema.d.ts +43 -660
  12. package/dist/zod/zod.gen.cjs +914 -1640
  13. package/dist/zod/zod.gen.d.ts +306 -8714
  14. package/dist/zod/zod.gen.js +911 -1636
  15. package/dist/zod/zod.gen.ts +1593 -1880
  16. package/package.json +79 -79
  17. package/dist/json-schema/svg-arrow-shape.json +0 -49
  18. package/dist/json-schema/svg-circle-shape.json +0 -28
  19. package/dist/json-schema/svg-cross-shape.json +0 -42
  20. package/dist/json-schema/svg-ellipse-shape.json +0 -35
  21. package/dist/json-schema/svg-fill.json +0 -169
  22. package/dist/json-schema/svg-gradient-stop.json +0 -25
  23. package/dist/json-schema/svg-heart-shape.json +0 -28
  24. package/dist/json-schema/svg-line-shape.json +0 -35
  25. package/dist/json-schema/svg-linear-gradient-fill.json +0 -80
  26. package/dist/json-schema/svg-path-shape.json +0 -26
  27. package/dist/json-schema/svg-polygon-shape.json +0 -35
  28. package/dist/json-schema/svg-radial-gradient-fill.json +0 -66
  29. package/dist/json-schema/svg-rectangle-shape.json +0 -49
  30. package/dist/json-schema/svg-ring-shape.json +0 -35
  31. package/dist/json-schema/svg-shadow.json +0 -79
  32. package/dist/json-schema/svg-shape.json +0 -404
  33. package/dist/json-schema/svg-solid-fill.json +0 -40
  34. package/dist/json-schema/svg-star-shape.json +0 -42
  35. package/dist/json-schema/svg-stroke.json +0 -115
  36. package/dist/json-schema/svg-transform.json +0 -93
package/dist/json-schema/svg-path-shape.json DELETED
@@ -1,26 +0,0 @@
1
- {
2
- "name": "SvgPathShape",
3
- "strict": true,
4
- "schema": {
5
- "description": "A custom shape defined by SVG path data.\nSupports all standard SVG path commands for creating complex shapes.\n\n**Path Commands:**\n- `M x y` / `m dx dy` - Move to (absolute/relative)\n- `L x y` / `l dx dy` - Line to\n- `H x` / `h dx` - Horizontal line to\n- `V y` / `v dy` - Vertical line to\n- `C x1 y1 x2 y2 x y` / `c` - Cubic Bezier curve\n- `S x2 y2 x y` / `s` - Smooth cubic Bezier\n- `Q x1 y1 x y` / `q` - Quadratic Bezier curve\n- `T x y` / `t` - Smooth quadratic Bezier\n- `A rx ry angle large-arc sweep x y` / `a` - Elliptical arc\n- `Z` / `z` - Close path\n",
6
- "type": "object",
7
- "additionalProperties": false,
8
- "properties": {
9
- "type": {
10
- "description": "The shape type - set to `path`.",
11
- "type": "string",
12
- "enum": [
13
- "path"
14
- ]
15
- },
16
- "d": {
17
- "description": "The SVG path data string defining the shape.\nUses standard SVG path commands (M, L, C, Q, A, Z, etc.).\nExample: `M 0 0 L 100 0 L 100 100 L 0 100 Z` draws a square.\n",
18
- "type": "string"
19
- }
20
- },
21
- "required": [
22
- "type",
23
- "d"
24
- ]
25
- }
26
- }
package/dist/json-schema/svg-polygon-shape.json DELETED
@@ -1,35 +0,0 @@
1
- {
2
- "name": "SvgPolygonShape",
3
- "strict": true,
4
- "schema": {
5
- "description": "A regular polygon shape with a specified number of sides.\nExamples: triangle (3), square (4), pentagon (5), hexagon (6), etc.\nThe polygon is inscribed in a circle of the given radius.\n",
6
- "type": "object",
7
- "additionalProperties": false,
8
- "properties": {
9
- "type": {
10
- "description": "The shape type - set to `polygon`.",
11
- "type": "string",
12
- "enum": [
13
- "polygon"
14
- ]
15
- },
16
- "sides": {
17
- "description": "The number of sides of the polygon.\nMinimum 3 (triangle), maximum 100 for practical use.\n",
18
- "type": "integer",
19
- "minimum": 3,
20
- "maximum": 100
21
- },
22
- "radius": {
23
- "description": "The radius of the circumscribed circle in pixels.\nThis determines the size of the polygon.\n",
24
- "type": "number",
25
- "minimum": 1,
26
- "maximum": 2048
27
- }
28
- },
29
- "required": [
30
- "type",
31
- "sides",
32
- "radius"
33
- ]
34
- }
35
- }
package/dist/json-schema/svg-radial-gradient-fill.json DELETED
@@ -1,66 +0,0 @@
1
- {
2
- "name": "SvgRadialGradientFill",
3
- "strict": true,
4
- "schema": {
5
- "description": "A radial gradient fill that transitions colors radiating outward from a center point.\nThe gradient creates a circular or elliptical color transition.\n",
6
- "type": "object",
7
- "additionalProperties": false,
8
- "properties": {
9
- "type": {
10
- "description": "The fill type - set to `radial` for a radial gradient fill.",
11
- "type": "string",
12
- "enum": [
13
- "radial"
14
- ]
15
- },
16
- "stops": {
17
- "description": "Array of color stops that define the gradient colors and their positions.\nMust have at least 2 stops. Offset `0` is the center, `1` is the outer edge.\n",
18
- "type": "array",
19
- "items": {
20
- "$ref": "#/$defs/SvgGradientStop"
21
- }
22
- },
23
- "opacity": {
24
- "anyOf": [
25
- {
26
- "type": "number",
27
- "description": "The overall opacity of the gradient where `1` is fully opaque and `0` is fully transparent.\n",
28
- "minimum": 0,
29
- "maximum": 1
30
- },
31
- {
32
- "type": "null"
33
- }
34
- ]
35
- }
36
- },
37
- "required": [
38
- "type",
39
- "stops",
40
- "opacity"
41
- ],
42
- "$defs": {
43
- "SvgGradientStop": {
44
- "description": "A color stop in a gradient. Each stop defines a color at a specific position\nalong the gradient vector. Gradients require at least 2 stops.\n",
45
- "type": "object",
46
- "additionalProperties": false,
47
- "properties": {
48
- "offset": {
49
- "description": "Position of the color stop along the gradient vector.\n`0` represents the start and `1` represents the end of the gradient.\n",
50
- "type": "number",
51
- "minimum": 0,
52
- "maximum": 1
53
- },
54
- "color": {
55
- "description": "The color at this stop using hexadecimal color notation.",
56
- "type": "string"
57
- }
58
- },
59
- "required": [
60
- "offset",
61
- "color"
62
- ]
63
- }
64
- }
65
- }
66
- }
package/dist/json-schema/svg-rectangle-shape.json DELETED
@@ -1,49 +0,0 @@
1
- {
2
- "name": "SvgRectangleShape",
3
- "strict": true,
4
- "schema": {
5
- "description": "A rectangle shape with optional rounded corners.\nThe rectangle is defined by its width and height dimensions.\n",
6
- "type": "object",
7
- "additionalProperties": false,
8
- "properties": {
9
- "type": {
10
- "description": "The shape type - set to `rectangle`.",
11
- "type": "string",
12
- "enum": [
13
- "rectangle"
14
- ]
15
- },
16
- "width": {
17
- "description": "The width of the rectangle in pixels.",
18
- "type": "number",
19
- "minimum": 1,
20
- "maximum": 4096
21
- },
22
- "height": {
23
- "description": "The height of the rectangle in pixels.",
24
- "type": "number",
25
- "minimum": 1,
26
- "maximum": 4096
27
- },
28
- "cornerRadius": {
29
- "anyOf": [
30
- {
31
- "type": "number",
32
- "description": "The corner radius for rounded corners in pixels.\nSet to `0` for sharp corners. The radius is automatically clamped\nto half of the smallest dimension.\n",
33
- "minimum": 0,
34
- "maximum": 2048
35
- },
36
- {
37
- "type": "null"
38
- }
39
- ]
40
- }
41
- },
42
- "required": [
43
- "type",
44
- "width",
45
- "height",
46
- "cornerRadius"
47
- ]
48
- }
49
- }
package/dist/json-schema/svg-ring-shape.json DELETED
@@ -1,35 +0,0 @@
1
- {
2
- "name": "SvgRingShape",
3
- "strict": true,
4
- "schema": {
5
- "description": "A ring (donut/annulus) shape - a circle with a circular hole in the center.\nThe ring is defined by outer and inner radii.\n",
6
- "type": "object",
7
- "additionalProperties": false,
8
- "properties": {
9
- "type": {
10
- "description": "The shape type - set to `ring`.",
11
- "type": "string",
12
- "enum": [
13
- "ring"
14
- ]
15
- },
16
- "outerRadius": {
17
- "description": "The outer radius of the ring in pixels.",
18
- "type": "number",
19
- "minimum": 1,
20
- "maximum": 2048
21
- },
22
- "innerRadius": {
23
- "description": "The inner radius (hole) of the ring in pixels.\nMust be smaller than outerRadius.\n",
24
- "type": "number",
25
- "minimum": 0,
26
- "maximum": 2048
27
- }
28
- },
29
- "required": [
30
- "type",
31
- "outerRadius",
32
- "innerRadius"
33
- ]
34
- }
35
- }
package/dist/json-schema/svg-shadow.json DELETED
@@ -1,79 +0,0 @@
1
- {
2
- "name": "SvgShadow",
3
- "strict": true,
4
- "schema": {
5
- "description": "Drop shadow properties for SVG shapes. Creates a shadow effect behind the shape.\n",
6
- "type": "object",
7
- "additionalProperties": false,
8
- "properties": {
9
- "offsetX": {
10
- "anyOf": [
11
- {
12
- "type": "number",
13
- "description": "Horizontal offset of the shadow in pixels.\nPositive values move the shadow to the right, negative to the left.\n"
14
- },
15
- {
16
- "type": "null"
17
- }
18
- ]
19
- },
20
- "offsetY": {
21
- "anyOf": [
22
- {
23
- "type": "number",
24
- "description": "Vertical offset of the shadow in pixels.\nPositive values move the shadow down, negative values move it up.\n"
25
- },
26
- {
27
- "type": "null"
28
- }
29
- ]
30
- },
31
- "blur": {
32
- "anyOf": [
33
- {
34
- "type": "number",
35
- "description": "The blur radius of the shadow in pixels. Must be 0 or greater.",
36
- "minimum": 0
37
- },
38
- {
39
- "type": "null"
40
- }
41
- ]
42
- },
43
- "color": {
44
- "anyOf": [
45
- {
46
- "type": "string",
47
- "description": "The shadow color using hexadecimal color notation.",
48
- "enum": [
49
- "#000000"
50
- ]
51
- },
52
- {
53
- "type": "null"
54
- }
55
- ]
56
- },
57
- "opacity": {
58
- "anyOf": [
59
- {
60
- "type": "number",
61
- "description": "The opacity of the shadow where `1` is opaque and `0` is transparent.",
62
- "minimum": 0,
63
- "maximum": 1
64
- },
65
- {
66
- "type": "null"
67
- }
68
- ]
69
- }
70
- },
71
- "required": [
72
- "offsetX",
73
- "offsetY",
74
- "blur",
75
- "color",
76
- "opacity"
77
- ]
78
- }
79
- }
package/dist/json-schema/svg-shape.json DELETED
@@ -1,404 +0,0 @@
1
- {
2
- "name": "SvgShape",
3
- "strict": true,
4
- "schema": {
5
- "description": "The shape definiti...",
6
- "anyOf": [
7
- {
8
- "$ref": "#/$defs/SvgRectangleShape"
9
- },
10
- {
11
- "$ref": "#/$defs/SvgCircleShape"
12
- },
13
- {
14
- "$ref": "#/$defs/SvgEllipseShape"
15
- },
16
- {
17
- "$ref": "#/$defs/SvgLineShape"
18
- },
19
- {
20
- "$ref": "#/$defs/SvgPolygonShape"
21
- },
22
- {
23
- "$ref": "#/$defs/SvgStarShape"
24
- },
25
- {
26
- "$ref": "#/$defs/SvgArrowShape"
27
- },
28
- {
29
- "$ref": "#/$defs/SvgHeartShape"
30
- },
31
- {
32
- "$ref": "#/$defs/SvgCrossShape"
33
- },
34
- {
35
- "$ref": "#/$defs/SvgRingShape"
36
- },
37
- {
38
- "$ref": "#/$defs/SvgPathShape"
39
- }
40
- ],
41
- "$defs": {
42
- "SvgRectangleShape": {
43
- "description": "A rectangle s...",
44
- "type": "object",
45
- "additionalProperties": false,
46
- "properties": {
47
- "type": {
48
- "description": "Th...",
49
- "type": "string",
50
- "enum": [
51
- "rectangle"
52
- ]
53
- },
54
- "width": {
55
- "description": "Th...",
56
- "type": "number",
57
- "minimum": 1,
58
- "maximum": 4096
59
- },
60
- "height": {
61
- "description": "Th...",
62
- "type": "number",
63
- "minimum": 1,
64
- "maximum": 4096
65
- },
66
- "cornerRadius": {
67
- "anyOf": [
68
- {
69
- "type": "number",
70
- "description": "The corner radius f...",
71
- "minimum": 0,
72
- "maximum": 2048
73
- },
74
- {
75
- "type": "null"
76
- }
77
- ]
78
- }
79
- },
80
- "required": [
81
- "type",
82
- "width",
83
- "height",
84
- "cornerRadius"
85
- ]
86
- },
87
- "SvgCircleShape": {
88
- "description": "A perfect c...",
89
- "type": "object",
90
- "additionalProperties": false,
91
- "properties": {
92
- "type": {
93
- "description": "T...",
94
- "type": "string",
95
- "enum": [
96
- "circle"
97
- ]
98
- },
99
- "radius": {
100
- "description": "Th...",
101
- "type": "number",
102
- "minimum": 1,
103
- "maximum": 2048
104
- }
105
- },
106
- "required": [
107
- "type",
108
- "radius"
109
- ]
110
- },
111
- "SvgEllipseShape": {
112
- "description": "An ellipse (ov...",
113
- "type": "object",
114
- "additionalProperties": false,
115
- "properties": {
116
- "type": {
117
- "description": "Th...",
118
- "type": "string",
119
- "enum": [
120
- "ellipse"
121
- ]
122
- },
123
- "radiusX": {
124
- "description": "The ...",
125
- "type": "number",
126
- "minimum": 1,
127
- "maximum": 2048
128
- },
129
- "radiusY": {
130
- "description": "The ...",
131
- "type": "number",
132
- "minimum": 1,
133
- "maximum": 2048
134
- }
135
- },
136
- "required": [
137
- "type",
138
- "radiusX",
139
- "radiusY"
140
- ]
141
- },
142
- "SvgLineShape": {
143
- "description": "A straight line s...",
144
- "type": "object",
145
- "additionalProperties": false,
146
- "properties": {
147
- "type": {
148
- "description": "T...",
149
- "type": "string",
150
- "enum": [
151
- "line"
152
- ]
153
- },
154
- "length": {
155
- "description": "T...",
156
- "type": "number",
157
- "minimum": 1,
158
- "maximum": 4096
159
- },
160
- "thickness": {
161
- "description": "Th...",
162
- "type": "number",
163
- "minimum": 1,
164
- "maximum": 500
165
- }
166
- },
167
- "required": [
168
- "type",
169
- "length",
170
- "thickness"
171
- ]
172
- },
173
- "SvgPolygonShape": {
174
- "description": "A regular polygon shape ...",
175
- "type": "object",
176
- "additionalProperties": false,
177
- "properties": {
178
- "type": {
179
- "description": "Th...",
180
- "type": "string",
181
- "enum": [
182
- "polygon"
183
- ]
184
- },
185
- "sides": {
186
- "description": "The number...",
187
- "type": "integer",
188
- "minimum": 3,
189
- "maximum": 100
190
- },
191
- "radius": {
192
- "description": "The radius...",
193
- "type": "number",
194
- "minimum": 1,
195
- "maximum": 2048
196
- }
197
- },
198
- "required": [
199
- "type",
200
- "sides",
201
- "radius"
202
- ]
203
- },
204
- "SvgStarShape": {
205
- "description": "A star shape with ...",
206
- "type": "object",
207
- "additionalProperties": false,
208
- "properties": {
209
- "type": {
210
- "description": "T...",
211
- "type": "string",
212
- "enum": [
213
- "star"
214
- ]
215
- },
216
- "points": {
217
- "description": "The number o...",
218
- "type": "integer",
219
- "minimum": 3,
220
- "maximum": 100
221
- },
222
- "outerRadius": {
223
- "description": "The outer...",
224
- "type": "number",
225
- "minimum": 1,
226
- "maximum": 2048
227
- },
228
- "innerRadius": {
229
- "description": "The inner radius...",
230
- "type": "number",
231
- "minimum": 1,
232
- "maximum": 2048
233
- }
234
- },
235
- "required": [
236
- "type",
237
- "points",
238
- "outerRadius",
239
- "innerRadius"
240
- ]
241
- },
242
- "SvgArrowShape": {
243
- "description": "An arrow s...",
244
- "type": "object",
245
- "additionalProperties": false,
246
- "properties": {
247
- "type": {
248
- "description": "T...",
249
- "type": "string",
250
- "enum": [
251
- "arrow"
252
- ]
253
- },
254
- "length": {
255
- "description": "The t...",
256
- "type": "number",
257
- "minimum": 1,
258
- "maximum": 4096
259
- },
260
- "headWidth": {
261
- "description": "The w...",
262
- "type": "number",
263
- "minimum": 1,
264
- "maximum": 1000
265
- },
266
- "headLength": {
267
- "description": "The ...",
268
- "type": "number",
269
- "minimum": 1,
270
- "maximum": 1000
271
- },
272
- "shaftWidth": {
273
- "description": "The...",
274
- "type": "number",
275
- "minimum": 1,
276
- "maximum": 1000
277
- }
278
- },
279
- "required": [
280
- "type",
281
- "length",
282
- "headWidth",
283
- "headLength",
284
- "shaftWidth"
285
- ]
286
- },
287
- "SvgHeartShape": {
288
- "description": "A heart sha...",
289
- "type": "object",
290
- "additionalProperties": false,
291
- "properties": {
292
- "type": {
293
- "description": "T...",
294
- "type": "string",
295
- "enum": [
296
- "heart"
297
- ]
298
- },
299
- "size": {
300
- "description": "The size o...",
301
- "type": "number",
302
- "minimum": 1,
303
- "maximum": 4096
304
- }
305
- },
306
- "required": [
307
- "type",
308
- "size"
309
- ]
310
- },
311
- "SvgCrossShape": {
312
- "description": "A cross or plus...",
313
- "type": "object",
314
- "additionalProperties": false,
315
- "properties": {
316
- "type": {
317
- "description": "T...",
318
- "type": "string",
319
- "enum": [
320
- "cross"
321
- ]
322
- },
323
- "width": {
324
- "description": "Th...",
325
- "type": "number",
326
- "minimum": 1,
327
- "maximum": 4096
328
- },
329
- "height": {
330
- "description": "Th...",
331
- "type": "number",
332
- "minimum": 1,
333
- "maximum": 4096
334
- },
335
- "thickness": {
336
- "description": "The...",
337
- "type": "number",
338
- "minimum": 1,
339
- "maximum": 500
340
- }
341
- },
342
- "required": [
343
- "type",
344
- "width",
345
- "height",
346
- "thickness"
347
- ]
348
- },
349
- "SvgRingShape": {
350
- "description": "A ring (donut/a...",
351
- "type": "object",
352
- "additionalProperties": false,
353
- "properties": {
354
- "type": {
355
- "description": "T...",
356
- "type": "string",
357
- "enum": [
358
- "ring"
359
- ]
360
- },
361
- "outerRadius": {
362
- "description": "Th...",
363
- "type": "number",
364
- "minimum": 1,
365
- "maximum": 2048
366
- },
367
- "innerRadius": {
368
- "description": "The inner...",
369
- "type": "number",
370
- "minimum": 0,
371
- "maximum": 2048
372
- }
373
- },
374
- "required": [
375
- "type",
376
- "outerRadius",
377
- "innerRadius"
378
- ]
379
- },
380
- "SvgPathShape": {
381
- "description": "A custom shape defined by SVG path data.\nSupports all standard SVG path command...",
382
- "type": "object",
383
- "additionalProperties": false,
384
- "properties": {
385
- "type": {
386
- "description": "T...",
387
- "type": "string",
388
- "enum": [
389
- "path"
390
- ]
391
- },
392
- "d": {
393
- "description": "The SVG path data str...",
394
- "type": "string"
395
- }
396
- },
397
- "required": [
398
- "type",
399
- "d"
400
- ]
401
- }
402
- }
403
- }
404
- }