@shotstack/schemas 1.4.0 → 1.4.2

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

@@ -1062,9 +1062,22 @@
             "type": "string"
           },
           "scale": {
-            "description": "Scale the asset to a fraction of the viewport size - i.e. setting the scale to 0.5 will scale asset to half the size of the viewport. This is useful for picture-in-picture video and scaling images such as logos and watermarks.",
-            "type": "number",
-            "example": 0
+            "description": "Scale the asset to a fraction of the viewport size - i.e. setting the scale to 0.5 will scale asset to half the size of the viewport. This is useful for picture-in-picture video and scaling images such as logos and watermarks. Use a number or an array of [Tween](./#tocs_tween) objects to create a custom animation.",
+            "oneOf": [
+              {
+                "type": "number",
+                "description": "Scale the asset to a fraction of the viewport size. For example, 0.5 will scale the asset to half the size of the viewport.",
+                "format": "float",
+                "example": 0.5
+              },
+              {
+                "type": "array",
+                "description": "An array of [Tween](./#tocs_tween) objects used to create a custom animation. Animate the scale of an asset over time.",
+                "items": {
+                  "$ref": "#/components/schemas/Tween"
+                }
+              }
+            ]
           },
           "width": {
             "description": "Set the width of the clip bounding box in pixels. This constrains the width of the clip, overriding the default behavior where clips fill the viewport width.",

package/dist/schema.d.ts

@@ -512,11 +512,8 @@ export interface components {
              * @enum {string}
              */
             fit?: "cover" | "contain" | "crop" | "none";
-            /**
-             * @description Scale the asset to a fraction of the viewport size - i.e. setting the scale to 0.5 will scale asset to half the size of the viewport. This is useful for picture-in-picture video and scaling images such as logos and watermarks.
-             * @example 0
-             */
-            scale?: number;
+            /** @description Scale the asset to a fraction of the viewport size - i.e. setting the scale to 0.5 will scale asset to half the size of the viewport. This is useful for picture-in-picture video and scaling images such as logos and watermarks. Use a number or an array of [Tween](./#tocs_tween) objects to create a custom animation. */
+            scale?: number | components["schemas"]["Tween"][];
             /**
              * @description Set the width of the clip bounding box in pixels. This constrains the width of the clip, overriding the default behavior where clips fill the viewport width.
              * @example 800