@shotstack/schemas 1.5.6 → 1.5.7

package/dist/zod/zod.gen.js

@@ -1307,6 +1307,73 @@ export const templateresponseTemplateResponseSchema = z.object({
     response: templateresponsedataTemplateResponseDataSchema,
 });
 export const templateResponseSchema = templateresponseTemplateResponseSchema;
+/**
+ * Font properties for the active/highlighted word.
+ */
+export const richcaptionpropertiesRichCaptionActiveFontSchema = z.object({
+    color: z.optional(z.union([z.string().regex(/^#[A-Fa-f0-9]{6}$/), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])).default("#ffff00"),
+    background: z.optional(z.union([z.string().regex(/^#[A-Fa-f0-9]{6}$/), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])),
+    opacity: z.optional(z.union([z.preprocess(((v) => { if (v === '' || v === null || v === undefined)
+            return undefined; if (Array.isArray(v))
+            return v; if (typeof v === 'string') {
+            if (/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/.test(v))
+                return v;
+            return Number(v);
+        } return v; }), z.number().gte(0).lte(1)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])).default(1),
+});
+export const richCaptionActiveFontSchema = richcaptionpropertiesRichCaptionActiveFontSchema;
+/**
+ * Word-level animation properties for caption effects.
+ */
+export const richcaptionpropertiesRichCaptionWordAnimationSchema = z.object({
+    style: z.enum([
+        "karaoke",
+        "highlight",
+        "pop",
+        "fade",
+        "slide",
+        "bounce",
+        "typewriter",
+        "none",
+    ]),
+    speed: z.optional(z.union([z.preprocess(((v) => { if (v === '' || v === null || v === undefined)
+            return undefined; if (Array.isArray(v))
+            return v; if (typeof v === 'string') {
+            if (/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/.test(v))
+                return v;
+            return Number(v);
+        } return v; }), z.number().gte(0.5).lte(2)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])).default(1),
+    direction: z.optional(z.enum(["left", "right", "up", "down"])),
+});
+export const richCaptionWordAnimationSchema = richcaptionpropertiesRichCaptionWordAnimationSchema;
+/**
+ * Word-level timing information for caption animation.
+ */
+export const richcaptionpropertiesWordTimingSchema = z.object({
+    text: z.string().min(1),
+    start: z.union([z.preprocess(((v) => { if (v === '' || v === null || v === undefined)
+            return undefined; if (Array.isArray(v))
+            return v; if (typeof v === 'string') {
+            if (/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/.test(v))
+                return v;
+            return Number(v);
+        } return v; }), z.number().gte(0)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)]),
+    end: z.union([z.preprocess(((v) => { if (v === '' || v === null || v === undefined)
+            return undefined; if (Array.isArray(v))
+            return v; if (typeof v === 'string') {
+            if (/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/.test(v))
+                return v;
+            return Number(v);
+        } return v; }), z.number().gte(0)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)]),
+    confidence: z.optional(z.union([z.preprocess(((v) => { if (v === '' || v === null || v === undefined)
+            return undefined; if (Array.isArray(v))
+            return v; if (typeof v === 'string') {
+            if (/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/.test(v))
+                return v;
+            return Number(v);
+        } return v; }), z.number().gte(0).lte(1)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])),
+});
+export const wordTimingSchema = richcaptionpropertiesWordTimingSchema;
 /**
  * Text alignment properties (horizontal and vertical).
  */
@@ -1501,6 +1568,21 @@ export const richtextpropertiesRichTextStrokeSchema = z.object({
         } return v; }), z.number().gte(0).lte(1)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])).default(1),
 });
 export const richTextStrokeSchema = richtextpropertiesRichTextStrokeSchema;
+/**
+ * Styling properties for the active/highlighted word.
+ */
+export const richcaptionpropertiesRichCaptionActiveSchema = z.object({
+    font: z.optional(richcaptionpropertiesRichCaptionActiveFontSchema),
+    stroke: z.optional(richtextpropertiesRichTextStrokeSchema),
+    scale: z.optional(z.union([z.preprocess(((v) => { if (v === '' || v === null || v === undefined)
+            return undefined; if (Array.isArray(v))
+            return v; if (typeof v === 'string') {
+            if (/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/.test(v))
+                return v;
+            return Number(v);
+        } return v; }), z.number().gte(0.5).lte(2)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])).default(1),
+});
+export const richCaptionActiveSchema = richcaptionpropertiesRichCaptionActiveSchema;
 /**
  * Font properties for rich text.
  */
@@ -1514,7 +1596,7 @@ export const richtextpropertiesRichTextFontSchema = z.object({
             return Number(v);
         } return v; }), z.number().int().gte(1).lte(500)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])).default(24),
     weight: z.optional(z.unknown()).default("400"),
-    color: z.optional(z.union([z.string().regex(/^#[A-Fa-f0-9]{6}$/), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])).default("#ffffff"),
+    color: z.optional(z.union([z.string().regex(/^#[A-Fa-f0-9]{6}$/), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])).default("#000000"),
     opacity: z.optional(z.union([z.preprocess(((v) => { if (v === '' || v === null || v === undefined)
             return undefined; if (Array.isArray(v))
             return v; if (typeof v === 'string') {
@@ -1537,6 +1619,13 @@ export const richtextpropertiesRichTextStyleSchema = z.object({
                 return v;
             return Number(v);
         } return v; }), z.number()), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])).default(0),
+    wordSpacing: z.optional(z.union([z.preprocess(((v) => { if (v === '' || v === null || v === undefined)
+            return undefined; if (Array.isArray(v))
+            return v; if (typeof v === 'string') {
+            if (/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/.test(v))
+                return v;
+            return Number(v);
+        } return v; }), z.number().gte(0)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])).default(0),
     lineHeight: z.optional(z.union([z.preprocess(((v) => { if (v === '' || v === null || v === undefined)
             return undefined; if (Array.isArray(v))
             return v; if (typeof v === 'string') {
@@ -1549,6 +1638,48 @@ export const richtextpropertiesRichTextStyleSchema = z.object({
     gradient: z.optional(richtextpropertiesRichTextGradientSchema),
 });
 export const richTextStyleSchema = richtextpropertiesRichTextStyleSchema;
+/**
+ * The RichCaptionAsset provides word-level caption animations with rich-text styling. It supports
+ * karaoke-style highlighting, word-by-word animations, and advanced typography. Use with SRT/VTT
+ * files or auto-transcription via aliases.
+ *
+ */
+export const richcaptionassetRichCaptionAssetSchema = z.object({
+    type: z.enum(["rich-caption"]),
+    src: z.optional(z.string().min(1)),
+    words: z.optional(z.array(richcaptionpropertiesWordTimingSchema).max(100000)),
+    font: z.optional(richtextpropertiesRichTextFontSchema),
+    style: z.optional(richtextpropertiesRichTextStyleSchema),
+    stroke: z.optional(richtextpropertiesRichTextStrokeSchema),
+    shadow: z.optional(richtextpropertiesRichTextShadowSchema),
+    background: z.optional(richtextpropertiesRichTextBackgroundSchema),
+    padding: z.optional(z.union([z.union([z.preprocess(((v) => { if (v === '' || v === null || v === undefined)
+                return undefined; if (Array.isArray(v))
+                return v; if (typeof v === 'string') {
+                if (/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/.test(v))
+                    return v;
+                return Number(v);
+            } return v; }), z.number().gte(0)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)]), richtextpropertiesRichTextPaddingSchema])),
+    align: z.optional(richtextpropertiesRichTextAlignmentSchema),
+    active: z.optional(richcaptionpropertiesRichCaptionActiveSchema),
+    wordAnimation: z.optional(richcaptionpropertiesRichCaptionWordAnimationSchema),
+    position: z.optional(z.enum(["top", "center", "bottom"])),
+    maxWidth: z.optional(z.union([z.preprocess(((v) => { if (v === '' || v === null || v === undefined)
+            return undefined; if (Array.isArray(v))
+            return v; if (typeof v === 'string') {
+            if (/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/.test(v))
+                return v;
+            return Number(v);
+        } return v; }), z.number().gte(0.1).lte(1)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])).default(0.9),
+    maxLines: z.optional(z.union([z.preprocess(((v) => { if (v === '' || v === null || v === undefined)
+            return undefined; if (Array.isArray(v))
+            return v; if (typeof v === 'string') {
+            if (/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/.test(v))
+                return v;
+            return Number(v);
+        } return v; }), z.number().int().gte(1).lte(10)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])).default(2),
+});
+export const richCaptionAssetSchema = richcaptionassetRichCaptionAssetSchema;
 /**
  * The RichTextAsset provides advanced text rendering with support for custom fonts, gradients, shadows, strokes,
  * animations, and styling options. It offers more flexibility and visual effects than the basic TextAsset.
@@ -3172,6 +3303,7 @@ export const assetAssetSchema = z.discriminatedUnion("type", [
     audioassetAudioAssetSchema,
     lumaassetLumaAssetSchema,
     captionassetCaptionAssetSchema,
+    richcaptionassetRichCaptionAssetSchema,
     htmlassetHtmlAssetSchema,
     titleassetTitleAssetSchema,
     shapeassetShapeAssetSchema,

package/dist/zod/zod.gen.ts

@@ -1380,6 +1380,51 @@ export const templateresponseTemplateResponseSchema = z.object({
 
 export const templateResponseSchema = templateresponseTemplateResponseSchema;
 
+/**
+ * Font properties for the active/highlighted word.
+ */
+export const richcaptionpropertiesRichCaptionActiveFontSchema = z.object({
+  color: z.optional(z.union([z.string().regex(/^#[A-Fa-f0-9]{6}$/), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])).default("#ffff00"),
+  background: z.optional(z.union([z.string().regex(/^#[A-Fa-f0-9]{6}$/), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])),
+  opacity: z.optional(z.union([z.preprocess(((v: unknown) => { if (v === '' || v === null || v === undefined) return undefined; if (Array.isArray(v)) return v; if (typeof v === 'string') { if (/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/.test(v)) return v; return Number(v); } return v; }), z.number().gte(0).lte(1)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])).default(1),
+});
+
+export const richCaptionActiveFontSchema =
+  richcaptionpropertiesRichCaptionActiveFontSchema;
+
+/**
+ * Word-level animation properties for caption effects.
+ */
+export const richcaptionpropertiesRichCaptionWordAnimationSchema = z.object({
+  style: z.enum([
+    "karaoke",
+    "highlight",
+    "pop",
+    "fade",
+    "slide",
+    "bounce",
+    "typewriter",
+    "none",
+  ]),
+  speed: z.optional(z.union([z.preprocess(((v: unknown) => { if (v === '' || v === null || v === undefined) return undefined; if (Array.isArray(v)) return v; if (typeof v === 'string') { if (/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/.test(v)) return v; return Number(v); } return v; }), z.number().gte(0.5).lte(2)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])).default(1),
+  direction: z.optional(z.enum(["left", "right", "up", "down"])),
+});
+
+export const richCaptionWordAnimationSchema =
+  richcaptionpropertiesRichCaptionWordAnimationSchema;
+
+/**
+ * Word-level timing information for caption animation.
+ */
+export const richcaptionpropertiesWordTimingSchema = z.object({
+  text: z.string().min(1),
+  start: z.union([z.preprocess(((v: unknown) => { if (v === '' || v === null || v === undefined) return undefined; if (Array.isArray(v)) return v; if (typeof v === 'string') { if (/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/.test(v)) return v; return Number(v); } return v; }), z.number().gte(0)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)]),
+  end: z.union([z.preprocess(((v: unknown) => { if (v === '' || v === null || v === undefined) return undefined; if (Array.isArray(v)) return v; if (typeof v === 'string') { if (/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/.test(v)) return v; return Number(v); } return v; }), z.number().gte(0)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)]),
+  confidence: z.optional(z.union([z.preprocess(((v: unknown) => { if (v === '' || v === null || v === undefined) return undefined; if (Array.isArray(v)) return v; if (typeof v === 'string') { if (/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/.test(v)) return v; return Number(v); } return v; }), z.number().gte(0).lte(1)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])),
+});
+
+export const wordTimingSchema = richcaptionpropertiesWordTimingSchema;
+
 /**
  * Text alignment properties (horizontal and vertical).
  */
@@ -1485,6 +1530,18 @@ export const richtextpropertiesRichTextStrokeSchema = z.object({
 
 export const richTextStrokeSchema = richtextpropertiesRichTextStrokeSchema;
 
+/**
+ * Styling properties for the active/highlighted word.
+ */
+export const richcaptionpropertiesRichCaptionActiveSchema = z.object({
+  font: z.optional(richcaptionpropertiesRichCaptionActiveFontSchema),
+  stroke: z.optional(richtextpropertiesRichTextStrokeSchema),
+  scale: z.optional(z.union([z.preprocess(((v: unknown) => { if (v === '' || v === null || v === undefined) return undefined; if (Array.isArray(v)) return v; if (typeof v === 'string') { if (/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/.test(v)) return v; return Number(v); } return v; }), z.number().gte(0.5).lte(2)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])).default(1),
+});
+
+export const richCaptionActiveSchema =
+  richcaptionpropertiesRichCaptionActiveSchema;
+
 /**
  * Font properties for rich text.
  */
@@ -1492,7 +1549,7 @@ export const richtextpropertiesRichTextFontSchema = z.object({
   family: z.optional(z.string()).default("Open Sans"),
   size: z.optional(z.union([z.preprocess(((v: unknown) => { if (v === '' || v === null || v === undefined) return undefined; if (Array.isArray(v)) return v; if (typeof v === 'string') { if (/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/.test(v)) return v; return Number(v); } return v; }), z.number().int().gte(1).lte(500)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])).default(24),
   weight: z.optional(z.unknown()).default("400"),
-  color: z.optional(z.union([z.string().regex(/^#[A-Fa-f0-9]{6}$/), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])).default("#ffffff"),
+  color: z.optional(z.union([z.string().regex(/^#[A-Fa-f0-9]{6}$/), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])).default("#000000"),
   opacity: z.optional(z.union([z.preprocess(((v: unknown) => { if (v === '' || v === null || v === undefined) return undefined; if (Array.isArray(v)) return v; if (typeof v === 'string') { if (/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/.test(v)) return v; return Number(v); } return v; }), z.number().gte(0).lte(1)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])).default(1),
   background: z.optional(z.union([z.string().regex(/^#[A-Fa-f0-9]{6}$/), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])),
   stroke: z.optional(richtextpropertiesRichTextStrokeSchema),
@@ -1505,6 +1562,7 @@ export const richTextFontSchema = richtextpropertiesRichTextFontSchema;
  */
 export const richtextpropertiesRichTextStyleSchema = z.object({
   letterSpacing: z.optional(z.union([z.preprocess(((v: unknown) => { if (v === '' || v === null || v === undefined) return undefined; if (Array.isArray(v)) return v; if (typeof v === 'string') { if (/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/.test(v)) return v; return Number(v); } return v; }), z.number()), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])).default(0),
+  wordSpacing: z.optional(z.union([z.preprocess(((v: unknown) => { if (v === '' || v === null || v === undefined) return undefined; if (Array.isArray(v)) return v; if (typeof v === 'string') { if (/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/.test(v)) return v; return Number(v); } return v; }), z.number().gte(0)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])).default(0),
   lineHeight: z.optional(z.union([z.preprocess(((v: unknown) => { if (v === '' || v === null || v === undefined) return undefined; if (Array.isArray(v)) return v; if (typeof v === 'string') { if (/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/.test(v)) return v; return Number(v); } return v; }), z.number().gte(0).lte(10)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])).default(1.2),
   textTransform: z.optional(
     z.enum(["none", "uppercase", "lowercase", "capitalize"]),
@@ -1515,6 +1573,36 @@ export const richtextpropertiesRichTextStyleSchema = z.object({
 
 export const richTextStyleSchema = richtextpropertiesRichTextStyleSchema;
 
+/**
+ * The RichCaptionAsset provides word-level caption animations with rich-text styling. It supports
+ * karaoke-style highlighting, word-by-word animations, and advanced typography. Use with SRT/VTT
+ * files or auto-transcription via aliases.
+ *
+ */
+export const richcaptionassetRichCaptionAssetSchema = z.object({
+  type: z.enum(["rich-caption"]),
+  src: z.optional(z.string().min(1)),
+  words: z.optional(z.array(richcaptionpropertiesWordTimingSchema).max(100000)),
+  font: z.optional(richtextpropertiesRichTextFontSchema),
+  style: z.optional(richtextpropertiesRichTextStyleSchema),
+  stroke: z.optional(richtextpropertiesRichTextStrokeSchema),
+  shadow: z.optional(richtextpropertiesRichTextShadowSchema),
+  background: z.optional(richtextpropertiesRichTextBackgroundSchema),
+  padding: z.optional(
+    z.union([z.union([z.preprocess(((v: unknown) => { if (v === '' || v === null || v === undefined) return undefined; if (Array.isArray(v)) return v; if (typeof v === 'string') { if (/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/.test(v)) return v; return Number(v); } return v; }), z.number().gte(0)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)]), richtextpropertiesRichTextPaddingSchema]),
+  ),
+  align: z.optional(richtextpropertiesRichTextAlignmentSchema),
+  active: z.optional(richcaptionpropertiesRichCaptionActiveSchema),
+  wordAnimation: z.optional(
+    richcaptionpropertiesRichCaptionWordAnimationSchema,
+  ),
+  position: z.optional(z.enum(["top", "center", "bottom"])),
+  maxWidth: z.optional(z.union([z.preprocess(((v: unknown) => { if (v === '' || v === null || v === undefined) return undefined; if (Array.isArray(v)) return v; if (typeof v === 'string') { if (/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/.test(v)) return v; return Number(v); } return v; }), z.number().gte(0.1).lte(1)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])).default(0.9),
+  maxLines: z.optional(z.union([z.preprocess(((v: unknown) => { if (v === '' || v === null || v === undefined) return undefined; if (Array.isArray(v)) return v; if (typeof v === 'string') { if (/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/.test(v)) return v; return Number(v); } return v; }), z.number().int().gte(1).lte(10)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])).default(2),
+});
+
+export const richCaptionAssetSchema = richcaptionassetRichCaptionAssetSchema;
+
 /**
  * The RichTextAsset provides advanced text rendering with support for custom fonts, gradients, shadows, strokes,
  * animations, and styling options. It offers more flexibility and visual effects than the basic TextAsset.
@@ -2719,6 +2807,7 @@ export const assetAssetSchema = z.discriminatedUnion("type", [
   audioassetAudioAssetSchema,
   lumaassetLumaAssetSchema,
   captionassetCaptionAssetSchema,
+  richcaptionassetRichCaptionAssetSchema,
   htmlassetHtmlAssetSchema,
   titleassetTitleAssetSchema,
   shapeassetShapeAssetSchema,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shotstack/schemas",
-  "version": "1.5.6",
+  "version": "1.5.7",
   "description": "Centralized OpenAPI schemas and TypeScript types for Shotstack API",
   "type": "module",
   "main": "dist/index.js",