@cloudcannon/configuration-types 0.0.46 → 0.0.48

package/package.json

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

package/src/build-coupled.ts

@@ -97,7 +97,7 @@ export const ReaderCollectionConfigSchema = z.object({
 
 export const HugoCollectionConfigSchema = z.object({
 	...BuildCoupledCollectionConfigSchema.shape,
-	parse_branch_index: z.boolean().optional().meta({
+	parse_branch_index: z.boolean().default(false).optional().meta({
 		description:
 			'Controls whether branch index files (e.g. `_index.md`) are assigned to this collection or not. The "pages" collection defaults this to true, and false otherwise.',
 	}),
@@ -105,7 +105,7 @@ export const HugoCollectionConfigSchema = z.object({
 
 export const BuildCoupledConfigurationSchema = z.object({
 	...ConfigurationSchema.omit({ version: true }).shape,
-	collections_config_override: z.boolean().optional().meta({
+	collections_config_override: z.boolean().default(false).optional().meta({
 		id: 'collections_config_override',
 		description:
 			'Prevents CloudCannon from automatically discovering collections for supported SSGs if true. Defaults to false.',

package/src/collections.ts

@@ -211,15 +211,15 @@ export const CollectionConfigSchema = z
 					'This key defines the options available in the _+ Add_ button dropdown at the top right of your _Collection browser_.',
 			}),
 		create: CreateSchema.optional(),
-		disable_add: z.boolean().optional().meta({
+		disable_add: z.boolean().default(false).optional().meta({
 			description:
 				'This key toggles whether team members can use the _+ Add_ button in the top right of the _Collection browser_ to add files to a Collection.',
 		}),
-		disable_add_folder: z.boolean().optional().meta({
+		disable_add_folder: z.boolean().default(false).optional().meta({
 			description:
 				'This key toggles whether team members can use the _+ Add_ button in the top right of the _Collection browser_ to add subfolders to a Collection.',
 		}),
-		disable_file_actions: z.boolean().optional().meta({
+		disable_file_actions: z.boolean().default(false).optional().meta({
 			description:
 				'This key toggles whether team members can use the _+ Add_ button in the top right of the _Collection browser_ to add files to a Collection.',
 		}),

package/src/inputs.ts

@@ -5,7 +5,7 @@ import { IconSchema } from './icon.ts';
 import { ImageOptionsSchema } from './image-options.ts';
 import { MimeTypeSchema } from './mimetype.ts';
 import { PathsSchema } from './paths.ts';
-import { PreviewEntriesSchema, PreviewSchema } from './preview.ts';
+import { PickerPreviewSchema, PreviewEntriesSchema, PreviewSchema } from './preview.ts';
 import { SelectDataValuesSchema } from './select-values.ts';
 import { SourceEditorSchema } from './source-editor.ts';
 import { StructureReferenceSchema, StructureSchema } from './structures.ts';
@@ -102,23 +102,23 @@ const TextValidationSchema = z.object({
 	}),
 	pattern_flags: z
 		.object({
-			global: z.boolean().optional().meta({
+			global: z.boolean().default(false).optional().meta({
 				description: '`g` - Search globally.',
 			}),
-			ignore_case: z.boolean().optional().meta({
+			ignore_case: z.boolean().default(false).optional().meta({
 				description: '`i` - Case-insensitive.',
 			}),
-			multiline: z.boolean().optional().meta({
+			multiline: z.boolean().default(false).optional().meta({
 				description:
 					'`m` - `^` and `$` match the start and end of each line rather than the entire string.',
 			}),
-			dot_all: z.boolean().optional().meta({
+			dot_all: z.boolean().default(false).optional().meta({
 				description: '`s` - `.` matches newline characters.',
 			}),
-			unicode: z.boolean().optional().meta({
+			unicode: z.boolean().default(false).optional().meta({
 				description: '`u` - Pattern is treated as a sequence of Unicode code points.',
 			}),
-			unicode_sets: z.boolean().optional().meta({
+			unicode_sets: z.boolean().default(false).optional().meta({
 				description: '`v` - Extended `unicode` mode.',
 			}),
 		})
@@ -384,6 +384,8 @@ export const ColorInputOptionsSchema = z
 			description:
 				'Toggles showing a control for adjusting the transparency of the selected color. Defaults to using the naming convention, enabled if the input key ends with "a".',
 		}),
+		palette: z.array(z.string()).optional(),
+		hide_picker: z.boolean().default(false).optional(),
 	})
 	.meta({
 		description: 'Options that are specific to Color Inputs.',
@@ -687,7 +689,7 @@ export const UrlInputSchema = z
 export const SharedSelectInputOptionsSchema = z.object({
 	...RequiredValidationSchema.shape,
 	preview: PreviewSchema.optional(),
-	picker_preview: PreviewSchema.optional(),
+	picker_preview: PickerPreviewSchema.optional(),
 	allow_create: z.boolean().default(false).optional().meta({
 		id: 'type._inputs.*.options.allow_create',
 		description: 'Allows new text values to be created at edit time.',

package/src/markdown.ts

@@ -26,19 +26,19 @@ export const MarkdownSettingsSchema = z
 		}),
 		options: z
 			.object({
-				html: z.boolean().optional().meta({
+				html: z.boolean().default(false).optional().meta({
 					description: 'Output HTML tags from source.',
 				}),
-				xhtml: z.boolean().optional().meta({
+				xhtml: z.boolean().default(false).optional().meta({
 					description: 'Use `/` to close single tags (e.g. `<br />`).',
 				}),
-				breaks: z.boolean().optional().meta({
+				breaks: z.boolean().default(false).optional().meta({
 					description: 'Convert `\\n` in paragraphs into `<br>`.',
 				}),
-				linkify: z.boolean().optional().meta({
+				linkify: z.boolean().default(false).optional().meta({
 					description: 'Autoconvert URL-like text to links.',
 				}),
-				typographer: z.boolean().optional().meta({
+				typographer: z.boolean().default(false).optional().meta({
 					description:
 						'Enable some language-neutral replacement, as well as quotes beautification.',
 				}),
@@ -46,10 +46,10 @@ export const MarkdownSettingsSchema = z
 					description:
 						'Double + single quotes replacement pairs, when typographer enabled and smartquotes on. For example, you can use "«»„"" for Russian, ""„"‚"" for German, and ["«\\xA0", "\\xA0»", "‹\\xA0", "\\xA0›"] for French (including `nbsp`).',
 				}),
-				spaced_lists: z.boolean().optional().meta({
+				spaced_lists: z.boolean().default(false).optional().meta({
 					description: 'Output lists with an extra space in Markdown.',
 				}),
-				sentence_per_line: z.boolean().optional().meta({
+				sentence_per_line: z.boolean().default(false).optional().meta({
 					description: 'Add linebreaks between sentences in Markdown.',
 				}),
 				gfm: z.boolean().optional().meta({
@@ -58,28 +58,28 @@ export const MarkdownSettingsSchema = z
 				code_block_fences: z.enum(['```', '~~~']).optional().meta({
 					description: 'Determines which style of code block fences to use.',
 				}),
-				treat_indentation_as_code: z.boolean().optional().meta({
+				treat_indentation_as_code: z.boolean().default(false).optional().meta({
 					description: 'Determines whether 4 spaces on indentation should be read as a code block.',
 				}),
-				escape_snippets_in_code_blocks: z.boolean().optional().meta({
+				escape_snippets_in_code_blocks: z.boolean().default(false).optional().meta({
 					description: 'Render snippets as plain text within code blocks.',
 				}),
-				table: z.boolean().optional().meta({
+				table: z.boolean().default(false).optional().meta({
 					description: 'Output tables in Markdown format.',
 				}),
-				strikethrough: z.boolean().optional().meta({
+				strikethrough: z.boolean().default(false).optional().meta({
 					description: 'Output strikes in wrapped in double tildes (e.g. `~~strike~~`).',
 				}),
-				subscript: z.boolean().optional().meta({
+				subscript: z.boolean().default(false).optional().meta({
 					description: 'Output subscript in wrapped in tildes (e.g. `~sub~`).',
 				}),
-				superscript: z.boolean().optional().meta({
+				superscript: z.boolean().default(false).optional().meta({
 					description: 'Output superscript in wrapped in carets (e.g. `^super^`).',
 				}),
-				heading_ids: z.boolean().optional().meta({
+				heading_ids: z.boolean().default(false).optional().meta({
 					description: 'Generate IDs for headings.',
 				}),
-				attributes: z.boolean().optional().meta({
+				attributes: z.boolean().default(false).optional().meta({
 					description: 'Save element attributes in Markdown format instead of converting to HTML.',
 				}),
 				attribute_elements: MarkdownAttributeElementOptionsSchema.optional().meta({

package/src/paths.ts

@@ -10,6 +10,7 @@ export const PathsSchema = z
 		dam_static: z.string().optional().meta({ id: 'paths.dam_static' }),
 		uploads_use_relative_path: z
 			.boolean()
+			.default(false)
 			.optional()
 			.meta({ id: 'paths.uploads_use_relative_path' }),
 	})

package/src/preview.ts

@@ -51,28 +51,29 @@ export const PreviewEntriesSchema = z
 	])
 	.meta({ id: 'PreviewEntries' });
 
-const TextPreviewEntriesSchema = PreviewEntriesSchema.optional().meta({ id: 'type.preview.text' });
-const SubtextPreviewEntriesSchema = PreviewEntriesSchema.optional().meta({
+const PreviewTextSchema = PreviewEntriesSchema.optional().meta({ id: 'type.preview.text' });
+const PreviewSubtextSchema = PreviewEntriesSchema.optional().meta({
 	id: 'type.preview.subtext',
 });
-const ImagePreviewEntriesSchema = PreviewEntriesSchema.optional().meta({
+const PreviewImageSchema = PreviewEntriesSchema.optional().meta({
 	id: 'type.preview.image',
 });
-const IconPreviewEntriesSchema = PreviewEntriesSchema.optional().meta({ id: 'type.preview.icon' });
-const IconColorPreviewEntriesSchema = PreviewEntriesSchema.optional().meta({
+const PreviewIconSchema = PreviewEntriesSchema.optional().meta({ id: 'type.preview.icon' });
+const PreviewIconColorSchema = PreviewEntriesSchema.optional().meta({
 	id: 'type.preview.icon_color',
 });
-const IconBackgroundColorPreviewEntriesSchema = PreviewEntriesSchema.optional().meta({
+const PreviewIconBackgroundColorSchema = PreviewEntriesSchema.optional().meta({
 	id: 'type.preview.icon_background_color',
 });
+const TagsPreviewEntriesSchema = z.array(z.string()).optional().meta({ id: 'type.preview.tags' });
 
 export const PreviewGallerySchema = z
 	.object({
-		text: TextPreviewEntriesSchema,
-		image: ImagePreviewEntriesSchema,
-		icon: IconPreviewEntriesSchema,
-		icon_color: IconColorPreviewEntriesSchema,
-		icon_background_color: IconBackgroundColorPreviewEntriesSchema,
+		text: PreviewTextSchema,
+		image: PreviewImageSchema,
+		icon: PreviewIconSchema,
+		icon_color: PreviewIconColorSchema,
+		icon_background_color: PreviewIconBackgroundColorSchema,
 		fit: z
 			.enum(['padded', 'cover', 'contain', 'cover-top'])
 			.default('padded')
@@ -82,33 +83,44 @@ export const PreviewGallerySchema = z
 			id: 'type.preview.gallery.background_color',
 		}),
 	})
-	.meta({ id: 'preview.gallery' });
+	.optional()
+	.meta({ id: 'type.preview.gallery' });
 
-const PreviewMetadataEntrySchema = z
+const MetadataPreviewEntrySchema = z
 	.object({
-		text: TextPreviewEntriesSchema,
-		image: ImagePreviewEntriesSchema,
-		icon: IconPreviewEntriesSchema,
-		icon_color: IconColorPreviewEntriesSchema,
-		icon_background_color: IconBackgroundColorPreviewEntriesSchema,
+		text: PreviewTextSchema,
+		image: PreviewImageSchema,
+		icon: PreviewIconSchema,
+		icon_color: PreviewIconColorSchema,
+		icon_background_color: PreviewIconBackgroundColorSchema,
 	})
 	.meta({ id: 'PreviewMetadataEntry' });
 
+const PreviewMetadataSchema = z
+	.array(MetadataPreviewEntrySchema)
+	.optional()
+	.meta({ id: 'type.preview.metadata' });
+
 export const PreviewSchema = z
 	.object({
-		text: TextPreviewEntriesSchema,
-		subtext: SubtextPreviewEntriesSchema,
-		image: ImagePreviewEntriesSchema,
-		icon: IconPreviewEntriesSchema,
-		icon_color: IconColorPreviewEntriesSchema,
-		icon_background_color: IconBackgroundColorPreviewEntriesSchema,
-		tags: z.array(z.string()).optional().meta({ id: 'preview.tags' }),
-		metadata: z.array(PreviewMetadataEntrySchema).optional().meta({ id: 'preview.metadata' }),
-		gallery: PreviewGallerySchema.optional(),
+		text: PreviewTextSchema,
+		subtext: PreviewSubtextSchema,
+		image: PreviewImageSchema,
+		icon: PreviewIconSchema,
+		icon_color: PreviewIconColorSchema,
+		icon_background_color: PreviewIconBackgroundColorSchema,
+		tags: TagsPreviewEntriesSchema,
+		metadata: PreviewMetadataSchema,
+		gallery: PreviewGallerySchema,
 	})
 	.meta({ id: 'type.preview', title: 'Preview' });
 
+export const PickerPreviewSchema = PreviewSchema.meta({
+	id: 'type.picker_preview',
+	title: 'Picker Preview',
+});
+
 export type PreviewEntry = z.infer<typeof PreviewEntrySchema>;
 export type PreviewEntries = z.infer<typeof PreviewEntriesSchema>;
-export type PreviewGallery = z.infer<typeof PreviewGallerySchema>;
+export type PreviewGallery = NonNullable<z.infer<typeof PreviewGallerySchema>>;
 export type Preview = z.infer<typeof PreviewSchema>;

package/src/snippets.ts

@@ -1,6 +1,6 @@
 import * as z from 'zod';
 import { ReducedCascadeSchema } from './cascade.ts';
-import { PreviewSchema } from './preview.ts';
+import { PickerPreviewSchema, PreviewSchema } from './preview.ts';
 
 export const ParserModelSchema = z
 	.object({
@@ -188,7 +188,7 @@ export const SnippetConfigSchema = z
 	.object({
 		...ReducedCascadeSchema.shape,
 		preview: PreviewSchema.optional(),
-		picker_preview: PreviewSchema.optional(),
+		picker_preview: PickerPreviewSchema.optional(),
 	})
 	.extend({
 		snippet: z.string().optional().meta({

package/src/structures.ts

@@ -2,7 +2,7 @@ import * as z from 'zod';
 import { DocumentationSchema } from './documentation.ts';
 import { IconSchema } from './icon.ts';
 import { InputsFromGlobSchema, InputsSchema, ObjectInputGroupSchema } from './inputs.ts';
-import { PreviewSchema } from './preview.ts';
+import { PickerPreviewSchema, PreviewSchema } from './preview.ts';
 import { SelectDataSchema } from './select-values.ts';
 
 export const StructureReferenceSchema = z.string().meta({
@@ -35,7 +35,7 @@ export const StructuresFromGlobSchema = z.array(z.string()).meta({
 
 export const StructureValueSchema = StructureBaseSchema.extend({
 	preview: PreviewSchema.optional(),
-	picker_preview: PreviewSchema.optional(),
+	picker_preview: PickerPreviewSchema.optional(),
 
 	// This is the ReducedCascadeSchema - can't seem to reuse it due to Zod's limitations.
 	get _inputs() {
@@ -87,7 +87,7 @@ export const StructureValueSchema = StructureBaseSchema.extend({
 	value: z.unknown().meta({
 		description: 'The actual value used when items are added after selection.',
 	}),
-	comment: z.string().optional().meta({
+	description: z.string().optional().meta({
 		description:
 			'Provides short descriptive text for editors shown in the Data Editor for expanded values matching this Structure value. Has no default. Supports a limited set of Markdown: links, bold, italic, subscript, superscript, and inline code elements are allowed.',
 	}),