@shotstack/schemas 1.12.1 → 1.13.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.
@@ -294,7 +294,44 @@
294
294
  "type": "string"
295
295
  },
296
296
  "src": {
297
- "type": "string"
297
+ "anyOf": [
298
+ {
299
+ "type": "string"
300
+ },
301
+ {
302
+ "type": "null"
303
+ }
304
+ ]
305
+ },
306
+ "prompt": {
307
+ "anyOf": [
308
+ {
309
+ "type": "string"
310
+ },
311
+ {
312
+ "type": "null"
313
+ }
314
+ ]
315
+ },
316
+ "seed": {
317
+ "anyOf": [
318
+ {
319
+ "type": "string"
320
+ },
321
+ {
322
+ "type": "null"
323
+ }
324
+ ]
325
+ },
326
+ "model": {
327
+ "anyOf": [
328
+ {
329
+ "type": "string"
330
+ },
331
+ {
332
+ "type": "null"
333
+ }
334
+ ]
298
335
  },
299
336
  "transcode": {
300
337
  "anyOf": [
@@ -387,6 +424,9 @@
387
424
  "required": [
388
425
  "type",
389
426
  "src",
427
+ "prompt",
428
+ "seed",
429
+ "model",
390
430
  "transcode",
391
431
  "trim",
392
432
  "volume",
@@ -613,7 +653,34 @@
613
653
  "type": "string"
614
654
  },
615
655
  "src": {
616
- "type": "string"
656
+ "anyOf": [
657
+ {
658
+ "type": "string"
659
+ },
660
+ {
661
+ "type": "null"
662
+ }
663
+ ]
664
+ },
665
+ "prompt": {
666
+ "anyOf": [
667
+ {
668
+ "type": "string"
669
+ },
670
+ {
671
+ "type": "null"
672
+ }
673
+ ]
674
+ },
675
+ "model": {
676
+ "anyOf": [
677
+ {
678
+ "type": "string"
679
+ },
680
+ {
681
+ "type": "null"
682
+ }
683
+ ]
617
684
  },
618
685
  "crop": {
619
686
  "anyOf": [
@@ -630,6 +697,8 @@
630
697
  "required": [
631
698
  "type",
632
699
  "src",
700
+ "prompt",
701
+ "model",
633
702
  "crop"
634
703
  ]
635
704
  },
@@ -1259,6 +1328,18 @@
1259
1328
  "type": "null"
1260
1329
  }
1261
1330
  ]
1331
+ },
1332
+ "padding": {
1333
+ "anyOf": [
1334
+ {
1335
+ "type": "integer",
1336
+ "minimum": 0,
1337
+ "maximum": 200
1338
+ },
1339
+ {
1340
+ "type": "null"
1341
+ }
1342
+ ]
1262
1343
  }
1263
1344
  },
1264
1345
  "additionalProperties": false,
@@ -1267,7 +1348,8 @@
1267
1348
  "color",
1268
1349
  "opacity",
1269
1350
  "borderRadius",
1270
- "wrap"
1351
+ "wrap",
1352
+ "padding"
1271
1353
  ]
1272
1354
  },
1273
1355
  "RichTextAlignment": {
@@ -1385,7 +1467,64 @@
1385
1467
  "type": "string"
1386
1468
  },
1387
1469
  "src": {
1388
- "type": "string"
1470
+ "anyOf": [
1471
+ {
1472
+ "type": "string"
1473
+ },
1474
+ {
1475
+ "type": "null"
1476
+ }
1477
+ ]
1478
+ },
1479
+ "prompt": {
1480
+ "anyOf": [
1481
+ {
1482
+ "type": "string"
1483
+ },
1484
+ {
1485
+ "type": "null"
1486
+ }
1487
+ ]
1488
+ },
1489
+ "voice": {
1490
+ "anyOf": [
1491
+ {
1492
+ "type": "string"
1493
+ },
1494
+ {
1495
+ "type": "null"
1496
+ }
1497
+ ]
1498
+ },
1499
+ "language": {
1500
+ "anyOf": [
1501
+ {
1502
+ "type": "string"
1503
+ },
1504
+ {
1505
+ "type": "null"
1506
+ }
1507
+ ]
1508
+ },
1509
+ "newscaster": {
1510
+ "anyOf": [
1511
+ {
1512
+ "type": "boolean"
1513
+ },
1514
+ {
1515
+ "type": "null"
1516
+ }
1517
+ ]
1518
+ },
1519
+ "model": {
1520
+ "anyOf": [
1521
+ {
1522
+ "type": "string"
1523
+ },
1524
+ {
1525
+ "type": "null"
1526
+ }
1527
+ ]
1389
1528
  },
