@cloudcannon/configuration-types 0.0.20 → 0.0.21

package/dist/cloudcannon-config.schema.json

@@ -4,63 +4,45 @@
   "additionalProperties": false,
   "definitions": {
     "AddOption": {
-      "anyOf": [
-        {
-          "additionalProperties": false,
-          "properties": {
-            "base_path": {
-              "description": "Enforces a path for new files to be created in, regardless of path the user is currently navigated to within the collection file list. Relative to the path of the collection defined in collection. Defaults to the path within the collection the user is currently navigated to.",
-              "markdownDescription": "Enforces a path for new files to be created in, regardless of path the user is currently\nnavigated to within the collection file list. Relative to the path of the collection\ndefined in collection. Defaults to the path within the collection the user is currently\nnavigated to.",
-              "type": "string"
-            },
-            "collection": {
-              "description": "Sets which collection this action is creating a file in. This is used when matching the value for schema. Defaults to the containing collection these `add_options` are configured in.",
-              "markdownDescription": "Sets which collection this action is creating a file in. This is used when matching the\nvalue for schema. Defaults to the containing collection these `add_options` are configured\nin.",
-              "type": "string"
-            },
-            "default_content_file": {
-              "description": "The path to a file used to populate the initial contents of a new file if no schemas are configured. We recommend using schemas, and this is ignored if a schema is available.",
-              "markdownDescription": "The path to a file used to populate the initial contents of a new file if no schemas are\nconfigured. We recommend using schemas, and this is ignored if a schema is available.",
-              "type": "string"
-            },
-            "editor": {
-              "$ref": "#/definitions/EditorKey",
-              "description": "The editor to open the new file in. Defaults to an appropriate editor for new file's type if possible. If no default editor can be calculated, or the editor does not support the new file type, a warning is shown in place of the editor.",
-              "markdownDescription": "The editor to open the new file in. Defaults to an appropriate editor for new file's type\nif possible. If no default editor can be calculated, or the editor does not support the new\nfile type, a warning is shown in place of the editor."
-            },
-            "icon": {
-              "$ref": "#/definitions/Icon",
-              "description": "The icon next to the text in the menu item. Defaults to using icon from the matching schema if set, then falls back to add.",
-              "markdownDescription": "The icon next to the text in the menu item. Defaults to using icon from the matching schema\nif set, then falls back to add."
-            },
-            "name": {
-              "description": "The text displayed for the menu item. Defaults to using name from the matching schema if set.",
-              "markdownDescription": "The text displayed for the menu item. Defaults to using name from the matching schema if\nset.",
-              "type": "string"
-            },
-            "schema": {
-              "description": "The schema that new files are created from with this action. This schema is not restricted to the containing collection, and is instead relative to the collection specified with collection. Defaults to default if schemas are configured for the collection.",
-              "markdownDescription": "The schema that new files are created from with this action. This schema is not restricted\nto the containing collection, and is instead relative to the collection specified with\ncollection. Defaults to default if schemas are configured for the collection.",
-              "type": "string"
-            }
-          },
-          "type": "object"
+      "additionalProperties": false,
+      "properties": {
+        "base_path": {
+          "description": "Enforces a path for new files to be created in, regardless of path the user is currently navigated to within the collection file list. Relative to the path of the collection defined in collection. Defaults to the path within the collection the user is currently navigated to.",
+          "markdownDescription": "Enforces a path for new files to be created in, regardless of path the user is currently\nnavigated to within the collection file list. Relative to the path of the collection defined in\ncollection. Defaults to the path within the collection the user is currently navigated to.",
+          "type": "string"
         },
-        {
-          "additionalProperties": false,
-          "properties": {
-            "href": {
-              "description": "The link that opens when the option is clicked. Can either be an external or internal link. If internal, the link is relative to the current site.",
-              "markdownDescription": "The link that opens when the option is clicked. Can either be an external or internal link.\nIf internal, the link is relative to the current site.",
-              "type": "string"
-            }
-          },
-          "required": [
-            "href"
-          ],
-          "type": "object"
+        "collection": {
+          "description": "Sets which collection this action is creating a file in. This is used when matching the value for schema. Defaults to the containing collection these `add_options` are configured in.",
+          "markdownDescription": "Sets which collection this action is creating a file in. This is used when matching the value\nfor schema. Defaults to the containing collection these `add_options` are configured in.",
+          "type": "string"
+        },
+        "default_content_file": {
+          "description": "The path to a file used to populate the initial contents of a new file if no schemas are configured. We recommend using schemas, and this is ignored if a schema is available.",
+          "markdownDescription": "The path to a file used to populate the initial contents of a new file if no schemas are\nconfigured. We recommend using schemas, and this is ignored if a schema is available.",
+          "type": "string"
+        },
+        "editor": {
+          "$ref": "#/definitions/EditorKey",
+          "description": "The editor to open the new file in. Defaults to an appropriate editor for new file's type if possible. If no default editor can be calculated, or the editor does not support the new file type, a warning is shown in place of the editor.",
+          "markdownDescription": "The editor to open the new file in. Defaults to an appropriate editor for new file's type if\npossible. If no default editor can be calculated, or the editor does not support the new file\ntype, a warning is shown in place of the editor."
+        },
+        "icon": {
+          "$ref": "#/definitions/Icon",
+          "description": "The icon next to the text in the menu item. Defaults to using icon from the matching schema if set, then falls back to add.",
+          "markdownDescription": "The icon next to the text in the menu item. Defaults to using icon from the matching schema if\nset, then falls back to add."
+        },
+        "name": {
+          "description": "The text displayed for the menu item. Defaults to using name from the matching schema if set.",
+          "markdownDescription": "The text displayed for the menu item. Defaults to using name from the matching schema if set.",
+          "type": "string"
+        },
+        "schema": {
+          "description": "The schema that new files are created from with this action. This schema is not restricted to the containing collection, and is instead relative to the collection specified with collection. Defaults to default if schemas are configured for the collection.",
+          "markdownDescription": "The schema that new files are created from with this action. This schema is not restricted to\nthe containing collection, and is instead relative to the collection specified with collection.\nDefaults to default if schemas are configured for the collection.",
+          "type": "string"
         }
-      ]
+      },
+      "type": "object"
     },
     "ArrayInput": {
       "additionalProperties": false,
@@ -876,7 +858,14 @@
         "add_options": {
           "description": "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 schemas are configured.",
           "items": {
-            "$ref": "#/definitions/AddOption"
+            "anyOf": [
+              {
+                "$ref": "#/definitions/AddOption"
+              },
+              {
+                "$ref": "#/definitions/HrefAddOption"
+              }
+            ]
           },
           "markdownDescription": "Changes the options presented in the add menu in the collection file list. Defaults to an\nautomatically generated list from _Schemas_, or uses the first file in the collection if no\nschemas are configured.",
           "type": "array"
@@ -1614,6 +1603,31 @@
       },
       "type": "object"
     },
+    "HrefAddOption": {
+      "additionalProperties": false,
+      "properties": {
+        "href": {
+          "description": "The link that opens when the option is clicked. Can either be an external or internal link. If internal, the link is relative to the current site.",
+          "markdownDescription": "The link that opens when the option is clicked. Can either be an external or internal link. If\ninternal, the link is relative to the current site.",
+          "type": "string"
+        },
+        "icon": {
+          "$ref": "#/definitions/Icon",
+          "default": "add",
+          "description": "The icon next to the text in the menu item.",
+          "markdownDescription": "The icon next to the text in the menu item."
+        },
+        "name": {
+          "description": "The text displayed for the menu item.",
+          "markdownDescription": "The text displayed for the menu item.",
+          "type": "string"
+        }
+      },
+      "required": [
+        "href"
+      ],
+      "type": "object"
+    },
     "Icon": {
       "enum": [
         "10k",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloudcannon/configuration-types",
-  "version": "0.0.20",
+  "version": "0.0.21",
   "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

@@ -88,18 +88,25 @@ export interface ReaderConfiguration extends Configuration {
 	output?: string;
 }
 
-export interface BuildCoupledCollectionConfig extends Omit<CollectionConfig, 'url'>, Filterable {
+export interface BuildCoupledCollectionConfig
+	extends Omit<CollectionConfig, 'url' | 'path'>,
+		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 top-most folder where the files in this collection are stored. It is relative to `source`.
+	 */
+	path?: string;
 }
 
 interface BuildCoupledConfiguration
-	extends Omit<Configuration, 'data_config'>,
+	extends Omit<Configuration, 'data_config' | 'collections_config'>,
 		WithCollectionsConfigOverride {
 	paths?: BuildCoupledPaths;
+	collections_config?: BuildCoupledCollectionConfig;
 }
 
 /**

package/src/configuration.d.ts

@@ -1269,56 +1269,63 @@ export interface Preview
 	gallery?: PreviewGallery;
 }
 
-export type AddOption =
-	| {
-			/**
-			 * The text displayed for the menu item. Defaults to using name from the matching schema if
-			 * set.
-			 */
-			name?: string;
-			/**
-			 * The icon next to the text in the menu item. Defaults to using icon from the matching schema
-			 * if set, then falls back to add.
-			 */
-			icon?: Icon;
-			/**
-			 * The editor to open the new file in. Defaults to an appropriate editor for new file's type
-			 * if possible. If no default editor can be calculated, or the editor does not support the new
-			 * file type, a warning is shown in place of the editor.
-			 */
-			editor?: EditorKey;
-			/**
-			 * Enforces a path for new files to be created in, regardless of path the user is currently
-			 * navigated to within the collection file list. Relative to the path of the collection
-			 * defined in collection. Defaults to the path within the collection the user is currently
-			 * navigated to.
-			 */
-			base_path?: string;
-			/**
-			 * Sets which collection this action is creating a file in. This is used when matching the
-			 * value for schema. Defaults to the containing collection these `add_options` are configured
-			 * in.
-			 */
-			collection?: string;
-			/**
-			 * The schema that new files are created from with this action. This schema is not restricted
-			 * to the containing collection, and is instead relative to the collection specified with
-			 * collection. Defaults to default if schemas are configured for the collection.
-			 */
-			schema?: string;
-			/**
-			 * The path to a file used to populate the initial contents of a new file if no schemas are
-			 * configured. We recommend using schemas, and this is ignored if a schema is available.
-			 */
-			default_content_file?: string;
-	  }
-	| {
-			/**
-			 * The link that opens when the option is clicked. Can either be an external or internal link.
-			 * If internal, the link is relative to the current site.
-			 */
-			href: string;
-	  };
+export type HrefAddOption = {
+	/**
+	 * The text displayed for the menu item.
+	 */
+	name?: string;
+	/**
+	 * The icon next to the text in the menu item.
+	 *
+	 * @default add
+	 */
+	icon?: Icon;
+	/**
+	 * The link that opens when the option is clicked. Can either be an external or internal link. If
+	 * internal, the link is relative to the current site.
+	 */
+	href: string;
+};
+
+export type AddOption = {
+	/**
+	 * The text displayed for the menu item. Defaults to using name from the matching schema if set.
+	 */
+	name?: string;
+	/**
+	 * The icon next to the text in the menu item. Defaults to using icon from the matching schema if
+	 * set, then falls back to add.
+	 */
+	icon?: Icon;
+	/**
+	 * The editor to open the new file in. Defaults to an appropriate editor for new file's type if
+	 * possible. If no default editor can be calculated, or the editor does not support the new file
+	 * type, a warning is shown in place of the editor.
+	 */
+	editor?: EditorKey;
+	/**
+	 * Enforces a path for new files to be created in, regardless of path the user is currently
+	 * navigated to within the collection file list. Relative to the path of the collection defined in
+	 * collection. Defaults to the path within the collection the user is currently navigated to.
+	 */
+	base_path?: string;
+	/**
+	 * Sets which collection this action is creating a file in. This is used when matching the value
+	 * for schema. Defaults to the containing collection these `add_options` are configured in.
+	 */
+	collection?: string;
+	/**
+	 * The schema that new files are created from with this action. This schema is not restricted to
+	 * the containing collection, and is instead relative to the collection specified with collection.
+	 * Defaults to default if schemas are configured for the collection.
+	 */
+	schema?: string;
+	/**
+	 * The path to a file used to populate the initial contents of a new file if no schemas are
+	 * configured. We recommend using schemas, and this is ignored if a schema is available.
+	 */
+	default_content_file?: string;
+};
 
 interface WithPreview {
 	/**
@@ -1488,7 +1495,7 @@ export interface CollectionConfig extends Cascade, WithPreview {
 	 * automatically generated list from _Schemas_, or uses the first file in the collection if no
 	 * schemas are configured.
 	 */
-	add_options?: AddOption[];
+	add_options?: (AddOption | HrefAddOption)[];
 	/**
 	 * The create path definition to control where new files are saved to inside this collection.
 	 * Defaults to [relative_base_path]/{title|slugify}.md.