@shotstack/schemas 1.8.6 → 1.9.0

package/README.md

@@ -1,89 +1,89 @@
-# @shotstack/schemas
-
-Centralized OpenAPI schemas and TypeScript types for the Shotstack API.
-
-## Installation
-
-```bash
-npm install @shotstack/schemas zod
-```
-
-## Usage
-
-### TypeScript Types
-
-```typescript
-import type { components } from '@shotstack/schemas';
-
-type Edit = components['schemas']['Edit'];
-type Timeline = components['schemas']['Timeline'];
-type Clip = components['schemas']['Clip'];
-type Output = components['schemas']['Output'];
-```
-
-### Zod Schemas
-
-```typescript
-import { z } from 'zod';
-import { richTextAssetSchema, editSchema, timelineSchema } from '@shotstack/schemas/zod';
-
-const result = richTextAssetSchema.safeParse(inputData);
-if (result.success) {
-  console.log(result.data);
-}
-```
-
-### Extending Schemas
-
-```typescript
-import { z } from 'zod';
-import { richTextAssetSchema } from '@shotstack/schemas/zod';
-
-const ExtendedAsset = richTextAssetSchema.extend({
-  customFonts: z.array(z.object({
-    src: z.string().url(),
-    family: z.string(),
-  })).optional(),
-  border: z.object({
-    width: z.number().min(0),
-    color: z.string(),
-  }).optional(),
-});
-
-type ExtendedAssetType = z.infer<typeof ExtendedAsset>;
-```
-
-### Custom Validation
-
-```typescript
-import { richTextAnimationSchema } from '@shotstack/schemas/zod';
-
-const AnimationWithDirection = richTextAnimationSchema.refine(
-  (data) => {
-    if (data.preset === 'slideIn' && !data.direction) {
-      return false;
-    }
-    return true;
-  },
-  { message: 'direction is required for slideIn preset' }
-);
-```
-
-## Available Schemas
-
-- Edit, Timeline, Track, Clip, Output
-- Assets: VideoAsset, ImageAsset, AudioAsset, HtmlAsset, TextAsset, TitleAsset, LumaAsset, CaptionAsset, ShapeAsset, RichTextAsset
-- Destinations: ShotstackDestination, S3Destination, MuxDestination, VimeoDestination, GoogleDriveDestination, GoogleCloudStorageDestination
-- Transforms, Transitions, Fonts, MergeFields, and more
-
-## Development
-
-```bash
-pnpm install
-pnpm run build
-pnpm run test
-```
-
-## License
-
-MIT
+# @shotstack/schemas
+
+Centralized OpenAPI schemas and TypeScript types for the Shotstack API
+
+## Installation
+
+```bash
+npm install @shotstack/schemas zod
+```
+
+## Usage
+
+### TypeScript Types
+
+```typescript
+import type { components } from '@shotstack/schemas';
+
+type Edit = components['schemas']['Edit'];
+type Timeline = components['schemas']['Timeline'];
+type Clip = components['schemas']['Clip'];
+type Output = components['schemas']['Output'];
+```
+
+### Zod Schemas
+
+```typescript
+import { z } from 'zod';
+import { richTextAssetSchema, editSchema, timelineSchema } from '@shotstack/schemas/zod';
+
+const result = richTextAssetSchema.safeParse(inputData);
+if (result.success) {
+  console.log(result.data);
+}
+```
+
+### Extending Schemas
+
+```typescript
+import { z } from 'zod';
+import { richTextAssetSchema } from '@shotstack/schemas/zod';
+
+const ExtendedAsset = richTextAssetSchema.extend({
+  customFonts: z.array(z.object({
+    src: z.string().url(),
+    family: z.string(),
+  })).optional(),
+  border: z.object({
+    width: z.number().min(0),
+    color: z.string(),
+  }).optional(),
+});
+
+type ExtendedAssetType = z.infer<typeof ExtendedAsset>;
+```
+
+### Custom Validation
+
+```typescript
+import { richTextAnimationSchema } from '@shotstack/schemas/zod';
+
+const AnimationWithDirection = richTextAnimationSchema.refine(
+  (data) => {
+    if (data.preset === 'slideIn' && !data.direction) {
+      return false;
+    }
+    return true;
+  },
+  { message: 'direction is required for slideIn preset' }
+);
+```
+
+## Available Schemas
+
+- Edit, Timeline, Track, Clip, Output
+- Assets: VideoAsset, ImageAsset, AudioAsset, HtmlAsset, TextAsset, TitleAsset, LumaAsset, CaptionAsset, ShapeAsset, RichTextAsset
+- Destinations: ShotstackDestination, S3Destination, MuxDestination, VimeoDestination, GoogleDriveDestination, GoogleCloudStorageDestination
+- Transforms, Transitions, Fonts, MergeFields, and more
+
+## Development
+
+```bash
+pnpm install
+pnpm run build
+pnpm run test
+```
+
+## License
+
+MIT

package/dist/api.bundled.json

@@ -1919,22 +1919,67 @@
             "type": "string"
           },
           "src": {
-            "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.",
             "type": "string",
             "minLength": 1,
             "example": "alias://audio"
           },