1390
1529
  "trim": {
1391
1530
  "anyOf": [
@@ -1448,6 +1587,11 @@
1448
1587
  "required": [
1449
1588
  "type",
1450
1589
  "src",
1590
+ "prompt",
1591
+ "voice",
1592
+ "language",
1593
+ "newscaster",
1594
+ "model",
1451
1595
  "trim",
1452
1596
  "volume",
1453
1597
  "speed",
@@ -478,7 +478,44 @@
478
478
  "type": "string"
479
479
  },
480
480
  "src": {
481
- "type": "string"
481
+ "anyOf": [
482
+ {
483
+ "type": "string"
484
+ },
485
+ {
486
+ "type": "null"
487
+ }
488
+ ]
489
+ },
490
+ "prompt": {
491
+ "anyOf": [
492
+ {
493
+ "type": "string"
494
+ },
495
+ {
496
+ "type": "null"
497
+ }
498
+ ]
499
+ },
500
+ "seed": {
501
+ "anyOf": [
502
+ {
503
+ "type": "string"
504
+ },
505
+ {
506
+ "type": "null"
507
+ }
508
+ ]
509
+ },
510
+ "model": {
511
+ "anyOf": [
512
+ {
513
+ "type": "string"
514
+ },
515
+ {
516
+ "type": "null"
517
+ }
518
+ ]
482
519
  },
483
520
  "transcode": {
484
521
  "anyOf": [
@@ -571,6 +608,9 @@
571
608
  "required": [
572
609
  "type",
573
610
  "src",
611
+ "prompt",
612
+ "seed",
613
+ "model",
574
614
  "transcode",
575
615
  "trim",
576
616
  "volume",
@@ -797,7 +837,34 @@
797
837
  "type": "string"
798
838
  },
799
839
  "src": {
800
- "type": "string"
840
+ "anyOf": [
841
+ {
842
+ "type": "string"
843
+ },
844
+ {
845
+ "type": "null"
846
+ }
847
+ ]
848
+ },
849
+ "prompt": {
850
+ "anyOf": [
851
+ {
852
+ "type": "string"
853
+ },
854
+ {
855
+ "type": "null"
856
+ }
857
+ ]
858
+ },
859
+ "model": {
860
+ "anyOf": [
861
+ {
862
+ "type": "string"
863
+ },
864
+ {
865
+ "type": "null"
866
+ }
867
+ ]
801
868
  },
802
869
  "crop": {
803
870
  "anyOf": [
@@ -814,6 +881,8 @@
814
881
  "required": [
815
882
  "type",
816
883
  "src",
884
+ "prompt",
885
+ "model",
817
886
  "crop"
818
887
  ]
819
888
  },
@@ -1443,6 +1512,18 @@
1443
1512
  "type": "null"
1444
1513
  }
1445
1514
  ]
1515
+ },
1516
+ "padding": {
1517
+ "anyOf": [
1518
+ {
1519
+ "type": "integer",
1520
+ "minimum": 0,
1521
+ "maximum": 200
1522
+ },
1523
+ {
1524
+ "type": "null"
1525
+ }
1526
+ ]
1446
1527
  }
1447
1528
  },
1448
1529
  "additionalProperties": false,
@@ -1451,7 +1532,8 @@
1451
1532
  "color",
1452
1533
  "opacity",
1453
1534
  "borderRadius",
1454
- "wrap"
1535
+ "wrap",
1536
+ "padding"
1455
1537
  ]
