@cloudcannon/configuration-types 0.0.23 → 0.0.24

package/package.json

@@ -1,49 +1,60 @@
 {
-  "name": "@cloudcannon/configuration-types",
-  "version": "0.0.23",
-  "description": "Contains TypeScript declarations and generates JSONSchema files for the CloudCannon configuration file.",
-  "author": "CloudCannon <support@cloudcannon.com>",
-  "license": "MIT",
-  "keywords": [
-    "static site generator",
-    "cloudcannon"
-  ],
-  "homepage": "https://github.com/CloudCannon/configuration-types#readme",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/CloudCannon/configuration-types.git"
-  },
-  "bugs": {
-    "url": "https://github.com/CloudCannon/configuration-types/issues",
-    "email": "support@cloudcannon.com"
-  },
-  "scripts": {
-    "prebuild": "rimraf dist && mkdir -p dist",
-    "build": "ts-json-schema-generator --no-top-ref --markdown-description --path src/index.d.ts --type Configuration --out dist/cloudcannon-config.schema.json --id 'https://github.com/cloudcannon/configuration-types/releases/latest/download/cloudcannon-config.schema.json'",
-    "lint": "npm run lint:tsc && npm run lint:format",
-    "lint:tsc": "tsc --noEmit",
-    "lint:format": "prettier -c src",
-    "format": "prettier -w src",
-    "test": "exit 0"
-  },
-  "main": "./src/index.d.ts",
-  "types": "./src/index.d.ts",
-  "publishConfig": {
-    "access": "public"
-  },
-  "files": [
-    "src/**/*",
-    "dist/**/*"
-  ],
-  "dependencies": {
-    "@cloudcannon/snippet-types": "^1.1.12",
-    "ts-json-schema-generator": "^2.2.0"
-  },
-  "devDependencies": {
-    "@types/node": "^22.9.1",
-    "prettier": "^3.3.3",
-    "prettier-plugin-jsdoc": "^1.3.0",
-    "rimraf": "^6.0.1",
-    "typescript": "^5.6.3"
-  }
+	"name": "@cloudcannon/configuration-types",
+	"version": "0.0.24",
+	"type": "module",
+	"description": "Contains TypeScript declarations and generates JSONSchema files for the CloudCannon configuration file.",
+	"author": "CloudCannon <support@cloudcannon.com>",
+	"license": "MIT",
+	"keywords": [
+		"static site generator",
+		"cloudcannon"
+	],
+	"homepage": "https://github.com/CloudCannon/configuration-types#readme",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/CloudCannon/configuration-types.git"
+	},
+	"bugs": {
+		"url": "https://github.com/CloudCannon/configuration-types/issues",
+		"email": "support@cloudcannon.com"
+	},
+	"scripts": {
+		"prebuild": "rimraf dist && mkdir -p dist",
+		"build": "run-p build:*",
+		"build:combined": "cp src/cloudcannon-config.schema.json dist/cloudcannon-config.schema.json",
+		"build:latest": "ts-json-schema-generator --markdown-description --no-top-ref --path src/index.d.ts --type Configuration --out dist/cloudcannon-config.latest.schema.json --id 'https://github.com/cloudcannon/configuration-types/releases/latest/download/cloudcannon-config.latest.schema.json'",
+		"build:legacy-jekyll": "ts-json-schema-generator --markdown-description --no-top-ref --path src/build-coupled.d.ts --type JekyllConfiguration --out dist/cloudcannon-config.legacy-jekyll.schema.json --id 'https://github.com/cloudcannon/configuration-types/releases/latest/download/cloudcannon-config.legacy-jekyll.schema.json'",
+		"build:legacy-hugo": "ts-json-schema-generator --markdown-description --no-top-ref --path src/build-coupled.d.ts --type HugoConfiguration --out dist/cloudcannon-config.legacy-hugo.schema.json --id 'https://github.com/cloudcannon/configuration-types/releases/latest/download/cloudcannon-config.legacy-hugo.schema.json'",
+		"build:legacy-eleventy": "ts-json-schema-generator --markdown-description --no-top-ref --path src/build-coupled.d.ts --type EleventyConfiguration --out dist/cloudcannon-config.legacy-eleventy.schema.json --id 'https://github.com/cloudcannon/configuration-types/releases/latest/download/cloudcannon-config.legacy-eleventy.schema.json'",
+		"build:legacy-reader": "ts-json-schema-generator --markdown-description --no-top-ref --path src/build-coupled.d.ts --type ReaderConfiguration --out dist/cloudcannon-config.legacy-reader.schema.json --id 'https://github.com/cloudcannon/configuration-types/releases/latest/download/cloudcannon-config.legacy-reader.schema.json'",
+		"lint": "npm run lint:tsc && npm run lint:format",
+		"lint:tsc": "tsc --noEmit",
+		"lint:format": "prettier -c src",
+		"format": "prettier -w src",
+		"site:dev": "http-server site -p 12345 -c-1",
+		"site:build": "cp dist/*.schema.json site/.",
+		"test": "exit 0"
+	},
+	"main": "./src/index.d.ts",
+	"types": "./src/index.d.ts",
+	"publishConfig": {
+		"access": "public"
+	},
+	"files": [
+		"src/**/*",
+		"dist/**/*"
+	],
+	"dependencies": {
+		"@cloudcannon/snippet-types": "^1.1.13",
+		"npm-run-all": "^4.1.5",
+		"ts-json-schema-generator": "^2.2.0"
+	},
+	"devDependencies": {
+		"@types/node": "^22.10.7",
+		"http-server": "^14.1.1",
+		"prettier": "^3.4.2",
+		"prettier-plugin-jsdoc": "^1.3.2",
+		"rimraf": "^6.0.1",
+		"typescript": "^5.7.3"
+	}
 }

