@shotstack/schemas 1.7.0 → 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 (53) hide show
  1. package/README.md +89 -89
  2. package/dist/api.bundled.json +49 -833
  3. package/dist/json-schema/asset.json +115 -856
  4. package/dist/json-schema/audio-asset.json +31 -1
  5. package/dist/json-schema/blueprint.json +380 -0
  6. package/dist/json-schema/caption-detailer.json +275 -0
  7. package/dist/json-schema/clip.json +256 -949
  8. package/dist/json-schema/edit.json +247 -940
  9. package/dist/json-schema/index.cjs +5 -0
  10. package/dist/json-schema/index.d.ts +5 -0
  11. package/dist/json-schema/index.js +5 -0
  12. package/dist/json-schema/offset.json +31 -1
  13. package/dist/json-schema/rich-caption-asset.json +221 -140
  14. package/dist/json-schema/rich-text-content.json +370 -0
  15. package/dist/json-schema/rich-text-effects.json +400 -0
  16. package/dist/json-schema/rotate-transformation.json +31 -1
  17. package/dist/json-schema/schemas.json +264 -1044
  18. package/dist/json-schema/skew-transformation.json +31 -1
  19. package/dist/json-schema/svg-asset.json +6 -857
  20. package/dist/json-schema/template.json +541 -0
  21. package/dist/json-schema/text-to-speech-asset.json +31 -1
  22. package/dist/json-schema/timeline.json +256 -949
  23. package/dist/json-schema/track.json +256 -949
  24. package/dist/json-schema/transformation.json +52 -22
  25. package/dist/json-schema/transition.json +50 -2
  26. package/dist/json-schema/tween.json +31 -1
  27. package/dist/json-schema/video-asset.json +56 -26
  28. package/dist/schema.d.ts +43 -660
  29. package/dist/zod/zod.gen.cjs +914 -1640
  30. package/dist/zod/zod.gen.d.ts +306 -8714
  31. package/dist/zod/zod.gen.js +911 -1636
  32. package/dist/zod/zod.gen.ts +1593 -1880
  33. package/package.json +79 -79
  34. package/dist/json-schema/svg-arrow-shape.json +0 -49
  35. package/dist/json-schema/svg-circle-shape.json +0 -28
  36. package/dist/json-schema/svg-cross-shape.json +0 -42
  37. package/dist/json-schema/svg-ellipse-shape.json +0 -35
  38. package/dist/json-schema/svg-fill.json +0 -169
  39. package/dist/json-schema/svg-gradient-stop.json +0 -25
  40. package/dist/json-schema/svg-heart-shape.json +0 -28
  41. package/dist/json-schema/svg-line-shape.json +0 -35
  42. package/dist/json-schema/svg-linear-gradient-fill.json +0 -80
  43. package/dist/json-schema/svg-path-shape.json +0 -26
  44. package/dist/json-schema/svg-polygon-shape.json +0 -35
  45. package/dist/json-schema/svg-radial-gradient-fill.json +0 -66
  46. package/dist/json-schema/svg-rectangle-shape.json +0 -49
  47. package/dist/json-schema/svg-ring-shape.json +0 -35
  48. package/dist/json-schema/svg-shadow.json +0 -79
  49. package/dist/json-schema/svg-shape.json +0 -404
  50. package/dist/json-schema/svg-solid-fill.json +0 -40
  51. package/dist/json-schema/svg-star-shape.json +0 -42
  52. package/dist/json-schema/svg-stroke.json +0 -115
  53. package/dist/json-schema/svg-transform.json +0 -93
