@cloudcannon/configuration-types 0.0.37 → 0.0.38

package/src/preview.ts

@@ -0,0 +1,125 @@
+import * as z from 'zod';
+
+const PreviewKeyEntrySchema = z.object({
+	key: z.string().meta({
+		description: 'The key used to access the value used for the preview.',
+	}),
+});
+
+const PreviewTemplateEntrySchema = z.object({
+	template: z.string().meta({
+		description:
+			'A template string containing various placeholders for the value used in the preview.',
+	}),
+});
+
+const PreviewEntrySchema = z
+	.union([
+		z.array(z.union([PreviewKeyEntrySchema, PreviewTemplateEntrySchema, z.string(), z.boolean()])),
+		z.string(),
+		z.boolean(),
+	])
+	.meta({
+		id: 'PreviewEntry',
+	});
+
+const TextPreviewSchema = PreviewEntrySchema.meta({
+	id: 'preview.text',
+	description: 'Controls the main text shown per item.',
+});
+
+const ImagePreviewSchema = PreviewEntrySchema.meta({
+	id: 'preview.image',
+	description: 'Controls the image shown per item.',
+});
+
+const IconPreviewSchema = PreviewEntrySchema.meta({
+	id: 'preview.icon',
+	description: 'Controls the icon shown per item. Must result in a Material Symbol name.',
+});
+
+export const IconColorSchema = PreviewEntrySchema.meta({
+	id: 'preview.icon_color',
+	description: 'Controls the color of the icon.',
+});
+
+export const IconBackgroundColorSchema = PreviewEntrySchema.meta({
+	id: 'preview.icon_background_color',
+	description: 'Controls the background color of the icon.',
+});
+
+export const PreviewGallerySchema = z
+	.object({
+		text: TextPreviewSchema.optional(),
+		image: ImagePreviewSchema.optional(),
+		icon: IconPreviewSchema.optional(),
+		icon_color: IconColorSchema.optional(),
+		icon_background_color: IconBackgroundColorSchema.optional(),
+		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({
+			description: 'Controls the background color gallery area.',
+		}),
+	})
+	.meta({
+		id: 'preview.gallery',
+		title: 'Preview Gallery',
+		description: 'Configuration for gallery-style previews.',
+	});
+
+export const PreviewMetadataSchema = z
+	.object({
+		text: TextPreviewSchema.optional(),
+		image: ImagePreviewSchema.optional(),
+		icon: IconPreviewSchema.optional(),
+		icon_color: IconColorSchema.optional(),
+		icon_background_color: IconBackgroundColorSchema.optional(),
+	})
+	.meta({
+		id: 'preview.metadata',
+		title: 'Preview Metadata',
+		description:
+			'Metadata configuration for preview items including text, image, and icon options.',
+	});
+
+export const PreviewSchema = z
+	.object({
+		text: TextPreviewSchema.optional(),
+		subtext: PreviewEntrySchema.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(),
+		metadata: z.array(PreviewMetadataSchema).optional().meta({
+			description: 'Defines a list of items that can contain an image, icon, and text.',
+		}),
+		gallery: PreviewGallerySchema.optional().meta({
+			description: 'Details for large image/icon preview per item.',
+		}),
+	})
+	.meta({
+		id: 'preview',
+		title: 'Preview',
+		description:
+			'Configuration for how content items are visually previewed in the CloudCannon interface.',
+	});
+
+export const PickerPreviewSchema = z
+	.object({
+		// This needs to extend it this way, rather than calling PreviewSchema.meta({}).
+		// Otherwise, it seems to override in a way that does not allow us to remove `"id": "preview"`
+		// during JSONSchema generate.
+		...PreviewSchema.shape,
+	})
+	.meta({
+		id: 'picker_preview',
+		title: 'Picker Preview',
+		description: 'Changes the way items are previewed in the CMS while being chosen.',
+	});
+
+export type PreviewGallery = z.infer<typeof PreviewGallerySchema>;
+export type PreviewMetadata = z.infer<typeof PreviewMetadataSchema>;
+export type Preview = z.infer<typeof PreviewSchema>;

