@cloudcannon/configuration-types 0.0.37 → 0.0.38

package/src/javascript-api.d.ts

@@ -1,204 +0,0 @@
-import type { Cascade } from './cascade';
-import type { SnippetConfig } from './snippets';
-import type { FileInput, UrlInput, RichTextInput } from './inputs';
-
-export interface CloseCustomDataPanelOptions {
-	parentId: string;
-	id: string;
-}
-
-export interface OpenCustomDataPanelOptions extends CloseCustomDataPanelOptions {
-	data: Record<string, any> | any[] | undefined;
-	position?: DOMRect;
-	title: string;
-	inputConfig: Cascade & SnippetConfig;
-	allowFullDataCascade?: boolean;
-}
-
-/**
- * Interface defining the public JavaScript API for interacting with CloudCannon's Visual Editor.
- * This API provides methods for managing content, handling file operations, and controlling the
- * editor's state.
- */
-export interface CloudCannonJavaScriptAPI {
-	/**
-	 * Whether event handling is currently enabled
-	 */
-	eventsEnabled: boolean;
-	/**
-	 * Whether the API should be installed globally
-	 */
-	installGlobally: boolean;
-
-	/**
-	 * Disables the global installation of the API
-	 */
-	disableGlobalInstall(): void;
-
-	/**
-	 * Enables event handling for the API This will also ensure the commit model is created
-	 */
-	enableEvents(): void;
-
-	/**
-	 * Disables event handling for the API
-	 */
-	disableEvents(): void;
-
-	/**
-	 * Refreshes the editor interface Note: This has been replaced with a MutationObserver in
-	 * editor-overlays-view
-	 */
-	refreshInterface(): void;
-
-	/**
-	 * Triggers an update event for a specific file
-	 *
-	 * @param sourcePath - The path of the file to update
-	 */
-	triggerUpdateEvent(sourcePath: string): void;
-
-	/**
-	 * Sets the loading state of the editor
-	 *
-	 * @param loadingData - Optional loading state message
-	 * @returns Promise that resolves when loading state is updated
-	 */
-	setLoading(loadingData: string | undefined): Promise<any>;
-
-	/**
-	 * Sets data for a specific field
-	 *
-	 * @param slug - The identifier of the field to set
-	 * @param value - The value to set
-	 * @returns Promise that resolves when the data is set
-	 */
-	set(slug: string, value: any): Promise<any>;
-
-	/**
-	 * Initiates editing of a specific field
-	 *
-	 * @param slug - The identifier of the field to edit
-	 * @param style - Optional style information
-	 * @param e - The mouse event that triggered the edit
-	 */
-	edit(slug: string, style: string | null, e: MouseEvent): void;
-
-	/**
-	 * Opens a custom data panel for editing
-	 *
-	 * @param options - Configuration options for the panel
-	 * @returns Promise that resolves when the panel is opened
-	 */
-	openCustomDataPanel(options: OpenCustomDataPanelOptions): Promise<void>;
-
-	/**
-	 * Closes a custom data panel
-	 *
-	 * @param options - Configuration options for the panel to close
-	 * @returns Promise that resolves when the panel is closed
-	 */
-	closeCustomDataPanel(options: CloseCustomDataPanelOptions): Promise<void>;
-
-	/**
-	 * Uploads a file to the editor
-	 *
-	 * @param file - The file to upload
-	 * @param inputConfig - Optional configuration for the input
-	 * @returns Promise that resolves with the path of the uploaded file
-	 */
-	uploadFile(
-		file: File,
-		inputConfig: RichTextInput | UrlInput | FileInput | undefined,
-	): Promise<string | undefined>;
-
-	/**
-	 * Adds an item to an array field
-	 *
-	 * @param slug - The identifier of the array field
-	 * @param index - The position to insert at (null for end)
-	 * @param value - The value to insert
-	 * @param e - The mouse event that triggered the addition
-	 * @returns Promise that resolves when the item is added
-	 */
-	addArrayItem(slug: string, index: number | null, value: any, e: MouseEvent): Promise<void>;
-
-	/**
-	 * Adds an item before a specific index in an array field
-	 *
-	 * @param slug - The identifier of the array field
-	 * @param index - The index to insert before
-	 * @param value - The value to insert
-	 * @param e - The mouse event that triggered the addition
-	 * @returns Promise that resolves when the item is added
-	 */
-	addArrayItemBefore(slug: string, index: number, value: any, e: MouseEvent): Promise<void>;
-
-	/**
-	 * Adds an item after a specific index in an array field
-	 *
-	 * @param slug - The identifier of the array field
-	 * @param index - The index to insert after
-	 * @param value - The value to insert
-	 * @param e - The mouse event that triggered the addition
-	 * @returns Promise that resolves when the item is added
-	 */
-	addArrayItemAfter(slug: string, index: number, value: any, e: MouseEvent): Promise<void>;
-
-	/**
-	 * Removes an item from an array field
-	 *
-	 * @param slug - The identifier of the array field
-	 * @param index - The index of the item to remove
-	 * @returns Promise that resolves when the item is removed
-	 */
-	removeArrayItem(slug: string, index: number): Promise<void>;
-
-	/**
-	 * Moves an item within an array field
-	 *
-	 * @param slug - The identifier of the array field
-	 * @param index - The current index of the item
-	 * @param toIndex - The target index for the item
-	 * @returns Promise that resolves when the item is moved
-	 */
-	moveArrayItem(slug: string, index: number, toIndex: number): Promise<void>;
-
-	/**
-	 * Gets the current value of the editor
-	 *
-	 * @param options - Optional configuration for the value retrieval
-	 * @returns Promise that resolves with the current value
-	 */
-	value(options?: { keepMarkdownAsHTML?: boolean }): Promise<string>;
-
-	/**
-	 * Claims a lock on a file
-	 *
-	 * @param sourcePath - Optional path of the file to lock
-	 * @returns Promise that resolves with the lock status
-	 */
-	claimLock(sourcePath?: string): Promise<{ readOnly: boolean }>;
-
-	/**
-	 * Releases a lock on a file
-	 *
-	 * @param sourcePath - Optional path of the file to unlock
-	 * @returns Promise that resolves with the lock status
-	 */
-	releaseLock(sourcePath?: string): Promise<{ readOnly: boolean }>;
-
-	/**
-	 * Gets prefetched files
-	 *
-	 * @returns Promise that resolves with a record of file blobs
-	 */
-	prefetchedFiles(): Promise<Record<string, Blob>>;
-
-	/**
-	 * Loads legacy Bookshop information
-	 *
-	 * @returns Promise that resolves with the Bookshop data
-	 */
-	loadLegacyBookshopInfo(): Promise<any>;
-}

