@shotstack/schemas 1.8.6 → 1.9.0

package/dist/json-schema/track.json

@@ -1741,32 +1741,109 @@
             "type": "string"
           },
           "src": {
-            "anyOf": [
-              {
-                "type": "string"
-              },
-              {
-                "type": "null"
-              }
-            ]
-          },
-          "words": {
-            "anyOf": [
-              {
-                "type": "array",
-                "items": {
-                  "$ref": "#/$defs/WordTiming"
-                }
-              },
-              {
-                "type": "null"
-              }
-            ]
+            "type": "string"
           },
           "font": {
             "anyOf": [
               {
-                "$ref": "#/$defs/RichTextFont"
+                "type": "object",
+                "properties": {
+                  "family": {
+                    "anyOf": [
+                      {
+                        "type": "string",
+                        "enum": [
+                          "Roboto"
+                        ]
+                      },
+                      {
+                        "type": "null"
+                      }
+                    ]
+                  },
+                  "size": {
+                    "anyOf": [
+                      {
+                        "type": "integer",
+                        "minimum": 1,
+                        "maximum": 500
+                      },
+                      {
+                        "type": "null"
+                      }
+                    ]
+                  },
+                  "weight": {
+                    "anyOf": [
+                      {
+                        "type": "string"
+                      },
+                      {
+                        "type": "null"
+                      }
+                    ]
+                  },
+                  "color": {
+                    "anyOf": [
+                      {
+                        "type": "string",
+                        "enum": [
+                          "#ffffff"
+                        ]
+                      },
+                      {
+                        "type": "null"
+                      }
+                    ]
+                  },
+                  "opacity": {
+                    "anyOf": [
+                      {
+                        "type": "number",
+                        "minimum": 0,
+                        "maximum": 1
+                      },
+                      {
+                        "type": "null"
+                      }
+                    ]
+                  },
+                  "background": {
+                    "anyOf": [
+                      {
+                        "type": "string"
+                      },
+                      {
+                        "type": "null"
+                      }
+                    ]
+                  },
+                  "textDecoration": {
+                    "anyOf": [
+                      {
+                        "type": "string",
+                        "enum": [
+                          "none",
+                          "underline",
+                          "line-through"
+                        ]
+                      },
+                      {
+                        "type": "null"
+                      }
+                    ]
+                  }
+                },
+                "additionalProperties": false,
+                "required": [
+                  "family",
+                  "size",
+                  "weight",
+                  "color",
+                  "opacity",
+                  "background",
+                  "textDecoration"
+                ]
               },
               {
                 "type": "null"
@@ -1813,6 +1890,16 @@
               }
             ]
           },
