@shotstack/schemas 1.6.0 → 1.7.0

package/dist/json-schema/svg-circle-shape.json

@@ -0,0 +1,28 @@
+{
+  "name": "SvgCircleShape",
+  "strict": true,
+  "schema": {
+    "description": "A perfect circle shape defined by its radius.\nThe circle is centered at the shape's position.\n",
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+      "type": {
+        "description": "The shape type - set to `circle`.",
+        "type": "string",
+        "enum": [
+          "circle"
+        ]
+      },
+      "radius": {
+        "description": "The radius of the circle in pixels.",
+        "type": "number",
+        "minimum": 1,
+        "maximum": 2048
+      }
+    },
+    "required": [
+      "type",
+      "radius"
+    ]
+  }
+}

package/dist/json-schema/svg-cross-shape.json

@@ -0,0 +1,42 @@
+{
+  "name": "SvgCrossShape",
+  "strict": true,
+  "schema": {
+    "description": "A cross or plus shape with equal or different arm lengths.\nCan be styled as a plus sign (+) or a cross (x with rotation).\n",
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+      "type": {
+        "description": "The shape type - set to `cross`.",
+        "type": "string",
+        "enum": [
+          "cross"
+        ]
+      },
+      "width": {
+        "description": "The total width of the cross in pixels.",
+        "type": "number",
+        "minimum": 1,
+        "maximum": 4096
+      },
+      "height": {
+        "description": "The total height of the cross in pixels.",
+        "type": "number",
+        "minimum": 1,
+        "maximum": 4096
+      },
+      "thickness": {
+        "description": "The thickness of the cross arms in pixels.",
+        "type": "number",
+        "minimum": 1,
+        "maximum": 500
+      }
+    },
+    "required": [
+      "type",
+      "width",
+      "height",
+      "thickness"
+    ]
+  }
+}

package/dist/json-schema/svg-ellipse-shape.json

@@ -0,0 +1,35 @@
+{
+  "name": "SvgEllipseShape",
+  "strict": true,
+  "schema": {
+    "description": "An ellipse (oval) shape with separate horizontal and vertical radii.\nThe ellipse is centered at the shape's position.\n",
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+      "type": {
+        "description": "The shape type - set to `ellipse`.",
+        "type": "string",
+        "enum": [
+          "ellipse"
+        ]
+      },
+      "radiusX": {
+        "description": "The horizontal radius (semi-major axis) in pixels.",
+        "type": "number",
+        "minimum": 1,
+        "maximum": 2048
+      },
+      "radiusY": {
+        "description": "The vertical radius (semi-minor axis) in pixels.",
+        "type": "number",
+        "minimum": 1,
+        "maximum": 2048
+      }
+    },
+    "required": [
+      "type",
+      "radiusX",
+      "radiusY"
+    ]
+  }
+}

package/dist/json-schema/svg-fill.json

