@sveltia/cms 0.82.1 → 0.84.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sveltia/cms",
-  "version": "0.82.1",
+  "version": "0.84.0",
   "description": "Sveltia CMS is a modern, lightweight, Git-based headless content management system.",
   "keywords": [
     "cms",

package/types/public.d.ts

@@ -873,12 +873,13 @@ export type RelationFieldProps = {
      */
     default?: any | any[];
     /**
-     * Referenced collection name.
+     * Referenced collection name. Use `_singletons` for the singleton
+     * collection.
      */
     collection: string;
     /**
-     * Referenced file identifier for a file collection. Required if the
-     * `collection` is a file collection.
+     * Referenced file identifier for a file/singleton collection. Required if
+     * the `collection` is defined.
      */
     file?: string;
     /**
@@ -1029,8 +1030,8 @@ export type I18nFileStructure = "single_file" | "multiple_files" | "multiple_fol
  */
 export type I18nOptions = {
     /**
-     * File structure for entry collections. File collections
-     * must define the structure using `{{locale}}` in the `file` option.
+     * File structure for entry collections. File/singleton
+     * collection must define the structure using `{{locale}}` in the `file` option.
      */
     structure: I18nFileStructure;
     /**
@@ -1069,14 +1070,14 @@ export type I18nOptions = {
     /**
      * Whether to exclude the default locale
      * from entry filenames. Default: `false`. This option applies to entry collections with the
-     * `multiple_files` i18n structure enabled, as well as to file collection items with the `file` path
-     * ending with `.{{locale}}.<extension>`, aiming to support Zola’s multilingual sites:
+     * `multiple_files` i18n structure enabled, as well as to file/singleton collection items with the
+     * `file` path ending with `.{{locale}}.<extension>`, aiming to support Zola’s multilingual sites:
      * https://www.getzola.org/documentation/content/multilingual/.
      */
     omit_default_locale_from_filename?: boolean;
 };
 /**
- * Single file in a file collection.
+ * Single file in a file/singleton collection.
  */
 export type CollectionFile = {
     /**
@@ -1087,6 +1088,11 @@ export type CollectionFile = {
      * Label to be displayed in the editor UI. Default: `name` option value.
      */
     label?: string;
+    /**
+     * Name of a Material Symbols icon to be displayed in the collection file
+     * list and other places.
+     */
+    icon?: string;
     /**
      * File path relative to the project root.
      */
@@ -1121,6 +1127,12 @@ export type CollectionFile = {
      * I18n options. Default: `false`.
      */
     i18n?: I18nOptions | boolean;
+    /**
+     * A special option to make this file a divider UI in the singleton
+     * file list. Default: `false`. Not supported in a file collection. If `true`, other options will be
+     * ignored, but you still have to provide a unique `name`.
+     */
+    divider?: boolean;
     /**
      * Preview URL path template.
      */
@@ -1277,9 +1289,20 @@ export type CollectionMetaData = {
  */
 export type CollectionIndexFile = {
     /**
-     * Index file name. Use `_index` for Hugo’s special index file.
+     * Index file name without a locale or file extension. Default: `_index`,
+     * which is used for Hugo’s special index file.
      */
-    name: string;
+    name?: string;
+    /**
+     * Label to be displayed in the editor UI. Default: Index File or its
+     * localized version.
+     */
+    label?: string;
+    /**
+     * Name of a Material Symbols icon to be displayed in the editor UI.
+     * Default: `home`.
+     */
+    icon?: string;
     /**
      * Set of fields for the index file. If omitted, the regular entry
      * collection `fields` will be used instead.
@@ -1455,7 +1478,8 @@ export type Collection = {
     yaml_quote?: boolean;
     /**
      * A special option to make this collection a divider UI in the
-     * collection list. Other options will be ignored, but you’ll still need `name`. Default: `false`.
+     * collection list. Default: `false`. If `true`, other options will be ignored, but you still have
+     * to provide a unique `name`.
      */
     divider?: boolean;
     /**
@@ -1747,6 +1771,12 @@ export type SiteConfig = {
      * Set of collections.
      */
     collections: Collection[];
+    /**
+     * Set of singleton files, such as the site configuration
+     * file or the homepage file. They are not part of any collection and can be accessed directly
+     * through the collection list.
+     */
+    singletons?: CollectionFile[];
     /**
      * Global i18n options.
      */