@cloudcannon/configuration-types 0.0.38 → 0.0.40

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

@@ -138,37 +138,8 @@
             ],
             "markdownDescription": "This key defines the documentation link at the top of a _Collection browser_. Collection documentation is useful for assisting your team members."
           },
-          "sort": {
-            "description": "This key defines how CloudCannon sorts your Collection files when you first open your _Collection browser_.",
-            "title": "Sort",
-            "type": "object",
-            "properties": {
-              "key": {
-                "description": "Defines what field contains the value to sort on inside each collection item's data.",
-                "type": "string",
-                "markdownDescription": "Defines what field contains the value to sort on inside each collection item's data."
-              },
-              "order": {
-                "description": "Controls which sort values come first.",
-                "default": "ascending",
-                "type": "string",
-                "enum": [
-                  "ascending",
-                  "descending",
-                  "asc",
-                  "desc"
-                ],
-                "markdownDescription": "Controls which sort values come first."
-              }
-            },
-            "required": [
-              "key"
-            ],
-            "additionalProperties": false,
-            "markdownDescription": "This key defines how CloudCannon sorts your Collection files when you first open your _Collection browser_."
-          },
           "sort_options": {
-            "description": "This key defines the options for the Sort dropdown in a _Collection browser_.",
+            "description": "This key defines the options for the Sort dropdown in a _Collection browser_. The first option listed is used as the default sort.",
             "type": "array",
             "items": {
               "title": "SortOption",
@@ -204,7 +175,21 @@
               "additionalProperties": false,
               "markdownDescription": "A sort option for a Collection."
             },
-            "markdownDescription": "This key defines the options for the Sort dropdown in a _Collection browser_."
+            "markdownDescription": "This key defines the options for the Sort dropdown in a _Collection browser_. The first option listed is used as the default sort."
+          },
+          "view_options": {
+            "uniqueItems": true,
+            "description": "This key defines the options for the View dropdown in a _Collection browser_. The first option listed is used as the default view.",
+            "type": "array",
+            "items": {
+              "type": "string",
+              "enum": [
+                "card",
+                "list",
+                "gallery"
+              ]
+            },
+            "markdownDescription": "This key defines the options for the View dropdown in a _Collection browser_. The first option listed is used as the default view."
           },
           "singular_name": {
             "description": "This key defines the singular noun for your Collection name. CloudCannon uses the singular noun in the _+ Add_ button in the top right of the _Collection browser_.",
@@ -4956,60 +4941,79 @@
       "description": "Controls the color of the icon.",
       "allOf": [
         {
-          "$ref": "#/definitions/PreviewEntry"
+          "$ref": "#/definitions/PreviewEntries"
         }
       ],
       "markdownDescription": "Controls the color of the icon."
     },
-    "PreviewEntry": {
-      "id": "PreviewEntry",
+    "PreviewEntries": {
+      "id": "PreviewEntries",
       "anyOf": [
         {
           "type": "array",
           "items": {
-            "anyOf": [
-              {
-                "type": "object",
-                "properties": {
-                  "key": {
-                    "description": "The key used to access the value used for the preview.",
-                    "type": "string",
-                    "markdownDescription": "The key used to access the value used for the preview."
-                  }
-                },
-                "required": [
-                  "key"
-                ],
-                "additionalProperties": false
-              },
-              {
-                "type": "object",
-                "properties": {
-                  "template": {
-                    "description": "A template string containing various placeholders for the value used in the preview.",
-                    "type": "string",
-                    "markdownDescription": "A template string containing various placeholders for the value used in the preview."
-                  }
-                },
-                "required": [
-                  "template"
-                ],
-                "additionalProperties": false
-              },
-              {
-                "type": "string"
-              },
-              {
-                "type": "boolean"
-              }
-            ]
+            "$ref": "#/definitions/PreviewEntry"
           }
         },
         {
           "type": "string"
         },
         {
-          "type": "boolean"
+          "type": "boolean",
+          "const": false
+        }
+      ]
+    },
+    "PreviewEntry": {
+      "anyOf": [
+        {
+          "type": "object",
+          "properties": {
+            "key": {
+              "description": "The key used to access the value used for the preview.",
+              "type": "string",
+              "markdownDescription": "The key used to access the value used for the preview."
+            }
+          },
+          "required": [
+            "key"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "template": {
+              "description": "A template string containing various placeholders for the value used in the preview.",
+              "type": "string",
+              "markdownDescription": "A template string containing various placeholders for the value used in the preview."
+            }
+          },
+          "required": [
+            "template"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "text": {
+              "description": "The raw text used as the value for the preview.",
+              "type": "string",
+              "markdownDescription": "The raw text used as the value for the preview."
+            }
+          },
+          "required": [
+            "text"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "string"
+        },
+        {
+          "type": "boolean",
+          "const": false
         }
       ]
     },
@@ -5017,7 +5021,7 @@
       "description": "Controls the background color of the icon.",
       "allOf": [
         {
-          "$ref": "#/definitions/PreviewEntry"
+          "$ref": "#/definitions/PreviewEntries"
         }
       ],
       "markdownDescription": "Controls the background color of the icon."
@@ -8230,7 +8234,7 @@
           "description": "Controls the supporting text shown per item.",
           "allOf": [
             {
-              "$ref": "#/definitions/PreviewEntry"
+              "$ref": "#/definitions/PreviewEntries"
             }
           ],
           "markdownDescription": "Controls the supporting text shown per item."
@@ -8263,6 +8267,14 @@
             }
           ]
         },