1456
1538
  },
1457
1539
  "RichTextAlignment": {
@@ -1569,7 +1651,64 @@
1569
1651
  "type": "string"
1570
1652
  },
1571
1653
  "src": {
1572
- "type": "string"
1654
+ "anyOf": [
1655
+ {
1656
+ "type": "string"
1657
+ },
1658
+ {
1659
+ "type": "null"
1660
+ }
1661
+ ]
1662
+ },
1663
+ "prompt": {
1664
+ "anyOf": [
1665
+ {
1666
+ "type": "string"
1667
+ },
1668
+ {
1669
+ "type": "null"
1670
+ }
1671
+ ]
1672
+ },
1673
+ "voice": {
1674
+ "anyOf": [
1675
+ {
1676
+ "type": "string"
1677
+ },
1678
+ {
1679
+ "type": "null"
1680
+ }
1681
+ ]
1682
+ },
1683
+ "language": {
1684
+ "anyOf": [
1685
+ {
1686
+ "type": "string"
1687
+ },
1688
+ {
1689
+ "type": "null"
1690
+ }
1691
+ ]
1692
+ },
1693
+ "newscaster": {
1694
+ "anyOf": [
1695
+ {
1696
+ "type": "boolean"
1697
+ },
1698
+ {
1699
+ "type": "null"
1700
+ }
1701
+ ]
1702
+ },
1703
+ "model": {
1704
+ "anyOf": [
1705
+ {
1706
+ "type": "string"
1707
+ },
1708
+ {
1709
+ "type": "null"
1710
+ }
1711
+ ]
1573
1712
  },
1574
1713
  "trim": {
1575
1714
  "anyOf": [
@@ -1632,6 +1771,11 @@
1632
1771
  "required": [
1633
1772
  "type",
1634
1773
  "src",
1774
+ "prompt",
1775
+ "voice",
1776
+ "language",
1777
+ "newscaster",
1778
+ "model",
1635
1779
  "trim",
1636
1780
  "volume",
1637
1781
  "speed",
@@ -2,7 +2,7 @@
2
2
  "name": "ImageAsset",
3
3
  "strict": true,
4
4
  "schema": {
5
- "description": "The ImageAsset is used to create video from images to compose an image. The src must be a publicly accessible URL to an image resource such as a jpg or png file.",
5
+ "description": "The ImageAsset adds an image to a Clip. The image 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 the publicly accessible URL of a jpg or png file.\n- **Generated:** set `prompt` to describe the image; the engine generates it\n using the provider chosen by `model` and fills `src` in automatically.\n",
6
6
  "type": "object",
7
7
  "properties": {
8
8
  "type": {
@@ -13,8 +13,37 @@
13
13
  "type": "string"
14
14
  },
15
15
  "src": {
16
- "description": "The image source URL. The URL must be publicly accessible or include credentials.",
17
- "type": "string"
16
+ "anyOf": [
17
+ {
18
+ "type": "string",
19
+ "description": "The image source URL. The URL must be publicly accessible or include credentials. Provide either `src` or `prompt`, not both."
20
+ },
21
+ {
22
+ "type": "null"
23
+ }
24
+ ]
25
+ },
26
+ "prompt": {
27
+ "anyOf": [
28
+ {
29
+ "type": "string",
30
+ "description": "A text prompt to generate the image from. When set without `src`, the engine generates an image and fills `src` automatically. Use `model` to choose the generator."
31
+ },
32
+ {
33
+ "type": "null"
34
+ }
35
+ ]
36
+ },
37
+ "model": {
38
+ "anyOf": [
39
+ {
40
+ "type": "string",
41
+ "description": "The generation model to use when `prompt` is set (e.g. `flux-schnell`). Defaults to the platform's preferred generator if omitted."
42
+ },
43
+ {
44
+ "type": "null"
45
+ }
46
+ ]
18
47
  },
19
48
  "crop": {
20
49
  "anyOf": [
@@ -31,6 +60,8 @@
31
60
  "required": [
32
61
  "type",
33
62
  "src",
63
+ "prompt",
64
+ "model",
34
65
  "crop"
35
66
  ],
36
67
  "$defs": {
@@ -2,7 +2,7 @@
2
2
  "name": "ImageToVideoAsset",
3
3
  "strict": true,
4
4
  "schema": {
5
- "description": "The ImageToVideoAsset lets you create a video from an image and a text prompt.",
5
+ "description": "**Notice: ImageToVideoAsset is deprecated. Use [VideoAsset](#tocs_videoasset)\nwith `prompt` and `seed` instead.** This type continues to function and is\ninternally rewritten to VideoAsset; no behaviour change for existing\nintegrations.\n\nThe ImageToVideoAsset lets you create a video from an image and a text prompt.\n",
6
6
  "properties": {
7
7
  "type": {
8
8
  "type": "string",
@@ -519,6 +519,18 @@
519
519
  "type": "null"
520
520
  }
521
521
  ]
522
+ },
523
+ "padding": {
524
+ "anyOf": [
525
+ {
526
+ "type": "integer",
527
+ "minimum": 0,
528
+ "maximum": 200
529
+ },
530
+ {
531
+ "type": "null"
532
+ }
533
+ ]
522
534
  }
523
535
  },
524
536
  "additionalProperties": false,
@@ -527,7 +539,8 @@
527
539
  "color",
528
540
  "opacity",
529
541
  "borderRadius",
530
- "wrap"
542
+ "wrap",
543
+ "padding"
531
544
  ]
532
545
  },
533
546
  "RichTextAsset": {
@@ -627,6 +627,18 @@
627
627
  "type": "null"
628
628
  }
629
629
  ]
630
+ },
631
+ "padding": {
632
+ "anyOf": [
633
+ {
634
+ "type": "integer",
635
+ "minimum": 0,
636
+ "maximum": 200
637
+ },
638
+ {
639
+ "type": "null"
640
+ }
641
+ ]
630
642
  }
631
643
  },
632
644
  "additionalProperties": false,
@@ -635,7 +647,8 @@
635
647
  "color",
636
648
  "opacity",
637
649
  "borderRadius",
638
- "wrap"
650
+ "wrap",
651
+ "padding"
639
652
  ]
640
653
  },
