@cloudcannon/configuration-types 0.0.41 → 0.0.43

package/src/inputs.ts

@@ -5,15 +5,10 @@ import { IconSchema } from './icon';
 import { ImageOptionsSchema } from './image-options';
 import { MimeTypeSchema } from './mimetype';
 import { PathsSchema } from './paths';
-import {
-	IconBackgroundColorSchema,
-	IconColorSchema,
-	PickerPreviewSchema,
-	PreviewSchema,
-} from './preview';
+import { PreviewEntriesSchema, PreviewSchema } from './preview';
 import { SelectDataValuesSchema } from './select-values';
 import { SourceEditorSchema } from './source-editor';
-import { StructureSchema } from './structures';
+import { StructureReferenceSchema, StructureSchema } from './structures';
 import { SyntaxSchema } from './syntax';
 import { TimezoneSchema } from './timezone';
 
@@ -169,16 +164,16 @@ const ArrayValidationSchema = z.object({
 });
 
 const ArrayControlOptionsSchema = z.object({
-	disable_add: z.boolean().default(false).meta({
+	disable_add: z.boolean().default(false).optional().meta({
 		id: 'ArrayInput.disable_add',
 		description:
 			'Hides the add button, and context menu actions on each item for adding new items to this Input.',
 	}),
-	disable_remove: z.boolean().default(false).meta({
+	disable_remove: z.boolean().default(false).optional().meta({
 		id: 'disable_remove',
 		description: 'Hides the context menu actions on each item for removing them.',
 	}),
-	disable_reorder: z.boolean().default(false).meta({
+	disable_reorder: z.boolean().default(false).optional().meta({
 		id: 'disable_reorder',
 		description: 'Hides the controls on each item for moving them.',
 	}),
@@ -238,14 +233,22 @@ export const BaseInputSchema = z.object({
 		id: 'label',
 		description: 'Optionally changes the text above this input.',
 	}),
-	hidden: z.boolean().default(false).optional().meta({
-		id: 'hidden',
-		description: 'Toggles the visibility of this input.',
-	}),
-	disabled: z.boolean().default(false).optional().meta({
-		id: 'disabled',
-		description: 'Toggles if this input can be edited.',
-	}),
+	hidden: z
+		.union([z.boolean().meta({ title: 'Boolean' }), z.string().meta({ title: 'Query String' })])
+		.default(false)
+		.optional()
+		.meta({
+			id: 'hidden',
+			description: 'Toggles the visibility of this input.',
+		}),
+	disabled: z
+		.union([z.boolean().meta({ title: 'Boolean' }), z.string().meta({ title: 'Query String' })])
+		.default(false)
+		.optional()
+		.meta({
+			id: 'disabled',
+			description: 'Toggles if this input can be edited.',
+		}),
 	instance_value: z.enum(['UUID', 'NOW']).optional().meta({
 		id: 'instance_value',
 		title: 'Instance Value',
@@ -257,7 +260,7 @@ export const BaseInputSchema = z.object({
 		description:
 			'Prevents the default where inputs configured with an `instance_value` are rehydrated with a new value when duplicated in the CMS.',
 	}),
-	cascade: z.boolean().default(false).optional().meta({
+	cascade: z.boolean().default(true).optional().meta({
 		id: 'cascade',
 		description:
 			'Specifies whether or not this input configuration should be merged with any matching, less specific configuration.',
@@ -275,8 +278,8 @@ export const TextInputOptionsSchema = z
 		icon: IconSchema.optional().meta({
 			description: 'Icon shown beside the input.',
 		}),
-		icon_color: IconColorSchema.optional(),
-		icon_background_color: IconBackgroundColorSchema.optional(),
+		icon_color: PreviewEntriesSchema.optional(),
+		icon_background_color: PreviewEntriesSchema.optional(),
 	})
 	.meta({
 		description: 'Options that are specific to Text Inputs.',
@@ -301,6 +304,8 @@ export const TextInputSchema = z
 	})
 	.meta({
 		id: 'TextInput',
+		title: 'Text Input',
+		description: 'Provides a simple editing interface for plain text.',
 	});
 
 export const TextareaInputOptionsSchema = z
@@ -327,6 +332,8 @@ export const TextareaInputSchema = z
 	})
 	.meta({
 		id: 'TextareaInput',
+		title: 'Textarea Input',
+		description: 'Provides an editing interface for plain text.',
 	});
 
 export const CodeInputOptionsSchema = z
@@ -360,6 +367,8 @@ export const CodeInputSchema = z
 	})
 	.meta({
 		id: 'CodeInput',
+		title: 'Code Input',
+		description: 'Provides an editing interface for code or mono-spaced plain text content.',
 	});
 
 export const ColorInputOptionsSchema = z
@@ -388,15 +397,19 @@ export const ColorInputSchema = z
 	})
 	.meta({
 		id: 'ColorInput',
+		title: 'Color Input',
+		description: 'Provides an editing interface for color values.',
 	});
 
 export const BooleanInputSchema = z
 	.object({
 		...BaseInputSchema.shape,
-		type: z.literal('checkbox').meta(typeMeta),
+		type: z.enum(['checkbox', 'switch']).meta(typeMeta),
 	})
 	.meta({
 		id: 'BooleanInput',
+		title: 'Boolean Input',
+		description: 'Provides an editing interface for true or false values.',
 	});
 
 const MinSchema = z.number().meta({
@@ -445,6 +458,8 @@ export const NumberInputSchema = z
 	})
 	.meta({
 		id: 'NumberInput',
+		title: 'Number Input',
+		description: 'Provides an editing interface for numeric values.',
 	});
 
 export const RangeInputOptionsSchema = z
@@ -465,6 +480,8 @@ export const RangeInputSchema = z
 	})
 	.meta({
 		id: 'RangeInput',
+		title: 'Range Input',
+		description: 'Provides a slider interface for selecting a numeric value.',
 	});
 
 export const RichTextInputOptionsSchema = z
@@ -493,20 +510,22 @@ export const RichTextInputSchema = z
 	})
 	.meta({
 		id: 'RichTextInput',
+		title: 'Rich Text Input',
+		description: 'Provides an editing interface for HTML markup content.',
 	});
 
 export const DateInputOptionsSchema = z
 	.object({
 		...RequiredValidationSchema.shape,
 		empty_type: EmptyTypeTextSchema.optional(),
-		timezone: TimezoneSchema.optional().default('Etc/UTC').meta({
+		timezone: TimezoneSchema.optional().meta({
 			description:
 				'Specifies the time zone that dates are displayed and edited in. Also changes the suffix the date is persisted to the file with. Defaults to the global `timezone`.',
 		}),
 		start_from: z
 			.union([
-				z.iso.datetime({ offset: true, local: true }),
-				z.coerce.string().meta({ isJsonSchemaAny: true }),
+				z.iso.datetime({ offset: true, local: true }).meta({ title: 'ISO8601 String' }),
+				z.coerce.string().meta({ isJsonSchemaAny: true, documentationType: 'date', title: 'Date' }),
 			])
 			.optional()
 			.meta({
@@ -519,8 +538,8 @@ export const DateInputOptionsSchema = z
 		}),
 		end_before: z
 			.union([
-				z.iso.datetime({ offset: true, local: true }),
-				z.coerce.string().meta({ isJsonSchemaAny: true }),
+				z.iso.datetime({ offset: true, local: true }).meta({ title: 'ISO8601 String' }),
+				z.coerce.string().meta({ isJsonSchemaAny: true, documentationType: 'date', title: 'Date' }),
 			])
 			.optional()
 			.meta({
@@ -544,6 +563,8 @@ export const DateInputSchema = z
 	})
 	.meta({
 		id: 'DateInput',
+		title: 'Date Input',
+		description: 'Provides an editing interface for date and/or time values.',
 	});
 
 export const TimeInputOptionsSchema = z
@@ -563,6 +584,8 @@ export const TimeInputSchema = z
 	})
 	.meta({
 		id: 'TimeInput',
+		title: 'Time Input',
+		description: 'Provides an editing interface for time values only.',
 	});
 
 export const FileInputOptionsSchema = z
@@ -573,7 +596,10 @@ export const FileInputOptionsSchema = z
 		empty_type: EmptyTypeTextSchema.optional(),
 		paths: PathsSchema.optional(),
 		accepts_mime_types: z
-			.union([z.string(), z.array(MimeTypeSchema)])
+			.union([
+				z.string().meta({ title: 'Comma Separated' }),
+				z.array(MimeTypeSchema).meta({ title: 'Array' }),
+			])
 			.optional()
 			.meta({
 				id: 'accepts_mime_types',
@@ -617,6 +643,9 @@ export const FileInputSchema = z
 	})
 	.meta({
 		id: 'FileInput',
+		title: 'File Input',
+		description:
+			'Provides an editing interface for uploading files to your repository or DAM and browsing existing assets.',
 	});
 
 export const UrlInputOptionsSchema = z
@@ -651,12 +680,14 @@ export const UrlInputSchema = z
 	})
 	.meta({
 		id: 'UrlInput',
+		title: 'URL Input',
+		description: 'Provides an editing interface for relative, absolute, and fully qualified URLs.',
 	});
 
 export const SharedSelectInputOptionsSchema = z.object({
 	...RequiredValidationSchema.shape,
 	preview: PreviewSchema.optional(),
-	picker_preview: PickerPreviewSchema.optional(),
+	picker_preview: PreviewSchema.optional(),
 	allow_create: z.boolean().default(false).optional().meta({
 		id: 'allow_create',
 		description: 'Allows new text values to be created at edit time.',
@@ -665,11 +696,17 @@ export const SharedSelectInputOptionsSchema = z.object({
 		id: 'allow_empty',
 		description: 'Provides an empty option alongside the options provided by values.',
 	}),
-	values: z.union([z.string(), SelectDataValuesSchema]).optional().meta({
-		id: 'values',
-		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).',
-	}),
+	values: z
+		.union([
+			z.string().meta({ title: 'Dataset Reference', description: 'Reference to a dataset.' }),
+			SelectDataValuesSchema,
+		])
+		.optional()
+		.meta({
+			id: 'values',
+			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).',
+		}),
 	value_key: z.string().optional().meta({
 		id: 'value_key',
 		description:
@@ -703,6 +740,9 @@ export const SelectInputSchema = z
 	})
 	.meta({
 		id: 'SelectInput',
+		title: 'Select Input',
+		description:
+			'Provides an editing interface for data with multiple predefined options. Select inputs only allow one value.',
 	});
 
 export const MultiselectInputOptionsSchema = z
@@ -723,6 +763,9 @@ export const MultiselectInputSchema = z
 	})
 	.meta({
 		id: 'MultiselectInput',
+		title: 'Multiselect Input',
+		description:
+			'Provides an editing interface for data with multiple predefined options. Multiselect inputs allow several values.',
 	});
 
 export const SharedChoiceInputOptionsSchema = SharedSelectInputOptionsSchema.omit({
@@ -747,6 +790,9 @@ export const ChoiceInputSchema = z
 	})
 	.meta({
 		id: 'ChoiceInput',
+		title: 'Choice Input',
+		description:
+			'Provides an editing interface for data with multiple predefined options. Choice inputs only allow one value.',
 	});
 
 export const MultichoiceInputOptionsSchema = z
@@ -767,6 +813,9 @@ export const MultichoiceInputSchema = z
 	})
 	.meta({
 		id: 'MultichoiceInput',
+		title: 'Multichoice Input',
+		description:
+			'Provides an editing interface for data with multiple predefined options. Multichoice inputs allow several values.',
 	});
 
 export const ObjectInputGroupSchema = z.object({
@@ -808,18 +857,28 @@ export const ObjectInputOptionsSchema = z
 						'Provides data formats when adding entries to the data within this object input. When adding an entry, team members are prompted to choose from a number of values you have defined. Has no effect if `allow_create` is false. `entries.structures` applies to the entries within the object.',
 				}),
 				get structures() {
-					return z.union([z.string(), StructureSchema]).optional().meta({
+					return z.union([StructureReferenceSchema, StructureSchema]).optional().meta({
 						description:
 							'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 itself.',
 					});
 				},
+				comment: z.string().optional().meta({
+					id: 'entries_comment',
+					description:
+						'Used to supply help text above the key input when adding/renaming within a mutable object input. Has no default. Supports a limited set of Markdown: links, bold, italic, subscript, superscript and inline code elements are allowed.',
+				}),
+				documentation: DocumentationSchema.optional().meta({
+					id: 'entries_documentation',
+					description:
+						'Provides a custom link for documentation for editors shown above the key input when adding/renaming within a mutable object input.',
+				}),
 			})
 			.optional()
 			.meta({
 				description: 'Contains options for the "mutable" subtype.',
 			}),
 		get structures() {
-			return z.union([z.string(), StructureSchema]).optional().meta({
+			return z.union([StructureReferenceSchema, StructureSchema]).optional().meta({
 				description:
 					'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 itself.',
 			});
@@ -850,6 +909,8 @@ export const ObjectInputSchema = z
 	})
 	.meta({
 		id: 'ObjectInput',
+		title: 'Object Input',
+		description: 'Provides a user interface for a group of inputs.',
 	});
 
 export const ArrayInputOptionsSchema = z
@@ -859,7 +920,7 @@ export const ArrayInputOptionsSchema = z
 		...ArrayControlOptionsSchema.shape,
 		empty_type: EmptyTypeArraySchema.optional(),
 		get structures() {
-			return z.union([z.string(), StructureSchema]).optional().meta({
+			return z.union([StructureReferenceSchema, StructureSchema]).optional().meta({
 				description:
 					'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.',
 			});
@@ -877,6 +938,8 @@ export const ArrayInputSchema = z
 	})
 	.meta({
 		id: 'ArrayInput',
+		title: 'Array Input',
+		description: 'Provides a user interface for lists of inputs or input groups.',
 	});
 
 export const AutoInputSchema = z
@@ -889,6 +952,9 @@ export const AutoInputSchema = z
 	})
 	.meta({
 		id: 'AutoInput',
+		title: 'Automatic Input',
+		description: 'Provides a default user interface based on the data contained.',
+		excludeFromDocumentation: true,
 	});
 
 export const UnknownInputSchema = z