package/src/select-values.ts

@@ -0,0 +1,26 @@
+import * as z from 'zod';
+
+export const SelectDataValuesSchema = z
+	.union([
+		z.array(z.string()),
+		z.array(z.record(z.string(), z.string())),
+		z.record(z.string(), z.string()),
+		z.array(z.record(z.string(), z.unknown())),
+		z.record(z.string(), z.unknown()),
+	])
+	.meta({
+		id: 'SelectDataValues',
+		title: 'Select Data Values',
+		description:
+			'Data formats for populating select and multiselect input options, supporting arrays and objects.',
+	});
+
+export const SelectDataSchema = z.record(z.string(), SelectDataValuesSchema).meta({
+	id: '_select_data',
+	title: 'Select Data',
+	description:
+		'Fixed datasets that can be referenced by the _Values_ configuration for _Select_ and _Multiselect_ inputs.',
+});
+
+export type SelectDataValues = z.infer<typeof SelectDataValuesSchema>;
+export type SelectData = z.infer<typeof SelectDataSchema>;

package/src/snippets.ts

@@ -0,0 +1,113 @@
+import * as z from 'zod';
+import { ReducedCascadeSchema } from './cascade';
+import { PickerPreviewSchema, PreviewSchema } from './preview';
+
+export const SnippetConfigSchema = z
+	.object({
+		...ReducedCascadeSchema.shape,
+		preview: PreviewSchema.optional(),
+		picker_preview: PickerPreviewSchema.optional(),
+	})
+	.extend({
+		snippet: z.string().optional().meta({
+			description: 'Name of the snippet.',
+		}),
+		template: z.string().optional().meta({
+			description:
+				'The template that this snippet should inherit, out of the available Shortcode Templates.',
+		}),
+		inline: z.boolean().optional().meta({
+			description:
+				'Whether this snippet can appear inline (within a sentence). Defaults to false, which will treat this snippet as a block-level element in the content editor.',
+		}),
+		view: z.enum(['card', 'inline', 'gallery']).optional().meta({
+			description:
+				"Controls how selected items are rendered. Defaults to 'card', or 'inline' if `inline` is true.",
+		}),
+		strict_whitespace: z.boolean().optional().meta({
+			description: 'Whether this snippet treats whitespace as-is or not.',
+		}),
+		definitions: z.record(z.string(), z.unknown()).optional().meta({
+			description: 'The variables required for the selected template.',
+		}),
+		get alternate_formats() {
+			return z.array(SnippetConfigSchema).optional().meta({
+				description: 'Alternate configurations for this snippet.',
+			});
+		},
+		params: z.record(z.string(), z.unknown()).optional().meta({
+			description: 'The parameters of this snippet.',
+		}),
+	})
+	.meta({
+		id: 'SnippetConfig',
+		title: 'Snippet Configuration',
+		description: 'A snippet configuration.',
+	});
+
+const SnippetImportSchema = z
+	.union([
+		z.boolean(),
+		z.object({
+			exclude: z.array(z.string()).meta({
+				description:
+					'The list of excluded snippets. If unset, all snippets are excluded unless defined in `include`.',
+			}),
+		}),
+		z.object({
+			include: z.array(z.string()).meta({
+				description:
+					'The list of included snippets. If unset, all snippets are included unless defined in `exclude`.',
+			}),
+		}),
+	])
+	.meta({
+		id: 'SnippetImport',
+		title: 'Snippet Import',
+		description: 'Controls what snippets are available to import.',
+	});
+
+export const SnippetsImportsSchema = z
+	.object({
+		hugo: SnippetImportSchema.optional().meta({
+			description: 'Default snippets for Hugo SSG.',
+			uniqueItems: true,
+		}),
+		jekyll: SnippetImportSchema.optional().meta({
+			description: 'Default snippets for Jekyll SSG.',
+			uniqueItems: true,
+		}),
+		mdx: SnippetImportSchema.optional().meta({
+			description: 'Default snippets for MDX-based content.',
+			uniqueItems: true,
+		}),
+		eleventy_liquid: SnippetImportSchema.optional().meta({
+			description: 'Default snippets for Eleventy SSG Liquid files.',
+			uniqueItems: true,
+		}),
+		eleventy_nunjucks: SnippetImportSchema.optional().meta({
+			description: 'Default snippets for Eleventy SSG Nunjucks files.',
+			uniqueItems: true,
+		}),
+		markdoc: SnippetImportSchema.optional().meta({
+			description: 'Default snippets for Markdoc-based content.',
+			uniqueItems: true,
+		}),
+		python_markdown_extensions: SnippetImportSchema.optional().meta({
+			description: 'Default snippets for content using Python markdown extensions.',
+			uniqueItems: true,
+		}),
+		docusaurus_mdx: SnippetImportSchema.optional().meta({
+			description: 'Default snippets for Docusaurus SSG.',
+			uniqueItems: true,
+		}),
+	})
+	.meta({
+		id: '_snippets_imports',
+		title: 'Snippets Imports',
+		description:
+			'Provides control over which snippets are available to use and/or extend within `_snippets`.',
+	});
+
+export type SnippetConfig = z.infer<typeof SnippetConfigSchema>;
+export type SnippetsImports = z.infer<typeof SnippetsImportsSchema>;

