@shotstack/schemas 1.6.0 → 1.7.1

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

@@ -0,0 +1,93 @@
+{
+  "name": "SvgTransform",
+  "strict": true,
+  "schema": {
+    "description": "Transformation properties for positioning, rotating, and scaling SVG shapes.\n",
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+      "x": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "The x-coordinate position of the shape in pixels.\nRelative to the top-left corner of the viewport.\n"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "y": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "The y-coordinate position of the shape in pixels.\nRelative to the top-left corner of the viewport.\n"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "rotation": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "Rotation angle in degrees. Positive values rotate clockwise,\nnegative values rotate counter-clockwise. Range: -360 to 360.\n",
+            "minimum": -360,
+            "maximum": 360
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "scale": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "Scale factor for the shape. `1` is original size, `2` is double size,\n`0.5` is half size. Must be greater than 0.\n",
+            "minimum": 0.01,
+            "maximum": 100
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "originX": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "The x-coordinate of the transformation origin as a value from 0 to 1.\n`0` is the left edge, `0.5` is the center, `1` is the right edge.\n",
+            "minimum": 0,
+            "maximum": 1
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "originY": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "The y-coordinate of the transformation origin as a value from 0 to 1.\n`0` is the top edge, `0.5` is the center, `1` is the bottom edge.\n",
+            "minimum": 0,
+            "maximum": 1
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "required": [
+      "x",
+      "y",
+      "rotation",
+      "scale",
+      "originX",
+      "originY"
+    ]
+  }
+}

package/dist/json-schema/template.json

