@cloudcannon/configuration-types 0.0.44 → 0.0.46

package/package.json

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

package/src/cascade.ts

@@ -1,8 +1,8 @@
 import * as z from 'zod';
-import { EditablesSchema } from './editables.ts';
-import { InputsSchema } from './inputs.ts';
+import { EditablesFromGlobSchema, EditablesSchema } from './editables.ts';
+import { InputsFromGlobSchema, InputsSchema } from './inputs.ts';
 import { SelectDataSchema } from './select-values.ts';
-import { StructuresSchema } from './structures.ts';
+import { StructuresFromGlobSchema, StructuresSchema } from './structures.ts';
 
 export const EditorKeySchema = z.enum(['visual', 'content', 'data']).meta({
 	id: 'EditorKey',
@@ -12,10 +12,10 @@ export const EditorKeySchema = z.enum(['visual', 'content', 'data']).meta({
 
 export const ReducedCascadeSchema = z.object({
 	_inputs: InputsSchema.optional(),
-	_inputs_from_glob: z.array(z.string()).optional(),
+	_inputs_from_glob: InputsFromGlobSchema.optional(),
 	_select_data: SelectDataSchema.optional(),
 	_structures: StructuresSchema.optional(),
-	_structures_from_glob: z.array(z.string()).optional(),
+	_structures_from_glob: StructuresFromGlobSchema.optional(),
 });
 
 export const CascadeSchema = z.object({
@@ -33,7 +33,7 @@ export const CascadeSchema = z.object({
 		description:
 			'Configuration for editable regions in the Visual Editor, including content, block, link, image, and text editing options.',
 	}),
-	_editables_from_glob: z.array(z.string()).optional(),
+	_editables_from_glob: EditablesFromGlobSchema.optional(),
 });
 
 export type EditorKey = z.infer<typeof EditorKeySchema>;

package/src/collections.ts

@@ -94,7 +94,7 @@ export const CreateSchema = z
 		...ReducedCascadeSchema.shape,
 	})
 	.meta({
-		id: 'create',
+		id: 'type.create',
 		title: 'Create',
 		description: 'Controls where new files are saved.',
 	});
@@ -110,7 +110,7 @@ export const SchemaSchema = z
 		}),
 		icon: IconSchema.default('notes').optional().meta({
 			description:
-				'Displayed in the add menu when creating new files; also used as the icon for collection files if no other preview is found. Defaults to notes.',
+				'Displayed in the add menu when creating new files; also used as the icon for collection files if no other preview is found.',
 		}),
 		create: CreateSchema.optional(),
 		new_preview_url: z.string().optional().meta({
@@ -119,7 +119,7 @@ export const SchemaSchema = z
 		}),
 		reorder_inputs: z.boolean().default(true).optional().meta({
 			description:
-				'If true, inputs are sorted to match when editing. Extra inputs are ordered after expected inputs, unless `remove_extra_inputs` is true. Defaults to true.',
+				'If true, inputs are sorted to match when editing. Extra inputs are ordered after expected inputs, unless `remove_extra_inputs` is true.',
 		}),
 		hide_extra_inputs: z.boolean().default(false).optional().meta({
 			description:
@@ -127,10 +127,10 @@ export const SchemaSchema = z
 		}),
 		remove_empty_inputs: z.boolean().default(false).optional().meta({
 			description:
-				'If checked, empty inputs are removed from the source file on save. Removed inputs will be available for editing again, provided they are in the matching schema/structure. Defaults to false.',
+				'If checked, empty inputs are removed from the source file on save. Removed inputs will be available for editing again, provided they are in the matching schema/structure.',
 		}),
 		remove_extra_inputs: z.boolean().default(true).optional().meta({
-			description: 'If checked, extra inputs are removed when editing. Defaults to true.',
+			description: 'If checked, extra inputs are removed when editing.',
 		}),
 		preview: PreviewSchema.optional(),
 		...CascadeSchema.shape,
@@ -231,7 +231,7 @@ export const CollectionConfigSchema = z
 			description:
 				'This key defines which Schemas are available to populate files in this Collection.',
 		}),