+          "border": {
+            "anyOf": [
+              {
+                "$ref": "#/$defs/RichTextAsset/properties/border"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
           "padding": {
             "anyOf": [
               {
@@ -1856,118 +1943,51 @@
                 "type": "null"
               }
             ]
-          },
-          "position": {
-            "anyOf": [
-              {
-                "type": "string",
-                "enum": [
-                  "top",
-                  "center",
-                  "bottom"
-                ]
-              },
-              {
-                "type": "null"
-              }
-            ]
-          },
-          "maxWidth": {
-            "anyOf": [
-              {
-                "type": "number",
-                "minimum": 0.1,
-                "maximum": 1
-              },
-              {
-                "type": "null"
-              }
-            ]
-          },
-          "maxLines": {
-            "anyOf": [
-              {
-                "type": "integer",
-                "minimum": 1,
-                "maximum": 10
-              },
-              {
-                "type": "null"
-              }
-            ]
           }
         },
         "additionalProperties": false,
         "required": [
           "type",
           "src",
-          "words",
           "font",
           "style",
           "stroke",
           "shadow",
           "background",
+          "border",
           "padding",
           "align",
           "active",
-          "wordAnimation",
-          "position",
-          "maxWidth",
-          "maxLines"
+          "wordAnimation"
         ]
       },
-      "WordTiming": {
+      "RichCaptionActive": {
         "type": "object",
         "properties": {
-          "text": {
-            "type": "string"
-          },
-          "start": {
-            "type": "number",
-            "minimum": 0
-          },
-          "end": {
-            "type": "number",
-            "minimum": 0
-          },
-          "confidence": {
+          "font": {
             "anyOf": [
               {
-                "type": "number",
-                "minimum": 0,
-                "maximum": 1
+                "$ref": "#/$defs/RichCaptionActiveFont"
               },
               {
                 "type": "null"
               }
             ]
-          }
-        },
-        "additionalProperties": false,
-        "required": [
-          "text",
-          "start",
-          "end",
-          "confidence"
-        ]
-      },
-      "RichCaptionActive": {
-        "type": "object",
-        "properties": {
-          "font": {
+          },
+          "stroke": {
             "anyOf": [
               {
-                "$ref": "#/$defs/RichCaptionActiveFont"
+                "$ref": "#/$defs/RichTextStroke"
               },
               {
                 "type": "null"
               }
             ]
           },
-          "stroke": {
+          "shadow": {
             "anyOf": [
               {
-                "$ref": "#/$defs/RichTextStroke"
+                "$ref": "#/$defs/RichTextShadow"
               },
               {
                 "type": "null"
@@ -1991,6 +2011,7 @@
         "required": [
           "font",
           "stroke",
+          "shadow",
           "scale"
         ]
       },
@@ -2031,13 +2052,29 @@
                 "type": "null"
               }
             ]
+          },
+          "textDecoration": {
+            "anyOf": [
+              {
+                "type": "string",
+                "enum": [
+                  "none",
+                  "underline",
+                  "line-through"
+                ]
+              },
+              {
+                "type": "null"
+              }
+            ]
           }
         },
         "additionalProperties": false,
         "required": [
           "color",
           "background",
-          "opacity"
+          "opacity",
+          "textDecoration"
         ]
       },
       "RichCaptionWordAnimation": {

package/dist/schema.d.ts

@@ -990,14 +990,54 @@ export interface components {
              */
             type: "rich-caption";
             /**
-             * @description The URL to an SRT or VTT subtitles file, or an alias reference to auto-generate captions from an audio or video clip. For file URLs, the URL must be publicly accessible or include credentials. For auto-captioning, use the format `alias://clip-name` where clip-name is the alias of an audio, video, or text-to-speech clip. Mutually exclusive with `words`.
+             * @description The URL to an SRT or VTT subtitles file, or an alias reference to auto-generate captions from an audio or video clip. For file URLs, the URL must be publicly accessible or include credentials. For auto-captioning, use the format `alias://clip-name` where clip-name is the alias of an audio, video, or text-to-speech clip.
              * @example alias://audio
              */
-            src?: string;
-            /** @description Pre-provided word-level timing data. Use this instead of `src` when you have word timestamps from an external source. Mutually exclusive with `src`. */
-            words?: components["schemas"]["WordTiming"][];
+            src: string;
             /** @description Font styling properties for inactive words. */
-            font?: components["schemas"]["RichTextFont"];
+            font?: {
+                /**
+                 * @description The font family name. This must be the Family name embedded in the font, i.e. "Roboto".
+                 * @default Roboto
+                 * @example Roboto
+                 */
+                family?: string;
+                /**
+                 * @description The size of the font in pixels (px). Must be between 1 and 500.
+                 * @default 24
+                 * @example 48
+                 */
+                size?: number;
+                /**
+                 * @description The weight of the font. Can be a number (100-900) or a string ('normal', 'bold', etc.). 100 is lightest, 900 is heaviest (boldest).
+                 * @default 400
+                 */
+                weight?: unknown;
+                /**
+                 * @description The text color using hexadecimal color notation.
+                 * @default #ffffff
+                 * @example #ffffff
+                 */
+                color?: string;
+                /**
+                 * @description The opacity of the text where 1 is opaque and 0 is transparent.
+                 * @default 1
+                 * @example 0.9
+                 */
+                opacity?: number;
+                /**
+                 * @description The background color behind the text using hexadecimal color notation.
+                 * @example #000000
+                 */
+                background?: string;
+                /**
+                 * @description Text decoration to apply to all words.
+                 * @default none
+                 * @example underline
+                 * @enum {string}
+                 */
+                textDecoration?: "none" | "underline" | "line-through";
+            };
             /** @description Text style properties including spacing, line height, and transformations. */
             style?: components["schemas"]["RichTextStyle"];
             /** @description Text stroke (outline) properties for inactive words. */
@@ -1006,6 +1046,8 @@ export interface components {
             shadow?: components["schemas"]["RichTextShadow"];
             /** @description Background styling properties for the caption bounding box. */
             background?: components["schemas"]["RichTextBackground"];
+            /** @description Border styling properties for the caption bounding box. */
+            border?: components["schemas"]["RichTextAsset"]["border"];
             /** @description Padding inside the caption bounding box. Can be a single number (applied to all sides) or an object with individual sides. */
             padding?: number | components["schemas"]["RichTextAsset"]["padding"]["oneOf"]["1"];
             /** @description Text alignment properties (horizontal and vertical). */
@@ -1014,48 +1056,6 @@ export interface components {
             active?: components["schemas"]["RichCaptionActive"];
             /** @description Word-level animation properties controlling how words are highlighted or revealed. */
             wordAnimation?: components["schemas"]["RichCaptionWordAnimation"];
-            /**
-             * @description Vertical position of the caption on screen.
-             * @default bottom
-             * @example bottom
-             * @enum {string}
-             */
-            position?: "top" | "center" | "bottom";
-            /**
-             * @description Maximum width of the caption as a ratio of the frame width. Must be between 0.1 and 1.
-             * @default 0.9
-             * @example 0.85
-             */
-            maxWidth?: number;
-            /**
-             * @description Maximum number of lines to display at once. Must be between 1 and 10.
-             * @default 2
-             * @example 2
-             */
-            maxLines?: number;
-        };
-        /** @description Word-level timing information for caption animation. */
-        WordTiming: {
-            /**
-             * @description The word text to display.
-             * @example Hello
-             */
-            text: string;
-            /**
-             * @description Start time of the word in milliseconds.
-             * @example 0
-             */
-            start: number;
-            /**
-             * @description End time of the word in milliseconds.
-             * @example 400
-             */
-            end: number;
-            /**
-             * @description Speech-to-text confidence score between 0 and 1.
-             * @example 0.98
-             */
-            confidence?: number;
         };
         /** @description Font properties for the active/highlighted word. */
         RichCaptionActiveFont: {
@@ -1076,6 +1076,13 @@ export interface components {
              * @example 1
              */
             opacity?: number;
+            /**
+             * @description Text decoration to apply to the active word.
+             * @default none
+             * @example underline
+             * @enum {string}
+             */
+            textDecoration?: "none" | "underline" | "line-through";
         };
         /** @description Styling properties for the active/highlighted word. */
         RichCaptionActive: {
@@ -1083,6 +1090,8 @@ export interface components {
             font?: components["schemas"]["RichCaptionActiveFont"];
             /** @description Stroke properties for the active word. */
             stroke?: components["schemas"]["RichTextStroke"];
+            /** @description Shadow properties for the active word. Overrides the base shadow when a word is active. */
+            shadow?: components["schemas"]["RichTextShadow"];
             /**
              * @description Scale multiplier for the active word. 1.0 is normal size, 1.2 is 20% larger.
              * @default 1