package/src/source-editor.ts

@@ -0,0 +1,68 @@
+import * as z from 'zod';
+
+export const ThemeSchema = z
+	.enum([
+		'ambiance',
+		'chaos',
+		'chrome',
+		'clouds',
+		'clouds_midnight',
+		'cobalt',
+		'crimson_editor',
+		'dawn',
+		'dracula',
+		'dreamweaver',
+		'eclipse',
+		'github',
+		'gob',
+		'gruvbox',
+		'idle_fingers',
+		'iplastic',
+		'katzenmilch',
+		'kr_theme',
+		'kuroir',
+		'merbivore',
+		'merbivore_soft',
+		'mono_industrial',
+		'monokai',
+		'nord_dark',
+		'pastel_on_dark',
+		'solarized_dark',
+		'solarized_light',
+		'sqlserver',
+		'terminal',
+		'textmate',
+		'tomorrow',
+		'tomorrow_night',
+		'tomorrow_night_blue',
+		'tomorrow_night_bright',
+		'tomorrow_night_eighties',
+		'twilight',
+		'vibrant_ink',
+		'xcode',
+	])
+	.meta({
+		id: 'Theme',
+	});
+
+export const SourceEditorSchema = z.object({
+	tab_size: z.number().default(2).optional().meta({
+		description:
+			'This key defines the auto-indentation of each line and how many spaces a tab indentation counts as.\n\nBy default, this key is `2`.\n\nhttps://cloudcannon.com/documentation/articles/the-source-editor/#source_editor.tab_size',
+	}),
+	theme: ThemeSchema.default('monokai').optional().meta({
+		title: 'Theme',
+		description:
+			'This key defines the color theme for syntax highlighting.\n\nBy default, this key is `monokai`.\n\nhttps://cloudcannon.com/documentation/articles/the-source-editor/#source_editor.theme',
+	}),
+	show_gutter: z.boolean().default(true).optional().meta({
+		description:
+			'This key toggles the gutter on the left of the editing interface, displaying line numbers and code folding controls.\n\nBy default, this key is `true`.\n\nhttps://cloudcannon.com/documentation/articles/the-source-editor/#source_editor.show_gutter',
+	}),
+	soft_wrap: z.boolean().default(false).optional().meta({
+		description: 'Enables soft wrapping of the code.',
+	}),
+});
+
+export type Theme = z.infer<typeof ThemeSchema>;
+export type SourceEditor = z.infer<typeof SourceEditorSchema>;

package/src/structures.ts

