@cloudcannon/configuration-types 0.0.22 → 0.0.24

package/src/markdown.d.ts

@@ -17,7 +17,7 @@ export interface MarkdownSettings {
 	/**
 	 * The flavor of Markdown to use to convert between HTML and Markdown.
 	 *
-	 * @default kramdown
+	 * @default commonmark
 	 */
 	engine: 'commonmark' | 'kramdown';
 	options: {

package/src/paths.d.ts

@@ -0,0 +1,44 @@
+export interface Paths {
+	/**
+	 * 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.
+	 */
+	static?: string;
+	/**
+	 * Default location of newly uploaded site files.
+	 *
+	 * @default uploads
+	 */
+	uploads?: string;
+	/**
+	 * Filename template for newly uploaded site files.
+	 */
+	uploads_filename?: string;
+	/**
+	 * Default location of newly uploaded DAM files.
+	 */
+	dam_uploads?: string;
+	/**
+	 * Filename template for newly uploaded DAM files.
+	 */
+	dam_uploads_filename?: string;
+	/**
+	 * 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.
+	 */
+	dam_static?: string;
+	/**
+	 * When set to true, CloudCannon will reference files relative to the path of the file they were
+	 * uploaded to.
+	 */
+	uploads_use_relative_path?: boolean;
+}
+
+export interface WithPaths {
+	/**
+	 * 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`.
+	 */
+	paths?: Paths;
+}

package/src/preview.d.ts

@@ -0,0 +1,102 @@
+interface PreviewKeyEntry {
+	/**
+	 * The key used to access the value used for the preview.
+	 */
+	key: string;
+}
+
+interface PreviewTemplateEntry {
+	/**
+	 * A template string containing various placeholders for the value used in the preview.
+	 */
+	template: string;
+}
+
+type PreviewEntry =
+	| Array<PreviewKeyEntry | PreviewTemplateEntry | string | boolean>
+	| string
+	| boolean;
+
+export interface WithTextPreview {
+	/**
+	 * Controls the main text shown per item.
+	 */
+	text?: PreviewEntry;
+}
+
+export interface WithImagePreview {
+	/**
+	 * Controls the image shown per item.
+	 */
+	image?: PreviewEntry;
+}
+
+export interface WithSubtextPreview {
+	/**
+	 * Controls the supporting text shown per item.
+	 */
+	subtext?: PreviewEntry;
+}
+
+export interface WithIconPreview {
+	/**
+	 * Controls the icon shown per item. Must result in a Material Icon name.
+	 */
+	icon?: PreviewEntry;
+}
+
+export interface WithIconColorPreview {
+	/**
+	 * Controls the color of the icon.
+	 */
+	icon_color?: string;
+}
+
+export interface WithPreview {
+	/**
+	 * Changes the way items are previewed in the CMS.
+	 */
+	preview?: Preview;
+}
+
+export interface WithPickerPreview {
+	/**
+	 * Changes the way items are previewed in the CMS while being chosen.
+	 */
+	picker_preview?: Preview;
+}
+
+export interface PreviewGallery
+	extends WithTextPreview,
+		WithImagePreview,
+		WithIconPreview,
+		WithIconColorPreview {
+	/**
+	 * Controls how the gallery image is positioned within the gallery.
+	 *
+	 * @default padded
+	 */
+	fit?: 'padded' | 'cover' | 'contain' | 'cover-top';
+}
+
+export interface PreviewMetadata
+	extends WithTextPreview,
+		WithImagePreview,
+		WithIconPreview,
+		WithIconColorPreview {}
+
+export interface Preview
+	extends WithTextPreview,
+		WithImagePreview,
+		WithIconPreview,
+		WithIconColorPreview,
+		WithSubtextPreview {
+	/**
+	 * Defines a list of items that can contain an image, icon, and text.
+	 */
+	metadata?: PreviewMetadata[];
+	/**
+	 * Details for large image/icon preview per item.
+	 */
+	gallery?: PreviewGallery;
+}

package/src/select-values.d.ts

@@ -0,0 +1,6 @@
+export type SelectValues =
+	| string[]
+	| Record<string, string>[]
+	| Record<string, string>
+	| Record<string, unknown>[]
+	| Record<string, unknown>;

package/src/snippets.d.ts

@@ -0,0 +1,227 @@
+import type Scrapbooker from '@cloudcannon/snippet-types';
+import type { ReducedCascade } from './cascade';
+import type { WithPickerPreview, WithPreview } from './preview';
+
+// TODO: use SnippetConfig from @cloudcannon/scrap-booker when ParserConfig issue resolved.
+export interface SnippetConfig extends ReducedCascade, WithPreview, WithPickerPreview {
+	/**
+	 * Name of the snippet.
+	 */
+	snippet?: string;
+	/**
+	 * The template that this snippet should inherit, out of the available Shortcode Templates.
+	 */
+	template?: string;
+	/**
+	 * 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.
+	 */
+	inline?: boolean;
+	/**
+	 * Controls how selected items are rendered. Defaults to 'card', or 'inline' if `inline` is true.
+	 */
+	view?: 'card' | 'inline' | 'gallery';
+	/**
+	 * Whether this snippet treats whitespace as-is or not.
+	 */
+	strict_whitespace?: boolean;
+	/**
+	 * The variables required for the selected template.
+	 */
+	definitions?: Record<string, unknown>;
+	/**
+	 * Alternate configurations for this snippet.
+	 */
+	alternate_formats?: SnippetConfig[];
+	/**
+	 * The parameters of this snippet.
+	 */
+	params?: Record<string, unknown>; // TODO: use ParserConfig from @cloudcannon/scrap-booker.
+}
+
+export interface SnippetsImports {
+	/**
+	 * Default snippets for Hugo SSG.
+	 */
+	hugo?:
+		| boolean
+		| {
+				/**
+				 * The list of excluded snippets. If unset, all snippets are excluded unless defined in
+				 * `include`.
+				 *
+				 * @uniqueItems
+				 */
+				exclude: Array<keyof typeof Scrapbooker.defaults.hugo.snippets>;
+		  }
+		| {
+				/**
+				 * The list of included snippets. If unset, all snippets are included unless defined in
+				 * `exclude`.
+				 *
+				 * @uniqueItems
+				 */
+				include: Array<keyof typeof Scrapbooker.defaults.hugo.snippets>;
+		  };
+	/**
+	 * Default snippets for Jekyll SSG.
+	 */
+	jekyll?:
+		| boolean
+		| {
+				/**
+				 * The list of excluded snippets. If unset, all snippets are excluded unless defined in
+				 * `include`.
+				 *
+				 * @uniqueItems
+				 */
+				exclude: Array<keyof typeof Scrapbooker.defaults.jekyll.snippets>;
+		  }
+		| {
+				/**
+				 * The list of included snippets. If unset, all snippets are included unless defined in
+				 * `exclude`.
+				 *
+				 * @uniqueItems
+				 */
+				include: Array<keyof typeof Scrapbooker.defaults.jekyll.snippets>;
+		  };
+	/**
+	 * Default snippets for MDX-based content.
+	 */
+	mdx?:
+		| boolean
+		| {
+				/**
+				 * The list of excluded snippets. If unset, all snippets are excluded unless defined in
+				 * `include`.
+				 *
+				 * @uniqueItems
+				 */
+				exclude: Array<keyof typeof Scrapbooker.defaults.mdx.snippets>;
+		  }
+		| {
+				/**
+				 * The list of included snippets. If unset, all snippets are included unless defined in
+				 * `exclude`.
+				 *
+				 * @uniqueItems
+				 */
+				include: Array<keyof typeof Scrapbooker.defaults.mdx.snippets>;
+		  };
+	/**
+	 * Default snippets for Eleventy SSG Liquid files.
+	 */
+	eleventy_liquid?:
+		| boolean
+		| {
+				/**
+				 * The list of excluded snippets. If unset, all snippets are excluded unless defined in
+				 * `include`.
+				 *
+				 * @uniqueItems
+				 */
+				exclude: Array<keyof typeof Scrapbooker.defaults.eleventy_liquid.snippets>;
+		  }
+		| {
+				/**
+				 * The list of included snippets. If unset, all snippets are included unless defined in
+				 * `exclude`.
+				 *
+				 * @uniqueItems
+				 */
+				include: Array<keyof typeof Scrapbooker.defaults.eleventy_liquid.snippets>;
+		  };
+	/**
+	 * Default snippets for Eleventy SSG Nunjucks files.
+	 */
+	eleventy_nunjucks?:
+		| boolean
+		| {
+				/**
+				 * The list of excluded snippets. If unset, all snippets are excluded unless defined in
+				 * `include`.
+				 *
+				 * @uniqueItems
+				 */
+				exclude: Array<keyof typeof Scrapbooker.defaults.eleventy_nunjucks.snippets>;
+		  }
+		| {
+				/**
+				 * The list of included snippets. If unset, all snippets are included unless defined in
+				 * `exclude`.
+				 *
+				 * @uniqueItems
+				 */
+				include: Array<keyof typeof Scrapbooker.defaults.eleventy_nunjucks.snippets>;
+		  };
+	/**
+	 * Default snippets for Markdoc-based content.
+	 */
+	markdoc?:
+		| boolean
+		| {
+				/**
+				 * The list of excluded snippets. If unset, all snippets are excluded unless defined in
+				 * `include`.
+				 *
+				 * @uniqueItems
+				 */
+				exclude: Array<keyof typeof Scrapbooker.defaults.markdoc.snippets>;
+		  }
+		| {
+				/**
+				 * The list of included snippets. If unset, all snippets are included unless defined in
+				 * `exclude`.
+				 *
+				 * @uniqueItems
+				 */
+				include: Array<keyof typeof Scrapbooker.defaults.markdoc.snippets>;
+		  };
+	/**
+	 * Default snippets for content using Python markdown extensions.
+	 */
+	python_markdown_extensions?:
+		| boolean
+		| {
+				/**
+				 * The list of excluded snippets. If unset, all snippets are excluded unless defined in
+				 * `include`.
+				 *
+				 * @uniqueItems
+				 */
+				exclude: Array<keyof typeof Scrapbooker.defaults.python_markdown_extensions.snippets>;
+		  }
+		| {
+				/**
+				 * The list of included snippets. If unset, all snippets are included unless defined in
+				 * `exclude`.
+				 *
+				 * @uniqueItems
+				 */
+				include: Array<keyof typeof Scrapbooker.defaults.python_markdown_extensions.snippets>;
+		  };
+	/**
+	 * Default snippets for Docusaurus SSG.
+	 */
+	docusaurus_mdx?:
+		| boolean
+		| {
+				/**
+				 * The list of excluded snippets. If unset, all snippets are excluded unless defined in
+				 * `include`.
+				 *
+				 * @uniqueItems
+				 */
+				exclude: Array<keyof typeof Scrapbooker.defaults.docusaurus_mdx.snippets>;
+		  }
+		| {
+				/**
+				 * The list of included snippets. If unset, all snippets are included unless defined in
+				 * `exclude`.
+				 *
+				 * @uniqueItems
+				 */
+				include: Array<keyof typeof Scrapbooker.defaults.docusaurus_mdx.snippets>;
+		  };
+}

package/src/source-editor.d.ts

@@ -0,0 +1,86 @@
+/**
+ * This key defines the appearance and behavior of the Source Editor. The following nested keys are
+ * available:
+ *
+ * - `tab_size`
+ * - `show_gutter`
+ * - `theme`
+ *
+ * This key has no default.
+ *
+ * https://cloudcannon.com/documentation/articles/the-source-editor/#source_editor
+ */
+export interface SourceEditor {
+	/**
+	 * This key defines the auto-indentation of each line and how many spaces a tab indentation counts
+	 * as.
+	 *
+	 * By default, this key is `2`.
+	 *
+	 * https://cloudcannon.com/documentation/articles/the-source-editor/#source_editor.tab_size
+	 *
+	 * @default 2
+	 */
+	tab_size?: number;
+	/**
+	 * This key defines the color theme for syntax highlighting in the Source Editor.
+	 *
+	 * By default, this key is `monokai`.
+	 *
+	 * https://cloudcannon.com/documentation/articles/the-source-editor/#source_editor.theme
+	 *
+	 * @default monokai
+	 */
+	theme?: Theme;
+	/**
+	 * This key toggles the gutter on the left of the editing interface, displaying line numbers and
+	 * code folding controls.
+	 *
+	 * By default, this key is `true`.
+	 *
+	 * https://cloudcannon.com/documentation/articles/the-source-editor/#source_editor.show_gutter
+	 *
+	 * @default true
+	 */
+	show_gutter?: boolean;
+}
+
+export type Theme =
+	| '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';

package/src/structures.d.ts

@@ -0,0 +1,113 @@
+import type { Cascade } from './cascade';
+import type { Documentation } from './documentation';
+import type { Icon } from './icon';
+import type { ObjectInputGroup } from './inputs';
+import type { WithPickerPreview, WithPreview } from './preview';
+
+interface StructureBase {
+	/**
+	 * 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.
+	 */
+	reorder_inputs?: boolean;
+	/**
+	 * Hides unexpected inputs when editing. Has no effect if `remove_extra_inputs` is true. Defaults
+	 * to false.
+	 */
+	hide_extra_inputs?: boolean;
+	/**
+	 * 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_empty_inputs?: boolean;
+	/**
+	 * If checked, extra inputs are removed when editing. Defaults to true.
+	 */
+	remove_extra_inputs?: boolean;
+}
+
+export interface Structure extends StructureBase {
+	/**
+	 * Defines what values are available to add when using this structure.
+	 */
+	values: StructureValue[];
+	/**
+	 * 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".
+	 */
+	id_key?: string;
+	/**
+	 * 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.
+	 *
+	 * @default select
+	 */
+	style?: 'select' | 'modal';
+}
+
+export interface StructureValue extends WithPreview, WithPickerPreview, StructureBase, Cascade {
+	/**
+	 * A unique reference value used when referring to this structure value from the Object input's
+	 * assigned_structures option.
+	 */
+	id?: string;
+	/**
+	 * 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.
+	 *
+	 * @default false
+	 */
+	default?: boolean;
+	/**
+	 * An icon used when displaying the structure (defaults to either format_list_bulleted for items
+	 * in arrays, or notes otherwise).
+	 */
+	icon?: Icon;
+	/**
+	 * Path to an image in your source files used when displaying the structure. Can be either a
+	 * source (has priority) or output path.
+	 */
+	image?: string;
+	/**
+	 * Used as the main text in the interface for this value.
+	 */
+	label?: string;
+	/**
+	 * Used to group and filter items when selecting from a modal.
+	 */
+	tags?: string[];
+	/**
+	 * Allows you to group the inputs inside this object together without changing the data structure.
+	 */
+	groups?: ObjectInputGroup[];
+	/**
+	 * Controls which order input groups and ungrouped inputs appear in.
+	 *
+	 * @default false
+	 */
+	place_groups_below?: boolean;
+	/**
+	 * Show nested objects as tabs. Requires all top-level keys to be objects.
+	 *
+	 * @default false
+	 */
+	tabbed?: boolean;
+	/**
+	 * The actual value used when items are added after selection.
+	 */
+	value: unknown;
+	/**
+	 * 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.
+	 */
+	comment?: string;
+	/**
+	 * Provides a custom link for documentation for editors shown in the Data Editor for expanded
+	 * values matching this Structure value. Has no default.
+	 */
+	documentation?: Documentation;
+}