-		schemas_config_from_glob: z.array(z.string()).optional(),
+		schemas_from_glob: z.array(z.string()).optional(),
 		schema_key: z.string().optional().meta({
 			description:
 				'This key defines the name for the structured data key that references the Schema a file uses.',

package/src/documentation.ts

@@ -14,7 +14,7 @@ export const DocumentationSchema = z
 		}),
 	})
 	.meta({
-		id: 'documentation',
+		id: 'type.documentation',
 		title: 'Documentation',
 		description: 'Configuration for documentation links displayed in the CloudCannon interface.',
 	});

package/src/editables.ts

@@ -6,72 +6,72 @@ export const TextEditableSchema = z.object({
 	paths: PathsSchema.optional(),
 
 	bold: z.boolean().default(true).optional().meta({
-		id: 'bold',
+		id: 'type._editables.*.bold',
 		description: 'Enables a control to set selected text to bold.',
 	}),
 
 	copyformatting: z.boolean().default(false).optional().meta({
-		id: 'copyformatting',
+		id: 'type._editables.*.copyformatting',
 		description:
 			'Enables a control to copy formatting from text to other text. Only applies to formatting from `bold`, `italic`, `underline`, `strike`, `subscript`, and `superscript`. Does not copy other styles or formatting.',
 	}),
 
 	italic: z.boolean().default(true).optional().meta({
-		id: 'italic',
+		id: 'type._editables.*.italic',
 		description: 'Enables a control to italicize selected text.',
 	}),
 
 	link: z.boolean().default(true).optional().meta({
-		id: 'link',
+		id: 'type._editables.*.link',
 		description: 'Enables a control to create hyperlinks around selected text.',
 	}),
 
 	redo: z.boolean().default(false).optional().meta({
-		id: 'redo',
+		id: 'type._editables.*.redo',
 		description:
 			'Enables a control to redo recent edits undone with undo. Redo is always enabled through standard OS-specific keyboard shortcuts.',
 	}),
 
 	removeformat: z.boolean().default(true).optional().meta({
-		id: 'removeformat',
+		id: 'type._editables.*.removeformat',
 		description:
 			'Enables the control to remove formatting from text. Applies to formatting from `bold`, `italic`, `underline`, `strike`, `subscript`, and `superscript`. Does not remove other styles or formatting.',
 	}),
 
 	strike: z.boolean().default(false).optional().meta({
-		id: 'strike',
+		id: 'type._editables.*.strike',
 		description: 'Enables a control to strike selected text.',
 	}),
 
 	subscript: z.boolean().default(false).optional().meta({
-		id: 'subscript',
+		id: 'type._editables.*.subscript',
 		description: 'Enables a control to set selected text to subscript.',
 	}),
 
 	superscript: z.boolean().default(false).optional().meta({
-		id: 'superscript',
+		id: 'type._editables.*.superscript',
 		description: 'Enables a control to set selected text to superscript.',
 	}),
 
 	underline: z.boolean().default(false).optional().meta({
-		id: 'underline',
+		id: 'type._editables.*.underline',
 		description: 'Enables a control to underline selected text.',
 	}),
 
 	undo: z.boolean().default(false).optional().meta({
-		id: 'undo',
+		id: 'type._editables.*.undo',
 		description:
 			'Enables a control to undo recent edits. Undo is always enabled through standard OS-specific keyboard shortcuts.',
 	}),
 
 	remove_custom_markup: z.boolean().optional().meta({
-		id: 'remove_custom_markup',
+		id: 'type._editables.*.remove_custom_markup',
 		description:
 			'Defines if the content should be stripped of "custom markup". It is recommended to have this option turned on once you have all of your rich text options configured. Having `allow_custom_markup` turned on disables this option. Defaults to false.',
 	}),
 
 	allow_custom_markup: z.boolean().optional().meta({
-		id: 'allow_custom_markup',
+		id: 'type._editables.*.allow_custom_markup',
 		description:
 			'Defines if the content can contain "custom markup". It is not recommended to have this option turned on. Defaults to true for non-content editable regions, false otherwise.',
 	}),
@@ -81,119 +81,119 @@ export const ToolbarOptionsSchema = z.object({
 	...TextEditableSchema.shape,
 
 	blockquote: z.boolean().default(true).optional().meta({
-		id: 'blockquote',
+		id: 'type._editables.*.blockquote',
 		description: 'Enables a control to wrap blocks of text in block quotes.',
 	}),
 
 	bulletedlist: z.boolean().default(true).optional().meta({
-		id: 'bulletedlist',
+		id: 'type._editables.*.bulletedlist',
 		description:
 			'Enables a control to insert an unordered list, or to convert selected blocks of text into a unordered list.',
 	}),
 
 	center: z.string().optional().meta({
-		id: 'center',
+		id: 'type._editables.*.center',
 		description:
 			'Enables a control to center align text by toggling a class name for a block of text. The value is the class name the editor should add to align the text. The styles for this class need to be listed in the `styles` file to take effect outside of the input.',
 	}),
 
 	code_inline: z.boolean().default(false).optional().meta({
-		id: 'code_inline',
+		id: 'type._editables.*.code_inline',
 		description:
 			'Enables a control to create an inline code element, containing any selected text.',
 	}),
 
 	code_block: z.boolean().default(false).optional().meta({
-		id: 'code_block',
+		id: 'type._editables.*.code_block',
 		description: 'Enables a control to insert a code block.',
 	}),
 
 	code: z.boolean().default(false).optional().meta({
-		id: 'code',
+		id: 'type._editables.*.code',
 		description: 'Enables both block and inline code controls: `code_block` and `code_inline`.',
 	}),
 
 	embed: z.boolean().default(false).optional().meta({
-		id: 'embed',
+		id: 'type._editables.*.embed',
 		description:
 			'Enables a control to insert a region of raw HTML, including YouTube, Vimeo, Tweets, and other media. Embedded content is sanitized to mitigate XSS risks, which includes removing style tags. Embeds containing script tags are not loaded in the editor.',
 	}),
 
 	format: z.string().default('p h1 h2 h3 h4 h5 h6').optional().meta({
-		id: 'format',
+		id: 'type._editables.*.format',
 		description:
 			'Enables a drop down menu for structured text. Has options for "p", "h1", "h2", "h3", "h4", "h5", "h6". Set as space separated options (e.g. "p h1 h2").',
 	}),
 
 	horizontalrule: z.boolean().default(false).optional().meta({
-		id: 'horizontalrule',
+		id: 'type._editables.*.horizontalrule',
 		description: 'Enables a control to insert a horizontal rule.',
 	}),
 
 	image: z.boolean().default(true).optional().meta({
-		id: 'image',
+		id: 'type._editables.*.image',
 		description:
 			'Enables a control to insert an image. The image can be uploaded, existing or an external link.',
 	}),
 
 	indent: z.boolean().default(false).optional().meta({
-		id: 'indent',
+		id: 'type._editables.*.indent',
 		description: 'Enables a control to increase indentation for numbered and unordered lists.',
 	}),
 
 	justify: z.string().optional().meta({
-		id: 'justify',
+		id: 'type._editables.*.justify',
 		description:
 			'Enables a control to justify text by toggling a class name for a block of text. The value is the class name the editor should add to justify the text. The styles for this class need to be listed in the `styles` file to take effect outside of the input.',
 	}),
 
 	left: z.string().optional().meta({
-		id: 'left',
+		id: 'type._editables.*.left',
 		description:
 			'Enables a control to left align text by toggling a class name for a block of text. The value is the class name the editor should add to align the text. The styles for this class need to be listed in the `styles` file to take effect outside of the input.',
 	}),
 
 	numberedlist: z.boolean().default(true).optional().meta({
-		id: 'numberedlist',
+		id: 'type._editables.*.numberedlist',
 		description:
 			'Enables a control to insert a numbered list, or to convert selected blocks of text into a numbered list.',
 	}),
 
 	outdent: z.boolean().default(false).optional().meta({
-		id: 'outdent',
+		id: 'type._editables.*.outdent',
 		description: 'Enables a control to reduce indentation for numbered and unordered lists.',
 	}),
 
 	right: z.string().optional().meta({
-		id: 'right',
+		id: 'type._editables.*.right',
 		description:
 			'Enables a control to right align text by toggling a class name for a block of text. The value is the class name the editor should add to align the text. The styles for this class need to be listed in the `styles` file to take effect outside of the input.',
 	}),
 
 	snippet: z.boolean().default(true).optional().meta({
-		id: 'snippet',
+		id: 'type._editables.*.snippet',
 		description: 'Enables a control to insert snippets, if any are available.',
 	}),
 
 	styles: z.string().optional().meta({
-		id: 'styles',
+		id: 'type._editables.*.styles',
 		description:
 			'Enables a drop down menu for editors to style selected text or blocks or text. Styles are the combination of an element and class name. The value for this option is the path (either source or build output) to the CSS file containing the styles.',
 	}),
 
 	table: z.boolean().default(false).optional().meta({
-		id: 'table',
+		id: 'type._editables.*.table',
 		description:
 			'Enables a control to insert a table. Further options for table cells are available in the context menu for cells within the editor.',
 	}),
 
 	join_above: z.boolean().default(false).optional().meta({
-		id: 'join_above',
+		id: 'type._editables.*.join_above',
 		description: 'Enables a control to join the selected block with the block above it.',
 	}),
 
 	join_below: z.boolean().default(false).optional().meta({
-		id: 'join_below',
+		id: 'type._editables.*.join_below',
 		description: 'Enables a control to join the selected block with the block below it.',
 	}),
 });
@@ -245,6 +245,10 @@ export const EditablesSchema = z.object({
 	}),
 });
 
