@cloudcannon/configuration-types 0.0.10 → 0.0.12

package/build/cloudcannon-config.json

@@ -402,7 +402,7 @@
           "type": "boolean"
         },
         "paths": {
-          "$ref": "#/definitions/ReducedPaths",
+          "$ref": "#/definitions/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`.",
           "markdownDescription": "Paths to where new asset files are uploaded to. They also set the default path when choosing\nexisting images, and linking to existing files. Each path is relative to global `source`.\nDefaults to the global `paths`."
         },
@@ -918,11 +918,6 @@
           "markdownDescription": "The set of schemas for this collection. Schemas are used when creating and editing files in\nthis collection. Each entry corresponds to a schema that describes a data structure for this\ncollection.\n\nThe keys in this object should match the values used for schema_key inside each of this\ncollection's files. default is a special entry and is used when a file has no schema.",
           "type": "object"
         },
-        "singular_key": {
-          "description": "Overrides the default singular input key of the collection. This is used for naming conventions for select and multiselect inputs.",
-          "markdownDescription": "Overrides the default singular input key of the collection. This is used for naming conventions\nfor select and multiselect inputs.",
-          "type": "string"
-        },
         "singular_name": {
           "description": "Overrides the default singular display name of the collection. This is displayed in the collection add menu and file context menu.",
           "markdownDescription": "Overrides the default singular display name of the collection. This is displayed in the\ncollection add menu and file context menu.",
@@ -1269,8 +1264,8 @@
         },
         "paths": {
           "$ref": "#/definitions/Paths",
-          "description": "Global paths to common folders.",
-          "markdownDescription": "Global paths to common folders."
+          "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`.",
+          "markdownDescription": "Paths to where new asset files are uploaded to. They also set the default path when choosing\nexisting images, and linking to existing files. Each path is relative to global `source`.\nDefaults to the global `paths`."
         },
         "source": {
           "description": "Base path to your site source files, relative to the root folder.",
@@ -1345,19 +1340,6 @@
     "DataConfigEntry": {
       "additionalProperties": false,
       "properties": {
-        "parser": {
-          "description": "Overrides the format files are read. Detected automatically from file extension if unset.",
-          "enum": [
-            "csv",
-            "front-matter",
-            "json",
-            "properties",
-            "toml",
-            "yaml"
-          ],
-          "markdownDescription": "Overrides the format files are read. Detected automatically from file extension if unset.",
-          "type": "string"
-        },
         "path": {
           "description": "The path to a file or folder of files containing data.",
           "markdownDescription": "The path to a file or folder of files containing data.",
@@ -1779,7 +1761,7 @@
           "markdownDescription": "Set how an ‘empty’ value will be saved. Does not apply to existing empty values."
         },
         "paths": {
-          "$ref": "#/definitions/ReducedPaths",
+          "$ref": "#/definitions/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`.",
           "markdownDescription": "Paths to where new asset files are uploaded to. They also set the default path when choosing\nexisting images, and linking to existing files. Each path is relative to global `source`.\nDefaults to the global `paths`."
         }
@@ -3953,7 +3935,7 @@
           "type": "string"
         },
         "paths": {
-          "$ref": "#/definitions/ReducedPaths",
+          "$ref": "#/definitions/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`.",
           "markdownDescription": "Paths to where new asset files are uploaded to. They also set the default path when choosing\nexisting images, and linking to existing files. Each path is relative to global `source`.\nDefaults to the global `paths`."
         },
@@ -4148,7 +4130,7 @@
           "type": "string"
         },
         "paths": {
-          "$ref": "#/definitions/ReducedPaths",
+          "$ref": "#/definitions/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`.",
           "markdownDescription": "Paths to where new asset files are uploaded to. They also set the default path when choosing\nexisting images, and linking to existing files. Each path is relative to global `source`.\nDefaults to the global `paths`."
         },
@@ -4306,7 +4288,7 @@
       "additionalProperties": false,
       "properties": {
         "paths": {
-          "$ref": "#/definitions/ReducedPaths",
+          "$ref": "#/definitions/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`.",
           "markdownDescription": "Paths to where new asset files are uploaded to. They also set the default path when choosing\nexisting images, and linking to existing files. Each path is relative to global `source`.\nDefaults to the global `paths`."
         }
@@ -4725,7 +4707,7 @@
             },
             "quotes": {
               "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).",
-              "markdownDescription": "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).",
+              "markdownDescription": "Double + single quotes replacement pairs, when typographer enabled and smartquotes on. For\nexample, you can use '«»„“' for Russian, '„“‚‘' for German, and ['«\\xA0', '\\xA0»', '‹\\xA0',\n'\\xA0›'] for French (including nbsp).",
               "type": "string"
             },
             "sentence_per_line": {
@@ -5783,11 +5765,6 @@
     "Paths": {
       "additionalProperties": false,
       "properties": {
-        "collections": {
-          "description": "Parent folder of all collections.",
-          "markdownDescription": "Parent folder of all collections.",
-          "type": "string"
-        },
         "dam_static": {
           "default": "",
           "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.",
@@ -5805,21 +5782,6 @@
           "markdownDescription": "Filename template for newly uploaded DAM files.",
           "type": "string"
         },
-        "data": {
-          "description": "Parent folder of all site data files.",
-          "markdownDescription": "Parent folder of all site data files.",
-          "type": "string"
-        },
-        "includes": {
-          "description": "Parent folder of all includes, partials, or shortcode files. _Only applies to Jekyll, Hugo, and Eleventy sites_.",
-          "markdownDescription": "Parent folder of all includes, partials, or shortcode files. _Only applies to Jekyll, Hugo, and\nEleventy sites_.",
-          "type": "string"
-        },
-        "layouts": {
-          "description": "Parent folder of all site layout files. _Only applies to Jekyll, Hugo, and Eleventy sites_.",
-          "markdownDescription": "Parent folder of all site layout files. _Only applies to Jekyll, Hugo, and Eleventy sites_.",
-          "type": "string"
-        },
         "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.",
           "markdownDescription": "Location of assets that are statically copied to the output site. This prefix will be removed\nfrom the _Uploads_ path when CloudCannon outputs the URL of an asset.",
@@ -6103,50 +6065,6 @@
       ],
       "type": "object"
     },
-    "ReducedPaths": {
-      "additionalProperties": false,
-      "properties": {
-        "dam_static": {
-          "default": "",
-          "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.",
-          "markdownDescription": "Location of statically copied assets for DAM files. This prefix will be removed from the _DAM\nUploads_ path when CloudCannon outputs the URL of an asset.",
-          "type": "string"
-        },
-        "dam_uploads": {
-          "default": "",
-          "description": "Default location of newly uploaded DAM files.",
-          "markdownDescription": "Default location of newly uploaded DAM files.",
-          "type": "string"
-        },
-        "dam_uploads_filename": {
-          "description": "Filename template for newly uploaded DAM files.",
-          "markdownDescription": "Filename template for newly uploaded DAM files.",
-          "type": "string"
-        },
-        "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.",
-          "markdownDescription": "Location of assets that are statically copied to the output site. This prefix will be removed\nfrom the _Uploads_ path when CloudCannon outputs the URL of an asset.",
-          "type": "string"
-        },
-        "uploads": {
-          "default": "uploads",
-          "description": "Default location of newly uploaded site files.",
-          "markdownDescription": "Default location of newly uploaded site files.",
-          "type": "string"
-        },
-        "uploads_filename": {
-          "description": "Filename template for newly uploaded site files.",
-          "markdownDescription": "Filename template for newly uploaded site files.",
-          "type": "string"
-        },
-        "uploads_use_relative_path": {
-          "description": "When set to true, CloudCannon will reference files relative to the path of the file they were uploaded to.",
-          "markdownDescription": "When set to true, CloudCannon will reference files relative to the path of the file they were\nuploaded to.",
-          "type": "boolean"
-        }
-      },
-      "type": "object"
-    },
     "RichTextInput": {
       "additionalProperties": false,
       "properties": {
@@ -6385,7 +6303,7 @@
           "type": "boolean"
         },
         "paths": {
-          "$ref": "#/definitions/ReducedPaths",
+          "$ref": "#/definitions/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`.",
           "markdownDescription": "Paths to where new asset files are uploaded to. They also set the default path when choosing\nexisting images, and linking to existing files. Each path is relative to global `source`.\nDefaults to the global `paths`."
         },
@@ -7727,7 +7645,7 @@
           "type": "boolean"
         },
         "paths": {
-          "$ref": "#/definitions/ReducedPaths",
+          "$ref": "#/definitions/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`.",
           "markdownDescription": "Paths to where new asset files are uploaded to. They also set the default path when choosing\nexisting images, and linking to existing files. Each path is relative to global `source`.\nDefaults to the global `paths`."
         },
@@ -7872,6 +7790,11 @@
           "description": "Set how an ‘empty’ value will be saved. Does not apply to existing empty values.",
           "markdownDescription": "Set how an ‘empty’ value will be saved. Does not apply to existing empty values."
         },
