@shotstack/schemas 1.4.2 → 1.4.4

package/dist/api.bundled.json

@@ -1026,10 +1026,9 @@
               },
               {
                 "type": "string",
-                "description": "The start position using a [smart clip property](/docs/guide/architecting-an-application/smart-clips/). Set to `auto` to automatically play the clip after the previous clip finishes.",
-                "enum": [
-                  "auto"
-                ]
+                "description": "The start position using a [smart clip property](/docs/guide/architecting-an-application/smart-clips/). Set to `auto` to automatically play the clip after the previous clip finishes. Use `alias://clip-name` to inherit the start time from the referenced clip.",
+                "pattern": "^(auto|alias://[A-Za-z0-9_-]+)$",
+                "example": "auto"
               }
             ]
           },
@@ -1043,11 +1042,9 @@
               },
               {
                 "type": "string",
-                "description": "The duration the Clip should play for using a [smart clip property](/docs/guide/architecting-an-application/smart-clips/). Set to `auto` to play the Clip for the duration of the asset. Set to `end` to display or play the clip to the end of the timeline.",
-                "enum": [
-                  "auto",
-                  "end"
-                ]
+                "description": "The duration the Clip should play for using a [smart clip property](/docs/guide/architecting-an-application/smart-clips/). Set to `auto` to play the Clip for the duration of the asset. Set to `end` to display or play the clip to the end of the timeline. Use `alias://clip-name` to inherit the length from the referenced clip.",
+                "pattern": "^(auto|end|alias://[A-Za-z0-9_-]+)$",
+                "example": "auto"
               }
             ]
           },
@@ -1811,7 +1808,7 @@
             "type": "string"
           },
           "src": {
-            "description": "The URL to an SRT or VTT subtitles file. The URL must be publicly accessible or include credentials.",
+            "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",
             "example": "https://s3-ap-northeast-1.amazonaws.com/my-bucket/captions.srt"
           },
@@ -1828,7 +1825,7 @@
             "$ref": "#/components/schemas/CaptionMargin"
           },
           "trim": {
-            "description": "The start trim point of the captions, in seconds (defaults to 0). Remove the trim length from teh start of the captions and allow it to be synced with video or audio. The captions will play until the file ends or the Clip length is reached.",
+            "description": "The start trim point of the captions, in seconds (defaults to 0). Remove the trim length from the start of the captions and allow it to be synced with video or audio. The captions will play until the file ends or the Clip length is reached.",
             "type": "number",
             "example": 2
           },
@@ -3746,11 +3743,12 @@
         "type": "object"
       },
       "ChromaKey": {
-        "description": "Chroma key, commonly known as green screen, is a technique that replaces a specific color in a video with a different background image or video, enabling seamless integration of diverse environments.",
+        "description": "Chroma key is a technique that replaces a specific color in a video with a different background image or video, enabling seamless integration of diverse environments. Commonly used for green screen and blue screen effects.",
         "properties": {
           "color": {
-            "description": "The chroma key color as a hex value. For a green screen, use a green hex value.",
+            "description": "The chroma key color as a hex value. Use green (#00b140) for green screens or blue (#0000FF) for blue screens. Any valid hex color can be used as the key color.",
             "type": "string",
+            "pattern": "^#[0-9a-fA-F]{6}$",
             "example": "#00b140"
           },
           "threshold": {
@@ -3768,6 +3766,9 @@
             "example": 100
           }
         },
+        "required": [
+          "color"
+        ],
         "type": "object"
       },
       "Tween": {
@@ -4397,6 +4398,14 @@
               "nobody",
               "contacts"
             ]
+          },
+          "download": {
+            "description": "Set whether the video can be downloaded.",
+            "type": "boolean"
+          },
+          "add": {
+            "description": "Set whether other users can add the video to their collections.",
+            "type": "boolean"
           }
         },
         "type": "object"

package/dist/schema.d.ts

