@shotstack/schemas 1.8.7 → 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

@@ -1965,6 +1965,17 @@
                 "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,
@@ -2047,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
@@ -2063,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

@@ -1570,6 +1570,21 @@
                         "type": "null"
                       }
                     ]
+                  },
+                  "textDecoration": {
+                    "anyOf": [
+                      {
+                        "type": "string",
+                        "enum": [
+                          "none",
+                          "underline",
+                          "line-through"
+                        ]
+                      },
+                      {
+                        "type": "null"
+                      }
+                    ]
                   }
                 },
                 "additionalProperties": false,
@@ -1579,7 +1594,8 @@
                   "weight",
                   "color",
                   "opacity",
-                  "background"
+                  "background",
+                  "textDecoration"
                 ]
               },
               {
@@ -1721,6 +1737,16 @@
               }
             ]
           },
+          "shadow": {
+            "anyOf": [
+              {
+                "$ref": "#/$defs/RichTextShadow"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
           "scale": {
             "anyOf": [
               {
@@ -1738,6 +1764,7 @@
         "required": [
           "font",
           "stroke",
+          "shadow",
           "scale"
         ]
       },
@@ -1778,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": {

package/dist/json-schema/clip.json

@@ -1802,6 +1802,21 @@
                         "type": "null"
                       }
                     ]
+                  },
+                  "textDecoration": {
+                    "anyOf": [
+                      {
+                        "type": "string",
+                        "enum": [
+                          "none",
+                          "underline",
+                          "line-through"
+                        ]
+                      },
+                      {
+                        "type": "null"
+                      }
+                    ]
                   }
                 },
                 "additionalProperties": false,
@@ -1811,7 +1826,8 @@
                   "weight",
                   "color",
                   "opacity",
-                  "background"
+                  "background",
+                  "textDecoration"
                 ]
               },
               {
@@ -1953,6 +1969,16 @@
               }
             ]
           },
+          "shadow": {
+            "anyOf": [
+              {
+                "$ref": "#/$defs/RichTextShadow"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
           "scale": {
             "anyOf": [
               {
@@ -1970,6 +1996,7 @@
         "required": [
           "font",
           "stroke",
+          "shadow",
           "scale"
         ]
       },
@@ -2010,13 +2037,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/json-schema/edit.json

@@ -1986,6 +1986,21 @@
                         "type": "null"
                       }
                     ]
+                  },
+                  "textDecoration": {
+                    "anyOf": [
+                      {
+                        "type": "string",
+                        "enum": [
+                          "none",
+                          "underline",
+                          "line-through"
+                        ]
+                      },
+                      {
+                        "type": "null"
+                      }
+                    ]
                   }
                 },
                 "additionalProperties": false,
@@ -1995,7 +2010,8 @@
                   "weight",
                   "color",
                   "opacity",
-                  "background"
+                  "background",
+                  "textDecoration"
                 ]
               },
               {
@@ -2137,6 +2153,16 @@
               }
             ]
           },
+          "shadow": {
+            "anyOf": [
+              {
+                "$ref": "#/$defs/RichTextShadow"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
           "scale": {
             "anyOf": [
               {
@@ -2154,6 +2180,7 @@
         "required": [
           "font",
           "stroke",
+          "shadow",
           "scale"
         ]
       },
@@ -2194,13 +2221,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/json-schema/rich-caption-active-font.json

@@ -42,13 +42,30 @@
             "type": "null"
           }
         ]
+      },
+      "textDecoration": {
+        "anyOf": [
+          {
+            "type": "string",
+            "description": "Text decoration to apply to the active word.",
+            "enum": [
+              "none",
+              "underline",
+              "line-through"
+            ]
+          },
+          {
+            "type": "null"
+          }
+        ]
       }
     },
     "additionalProperties": false,
     "required": [
       "color",
       "background",
-      "opacity"
+      "opacity",
+      "textDecoration"
     ]
   }
 }

package/dist/json-schema/rich-caption-active.json

@@ -27,6 +27,17 @@
           }
         ]
       },
+      "shadow": {
+        "anyOf": [
+          {
+            "description": "Shadow properties for the active word. Overrides the base shadow when a word is active.",
+            "$ref": "#/$defs/RichTextShadow"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
       "scale": {
         "anyOf": [
           {
@@ -45,6 +56,7 @@
     "required": [
       "font",
       "stroke",
+      "shadow",
       "scale"
     ],
     "$defs": {
@@ -89,13 +101,30 @@
                 "type": "null"
               }
             ]
+          },
+          "textDecoration": {
+            "anyOf": [
+              {
+                "type": "string",
+                "description": "Text decoration to apply to the active word.",
+                "enum": [
+                  "none",
+                  "underline",
+                  "line-through"
+                ]
+              },
+              {
+                "type": "null"
+              }
+            ]
           }
         },
         "additionalProperties": false,
         "required": [
           "color",
           "background",
-          "opacity"
+          "opacity",
+          "textDecoration"
         ]
       },
       "RichTextStroke": {
@@ -148,6 +177,81 @@
           "color",
           "opacity"
         ]
+      },
+      "RichTextShadow": {
+        "description": "Text shadow properties.",
+        "properties": {
+          "offsetX": {
+            "anyOf": [
+              {
+                "type": "number",
+                "description": "Horizontal offset of the shadow in pixels. Positive values move right, negative left."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "offsetY": {
+            "anyOf": [
+              {
+                "type": "number",
+                "description": "Vertical offset of the shadow in pixels. Positive values move down, negative up."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "blur": {
+            "anyOf": [
+              {
+                "type": "number",
+                "description": "The blur radius of the shadow in pixels. Must be 0 or greater.",
+                "minimum": 0
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "color": {
+            "anyOf": [
+              {
+                "type": "string",
+                "description": "The shadow color using hexadecimal color notation.",
+                "enum": [
+                  "#000000"
+                ]
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "opacity": {
+            "anyOf": [
+              {
+                "type": "number",
+                "description": "The opacity of the shadow where 1 is opaque and 0 is transparent.",
+                "minimum": 0,
+                "maximum": 1
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "additionalProperties": false,
+        "type": "object",
+        "required": [
+          "offsetX",
+          "offsetY",
+          "blur",
+          "color",
+          "opacity"
+        ]
       }
     }
   }