@shotstack/schemas 1.7.0 → 1.8.2

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

@@ -156,7 +156,37 @@
             "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`."
+                "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"

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"
+        ]
+      }
+    }
+  }
+}

package/dist/json-schema/caption-detailer.json

@@ -0,0 +1,275 @@
+{
+  "name": "CaptionDetails",
+  "strict": true,
+  "schema": {
+    "type": "object",
+    "properties": {
+      "assets": {
+        "type": "array",
+        "items": {
+          "$ref": "#/$defs/CaptionAsset"
+        }
+      }
+    },
+    "additionalProperties": false,
+    "required": [
+      "assets"
+    ],
+    "$defs": {
+      "CaptionAsset": {
+        "type": "object",
+        "properties": {
+          "type": {
+            "enum": [
+              "caption"
+            ],
+            "type": "string"
+          },
+          "src": {
+            "type": "string"
+          },
+          "font": {
+            "anyOf": [
+              {
+                "$ref": "#/$defs/CaptionFont"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "background": {
+            "anyOf": [
+              {
+                "$ref": "#/$defs/CaptionBackground"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "margin": {
+            "anyOf": [
+              {
+                "$ref": "#/$defs/CaptionMargin"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "trim": {
+            "anyOf": [
+              {
+                "type": "number"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "speed": {
+            "anyOf": [
+              {
+                "type": "number",
+                "minimum": 0,
+                "maximum": 10
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "additionalProperties": false,
+        "required": [
+          "type",
+          "src",
+          "font",
+          "background",
+          "margin",
+          "trim",
+          "speed"
+        ]
+      },
+      "CaptionFont": {
+        "properties": {
+          "family": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "color": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "opacity": {
+            "anyOf": [
+              {
+                "type": "number"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "size": {
+            "anyOf": [
+              {
+                "type": "integer"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "lineHeight": {
+            "anyOf": [
+              {
+                "type": "number"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "stroke": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "strokeWidth": {
+            "anyOf": [
+              {
+                "type": "number"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "additionalProperties": false,
+        "type": "object",
+        "required": [
+          "family",
+          "color",
+          "opacity",
+          "size",
+          "lineHeight",
+          "stroke",
+          "strokeWidth"
+        ]
+      },
+      "CaptionBackground": {
+        "properties": {
+          "color": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "opacity": {
+            "anyOf": [
+              {
+                "type": "number"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "padding": {
+            "anyOf": [
+              {
+                "type": "integer"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "borderRadius": {
+            "anyOf": [
+              {
+                "type": "integer"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "additionalProperties": false,
+        "type": "object",
+        "required": [
+          "color",
+          "opacity",
+          "padding",
+          "borderRadius"
+        ]
+      },
+      "CaptionMargin": {
+        "properties": {
+          "top": {
+            "anyOf": [
+              {
+                "type": "number"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "left": {
+            "anyOf": [
+              {
+                "type": "number"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "right": {
+            "anyOf": [
+              {
+                "type": "number"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "additionalProperties": false,
+        "type": "object",
+        "required": [
+          "top",
+          "left",
+          "right"
+        ]
+      }
+    }
+  }
+}