@@ -0,0 +1,169 @@
+{
+  "name": "SvgFill",
+  "strict": true,
+  "schema": {
+    "description": "Fill properties for SVG shapes. Supports solid colors and gradients.\nThe fill defines how the interior of a shape is painted.\n",
+    "anyOf": [
+      {
+        "$ref": "#/$defs/SvgSolidFill"
+      },
+      {
+        "$ref": "#/$defs/SvgLinearGradientFill"
+      },
+      {
+        "$ref": "#/$defs/SvgRadialGradientFill"
+      }
+    ],
+    "$defs": {
+      "SvgSolidFill": {
+        "description": "A solid color fill for SVG shapes.",
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "type": {
+            "description": "The fill type - set to `solid` for a single color fill.",
+            "type": "string",
+            "enum": [
+              "solid"
+            ]
+          },
+          "color": {
+            "description": "The fill color using hexadecimal color notation (e.g., `#FF0000` for red).\nMust be a 6-digit hex color code prefixed with `#`.\n",
+            "type": "string"
+          },
+          "opacity": {
+            "anyOf": [
+              {
+                "type": "number",
+                "description": "The opacity of the fill where `1` is fully opaque and `0` is fully transparent.\nValues between 0 and 1 create semi-transparent fills.\n",
+                "minimum": 0,
+                "maximum": 1
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "required": [
+          "type",
+          "color",
+          "opacity"
+        ]
+      },
+      "SvgLinearGradientFill": {
+        "description": "A linear gradient fill that transitions colors along a straight line.\nThe gradient direction is controlled by the `angle` property.\n",
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "type": {
+            "description": "The fill type - set to `linear` for a linear gradient fill.",
+            "type": "string",
+            "enum": [
+              "linear"
+            ]
+          },
+          "angle": {
+            "anyOf": [
+              {
+                "type": "number",
+                "description": "The angle of the gradient in degrees. `0` is horizontal (left to right),\n`90` is vertical (bottom to top), `180` is right to left, etc.\n",
+                "minimum": 0,
+                "maximum": 360
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "stops": {
+            "description": "Array of color stops that define the gradient colors and their positions.\nMust have at least 2 stops. Offsets should increase from 0 to 1.\n",
+            "type": "array",
+            "items": {
+              "$ref": "#/$defs/SvgGradientStop"
+            }
+          },
+          "opacity": {
+            "anyOf": [
+              {
+                "type": "number",
+                "description": "The overall opacity of the gradient where `1` is fully opaque and `0` is fully transparent.\n",
+                "minimum": 0,
+                "maximum": 1
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "required": [
+          "type",
+          "angle",
+          "stops",
+          "opacity"
+        ]
+      },
+      "SvgGradientStop": {
+        "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",
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "offset": {
+            "description": "Position of the color stop along the gradient vector.\n`0` represents the start and `1` represents the end of the gradient.\n",
+            "type": "number",
+            "minimum": 0,
+            "maximum": 1
+          },
+          "color": {
+            "description": "The color at this stop using hexadecimal color notation.",
+            "type": "string"
+          }
+        },
+        "required": [
+          "offset",
+          "color"
+        ]
+      },
+      "SvgRadialGradientFill": {
+        "description": "A radial gradient fill that transitions colors radiating outward from a center point.\nThe gradient creates a circular or elliptical color transition.\n",
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "type": {
+            "description": "The fill type - set to `radial` for a radial gradient fill.",
+            "type": "string",
+            "enum": [
+              "radial"
+            ]
+          },
+          "stops": {
+            "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",
+            "type": "array",
+            "items": {
+              "$ref": "#/$defs/SvgGradientStop"
+            }
+          },
+          "opacity": {
+            "anyOf": [
+              {
+                "type": "number",
+                "description": "The overall opacity of the gradient where `1` is fully opaque and `0` is fully transparent.\n",
+                "minimum": 0,
+                "maximum": 1
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "required": [
+          "type",
+          "stops",
+          "opacity"
+        ]
+      }
+    }
+  }
+}

package/dist/json-schema/svg-gradient-stop.json

@@ -0,0 +1,25 @@
+{
+  "name": "SvgGradientStop",
+  "strict": true,
+  "schema": {
+    "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",
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+      "offset": {
+        "description": "Position of the color stop along the gradient vector.\n`0` represents the start and `1` represents the end of the gradient.\n",
+        "type": "number",
+        "minimum": 0,
+        "maximum": 1
+      },
+      "color": {
+        "description": "The color at this stop using hexadecimal color notation.",
+        "type": "string"
+      }
+    },
+    "required": [
+      "offset",
+      "color"
+    ]
+  }
+}

package/dist/json-schema/svg-heart-shape.json

@@ -0,0 +1,28 @@
+{
+  "name": "SvgHeartShape",
+  "strict": true,
+  "schema": {
+    "description": "A heart shape commonly used for love/like icons.\nThe heart is defined by a single size parameter.\n",
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+      "type": {
+        "description": "The shape type - set to `heart`.",
+        "type": "string",
+        "enum": [
+          "heart"
+        ]
+      },
+      "size": {
+        "description": "The size of the heart in pixels.\nThis determines both the width and height proportionally.\n",
+        "type": "number",
+        "minimum": 1,
+        "maximum": 4096
+      }
+    },
+    "required": [
+      "type",
+      "size"
+    ]
+  }
+}

package/dist/json-schema/svg-line-shape.json

@@ -0,0 +1,35 @@
+{
+  "name": "SvgLineShape",
+  "strict": true,
+  "schema": {
+    "description": "A straight line shape with a specified length and thickness.\nThe line is drawn horizontally by default and can be rotated using transform.\n",
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+      "type": {
+        "description": "The shape type - set to `line`.",
+        "type": "string",
+        "enum": [
+          "line"
+        ]
+      },
+      "length": {
+        "description": "The length of the line in pixels.",
+        "type": "number",
+        "minimum": 1,
+        "maximum": 4096
+      },
+      "thickness": {
+        "description": "The thickness of the line in pixels.",
+        "type": "number",
+        "minimum": 1,
+        "maximum": 500
+      }
+    },
+    "required": [
+      "type",
+      "length",
+      "thickness"
+    ]
+  }
+}

package/dist/json-schema/svg-linear-gradient-fill.json

@@ -0,0 +1,80 @@
+{
+  "name": "SvgLinearGradientFill",
+  "strict": true,
+  "schema": {
+    "description": "A linear gradient fill that transitions colors along a straight line.\nThe gradient direction is controlled by the `angle` property.\n",
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+      "type": {
+        "description": "The fill type - set to `linear` for a linear gradient fill.",
+        "type": "string",
+        "enum": [
+          "linear"
+        ]
+      },
+      "angle": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "The angle of the gradient in degrees. `0` is horizontal (left to right),\n`90` is vertical (bottom to top), `180` is right to left, etc.\n",
+            "minimum": 0,
+            "maximum": 360
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "stops": {
+        "description": "Array of color stops that define the gradient colors and their positions.\nMust have at least 2 stops. Offsets should increase from 0 to 1.\n",
+        "type": "array",
+        "items": {
+          "$ref": "#/$defs/SvgGradientStop"
+        }
+      },
+      "opacity": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "The overall opacity of the gradient where `1` is fully opaque and `0` is fully transparent.\n",
+            "minimum": 0,
+            "maximum": 1
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "required": [
+      "type",
+      "angle",
+      "stops",
+      "opacity"
+    ],
+    "$defs": {
+      "SvgGradientStop": {
+        "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",
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "offset": {
+            "description": "Position of the color stop along the gradient vector.\n`0` represents the start and `1` represents the end of the gradient.\n",
+            "type": "number",
+            "minimum": 0,
+            "maximum": 1
+          },
+          "color": {
+            "description": "The color at this stop using hexadecimal color notation.",
+            "type": "string"
+          }
+        },
+        "required": [
+          "offset",
+          "color"
+        ]
+      }
+    }
+  }
+}

package/dist/json-schema/svg-path-shape.json

@@ -0,0 +1,26 @@
+{
+  "name": "SvgPathShape",
+  "strict": true,
+  "schema": {
+    "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",
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+      "type": {
+        "description": "The shape type - set to `path`.",
+        "type": "string",
+        "enum": [
+          "path"
+        ]
+      },
+      "d": {
+        "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",
+        "type": "string"
+      }
+    },
+    "required": [
+      "type",
+      "d"
+    ]
+  }
+}

package/dist/json-schema/svg-polygon-shape.json

@@ -0,0 +1,35 @@
+{
+  "name": "SvgPolygonShape",
+  "strict": true,
+  "schema": {
+    "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",
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+      "type": {
+        "description": "The shape type - set to `polygon`.",
+        "type": "string",
+        "enum": [
+          "polygon"
+        ]
+      },
+      "sides": {
+        "description": "The number of sides of the polygon.\nMinimum 3 (triangle), maximum 100 for practical use.\n",
+        "type": "integer",
+        "minimum": 3,
+        "maximum": 100
+      },
+      "radius": {
+        "description": "The radius of the circumscribed circle in pixels.\nThis determines the size of the polygon.\n",
+        "type": "number",
+        "minimum": 1,
+        "maximum": 2048
+      }
+    },
+    "required": [
+      "type",
+      "sides",
+      "radius"
+    ]
+  }
+}

package/dist/json-schema/svg-radial-gradient-fill.json

@@ -0,0 +1,66 @@
+{
+  "name": "SvgRadialGradientFill",
+  "strict": true,
+  "schema": {
+    "description": "A radial gradient fill that transitions colors radiating outward from a center point.\nThe gradient creates a circular or elliptical color transition.\n",
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+      "type": {
+        "description": "The fill type - set to `radial` for a radial gradient fill.",
+        "type": "string",
+        "enum": [
+          "radial"
+        ]
+      },
+      "stops": {
+        "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",
+        "type": "array",
+        "items": {
+          "$ref": "#/$defs/SvgGradientStop"
+        }
+      },
+      "opacity": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "The overall opacity of the gradient where `1` is fully opaque and `0` is fully transparent.\n",
+            "minimum": 0,
+            "maximum": 1
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "required": [
+      "type",
+      "stops",
+      "opacity"
+    ],
+    "$defs": {
+      "SvgGradientStop": {
+        "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",
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "offset": {
+            "description": "Position of the color stop along the gradient vector.\n`0` represents the start and `1` represents the end of the gradient.\n",
+            "type": "number",
+            "minimum": 0,
+            "maximum": 1
+          },
+          "color": {
+            "description": "The color at this stop using hexadecimal color notation.",
+            "type": "string"
+          }
+        },
+        "required": [
+          "offset",
+          "color"
+        ]
+      }
+    }
+  }
+}

package/dist/json-schema/svg-rectangle-shape.json

@@ -0,0 +1,49 @@
+{
+  "name": "SvgRectangleShape",
+  "strict": true,
+  "schema": {
+    "description": "A rectangle shape with optional rounded corners.\nThe rectangle is defined by its width and height dimensions.\n",
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+      "type": {
+        "description": "The shape type - set to `rectangle`.",
+        "type": "string",
+        "enum": [
+          "rectangle"
+        ]
+      },
+      "width": {
+        "description": "The width of the rectangle in pixels.",
+        "type": "number",
+        "minimum": 1,
+        "maximum": 4096
+      },
+      "height": {
+        "description": "The height of the rectangle in pixels.",
+        "type": "number",
+        "minimum": 1,
+        "maximum": 4096
+      },
+      "cornerRadius": {
+        "anyOf": [
+          {
+            "type": "number",
+            "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",
+            "minimum": 0,
+            "maximum": 2048
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "required": [
+      "type",
+      "width",
+      "height",
+      "cornerRadius"
+    ]
+  }
+}

package/dist/json-schema/svg-ring-shape.json

@@ -0,0 +1,35 @@
+{
+  "name": "SvgRingShape",
+  "strict": true,
+  "schema": {
+    "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",
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+      "type": {
+        "description": "The shape type - set to `ring`.",
+        "type": "string",
+        "enum": [
+          "ring"
+        ]
+      },
+      "outerRadius": {
+        "description": "The outer radius of the ring in pixels.",
+        "type": "number",
+        "minimum": 1,
+        "maximum": 2048
+      },
+      "innerRadius": {
+        "description": "The inner radius (hole) of the ring in pixels.\nMust be smaller than outerRadius.\n",
+        "type": "number",
+        "minimum": 0,
+        "maximum": 2048
+      }
+    },
+    "required": [
+      "type",
+      "outerRadius",
+      "innerRadius"
+    ]
+  }
+}