@shotstack/schemas 1.6.0 → 1.7.1

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

@@ -0,0 +1,79 @@
+{
+  "name": "SvgShadow",
+  "strict": true,
+  "schema": {
+    "description": "Drop shadow properties for SVG shapes. Creates a shadow effect behind the shape.\n",
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+      "offsetX": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "Horizontal offset of the shadow in pixels.\nPositive values move the shadow to the right, negative to the left.\n"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "offsetY": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "Vertical offset of the shadow in pixels.\nPositive values move the shadow down, negative values move it up.\n"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "blur": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "The blur radius of the shadow in pixels. Must be 0 or greater.",
+            "minimum": 0
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "color": {
+        "anyOf": [
+          {
+            "type": "string",
+            "description": "The shadow color using hexadecimal color notation.",
+            "enum": [
+              "#000000"
+            ]
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "opacity": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "The opacity of the shadow where `1` is opaque and `0` is transparent.",
+            "minimum": 0,
+            "maximum": 1
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "required": [
+      "offsetX",
+      "offsetY",
+      "blur",
+      "color",
+      "opacity"
+    ]
+  }
+}

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

@@ -0,0 +1,404 @@
+{
+  "name": "SvgShape",
+  "strict": true,
+  "schema": {
+    "description": "The shape definiti...",
+    "anyOf": [
+      {
+        "$ref": "#/$defs/SvgRectangleShape"
+      },
+      {
+        "$ref": "#/$defs/SvgCircleShape"
+      },
+      {
+        "$ref": "#/$defs/SvgEllipseShape"
+      },
+      {
+        "$ref": "#/$defs/SvgLineShape"
+      },
+      {
+        "$ref": "#/$defs/SvgPolygonShape"
+      },
+      {
+        "$ref": "#/$defs/SvgStarShape"
+      },
+      {
+        "$ref": "#/$defs/SvgArrowShape"
+      },
+      {
+        "$ref": "#/$defs/SvgHeartShape"
+      },
+      {
+        "$ref": "#/$defs/SvgCrossShape"
+      },
+      {
+        "$ref": "#/$defs/SvgRingShape"
+      },
+      {
+        "$ref": "#/$defs/SvgPathShape"
+      }
+    ],
+    "$defs": {
+      "SvgRectangleShape": {
+        "description": "A rectangle s...",
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "type": {
+            "description": "Th...",
+            "type": "string",
+            "enum": [
+              "rectangle"
+            ]
+          },
+          "width": {
+            "description": "Th...",
+            "type": "number",
+            "minimum": 1,
+            "maximum": 4096
+          },
+          "height": {
+            "description": "Th...",
+            "type": "number",
+            "minimum": 1,
+            "maximum": 4096
+          },
+          "cornerRadius": {
+            "anyOf": [
+              {
+                "type": "number",
+                "description": "The corner radius f...",
+                "minimum": 0,
+                "maximum": 2048
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "required": [
+          "type",
+          "width",
+          "height",
+          "cornerRadius"
+        ]
+      },
+      "SvgCircleShape": {
+        "description": "A perfect c...",
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "type": {
+            "description": "T...",
+            "type": "string",
+            "enum": [
+              "circle"
+            ]
+          },
+          "radius": {
+            "description": "Th...",
+            "type": "number",
+            "minimum": 1,
+            "maximum": 2048
+          }
+        },
+        "required": [
+          "type",
+          "radius"
+        ]
+      },
+      "SvgEllipseShape": {
+        "description": "An ellipse (ov...",
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "type": {
+            "description": "Th...",
+            "type": "string",
+            "enum": [
+              "ellipse"
+            ]
+          },
+          "radiusX": {
+            "description": "The ...",
+            "type": "number",
+            "minimum": 1,
+            "maximum": 2048
+          },
+          "radiusY": {
+            "description": "The ...",
+            "type": "number",
+            "minimum": 1,
+            "maximum": 2048
+          }
+        },
+        "required": [
+          "type",
+          "radiusX",
+          "radiusY"
+        ]
+      },
+      "SvgLineShape": {
+        "description": "A straight line s...",
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "type": {
+            "description": "T...",
+            "type": "string",
+            "enum": [
+              "line"
+            ]
+          },
+          "length": {
+            "description": "T...",
+            "type": "number",
+            "minimum": 1,
+            "maximum": 4096
+          },
+          "thickness": {
+            "description": "Th...",
+            "type": "number",
+            "minimum": 1,
+            "maximum": 500
+          }
+        },
+        "required": [
+          "type",
+          "length",
+          "thickness"
+        ]
+      },
+      "SvgPolygonShape": {
+        "description": "A regular polygon shape ...",
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "type": {
+            "description": "Th...",
+            "type": "string",
+            "enum": [
+              "polygon"
+            ]
+          },
+          "sides": {
+            "description": "The number...",
+            "type": "integer",
+            "minimum": 3,
+            "maximum": 100
+          },
+          "radius": {
+            "description": "The radius...",
+            "type": "number",
+            "minimum": 1,
+            "maximum": 2048
+          }
+        },
+        "required": [
+          "type",
+          "sides",
+          "radius"
+        ]
+      },
+      "SvgStarShape": {
+        "description": "A star shape with ...",
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "type": {
+            "description": "T...",
+            "type": "string",
+            "enum": [
+              "star"
+            ]
+          },
+          "points": {
+            "description": "The number o...",
+            "type": "integer",
+            "minimum": 3,
+            "maximum": 100
+          },
+          "outerRadius": {
+            "description": "The outer...",
+            "type": "number",
+            "minimum": 1,
+            "maximum": 2048
+          },
+          "innerRadius": {
+            "description": "The inner radius...",
+            "type": "number",
+            "minimum": 1,
+            "maximum": 2048
+          }
+        },
+        "required": [
+          "type",
+          "points",
+          "outerRadius",
+          "innerRadius"
+        ]
+      },
+      "SvgArrowShape": {
+        "description": "An arrow s...",
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "type": {
+            "description": "T...",
+            "type": "string",
+            "enum": [
+              "arrow"
+            ]
+          },
+          "length": {
+            "description": "The t...",
+            "type": "number",
+            "minimum": 1,
+            "maximum": 4096
+          },
+          "headWidth": {
+            "description": "The w...",
+            "type": "number",
+            "minimum": 1,
+            "maximum": 1000
+          },
+          "headLength": {
+            "description": "The ...",
+            "type": "number",
+            "minimum": 1,
+            "maximum": 1000
+          },
+          "shaftWidth": {
+            "description": "The...",
+            "type": "number",
+            "minimum": 1,
+            "maximum": 1000
+          }
+        },
+        "required": [
+          "type",
+          "length",
+          "headWidth",
+          "headLength",
+          "shaftWidth"
+        ]
+      },
+      "SvgHeartShape": {
+        "description": "A heart sha...",
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "type": {
+            "description": "T...",
+            "type": "string",
+            "enum": [
+              "heart"
+            ]
+          },
+          "size": {
+            "description": "The size o...",
+            "type": "number",
+            "minimum": 1,
+            "maximum": 4096
+          }
+        },
+        "required": [
+          "type",
+          "size"
+        ]
+      },
+      "SvgCrossShape": {
+        "description": "A cross or plus...",
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "type": {
+            "description": "T...",
+            "type": "string",
+            "enum": [
+              "cross"
+            ]
+          },
+          "width": {
+            "description": "Th...",
+            "type": "number",
+            "minimum": 1,
+            "maximum": 4096
+          },
+          "height": {
+            "description": "Th...",
+            "type": "number",
+            "minimum": 1,
+            "maximum": 4096
+          },
+          "thickness": {
+            "description": "The...",
+            "type": "number",
+            "minimum": 1,
+            "maximum": 500
+          }
+        },
+        "required": [
+          "type",
+          "width",
+          "height",
+          "thickness"
+        ]
+      },
+      "SvgRingShape": {
+        "description": "A ring (donut/a...",
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "type": {
+            "description": "T...",
+            "type": "string",
+            "enum": [
+              "ring"
+            ]
+          },
+          "outerRadius": {
+            "description": "Th...",
+            "type": "number",
+            "minimum": 1,
+            "maximum": 2048
+          },
+          "innerRadius": {
+            "description": "The inner...",
+            "type": "number",
+            "minimum": 0,
+            "maximum": 2048
+          }
+        },
+        "required": [
+          "type",
+          "outerRadius",
+          "innerRadius"
+        ]
+      },
+      "SvgPathShape": {
+        "description": "A custom shape defined by SVG path data.\nSupports all standard SVG path command...",
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "type": {
+            "description": "T...",
+            "type": "string",
+            "enum": [
+              "path"
+            ]
+          },
+          "d": {
+            "description": "The SVG path data str...",
+            "type": "string"
+          }
+        },
+        "required": [
+          "type",
+          "d"
+        ]
+      }
+    }
+  }
+}

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

