@cloudcannon/configuration-types - npm Package Compare versions

Comparing version 0.0.10 to 0.0.11

package.json

 {
   "name": "@cloudcannon/configuration-types",
-  "version": "0.0.10",
+  "version": "0.0.11",
   "description": "Contains TypeScript declarations and generates JSONSchema files for the CloudCannon configuration file.",
@@ -5,0 +5,0 @@ "author": "CloudCannon <[e-mail]>",

src/build-coupled.d.ts

@@ -1,3 +0,23 @@
-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';
@@ -23,2 +43,9 @@
 
+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 {
@@ -43,3 +70,9 @@ /**
  */
-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;
+}
 
@@ -50,2 +83,4 @@ /**
 export interface ReaderConfiguration extends Configuration {
+	paths?: BuildCoupledPaths;
+	data_config?: Record<string, DataConfigEntry & Parseable>;
 	collections_config?: Record<string, ReaderCollectionConfig>;
@@ -59,7 +94,15 @@ /**
 
-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;
+}
 
@@ -66,0 +109,0 @@ /**

src/configuration.d.ts

@@ -12,3 +12,9 @@ import Scrapbooker from '@cloudcannon/snippet-types';
 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';
 
@@ -44,3 +50,5 @@ export type MarkdownAttributeElementOptions = {
 		/**
-		 * 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).
 		 */
@@ -96,7 +104,7 @@ quotes?: string;
 		attributes?: boolean;
-		/** 
+		/**
 		 * Define positioning behaviour of Markdown attributes for different elements.
-		 */ 
+		 */
 		attribute_elements?: MarkdownAttributeElementOptions;
-	}
+	};
 }
@@ -394,3 +402,3 @@
 
-interface WithReducedPaths {
+interface WithPaths {
 	/**
@@ -401,10 +409,10 @@ * Paths to where new asset files are uploaded to. They also set the default path when choosing
 	 */
-	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 {
 	/**
@@ -728,3 +736,3 @@ * Enables a control to set selected text to bold.
 
-export interface UrlInputOptions extends BaseInputOptions, WithReducedPaths {}
+export interface UrlInputOptions extends BaseInputOptions, WithPaths {}
 
@@ -762,3 +770,3 @@ export interface UrlInput extends BaseInput<UrlInputOptions> {
 
-export interface FileInputOptions extends BaseInputOptions, WithReducedPaths {
+export interface FileInputOptions extends BaseInputOptions, WithPaths {
 	/**
@@ -950,3 +958,3 @@ * Restricts which file types are available to select or upload to this input.
 
-export interface ReducedPaths {
+export interface Paths {
 	/**
@@ -991,22 +999,2 @@ * Location of assets that are statically copied to the output site. This prefix will be removed
 
-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 {
@@ -1290,7 +1278,2 @@ /**
 	/**
-	 * 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
@@ -1444,11 +1427,4 @@ * automatically generated list from _Schemas_, or uses the first file in the collection if no
 
-export interface Parseable {
+export interface DataConfigEntry {
 	/**
-	 * 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 {
-	/**
 	 * The path to a file or folder of files containing data.
@@ -1537,7 +1513,6 @@ */
 	| 'static'
-	| 'other'
 	| 'legacy'
-	| 'unknown';
+	| 'other';
 
-export interface Configuration extends Cascade, WithSnippets {
+export interface Configuration extends Cascade, WithSnippets, WithPaths {
 	/**
@@ -1548,6 +1523,2 @@ * Base path to your site source files, relative to the root folder.
 	/**
-	 * Global paths to common folders.
-	 */
-	paths?: Paths;
-	/**
 	 * Definitions for your collections, which are the sets of content files for your site grouped by
@@ -1554,0 +1525,0 @@ * folder. Entries are keyed by a chosen collection key, and contain configuration specific to

No alert changes

Worsened metrics

Total package byte prevSize

1861121

decreased by-0.13%

Lines of code

48717

decreased by-0.15%

No dependency changes