@cloudcannon/configuration-types 0.0.15 → 0.0.16

package/build/cloudcannon-config.json

@@ -137,11 +137,6 @@
           "description": "Set how an ‘empty’ value will be saved. Does not apply to existing empty values.",
           "markdownDescription": "Set how an ‘empty’ value will be saved. Does not apply to existing empty values."
         },
-        "preview": {
-          "$ref": "#/definitions/ObjectPreview",
-          "description": "The preview definition for changing the way data within an array input's items are previewed before being expanded. If the input has structures, the preview from the structure value is used instead.",
-          "markdownDescription": "The preview definition for changing the way data within an array input's items are previewed\nbefore being expanded. If the input has structures, the preview from the structure value is\nused instead."
-        },
         "structures": {
           "anyOf": [
             {
@@ -611,10 +606,26 @@
           "description": "Set how an ‘empty’ value will be saved. Does not apply to existing empty values.",
           "markdownDescription": "Set how an ‘empty’ value will be saved. Does not apply to existing empty values."
         },
+        "picker_preview": {
+          "$ref": "#/definitions/Preview",
+          "description": "Changes the way items are previewed in the CMS while being chosen.",
+          "markdownDescription": "Changes the way items are previewed in the CMS while being chosen."
+        },
+        "picker_view": {
+          "description": "Controls how selectable options are rendered.",
+          "enum": [
+            "card",
+            "text",
+            "gallery",
+            "gallery-left"
+          ],
+          "markdownDescription": "Controls how selectable options are rendered.",
+          "type": "string"
+        },
         "preview": {
-          "$ref": "#/definitions/SelectPreview",
-          "description": "The preview definition for changing the way selected and available options are displayed.",
-          "markdownDescription": "The preview definition for changing the way selected and available options are displayed."
+          "$ref": "#/definitions/Preview",
+          "description": "Changes the way items are previewed in the CMS.",
+          "markdownDescription": "Changes the way items are previewed in the CMS."
         },
         "value_key": {
           "description": "Defines the key used for mapping between saved values and objects in values. This changes how the input saves selected values to match. Defaults to checking for \"id\", \"uuid\", \"path\", \"title\", then \"name\". Has no effect unless values is an array of objects, the key is used instead for objects, and the value itself is used for primitive types.",
@@ -625,6 +636,17 @@
           "$ref": "#/definitions/SelectValues",
           "description": "Defines the values available to choose from. Optional, defaults to fetching values from the naming convention (e.g. colors or my_colors for data set colors).",
           "markdownDescription": "Defines the values available to choose from. Optional, defaults to fetching values from the\nnaming convention (e.g. colors or my_colors for data set colors)."
+        },
+        "view": {
+          "description": "Controls how selected items are rendered.",
+          "enum": [
+            "card",
+            "text",
+            "gallery",
+            "gallery-left"
+          ],
+          "markdownDescription": "Controls how selected items are rendered.",
+          "type": "string"
         }
       },
       "type": "object"
@@ -5300,10 +5322,26 @@
           "description": "Set how an ‘empty’ value will be saved. Does not apply to existing empty values.",
           "markdownDescription": "Set how an ‘empty’ value will be saved. Does not apply to existing empty values."
         },
+        "picker_preview": {
+          "$ref": "#/definitions/Preview",
+          "description": "Changes the way items are previewed in the CMS while being chosen.",
+          "markdownDescription": "Changes the way items are previewed in the CMS while being chosen."
+        },
+        "picker_view": {
+          "description": "Controls how selectable options are rendered.",
+          "enum": [
+            "card",
+            "text",
+            "gallery",
+            "gallery-left"
+          ],
+          "markdownDescription": "Controls how selectable options are rendered.",
+          "type": "string"
+        },
         "preview": {
-          "$ref": "#/definitions/SelectPreview",
-          "description": "The preview definition for changing the way selected and available options are displayed.",
-          "markdownDescription": "The preview definition for changing the way selected and available options are displayed."
+          "$ref": "#/definitions/Preview",
+          "description": "Changes the way items are previewed in the CMS.",
+          "markdownDescription": "Changes the way items are previewed in the CMS."
         },
         "value_key": {
           "description": "Defines the key used for mapping between saved values and objects in values. This changes how the input saves selected values to match. Defaults to checking for \"id\", \"uuid\", \"path\", \"title\", then \"name\". Has no effect unless values is an array of objects, the key is used instead for objects, and the value itself is used for primitive types.",
@@ -5314,6 +5352,17 @@
           "$ref": "#/definitions/SelectValues",
           "description": "Defines the values available to choose from. Optional, defaults to fetching values from the naming convention (e.g. colors or my_colors for data set colors).",
           "markdownDescription": "Defines the values available to choose from. Optional, defaults to fetching values from the\nnaming convention (e.g. colors or my_colors for data set colors)."
+        },
+        "view": {
+          "description": "Controls how selected items are rendered.",
+          "enum": [
+            "card",
+            "text",
+            "gallery",
+            "gallery-left"
+          ],
+          "markdownDescription": "Controls how selected items are rendered.",
+          "type": "string"
         }
       },
       "type": "object"