+export const EditablesFromGlobSchema = z.array(z.string()).meta({
+	id: 'type._editables_from_glob',
+});
+
 export type ToolbarOptions = z.infer<typeof ToolbarOptionsSchema>;
 export type TextEditable = z.infer<typeof TextEditableSchema>;
 export type BlockEditable = z.infer<typeof BlockEditableSchema>;

package/src/image-options.ts

@@ -2,49 +2,49 @@ import * as z from 'zod';
 
 export const ImageOptionsSchema = z.object({
 	mime_type: z.enum(['image/jpeg', 'image/png', 'image/webp']).optional().meta({
-		id: 'mime_type',
+		id: 'type._inputs.*.options.mime_type',
 		title: '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.',
 	}),
 	resize_style: z.enum(['cover', 'contain', 'stretch', 'crop']).default('contain').optional().meta({
-		id: 'resize_style',
+		id: 'type._inputs.*.options.resize_style',
 		title: 'Resize Style',
 		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.',
 	}),
 	width: z.number().optional().meta({
-		id: 'width',
+		id: 'type._inputs.*.options.width',
 		title: 'Width',
 		description:
 			'Defines the width of the bounding box used in the image resizing process defined with resize_style.',
 	}),
 	height: z.number().optional().meta({
-		id: 'height',
+		id: 'type._inputs.*.options.height',
 		title: 'Height',
 		description:
 			'Defines the height of the bounding box used in the image resizing process defined with resize_style.',
 	}),
 	expandable: z.boolean().default(false).optional().meta({
-		id: 'expandable',
+		id: 'type._inputs.*.options.expandable',
 		title: 'Expandable',
 		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.',
 	}),
 	image_size_attributes: z.boolean().default(true).optional().meta({
-		id: 'image_size_attributes',
+		id: 'type._inputs.*.options.image_size_attributes',
 		title: 'Image Size Attributes',
 		description:
 			'Instructs the editor to save `width` and `height` attributes on the image elements. This can prevent pop-in as a page loads.',
 	}),
 	allowed_sources: z.array(z.string()).optional().meta({
-		id: 'allowed_sources',
+		id: 'type._inputs.*.options.allowed_sources',
 		title: '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.',
 	}),
 	prevent_resize_existing_files: z.boolean().default(false).optional().meta({
-		id: 'prevent_resize_existing_files',
+		id: 'type._inputs.*.options.prevent_resize_existing_files',
 		title: 'Prevent Resize Existing Files',
 		description:
 			'Enable to skip the image resizing process configured for this input when selecting existing images.',
@@ -64,7 +64,7 @@ export const ImageOptionsSchema = z.object({
 		)
 		.optional()
 		.meta({
-			id: 'sizes',
+			id: 'type._inputs.*.options.sizes',
 			title: 'Sizes',
 			description:
 				'Definitions for creating additional images of different sizes when uploading or selecting existing files.',