@@ -0,0 +1,40 @@
+{
+  "name": "SvgSolidFill",
+  "strict": true,
+  "schema": {
+    "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"
+    ]
+  }
+}

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

@@ -0,0 +1,42 @@
+{
+  "name": "SvgStarShape",
+  "strict": true,
+  "schema": {
+    "description": "A star shape with a specified number of points.\nThe star is defined by outer and inner radii, creating the characteristic\npointed appearance.\n",
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+      "type": {
+        "description": "The shape type - set to `star`.",
+        "type": "string",
+        "enum": [
+          "star"
+        ]
+      },
+      "points": {
+        "description": "The number of points on the star.\nMinimum 3 for a triangle-like star, typically 5 for a classic star.\n",
+        "type": "integer",
+        "minimum": 3,
+        "maximum": 100
+      },
+      "outerRadius": {
+        "description": "The outer radius in pixels - the distance from center to the tips of the points.\n",
+        "type": "number",
+        "minimum": 1,
+        "maximum": 2048
+      },
+      "innerRadius": {
+        "description": "The inner radius in pixels - the distance from center to the inner vertices.\nShould be smaller than outerRadius for a star effect.\n",
+        "type": "number",
+        "minimum": 1,
+        "maximum": 2048
+      }
+    },
+    "required": [
+      "type",
+      "points",
+      "outerRadius",
+      "innerRadius"
+    ]
+  }
+}

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

