@cloudcannon/configuration-types 0.0.28 → 0.0.31

package/dist/cloudcannon-config.legacy-reader.schema.json

@@ -1624,14 +1624,15 @@
         },
         "options": {
           "$ref": "#/definitions/FileInputOptions",
-          "description": "Options that are specific to File inputs.",
-          "markdownDescription": "Options that are specific to File inputs."
+          "description": "Options that are specific to File, Image and Document inputs.",
+          "markdownDescription": "Options that are specific to File, Image and Document inputs."
         },
         "type": {
           "description": "Sets an input type, which controls how this input appears and behaves.",
           "enum": [
             "file",
-            "document"
+            "document",
+            "image"
           ],
           "markdownDescription": "Sets an input type, which controls how this input appears and behaves.",
           "type": "string"
@@ -1668,6 +1669,24 @@
           "markdownDescription": "If you have one or more DAMs connected to your site, you can use this key to list which asset\nsources can be uploaded to and selected from.",
           "type": "array"
         },
+        "disable_direct_input": {
+          "default": false,
+          "description": "Prevents typing into the text input, while still allowing context menu options to change the value.",
+          "markdownDescription": "Prevents typing into the text input, while still allowing context menu options to change the\nvalue.",
+          "type": "boolean"
+        },
+        "disable_upload_file": {
+          "default": false,
+          "description": "Disables the context menu option and the drop area for uploading files.",
+          "markdownDescription": "Disables the context menu option and the drop area for uploading files.",
+          "type": "boolean"
+        },
+        "disable_upload_file_in_file_browser": {
+          "default": false,
+          "description": "Prevents file uploads inside the \"Select existing file/image\" file browser modal window.",
+          "markdownDescription": "Prevents file uploads inside the \"Select existing file/image\" file browser modal window.",
+          "type": "boolean"
+        },
         "empty_type": {
           "description": "Set how an ‘empty’ value will be saved. Does not apply to existing empty values.",
           "enum": [
@@ -1677,10 +1696,84 @@
           "markdownDescription": "Set how an ‘empty’ value will be saved. Does not apply to existing empty values.",
           "type": "string"
         },
+        "expandable": {
+          "default": false,
+          "description": "Controls whether or not images can be upscaled to fit the bounding box during resize prior to upload. Has no effect if files are not resized.",
+          "markdownDescription": "Controls whether or not images can be upscaled to fit the bounding box during resize prior to\nupload. Has no effect if files are not resized.",
+          "type": "boolean"
+        },
+        "height": {
+          "description": "Defines the height of the bounding box used in the image resizing process defined with resize_style.",
+          "markdownDescription": "Defines the height of the bounding box used in the image resizing process defined with\nresize_style.",
+          "type": "number"
+        },
+        "image_size_attributes": {
+          "default": true,
+          "description": "Instructs the editor to save `width` and `height` attributes on the image elements. This can prevent pop-in as a page loads.",
+          "markdownDescription": "Instructs the editor to save `width` and `height` attributes on the image elements. This can\nprevent pop-in as a page loads.",
+          "type": "boolean"
+        },
+        "mime_type": {
+          "description": "Sets the format images are converted to prior to upload. The extension of the file is updated to match. Defaults to keeping the mime type of the uploaded file.",
+          "enum": [
+            "image/jpeg",
+            "image/png",
+            "image/webp"
+          ],
+          "markdownDescription": "Sets the format images are converted to prior to upload. The extension of the file is updated\nto match. Defaults to keeping the mime type of the uploaded file.",
+          "type": "string"
+        },
         "paths": {
           "$ref": "#/definitions/Paths",
           "description": "Paths to where new asset files are uploaded to. They also set the default path when choosing existing images, and linking to existing files. Each path is relative to global `source`. Defaults to the global `paths`.",
           "markdownDescription": "Paths to where new asset files are uploaded to. They also set the default path when choosing\nexisting images, and linking to existing files. Each path is relative to global `source`.\nDefaults to the global `paths`."
+        },
+        "prevent_resize_existing_files": {
+          "default": false,
+          "description": "Enable to skip the image resizing process configured for this input when selecting existing images.",
+          "markdownDescription": "Enable to skip the image resizing process configured for this input when selecting existing\nimages.",
+          "type": "boolean"
+        },
+        "resize_style": {
+          "default": "contain",
+          "description": "Sets how uploaded image files are resized with a bounding box defined by width and height prior to upload. Has no effect when selecting existing images, or if width and height are unset.",
+          "enum": [
+            "cover",
+            "contain",
+            "stretch",
+            "crop"
+          ],
+          "markdownDescription": "Sets how uploaded image files are resized with a bounding box defined by width and height prior\nto upload. Has no effect when selecting existing images, or if width and height are unset.",
+          "type": "string"
+        },
+        "sizes": {
+          "description": "Definitions for creating additional images of different sizes when uploading or selecting existing files.",
+          "items": {
+            "additionalProperties": false,
+            "properties": {
+              "size": {
+                "description": "A number suffixed with \"x\" (relative size) or \"w\" (fixed width) for setting the dimensions of the image (e.g. 2x, 3x, 100w, 360w).",
+                "markdownDescription": "A number suffixed with \"x\" (relative size) or \"w\" (fixed width) for setting the dimensions of\nthe image (e.g. 2x, 3x, 100w, 360w).",
+                "type": "string"
+              },
+              "target": {
+                "description": "A reference to another input that is given the path to this additional image file.",
+                "markdownDescription": "A reference to another input that is given the path to this additional image file.",
+                "type": "string"
+              }
+            },
+            "required": [
+              "size"
+            ],
+            "type": "object"
+          },
+          "markdownDescription": "Definitions for creating additional images of different sizes when uploading or selecting\nexisting files.",
+          "type": "array"
+        },
+        "width": {
+          "description": "Defines the width of the bounding box used in the image resizing process defined with resize_style.",
+          "markdownDescription": "Defines the width of the bounding box used in the image resizing process defined with\nresize_style.",
+          "type": "number"
         }
       },
       "type": "object"