package/src/build-coupled.d.ts

@@ -1,4 +1,5 @@
-import type { CollectionConfig, Configuration, DataConfigEntry, Paths } from './configuration';
+import type { CollectionConfig, Configuration, DataConfigEntry } from './configuration';
+import type { Paths } from './paths';
 
 export interface BuildCoupledPaths extends Paths {
 	/**
@@ -72,14 +73,38 @@ export interface ReaderCollectionConfig extends CollectionConfig, Parseable, Fil
 	 * for select and multiselect inputs.
 	 */
 	singular_key?: string;
+	/**
+	 * Specifies whether this collection's source files build to output files. Defaults to false.
+	 */
+	output?: boolean;
 }
 
 /**
  * The configuration format for build-coupled non-Jekyll/Hugo/Eleventy sites.
  */
-export interface ReaderConfiguration extends Configuration {
+export interface ReaderConfiguration extends Omit<Configuration, 'version'> {
+	/**
+	 * Controls which schema this file is validated against. Defaults to the latest schema.
+	 */
+	version: 'legacy-reader';
+	/**
+	 * 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`.
+	 */
 	paths?: BuildCoupledPaths;
+	/**
+	 * Controls what data sets are available to populate select and multiselect inputs.
+	 *
+	 * https://cloudcannon.com/documentation/articles/configuration-file-reference/#data_config
+	 */
 	data_config?: Record<string, DataConfigEntry & Parseable>;
+	/**
+	 * Definitions for your collections, which are the sets of content files for your site grouped by
+	 * folder. Entries are keyed by a chosen collection key, and contain configuration specific to
+	 * that collection.
+	 *
+	 * https://cloudcannon.com/documentation/articles/configuration-file-reference/#collections_config
+	 */
 	collections_config?: Record<string, ReaderCollectionConfig>;
 	/**
 	 * Generates the integration file in another folder. Not applicable to Jekyll, Hugo, and Eleventy.
@@ -89,7 +114,7 @@ export interface ReaderConfiguration extends Configuration {
 }
 
 export interface BuildCoupledCollectionConfig
-	extends Omit<CollectionConfig, 'url' | 'path'>,
+	extends Omit<CollectionConfig, 'url' | 'path' | 'disable_url'>,
 		Filterable {
 	/**
 	 * Overrides the default singular input key of the collection. This is used for naming conventions
@@ -100,13 +125,34 @@ export interface BuildCoupledCollectionConfig
 	 * The top-most folder where the files in this collection are stored. It is relative to `source`.
 	 */
 	path?: string;
+	/**
+	 * Specifies whether this collection's source files build to output files. Defaults to false.
+	 */
+	output?: boolean;
 }
 
 interface BuildCoupledConfiguration
-	extends Omit<Configuration, 'data_config' | 'collections_config'>,
+	extends Omit<Configuration, 'data_config' | 'collections_config' | 'version'>,
 		WithCollectionsConfigOverride {
+	/**
+	 * 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`.
+	 */
 	paths?: BuildCoupledPaths;
+	/**
+	 * Definitions for your collections, which are the sets of content files for your site grouped by
+	 * folder. Entries are keyed by a chosen collection key, and contain configuration specific to
+	 * that collection.
+	 *
+	 * https://cloudcannon.com/documentation/articles/configuration-file-reference/#collections_config
+	 */
 	collections_config?: BuildCoupledCollectionConfig;
+	/**
+	 * Controls what data sets are available to populate select and multiselect inputs.
+	 *
+	 * https://cloudcannon.com/documentation/articles/configuration-file-reference/#data_config
+	 */
+	data_config?: Record<string, boolean>;
 }
 
 /**
@@ -124,22 +170,66 @@ export interface HugoCollectionConfig extends BuildCoupledCollectionConfig {
  * The configuration format for build-coupled Hugo sites.
  */
 export interface HugoConfiguration extends BuildCoupledConfiguration {
+	/**
+	 * Controls which schema this file is validated against. Defaults to the latest schema.
+	 */
+	version: 'legacy-hugo';
+	/**
+	 * Definitions for your collections, which are the sets of content files for your site grouped by
+	 * folder. Entries are keyed by a chosen collection key, and contain configuration specific to
+	 * that collection.
+	 *
+	 * https://cloudcannon.com/documentation/articles/configuration-file-reference/#collections_config
+	 */
 	collections_config?: Record<string, HugoCollectionConfig>;
-	data_config?: Record<string, boolean>;
 }
 
 /**
  * The configuration format for build-coupled Jekyll sites.
  */
 export interface JekyllConfiguration extends BuildCoupledConfiguration {
+	/**
+	 * Controls which schema this file is validated against. Defaults to the latest schema.
+	 */
+	version: 'legacy-jekyll';
+	/**
+	 * Definitions for your collections, which are the sets of content files for your site grouped by
+	 * folder. Entries are keyed by a chosen collection key, and contain configuration specific to
+	 * that collection.
+	 *
+	 * https://cloudcannon.com/documentation/articles/configuration-file-reference/#collections_config
+	 */
 	collections_config?: Record<string, BuildCoupledCollectionConfig>;
-	data_config?: Record<string, boolean>;
 }
 
 /**
  * The configuration format for build-coupled Eleventy sites.
  */
-export type EleventyConfiguration = JekyllConfiguration;
+export interface EleventyConfiguration extends BuildCoupledConfiguration {
+	/**
+	 * Controls which schema this file is validated against. Defaults to the latest schema.
+	 */
+	version: 'legacy-eleventy';
+	/**
+	 * Definitions for your collections, which are the sets of content files for your site grouped by
+	 * folder. Entries are keyed by a chosen collection key, and contain configuration specific to
+	 * that collection.
+	 *
+	 * https://cloudcannon.com/documentation/articles/configuration-file-reference/#collections_config
+	 */
+	collections_config?: Record<string, BuildCoupledCollectionConfig>;
+}
+
+/**
+ * @discriminator version
+ */
+export type AnyLegacyConfiguration =
+	| HugoConfiguration
+	| JekyllConfiguration
+	| EleventyConfiguration
+	| ReaderConfiguration;
+
+export type AnyConfiguration = Configuration | AnyLegacyConfiguration;
 
 export type ParsedDataset =
 	| string[]
@@ -172,12 +262,6 @@ interface WithIntegrationOutput {
 	 * The time this file was generated.
 	 */
 	time?: string;
-	/**
-	 * The schema version of the integration output file.
-	 *
-	 * @deprecated No longer used.
-	 */
-	version?: string; // This refers to an old schema, replaced by the IntegrationOutput type.
 	/**
 	 * Details about the integration tool used to generate the integration output file.
 	 */

package/src/cascade.d.ts

@@ -0,0 +1,37 @@
+import type { Editables } from './editables';
+import type { Input } from './inputs';
+import type { SelectValues } from './select-values';
+import type { Structure } from './structures';
+
+export type EditorKey = 'visual' | 'content' | 'data';
+
+export interface ReducedCascade {
+	/**
+	 * Controls the behavior and appearance of your inputs in all data editing interfaces.
+	 */
+	_inputs?: Record<string, Input>;
+	/**
+	 * Fixed datasets that can be referenced by the _Values_ configuration for _Select_ and
+	 * _Multiselect_ inputs.
+	 */
+	_select_data?: Record<string, SelectValues>;
+	/**
+	 * Structured values for editors adding new items to arrays and objects. Entries here can be
+	 * referenced in the configuration for `array` or `object` inputs.
+	 */
+	_structures?: Record<string, Structure>;
+}
+
+export interface Cascade extends ReducedCascade {
+	/**
+	 * Set a preferred editor and/or disable the others. The first value sets which editor opens by
+	 * default, and the following values specify which editors are accessible.
+	 *
+	 * @uniqueItems
+	 */
+	_enabled_editors?: EditorKey[];
+	/**
+	 * Contains input options for Editable Regions and the Content Editor.
+	 */
+	_editables?: Editables;
+}

package/src/cloudcannon-config.schema.json

@@ -0,0 +1,79 @@
+{
+	"$id": "https://github.com/cloudcannon/configuration-types/releases/latest/download/cloudcannon-config.schema.json",
+	"$schema": "http://json-schema.org/draft-07/schema#",
+	"description": "Delegates to other schemas based on version.",
+	"type": "object",
+	"properties": {
+		"version": {
+			"enum": ["legacy-hugo", "legacy-jekyll", "legacy-eleventy", "legacy-reader", "latest"]
+		}
+	},
+	"allOf": [
+		{
+			"if": {
+				"properties": {
+					"version": {
+						"not": {
+							"enum": ["legacy-hugo", "legacy-jekyll", "legacy-eleventy", "legacy-reader"]
+						}
+					}
+				}
+			},
+			"then": {
+				"$ref": "cloudcannon-config.latest.schema.json"
+			}
+		},
+		{
+			"if": {
+				"properties": {
+					"version": {
+						"const": "legacy-hugo"
+					}
+				},
+				"required": ["version"]
+			},
+			"then": {
+				"$ref": "cloudcannon-config.legacy-hugo.schema.json"
+			}
+		},
+		{
+			"if": {
+				"properties": {
+					"version": {
+						"const": "legacy-jekyll"
+					}
+				},
+				"required": ["version"]
+			},
+			"then": {
+				"$ref": "cloudcannon-config.legacy-jekyll.schema.json"
+			}
+		},
+		{
+			"if": {
+				"properties": {
+					"version": {
+						"const": "legacy-eleventy"
+					}
+				},
+				"required": ["version"]
+			},
+			"then": {
+				"$ref": "cloudcannon-config.legacy-eleventy.schema.json"
+			}
+		},
+		{
+			"if": {
+				"properties": {
+					"version": {
+						"const": "legacy-reader"
+					}
+				},
+				"required": ["version"]
+			},
+			"then": {
+				"$ref": "cloudcannon-config.legacy-reader.schema.json"
+			}
+		}
+	]
+}