@shotstack/schemas 1.0.1 → 1.1.0

package/README.md

@@ -5,11 +5,13 @@ Centralized OpenAPI schemas and TypeScript types for the Shotstack API.
 ## Installation
 
 ```bash
-npm install @shotstack/schemas
+npm install @shotstack/schemas zod
 ```
 
 ## Usage
 
+### TypeScript Types
+
 ```typescript
 import type { components } from '@shotstack/schemas';
 
@@ -19,7 +21,55 @@ type Clip = components['schemas']['Clip'];
 type Output = components['schemas']['Output'];
 ```
 
-## Available Types
+### 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

package/dist/index.d.ts

@@ -1 +1 @@
-export type * from './schema';
+export type * from '../dist/schema';