@@ -0,0 +1,541 @@
+{
+  "name": "Template",
+  "strict": true,
+  "schema": {
+    "type": "object",
+    "properties": {
+      "timeline": {
+        "$ref": "#/$defs/Timeline"
+      },
+      "output": {
+        "$ref": "#/$defs/Output"
+      },
+      "merge": {
+        "anyOf": [
+          {
+            "type": "array",
+            "items": {
+              "$ref": "#/$defs/MergeField"
+            }
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "additionalProperties": false,
+    "required": [
+      "timeline",
+      "output",
+      "merge"
+    ],
+    "$defs": {
+      "Timeline": {
+        "properties": {
+          "tracks": {
+            "type": "array",
+            "items": {
+              "$ref": "#/$defs/Track"
+            }
+          }
+        },
+        "additionalProperties": false,
+        "required": [
+          "tracks"
+        ],
+        "type": "object"
+      },
+      "Track": {
+        "properties": {
+          "clips": {
+            "type": "array",
+            "items": {
+              "$ref": "#/$defs/Clip"
+            }
+          }
+        },
+        "additionalProperties": false,
+        "required": [
+          "clips"
+        ],
+        "type": "object"
+      },
+      "Clip": {
+        "properties": {
+          "asset": {
+            "$ref": "#/$defs/Asset"
+          },
+          "start": {
+            "anyOf": [
+              {
+                "type": "number",
+                "minimum": 0
+              },
+              {
+                "type": "string"
+              }
+            ]
+          },
+          "length": {
+            "anyOf": [
+              {
+                "type": "number",
+                "minimum": 0
+              },
+              {
+                "type": "string"
+              }
+            ]
+          },
+          "fit": {
+            "anyOf": [
+              {
+                "type": "string",
+                "enum": [
+                  "cover",
+                  "contain",
+                  "crop",
+                  "none"
+                ]
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "position": {
+            "anyOf": [
+              {
+                "type": "string",
+                "enum": [
+                  "top",
+                  "topRight",
+                  "right",
+                  "bottomRight",
+                  "bottom",
+                  "bottomLeft",
+                  "left",
+                  "topLeft",
+                  "center"
+                ]
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "transition": {
+            "anyOf": [
+              {
+                "$ref": "#/$defs/Transition"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "effect": {
+            "anyOf": [
+              {
+                "type": "string",
+                "enum": [
+                  "zoomIn",
+                  "zoomInSlow",
+                  "zoomInFast",
+                  "zoomOut",
+                  "zoomOutSlow",
+                  "zoomOutFast",
+                  "slideLeft",
+                  "slideLeftSlow",
+                  "slideLeftFast",
+                  "slideRight",
+                  "slideRightSlow",
+                  "slideRightFast",
+                  "slideUp",
+                  "slideUpSlow",
+                  "slideUpFast",
+                  "slideDown",
+                  "slideDownSlow",
+                  "slideDownFast"
+                ]
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "additionalProperties": false,
+        "required": [
+          "asset",
+          "start",
+          "length",
+          "fit",
+          "position",
+          "transition",
+          "effect"
+        ],
+        "type": "object"
+      },
+      "Asset": {
+        "anyOf": [
+          {
+            "$ref": "#/$defs/VideoAsset"
+          },
+          {
+            "$ref": "#/$defs/ImageAsset"
+          },
+          {
+            "$ref": "#/$defs/AudioAsset"
+          }
+        ]
+      },
+      "VideoAsset": {
+        "type": "object",
+        "properties": {
+          "type": {
+            "enum": [
+              "video"
+            ],
+            "type": "string"
+          },
+          "src": {
+            "type": "string"
+          },
+          "trim": {
+            "anyOf": [
+              {
+                "type": "number"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "volume": {
+            "anyOf": [
+              {
+                "type": "number",
+                "minimum": 0,
+                "maximum": 1
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "volumeEffect": {
+            "anyOf": [
+              {
+                "type": "string",
+                "enum": [
+                  "none",
+                  "fadeIn",
+                  "fadeOut",
+                  "fadeInFadeOut"
+                ]
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "speed": {
+            "anyOf": [
+              {
+                "type": "number",
+                "minimum": 0,
+                "maximum": 10
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "additionalProperties": false,
+        "required": [
+          "type",
+          "src",
+          "trim",
+          "volume",
+          "volumeEffect",
+          "speed"
+        ]
+      },
+      "ImageAsset": {
+        "type": "object",
+        "properties": {
+          "type": {
+            "enum": [
+              "image"
+            ],
+            "type": "string"
+          },
+          "src": {
+            "type": "string"
+          }
+        },
+        "additionalProperties": false,
+        "required": [
+          "type",
+          "src"
+        ]
+      },
+      "AudioAsset": {
+        "type": "object",
+        "properties": {
+          "type": {
+            "enum": [
+              "audio"
+            ],
+            "type": "string"
+          },
+          "src": {
+            "type": "string"
+          },
+          "trim": {
+            "anyOf": [
+              {
+                "type": "number"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "volume": {
+            "anyOf": [
+              {
+                "type": "number",
+                "minimum": 0,
+                "maximum": 1
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "effect": {
+            "anyOf": [
+              {
+                "type": "string",
+                "enum": [
+                  "none",
+                  "fadeIn",
+                  "fadeOut",
+                  "fadeInFadeOut"
+                ]
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "additionalProperties": false,
+        "required": [
+          "type",
+          "src",
+          "trim",
+          "volume",
+          "effect"
+        ]
+      },
+      "Transition": {
+        "properties": {
+          "in": {
+            "anyOf": [
+              {
+                "type": "string",
+                "enum": [
+                  "none",
+                  "fade",
+                  "reveal",
+                  "wipeLeft",
+                  "wipeRight",
+                  "slideLeft",
+                  "slideRight",
+                  "slideUp",
+                  "slideDown",
+                  "carouselLeft",
+                  "carouselRight",
+                  "carouselUp",
+                  "carouselDown",
+                  "shuffleTopRight",
+                  "shuffleRightTop",
+                  "shuffleRightBottom",
+                  "shuffleBottomRight",
+                  "shuffleBottomLeft",
+                  "shuffleLeftBottom",
+                  "shuffleLeftTop",
+                  "shuffleTopLeft",
+                  "zoom"
+                ]
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "out": {
+            "anyOf": [
+              {
+                "type": "string",
+                "enum": [
+                  "none",
+                  "fade",
+                  "reveal",
+                  "wipeLeft",
+                  "wipeRight",
+                  "slideLeft",
+                  "slideRight",
+                  "slideUp",
+                  "slideDown",
+                  "carouselLeft",
+                  "carouselRight",
+                  "carouselUp",
+                  "carouselDown",
+                  "shuffleTopRight",
+                  "shuffleRightTop",
+                  "shuffleRightBottom",
+                  "shuffleBottomRight",
+                  "shuffleBottomLeft",
+                  "shuffleLeftBottom",
+                  "shuffleLeftTop",
+                  "shuffleTopLeft",
+                  "zoom"
+                ]
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "additionalProperties": false,
+        "type": "object",
+        "required": [
+          "in",
+          "out"
+        ]
+      },
+      "Output": {
+        "properties": {
+          "format": {
+            "enum": [
+              "mp4",
+              "gif",
+              "mp3",
+              "jpg",
+              "png",
+              "bmp"
+            ],
+            "type": "string"
+          },
+          "resolution": {
+            "anyOf": [
+              {
+                "type": "string",
+                "enum": [
+                  "preview",
+                  "mobile",
+                  "sd",
+                  "hd",
+                  "1080",
+                  "4k"
+                ]
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "aspectRatio": {
+            "anyOf": [
+              {
+                "type": "string",
+                "enum": [
+                  "16:9",
+                  "9:16",
+                  "1:1",
+                  "4:5",
+                  "4:3"
+                ]
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "fps": {
+            "anyOf": [
+              {
+                "type": "number",
+                "enum": [
+                  12,
+                  15,
+                  23.976,
+                  24,
+                  25,
+                  29.97,
+                  30,
+                  48,
+                  50,
+                  59.94,
+                  60
+                ]
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "quality": {
+            "anyOf": [
+              {
+                "type": "string",
+                "enum": [
+                  "verylow",
+                  "low",
+                  "medium",
+                  "high",
+                  "veryhigh"
+                ]
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "additionalProperties": false,
+        "required": [
+          "format",
+          "resolution",
+          "aspectRatio",
+          "fps",
+          "quality"
+        ],
+        "type": "object"
+      },
+      "MergeField": {
+        "type": "object",
+        "properties": {
+          "find": {
+            "type": "string"
+          },
+          "replace": {
+            "type": "string"
+          }
+        },
+        "additionalProperties": false,
+        "required": [
+          "find",
+          "replace"
+        ]
+      }
+    }
+  }
+}