package/src/markdown.d.ts

@@ -1,103 +0,0 @@
-export type AttributeListPosition =
-	| 'none'
-	| 'right'
-	| 'space right'
-	| 'below'
-	| 'newline below'
-	| 'right-of-prefix';
-
-export type MarkdownAttributeElementOptions = {
-	inline?: AttributeListPosition;
-	block?: AttributeListPosition;
-} & {
-	[index: string]: AttributeListPosition;
-};
-
-export interface MarkdownSettings {
-	/**
-	 * The flavor of Markdown to use to convert between HTML and Markdown.
-	 *
-	 * @default commonmark
-	 */
-	engine: 'commonmark' | 'kramdown';
-	options: {
-		/**
-		 * Output HTML tags from source.
-		 */
-		html?: boolean;
-		/**
-		 * Use `/` to close single tags (e.g. `<br />`).
-		 */
-		xhtml?: boolean;
-		/**
-		 * Convert `\n` in paragraphs into `<br>`.
-		 */
-		breaks?: boolean;
-		/**
-		 * Autoconvert URL-like text to links.
-		 */
-		linkify?: boolean;
-		/**
-		 * Enable some language-neutral replacement, as well as quotes beautification.
-		 */
-		typographer?: boolean;
-		/**
-		 * 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`).
-		 */
-		quotes?: string;
-		/**
-		 * Output lists with an extra space in Markdown.
-		 */
-		spaced_lists?: boolean;
-		/**
-		 * Add linebreaks between sentences in Markdown.
-		 */
-		sentence_per_line?: boolean;
-		/**
-		 * Enable GFM mode.
-		 */
-		gfm?: boolean;
-		/**
-		 * Determines which style of code block fences to use.
-		 */
-		code_block_fences?: '```' | '~~~';
-		/**
-		 * Determines whether 4 spaces on indentation should be read as a code block.
-		 */
-		treat_indentation_as_code?: boolean;
-		/**
-		 * Render snippets as plain text within code blocks.
-		 */
-		escape_snippets_in_code_blocks?: boolean;
-		/**
-		 * Output tables in Markdown format.
-		 */
-		table?: boolean;
-		/**
-		 * Output strikes in wrapped in double tildes (e.g. `~~strike~~`).
-		 */
-		strikethrough?: boolean;
-		/**
-		 * Output subscript in wrapped in tildes (e.g. `~sub~`).
-		 */
-		subscript?: boolean;
-		/**
-		 * Output superscript in wrapped in carets (e.g. `^super^`).
-		 */
-		superscript?: boolean;
-		/**
-		 * Generate IDs for headings.
-		 */
-		heading_ids?: boolean;
-		/**
-		 * Save element attributes in Markdown format instead of converting to HTML.
-		 */
-		attributes?: boolean;
-		/**
-		 * Define positioning behavior of Markdown attributes for different elements.
-		 */
-		attribute_elements?: MarkdownAttributeElementOptions;
-	};
-}

package/src/paths.d.ts

@@ -1,44 +0,0 @@
-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

@@ -1,110 +0,0 @@
-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?: PreviewEntry;
-	/**
-	 * Controls the background color of the icon.
-	 */
-	icon_background_color?: PreviewEntry;
-}
-
-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';
-	/**
-	 * Controls the background color gallery area.
-	 */
-	background_color?: PreviewEntry;
-}
-
-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

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

package/src/snippets.d.ts

@@ -1,227 +0,0 @@
-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>;
-		  };
-}