@shotstack/schemas 1.5.9 → 1.7.0

package/dist/json-schema/flip-transformation.json

@@ -0,0 +1,37 @@
+{
+  "name": "FlipTransformation",
+  "strict": true,
+  "schema": {
+    "description": "Flip a clip vertically or horizontally. Acts as a mirror effect of the clip along the selected plane.",
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+      "horizontal": {
+        "anyOf": [
+          {
+            "type": "boolean",
+            "description": "Flip a clip horizontally."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "vertical": {
+        "anyOf": [
+          {
+            "type": "boolean",
+            "description": "Flip a clip vertically."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "required": [
+      "horizontal",
+      "vertical"
+    ]
+  }
+}

package/dist/json-schema/font.json

@@ -0,0 +1,18 @@
+{
+  "name": "Font",
+  "strict": true,
+  "schema": {
+    "description": "Download a custom font to use with the HTML asset type, using the font name in the CSS or font tag. See our [custom fonts](https://shotstack.io/learn/html-custom-fonts/) getting started guide for more details.",
+    "properties": {
+      "src": {
+        "description": "The URL of the font file. The URL must be publicly accessible or include credentials.",
+        "type": "string"
+      }
+    },
+    "additionalProperties": false,
+    "required": [
+      "src"
+    ],
+    "type": "object"
+  }
+}

package/dist/json-schema/google-cloud-storage-destination-options.json

@@ -0,0 +1,42 @@
+{
+  "name": "GoogleCloudStorageDestinationOptions",
+  "strict": true,
+  "schema": {
+    "description": "Pass additional options to control how files are stored in Google Cloud Storage.",
+    "properties": {
+      "bucket": {
+        "description": "The bucket name to send files to. The bucket must exist in the Google Cloud Storage account before files can be sent.",
+        "type": "string"
+      },
+      "prefix": {
+        "anyOf": [
+          {
+            "type": "string",
+            "description": "A prefix for the file being sent. This is typically a folder name, i.e. `videos` or `customerId/videos`."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "filename": {
+        "anyOf": [
+          {
+            "type": "string",
+            "description": "Use your own filename instead of the default filenames generated by Shotstack. Note: omit the file extension as this will be appended depending on the output format. Also `-poster.jpg` and `-thumb.jpg` will be appended for poster and thumbnail images."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "required": [
+      "bucket",
+      "prefix",
+      "filename"
+    ],
+    "type": "object",
+    "additionalProperties": false
+  }
+}

package/dist/json-schema/google-cloud-storage-destination.json

@@ -0,0 +1,73 @@
+{
+  "name": "GoogleCloudStorageDestination",
+  "strict": true,
+  "schema": {
+    "description": "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.",
+    "properties": {
+      "provider": {
+        "description": "The destination to send assets to - set to `google-cloud-storage` for Google Cloud Storage.",
+        "type": "string",
+        "enum": [
+          "google-cloud-storage"
+        ]
+      },
+      "options": {
+        "anyOf": [
+          {
+            "description": "Additional Google Cloud Storage configuration options.",
+            "$ref": "#/$defs/GoogleCloudStorageDestinationOptions"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "type": "object",
+    "required": [
+      "provider",
+      "options"
+    ],
+    "additionalProperties": false,
+    "$defs": {
+      "GoogleCloudStorageDestinationOptions": {
+        "description": "Pass additional options to control how files are stored in Google Cloud Storage.",
+        "properties": {
+          "bucket": {
+            "description": "The bucket name to send files to. The bucket must exist in the Google Cloud Storage account before files can be sent.",
+            "type": "string"
+          },
+          "prefix": {
+            "anyOf": [
+              {
+                "type": "string",
+                "description": "A prefix for the file being sent. This is typically a folder name, i.e. `videos` or `customerId/videos`."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "filename": {
+            "anyOf": [
+              {
+                "type": "string",
+                "description": "Use your own filename instead of the default filenames generated by Shotstack. Note: omit the file extension as this will be appended depending on the output format. Also `-poster.jpg` and `-thumb.jpg` will be appended for poster and thumbnail images."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "required": [
+          "bucket",
+          "prefix",
+          "filename"
+        ],
+        "type": "object",
+        "additionalProperties": false
+      }
+    }
+  }
+}

package/dist/json-schema/google-drive-destination-options.json

@@ -0,0 +1,30 @@
+{
+  "name": "GoogleDriveDestinationOptions",
+  "strict": true,
+  "schema": {
+    "description": "Pass the folder ID and options to configure how assets are stored in Google Drive.",
+    "properties": {
+      "folderId": {
+        "description": "The Google Drive folder ID where asset will be stored. The folder ID is required and can be retrieved from the URL when logged in to Google Drive, e.g. <a href=\"#\">https://drive.google.com/drive/u/0/folders/1r-eTY6OLO8tzQRKwMyq-fIrQ_7AJEI6A</a>.",
+        "type": "string"
+      },
+      "filename": {
+        "anyOf": [
+          {
+            "type": "string",
+            "description": "Use your own filename instead of the default filenames generated by Shotstack. Note: omit the file extension as this will be appended depending on the output format. Also `-poster.jpg` and `-thumb.jpg` will be appended for poster and thumbnail images."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "required": [
+      "folderId",
+      "filename"
+    ],
+    "type": "object",
+    "additionalProperties": false
+  }
+}

package/dist/json-schema/google-drive-destination.json

@@ -0,0 +1,54 @@
+{
+  "name": "GoogleDriveDestination",
+  "strict": true,
+  "schema": {
+    "description": "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.",
+    "properties": {
+      "provider": {
+        "description": "The destination to send assets to - set to `google-drive` for Google Drive.",
+        "type": "string",
+        "enum": [
+          "google-drive"
+        ]
+      },
+      "options": {
+        "description": "Additional Google Drive configuration and features.",
+        "$ref": "#/$defs/GoogleDriveDestinationOptions"
+      }
+    },
+    "type": "object",
+    "required": [
+      "provider",
+      "options"
+    ],
+    "additionalProperties": false,
+    "$defs": {
+      "GoogleDriveDestinationOptions": {
+        "description": "Pass the folder ID and options to configure how assets are stored in Google Drive.",
+        "properties": {
+          "folderId": {
+            "description": "The Google Drive folder ID where asset will be stored. The folder ID is required and can be retrieved from the URL when logged in to Google Drive, e.g. <a href=\"#\">https://drive.google.com/drive/u/0/folders/1r-eTY6OLO8tzQRKwMyq-fIrQ_7AJEI6A</a>.",
+            "type": "string"
+          },
+          "filename": {
+            "anyOf": [
+              {
+                "type": "string",
+                "description": "Use your own filename instead of the default filenames generated by Shotstack. Note: omit the file extension as this will be appended depending on the output format. Also `-poster.jpg` and `-thumb.jpg` will be appended for poster and thumbnail images."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "required": [
+          "folderId",
+          "filename"
+        ],
+        "type": "object",
+        "additionalProperties": false
+      }
+    }
+  }
+}

package/dist/json-schema/image-asset.json

@@ -0,0 +1,104 @@
+{
+  "name": "ImageAsset",
+  "strict": true,
+  "schema": {
+    "description": "The ImageAsset is used to create video from images to compose an image. The src must be a publicly accessible URL to an image resource such as a jpg or png file.",
+    "type": "object",
+    "properties": {
+      "type": {
+        "enum": [
+          "image"
+        ],
+        "description": "The type of asset - set to `image` for images.",
+        "type": "string"
+      },
+      "src": {
+        "description": "The image source URL. The URL must be publicly accessible or include credentials.",
+        "type": "string"
+      },
+      "crop": {
+        "anyOf": [
+          {
+            "$ref": "#/$defs/Crop"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "additionalProperties": false,
+    "required": [
+      "type",
+      "src",
+      "crop"
+    ],
+    "$defs": {
+      "Crop": {
+        "description": "Crop the sides of an asset by a relative amount. The size of the crop is specified using a scale between 0 and 1, relative to the screen width - i.e a left crop of 0.5 will crop half of the asset from the left, a top crop  of 0.25 will crop the top by quarter of the asset.",
+        "properties": {
+          "top": {
+            "anyOf": [
+              {
+                "type": "number",
+                "description": "Crop from the top of the asset",
+                "minimum": 0,
+                "maximum": 1
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "bottom": {
+            "anyOf": [
+              {
+                "type": "number",
+                "description": "Crop from the bottom of the asset",
+                "minimum": 0,
+                "maximum": 1
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "left": {
+            "anyOf": [
+              {
+                "type": "number",
+                "description": "Crop from the left of the asset",
+                "minimum": 0,
+                "maximum": 1
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "right": {
+            "anyOf": [
+              {
+                "type": "number",
+                "description": "Crop from the left of the asset",
+                "minimum": 0,
+                "maximum": 1
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "additionalProperties": false,
+        "type": "object",
+        "required": [
+          "top",
+          "bottom",
+          "left",
+          "right"
+        ]
+      }
+    }
+  }
+}

package/dist/json-schema/image-to-video-asset.json

@@ -0,0 +1,151 @@
+{
+  "name": "ImageToVideoAsset",
+  "strict": true,
+  "schema": {
+    "description": "The ImageToVideoAsset lets you create a video from an image and a text prompt.",
+    "properties": {
+      "type": {
+        "type": "string",
+        "description": "The type of asset to generate - set to `image-to-video` for image-to-video.",
+        "enum": [
+          "image-to-video"
+        ]
+      },
+      "src": {
+        "description": "The image source URL. The URL must be publicly accessible or include credentials.",
+        "type": "string"
+      },
+      "prompt": {
+        "anyOf": [
+          {
+            "type": "string",
+            "description": "The instructions for modifying the image into a video sequence."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "aspectRatio": {
+        "anyOf": [
+          {
+            "type": "string",
+            "description": "The aspect ratio (shape) of the video output.",
+            "enum": [
+              "1:1",
+              "4:3",
+              "16:9",
+              "9:16",
+              "3:4",
+              "21:9",
+              "9:21"
+            ]
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "speed": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "Adjust the playback speed of the video clip between 0 (paused) and 10 (10x normal speed) where 1 is normal speed (defaults to 1). Adjusting the speed will also adjust the duration of the clip and may require you to  adjust the Clip length. For example, if you set speed to 0.5, the clip will need to be 2x as long to play the entire video (i.e. original length / 0.5). If you set speed to 2, the clip will need to be half as long to play the entire video (i.e. original length / 2).",
+            "minimum": 0,
+            "maximum": 10
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "crop": {
+        "anyOf": [
+          {
+            "$ref": "#/$defs/Crop"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "additionalProperties": false,
+    "type": "object",
+    "required": [
+      "type",
+      "src",
+      "prompt",
+      "aspectRatio",
+      "speed",
+      "crop"
+    ],
+    "$defs": {
+      "Crop": {
+        "description": "Crop the sides of an asset by a relative amount. The size of the crop is specified using a scale between 0 and 1, relative to the screen width - i.e a left crop of 0.5 will crop half of the asset from the left, a top crop  of 0.25 will crop the top by quarter of the asset.",
+        "properties": {
+          "top": {
+            "anyOf": [
+              {
+                "type": "number",
+                "description": "Crop from the top of the asset",
+                "minimum": 0,
+                "maximum": 1
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "bottom": {
+            "anyOf": [
+              {
+                "type": "number",
+                "description": "Crop from the bottom of the asset",
+                "minimum": 0,
+                "maximum": 1
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "left": {
+            "anyOf": [
+              {
+                "type": "number",
+                "description": "Crop from the left of the asset",
+                "minimum": 0,
+                "maximum": 1
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "right": {
+            "anyOf": [
+              {
+                "type": "number",
+                "description": "Crop from the left of the asset",
+                "minimum": 0,
+                "maximum": 1
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "additionalProperties": false,
+        "type": "object",
+        "required": [
+          "top",
+          "bottom",
+          "left",
+          "right"
+        ]
+      }
+    }
+  }
+}

package/dist/json-schema/index.cjs

@@ -0,0 +1 @@
+module.exports.edit = require('./edit.json');

package/dist/json-schema/index.d.ts

@@ -0,0 +1,6 @@
+export interface JsonSchema {
+  name: string;
+  strict: boolean;
+  schema: Record<string, unknown>;
+}
+export declare const edit: JsonSchema;

package/dist/json-schema/index.js

@@ -0,0 +1,3 @@
+import { createRequire } from 'module';
+const require = createRequire(import.meta.url);
+export const edit = require('./edit.json');

package/dist/json-schema/luma-asset.json

@@ -0,0 +1,38 @@
+{
+  "name": "LumaAsset",
+  "strict": true,
+  "schema": {
+    "description": "The LumaAsset is used to create luma matte masks, transitions and effects between other assets. A luma matte is a grey scale image or animated video where the black areas are transparent and the white areas solid. The luma matte animation should be provided as an mp4 video file. The src must be a publicly accessible URL to the file.",
+    "type": "object",
+    "properties": {
+      "type": {
+        "enum": [
+          "luma"
+        ],
+        "description": "The type of asset - set to `luma` for luma mattes.",
+        "type": "string"
+      },
+      "src": {
+        "description": "The luma matte source URL. The URL must be publicly accessible or include credentials.",
+        "type": "string"
+      },
+      "trim": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "The start trim point of the luma matte clip, in seconds (defaults to 0). Videos will start from the in trim point. A luma matte video will play until the file ends or the Clip length is reached."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "additionalProperties": false,
+    "required": [
+      "type",
+      "src",
+      "trim"
+    ]
+  }
+}

package/dist/json-schema/merge-field.json

@@ -0,0 +1,23 @@
+{
+  "name": "MergeField",
+  "strict": true,
+  "schema": {
+    "description": "A merge field consists of a key; `find`, and a value; `replace`. Merge fields can be used to replace placeholders within the JSON edit to create re-usable templates. Placeholders should be a string with double brace delimiters, i.e. `\"{{NAME}}\"`. A placeholder can be used for any value within the JSON edit.",
+    "type": "object",
+    "properties": {
+      "find": {
+        "description": "The string to find <u>without</u> delimiters.",
+        "type": "string"
+      },
+      "replace": {
+        "description": "The replacement value. The replacement can be any valid JSON type - string, boolean, number, etc...",
+        "type": "string"
+      }
+    },
+    "additionalProperties": false,
+    "required": [
+      "find",
+      "replace"
+    ]
+  }
+}