@@ -901,8 +967,8 @@ export const UnknownInputSchema = z
 	.meta({
 		id: 'UnknownInput',
 		title: 'Unknown Input',
-		description:
-			'An input type that is not known to the CloudCannon configuration schema. This is logically the same as `AutoInput`, but is used for inputs that have no type set.',
+		description: 'Provides a default user interface based on the data contained.',
+		excludeFromDocumentation: true,
 	});
 
 export const KnownInputSchema = z
@@ -935,10 +1001,11 @@ export const KnownInputSchema = z
 
 export const InputSchema = z.union([KnownInputSchema, UnknownInputSchema]).meta({
 	id: 'Input',
+	title: 'Input',
 });
 
 export const InputsSchema = z.record(z.string(), InputSchema).meta({
-	id: '_inputs',
+	id: 'type._inputs',
 	title: 'Inputs',
 	description:
 		'Controls the behavior and appearance of your inputs in all data editing interfaces.',

package/src/markdown.ts

@@ -9,13 +9,11 @@ export const AttributeListPositionSchema = z
 	});
 
 export const MarkdownAttributeElementOptionsSchema = z
-	.intersection(
-		z.object({
-			inline: AttributeListPositionSchema.optional(),
-			block: AttributeListPositionSchema.optional(),
-		}),
-		z.record(z.string(), AttributeListPositionSchema)
-	)
+	.object({
+		inline: AttributeListPositionSchema.optional(),
+		block: AttributeListPositionSchema.optional(),
+	})
+	.catchall(AttributeListPositionSchema)
 	.meta({
 		title: 'Markdown Attribute Element Options',
 		description: 'Configuration for positioning Markdown attributes on different element types.',
@@ -23,69 +21,72 @@ export const MarkdownAttributeElementOptionsSchema = z
 
 export const MarkdownSettingsSchema = z
 	.object({
-		engine: z.enum(['commonmark', 'kramdown']).default('commonmark').meta({
+		engine: z.enum(['commonmark', 'kramdown']).default('commonmark').optional().meta({
 			description: 'The flavor of Markdown to use to convert between HTML and Markdown.',
 		}),
-		options: z.object({
-			html: z.boolean().optional().meta({
-				description: 'Output HTML tags from source.',
-			}),
-			xhtml: z.boolean().optional().meta({
-				description: 'Use `/` to close single tags (e.g. `<br />`).',
-			}),
-			breaks: z.boolean().optional().meta({
-				description: 'Convert `\\n` in paragraphs into `<br>`.',
-			}),
-			linkify: z.boolean().optional().meta({
-				description: 'Autoconvert URL-like text to links.',
-			}),
-			typographer: z.boolean().optional().meta({
-				description: 'Enable some language-neutral replacement, as well as quotes beautification.',
-			}),
-			quotes: z.string().optional().meta({
-				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({
-				description: 'Output lists with an extra space in Markdown.',
-			}),
-			sentence_per_line: z.boolean().optional().meta({
-				description: 'Add linebreaks between sentences in Markdown.',
-			}),
-			gfm: z.boolean().optional().meta({
-				description: 'Enable GFM mode.',
-			}),
-			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({
-				description: 'Determines whether 4 spaces on indentation should be read as a code block.',
-			}),
-			escape_snippets_in_code_blocks: z.boolean().optional().meta({
-				description: 'Render snippets as plain text within code blocks.',
-			}),
-			table: z.boolean().optional().meta({
-				description: 'Output tables in Markdown format.',
-			}),
-			strikethrough: z.boolean().optional().meta({
-				description: 'Output strikes in wrapped in double tildes (e.g. `~~strike~~`).',
-			}),
-			subscript: z.boolean().optional().meta({
-				description: 'Output subscript in wrapped in tildes (e.g. `~sub~`).',
-			}),
-			superscript: z.boolean().optional().meta({
-				description: 'Output superscript in wrapped in carets (e.g. `^super^`).',
-			}),
-			heading_ids: z.boolean().optional().meta({
-				description: 'Generate IDs for headings.',
-			}),
-			attributes: z.boolean().optional().meta({
-				description: 'Save element attributes in Markdown format instead of converting to HTML.',
-			}),
-			attribute_elements: MarkdownAttributeElementOptionsSchema.optional().meta({
-				description: 'Define positioning behavior of Markdown attributes for different elements.',
-			}),
-		}),
+		options: z
+			.object({
+				html: z.boolean().optional().meta({
+					description: 'Output HTML tags from source.',
+				}),
+				xhtml: z.boolean().optional().meta({
+					description: 'Use `/` to close single tags (e.g. `<br />`).',
+				}),
+				breaks: z.boolean().optional().meta({
+					description: 'Convert `\\n` in paragraphs into `<br>`.',
+				}),
+				linkify: z.boolean().optional().meta({
+					description: 'Autoconvert URL-like text to links.',
+				}),
+				typographer: z.boolean().optional().meta({
+					description:
+						'Enable some language-neutral replacement, as well as quotes beautification.',
+				}),
+				quotes: z.string().optional().meta({
+					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({
+					description: 'Output lists with an extra space in Markdown.',
+				}),
+				sentence_per_line: z.boolean().optional().meta({
+					description: 'Add linebreaks between sentences in Markdown.',
+				}),
+				gfm: z.boolean().optional().meta({
+					description: 'Enable GFM mode.',
+				}),
+				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({
+					description: 'Determines whether 4 spaces on indentation should be read as a code block.',
+				}),
+				escape_snippets_in_code_blocks: z.boolean().optional().meta({
+					description: 'Render snippets as plain text within code blocks.',
+				}),
+				table: z.boolean().optional().meta({
+					description: 'Output tables in Markdown format.',
+				}),
+				strikethrough: z.boolean().optional().meta({
+					description: 'Output strikes in wrapped in double tildes (e.g. `~~strike~~`).',
+				}),
+				subscript: z.boolean().optional().meta({
+					description: 'Output subscript in wrapped in tildes (e.g. `~sub~`).',
+				}),
+				superscript: z.boolean().optional().meta({
+					description: 'Output superscript in wrapped in carets (e.g. `^super^`).',
+				}),
+				heading_ids: z.boolean().optional().meta({
+					description: 'Generate IDs for headings.',
+				}),
+				attributes: z.boolean().optional().meta({
+					description: 'Save element attributes in Markdown format instead of converting to HTML.',
+				}),
+				attribute_elements: MarkdownAttributeElementOptionsSchema.optional().meta({
+					description: 'Define positioning behavior of Markdown attributes for different elements.',
+				}),
+			})
+			.optional(),
 	})
 	.meta({
 		title: 'Markdown Settings',

package/src/paths.ts

@@ -2,42 +2,17 @@ import * as z from 'zod';
 
 export const PathsSchema = z
 	.object({
-		static: z.string().optional().meta({
-			id: 'Paths.static',
-			description:
-				'Location of assets that are statically copied to the output site. This prefix will be removed from the _Uploads_ path when CloudCannon outputs the URL of an asset.',
-		}),
-		uploads: z.string().default('uploads').optional().meta({
-			id: 'Paths.uploads',
-			description: 'Default location of newly uploaded site files.',
-		}),
-		uploads_filename: z.string().optional().meta({
-			id: 'Paths.uploads_filename',
-			description: 'Filename template for newly uploaded site files.',
-		}),
-		dam_uploads: z.string().optional().meta({
-			id: 'Paths.dam_uploads',
-			description: 'Default location of newly uploaded DAM files.',
-		}),
-		dam_uploads_filename: z.string().optional().meta({
-			id: 'Paths.dam_uploads_filename',
-			description: 'Filename template for newly uploaded DAM files.',
-		}),
-		dam_static: z.string().optional().meta({
-			id: 'Paths.dam_static',
-			description:
-				'Location of statically copied assets for DAM files. This prefix will be removed from the _DAM Uploads_ path when CloudCannon outputs the URL of an asset.',
-		}),
-		uploads_use_relative_path: z.boolean().optional().meta({
-			id: 'Paths.uploads_use_relative_path',
-			description:
-				'When set to true, CloudCannon will reference files relative to the path of the file they were uploaded to.',
-		}),
+		static: z.string().optional().meta({ id: 'paths.static' }),
+		uploads: z.string().default('uploads').optional().meta({ id: 'paths.uploads' }),
+		uploads_filename: z.string().optional().meta({ id: 'paths.uploads_filename' }),
+		dam_uploads: z.string().optional().meta({ id: 'paths.dam_uploads' }),
+		dam_uploads_filename: z.string().optional().meta({ id: 'paths.dam_uploads_filename' }),
+		dam_static: z.string().optional().meta({ id: 'paths.dam_static' }),
+		uploads_use_relative_path: z
+			.boolean()
+			.optional()
+			.meta({ id: 'paths.uploads_use_relative_path' }),
 	})
-	.meta({
-		id: 'paths',
-		description:
-			'Paths to where new asset files are uploaded to. They also set the default path when choosing existing images, and linking to existing files. Each path is relative to global `source`. Defaults to the global `paths`.',
-	});
+	.meta({ id: 'type.paths', title: 'Paths' });
 
 export type Paths = z.infer<typeof PathsSchema>;