+        "icon": {
+          "$ref": "#/definitions/Icon",
+          "description": "Icon shown beside the input.",
+          "markdownDescription": "Icon shown beside the input."
+        },
         "placeholder": {
           "description": "Text shown when this input has no value.",
           "markdownDescription": "Text shown when this input has no value.",
@@ -8690,7 +8613,7 @@
           "markdownDescription": "Set how an ‘empty’ value will be saved. Does not apply to existing empty values."
         },
         "paths": {
-          "$ref": "#/definitions/ReducedPaths",
+          "$ref": "#/definitions/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`.",
           "markdownDescription": "Paths to where new asset files are uploaded to. They also set the default path when choosing\nexisting images, and linking to existing files. Each path is relative to global `source`.\nDefaults to the global `paths`."
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloudcannon/configuration-types",
-  "version": "0.0.10",
+  "version": "0.0.12",
   "description": "Contains TypeScript declarations and generates JSONSchema files for the CloudCannon configuration file.",
   "author": "CloudCannon <support@cloudcannon.com>",
   "license": "MIT",

package/src/build-coupled.d.ts

@@ -1,4 +1,24 @@
-import { CollectionConfig, Configuration, Parseable } from './configuration';
+import { CollectionConfig, Configuration, DataConfigEntry, Paths } from './configuration';
+
+export interface BuildCoupledPaths extends Paths {
+	/**
+	 * Parent folder of all collections.
+	 */
+	collections?: string;
+	/**
+	 * Parent folder of all site data files.
+	 */
+	data?: string;
+	/**
+	 * Parent folder of all site layout files. _Only applies to Jekyll, Hugo, and Eleventy sites_.
+	 */
+	layouts?: string;
+	/**
+	 * Parent folder of all includes, partials, or shortcode files. _Only applies to Jekyll, Hugo, and
+	 * Eleventy sites_.
+	 */
+	includes?: string;
+}
 
 export type FilterBase = 'none' | 'all' | 'strict';
 
@@ -20,6 +40,13 @@ export interface Filter {
 	exclude?: string[];
 }
 
+interface Parseable {
+	/**
+	 * Overrides the format files are read. Detected automatically from file extension if unset.
+	 */
+	parser?: 'csv' | 'front-matter' | 'json' | 'properties' | 'toml' | 'yaml';
+}
+
 interface Filterable {
 	/**
 	 * Controls which files are displayed in the collection list. Does not change which files are
@@ -39,12 +66,20 @@ interface WithCollectionsConfigOverride {
 /**
  * The `collections_config` entry format for build-coupled non-Jekyll/Hugo/Eleventy sites.
  */
-export interface ReaderCollectionConfig extends CollectionConfig, Parseable, Filterable {}
+export interface ReaderCollectionConfig extends CollectionConfig, Parseable, Filterable {
+	/**
+	 * Overrides the default singular input key of the collection. This is used for naming conventions
+	 * for select and multiselect inputs.
+	 */
+	singular_key?: string;
+}
 
 /**
  * The configuration format for build-coupled non-Jekyll/Hugo/Eleventy sites.
  */
 export interface ReaderConfiguration extends Configuration {
+	paths?: BuildCoupledPaths;
+	data_config?: Record<string, DataConfigEntry & Parseable>;
 	collections_config?: Record<string, ReaderCollectionConfig>;
 	/**
 	 * Generates the integration file in another folder. Not applicable to Jekyll, Hugo, and Eleventy.
@@ -53,11 +88,19 @@ export interface ReaderConfiguration extends Configuration {
 	output?: string;
 }
 
-export interface BuildCoupledCollectionConfig extends Omit<CollectionConfig, 'url'>, Filterable {}
+export interface BuildCoupledCollectionConfig extends Omit<CollectionConfig, 'url'>, Filterable {
+	/**
+	 * Overrides the default singular input key of the collection. This is used for naming conventions
+	 * for select and multiselect inputs.
+	 */
+	singular_key?: string;
+}
 
 interface BuildCoupledConfiguration
 	extends Omit<Configuration, 'data_config'>,
-		WithCollectionsConfigOverride {}
+		WithCollectionsConfigOverride {
+	paths?: BuildCoupledPaths;
+}
 
 /**
  * The `collections_config` entry format for build-coupled Hugo sites.

package/src/configuration.d.ts

@@ -9,7 +9,13 @@ import type { Syntax } from './syntax';
 export type InstanceValue = 'UUID' | 'NOW';
 export type EditorKey = 'visual' | 'content' | 'data';
 export type SortOrder = 'ascending' | 'descending' | 'asc' | 'desc';
-export type AttributeListPosition = 'none' | 'right' | 'space right' | 'below' | 'newline below' | 'right-of-prefix';
+export type AttributeListPosition =
+	| 'none'
+	| 'right'
+	| 'space right'
+	| 'below'
+	| 'newline below'
+	| 'right-of-prefix';
 
 export type MarkdownAttributeElementOptions = {
 	inline?: AttributeListPosition;
@@ -40,7 +46,9 @@ export interface MarkdownSettings {
 		 */
 		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).
+		 * 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;
 		/**
@@ -91,11 +99,11 @@ export interface MarkdownSettings {
 		 * Save element attributes in Markdown format instead of converting to HTML.
 		 */
 		attributes?: boolean;
-		/** 
+		/**
 		 * Define positioning behaviour of Markdown attributes for different elements.
-		 */ 
+		 */
 		attribute_elements?: MarkdownAttributeElementOptions;
-	}
+	};
 }
 
 // TODO: use SnippetConfig from @cloudcannon/scrap-booker when ParserConfig issue resolved.