@@ -5419,6 +5468,27 @@
           "description": "Set how an ‘empty’ value will be saved. Does not apply to existing empty values.",
           "markdownDescription": "Set how an ‘empty’ value will be saved. Does not apply to existing empty values."
         },
+        "picker_preview": {
+          "$ref": "#/definitions/Preview",
+          "description": "Changes the way items are previewed in the CMS while being chosen.",
+          "markdownDescription": "Changes the way items are previewed in the CMS while being chosen."
+        },
+        "picker_view": {
+          "description": "Controls how selectable options are rendered.",
+          "enum": [
+            "card",
+            "text",
+            "gallery",
+            "gallery-left"
+          ],
+          "markdownDescription": "Controls how selectable options are rendered.",
+          "type": "string"
+        },
+        "preview": {
+          "$ref": "#/definitions/Preview",
+          "description": "Changes the way items are previewed in the CMS.",
+          "markdownDescription": "Changes the way items are previewed in the CMS."
+        },
         "value_key": {
           "description": "Defines the key used for mapping between saved values and objects in values. This changes how the input saves selected values to match. Defaults to checking for \"id\", \"uuid\", \"path\", \"title\", then \"name\". Has no effect unless values is an array of objects, the key is used instead for objects, and the value itself is used for primitive types.",
           "markdownDescription": "Defines the key used for mapping between saved values and objects in values. This changes how\nthe input saves selected values to match. Defaults to checking for \"id\", \"uuid\", \"path\",\n\"title\", then \"name\". Has no effect unless values is an array of objects, the key is used\ninstead for objects, and the value itself is used for primitive types.",
@@ -5428,6 +5498,17 @@
           "$ref": "#/definitions/SelectValues",
           "description": "Defines the values available to choose from. Optional, defaults to fetching values from the naming convention (e.g. colors or my_colors for data set colors).",
           "markdownDescription": "Defines the values available to choose from. Optional, defaults to fetching values from the\nnaming convention (e.g. colors or my_colors for data set colors)."
+        },
+        "view": {
+          "description": "Controls how selected items are rendered.",
+          "enum": [
+            "card",
+            "text",
+            "gallery",
+            "gallery-left"
+          ],
+          "markdownDescription": "Controls how selected items are rendered.",
+          "type": "string"
         }
       },
       "type": "object"
@@ -5710,9 +5791,9 @@
           "type": "boolean"
         },
         "preview": {
-          "$ref": "#/definitions/ObjectPreview",
-          "description": "The preview definition for changing the way data within an object input is previewed before being expanded. If the input has `structures`, the preview from the structure value is used instead.",
-          "markdownDescription": "The preview definition for changing the way data within an object input is previewed before\nbeing expanded. If the input has `structures`, the preview from the structure value is used\ninstead."
+          "$ref": "#/definitions/Preview",
+          "description": "Changes the way items are previewed in the CMS.",
+          "markdownDescription": "Changes the way items are previewed in the CMS."
         },
         "structures": {
           "anyOf": [
@@ -5739,32 +5820,6 @@
       },
       "type": "object"
     },
