@cloudcannon/configuration-types 0.0.21 → 0.0.23

package/dist/cloudcannon-config.schema.json

@@ -533,6 +533,86 @@
       },
       "type": "object"
     },
+    "BooleanInput": {
+      "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"
+        },
+        "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"
+        },
+        "type": {
+          "description": "Sets an input type, which controls how this input appears and behaves.",
+          "enum": [
+            "checkbox",
+            "switch"
+          ],
+          "markdownDescription": "Sets an input type, which controls how this input appears and behaves.",
+          "type": "string"
+        }
+      },
+      "required": [
+        "type"
+      ],
+      "type": "object"
+    },
     "ChoiceInput": {
       "additionalProperties": false,
       "properties": {
@@ -4065,6 +4145,9 @@
         {
           "$ref": "#/definitions/ColorInput"
         },
+        {
+          "$ref": "#/definitions/BooleanInput"
+        },
         {
           "$ref": "#/definitions/NumberInput"
         },
@@ -4080,6 +4163,9 @@
         {
           "$ref": "#/definitions/DateInput"
         },
+        {
+          "$ref": "#/definitions/TimeInput"
+        },
         {
           "$ref": "#/definitions/FileInput"
         },
@@ -7677,6 +7763,88 @@
       ],
       "type": "string"
     },
+    "TimeInput": {
+      "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"
+        },
+        "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/WithEmptyTypeText",
+          "description": "Options that are specific to Time inputs.",
+          "markdownDescription": "Options that are specific to Time inputs."
+        },
+        "type": {
+          "const": "time",
+          "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"
+    },
     "Timezone": {
       "enum": [
         "Africa/Abidjan",
@@ -8343,7 +8511,20 @@
           "type": "string"
         },
         "options": {
-          "$ref": "#/definitions/WithEmptyTypeText",
+          "anyOf": [
+            {
+              "$ref": "#/definitions/WithEmptyTypeText"
+            },
+            {
+              "$ref": "#/definitions/WithEmptyTypeNumber"
+            },
+            {
+              "$ref": "#/definitions/WithEmptyTypeObject"
+            },
+            {
+              "$ref": "#/definitions/WithEmptyTypeArray"
+            }
+          ],
           "description": "Options that are specific to this `type` of input.",
           "markdownDescription": "Options that are specific to this `type` of input."
         },
@@ -8427,7 +8608,7 @@
           "markdownDescription": "Options that are specific to this `type` of input."
         },
         "type": {
-          "const": "range",
+          "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"

package/package.json

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

package/src/configuration.d.ts

@@ -796,6 +796,10 @@ export interface ColorInput extends BaseInput {
 	options?: ColorInputOptions;
 }
 
+export interface BooleanInput extends Omit<BaseInput, 'options'> {
+	type: 'checkbox' | 'switch';
+}
+
 export interface NumberInputOptions extends WithEmptyTypeNumber {
 	/**
 	 * The lowest value in the range of permitted values.
@@ -853,7 +857,7 @@ export interface RangeInput extends BaseInput {
 export interface UrlInputOptions extends WithEmptyTypeText, WithPaths {}
 
 export interface UrlInput extends BaseInput {
-	type: 'range';
+	type: 'url';
 	/**
 	 * Options that are specific to this `type` of input.
 	 */
@@ -901,6 +905,14 @@ export interface DateInput extends BaseInput {
 	options?: DateInputOptions;
 }
 
+export interface TimeInput extends BaseInput {
+	type: 'time';
+	/**
+	 * Options that are specific to Time inputs.
+	 */
+	options?: WithEmptyTypeText;
+}
+
 export interface FileInputOptions extends WithEmptyTypeText, WithPaths {
 	/**
 	 * Restricts which file types are available to select or upload to this input. Accepted format is
@@ -1111,10 +1123,6 @@ export interface ArrayInput extends BaseInput {
 
 export interface UnknownInput extends BaseInput {
 	type?: 'auto' | undefined;
-	/**
-	 * Options that are specific to this `type` of input.
-	 */
-	options?: WithEmptyTypeText;
 }
 
 export type Input =
@@ -1123,11 +1131,13 @@ export type Input =
 	| TextInput
 	| CodeInput
 	| ColorInput
+	| BooleanInput
 	| NumberInput
 	| RangeInput
 	| UrlInput
 	| RichTextInput
 	| DateInput
+	| TimeInput
 	| FileInput
 	| ImageInput
 	| SelectInput