@@ -0,0 +1,120 @@
+import * as z from 'zod';
+import { DocumentationSchema } from './documentation';
+import { IconSchema } from './icon';
+import { InputsSchema, ObjectInputGroupSchema } from './inputs';
+import { PickerPreviewSchema, PreviewSchema } from './preview';
+import { SelectDataSchema } from './select-values';
+
+const StructureBaseSchema = z.object({
+	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.',
+	}),
+	hide_extra_inputs: z.boolean().default(false).optional().meta({
+		description:
+			'Hides unexpected inputs when editing. Has no effect if `remove_extra_inputs` is true. Defaults to false.',
+	}),
+	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.',
+	}),
+	remove_extra_inputs: z.boolean().default(true).optional().meta({
+		description: 'If checked, extra inputs are removed when editing. Defaults to true.',
+	}),
+});
+
+export const StructureValueSchema = StructureBaseSchema.extend({
+	preview: PreviewSchema.optional(),
+	picker_preview: PickerPreviewSchema.optional(),
+
+	// This is the ReducedCascadeSchema - can't seem to reuse it due to Zod's limitations.
+	get _inputs() {
+		return InputsSchema.optional();
+	},
+	_select_data: SelectDataSchema.optional(),
+	get _structures() {
+		return StructuresSchema.optional();
+	},
+
+	id: z.string().optional().meta({
+		description:
+			"A unique reference value used when referring to this structure value from the Object input's assigned_structures option.",
+	}),
+	default: z.boolean().default(false).optional().meta({
+		description:
+			'If set to true, this item will be considered the default type for this structure. If the type of a value within a structure cannot be inferred based on its id_key or matching fields, then it will fall back to this item. If multiple items have default set to true, only the first item will be used.',
+	}),
+	icon: IconSchema.optional().meta({
+		description:
+			'An icon used when displaying the structure (defaults to either format_list_bulleted for items in arrays, or notes otherwise).',
+	}),
+	image: z.string().optional().meta({
+		description:
+			'Path to an image in your source files used when displaying the structure. Can be either a source (has priority) or output path.',
+	}),
+	label: z.string().optional().meta({
+		description: 'Used as the main text in the interface for this value.',
+	}),
+	tags: z.array(z.string()).optional().meta({
+		description: 'Used to group and filter items when selecting from a modal.',
+	}),
+	get groups() {
+		return z.array(ObjectInputGroupSchema).optional().meta({
+			description:
+				'Allows you to group the inputs inside this object together without changing the data structure.',
+		});
+	},
+	place_groups_below: z.boolean().default(false).optional().meta({
+		description: 'Controls which order input groups and ungrouped inputs appear in.',
+	}),
+	tabbed: z.boolean().default(false).optional().meta({
+		description: 'Show nested objects as tabs. Requires all top-level keys to be objects.',
+	}),
+	value: z.unknown().meta({
+		description: 'The actual value used when items are added after selection.',
+	}),
+	comment: 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.',
+	}),
+	documentation: DocumentationSchema.optional().meta({
+		description:
+			'Provides a custom link for documentation for editors shown in the Data Editor for expanded values matching this Structure value. Has no default.',
+	}),
+}).meta({
+	title: 'Structure Value',
+	description:
+		'A single value option within a structure, defining the data format and appearance for content editors.',
+});
+
+export const StructureSchema = z
+	.object({
+		...StructureBaseSchema.shape,
+		values: z.array(StructureValueSchema).meta({
+			description: 'Defines what values are available to add when using this structure.',
+		}),
+		id_key: z.string().default('_type').optional().meta({
+			description:
+				'Defines what key should be used to detect which structure an item is. If this key is not found in the existing structure, a comparison of key names is used. Defaults to "_type".',
+		}),
+		style: z.enum(['select', 'modal']).default('select').optional().meta({
+			description:
+				'Defines whether options are shown to your editors in a select menu (select, default) or a modal pop up window (modal) when adding a new item.',
+		}),
+	})
+	.meta({
+		id: 'Structure',
+		title: 'Structure',
+		description:
+			'Provides data formats when adding new items to arrays and objects, with options for how editors choose from available values.',
+	});
+
+export const StructuresSchema = z.record(z.string(), StructureSchema).meta({
+	id: '_structures',
+	title: 'Structures',
+	description:
+		'Structured values for editors adding new items to arrays and objects. Entries here can be referenced in the configuration for `array` or `object` inputs.',
+});
+
+export type StructureValue = z.infer<typeof StructureValueSchema>;
+export type Structure = z.infer<typeof StructureSchema>;