-    "ObjectPreview": {
-      "additionalProperties": false,
-      "properties": {
-        "icon": {
-          "$ref": "#/definitions/PreviewEntry",
-          "description": "Controls the icon shown per item. Must result in a Material Icon name.",
-          "markdownDescription": "Controls the icon shown per item. Must result in a Material Icon name."
-        },
-        "image": {
-          "$ref": "#/definitions/PreviewEntry",
-          "description": "Controls the image shown per item.",
-          "markdownDescription": "Controls the image shown per item."
-        },
-        "subtext": {
-          "$ref": "#/definitions/PreviewEntry",
-          "description": "Controls the supporting text shown per item.",
-          "markdownDescription": "Controls the supporting text shown per item."
-        },
-        "text": {
-          "$ref": "#/definitions/PreviewEntry",
-          "description": "Controls the main text shown per item.",
-          "markdownDescription": "Controls the main text shown per item."
-        }
-      },
-      "type": "object"
-    },
     "Paths": {
       "additionalProperties": false,
       "properties": {
@@ -6648,6 +6703,27 @@
           "description": "Set how an ‘empty’ value will be saved. Does not apply to existing empty values.",
           "markdownDescription": "Set how an ‘empty’ value will be saved. Does not apply to existing empty values."
         },
+        "picker_preview": {
+          "$ref": "#/definitions/Preview",
+          "description": "Changes the way items are previewed in the CMS while being chosen.",
+          "markdownDescription": "Changes the way items are previewed in the CMS while being chosen."
+        },
+        "picker_view": {
+          "description": "Controls how selectable options are rendered.",
+          "enum": [
+            "card",
+            "text",
+            "gallery",
+            "gallery-left"
+          ],
+          "markdownDescription": "Controls how selectable options are rendered.",
+          "type": "string"
+        },
+        "preview": {
+          "$ref": "#/definitions/Preview",
+          "description": "Changes the way items are previewed in the CMS.",
+          "markdownDescription": "Changes the way items are previewed in the CMS."
+        },
         "value_key": {
           "description": "Defines the key used for mapping between saved values and objects in values. This changes how the input saves selected values to match. Defaults to checking for \"id\", \"uuid\", \"path\", \"title\", then \"name\". Has no effect unless values is an array of objects, the key is used instead for objects, and the value itself is used for primitive types.",
           "markdownDescription": "Defines the key used for mapping between saved values and objects in values. This changes how\nthe input saves selected values to match. Defaults to checking for \"id\", \"uuid\", \"path\",\n\"title\", then \"name\". Has no effect unless values is an array of objects, the key is used\ninstead for objects, and the value itself is used for primitive types.",
@@ -6657,22 +6733,17 @@
           "$ref": "#/definitions/SelectValues",
           "description": "Defines the values available to choose from. Optional, defaults to fetching values from the naming convention (e.g. colors or my_colors for data set colors).",
           "markdownDescription": "Defines the values available to choose from. Optional, defaults to fetching values from the\nnaming convention (e.g. colors or my_colors for data set colors)."
-        }
-      },
-      "type": "object"
-    },
-    "SelectPreview": {
-      "additionalProperties": false,
-      "properties": {
-        "icon": {
-          "$ref": "#/definitions/PreviewEntry",
-          "description": "Controls the icon shown per item. Must result in a Material Icon name.",
-          "markdownDescription": "Controls the icon shown per item. Must result in a Material Icon name."
         },
-        "text": {
-          "$ref": "#/definitions/PreviewEntry",
-          "description": "Controls the main text shown per item.",
-          "markdownDescription": "Controls the main text shown per item."
+        "view": {
+          "description": "Controls how selected items are rendered.",
+          "enum": [
+            "card",
+            "text",
+            "gallery",
+            "gallery-left"
+          ],
+          "markdownDescription": "Controls how selected items are rendered.",
+          "type": "string"
         }
       },
       "type": "object"
@@ -7371,6 +7442,14 @@
           "markdownDescription": "If set to true, this item will be considered the default type for this structure. If the type\nof a value within a structure cannot be inferred based on its id_key or matching fields, then\nit will fall back to this item. If multiple items have default set to true, only the first item\nwill be used.",
           "type": "boolean"
         },
+        "groups": {
+          "description": "Allows you to group the inputs inside this object together without changing the data structure.",
+          "items": {
+            "$ref": "#/definitions/ObjectInputGroup"
+          },
+          "markdownDescription": "Allows you to group the inputs inside this object together without changing the data structure.",
+          "type": "array"
+        },
         "hide_extra_inputs": {
           "default": false,
           "description": "Hides unexpected inputs when editing. Has no effect if `remove_extra_inputs` is true.",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloudcannon/configuration-types",
-  "version": "0.0.15",
+  "version": "0.0.16",
   "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

@@ -787,7 +787,10 @@ export interface ImageInput extends BaseInput<ImageInputOptions> {
 	type: 'image';
 }
 
-export interface SelectInputOptions<EmptyType = EmptyTypeText> extends BaseInputOptions<EmptyType> {
+export interface SelectInputOptions<EmptyType = EmptyTypeText>
+	extends BaseInputOptions<EmptyType>,
+		Previewable,
+		PickerPreviewable {
 	/**
 	 * Allows new text values to be created at edit time.
 	 *
@@ -812,6 +815,14 @@ export interface SelectInputOptions<EmptyType = EmptyTypeText> extends BaseInput
 	 * instead for objects, and the value itself is used for primitive types.
 	 */
 	value_key?: string;
+	/**
+	 * Controls how selected items are rendered.
+	 */
+	view?: 'card' | 'text' | 'gallery' | 'gallery-left';
+	/**
+	 * Controls how selectable options are rendered.
+	 */
+	picker_view?: 'card' | 'text' | 'gallery' | 'gallery-left';
 }
 
 export interface SelectInput extends BaseInput<SelectInputOptions> {
@@ -825,12 +836,7 @@ export interface MultiselectInput extends BaseInput<MultiselectInputOptions> {
 }
 
 export interface ChoiceInputOptions<EmptyType = EmptyTypeText>
-	extends Omit<SelectInputOptions<EmptyType>, 'allow_create'> {
-	/**
-	 * The preview definition for changing the way selected and available options are displayed.
-	 */
-	preview?: SelectPreview;
-}
+	extends Omit<SelectInputOptions<EmptyType>, 'allow_create'> {}
 
 export interface ChoiceInput extends BaseInput<ChoiceInputOptions> {
 	type: 'choice';
@@ -850,7 +856,7 @@ export interface ObjectInputGroup {
 	documentation?: Documentation;
 }
 
-export interface ObjectInputOptions extends BaseInputOptions<EmptyTypeObject> {
+export interface ObjectInputOptions extends BaseInputOptions<EmptyTypeObject>, Previewable {
 	/**
 	 * Changes the appearance and behavior of the input.
 	 */
@@ -877,12 +883,6 @@ export interface ObjectInputOptions extends BaseInputOptions<EmptyTypeObject> {
 		 */
 		structures?: string | Structure;
 	};
-	/**
-	 * The preview definition for changing the way data within an object input is previewed before
-	 * being expanded. If the input has `structures`, the preview from the structure value is used
-	 * instead.
-	 */
-	preview?: ObjectPreview;
 	/**
 	 * Provides data formats for value of this object. When choosing an item, team members are
 	 * prompted to choose from a number of values you have defined. `structures` applies to the object
@@ -911,12 +911,6 @@ export interface ObjectInput extends BaseInput<ObjectInputOptions> {
 }
 
 export interface ArrayInputOptions extends BaseInputOptions<EmptyTypeArray> {
-	/**
-	 * The preview definition for changing the way data within an array input's items are previewed
-	 * before being expanded. If the input has structures, the preview from the structure value is
-	 * used instead.
-	 */
-	preview?: ObjectPreview;
 	/**
 	 * Provides data formats for value of this object. When choosing an item, team members are
 	 * prompted to choose from a number of values you have defined.
@@ -1055,6 +1049,7 @@ export interface PreviewGallery
 	extends TextPreviewable,
 		ImagePreviewable,
 		IconPreviewable,
+		IconColorPreviewable,
 		IconColorPreviewable {
 	/**
 	 * Controls how the gallery image is positioned within the gallery.
@@ -1068,14 +1063,6 @@ export interface PreviewMetadata
 		IconPreviewable,
 		IconColorPreviewable {}
 
-export interface ObjectPreview
-	extends TextPreviewable,
-		ImagePreviewable,
-		IconPreviewable,
-		SubtextPreviewable {}
-
-export interface SelectPreview extends TextPreviewable, IconPreviewable {}
-
 export interface Preview
 	extends TextPreviewable,
 		ImagePreviewable,
@@ -1412,6 +1399,10 @@ export interface StructureValue extends Previewable, PickerPreviewable, Schemali
 	 * Used to group and filter items when selecting from a modal.
 	 */
 	tags?: string[];
+	/**
+	 * Allows you to group the inputs inside this object together without changing the data structure.
+	 */
+	groups?: ObjectInputGroup[];
 	/**
 	 * The actual value used when items are added after selection.
 	 */