@shotstack/schemas 1.4.5 → 1.4.7

package/dist/api.bundled.json

@@ -939,6 +939,7 @@
           "tracks": {
             "description": "A timeline consists of an array of tracks, each track containing clips. Tracks are layered on top of each other in the same order they are added to the array with the top most track layered over the top of those below it. Ensure that a track containing titles is the top most track so that it is displayed above videos and images.",
             "type": "array",
+            "minItems": 1,
             "items": {
               "$ref": "#/components/schemas/Track"
             }
@@ -959,6 +960,8 @@
           "src": {
             "description": "The URL of the mp3 audio file. The URL must be publicly accessible or include credentials.",
             "type": "string",
+            "minLength": 1,
+            "pattern": "\\S",
             "example": "https://s3-ap-northeast-1.amazonaws.com/my-bucket/music.mp3"
           },
           "effect": {
@@ -1000,6 +1003,7 @@
           "clips": {
             "description": "An array of Clips comprising of TitleClip, ImageClip or VideoClip.",
             "type": "array",
+            "minItems": 1,
             "items": {
               "$ref": "#/components/schemas/Clip"
             }
@@ -1022,6 +1026,7 @@
               {
                 "type": "number",
                 "description": "The start position of the Clip on the timeline, in seconds. For example, to start the Clip at 2 seconds, set the start value to 2.",
+                "minimum": 0,
                 "example": 2
               },
               {
@@ -1038,6 +1043,7 @@
               {
                 "type": "number",
                 "description": "The duration the Clip should play for, in seconds. For example, to play the Clip for 5 seconds, set the length value to 5.",
+                "minimum": 0,
                 "example": 5
               },
               {
@@ -1268,6 +1274,8 @@
           "src": {
             "description": "The video source URL. The URL must be publicly accessible or include credentials.",
             "type": "string",
+            "minLength": 1,
+            "pattern": "\\S",
             "example": "https://s3-ap-northeast-1.amazonaws.com/my-bucket/video.mp4"
           },
           "transcode": {
@@ -1345,6 +1353,8 @@
           "src": {
             "description": "The image source URL. The URL must be publicly accessible or include credentials.",
             "type": "string",
+            "minLength": 1,
+            "pattern": "\\S",
             "example": "https://s3-ap-northeast-1.amazonaws.com/my-bucket/image.jpg"
           },
           "crop": {
@@ -1464,8 +1474,8 @@
           "text": {
             "description": "The text string to display. Maximum 5000 characters.",
             "type": "string",
-            "example": "Hello World",
-            "maxLength": 5000
+            "maxLength": 5000,
+            "example": "Hello World"
           },
           "font": {
             "description": "Font styling properties.",
@@ -1592,6 +1602,8 @@
           "src": {
             "description": "The audio source URL. The URL must be publicly accessible or include credentials.",
             "type": "string",
+            "minLength": 1,
+            "pattern": "\\S",
             "example": "https://s3-ap-northeast-1.amazonaws.com/my-bucket/sound.mp3"
           },
           "trim": {
@@ -1785,6 +1797,8 @@
           "src": {
             "description": "The luma matte source URL. The URL must be publicly accessible or include credentials.",
             "type": "string",
+            "minLength": 1,
+            "pattern": "\\S",
             "example": "https://s3-ap-northeast-1.amazonaws.com/my-bucket/mask.mp4"
           },
           "trim": {
@@ -1812,6 +1826,8 @@
           "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. The system will automatically transcribe the audio and detect the language.",
             "type": "string",
+            "minLength": 1,
+            "pattern": "\\S",
             "example": "https://s3-ap-northeast-1.amazonaws.com/my-bucket/captions.srt"
           },
           "font": {
@@ -1894,6 +1910,7 @@
           "src": {
             "description": "The image source URL. The URL must be publicly accessible or include credentials.",
             "type": "string",
+            "minLength": 1,
             "example": "https://s3-ap-northeast-1.amazonaws.com/my-bucket/image.jpg"
           },
           "prompt": {
@@ -1926,7 +1943,12 @@
           "crop": {
             "$ref": "#/components/schemas/Crop"
           }
-        }
+        },
+        "type": "object",
+        "required": [
+          "type",
+          "src"
+        ]
       },
       "HtmlAsset": {
         "deprecated": true,
@@ -3615,16 +3637,8 @@
             ],
             "example": "shift"
           },
-          "speed": {
-            "description": "Animation speed multiplier. Must be between 0.1 and 10. Higher is faster.",
-            "type": "number",
-            "minimum": 0.1,
-            "maximum": 10,
-            "default": 1,
-            "example": 1.5
-          },
           "duration": {
-            "description": "Override animation duration in seconds. If not specified, calculated based on text length and speed. Must be between 0.1 and 30 seconds.",
+            "description": "Override animation duration in seconds. Must be between 0.1 and 30 seconds.",
             "type": "number",
             "minimum": 0.1,
             "maximum": 30,

package/dist/schema.d.ts

@@ -994,8 +994,7 @@ export interface components {
         /** @description The ImageToVideoAsset lets you create a video from an image and a text prompt. */
         ImageToVideoAsset: {
             /**
-             * @description The type of asset to generate - set to `image-to-video` for image-to-video.
-             * @default image-to-video
+             * @description The type of asset to generate - set to `image-to-video` for image-to-video. (enum property replaced by openapi-typescript)
              * @enum {string}
              */
             type: "image-to-video";
@@ -1003,7 +1002,7 @@ export interface components {
              * @description The image source URL. The URL must be publicly accessible or include credentials.
              * @example https://s3-ap-northeast-1.amazonaws.com/my-bucket/image.jpg
              */
-            src?: string;
+            src: string;
             /**
              * @description The instructions for modifying the image into a video sequence.
              * @example Slowly zoom out and orbit left around the object.
@@ -2239,13 +2238,7 @@ export interface components {
              */
             preset: "fadeIn" | "slideIn" | "typewriter" | "ascend" | "shift" | "movingLetters";
             /**
-             * @description Animation speed multiplier. Must be between 0.1 and 10. Higher is faster.
-             * @default 1
-             * @example 1.5
-             */
-            speed: number;
-            /**
-             * @description Override animation duration in seconds. If not specified, calculated based on text length and speed. Must be between 0.1 and 30 seconds.
+             * @description Override animation duration in seconds. Must be between 0.1 and 30 seconds.
              * @example 2
              */
             duration?: number;

package/dist/zod/zod.gen.cjs

@@ -102,7 +102,7 @@ exports.captionMarginSchema = exports.captionpropertiesCaptionMarginSchema;
  */
 exports.captionassetCaptionAssetSchema = zod_1.z.object({
     type: zod_1.z.enum(["caption"]),
-    src: zod_1.z.string(),
+    src: zod_1.z.string().min(1).regex(/\S/),
     font: zod_1.z.optional(exports.captionpropertiesCaptionFontSchema),
     background: zod_1.z.optional(exports.captionpropertiesCaptionBackgroundSchema),
     margin: zod_1.z.optional(exports.captionpropertiesCaptionMarginSchema),
@@ -923,7 +923,7 @@ exports.htmlAssetSchema = exports.htmlassetHtmlAssetSchema;
  */
 exports.imageassetImageAssetSchema = zod_1.z.object({
     type: zod_1.z.enum(["image"]),
-    src: zod_1.z.string(),
+    src: zod_1.z.string().min(1).regex(/\S/),
     crop: zod_1.z.optional(exports.cropCropSchema),
 });
 exports.imageAssetSchema = exports.imageassetImageAssetSchema;
@@ -931,8 +931,8 @@ exports.imageAssetSchema = exports.imageassetImageAssetSchema;
  * The ImageToVideoAsset lets you create a video from an image and a text prompt.
  */
 exports.imagetovideoassetImageToVideoAssetSchema = zod_1.z.object({
-    type: zod_1.z.optional(zod_1.z.enum(["image-to-video"])),
-    src: zod_1.z.optional(zod_1.z.string()),
+    type: zod_1.z.enum(["image-to-video"]),
+    src: zod_1.z.string().min(1),
     prompt: zod_1.z.optional(zod_1.z.string()),
     aspectRatio: zod_1.z.optional(zod_1.z.enum(["1:1", "4:3", "16:9", "9:16", "3:4", "21:9", "9:21"])),
     speed: zod_1.z.optional(zod_1.z.preprocess(((v) => { if (v === '' || v === null || v === undefined)
@@ -1065,7 +1065,7 @@ exports.transcriptionSchema = exports.transcriptionTranscriptionSchema;
  */
 exports.lumaassetLumaAssetSchema = zod_1.z.object({
     type: zod_1.z.enum(["luma"]),
-    src: zod_1.z.string(),
+    src: zod_1.z.string().min(1).regex(/\S/),
     trim: zod_1.z.optional(zod_1.z.preprocess(((v) => { if (v === '' || v === null || v === undefined)
         return undefined; if (Array.isArray(v))
         return v; if (typeof v === 'string')
@@ -1077,7 +1077,7 @@ exports.lumaAssetSchema = exports.lumaassetLumaAssetSchema;
  */
 exports.mergefieldMergeFieldSchema = zod_1.z.object({
     find: zod_1.z.string(),
-    replace: zod_1.z.unknown(),
+    replace: zod_1.z.union([zod_1.z.string(), zod_1.z.number(), zod_1.z.boolean(), zod_1.z.null(), zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()), zod_1.z.array(zod_1.z.unknown())]),
 });
 exports.mergeFieldSchema = exports.mergefieldMergeFieldSchema;
 /**
@@ -1232,10 +1232,6 @@ exports.richtextpropertiesRichTextAnimationSchema = zod_1.z.object({
         "shift",
         "movingLetters",
     ]),
-    speed: zod_1.z.optional(zod_1.z.preprocess(((v) => { if (v === '' || v === null || v === undefined)
-        return undefined; if (Array.isArray(v))
-        return v; if (typeof v === 'string')
-        return Number(v); return v; }), zod_1.z.number().gte(0.1).lte(10))).default(1),
     duration: zod_1.z.optional(zod_1.z.preprocess(((v) => { if (v === '' || v === null || v === undefined)
         return undefined; if (Array.isArray(v))
         return v; if (typeof v === 'string')
@@ -1702,7 +1698,7 @@ exports.sourceSchema = exports.sourceSourceSchema;
  * A music or audio file in mp3 format that plays for the duration of the rendered video or the length of the audio file, which ever is shortest.
  */
 exports.soundtrackSoundtrackSchema = zod_1.z.object({
-    src: zod_1.z.string(),
+    src: zod_1.z.string().min(1).regex(/\S/),
     effect: zod_1.z.optional(zod_1.z.enum(["fadeIn", "fadeOut", "fadeInFadeOut"])),
     volume: zod_1.z.optional(zod_1.z.preprocess(((v) => { if (v === '' || v === null || v === undefined)
         return undefined; if (Array.isArray(v))
@@ -2550,7 +2546,7 @@ exports.tweenSchema = exports.tweenTweenSchema;
  */
 exports.audioassetAudioAssetSchema = zod_1.z.object({
     type: zod_1.z.enum(["audio"]),
-    src: zod_1.z.string(),
+    src: zod_1.z.string().min(1).regex(/\S/),
     trim: zod_1.z.optional(zod_1.z.preprocess(((v) => { if (v === '' || v === null || v === undefined)
         return undefined; if (Array.isArray(v))
         return v; if (typeof v === 'string')
@@ -2666,7 +2662,7 @@ exports.transformationSchema = exports.transformationTransformationSchema;
  */
 exports.videoassetVideoAssetSchema = zod_1.z.object({
     type: zod_1.z.enum(["video"]),
-    src: zod_1.z.string(),
+    src: zod_1.z.string().min(1).regex(/\S/),
     transcode: zod_1.z.optional(zod_1.z.boolean()),
     trim: zod_1.z.optional(zod_1.z.preprocess(((v) => { if (v === '' || v === null || v === undefined)
         return undefined; if (Array.isArray(v))
@@ -2713,14 +2709,14 @@ exports.clipClipSchema = zod_1.z.object({
         zod_1.z.preprocess(((v) => { if (v === '' || v === null || v === undefined)
             return undefined; if (Array.isArray(v))
             return v; if (typeof v === 'string')
-            return Number(v); return v; }), zod_1.z.number()),
+            return Number(v); return v; }), zod_1.z.number().gte(0)),
         zod_1.z.string().regex(/^(auto|alias:\/\/[A-Za-z0-9_-]+)$/),
     ]),
     length: zod_1.z.union([
         zod_1.z.preprocess(((v) => { if (v === '' || v === null || v === undefined)
             return undefined; if (Array.isArray(v))
             return v; if (typeof v === 'string')
-            return Number(v); return v; }), zod_1.z.number()),
+            return Number(v); return v; }), zod_1.z.number().gte(0)),
         zod_1.z.string().regex(/^(auto|end|alias:\/\/[A-Za-z0-9_-]+)$/),
     ]),
     fit: zod_1.z.optional(zod_1.z.enum(["cover", "contain", "crop", "none"])),
@@ -2792,7 +2788,7 @@ exports.clipSchema = exports.clipClipSchema;
  * A track contains an array of clips. Tracks are layered on top of each other in the order in the array. The top most track will render on top of those below it.
  */
 exports.trackTrackSchema = zod_1.z.object({
-    clips: zod_1.z.array(exports.clipClipSchema),
+    clips: zod_1.z.array(exports.clipClipSchema).min(1),
 });
 exports.trackSchema = exports.trackTrackSchema;
 /**
@@ -2802,7 +2798,7 @@ exports.timelineTimelineSchema = zod_1.z.object({
     soundtrack: zod_1.z.optional(exports.soundtrackSoundtrackSchema),
     background: zod_1.z.optional(zod_1.z.string()),
     fonts: zod_1.z.optional(zod_1.z.array(exports.fontFontSchema)),
-    tracks: zod_1.z.array(exports.trackTrackSchema),
+    tracks: zod_1.z.array(exports.trackTrackSchema).min(1),
     cache: zod_1.z.optional(zod_1.z.boolean()),
 });
 exports.timelineSchema = exports.timelineTimelineSchema;