@@ -388,20 +396,20 @@ export interface BlockEditable extends ImageResizeable, TextEditable {
 	table?: boolean;
 }
 
-interface WithReducedPaths {
+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?: ReducedPaths;
+	paths?: Paths;
 }
 
-export interface ImageEditable extends ImageResizeable, WithReducedPaths {}
+export interface ImageEditable extends ImageResizeable, WithPaths {}
 
-export interface LinkEditable extends WithReducedPaths {}
+export interface LinkEditable extends WithPaths {}
 
-export interface TextEditable extends WithReducedPaths {
+export interface TextEditable extends WithPaths {
 	/**
 	 * Enables a control to set selected text to bold.
 	 */
@@ -621,6 +629,10 @@ export interface TextInputOptions extends BaseInputOptions {
 	 * Text shown when this input has no value.
 	 */
 	placeholder?: string;
+	/**
+	 * Icon shown beside the input.
+	 */
+	icon?: Icon;
 }
 
 export interface TextInput extends BaseInput<TextInputOptions> {
@@ -720,7 +732,7 @@ export interface RangeInput extends BaseInput<RangeInputOptions> {
 	type: 'range';
 }
 
-export interface UrlInputOptions extends BaseInputOptions, WithReducedPaths {}
+export interface UrlInputOptions extends BaseInputOptions, WithPaths {}
 
 export interface UrlInput extends BaseInput<UrlInputOptions> {
 	type: 'range';
@@ -753,7 +765,7 @@ export interface DateInput extends BaseInput<DateInputOptions> {
 	type: 'date' | 'datetime';
 }
 
-export interface FileInputOptions extends BaseInputOptions, WithReducedPaths {
+export interface FileInputOptions extends BaseInputOptions, WithPaths {
 	/**
 	 * Restricts which file types are available to select or upload to this input.
 	 */
@@ -940,7 +952,7 @@ export type Input =
 	| ObjectInput
 	| ArrayInput;
 
-export interface ReducedPaths {
+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.
@@ -980,26 +992,6 @@ export interface ReducedPaths {
 	uploads_use_relative_path?: boolean;
 }
 
-export interface Paths extends ReducedPaths {
-	/**
-	 * Parent folder of all collections.
-	 */
-	collections?: string;
-	/**
-	 * Parent folder of all site data files.
-	 */
-	data?: string;
-	/**
-	 * Parent folder of all site layout files. _Only applies to Jekyll, Hugo, and Eleventy sites_.
-	 */
-	layouts?: string;
-	/**
-	 * Parent folder of all includes, partials, or shortcode files. _Only applies to Jekyll, Hugo, and
-	 * Eleventy sites_.
-	 */
-	includes?: string;
-}
-
 export interface Documentation {
 	/**
 	 * The "href" value of the link.
@@ -1277,11 +1269,6 @@ export interface CollectionConfig extends Cascade, Previewable {
 	 * collection add menu and file context menu.
 	 */
 	singular_name?: string;
-	/**
-	 * Overrides the default singular input key of the collection. This is used for naming conventions
-	 * for select and multiselect inputs.
-	 */
-	singular_key?: string;
 	/**
 	 * Changes the options presented in the add menu in the collection file list. Defaults to an
 	 * automatically generated list from _Schemas_, or uses the first file in the collection if no
@@ -1431,14 +1418,7 @@ export type SelectValues =
 	| Record<string, string>
 	| Record<string, Record<string, any>>;
 
-export interface Parseable {
-	/**
-	 * Overrides the format files are read. Detected automatically from file extension if unset.
-	 */
-	parser?: 'csv' | 'front-matter' | 'json' | 'properties' | 'toml' | 'yaml';
-}
-
-export interface DataConfigEntry extends Parseable {
+export interface DataConfigEntry {
 	/**
 	 * The path to a file or folder of files containing data.
 	 */
@@ -1523,19 +1503,14 @@ export type SsgKey =
 	| 'nuxtjs'
 	| 'sphinx'
 	| 'static'
-	| 'other'
 	| 'legacy'
-	| 'unknown';
+	| 'other';
 
-export interface Configuration extends Cascade, WithSnippets {
+export interface Configuration extends Cascade, WithSnippets, WithPaths {
 	/**
 	 * Base path to your site source files, relative to the root folder.
 	 */
 	source?: string;
-	/**
-	 * Global paths to common folders.
-	 */
-	paths?: Paths;
 	/**
 	 * 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