+        "tags": {
+          "description": "Defines a list of tags.",
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "markdownDescription": "Defines a list of tags."
+        },
         "metadata": {
           "description": "Defines a list of items that can contain an image, icon, and text.",
           "type": "array",
@@ -8288,7 +8300,7 @@
       "description": "Controls the main text shown per item.",
       "allOf": [
         {
-          "$ref": "#/definitions/PreviewEntry"
+          "$ref": "#/definitions/PreviewEntries"
         }
       ],
       "markdownDescription": "Controls the main text shown per item."
@@ -8297,7 +8309,7 @@
       "description": "Controls the image shown per item.",
       "allOf": [
         {
-          "$ref": "#/definitions/PreviewEntry"
+          "$ref": "#/definitions/PreviewEntries"
         }
       ],
       "markdownDescription": "Controls the image shown per item."
@@ -8306,7 +8318,7 @@
       "description": "Controls the icon shown per item. Must result in a Material Symbol name.",
       "allOf": [
         {
-          "$ref": "#/definitions/PreviewEntry"
+          "$ref": "#/definitions/PreviewEntries"
         }
       ],
       "markdownDescription": "Controls the icon shown per item. Must result in a Material Symbol name."
@@ -8411,7 +8423,7 @@
           "description": "Controls the background color gallery area.",
           "allOf": [
             {
-              "$ref": "#/definitions/PreviewEntry"
+              "$ref": "#/definitions/PreviewEntries"
             }
           ],
           "markdownDescription": "Controls the background color gallery area."
@@ -8436,7 +8448,7 @@
           "description": "Controls the supporting text shown per item.",
           "allOf": [
             {
-              "$ref": "#/definitions/PreviewEntry"
+              "$ref": "#/definitions/PreviewEntries"
             }
           ],
           "markdownDescription": "Controls the supporting text shown per item."
@@ -8469,6 +8481,14 @@
             }
           ]
         },
+        "tags": {
+          "description": "Defines a list of tags.",
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "markdownDescription": "Defines a list of tags."
+        },
         "metadata": {
           "description": "Defines a list of items that can contain an image, icon, and text.",
           "type": "array",

package/package.json

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

package/src/configuration.ts

@@ -202,13 +202,18 @@ export const CollectionConfigSchema = z
 			description:
 				'This key defines the documentation link at the top of a _Collection browser_. Collection documentation is useful for assisting your team members.',
 		}),
-		sort: SortSchema.optional().meta({
-			description:
-				'This key defines how CloudCannon sorts your Collection files when you first open your _Collection browser_.',
-		}),
 		sort_options: z.array(SortOptionSchema).optional().meta({
-			description: 'This key defines the options for the Sort dropdown in a _Collection browser_.',
+			description:
+				'This key defines the options for the Sort dropdown in a _Collection browser_. The first option listed is used as the default sort.',
 		}),
