@shotstack/schemas 1.6.0 → 1.7.1

package/dist/json-schema/rich-text-stroke.json

@@ -0,0 +1,55 @@
+{
+  "name": "RichTextStroke",
+  "strict": true,
+  "schema": {
+    "description": "Text stroke (outline) properties.",
+    "properties": {
+      "width": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "The width of the stroke in pixels. Must be 0 or greater.",
+            "minimum": 0
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "color": {
+        "anyOf": [
+          {
+            "type": "string",
+            "description": "The stroke color using hexadecimal color notation.",
+            "enum": [
+              "#000000"
+            ]
+          },
+          {
+            "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"
+          }
+        ]
+      }
+    },
+    "additionalProperties": false,
+    "type": "object",
+    "required": [
+      "width",
+      "color",
+      "opacity"
+    ]
+  }
+}

package/dist/json-schema/rich-text-style.json

@@ -0,0 +1,165 @@
+{
+  "name": "RichTextStyle",
+  "strict": true,
+  "schema": {
+    "description": "Text style properties including spacing, line height, and transformations.",
+    "properties": {
+      "letterSpacing": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "Additional spacing between letters in pixels. Can be negative for tighter spacing."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "wordSpacing": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "Additional spacing between words in pixels. A value of 0 uses the font's natural space width.",
+            "minimum": 0
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "lineHeight": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "The line height as a multiplier of the font size. Must be between 0 and 10.",
+            "minimum": 0,
+            "maximum": 10
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "textTransform": {
+        "anyOf": [
+          {
+            "type": "string",
+            "description": "Text transformation to apply.",
+            "enum": [
+              "none",
+              "uppercase",
+              "lowercase",
+              "capitalize"
+            ]
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "textDecoration": {
+        "anyOf": [
+          {
+            "type": "string",
+            "description": "Text decoration to apply.",
+            "enum": [
+              "none",
+              "underline",
+              "line-through"
+            ]
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "gradient": {
+        "anyOf": [
+          {
+            "description": "Gradient fill for text instead of solid color.",
+            "$ref": "#/$defs/RichTextGradient"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "additionalProperties": false,
+    "type": "object",
+    "required": [
+      "letterSpacing",
+      "wordSpacing",
+      "lineHeight",
+      "textTransform",
+      "textDecoration",
+      "gradient"
+    ],
+    "$defs": {
+      "RichTextGradient": {
+        "description": "Gradient properties for text fill.",
+        "properties": {
+          "type": {
+            "anyOf": [
+              {
+                "type": "string",
+                "description": "The type of gradient.",
+                "enum": [
+                  "linear",
+                  "radial"
+                ]
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "angle": {
+            "anyOf": [
+              {
+                "type": "number",
+                "description": "The angle of the gradient in degrees (for linear gradients). Must be between 0 and 360.",
+                "minimum": 0,
+                "maximum": 360
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "stops": {
+            "description": "Gradient color stops. Must have at least 2 stops.",
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "offset": {
+                  "description": "Position of the color stop between 0 (start) and 1 (end).",
+                  "type": "number",
+                  "minimum": 0,
+                  "maximum": 1
+                },
+                "color": {
+                  "description": "Color at this stop using hexadecimal color notation.",
+                  "type": "string"
+                }
+              },
+              "required": [
+                "offset",
+                "color"
+              ],
+              "additionalProperties": false
+            }
+          }
+        },
+        "required": [
+          "type",
+          "angle",
+          "stops"
+        ],
+        "additionalProperties": false,
+        "type": "object"
+      }
+    }
+  }
+}

package/dist/json-schema/rotate-transformation.json

@@ -0,0 +1,153 @@
+{
+  "name": "RotateTransformation",
+  "strict": true,
+  "schema": {
+    "description": "Rotate a clip by the specified angle in degrees. Rotation origin is set based on the clips `position`.",
+    "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 to create a custom animation.",
+        "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, negative numbers counter-clockwise.",
+            "minimum": -360,
+            "maximum": 360
+          },
+          {
+            "type": "array",
+            "description": "An array of [Tween](./#tocs_tween) objects used to create a custom animation. Animate the rotation of an asset over time.",
+            "items": {
+              "$ref": "#/$defs/Tween"
+            }
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "required": [
+      "angle"
+    ],
+    "$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/s3destination-options.json

@@ -0,0 +1,59 @@
+{
+  "name": "S3DestinationOptions",
+  "strict": true,
+  "schema": {
+    "description": "Pass additional options to control how files are stored in S3.",
+    "properties": {
+      "region": {
+        "description": "Choose the region to send the file to. Must be a valid  [AWS region](https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_region) string like `us-east-1` or `ap-southeast-2`.",
+        "type": "string"
+      },
+      "bucket": {
+        "description": "The bucket name to send files to. The bucket must exist in the AWS account before files can be sent.",
+        "type": "string"
+      },
+      "prefix": {
+        "anyOf": [
+          {
+            "type": "string",
+            "description": "A prefix for the file being sent. This is typically a folder name, i.e. `videos` or `customerId/videos`."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "filename": {
+        "anyOf": [
+          {
+            "type": "string",
+            "description": "Use your own filename instead of the default filenames generated by Shotstack. Note: omit the file extension as this will be appended depending on the output format. Also `-poster.jpg` and `-thumb.jpg` will be appended for poster and thumbnail images."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "acl": {
+        "anyOf": [
+          {
+            "type": "string",
+            "description": "Sets the S3 Access Control List (acl) permissions. Default is `private`. Must use a valid  S3 [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl)."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "required": [
+      "region",
+      "bucket",
+      "prefix",
+      "filename",
+      "acl"
+    ],
+    "type": "object",
+    "additionalProperties": false
+  }
+}

package/dist/json-schema/s3destination.json

@@ -0,0 +1,90 @@
+{
+  "name": "S3Destination",
+  "strict": true,
+  "schema": {
+    "description": "Send videos and assets to an [Amazon S3](https://shotstack.io/docs/guide/serving-assets/destinations/s3/) bucket. Send files to any region with your own prefix and filename. AWS credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/s3), not in the request.",
+    "properties": {
+      "provider": {
+        "description": "The destination to send assets to - set to `s3` for S3.",
+        "type": "string",
+        "enum": [
+          "s3"
+        ]
+      },
+      "options": {
+        "anyOf": [
+          {
+            "description": "Additional S3 configuration options.",
+            "$ref": "#/$defs/S3DestinationOptions"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "type": "object",
+    "required": [
+      "provider",
+      "options"
+    ],
+    "additionalProperties": false,
+    "$defs": {
+      "S3DestinationOptions": {
+        "description": "Pass additional options to control how files are stored in S3.",
+        "properties": {
+          "region": {
+            "description": "Choose the region to send the file to. Must be a valid  [AWS region](https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_region) string like `us-east-1` or `ap-southeast-2`.",
+            "type": "string"
+          },
+          "bucket": {
+            "description": "The bucket name to send files to. The bucket must exist in the AWS account before files can be sent.",
+            "type": "string"
+          },
+          "prefix": {
+            "anyOf": [
+              {
+                "type": "string",
+                "description": "A prefix for the file being sent. This is typically a folder name, i.e. `videos` or `customerId/videos`."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "filename": {
+            "anyOf": [
+              {
+                "type": "string",
+                "description": "Use your own filename instead of the default filenames generated by Shotstack. Note: omit the file extension as this will be appended depending on the output format. Also `-poster.jpg` and `-thumb.jpg` will be appended for poster and thumbnail images."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "acl": {
+            "anyOf": [
+              {
+                "type": "string",
+                "description": "Sets the S3 Access Control List (acl) permissions. Default is `private`. Must use a valid  S3 [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl)."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "required": [
+          "region",
+          "bucket",
+          "prefix",
+          "filename",
+          "acl"
+        ],
+        "type": "object",
+        "additionalProperties": false
+      }
+    }
+  }
+}