package/src/syntax.ts

@@ -0,0 +1,183 @@
+import * as z from 'zod';
+
+export const SyntaxSchema = z
+	.enum([
+		'abap',
+		'abc',
+		'actionscript',
+		'ada',
+		'alda',
+		'apache_conf',
+		'apex',
+		'applescript',
+		'aql',
+		'asciidoc',
+		'asl',
+		'assembly_x86',
+		'autohotkey',
+		'batchfile',
+		'c9search',
+		'c_cpp',
+		'cirru',
+		'clojure',
+		'cobol',
+		'coffee',
+		'coldfusion',
+		'crystal',
+		'csharp',
+		'csound_document',
+		'csound_orchestra',
+		'csound_score',
+		'csp',
+		'css',
+		'curly',
+		'd',
+		'dart',
+		'diff',
+		'django',
+		'dockerfile',
+		'dot',
+		'drools',
+		'edifact',
+		'eiffel',
+		'ejs',
+		'elixir',
+		'elm',
+		'erlang',
+		'forth',
+		'fortran',
+		'fsharp',
+		'fsl',
+		'ftl',
+		'gcode',
+		'gherkin',
+		'gitignore',
+		'glsl',
+		'gobstones',
+		'golang',
+		'graphqlschema',
+		'groovy',
+		'haml',
+		'handlebars',
+		'haskell',
+		'haskell_cabal',
+		'haxe',
+		'hjson',
+		'html',
+		'html_elixir',
+		'html_ruby',
+		'ini',
+		'io',
+		'jack',
+		'jade',
+		'java',
+		'javascript',
+		'json5',
+		'json',
+		'jsoniq',
+		'jsp',
+		'jssm',
+		'jsx',
+		'julia',
+		'kotlin',
+		'latex',
+		'less',
+		'liquid',
+		'lisp',
+		'livescript',
+		'logiql',
+		'logtalk',
+		'lsl',
+		'lua',
+		'luapage',
+		'lucene',
+		'makefile',
+		'markdown',
+		'mask',
+		'matlab',
+		'maze',
+		'mediawiki',
+		'mel',
+		'mixal',
+		'mushcode',
+		'mysql',
+		'nginx',
+		'nim',
+		'nix',
+		'nsis',
+		'nunjucks',
+		'objectivec',
+		'ocaml',
+		'pascal',
+		'perl6',
+		'perl',
+		'pgsql',
+		'php',
+		'php_laravel_blade',
+		'pig',
+		'plain_text',
+		'powershell',
+		'praat',
+		'prisma',
+		'prolog',
+		'properties',
+		'protobuf',
+		'puppet',
+		'python',
+		'qml',
+		'r',
+		'razor',
+		'rdoc',
+		'red',
+		'redshift',
+		'rhtml',
+		'rst',
+		'ruby',
+		'rust',
+		'sass',
+		'scad',
+		'scala',
+		'scheme',
+		'scss',
+		'sh',
+		'sjs',
+		'slim',
+		'smarty',
+		'snippets',
+		'soy_template',
+		'space',
+		'sparql',
+		'sql',
+		'sqlserver',
+		'stylus',
+		'svg',
+		'swift',
+		'tcl',
+		'terraform',
+		'tex',
+		'text',
+		'textile',
+		'toml',
+		'tsx',
+		'turtle',
+		'twig',
+		'typescript',
+		'vala',
+		'vbscript',
+		'velocity',
+		'verilog',
+		'vhdl',
+		'visualforce',
+		'wollok',
+		'xml',
+		'xquery',
+		'yaml',
+		'zeek',
+	])
+	.meta({
+		id: 'Syntax',
+		title: 'Syntax',
+		description: 'Available syntax highlighting languages for code editors in CloudCannon.',
+	});
+
+export type Schema = z.infer<typeof SyntaxSchema>;