@shotstack/schemas 1.6.0 → 1.7.1

package/dist/json-schema/audio-asset.json

@@ -0,0 +1,210 @@
+{
+  "name": "AudioAsset",
+  "strict": true,
+  "schema": {
+    "description": "The AudioAsset is used to add sound effects and audio at specific intervals on the timeline. The src must be a publicly accessible URL to an audio resource such  as an mp3 file.",
+    "type": "object",
+    "properties": {
+      "type": {
+        "enum": [
+          "audio"
+        ],
+        "description": "The type of asset - set to `audio` for audio assets.",
+        "type": "string"
+      },
+      "src": {
+        "description": "The audio source URL. The URL must be publicly accessible or include credentials.",
+        "type": "string"
+      },
+      "trim": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "The start trim point of the audio clip, in seconds (defaults to 0). Audio will start from the in trim point. The audio will play until the file ends or the Clip length is reached."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "volume": {
+        "description": "Set the volume of the audio clip. Use a number or an array of [Tween](./#tocs_tween) objects to create custom volume transitions.",
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "The volume level for the audio clip. Range varies from 0 to 1 where 0 is muted and 1 is full volume (defaults to 1).",
+            "minimum": 0,
+            "maximum": 1
+          },
+          {
+            "type": "array",
+            "description": "An array of [Tween](./#tocs_tween) objects used to create a custom volume effect. Modify the volume of an asset over time.",
+            "items": {
+              "$ref": "#/$defs/Tween"
+            }
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "speed": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "Adjust the playback speed of the audio clip between 0 (paused) and 10 (10x normal speed), where 1 is normal speed (defaults to 1). Adjusting the speed will also adjust the duration of the clip and may require you to  adjust the Clip length. For example, if you set speed to 0.5, the clip will need to be 2x as long to play the entire audio (i.e. original length / 0.5). If you set speed to 2, the clip will need to be half as long to play the entire audio (i.e. original length / 2).",
+            "minimum": 0,
+            "maximum": 10
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "effect": {
+        "anyOf": [
+          {
+            "type": "string",
+            "description": "The effect to apply to the audio asset <ul>\n  <li>`fadeIn` - fade volume in only</li>\n  <li>`fadeOut` - fade volume out only</li>\n  <li>`fadeInFadeOut` - fade volume in and out</li>\n</ul>",
+            "enum": [
+              "none",
+              "fadeIn",
+              "fadeOut",
+              "fadeInFadeOut"
+            ]
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "additionalProperties": false,
+    "required": [
+      "type",
+      "src",
+      "trim",
+      "volume",
+      "speed",
+      "effect"
+    ],
+    "$defs": {
+      "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 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"
+        ]
+      }
+    }
+  }
+}

package/dist/json-schema/blueprint.json

@@ -0,0 +1,380 @@
+{
+  "name": "Blueprint",
+  "strict": true,
+  "schema": {
+    "type": "object",
+    "properties": {
+      "output": {
+        "$ref": "#/$defs/Output"
+      },
+      "merge": {
+        "anyOf": [
+          {
+            "type": "array",
+            "items": {
+              "$ref": "#/$defs/MergeField"
+            }
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "timeline": {
+        "type": "object",
+        "properties": {
+          "tracks": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "clips": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/$defs/BlueprintClip"
+                  }
+                }
+              },
+              "additionalProperties": false,
+              "required": [
+                "clips"
+              ]
+            }
+          }
+        },
+        "additionalProperties": false,
+        "required": [
+          "tracks"
+        ]
+      }
+    },
+    "additionalProperties": false,
+    "required": [
+      "output",
+      "merge",
+      "timeline"
+    ],
+    "$defs": {
+      "BlueprintClip": {
+        "type": "object",
+        "properties": {
+          "asset": {
+            "type": "string",
+            "enum": [
+              "video",
+              "image",
+              "audio",
+              "rich-text",
+              "svg",
+              "caption"
+            ]
+          },
+          "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"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "mergeField": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "textHint": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "additionalProperties": false,
+        "required": [
+          "asset",
+          "start",
+          "length",
+          "fit",
+          "position",
+          "transition",
+          "effect",
+          "mergeField",
+          "textHint"
+        ]
+      },
+      "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"
+        ]
+      }
+    }
+  }
+}