@shotstack/schemas 1.6.0 → 1.7.0

package/dist/json-schema/crop.json

@@ -0,0 +1,69 @@
+{
+  "name": "Crop",
+  "strict": true,
+  "schema": {
+    "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/destinations.json

@@ -0,0 +1,495 @@
+{
+  "name": "Destinations",
+  "strict": true,
+  "schema": {
+    "description": "A destination is a...",
+    "anyOf": [
+      {
+        "$ref": "#/$defs/ShotstackDestination"
+      },
+      {
+        "$ref": "#/$defs/S3Destination"
+      },
+      {
+        "$ref": "#/$defs/GoogleCloudStorageDestination"
+      },
+      {
+        "$ref": "#/$defs/GoogleDriveDestination"
+      },
+      {
+        "$ref": "#/$defs/VimeoDestination"
+      },
+      {
+        "description": "S...",
+        "properties": {
+          "provider": {
+            "type": "string",
+            "enum": [
+              "tiktok"
+            ]
+          },
+          "options": {
+            "anyOf": [
+              {
+                "type": "object",
+                "properties": {
+                  "title": {
+                    "anyOf": [
+                      {
+                        "type": "string"
+                      },
+                      {
+                        "type": "null"
+                      }
+                    ]
+                  },
+                  "privacyLevel": {
+                    "anyOf": [
+                      {
+                        "type": "string",
+                        "description": "Th...",
+                        "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
+      }
+    ],
+    "$defs": {
+      "ShotstackDestination": {
+        "description": "S...",
+        "properties": {
+          "provider": {
+            "type": "string",
+            "enum": [
+              "shotstack"
+            ]
+          },
+          "exclude": {
+            "anyOf": [
+              {
+                "type": "boolean",
+                "description": "S..."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "type": "object",
+        "required": [
+          "provider",
+          "exclude"
+        ],
+        "additionalProperties": false
+      },
+      "S3Destination": {
+        "description": "Send...",
+        "properties": {
+          "provider": {
+            "type": "string",
+            "enum": [
+              "s3"
+            ]
+          },
+          "options": {
+            "anyOf": [
+              {
+                "$ref": "#/$defs/S3DestinationOptions"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "type": "object",
+        "required": [
+          "provider",
+          "options"
+        ],
+        "additionalProperties": false
+      },
+      "S3DestinationOptions": {
+        "properties": {
+          "region": {
+            "description": "C...",
+            "type": "string"
+          },
+          "bucket": {
+            "type": "string"
+          },
+          "prefix": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "filename": {
+            "anyOf": [
+              {
+                "type": "string",
+                "description": "Use..."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "acl": {
+            "anyOf": [
+              {
+                "type": "string",
+                "description": "Se..."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "required": [
+          "region",
+          "bucket",
+          "prefix",
+          "filename",
+          "acl"
+        ],
+        "type": "object",
+        "additionalProperties": false
+      },
+      "GoogleCloudStorageDestination": {
+        "description": "Send...",
+        "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",
+                "description": "Use..."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "required": [
+          "bucket",
+          "prefix",
+          "filename"
+        ],
+        "type": "object",
+        "additionalProperties": false
+      },
+      "GoogleDriveDestination": {
+        "description": "Send ...",
+        "properties": {
+          "provider": {
+            "type": "string",
+            "enum": [
+              "google-drive"
+            ]
+          },
+          "options": {
+            "$ref": "#/$defs/GoogleDriveDestinationOptions"
+          }
+        },
+        "type": "object",
+        "required": [
+          "provider",
+          "options"
+        ],
+        "additionalProperties": false
+      },
+      "GoogleDriveDestinationOptions": {
+        "properties": {
+          "folderId": {
+            "description": "The...",
+            "type": "string"
+          },
+          "filename": {
+            "anyOf": [
+              {
+                "type": "string",
+                "description": "Use..."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "required": [
+          "folderId",
+          "filename"
+        ],
+        "type": "object",
+        "additionalProperties": false
+      },
+      "VimeoDestination": {
+        "description": "Sen...",
+        "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",
+                "description": "Set wh...",
+                "enum": [
+                  "anybody",
+                  "nobody",
+                  "contacts",
+                  "password",
+                  "unlisted"
+                ]
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "embed": {
+            "anyOf": [
+              {
+                "type": "string",
+                "description": "Set...",
+                "enum": [
+                  "public",
+                  "private",
+                  "whitelist"
+                ]
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "comments": {
+            "anyOf": [
+              {
+                "type": "string",
+                "description": "Set...",
+                "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"
+        ]
+      }
+    }
+  }
+}