@@ -498,9 +498,9 @@ export interface components {
         Clip: {
             asset: components["schemas"]["Asset"];
             /** @description The start position of the Clip on the timeline. */
-            start: number | "auto";
+            start: number | string;
             /** @description The duration the Clip should play for. */
-            length: number | ("auto" | "end");
+            length: number | string;
             /**
              * @description Set how the asset should be scaled to fit the viewport using one of the following options:
              *       <ul>
@@ -942,7 +942,7 @@ export interface components {
              */
             type: "caption";
             /**
-             * @description The URL to an SRT or VTT subtitles file. The URL must be publicly accessible or include credentials.
+             * @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.
              * @example https://s3-ap-northeast-1.amazonaws.com/my-bucket/captions.srt
              */
             src: string;
@@ -953,7 +953,7 @@ export interface components {
             /** @description Margin properties. */
             margin?: components["schemas"]["CaptionMargin"];
             /**
-             * @description The start trim point of the captions, in seconds (defaults to 0). Remove the trim length from teh start of the captions and allow it to be synced with video or audio. The captions will play until the file ends or the Clip length is reached.
+             * @description The start trim point of the captions, in seconds (defaults to 0). Remove the trim length from the start of the captions and allow it to be synced with video or audio. The captions will play until the file ends or the Clip length is reached.
              * @example 2
              */
             trim?: number;
@@ -2344,13 +2344,13 @@ export interface components {
              */
             right?: number;
         };
-        /** @description Chroma key, commonly known as green screen, is a technique that replaces a specific color in a video with a different background image or video, enabling seamless integration of diverse environments. */
+        /** @description Chroma key is a technique that replaces a specific color in a video with a different background image or video, enabling seamless integration of diverse environments. Commonly used for green screen and blue screen effects. */
         ChromaKey: {
             /**
-             * @description The chroma key color as a hex value. For a green screen, use a green hex value.
+             * @description The chroma key color as a hex value. Use green (#00b140) for green screens or blue (#0000FF) for blue screens. Any valid hex color can be used as the key color.
              * @example #00b140
              */
-            color?: string;
+            color: string;
             /**
              * @description Pixels within this distance from the key color are eliminated by setting their alpha values to zero.
              * @example 150
@@ -2794,6 +2794,10 @@ export interface components {
              * @enum {string}
              */
             comments?: "anybody" | "nobody" | "contacts";
+            /** @description Set whether the video can be downloaded. */
+            download?: boolean;
+            /** @description Set whether other users can add the video to their collections. */
+            add?: boolean;
         };
         /** @description A template is a saved [Edit](#tocs_edit) than can be loaded and re-used. */
         Template: {

package/dist/zod/zod.gen.cjs

@@ -117,10 +117,10 @@ exports.captionassetCaptionAssetSchema = zod_1.z.object({
 });
 exports.captionAssetSchema = exports.captionassetCaptionAssetSchema;
 /**
- * Chroma key, commonly known as green screen, is a technique that replaces a specific color in a video with a different background image or video, enabling seamless integration of diverse environments.
+ * Chroma key is a technique that replaces a specific color in a video with a different background image or video, enabling seamless integration of diverse environments. Commonly used for green screen and blue screen effects.
  */
 exports.chromakeyChromaKeySchema = zod_1.z.object({
-    color: zod_1.z.optional(zod_1.z.string()),
+    color: zod_1.z.string().regex(/^#[0-9a-fA-F]{6}$/),
     threshold: 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')
@@ -730,7 +730,7 @@ exports.googleCloudStorageDestinationOptionsSchema = exports.googleCloudStorageD
  * Send videos and assets to a [Google Cloud Storage](https://cloud.google.com/storage) bucket. Send files with your own prefix and filename. Google Cloud credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/google-cloud-storage), not in the request.
  */
 exports.googleCloudStorageDestinationGoogleCloudStorageDestinationSchema = zod_1.z.object({
-    provider: zod_1.z.string().default('google-cloud-storage'),
+    provider: zod_1.z.literal('google-cloud-storage'),
     options: zod_1.z.optional(exports.googleCloudStorageDestinationOptionsGoogleCloudStorageDestinationOptionsSchema)
 });
 exports.googleCloudStorageDestinationSchema = exports.googleCloudStorageDestinationGoogleCloudStorageDestinationSchema;
@@ -746,7 +746,7 @@ exports.googleDriveDestinationOptionsSchema = exports.googleDriveDestinationOpti
  * Send rendered videos and assets to the [Google Drive](https://shotstack.io/docs/guide/serving-assets/destinations/google-drive/) cloud storage service. Google Drive uses OAuth and you must authenticate and link your Google account via  [dashboard](https://dashboard.shotstack.io/integrations/google-drive), not in the request.
  */
 exports.googleDriveDestinationGoogleDriveDestinationSchema = zod_1.z.object({
-    provider: zod_1.z.string().default('google-drive'),
+    provider: zod_1.z.literal('google-drive'),
     options: exports.googleDriveDestinationOptionsGoogleDriveDestinationOptionsSchema
 });
 exports.googleDriveDestinationSchema = exports.googleDriveDestinationGoogleDriveDestinationSchema;
@@ -762,7 +762,7 @@ exports.muxDestinationOptionsSchema = exports.muxDestinationOptionsMuxDestinatio
  * Send videos to the [Mux](https://shotstack.io/docs/guide/serving-assets/destinations/mux/) video hosting and streaming service. Mux credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/mux), not in the request.
  */
 exports.muxDestinationMuxDestinationSchema = zod_1.z.object({
-    provider: zod_1.z.string().default('mux'),
+    provider: zod_1.z.literal('mux'),
     options: zod_1.z.optional(exports.muxDestinationOptionsMuxDestinationOptionsSchema)
 });
 exports.muxDestinationSchema = exports.muxDestinationMuxDestinationSchema;
@@ -781,7 +781,7 @@ exports.s3DestinationOptionsSchema = exports.s3DestinationOptionsS3DestinationOp
  * Send videos and assets to an [Amazon S3](https://shotstack.io/docs/guide/serving-assets/destinations/s3/) bucket. Send files to any region with your own prefix and filename. AWS credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/s3), not in the request.
  */
 exports.s3DestinationS3DestinationSchema = zod_1.z.object({
-    provider: zod_1.z.string().default('s3'),
+    provider: zod_1.z.literal('s3'),
     options: zod_1.z.optional(exports.s3DestinationOptionsS3DestinationOptionsSchema)
 });
 exports.s3DestinationSchema = exports.s3DestinationS3DestinationSchema;
@@ -789,7 +789,7 @@ exports.s3DestinationSchema = exports.s3DestinationS3DestinationSchema;
  * Send videos and assets to the  [Shotstack hosting and CDN](https://shotstack.io/docs/guide/serving-assets/destinations/shotstack/) service.  This destination is enabled by default.
  */
 exports.shotstackDestinationShotstackDestinationSchema = zod_1.z.object({
-    provider: zod_1.z.string().default('shotstack'),
+    provider: zod_1.z.literal('shotstack'),
     exclude: zod_1.z.optional(zod_1.z.boolean())
 });
 exports.shotstackDestinationSchema = exports.shotstackDestinationShotstackDestinationSchema;
@@ -811,7 +811,7 @@ exports.tiktokDestinationOptionsTiktokDestinationOptionsSchema = zod_1.z.object(
  * Send videos to TikTok. TikTok credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/tiktok), not in the request.
  */
 exports.tiktokDestinationTiktokDestinationSchema = zod_1.z.object({
-    provider: zod_1.z.string().default('tiktok'),
+    provider: zod_1.z.literal('tiktok'),
     options: zod_1.z.optional(exports.tiktokDestinationOptionsTiktokDestinationOptionsSchema)
 });
 /**
@@ -834,7 +834,9 @@ exports.vimeoDestinationPrivacyOptionsVimeoDestinationPrivacyOptionsSchema = zod
         'anybody',
         'nobody',
         'contacts'
-    ]))
+    ])),
+    download: zod_1.z.optional(zod_1.z.boolean()),
+    add: zod_1.z.optional(zod_1.z.boolean())
 });
 exports.vimeoDestinationPrivacyOptionsSchema = exports.vimeoDestinationPrivacyOptionsVimeoDestinationPrivacyOptionsSchema;
 /**
@@ -851,7 +853,7 @@ exports.vimeoDestinationOptionsSchema = exports.vimeoDestinationOptionsVimeoDest
  * Send videos to [Vimeo](https://shotstack.io/docs/guide/serving-assets/destinations/vimeo/) video hosting and streaming service. Vimeo credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/vimeo), not in the request.
  */
 exports.vimeoDestinationVimeoDestinationSchema = zod_1.z.object({
-    provider: zod_1.z.string().default('vimeo'),
+    provider: zod_1.z.literal('vimeo'),
     options: zod_1.z.optional(exports.vimeoDestinationOptionsVimeoDestinationOptionsSchema)
 });
 exports.vimeoDestinationSchema = exports.vimeoDestinationVimeoDestinationSchema;
@@ -860,28 +862,14 @@ exports.vimeoDestinationSchema = exports.vimeoDestinationVimeoDestinationSchema;
  *
  * By default all ingested and generated assets are automatically sent to the [Shotstack hosting destination](https://shotstack.io/docs/guide/serving-assets/hosting/). You can [opt-out](https://shotstack.io/docs/guide/serving-assets/self-host/) from by setting the Shotstack destination **exclude** property to **true**.
  */
-exports.destinationsDestinationsSchema = zod_1.z.union([
-    zod_1.z.object({
-        destinations: zod_1.z.optional(zod_1.z.literal('shotstackDestination_ShotstackDestination'))
-    }).and(exports.shotstackDestinationShotstackDestinationSchema),
-    zod_1.z.object({
-        destinations: zod_1.z.optional(zod_1.z.literal('muxDestination_MuxDestination'))
-    }).and(exports.muxDestinationMuxDestinationSchema),
-    zod_1.z.object({
-        destinations: zod_1.z.optional(zod_1.z.literal('s3Destination_S3Destination'))
-    }).and(exports.s3DestinationS3DestinationSchema),
-    zod_1.z.object({
-        destinations: zod_1.z.optional(zod_1.z.literal('googleCloudStorageDestination_GoogleCloudStorageDestination'))
-    }).and(exports.googleCloudStorageDestinationGoogleCloudStorageDestinationSchema),
-    zod_1.z.object({
-        destinations: zod_1.z.optional(zod_1.z.literal('googleDriveDestination_GoogleDriveDestination'))
-    }).and(exports.googleDriveDestinationGoogleDriveDestinationSchema),
-    zod_1.z.object({
-        destinations: zod_1.z.optional(zod_1.z.literal('vimeoDestination_VimeoDestination'))
-    }).and(exports.vimeoDestinationVimeoDestinationSchema),
-    zod_1.z.object({
-        destinations: zod_1.z.optional(zod_1.z.literal('tiktokDestination_TiktokDestination'))
-    }).and(exports.tiktokDestinationTiktokDestinationSchema)
+exports.destinationsDestinationsSchema = zod_1.z.discriminatedUnion("provider", [
+    exports.shotstackDestinationShotstackDestinationSchema,
+    exports.muxDestinationMuxDestinationSchema,
+    exports.s3DestinationS3DestinationSchema,
+    exports.googleCloudStorageDestinationGoogleCloudStorageDestinationSchema,
+    exports.googleDriveDestinationGoogleDriveDestinationSchema,
+    exports.vimeoDestinationVimeoDestinationSchema,
+    exports.tiktokDestinationTiktokDestinationSchema
 ]);
 exports.destinationsSchema = exports.destinationsDestinationsSchema;
 /**
@@ -2864,15 +2852,14 @@ exports.clipClipSchema = zod_1.z.object({
             return undefined; if (Array.isArray(v))
             return v; if (typeof v === 'string')
             return Number(v); return v; }), zod_1.z.number()),
-        zod_1.z.enum(['auto'])
+        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()),
-        zod_1.z.literal('auto'),
-        zod_1.z.literal('end')
+        zod_1.z.string().regex(/^(auto|end|alias:\/\/[A-Za-z0-9_-]+)$/)
     ]),
     fit: zod_1.z.optional(zod_1.z.enum([
         'cover',