+		view_options: z
+			.array(z.enum(['card', 'list', 'gallery']))
+			.optional()
+			.meta({
+				uniqueItems: true,
+				description:
+					'This key defines the options for the View dropdown in a _Collection browser_. The first option listed is used as the default view.',
+			}),
 		singular_name: z.string().optional().meta({
 			description:
 				'This key defines the singular noun for your Collection name. CloudCannon uses the singular noun in the _+ Add_ button in the top right of the _Collection browser_.',

package/src/preview.ts

@@ -13,37 +13,51 @@ const PreviewTemplateEntrySchema = z.object({
 	}),
 });
 
+const PreviewTextEntrySchema = z.object({
+	text: z.string().meta({
+		description: 'The raw text used as the value for the preview.',
+	}),
+});
+
 const PreviewEntrySchema = z
 	.union([
-		z.array(z.union([PreviewKeyEntrySchema, PreviewTemplateEntrySchema, z.string(), z.boolean()])),
+		PreviewKeyEntrySchema,
+		PreviewTemplateEntrySchema,
+		PreviewTextEntrySchema,
 		z.string(),
-		z.boolean(),
+		z.literal(false),
 	])
 	.meta({
 		id: 'PreviewEntry',
 	});
 
-const TextPreviewSchema = PreviewEntrySchema.meta({
+const PreviewEntriesSchema = z
+	.union([z.array(PreviewEntrySchema), z.string(), z.literal(false)])
+	.meta({
+		id: 'PreviewEntries',
+	});
+
+const TextPreviewSchema = PreviewEntriesSchema.meta({
 	id: 'preview.text',
 	description: 'Controls the main text shown per item.',
 });
 
-const ImagePreviewSchema = PreviewEntrySchema.meta({
+const ImagePreviewSchema = PreviewEntriesSchema.meta({
 	id: 'preview.image',
 	description: 'Controls the image shown per item.',
 });
 
-const IconPreviewSchema = PreviewEntrySchema.meta({
+const IconPreviewSchema = PreviewEntriesSchema.meta({
 	id: 'preview.icon',
 	description: 'Controls the icon shown per item. Must result in a Material Symbol name.',
 });
 
-export const IconColorSchema = PreviewEntrySchema.meta({
+export const IconColorSchema = PreviewEntriesSchema.meta({
 	id: 'preview.icon_color',
 	description: 'Controls the color of the icon.',
 });
 
-export const IconBackgroundColorSchema = PreviewEntrySchema.meta({
+export const IconBackgroundColorSchema = PreviewEntriesSchema.meta({
 	id: 'preview.icon_background_color',
 	description: 'Controls the background color of the icon.',
 });
@@ -58,7 +72,7 @@ export const PreviewGallerySchema = z
 		fit: z.enum(['padded', 'cover', 'contain', 'cover-top']).default('padded').optional().meta({
 			description: 'Controls how the gallery image is positioned within the gallery.',
 		}),
-		background_color: PreviewEntrySchema.optional().meta({
+		background_color: PreviewEntriesSchema.optional().meta({
 			description: 'Controls the background color gallery area.',
 		}),
 	})
@@ -86,13 +100,16 @@ export const PreviewMetadataSchema = z
 export const PreviewSchema = z
 	.object({
 		text: TextPreviewSchema.optional(),
-		subtext: PreviewEntrySchema.optional().meta({
+		subtext: PreviewEntriesSchema.optional().meta({
 			description: 'Controls the supporting text shown per item.',
 		}),
 		image: ImagePreviewSchema.optional(),
 		icon: IconPreviewSchema.optional(),
 		icon_color: IconColorSchema.optional(),
 		icon_background_color: IconBackgroundColorSchema.optional(),
+		tags: z.array(z.string()).optional().meta({
+			description: 'Defines a list of tags.',
+		}),
 		metadata: z.array(PreviewMetadataSchema).optional().meta({
 			description: 'Defines a list of items that can contain an image, icon, and text.',
 		}),
@@ -120,6 +137,8 @@ export const PickerPreviewSchema = z
 		description: 'Changes the way items are previewed in the CMS while being chosen.',
 	});
 
+export type PreviewEntry = z.infer<typeof PreviewEntrySchema>;
+export type PreviewEntries = z.infer<typeof PreviewEntriesSchema>;
 export type PreviewGallery = z.infer<typeof PreviewGallerySchema>;
 export type PreviewMetadata = z.infer<typeof PreviewMetadataSchema>;
 export type Preview = z.infer<typeof PreviewSchema>;