@shotstack/schemas 1.6.0 → 1.7.0

package/dist/json-schema/output.json

@@ -0,0 +1,771 @@
+{
+  "name": "Output",
+  "strict": true,
+  "schema": {
+    "properties": {
+      "format": {
+        "enum": [
+          "mp4",
+          "gif",
+          "mp3",
+          "jpg",
+          "png",
+          "bmp"
+        ],
+        "type": "string"
+      },
+      "resolution": {
+        "anyOf": [
+          {
+            "type": "string",
+            "enum": [
+              "preview",
+              "mobile",
+              "sd",
+              "hd",
+              "1080",
+              "4k"
+            ]
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "aspectRatio": {
+        "anyOf": [
+          {
+            "type": "string",
+            "enum": [
+              "16:9",
+              "9:16",
+              "1:1",
+              "4:5",
+              "4:3"
+            ]
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "size": {
+        "anyOf": [
+          {
+            "$ref": "#/$defs/Size"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "fps": {
+        "anyOf": [
+          {
+            "type": "number",
+            "enum": [
+              12,
+              15,
+              23.976,
+              24,
+              25,
+              29.97,
+              30,
+              48,
+              50,
+              59.94,
+              60
+            ]
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "scaleTo": {
+        "anyOf": [
+          {
+            "type": "string",
+            "enum": [
+              "preview",
+              "mobile",
+              "sd",
+              "hd",
+              "1080",
+              "4k"
+            ]
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "quality": {
+        "anyOf": [
+          {
+            "type": "string",
+            "enum": [
+              "verylow",
+              "low",
+              "medium",
+              "high",
+              "veryhigh"
+            ]
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "repeat": {
+        "anyOf": [
+          {
+            "type": "boolean"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "mute": {
+        "anyOf": [
+          {
+            "type": "boolean"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "range": {
+        "anyOf": [
+          {
+            "$ref": "#/$defs/Range"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "poster": {
+        "anyOf": [
+          {
+            "$ref": "#/$defs/Poster"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "thumbnail": {
+        "anyOf": [
+          {
+            "$ref": "#/$defs/Thumbnail"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "destinations": {
+        "anyOf": [
+          {
+            "type": "array",
+            "items": {
+              "$ref": "#/$defs/Destinations"
+            }
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "additionalProperties": false,
+    "required": [
+      "format",
+      "resolution",
+      "aspectRatio",
+      "size",
+      "fps",
+      "scaleTo",
+      "quality",
+      "repeat",
+      "mute",
+      "range",
+      "poster",
+      "thumbnail",
+      "destinations"
+    ],
+    "type": "object",
+    "$defs": {
+      "Size": {
+        "properties": {
+          "width": {
+            "anyOf": [
+              {
+                "type": "integer",
+                "minimum": 1,
+                "maximum": 4096
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "height": {
+            "anyOf": [
+              {
+                "type": "integer",
+                "minimum": 1,
+                "maximum": 4096
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "additionalProperties": false,
+        "type": "object",
+        "required": [
+          "width",
+          "height"
+        ]
+      },
+      "Range": {
+        "properties": {
+          "start": {
+            "anyOf": [
+              {
+                "type": "number",
+                "minimum": 0
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "length": {
+            "anyOf": [
+              {
+                "type": "number",
+                "minimum": 0
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "additionalProperties": false,
+        "type": "object",
+        "required": [
+          "start",
+          "length"
+        ]
+      },
+      "Poster": {
+        "properties": {
+          "capture": {
+            "type": "number"
+          }
+        },
+        "additionalProperties": false,
+        "required": [
+          "capture"
+        ],
+        "type": "object"
+      },
+      "Thumbnail": {
+        "properties": {
+          "capture": {
+            "type": "number"
+          },
+          "scale": {
+            "type": "number",
+            "minimum": 0,
+            "maximum": 1
+          }
+        },
+        "additionalProperties": false,
+        "required": [
+          "capture",
+          "scale"
+        ],
+        "type": "object"
+      },
+      "Destinations": {
+        "anyOf": [
+          {
+            "$ref": "#/$defs/ShotstackDestination"
+          },
+          {
+            "$ref": "#/$defs/S3Destination"
+          },
+          {
+            "$ref": "#/$defs/GoogleCloudStorageDestination"
+          },
+          {
+            "$ref": "#/$defs/GoogleDriveDestination"
+          },
+          {
+            "$ref": "#/$defs/VimeoDestination"
+          },
+          {
+            "properties": {
+              "provider": {
+                "type": "string",
+                "enum": [
+                  "tiktok"
+                ]
+              },
+              "options": {
+                "anyOf": [
+                  {
+                    "type": "object",
+                    "properties": {
+                      "title": {
+                        "anyOf": [
+                          {
+                            "type": "string"
+                          },
+                          {
+                            "type": "null"
+                          }
+                        ]
+                      },
+                      "privacyLevel": {
+                        "anyOf": [
+                          {
+                            "type": "string",
+                            "enum": [
+                              "public",
+                              "friends",
+                              "private"
+                            ]
+                          },
+                          {
+                            "type": "null"
+                          }
+                        ]
+                      },
+                      "disableDuet": {
+                        "anyOf": [
+                          {
+                            "type": "boolean"
+                          },
+                          {
+                            "type": "null"
+                          }
+                        ]
+                      },
+                      "disableStitch": {
+                        "anyOf": [
+                          {
+                            "type": "boolean"
+                          },
+                          {
+                            "type": "null"
+                          }
+                        ]
+                      },
+                      "disableComment": {
+                        "anyOf": [
+                          {
+                            "type": "boolean"
+                          },
+                          {
+                            "type": "null"
+                          }
+                        ]
+                      }
+                    },
+                    "additionalProperties": false,
+                    "required": [
+                      "title",
+                      "privacyLevel",
+                      "disableDuet",
+                      "disableStitch",
+                      "disableComment"
+                    ]
+                  },
+                  {
+                    "type": "null"
+                  }
+                ]
+              }
+            },
+            "type": "object",
+            "required": [
+              "provider",
+              "options"
+            ],
+            "additionalProperties": false
+          }
+        ]
+      },
+      "ShotstackDestination": {
+        "properties": {
+          "provider": {
+            "type": "string",
+            "enum": [
+              "shotstack"
+            ]
+          },
+          "exclude": {
+            "anyOf": [
+              {
+                "type": "boolean"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "type": "object",
+        "required": [
+          "provider",
+          "exclude"
+        ],
+        "additionalProperties": false
+      },
+      "S3Destination": {
+        "properties": {
+          "provider": {
+            "type": "string",
+            "enum": [
+              "s3"
+            ]
+          },
+          "options": {
+            "anyOf": [
+              {
+                "$ref": "#/$defs/S3DestinationOptions"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "type": "object",
+        "required": [
+          "provider",
+          "options"
+        ],
+        "additionalProperties": false
+      },
+      "S3DestinationOptions": {
+        "properties": {
+          "region": {
+            "type": "string"
+          },
+          "bucket": {
+            "type": "string"
+          },
+          "prefix": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "filename": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "acl": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "required": [
+          "region",
+          "bucket",
+          "prefix",
+          "filename",
+          "acl"
+        ],
+        "type": "object",
+        "additionalProperties": false
+      },
+      "GoogleCloudStorageDestination": {
+        "properties": {
+          "provider": {
+            "type": "string",
+            "enum": [
+              "google-cloud-storage"
+            ]
+          },
+          "options": {
+            "anyOf": [
+              {
+                "$ref": "#/$defs/GoogleCloudStorageDestinationOptions"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "type": "object",
+        "required": [
+          "provider",
+          "options"
+        ],
+        "additionalProperties": false
+      },
+      "GoogleCloudStorageDestinationOptions": {
+        "properties": {
+          "bucket": {
+            "type": "string"
+          },
+          "prefix": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "filename": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "required": [
+          "bucket",
+          "prefix",
+          "filename"
+        ],
+        "type": "object",
+        "additionalProperties": false
+      },
+      "GoogleDriveDestination": {
+        "properties": {
+          "provider": {
+            "type": "string",
+            "enum": [
+              "google-drive"
+            ]
+          },
+          "options": {
+            "$ref": "#/$defs/GoogleDriveDestinationOptions"
+          }
+        },
+        "type": "object",
+        "required": [
+          "provider",
+          "options"
+        ],
+        "additionalProperties": false
+      },
+      "GoogleDriveDestinationOptions": {
+        "properties": {
+          "folderId": {
+            "type": "string"
+          },
+          "filename": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "required": [
+          "folderId",
+          "filename"
+        ],
+        "type": "object",
+        "additionalProperties": false
+      },
+      "VimeoDestination": {
+        "properties": {
+          "provider": {
+            "type": "string",
+            "enum": [
+              "vimeo"
+            ]
+          },
+          "options": {
+            "anyOf": [
+              {
+                "$ref": "#/$defs/VimeoDestinationOptions"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "type": "object",
+        "required": [
+          "provider",
+          "options"
+        ],
+        "additionalProperties": false
+      },
+      "VimeoDestinationOptions": {
+        "properties": {
+          "name": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "description": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "privacy": {
+            "anyOf": [
+              {
+                "$ref": "#/$defs/VimeoDestinationPrivacyOptions"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "folderUri": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "name",
+          "description",
+          "privacy",
+          "folderUri"
+        ]
+      },
+      "VimeoDestinationPrivacyOptions": {
+        "properties": {
+          "view": {
+            "anyOf": [
+              {
+                "type": "string",
+                "enum": [
+                  "anybody",
+                  "nobody",
+                  "contacts",
+                  "password",
+                  "unlisted"
+                ]
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "embed": {
+            "anyOf": [
+              {
+                "type": "string",
+                "enum": [
+                  "public",
+                  "private",
+                  "whitelist"
+                ]
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "comments": {
+            "anyOf": [
+              {
+                "type": "string",
+                "enum": [
+                  "anybody",
+                  "nobody",
+                  "contacts"
+                ]
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "download": {
+            "anyOf": [
+              {
+                "type": "boolean"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "add": {
+            "anyOf": [
+              {
+                "type": "boolean"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "view",
+          "embed",
+          "comments",
+          "download",
+          "add"
+        ]
+      }
+    }
+  }
+}