641
654
  "RichTextAlignment": {
@@ -50,6 +50,19 @@
50
50
  "type": "null"
51
51
  }
52
52
  ]
53
+ },
54
+ "padding": {
55
+ "anyOf": [
56
+ {
57
+ "type": "integer",
58
+ "description": "Inner padding in pixels between the wrap pill edge and the rendered text. Only takes\neffect when `wrap: true`. When omitted, the renderer applies a sensible default\nproportional to the font size (approximately 12% of the active page font size on\nrich-caption assets). Set to 0 for a pill that hugs the text exactly. Available on\nrich-text and rich-caption assets only.\n",
59
+ "minimum": 0,
60
+ "maximum": 200
61
+ },
62
+ {
63
+ "type": "null"
64
+ }
65
+ ]
53
66
  }
54
67
  },
55
68
  "additionalProperties": false,
@@ -58,7 +71,8 @@
58
71
  "color",
59
72
  "opacity",
60
73
  "borderRadius",
61
- "wrap"
74
+ "wrap",
75
+ "padding"
62
76
  ]
63
77
  }
64
78
  }
@@ -325,6 +325,18 @@
325
325
  "type": "null"
326
326
  }
327
327
  ]
328
+ },
329
+ "padding": {
330
+ "anyOf": [
331
+ {
332
+ "type": "integer",
333
+ "minimum": 0,
334
+ "maximum": 200
335
+ },
336
+ {
337
+ "type": "null"
338
+ }
339
+ ]
328
340
  }
329
341
  },
330
342
  "additionalProperties": false,
@@ -333,7 +345,8 @@
333
345
  "color",
334
346
  "opacity",
335
347
  "borderRadius",
336
- "wrap"
348
+ "wrap",
349
+ "padding"
337
350
  ]
338
351
  },
339
352
  "RichTextAlignment": {