package/dist/schema.d.ts CHANGED
@@ -997,7 +997,42 @@ export interface components {
997
997
  /** @description Pre-provided word-level timing data. Use this instead of `src` when you have word timestamps from an external source. Mutually exclusive with `src`. */
998
998
  words?: components["schemas"]["WordTiming"][];
999
999
  /** @description Font styling properties for inactive words. */
1000
- font?: components["schemas"]["RichTextFont"];
1000
+ font?: {
1001
+ /**
1002
+ * @description The font family name. This must be the Family name embedded in the font, i.e. "Roboto".
1003
+ * @default Roboto
1004
+ * @example Roboto
1005
+ */
1006
+ family?: string;
1007
+ /**
1008
+ * @description The size of the font in pixels (px). Must be between 1 and 500.
1009
+ * @default 24
1010
+ * @example 48
1011
+ */
1012
+ size?: number;
1013
+ /**
1014
+ * @description The weight of the font. Can be a number (100-900) or a string ('normal', 'bold', etc.). 100 is lightest, 900 is heaviest (boldest).
1015
+ * @default 400
1016
+ */
1017
+ weight?: unknown;
1018
+ /**
1019
+ * @description The text color using hexadecimal color notation.
1020
+ * @default #ffffff
1021
+ * @example #ffffff
1022
+ */
1023
+ color?: string;
1024
+ /**
1025
+ * @description The opacity of the text where 1 is opaque and 0 is transparent.
1026
+ * @default 1
1027
+ * @example 0.9
1028
+ */
1029
+ opacity?: number;
1030
+ /**
1031
+ * @description The background color behind the text using hexadecimal color notation.
1032
+ * @example #000000
1033
+ */
1034
+ background?: string;
1035
+ };
1001
1036
  /** @description Text style properties including spacing, line height, and transformations. */
1002
1037
  style?: components["schemas"]["RichTextStyle"];
1003
1038
  /** @description Text stroke (outline) properties for inactive words. */
@@ -1348,688 +1383,36 @@ export interface components {
1348
1383
  offset?: components["schemas"]["Offset"];
1349
1384
  };
1350
1385
  /**
1351
- * @description The SvgAsset is used to add scalable vector graphics (SVG) shapes to a video.
1352
- * It provides two mutually exclusive ways to define shapes:
1386
+ * @description The SvgAsset is used to create scalable vector graphic (SVG) assets using
1387
+ * raw SVG markup.
1353
1388
  *
1354
- * **Option 1: Import SVG markup using `src`**
1355
1389
  * ```json
1356
1390
  * {
1357
1391
  * "type": "svg",
1358
1392
  * "src": "<svg width=\"100\" height=\"100\"><circle cx=\"50\" cy=\"50\" r=\"40\" fill=\"#FF0000\"/></svg>"
1359
1393
  * }
1360
1394
  * ```
1361
- * When using `src`, no other properties are allowed. The fill, stroke, and dimensions
1362
- * are automatically extracted from the SVG markup.
1363
1395
  *
1364
- * **Option 2: Define shapes programmatically using `shape`**
1365
- * ```json
1366
- * {
1367
- * "type": "svg",
1368
- * "shape": { "type": "circle", "radius": 50 },
1369
- * "fill": { "type": "solid", "color": "#FF0000" }
1370
- * }
1371
- * ```
1372
- * When using `shape`, you can customize fill, stroke, shadow, transform, and other properties.
1373
- * The `src` property is not allowed in this mode.
1374
- *
1375
- * **Important:** You must provide either `src` OR `shape`, but not both.
1376
- * These two modes are mutually exclusive.
1377
- *
1378
- * **Available Shapes (Option 2 only):**
1379
- * - `rectangle` - Rectangles with optional rounded corners
1380
- * - `circle` - Perfect circles
1381
- * - `ellipse` - Ellipses/ovals with separate x and y radii
1382
- * - `line` - Straight lines with configurable thickness
1383
- * - `polygon` - Regular polygons (triangle, pentagon, hexagon, etc.)
1384
- * - `star` - Multi-pointed stars
1385
- * - `arrow` - Directional arrows
1386
- * - `heart` - Heart shapes
1387
- * - `cross` - Plus/cross shapes
1388
- * - `ring` - Donut/ring shapes
1389
- * - `path` - Custom shapes using SVG path data
1390
- *
1391
- * See [W3C SVG 2 Specification](https://www.w3.org/TR/SVG2/) for path data syntax.
1396
+ * See [W3C SVG 2 Specification](https://www.w3.org/TR/SVG2/) for SVG markup syntax.
1392
1397
  * @example {
1393
1398
  * "type": "svg",
1394
- * "shape": {
1395
- * "type": "star",
1396
- * "points": 5,
1397
- * "outerRadius": 100,
1398
- * "innerRadius": 50
1399
- * },
1400
- * "fill": {
1401
- * "type": "linear",
1402
- * "angle": 45,
1403
- * "stops": [
1404
- * {
1405
- * "offset": 0,
1406
- * "color": "#FFD700"
1407
- * },
1408
- * {
1409
- * "offset": 1,
1410
- * "color": "#FF6B6B"
1411
- * }
1412
- * ],
1413
- * "opacity": 1
1414
- * },
1415
- * "stroke": {
1416
- * "color": "#2C3E50",
1417
- * "width": 3,
1418
- * "opacity": 1,
1419
- * "lineCap": "round",
1420
- * "lineJoin": "round"
1421
- * },
1422
- * "transform": {
1423
- * "x": 200,
1424
- * "y": 150,
1425
- * "rotation": 0,
1426
- * "scale": 1
1427
- * },
1428
- * "opacity": 1
1399
+ * "src": "<svg width=\"100\" height=\"100\"><circle cx=\"50\" cy=\"50\" r=\"40\" fill=\"#3498db\"/></svg>"
1429
1400
  * }
1430
1401
  */
1431
1402
  SvgAsset: {
1432
1403
  /**
1433
- * @description The asset type - set to `svg` for SVG shapes. (enum property replaced by openapi-typescript)
1404
+ * @description The asset type - set to `svg` for SVG assets. (enum property replaced by openapi-typescript)
1434
1405
  * @enum {string}
1435
1406
  */
1436
1407
  type: "svg";
1437
1408
  /**
1438
- * @description Raw SVG markup string to import. When provided, the shape is extracted
1439
- * automatically from the SVG content.
1409
+ * @description Raw SVG markup string to import.
1440
1410
  *
1441
1411
  * **Supported elements:** `<path>`, `<rect>`, `<circle>`, `<ellipse>`,
1442
1412
  * `<line>`, `<polygon>`, `<polyline>`
1443
- *
1444
- * **Automatically extracted:**
1445
- * - Path data (converted to a single combined path)
1446
- * - Fill color (from `fill` attribute or `style`)
1447
- * - Stroke color and width (from attributes or `style`)
1448
- * - Dimensions (from `width`/`height` or `viewBox`)
1449
- * - Opacity (from `opacity` attribute)
1450
- *
1451
- * **Important:** When using `src`, no other properties (shape, fill, stroke, etc.)
1452
- * are allowed. All styling must be defined within the SVG markup itself.
1453
1413
  * @example <svg width="100" height="100"><circle cx="50" cy="50" r="40" fill="#3498db"/></svg>
1454
1414
  */
1455
- src?: string;
1456
- /**
1457
- * @description The shape definition using primitives. The `type` property within determines
1458
- * the shape kind and its specific properties.
1459
- *
1460
- * **Important:** When using `shape`, the `src` property is not allowed.
1461
- */
1462
- shape?: components["schemas"]["SvgShape"];
1463
- /**
1464
- * @description Fill properties for the shape interior.
1465
- * Can be a solid color or a gradient (linear/radial).
1466
- * If omitted, the shape will have no fill (transparent interior).
1467
- *
1468
- * **Note:** Only allowed when using `shape`, not with `src`.
1469
- */
1470
- fill?: components["schemas"]["SvgFill"];
1471
- /**
1472
- * @description Stroke (outline) properties for the shape.
1473
- * If omitted, the shape will have no stroke (no outline).
1474
- *
1475
- * **Note:** Only allowed when using `shape`, not with `src`.
1476
- */
1477
- stroke?: components["schemas"]["SvgStroke"];
1478
- /**
1479
- * @description Drop shadow properties for the shape.
1480
- * Creates a shadow effect behind the shape.
1481
- *
1482
- * **Note:** Only allowed when using `shape`, not with `src`.
1483
- */
1484
- shadow?: components["schemas"]["SvgShadow"];
1485
- /**
1486
- * @description Transform properties for positioning, rotating, and scaling the shape.
1487
- * The transform is applied relative to the transformation origin.
1488
- *
1489
- * **Note:** Only allowed when using `shape`, not with `src`.
1490
- */
1491
- transform?: components["schemas"]["SvgTransform"];
1492
- /**
1493
- * @description The overall opacity of the entire shape (including fill, stroke, and shadow).
1494
- * `1` is fully opaque, `0` is fully transparent.
1495
- * This is applied on top of individual fill/stroke/shadow opacity values.
1496
- *
1497
- * **Note:** Only allowed when using `shape`, not with `src`.
1498
- * @default 1
1499
- * @example 1
1500
- */
1501
- opacity?: number;
1502
- /**
1503
- * @description The width of the bounding box in pixels.
1504
- * If specified, the shape may be scaled to fit within this width.
1505
- * If omitted, the shape uses its natural dimensions.
1506
- *
1507
- * **Note:** Only allowed when using `shape`, not with `src`.
1508
- * @example 400
1509
- */
1510
- width?: number;
1511
- /**
1512
- * @description The height of the bounding box in pixels.
1513
- * If specified, the shape may be scaled to fit within this height.
1514
- * If omitted, the shape uses its natural dimensions.
1515
- *
1516
- * **Note:** Only allowed when using `shape`, not with `src`.
1517
- * @example 300
1518
- */
1519
- height?: number;
1520
- };
1521
- /**
1522
- * @description The shape definition for an SVG asset. Each shape type has its own specific
1523
- * properties. The `type` field determines which shape is rendered.
1524
- */
1525
- SvgShape: components["schemas"]["SvgRectangleShape"] | components["schemas"]["SvgCircleShape"] | components["schemas"]["SvgEllipseShape"] | components["schemas"]["SvgLineShape"] | components["schemas"]["SvgPolygonShape"] | components["schemas"]["SvgStarShape"] | components["schemas"]["SvgArrowShape"] | components["schemas"]["SvgHeartShape"] | components["schemas"]["SvgCrossShape"] | components["schemas"]["SvgRingShape"] | components["schemas"]["SvgPathShape"];
1526
- /**
1527
- * @description A rectangle shape with optional rounded corners.
1528
- * The rectangle is defined by its width and height dimensions.
1529
- */
1530
- SvgRectangleShape: {
1531
- /**
1532
- * @description The shape type - set to `rectangle`. (enum property replaced by openapi-typescript)
1533
- * @enum {string}
1534
- */
1535
- type: "rectangle";
1536
- /**
1537
- * @description The width of the rectangle in pixels.
1538
- * @example 200
1539
- */
1540
- width: number;
1541
- /**
1542
- * @description The height of the rectangle in pixels.
1543
- * @example 100
1544
- */
1545
- height: number;
1546
- /**
1547
- * @description The corner radius for rounded corners in pixels.
1548
- * Set to `0` for sharp corners. The radius is automatically clamped
1549
- * to half of the smallest dimension.
1550
- * @default 0
1551
- * @example 10
1552
- */
1553
- cornerRadius?: number;
1554
- };
1555
- /**
1556
- * @description A perfect circle shape defined by its radius.
1557
- * The circle is centered at the shape's position.
1558
- */
1559
- SvgCircleShape: {
1560
- /**
1561
- * @description The shape type - set to `circle`. (enum property replaced by openapi-typescript)
1562
- * @enum {string}
1563
- */
1564
- type: "circle";
1565
- /**
1566
- * @description The radius of the circle in pixels.
1567
- * @example 50
1568
- */
1569
- radius: number;
1570
- };
1571
- /**
1572
- * @description An ellipse (oval) shape with separate horizontal and vertical radii.
1573
- * The ellipse is centered at the shape's position.
1574
- */
1575
- SvgEllipseShape: {
1576
- /**
1577
- * @description The shape type - set to `ellipse`. (enum property replaced by openapi-typescript)
1578
- * @enum {string}
1579
- */
1580
- type: "ellipse";
1581
- /**
1582
- * @description The horizontal radius (semi-major axis) in pixels.
1583
- * @example 80
1584
- */
1585
- radiusX: number;
1586
- /**
1587
- * @description The vertical radius (semi-minor axis) in pixels.
1588
- * @example 50
1589
- */
1590
- radiusY: number;
1591
- };
1592
- /**
1593
- * @description A straight line shape with a specified length and thickness.
1594
- * The line is drawn horizontally by default and can be rotated using transform.
1595
- */
1596
- SvgLineShape: {
1597
- /**
1598
- * @description The shape type - set to `line`. (enum property replaced by openapi-typescript)
1599
- * @enum {string}
1600
- */
1601
- type: "line";
1602
- /**
1603
- * @description The length of the line in pixels.
1604
- * @example 100
1605
- */
1606
- length: number;
1607
- /**
1608
- * @description The thickness of the line in pixels.
1609
- * @example 4
1610
- */
1611
- thickness: number;
1612
- };
1613
- /**
1614
- * @description A regular polygon shape with a specified number of sides.
1615
- * Examples: triangle (3), square (4), pentagon (5), hexagon (6), etc.
1616
- * The polygon is inscribed in a circle of the given radius.
1617
- */
1618
- SvgPolygonShape: {
1619
- /**
1620
- * @description The shape type - set to `polygon`. (enum property replaced by openapi-typescript)
1621
- * @enum {string}
1622
- */
1623
- type: "polygon";
1624
- /**
1625
- * @description The number of sides of the polygon.
1626
- * Minimum 3 (triangle), maximum 100 for practical use.
1627
- * @example 6
1628
- */
1629
- sides: number;
1630
- /**
1631
- * @description The radius of the circumscribed circle in pixels.
1632
- * This determines the size of the polygon.
1633
- * @example 50
1634
- */
1635
- radius: number;
1636
- };
1637
- /**
1638
- * @description A star shape with a specified number of points.
1639
- * The star is defined by outer and inner radii, creating the characteristic
1640
- * pointed appearance.
1641
- */
1642
- SvgStarShape: {
1643
- /**
1644
- * @description The shape type - set to `star`. (enum property replaced by openapi-typescript)
1645
- * @enum {string}
1646
- */
1647
- type: "star";
1648
- /**
1649
- * @description The number of points on the star.
1650
- * Minimum 3 for a triangle-like star, typically 5 for a classic star.
1651
- * @example 5
1652
- */
1653
- points: number;
1654
- /**
1655
- * @description The outer radius in pixels - the distance from center to the tips of the points.
1656
- * @example 50
1657
- */
1658
- outerRadius: number;
1659
- /**
1660
- * @description The inner radius in pixels - the distance from center to the inner vertices.
1661
- * Should be smaller than outerRadius for a star effect.
1662
- * @example 25
1663
- */
1664
- innerRadius: number;
1665
- };
1666
- /**
1667
- * @description An arrow shape pointing to the right by default.
1668
- * Use transform rotation to change direction.
1669
- */
1670
- SvgArrowShape: {
1671
- /**
1672
- * @description The shape type - set to `arrow`. (enum property replaced by openapi-typescript)
1673
- * @enum {string}
1674
- */
1675
- type: "arrow";
1676
- /**
1677
- * @description The total length of the arrow from tail to tip in pixels.
1678
- * @example 100
1679
- */
1680
- length: number;
1681
- /**
1682
- * @description The width of the arrow head (the widest part) in pixels.
1683
- * @example 40
1684
- */
1685
- headWidth: number;
1686
- /**
1687
- * @description The length of the arrow head portion in pixels.
1688
- * @example 30
1689
- */
1690
- headLength: number;
1691
- /**
1692
- * @description The width of the arrow shaft (body) in pixels.
1693
- * @example 20
1694
- */
1695
- shaftWidth: number;
1696
- };
1697
- /**
1698
- * @description A heart shape commonly used for love/like icons.
1699
- * The heart is defined by a single size parameter.
1700
- */
1701
- SvgHeartShape: {
1702
- /**
1703
- * @description The shape type - set to `heart`. (enum property replaced by openapi-typescript)
1704
- * @enum {string}
1705
- */
1706
- type: "heart";
1707
- /**
1708
- * @description The size of the heart in pixels.
1709
- * This determines both the width and height proportionally.
1710
- * @example 100
1711
- */
1712
- size: number;
1713
- };
1714
- /**
1715
- * @description A cross or plus shape with equal or different arm lengths.
1716
- * Can be styled as a plus sign (+) or a cross (x with rotation).
1717
- */
1718
- SvgCrossShape: {
1719
- /**
1720
- * @description The shape type - set to `cross`. (enum property replaced by openapi-typescript)
1721
- * @enum {string}
1722
- */
1723
- type: "cross";
1724
- /**
1725
- * @description The total width of the cross in pixels.
1726
- * @example 100
1727
- */
1728
- width: number;
1729
- /**
1730
- * @description The total height of the cross in pixels.
1731
- * @example 100
1732
- */
1733
- height: number;
1734
- /**
1735
- * @description The thickness of the cross arms in pixels.
1736
- * @example 20
1737
- */
1738
- thickness: number;
1739
- };
1740
- /**
1741
- * @description A ring (donut/annulus) shape - a circle with a circular hole in the center.
1742
- * The ring is defined by outer and inner radii.
1743
- */
1744
- SvgRingShape: {
1745
- /**
1746
- * @description The shape type - set to `ring`. (enum property replaced by openapi-typescript)
1747
- * @enum {string}
1748
- */
1749
- type: "ring";
1750
- /**
1751
- * @description The outer radius of the ring in pixels.
1752
- * @example 50
1753
- */
1754
- outerRadius: number;
1755
- /**
1756
- * @description The inner radius (hole) of the ring in pixels.
1757
- * Must be smaller than outerRadius.
1758
- * @example 30
1759
- */
1760
- innerRadius: number;
1761
- };
1762
- /**
1763
- * @description A custom shape defined by SVG path data.
1764
- * Supports all standard SVG path commands for creating complex shapes.
1765
- *
1766
- * **Path Commands:**
1767
- * - `M x y` / `m dx dy` - Move to (absolute/relative)
1768
- * - `L x y` / `l dx dy` - Line to
1769
- * - `H x` / `h dx` - Horizontal line to
1770
- * - `V y` / `v dy` - Vertical line to
1771
- * - `C x1 y1 x2 y2 x y` / `c` - Cubic Bezier curve
1772
- * - `S x2 y2 x y` / `s` - Smooth cubic Bezier
1773
- * - `Q x1 y1 x y` / `q` - Quadratic Bezier curve
1774
- * - `T x y` / `t` - Smooth quadratic Bezier
1775
- * - `A rx ry angle large-arc sweep x y` / `a` - Elliptical arc
1776
- * - `Z` / `z` - Close path
1777
- */
1778
- SvgPathShape: {
1779
- /**
1780
- * @description The shape type - set to `path`. (enum property replaced by openapi-typescript)
1781
- * @enum {string}
1782
- */
1783
- type: "path";
1784
- /**
1785
- * @description The SVG path data string defining the shape.
1786
- * Uses standard SVG path commands (M, L, C, Q, A, Z, etc.).
1787
- * Example: `M 0 0 L 100 0 L 100 100 L 0 100 Z` draws a square.
1788
- * @example M 0 0 L 100 0 L 50 86.6 Z
1789
- */
1790
- d: string;
1791
- };
1792
- /**
1793
- * @description Fill properties for SVG shapes. Supports solid colors and gradients.
1794
- * The fill defines how the interior of a shape is painted.
1795
- */
1796
- SvgFill: components["schemas"]["SvgSolidFill"] | components["schemas"]["SvgLinearGradientFill"] | components["schemas"]["SvgRadialGradientFill"];
1797
- /** @description A solid color fill for SVG shapes. */
1798
- SvgSolidFill: {
1799
- /**
1800
- * @description The fill type - set to `solid` for a single color fill. (enum property replaced by openapi-typescript)
1801
- * @enum {string}
1802
- */
1803
- type: "solid";
1804
- /**
1805
- * @description The fill color using hexadecimal color notation (e.g., `#FF0000` for red).
1806
- * Must be a 6-digit hex color code prefixed with `#`.
1807
- * @default #000000
1808
- * @example #3498db
1809
- */
1810
- color: string;
1811
- /**
1812
- * @description The opacity of the fill where `1` is fully opaque and `0` is fully transparent.
1813
- * Values between 0 and 1 create semi-transparent fills.
1814
- * @default 1
1815
- * @example 0.8
1816
- */
1817
- opacity?: number;
1818
- };
1819
- /**
1820
- * @description A linear gradient fill that transitions colors along a straight line.
1821
- * The gradient direction is controlled by the `angle` property.
1822
- */
1823
- SvgLinearGradientFill: {
1824
- /**
1825
- * @description The fill type - set to `linear` for a linear gradient fill. (enum property replaced by openapi-typescript)
1826
- * @enum {string}
1827
- */
1828
- type: "linear";
1829
- /**
1830
- * @description The angle of the gradient in degrees. `0` is horizontal (left to right),
1831
- * `90` is vertical (bottom to top), `180` is right to left, etc.
1832
- * @default 0
1833
- * @example 45
1834
- */
1835
- angle?: number;
1836
- /**
1837
- * @description Array of color stops that define the gradient colors and their positions.
1838
- * Must have at least 2 stops. Offsets should increase from 0 to 1.
1839
- */
1840
- stops: components["schemas"]["SvgGradientStop"][];
1841
- /**
1842
- * @description The overall opacity of the gradient where `1` is fully opaque and `0` is fully transparent.
1843
- * @default 1
1844
- * @example 1
1845
- */
1846
- opacity?: number;
1847
- };
1848
- /**
1849
- * @description A radial gradient fill that transitions colors radiating outward from a center point.
1850
- * The gradient creates a circular or elliptical color transition.
1851
- */
1852
- SvgRadialGradientFill: {
1853
- /**
1854
- * @description The fill type - set to `radial` for a radial gradient fill. (enum property replaced by openapi-typescript)
1855
- * @enum {string}
1856
- */
1857
- type: "radial";
1858
- /**
1859
- * @description Array of color stops that define the gradient colors and their positions.
1860
- * Must have at least 2 stops. Offset `0` is the center, `1` is the outer edge.
1861
- */
1862
- stops: components["schemas"]["SvgGradientStop"][];
1863
- /**
1864
- * @description The overall opacity of the gradient where `1` is fully opaque and `0` is fully transparent.
1865
- * @default 1
1866
- * @example 1
1867
- */
1868
- opacity?: number;
1869
- };
1870
- /**
1871
- * @description A color stop in a gradient. Each stop defines a color at a specific position
1872
- * along the gradient vector. Gradients require at least 2 stops.
1873
- */
1874
- SvgGradientStop: {
1875
- /**
1876
- * @description Position of the color stop along the gradient vector.
1877
- * `0` represents the start and `1` represents the end of the gradient.
1878
- * @example 0.5
1879
- */
1880
- offset: number;
1881
- /**
1882
- * @description The color at this stop using hexadecimal color notation.
1883
- * @example #e74c3c
1884
- */
1885
- color: string;
1886
- };
1887
- /**
1888
- * @description Stroke (outline) properties for SVG shapes. The stroke defines how the outline
1889
- * of a shape is painted, including its color, width, and line style.
1890
- */
1891
- SvgStroke: {
1892
- /**
1893
- * @description The stroke color using hexadecimal color notation.
1894
- * @default #000000
1895
- * @example #2c3e50
1896
- */
1897
- color?: string;
1898
- /**
1899
- * @description The width of the stroke in pixels. Must be greater than 0.
1900
- * Larger values create thicker outlines.
1901
- * @default 1
1902
- * @example 2
1903
- */
1904
- width?: number;
1905
- /**
1906
- * @description The opacity of the stroke where `1` is opaque and `0` is transparent.
1907
- * @default 1
1908
- * @example 1
1909
- */
1910
- opacity?: number;
1911
- /**
1912
- * @description The shape at the end of open paths (lines, polylines, unclosed paths).
1913
- * <ul>
1914
- * <li>`butt` - flat edge perpendicular to the line (default)</li>
1915
- * <li>`round` - semicircular cap extending beyond the endpoint</li>
1916
- * <li>`square` - rectangular cap extending beyond the endpoint</li>
1917
- * </ul>
1918
- * @default butt
1919
- * @example round
1920
- * @enum {string}
1921
- */
1922
- lineCap?: "butt" | "round" | "square";
1923
- /**
1924
- * @description The shape at the corners where two lines meet.
1925
- * <ul>
1926
- * <li>`miter` - sharp corner (default)</li>
1927
- * <li>`round` - rounded corner</li>
1928
- * <li>`bevel` - flattened corner</li>
1929
- * </ul>
1930
- * @default miter
1931
- * @example round
1932
- * @enum {string}
1933
- */
1934
- lineJoin?: "miter" | "round" | "bevel";
1935
- /**
1936
- * @description Pattern of dashes and gaps for the stroke. An array of numbers where
1937
- * odd indices are dash lengths and even indices are gap lengths.
1938
- * For example, `[10, 5]` creates 10px dashes with 5px gaps.
1939
- * `[10, 5, 2, 5]` creates alternating 10px and 2px dashes with 5px gaps.
1940
- * @example [
1941
- * 10,
1942
- * 5
1943
- * ]
1944
- */
1945
- dashArray?: number[];
1946
- /**
1947
- * @description Offset for the dash pattern. Positive values shift the pattern
1948
- * forward along the path, negative values shift it backward.
1949
- * @default 0
1950
- * @example 5
1951
- */
1952
- dashOffset?: number;
1953
- };
1954
- /** @description Drop shadow properties for SVG shapes. Creates a shadow effect behind the shape. */
1955
- SvgShadow: {
1956
- /**
1957
- * @description Horizontal offset of the shadow in pixels.
1958
- * Positive values move the shadow to the right, negative to the left.
1959
- * @default 0
1960
- * @example 4
1961
- */
1962
- offsetX?: number;
1963
- /**
1964
- * @description Vertical offset of the shadow in pixels.
1965
- * Positive values move the shadow down, negative values move it up.
1966
- * @default 0
1967
- * @example 4
1968
- */
1969
- offsetY?: number;
1970
- /**
1971
- * @description The blur radius of the shadow in pixels. Must be 0 or greater.
1972
- * @default 0
1973
- * @example 8
1974
- */
1975
- blur?: number;
1976
- /**
1977
- * @description The shadow color using hexadecimal color notation.
1978
- * @default #000000
1979
- * @example #000000
1980
- */
1981
- color?: string;
1982
- /**
1983
- * @description The opacity of the shadow where `1` is opaque and `0` is transparent.
1984
- * @default 0.5
1985
- * @example 0.3
1986
- */
1987
- opacity?: number;
1988
- };
1989
- /** @description Transformation properties for positioning, rotating, and scaling SVG shapes. */
1990
- SvgTransform: {
1991
- /**
1992
- * @description The x-coordinate position of the shape in pixels.
1993
- * Relative to the top-left corner of the viewport.
1994
- * @default 0
1995
- * @example 100
1996
- */
1997
- x?: number;
1998
- /**
1999
- * @description The y-coordinate position of the shape in pixels.
2000
- * Relative to the top-left corner of the viewport.
2001
- * @default 0
2002
- * @example 100
2003
- */
2004
- y?: number;
2005
- /**
2006
- * @description Rotation angle in degrees. Positive values rotate clockwise,
2007
- * negative values rotate counter-clockwise. Range: -360 to 360.
2008
- * @default 0
2009
- * @example 45
2010
- */
2011
- rotation?: number;
2012
- /**
2013
- * @description Scale factor for the shape. `1` is original size, `2` is double size,
2014
- * `0.5` is half size. Must be greater than 0.
2015
- * @default 1
2016
- * @example 1.5
2017
- */
2018
- scale?: number;
2019
- /**
2020
- * @description The x-coordinate of the transformation origin as a value from 0 to 1.
2021
- * `0` is the left edge, `0.5` is the center, `1` is the right edge.
2022
- * @default 0.5
2023
- * @example 0.5
2024
- */
2025
- originX?: number;
2026
- /**
2027
- * @description The y-coordinate of the transformation origin as a value from 0 to 1.
2028
- * `0` is the top edge, `0.5` is the center, `1` is the bottom edge.
2029
- * @default 0.5
2030
- * @example 0.5
2031
- */
2032
- originY?: number;
1415
+ src: string;
2033
1416
  };
2034
1417
  /** @description In and out transitions for a clip - i.e. fade in and fade out */
2035
1418
  Transition: {