@@ -5427,220 +5520,6 @@
       },
       "type": "object"
     },
-    "ImageInput": {
-      "additionalProperties": false,
-      "properties": {
-        "cascade": {
-          "description": "Specifies whether or not this input configuration should be merged with any matching, less specific configuration.",
-          "markdownDescription": "Specifies whether or not this input configuration should be merged with any matching, less\nspecific configuration.",
-          "type": "boolean"
-        },
-        "comment": {
-          "description": "Changes the subtext below the _Label_. Has no default. Supports a limited set of Markdown: links, bold, italic, subscript, superscript, and inline code elements are allowed.",
-          "markdownDescription": "Changes the subtext below the _Label_. Has no default. Supports a limited set of Markdown:\nlinks, bold, italic, subscript, superscript, and inline code elements are allowed.",
-          "type": "string"
-        },
-        "context": {
-          "additionalProperties": false,
-          "description": "Adds an expandable section of rich text below the input.",
-          "markdownDescription": "Adds an expandable section of rich text below the input.",
-          "properties": {
-            "content": {
-              "description": "The rich text content shown when opened. Supports a limited set of Markdown.",
-              "markdownDescription": "The rich text content shown when opened. Supports a limited set of Markdown.",
-              "type": "string"
-            },
-            "icon": {
-              "$ref": "#/definitions/Icon",
-              "description": "The icon shown when not open.",
-              "markdownDescription": "The icon shown when not open."
-            },
-            "open": {
-              "description": "Makes the content visible initially.",
-              "markdownDescription": "Makes the content visible initially.",
-              "type": "boolean"
-            },
-            "title": {
-              "description": "The text shown when not open. Defaults to \"Context\" if unset.",
-              "markdownDescription": "The text shown when not open. Defaults to \"Context\" if unset.",
-              "type": "string"
-            }
-          },
-          "type": "object"
-        },
-        "disable_instance_value_rehydration": {
-          "default": false,
-          "description": "Prevents the default where inputs configured with an `instance_value` are rehydrated with a new value when duplicated in the CMS.",
-          "markdownDescription": "Prevents the default where inputs configured with an `instance_value` are rehydrated with a new\nvalue when duplicated in the CMS.",
-          "type": "boolean"
-        },
-        "disabled": {
-          "default": false,
-          "description": "Toggles if this input can be edited.",
-          "markdownDescription": "Toggles if this input can be edited.",
-          "type": [
-            "boolean",
-            "string"
-          ]
-        },
-        "documentation": {
-          "$ref": "#/definitions/Documentation",
-          "description": "Provides a custom link for documentation for editors shown above input.",
-          "markdownDescription": "Provides a custom link for documentation for editors shown above input."
-        },
-        "hidden": {
-          "default": false,
-          "description": "Toggles the visibility of this input.",
-          "markdownDescription": "Toggles the visibility of this input.",
-          "type": [
-            "boolean",
-            "string"
-          ]
-        },
-        "instance_value": {
-          "$ref": "#/definitions/InstanceValue",
-          "description": "Controls if and how the value of this input is instantiated when created. This occurs when creating files, or adding array items containing the configured input.",
-          "markdownDescription": "Controls if and how the value of this input is instantiated when created. This occurs when\ncreating files, or adding array items containing the configured input."
-        },
-        "label": {
-          "description": "Optionally changes the text above this input.",
-          "markdownDescription": "Optionally changes the text above this input.",
-          "type": "string"
-        },
-        "options": {
-          "$ref": "#/definitions/ImageInputOptions",
-          "description": "Options that are specific to Image inputs.",
-          "markdownDescription": "Options that are specific to Image inputs."
-        },
-        "type": {
-          "const": "image",
-          "description": "Sets an input type, which controls how this input appears and behaves.",
-          "markdownDescription": "Sets an input type, which controls how this input appears and behaves.",
-          "type": "string"
-        }
-      },
-      "required": [
-        "type"
-      ],
-      "type": "object"
-    },
-    "ImageInputOptions": {
-      "additionalProperties": false,
-      "properties": {
-        "accepts_mime_types": {
-          "anyOf": [
-            {
-              "items": {
-                "$ref": "#/definitions/MimeType"
-              },
-              "type": "array"
-            },
-            {
-              "type": "string"
-            }
-          ],
-          "description": "Restricts which file types are available to select or upload to this input. Accepted format is an array or comma-separated string of MIME types. The special value '*' means any type is accepted.",
-          "markdownDescription": "Restricts which file types are available to select or upload to this input. Accepted format is\nan array or comma-separated string of MIME types. The special value '*' means any type is\naccepted."
-        },
-        "allowed_sources": {
-          "description": "If you have one or more DAMs connected to your site, you can use this key to list which asset sources can be uploaded to and selected from.",
-          "items": {
-            "type": "string"
-          },
-          "markdownDescription": "If you have one or more DAMs connected to your site, you can use this key to list which asset\nsources can be uploaded to and selected from.",
-          "type": "array"
-        },
-        "empty_type": {
-          "description": "Set how an ‘empty’ value will be saved. Does not apply to existing empty values.",
-          "enum": [
-            "null",
-            "string"
-          ],
-          "markdownDescription": "Set how an ‘empty’ value will be saved. Does not apply to existing empty values.",
-          "type": "string"
-        },
-        "expandable": {
-          "default": false,
-          "description": "Controls whether or not images can be upscaled to fit the bounding box during resize prior to upload. Has no effect if files are not resized.",
-          "markdownDescription": "Controls whether or not images can be upscaled to fit the bounding box during resize prior to\nupload. Has no effect if files are not resized.",
-          "type": "boolean"
-        },
-        "height": {
-          "description": "Defines the height of the bounding box used in the image resizing process defined with resize_style.",
-          "markdownDescription": "Defines the height of the bounding box used in the image resizing process defined with\nresize_style.",
-          "type": "number"
-        },
-        "image_size_attributes": {
-          "default": true,
-          "description": "Instructs the editor to save `width` and `height` attributes on the image elements. This can prevent pop-in as a page loads.",
-          "markdownDescription": "Instructs the editor to save `width` and `height` attributes on the image elements. This can\nprevent pop-in as a page loads.",
-          "type": "boolean"
-        },
-        "mime_type": {
-          "description": "Sets the format images are converted to prior to upload. The extension of the file is updated to match. Defaults to keeping the mime type of the uploaded file.",
-          "enum": [
-            "image/jpeg",
-            "image/png",
-            "image/webp"
-          ],
-          "markdownDescription": "Sets the format images are converted to prior to upload. The extension of the file is updated\nto match. Defaults to keeping the mime type of the uploaded file.",
-          "type": "string"
-        },
-        "paths": {
-          "$ref": "#/definitions/Paths",
-          "description": "Paths to where new asset files are uploaded to. They also set the default path when choosing existing images, and linking to existing files. Each path is relative to global `source`. Defaults to the global `paths`.",
-          "markdownDescription": "Paths to where new asset files are uploaded to. They also set the default path when choosing\nexisting images, and linking to existing files. Each path is relative to global `source`.\nDefaults to the global `paths`."
-        },
-        "prevent_resize_existing_files": {
-          "default": false,
-          "description": "Enable to skip the image resizing process configured for this input when selecting existing images.",
-          "markdownDescription": "Enable to skip the image resizing process configured for this input when selecting existing\nimages.",
-          "type": "boolean"
-        },
-        "resize_style": {
-          "default": "contain",
-          "description": "Sets how uploaded image files are resized with a bounding box defined by width and height prior to upload. Has no effect when selecting existing images, or if width and height are unset.",
-          "enum": [
-            "cover",
-            "contain",
-            "stretch",
-            "crop"
-          ],
-          "markdownDescription": "Sets how uploaded image files are resized with a bounding box defined by width and height prior\nto upload. Has no effect when selecting existing images, or if width and height are unset.",
-          "type": "string"
-        },
-        "sizes": {
-          "description": "Definitions for creating additional images of different sizes when uploading or selecting existing files.",
-          "items": {
-            "additionalProperties": false,
-            "properties": {
-              "size": {
-                "description": "A number suffixed with \"x\" (relative size) or \"w\" (fixed width) for setting the dimensions of the image (e.g. 2x, 3x, 100w, 360w).",
-                "markdownDescription": "A number suffixed with \"x\" (relative size) or \"w\" (fixed width) for setting the dimensions of\nthe image (e.g. 2x, 3x, 100w, 360w).",
-                "type": "string"
-              },
-              "target": {
-                "description": "A reference to another input that is given the path to this additional image file.",
-                "markdownDescription": "A reference to another input that is given the path to this additional image file.",
-                "type": "string"
-              }
-            },
-            "required": [
-              "size"
-            ],
-            "type": "object"
-          },
-          "markdownDescription": "Definitions for creating additional images of different sizes when uploading or selecting\nexisting files.",
-          "type": "array"
-        },
-        "width": {
-          "description": "Defines the width of the bounding box used in the image resizing process defined with resize_style.",
-          "markdownDescription": "Defines the width of the bounding box used in the image resizing process defined with\nresize_style.",
-          "type": "number"
-        }
-      },
-      "type": "object"
-    },
     "Input": {
       "anyOf": [
         {
@@ -5777,21 +5656,6 @@
             "$ref": "#/definitions/RangeInput"
           }
         },
-        {
-          "if": {
-            "properties": {
-              "type": {
-                "const": "url",
-                "description": "Sets an input type, which controls how this input appears and behaves.",
-                "markdownDescription": "Sets an input type, which controls how this input appears and behaves.",
-                "type": "string"
-              }
-            }
-          },
-          "then": {
-            "$ref": "#/definitions/UrlInput"
-          }
-        },
         {
           "if": {
             "properties": {
@@ -5850,7 +5714,8 @@
                 "description": "Sets an input type, which controls how this input appears and behaves.",
                 "enum": [
                   "file",
-                  "document"
+                  "document",
+                  "image"
                 ],
                 "markdownDescription": "Sets an input type, which controls how this input appears and behaves.",
                 "type": "string"
@@ -5865,7 +5730,7 @@
           "if": {
             "properties": {
               "type": {
-                "const": "image",
+                "const": "url",
                 "description": "Sets an input type, which controls how this input appears and behaves.",
                 "markdownDescription": "Sets an input type, which controls how this input appears and behaves.",
                 "type": "string"
@@ -5873,7 +5738,7 @@
             }
           },
           "then": {
-            "$ref": "#/definitions/ImageInput"
+            "$ref": "#/definitions/UrlInput"
           }
         },
         {
@@ -6000,7 +5865,6 @@
             "switch",
             "number",
             "range",
-            "url",
             "html",
             "markdown",
             "date",
@@ -6009,6 +5873,7 @@
             "file",
             "document",
             "image",
+            "url",
             "select",
             "multiselect",
             "choice",
@@ -10941,8 +10806,8 @@
         },
         "options": {
           "$ref": "#/definitions/UrlInputOptions",
-          "description": "Options that are specific to this `type` of input.",
-          "markdownDescription": "Options that are specific to this `type` of input."
+          "description": "Options that are specific to URL inputs.",
+          "markdownDescription": "Options that are specific to URL inputs."
         },
         "type": {
           "const": "url",
@@ -10959,6 +10824,47 @@
     "UrlInputOptions": {
       "additionalProperties": false,
       "properties": {
+        "accepts_mime_types": {
+          "anyOf": [
+            {
+              "items": {
+                "$ref": "#/definitions/MimeType"
+              },
+              "type": "array"
+            },
+            {
+              "type": "string"
+            }
+          ],
+          "description": "Restricts which file types are available to select or upload to this input. Accepted format is an array or comma-separated string of MIME types. The special value '*' means any type is accepted.",
+          "markdownDescription": "Restricts which file types are available to select or upload to this input. Accepted format is\nan array or comma-separated string of MIME types. The special value '*' means any type is\naccepted."
+        },
+        "allowed_sources": {
+          "description": "If you have one or more DAMs connected to your site, you can use this key to list which asset sources can be uploaded to and selected from.",
+          "items": {
+            "type": "string"
+          },
+          "markdownDescription": "If you have one or more DAMs connected to your site, you can use this key to list which asset\nsources can be uploaded to and selected from.",
+          "type": "array"
+        },
+        "disable_direct_input": {
+          "default": false,
+          "description": "Prevents typing into the text input, while still allowing context menu options to change the value.",
+          "markdownDescription": "Prevents typing into the text input, while still allowing context menu options to change the\nvalue.",
+          "type": "boolean"
+        },
+        "disable_upload_file": {
+          "default": false,
+          "description": "Disables the context menu option and the drop area for uploading files.",
+          "markdownDescription": "Disables the context menu option and the drop area for uploading files.",
+          "type": "boolean"
+        },
+        "disable_upload_file_in_file_browser": {
+          "default": false,
+          "description": "Prevents file uploads inside the \"Select existing file/image\" file browser modal window.",
+          "markdownDescription": "Prevents file uploads inside the \"Select existing file/image\" file browser modal window.",
+          "type": "boolean"
+        },
         "empty_type": {
           "description": "Set how an ‘empty’ value will be saved. Does not apply to existing empty values.",
           "enum": [
@@ -10968,6 +10874,17 @@
           "markdownDescription": "Set how an ‘empty’ value will be saved. Does not apply to existing empty values.",
           "type": "string"
         },
+        "expandable": {
+          "default": false,
+          "description": "Controls whether or not images can be upscaled to fit the bounding box during resize prior to upload. Has no effect if files are not resized.",
+          "markdownDescription": "Controls whether or not images can be upscaled to fit the bounding box during resize prior to\nupload. Has no effect if files are not resized.",
+          "type": "boolean"
+        },
+        "height": {
+          "description": "Defines the height of the bounding box used in the image resizing process defined with resize_style.",
+          "markdownDescription": "Defines the height of the bounding box used in the image resizing process defined with\nresize_style.",
+          "type": "number"
+        },
         "hide_link_to_email_address": {
           "default": false,
           "description": "Hides the option to link to an email address. This does not prevent typing a `mailto:` link in the input.",
@@ -10976,8 +10893,8 @@
         },
         "hide_link_to_file": {
           "default": false,
-          "description": "Hides the option to link to a file. This does not prevent typing a file path in the input.",
-          "markdownDescription": "Hides the option to link to a file. This does not prevent typing a file path in the input.",
+          "description": "Hides the options to link to an existing file, and upload a new file. This does not prevent typing a file path in the input.",
+          "markdownDescription": "Hides the options to link to an existing file, and upload a new file. This does not prevent\ntyping a file path in the input.",
           "type": "boolean"
         },
         "hide_link_to_page": {
@@ -10986,10 +10903,73 @@
           "markdownDescription": "Hides the option to link to a page. This does not prevent typing a file's output URL in the\ninput.",
           "type": "boolean"
         },
+        "image_size_attributes": {
+          "default": true,
+          "description": "Instructs the editor to save `width` and `height` attributes on the image elements. This can prevent pop-in as a page loads.",
+          "markdownDescription": "Instructs the editor to save `width` and `height` attributes on the image elements. This can\nprevent pop-in as a page loads.",
+          "type": "boolean"
+        },
+        "mime_type": {
+          "description": "Sets the format images are converted to prior to upload. The extension of the file is updated to match. Defaults to keeping the mime type of the uploaded file.",
+          "enum": [
+            "image/jpeg",
+            "image/png",
+            "image/webp"
+          ],
+          "markdownDescription": "Sets the format images are converted to prior to upload. The extension of the file is updated\nto match. Defaults to keeping the mime type of the uploaded file.",
+          "type": "string"
+        },
         "paths": {
           "$ref": "#/definitions/Paths",
           "description": "Paths to where new asset files are uploaded to. They also set the default path when choosing existing images, and linking to existing files. Each path is relative to global `source`. Defaults to the global `paths`.",
           "markdownDescription": "Paths to where new asset files are uploaded to. They also set the default path when choosing\nexisting images, and linking to existing files. Each path is relative to global `source`.\nDefaults to the global `paths`."
+        },
+        "prevent_resize_existing_files": {
+          "default": false,
+          "description": "Enable to skip the image resizing process configured for this input when selecting existing images.",
+          "markdownDescription": "Enable to skip the image resizing process configured for this input when selecting existing\nimages.",
+          "type": "boolean"
+        },
+        "resize_style": {
+          "default": "contain",
+          "description": "Sets how uploaded image files are resized with a bounding box defined by width and height prior to upload. Has no effect when selecting existing images, or if width and height are unset.",
+          "enum": [
+            "cover",
+            "contain",
+            "stretch",
+            "crop"
+          ],
+          "markdownDescription": "Sets how uploaded image files are resized with a bounding box defined by width and height prior\nto upload. Has no effect when selecting existing images, or if width and height are unset.",
+          "type": "string"
+        },
+        "sizes": {
+          "description": "Definitions for creating additional images of different sizes when uploading or selecting existing files.",
+          "items": {
+            "additionalProperties": false,
+            "properties": {
+              "size": {
+                "description": "A number suffixed with \"x\" (relative size) or \"w\" (fixed width) for setting the dimensions of the image (e.g. 2x, 3x, 100w, 360w).",
+                "markdownDescription": "A number suffixed with \"x\" (relative size) or \"w\" (fixed width) for setting the dimensions of\nthe image (e.g. 2x, 3x, 100w, 360w).",
+                "type": "string"
+              },
+              "target": {
+                "description": "A reference to another input that is given the path to this additional image file.",
+                "markdownDescription": "A reference to another input that is given the path to this additional image file.",
+                "type": "string"
+              }
+            },
+            "required": [
+              "size"
+            ],
+            "type": "object"
+          },
+          "markdownDescription": "Definitions for creating additional images of different sizes when uploading or selecting\nexisting files.",
+          "type": "array"
+        },
+        "width": {
+          "description": "Defines the width of the bounding box used in the image resizing process defined with resize_style.",
+          "markdownDescription": "Defines the width of the bounding box used in the image resizing process defined with\nresize_style.",
+          "type": "number"
         }
       },
       "type": "object"

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@cloudcannon/configuration-types",
-	"version": "0.0.28",
+	"version": "0.0.31",
 	"type": "module",
 	"description": "Contains TypeScript declarations and generates JSONSchema files for the CloudCannon configuration file.",
 	"author": "CloudCannon <support@cloudcannon.com>",