@shotstack/schemas 1.6.0 → 1.7.1

package/dist/json-schema/transformation.json

@@ -0,0 +1,281 @@
+{
+  "name": "Transformation",
+  "strict": true,
+  "schema": {
+    "description": "Apply one or more transformations to a clip. Transformations alter the visual properties of a clip and can be combined t...",
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+      "rotate": {
+        "anyOf": [
+          {
+            "$ref": "#/$defs/RotateTransformation"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "skew": {
+        "anyOf": [
+          {
+            "$ref": "#/$defs/SkewTransformation"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "flip": {
+        "anyOf": [
+          {
+            "$ref": "#/$defs/FlipTransformation"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "required": [
+      "rotate",
+      "skew",
+      "flip"
+    ],
+    "$defs": {
+      "RotateTransformation": {
+        "description": "Rotate a clip by the specified angle in degrees. Rotation origin is set based on...",
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "angle": {
+            "description": "Rotate a clip by the specified angle in degrees. Use a number or an array of [Tween](./#tocs_tween) objects ...",
+            "anyOf": [
+              {
+                "type": "number",
+                "description": "The angle to rotate the clip. Can be 0 to 360, or 0 to -360. Using a positive number rotates the clip clockwise, nega...",
+                "minimum": -360,
+                "maximum": 360
+              },
+              {
+                "type": "array",
+                "description": "An array of [Tween](./#tocs_tween) objects used to create a custom animation. Animate the rotat...",
+                "items": {
+                  "$ref": "#/$defs/Tween"
+                }
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "required": [
+          "angle"
+        ]
+      },
+      "Tween": {
+        "description": "Use a Tween to [animate properties over time](/docs/guide/architecting-an-application/animations/). The following properties are currently supported and can be animated:\n  <ul>\n    <li>Opacity - animate the transparency of a clip.</li>\n    <li>Offset - animate the x and y position of a clip.</li>\n    <li>Rotation - animate the rotation of a clip.</li>\n    <li>Skew - animate the horizontal and v...",
+        "properties": {
+          "from": {
+            "anyOf": [
+              {
+                "type": "string",
+                "description": "The initial property value at the start of ..."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "to": {
+            "anyOf": [
+              {
+                "type": "string",
+                "description": "The final property value at the end of t..."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "start": {
+            "anyOf": [
+              {
+                "type": "number",
+                "description": "The time in seconds when the animation starts, relative to the clip..."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "length": {
+            "anyOf": [
+              {
+                "type": "number",
+                "description": "The duration of the animation ..."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "interpolation": {
+            "anyOf": [
+              {
+                "type": "string",
+                "description": "The interpolation method to use for the animation. Available options are: <ul>\n  <li>`linear` - a linear interpolation between the start and end values.</li>\n  <li>`bezier` - a bezier curve interpolation between the start and end values.</li>\n  <li>`constant` - an interpolation where the property instantly jumps...",
+                "enum": [
+                  "linear",
+                  "bezier",
+                  "constant"
+                ]
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "easing": {
+            "anyOf": [
+              {
+                "type": "string",
+                "description": "The easing function to use for the animation. Easing controls the rate of change of the animated value, allowing for more natural motion by speeding up or slowing down the animation at different points. O...",
+                "enum": [
+                  "ease",
+                  "easeIn",
+                  "easeOut",
+                  "easeInOut",
+                  "easeInQuad",
+                  "easeInCubic",
+                  "easeInQuart",
+                  "easeInQuint",
+                  "easeInSine",
+                  "easeInExpo",
+                  "easeInCirc",
+                  "easeInBack",
+                  "easeOutQuad",
+                  "easeOutCubic",
+                  "easeOutQuart",
+                  "easeOutQuint",
+                  "easeOutSine",
+                  "easeOutExpo",
+                  "easeOutCirc",
+                  "easeOutBack",
+                  "easeInOutQuad",
+                  "easeInOutCubic",
+                  "easeInOutQuart",
+                  "easeInOutQuint",
+                  "easeInOutSine",
+                  "easeInOutExpo",
+                  "easeInOutCirc",
+                  "easeInOutBack"
+                ]
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "additionalProperties": false,
+        "type": "object",
+        "required": [
+          "from",
+          "to",
+          "start",
+          "length",
+          "interpolation",
+          "easing"
+        ]
+      },
+      "SkewTransformation": {
+        "description": "Skew a clip so its edges are sheared at an angle. Use values between -100 and 100. Values over 3 or under -3 w...",
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "x": {
+            "description": "Skew the clip along it'...",
+            "anyOf": [
+              {
+                "type": "number",
+                "description": "Range varies from -100 to 100. Positive numbers skew the asset right, negative left. The distance moved is relative to the width of the viewport - i.e. an X skew of 0.5 will skew ...",
+                "minimum": -100,
+                "maximum": 100
+              },
+              {
+                "type": "array",
+                "description": "An array of [Tween](./#tocs_tween) objects used to create a custom animation. Animate the X s...",
+                "items": {
+                  "$ref": "#/$defs/Tween"
+                }
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "y": {
+            "description": "Skew the clip along it'...",
+            "anyOf": [
+              {
+                "type": "number",
+                "description": "Range varies from -100 to 100. Positive numbers skew the asset up, negative down. The distance moved is relative to the height of the viewport - i.e. an Y skew of 0.5 wil...",
+                "minimum": -100,
+                "maximum": 100
+              },
+              {
+                "type": "array",
+                "description": "An array of [Tween](./#tocs_tween) objects used to create a custom animation. Animate the Y s...",
+                "items": {
+                  "$ref": "#/$defs/Tween"
+                }
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "required": [
+          "x",
+          "y"
+        ]
+      },
+      "FlipTransformation": {
+        "description": "Flip a clip vertically or horizontally. Acts as a mirror effect of the clip alo...",
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "horizontal": {
+            "anyOf": [
+              {
+                "type": "boolean",
+                "description": "Flip a clip horiz..."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "vertical": {
+            "anyOf": [
+              {
+                "type": "boolean",
+                "description": "Flip a clip ver..."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "required": [
+          "horizontal",
+          "vertical"
+        ]
+      }
+    }
+  }
+}

package/dist/json-schema/transition.json

@@ -0,0 +1,85 @@
+{
+  "name": "Transition",
+  "strict": true,
+  "schema": {
+    "description": "In and out transitions for a clip - i.e. fade in and fade out",
+    "properties": {
+      "in": {
+        "anyOf": [
+          {
+            "type": "string",
+            "description": "The transition in. Available transitions are:\n  <ul>\n    <li>`fade` - fade in</li>\n    <li>`reveal` - reveal from left to right</li>\n    <li>`wipeLeft` - fade across screen to the left</li>\n    <li>`wipeRight` - fade across screen to the right</li>\n    <li>`slideLeft` - move slightly left and fade in</li>\n    <li>`slideRight` - move slightly right and fade in</li>\n    <li>`slideUp` - move slightly up and fade in</li>\n    <li>`slideDown` - move slightly down and fade in</li>\n    <li>`carouselLeft` - slide in from right to left</li>\n    <li>`carouselRight` - slide in from left to right</li>\n    <li>`carouselUp` - slide in from bottom to top</li>\n    <li>`carouselDown` - slide in from top to bottom</li>\n    <li>`shuffleTopRight` - rotate in from top right</li>\n    <li>`shuffleRightTop` - rotate in from right top</li>\n    <li>`shuffleRightBottom` - rotate in from right bottom</li>\n    <li>`shuffleBottomRight` - rotate in from bottom right</li>\n    <li>`shuffleBottomLeft` - rotate in from bottom left</li>\n    <li>`shuffleLeftBottom` - rotate in from left bottom</li>\n    <li>`shuffleLeftTop` - rotate in from left top</li>\n    <li>`shuffleTopLeft` - rotate in from top left</li>\n    <li>`zoom` - fast zoom in</li>\n  </ul>\nThe transition speed can also be controlled by appending `Fast` or `Slow` to the transition, e.g. `fadeFast` or `CarouselLeftSlow`.",
+            "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",
+            "description": "The transition out. Available transitions are:\n  <ul>\n    <li>`fade` - fade out</li>\n    <li>`reveal` - reveal from right to left</li>\n    <li>`wipeLeft` - fade across screen to the left</li>\n    <li>`wipeRight` - fade across screen to the right</li>\n    <li>`slideLeft` - move slightly left and fade out</li>\n    <li>`slideRight` - move slightly right and fade out</li>\n    <li>`slideUp` - move slightly up and fade out</li>\n    <li>`slideDown` - move slightly down and fade out</li>\n    <li>`carouselLeft` - slide out from right to left</li>\n    <li>`carouselRight` - slide out from left to right</li>\n    <li>`carouselUp` - slide out from bottom to top</li>\n    <li>`carouselDown` - slide out from top  to bottom</li>\n    <li>`shuffleTopRight` - rotate out from top right</li>\n    <li>`shuffleRightTop` - rotate out from right top</li>\n    <li>`shuffleRightBottom` - rotate out from right bottom</li>\n    <li>`shuffleBottomRight` - rotate out from bottom right</li>\n    <li>`shuffleBottomLeft` - rotate out from bottom left</li>\n    <li>`shuffleLeftBottom` - rotate out from left bottom</li>\n    <li>`shuffleLeftTop` - rotate out from left top</li>\n    <li>`shuffleTopLeft` - rotate out from top left</li>\n    <li>`zoom` - fast zoom out</li>\n  </ul>\nThe transition speed can also be controlled by appending `Fast` or `Slow` to the transition, e.g. `fadeFast` or `CarouselLeftSlow`.",
+            "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"
+    ]
+  }
+}

package/dist/json-schema/tween.json

@@ -0,0 +1,120 @@
+{
+  "name": "Tween",
+  "strict": true,
+  "schema": {
+    "description": "Use a Tween to [animate properties over time](/docs/guide/architecting-an-application/animations/). The following properties are currently supported and can be animated:\n  <ul>\n    <li>Opacity - animate the transparency of a clip.</li>\n    <li>Offset - animate the x and y position of a clip.</li>\n    <li>Rotation - animate the rotation of a clip.</li>\n    <li>Skew - animate the horizontal and vertical shearing effect.</li>\n    <li>Volume - animate the audio volume of a clip.</li>\n  </ul>",
+    "properties": {
+      "from": {
+        "anyOf": [
+          {
+            "type": "string",
+            "description": "The initial property value at the start of the animation."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "to": {
+        "anyOf": [
+          {
+            "type": "string",
+            "description": "The final property value at the end of the animation."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "start": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "The time in seconds when the animation starts, relative to the clip, not the timeline."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "length": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "The duration of the animation in seconds."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "interpolation": {
+        "anyOf": [
+          {
+            "type": "string",
+            "description": "The interpolation method to use for the animation. Available options are: <ul>\n  <li>`linear` - a linear interpolation between the start and end values.</li>\n  <li>`bezier` - a bezier curve interpolation between the start and end values.</li>\n  <li>`constant` - an interpolation where the property instantly jumps from the start to the end value, without any gradual transition.</li>\n</ul>",
+            "enum": [
+              "linear",
+              "bezier",
+              "constant"
+            ]
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "easing": {
+        "anyOf": [
+          {
+            "type": "string",
+            "description": "The easing function to use for the animation. Easing controls the rate of change of the animated value, allowing for more natural motion by speeding up or slowing down the animation at different points. Only applicable if interpolation is set to `bezier`.",
+            "enum": [
+              "ease",
+              "easeIn",
+              "easeOut",
+              "easeInOut",
+              "easeInQuad",
+              "easeInCubic",
+              "easeInQuart",
+              "easeInQuint",
+              "easeInSine",
+              "easeInExpo",
+              "easeInCirc",
+              "easeInBack",
+              "easeOutQuad",
+              "easeOutCubic",
+              "easeOutQuart",
+              "easeOutQuint",
+              "easeOutSine",
+              "easeOutExpo",
+              "easeOutCirc",
+              "easeOutBack",
+              "easeInOutQuad",
+              "easeInOutCubic",
+              "easeInOutQuart",
+              "easeInOutQuint",
+              "easeInOutSine",
+              "easeInOutExpo",
+              "easeInOutCirc",
+              "easeInOutBack"
+            ]
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "additionalProperties": false,
+    "type": "object",
+    "required": [
+      "from",
+      "to",
+      "start",
+      "length",
+      "interpolation",
+      "easing"
+    ]
+  }
+}