-          "words": {
-            "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`.",
-            "type": "array",
-            "items": {
-              "$ref": "#/components/schemas/WordTiming"
-            },
-            "maxItems": 100000
-          },
           "font": {
             "description": "Font styling properties for inactive words.",
-            "$ref": "#/components/schemas/RichTextFont"
+            "properties": {
+              "family": {
+                "description": "The font family name. This must be the Family name embedded in the font, i.e. \"Roboto\".",
+                "type": "string",
+                "example": "Roboto",
+                "default": "Roboto"
+              },
+              "size": {
+                "description": "The size of the font in pixels (px). Must be between 1 and 500.",
+                "type": "integer",
+                "minimum": 1,
+                "maximum": 500,
+                "default": 24,
+                "example": 48
+              },
+              "weight": {
+                "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"
+              },
+              "color": {
+                "description": "The text color using hexadecimal color notation.",
+                "type": "string",
+                "pattern": "^#[A-Fa-f0-9]{6}$",
+                "default": "#ffffff",
+                "example": "#ffffff"
+              },
+              "opacity": {
+                "description": "The opacity of the text where 1 is opaque and 0 is transparent.",
+                "type": "number",
+                "minimum": 0,
+                "maximum": 1,
+                "default": 1,
+                "example": 0.9
+              },
+              "background": {
+                "description": "The background color behind the text using hexadecimal color notation.",
+                "type": "string",
+                "pattern": "^#[A-Fa-f0-9]{6}$",
+                "example": "#000000"
+              },
+              "textDecoration": {
+                "description": "Text decoration to apply to all words.",
+                "type": "string",
+                "enum": [
+                  "none",
+                  "underline",
+                  "line-through"
+                ],
+                "default": "none",
+                "example": "underline"
+              }
+            },
+            "additionalProperties": false,
+            "type": "object"
           },
           "style": {
             "description": "Text style properties including spacing, line height, and transformations.",
@@ -1952,6 +1997,10 @@
             "description": "Background styling properties for the caption bounding box.",
             "$ref": "#/components/schemas/RichTextBackground"
           },
+          "border": {
+            "description": "Border styling properties for the caption bounding box.",
+            "$ref": "#/components/schemas/RichTextAsset/properties/border"
+          },
           "padding": {
             "description": "Padding inside the caption bounding box. Can be a single number (applied to all sides) or an object with individual sides.",
             "oneOf": [
@@ -1977,75 +2026,12 @@
           "wordAnimation": {
             "description": "Word-level animation properties controlling how words are highlighted or revealed.",
             "$ref": "#/components/schemas/RichCaptionWordAnimation"
-          },
-          "position": {
-            "description": "Vertical position of the caption on screen.",
-            "type": "string",
-            "enum": [
-              "top",
-              "center",
-              "bottom"
-            ],
-            "default": "bottom",
-            "example": "bottom"
-          },
-          "maxWidth": {
-            "description": "Maximum width of the caption as a ratio of the frame width. Must be between 0.1 and 1.",
-            "type": "number",
-            "minimum": 0.1,
-            "maximum": 1,
-            "default": 0.9,
-            "example": 0.85
-          },
-          "maxLines": {
-            "description": "Maximum number of lines to display at once. Must be between 1 and 10.",
-            "type": "integer",
-            "minimum": 1,
-            "maximum": 10,
-            "default": 2,
-            "example": 2
           }
         },
         "additionalProperties": false,
         "required": [
-          "type"
-        ]
-      },
-      "WordTiming": {
-        "description": "Word-level timing information for caption animation.",
-        "type": "object",
-        "properties": {
-          "text": {
-            "description": "The word text to display.",
-            "type": "string",
-            "minLength": 1,
-            "example": "Hello"
-          },
-          "start": {
-            "description": "Start time of the word in milliseconds.",
-            "type": "number",
-            "minimum": 0,
-            "example": 0
-          },
-          "end": {
-            "description": "End time of the word in milliseconds.",
-            "type": "number",
-            "minimum": 0,
-            "example": 400
-          },
-          "confidence": {
-            "description": "Speech-to-text confidence score between 0 and 1.",
-            "type": "number",
-            "minimum": 0,
-            "maximum": 1,
-            "example": 0.98
-          }
-        },
-        "additionalProperties": false,
-        "required": [
-          "text",
-          "start",
-          "end"
+          "type",
+          "src"
         ]
       },
       "RichCaptionActiveFont": {
@@ -2072,6 +2058,17 @@
             "maximum": 1,
             "default": 1,
             "example": 1
+          },
+          "textDecoration": {
+            "description": "Text decoration to apply to the active word.",
+            "type": "string",
+            "enum": [
+              "none",
+              "underline",
+              "line-through"
+            ],
+            "default": "none",
+            "example": "underline"
           }
         },
         "additionalProperties": false
@@ -2088,6 +2085,10 @@
             "description": "Stroke properties for the active word.",
             "$ref": "#/components/schemas/RichTextStroke"
           },
+          "shadow": {
+            "description": "Shadow properties for the active word. Overrides the base shadow when a word is active.",
+            "$ref": "#/components/schemas/RichTextShadow"
+          },
           "scale": {
             "description": "Scale multiplier for the active word. 1.0 is normal size, 1.2 is 20% larger.",
             "type": "number",

package/dist/json-schema/asset.json

@@ -1494,32 +1494,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"
@@ -1566,6 +1643,16 @@
               }
             ]
           },
+          "border": {
+            "anyOf": [
+              {
+                "$ref": "#/$defs/RichTextAsset/properties/border"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
           "padding": {
             "anyOf": [
               {
@@ -1609,118 +1696,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"
@@ -1744,6 +1764,7 @@
         "required": [
           "font",
           "stroke",
+          "shadow",
           "scale"
         ]
       },
@@ -1784,13 +1805,29 @@
                 "type": "null"
               }
             ]
+          },
+          "textDecoration": {
+            "anyOf": [
+              {
+                "type": "string",
+                "enum": [
+                  "none",
+                  "underline",
+                  "line-through"
+                ]
+              },
+              {
+                "type": "null"
+              }
+            ]
           }
         },
         "additionalProperties": false,
         "required": [
           "color",
           "background",
-          "opacity"
+          "opacity",
+          "textDecoration"
         ]
       },
       "RichCaptionWordAnimation": {