@@ -0,0 +1,115 @@
+{
+  "name": "SvgStroke",
+  "strict": true,
+  "schema": {
+    "description": "Stroke (outline) properties for SVG shapes. The stroke defines how the outline\nof a shape is painted, including its color, width, and line style.\n",
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+      "color": {
+        "anyOf": [
+          {
+            "type": "string",
+            "description": "The stroke color using hexadecimal color notation."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "width": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "The width of the stroke in pixels. Must be greater than 0.\nLarger values create thicker outlines.\n",
+            "minimum": 0,
+            "maximum": 100
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "opacity": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "The opacity of the stroke where `1` is opaque and `0` is transparent.",
+            "minimum": 0,
+            "maximum": 1
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "lineCap": {
+        "anyOf": [
+          {
+            "type": "string",
+            "description": "The shape at the end of open paths (lines, polylines, unclosed paths).\n<ul>\n  <li>`butt` - flat edge perpendicular to the line (default)</li>\n  <li>`round` - semicircular cap extending beyond the endpoint</li>\n  <li>`square` - rectangular cap extending beyond the endpoint</li>\n</ul>\n",
+            "enum": [
+              "butt",
+              "round",
+              "square"
+            ]
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "lineJoin": {
+        "anyOf": [
+          {
+            "type": "string",
+            "description": "The shape at the corners where two lines meet.\n<ul>\n  <li>`miter` - sharp corner (default)</li>\n  <li>`round` - rounded corner</li>\n  <li>`bevel` - flattened corner</li>\n</ul>\n",
+            "enum": [
+              "miter",
+              "round",
+              "bevel"
+            ]
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "dashArray": {
+        "anyOf": [
+          {
+            "type": "array",
+            "description": "Pattern of dashes and gaps for the stroke. An array of numbers where\nodd indices are dash lengths and even indices are gap lengths.\nFor example, `[10, 5]` creates 10px dashes with 5px gaps.\n`[10, 5, 2, 5]` creates alternating 10px and 2px dashes with 5px gaps.\n",
+            "items": {
+              "type": "number",
+              "minimum": 0
+            }
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "dashOffset": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "Offset for the dash pattern. Positive values shift the pattern\nforward along the path, negative values shift it backward.\n"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "required": [
+      "color",
+      "width",
+      "opacity",
+      "lineCap",
+      "lineJoin",
+      "dashArray",
+      "dashOffset"
+    ]
+  }
+}