@sveltia/cms 0.87.2 → 0.87.3

package/types/public.d.ts

@@ -36,7 +36,7 @@ export type RasterImageTransformationOptions = {
      */
     format?: RasterImageConversionFormat;
     /**
-     * Image quality between 0 and 100. Default: 85.
+     * Image quality between 0 and 100. Default: `85`.
      */
     quality?: number;
     /**
@@ -154,7 +154,7 @@ export type CloudinaryMediaLibrary = {
      */
     use_secure_url?: boolean;
     /**
-     * Options to be passed to Uploadcare, such as `multiple`.
+     * Options to be passed to Cloudinary, such as `multiple`.
      * The `cloud_name` and `api_key` options are required for the global `media_library` option. See
      * https://cloudinary.com/documentation/media_library_widget#2_set_the_configuration_options for a
      * full list of available options.
@@ -233,9 +233,9 @@ export type MediaLibraries = {
     stock_assets?: StockAssetMediaLibrary;
 };
 /**
- * Common field properties.
+ * Base field properties that are common to all fields.
  */
-export type CommonFieldProps = {
+export type BaseFieldProps = {
     /**
      * Unique identifier for the field. It cannot include periods and spaces.
      */
@@ -250,10 +250,32 @@ export type CommonFieldProps = {
      */
     comment?: string;
     /**
-     * Name of a widget that defines the input UI and data type. Default:
-     * `string`.
+     * Help message to be displayed below the input UI. Limited Markdown
+     * formatting is supported: bold, italic, strikethrough and links.
+     */
+    hint?: string;
+    /**
+     * Whether to show the preview of the field. Default: `true`.
      */
-    widget?: string;
+    preview?: boolean;
+    /**
+     * Whether to enable the editor UI
+     * in locales other than the default locale. Default: `false`. `duplicate` disables the UI in
+     * non-default like `false` but automatically copies the default locale’s value to other locales.
+     * `translate` and `none` are aliases of `true` and `false`, respectively. This option only works
+     * when i18n is set up with the global and collection-level `i18n` option.
+     */
+    i18n?: boolean | "duplicate" | "translate" | "none";
+};
+/**
+ * Common field properties. We have to allow arbitrary properties because custom widgets can have
+ * any properties. This is also required to enable schema autocomplete for the fields in IDEs.
+ */
+export type CommonFieldProps = BaseFieldProps & Record<string, any>;
+/**
+ * Standard field properties for a built-in widget.
+ */
+export type StandardFieldProps = {
     /**
      * Whether to make data input on the field required.
      * Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global
@@ -272,23 +294,6 @@ export type CommonFieldProps = {
      * message. This option has no effect on a List or Object field with subfields.
      */
     pattern?: [string | RegExp, string];
-    /**
-     * Help message to be displayed below the input UI. Limited Markdown
-     * formatting is supported: bold, italic, strikethrough and links.
-     */
-    hint?: string;
-    /**
-     * Whether to show the preview of the field. Default: `true`.
-     */
-    preview?: boolean;
-    /**
-     * Whether to enable the editor UI
-     * in locales other than the default locale. Default: `false`. `duplicate` disables the UI in
-     * non-default like `false` but automatically copies the default locale’s value to other locales.
-     * `translate` and `none` are aliases of `true` and `false`, respectively. This option only works
-     * when i18n is set up with the global and collection-level `i18n` option.
-     */
-    i18n?: boolean | "duplicate" | "translate" | "none";
 };
 /**
  * Field-level media library options.
@@ -349,11 +354,11 @@ export type MediaFieldProps = {
  */
 export type MultiValueFieldProps = {
     /**
-     * Minimum number of items that can be added. Default: 0.
+     * Minimum number of items that can be added. Default: `0`.
      */
     min?: number;
     /**
-     * Maximum number of items that can be added. Default: infinity.
+     * Maximum number of items that can be added. Default: `Infinity`.
      */
     max?: number;
 };
@@ -367,17 +372,17 @@ export type MultiOptionFieldProps = {
     multiple?: boolean;
     /**
      * Minimum number of items that can be selected. Ignored if `multiple` is
-     * `false`. Default: 0.
+     * `false`. Default: `0`.
      */
     min?: number;
     /**
      * Maximum number of items that can be selected. Ignored if `multiple` is
-     * `false`. Default: infinity.
+     * `false`. Default: `Infinity`.
      */
     max?: number;
     /**
      * Maximum number of options to be displayed as radio
-     * buttons (single-select) or checkboxes (multi-select) rather than a dropdown list. Default: 5.
+     * buttons (single-select) or checkboxes (multi-select) rather than a dropdown list. Default: `5`.
      */
     dropdown_threshold?: number;
 };
@@ -443,12 +448,12 @@ export type AdjacentLabelProps = {
 export type CharCountProps = {
     /**
      * Minimum number of characters that can be entered in the input.
-     * Default: 0.
+     * Default: `0`.
      */
     minlength?: number;
     /**
      * Maximum number of characters that can be entered in the input.
-     * Default: infinity.
+     * Default: `Infinity`.
      */
     maxlength?: number;
 };
@@ -468,7 +473,7 @@ export type BooleanFieldProps = {
 /**
  * Boolean field definition.
  */
-export type BooleanField = CommonFieldProps & BooleanFieldProps & AdjacentLabelProps;
+export type BooleanField = CommonFieldProps & StandardFieldProps & BooleanFieldProps & AdjacentLabelProps;
 /**
  * Code field properties.
  */
@@ -509,7 +514,7 @@ export type CodeFieldProps = {
 /**
  * Code field definition.
  */
-export type CodeField = CommonFieldProps & CodeFieldProps;
+export type CodeField = CommonFieldProps & StandardFieldProps & CodeFieldProps;
 /**
  * Color field properties.
  */
@@ -536,7 +541,7 @@ export type ColorFieldProps = {
 /**
  * Color field definition.
  */
-export type ColorField = CommonFieldProps & ColorFieldProps;
+export type ColorField = CommonFieldProps & StandardFieldProps & ColorFieldProps;
 /**
  * Compute field properties.
  */
@@ -553,7 +558,7 @@ export type ComputeFieldProps = {
 /**
  * Compute field definition.
  */
-export type ComputeField = CommonFieldProps & ComputeFieldProps;
+export type ComputeField = CommonFieldProps & StandardFieldProps & ComputeFieldProps;
 /**
  * DateTime field properties.
  */
@@ -592,7 +597,7 @@ export type DateTimeFieldProps = {
 /**
  * DateTime field definition.
  */
-export type DateTimeField = CommonFieldProps & DateTimeFieldProps;
+export type DateTimeField = CommonFieldProps & StandardFieldProps & DateTimeFieldProps;
 /**
  * File field properties.
  */
@@ -605,7 +610,7 @@ export type FileFieldProps = {
 /**
  * File field definition.
  */
-export type FileField = CommonFieldProps & MediaFieldProps & FileFieldProps;
+export type FileField = CommonFieldProps & StandardFieldProps & MediaFieldProps & FileFieldProps;
 /**
  * Hidden field properties.
  */
@@ -623,7 +628,7 @@ export type HiddenFieldProps = {
 /**
  * Hidden field definition.
  */
-export type HiddenField = CommonFieldProps & HiddenFieldProps;
+export type HiddenField = CommonFieldProps & StandardFieldProps & HiddenFieldProps;
 /**
  * Image field properties.
  */
@@ -636,7 +641,7 @@ export type ImageFieldProps = {
 /**
  * Image field definition.
  */
-export type ImageField = CommonFieldProps & MediaFieldProps & ImageFieldProps;
+export type ImageField = CommonFieldProps & StandardFieldProps & MediaFieldProps & ImageFieldProps;
 /**
  * KeyValue field properties.
  */
@@ -661,7 +666,7 @@ export type KeyValueFieldProps = {
 /**
  * KeyValue field definition.
  */
-export type KeyValueField = CommonFieldProps & KeyValueFieldProps & MultiValueFieldProps;
+export type KeyValueField = CommonFieldProps & StandardFieldProps & KeyValueFieldProps & MultiValueFieldProps;
 /**
  * List field properties.
  */
@@ -725,7 +730,7 @@ export type ListFieldProps = {
 /**
  * List field definition.
  */
-export type ListField = CommonFieldProps & ListFieldProps & MultiValueFieldProps & VariableFieldProps;
+export type ListField = CommonFieldProps & StandardFieldProps & ListFieldProps & MultiValueFieldProps & VariableFieldProps;
 /**
  * Map field properties.
  */
@@ -740,18 +745,18 @@ export type MapFieldProps = {
      */
     default?: string;
     /**
-     * Precision of coordinates to be saved. Default: 7.
+     * Precision of coordinates to be saved. Default: `7`.
      */
     decimals?: number;
     /**
-     * Geometry type. Default: Point.
+     * Geometry type. Default: `Point`.
      */
     type?: "Point" | "LineString" | "Polygon";
 };
 /**
  * Map field definition.
  */
-export type MapField = CommonFieldProps & MapFieldProps;
+export type MapField = CommonFieldProps & StandardFieldProps & MapFieldProps;
 /**
  * Supported button name for the rich text editor.
  */
@@ -812,7 +817,7 @@ export type MarkdownFieldProps = {
 /**
  * Markdown field definition.
  */
-export type MarkdownField = CommonFieldProps & MarkdownFieldProps;
+export type MarkdownField = CommonFieldProps & StandardFieldProps & MarkdownFieldProps;
 /**
  * Number field properties.
  */
@@ -830,22 +835,22 @@ export type NumberFieldProps = {
      */
     value_type?: "int" | "float" | string;
     /**
-     * Minimum value that can be entered in the input. Default: undefined.
+     * Minimum value that can be entered in the input. Default: `-Infinity`.
      */
     min?: number;
     /**
-     * Maximum value that can be entered in the input. Default: undefined.
+     * Maximum value that can be entered in the input. Default: `Infinity`.
      */
     max?: number;
     /**
-     * Number to increase/decrease with the arrow key/button. Default: 1.
+     * Number to increase/decrease with the arrow key/button. Default: `1`.
      */
     step?: number;
 };
 /**
  * Number field definition.
  */
-export type NumberField = CommonFieldProps & NumberFieldProps & AdjacentLabelProps;
+export type NumberField = CommonFieldProps & StandardFieldProps & NumberFieldProps & AdjacentLabelProps;
 /**
  * Object field properties.
  */
@@ -876,7 +881,7 @@ export type ObjectFieldProps = {
 /**
  * Object field definition.
  */
-export type ObjectField = CommonFieldProps & ObjectFieldProps & VariableFieldProps;
+export type ObjectField = CommonFieldProps & StandardFieldProps & ObjectFieldProps & VariableFieldProps;
 /**
  * Entry filter options for a Relation field.
  */
@@ -938,7 +943,7 @@ export type RelationFieldProps = {
 /**
  * Relation field definition.
  */
-export type RelationField = CommonFieldProps & RelationFieldProps & MultiOptionFieldProps;
+export type RelationField = CommonFieldProps & StandardFieldProps & RelationFieldProps & MultiOptionFieldProps;
 /**
  * Select field properties.
  */
@@ -963,7 +968,7 @@ export type SelectFieldProps = {
 /**
  * Select field definition.
  */
-export type SelectField = CommonFieldProps & SelectFieldProps & MultiOptionFieldProps;
+export type SelectField = CommonFieldProps & StandardFieldProps & SelectFieldProps & MultiOptionFieldProps;
 /**
  * String field properties.
  */
@@ -971,14 +976,14 @@ export type StringFieldProps = {
     /**
      * Widget name.
      */
-    widget: "string";
+    widget?: "string";
     /**
      * Default value.
      */
     default?: string;
     /**
      * Data type. It’s useful when the input value needs a
-     * validation. Default: text.
+     * validation. Default: `text`.
      */
     type?: "text" | "url" | "email";
     /**
@@ -993,7 +998,7 @@ export type StringFieldProps = {
 /**
  * String field definition.
  */
-export type StringField = CommonFieldProps & StringFieldProps & AdjacentLabelProps & CharCountProps;
+export type StringField = CommonFieldProps & StandardFieldProps & StringFieldProps & AdjacentLabelProps & CharCountProps;
 /**
  * Text field properties.
  */
@@ -1010,7 +1015,7 @@ export type TextFieldProps = {
 /**
  * Text field definition.
  */
-export type TextField = CommonFieldProps & TextFieldProps & CharCountProps;
+export type TextField = CommonFieldProps & StandardFieldProps & TextFieldProps & CharCountProps;
 /**
  * UUID field properties.
  */
@@ -1039,15 +1044,24 @@ export type UuidFieldProps = {
 /**
  * UUID field definition.
  */
-export type UuidField = CommonFieldProps & UuidFieldProps;
+export type UuidField = CommonFieldProps & StandardFieldProps & UuidFieldProps;
 /**
  * Entry field using a built-in widget.
  */
 export type StandardField = BooleanField | CodeField | ColorField | ComputeField | DateTimeField | FileField | HiddenField | ImageField | KeyValueField | ListField | MapField | MarkdownField | NumberField | ObjectField | RelationField | SelectField | StringField | TextField | UuidField;
 /**
- * Entry field using a custom widget. It can contain any properties.
+ * Custom field properties.
+ */
+export type CustomFieldProps = {
+    /**
+     * Widget name.
+     */
+    widget: string;
+};
+/**
+ * Entry field using a custom widget.
  */
-export type CustomField = CommonFieldProps & Record<string, any>;
+export type CustomField = CommonFieldProps & CustomFieldProps;
 /**
  * Entry field.
  */
@@ -1158,12 +1172,6 @@ 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.
      */
@@ -1281,7 +1289,7 @@ export type EditorOptions = {
 export type NestedCollectionOptions = {
     /**
      * Maximum depth to show nested items in the collection tree. Default:
-     * infinity.
+     * `Infinity`.
      */
     depth?: number;
     /**
@@ -1344,6 +1352,23 @@ export type CollectionIndexFile = {
      */
     editor?: EditorOptions;
 };
+/**
+ * A divider in the collection list and singleton list.
+ */
+export type CollectionDivider = {
+    /**
+     * Unique identifier for the divider. Can be omitted, but it must be
+     * unique across all the collections and singletons. This property is included here because in the
+     * previous version of Sveltia CMS, a divider was defined as a collection with the `divider` option
+     * set to `true`, and the `name` option was required.
+     */
+    name?: string;
+    /**
+     * Whether to make this collection a divider UI in the collection list.
+     * It must be `true` to be used as a divider.
+     */
+    divider: boolean;
+};
 /**
  * A raw collection defined in the configuration file. Note: In Sveltia CMS, a folder collection is
  * called an entry collection.
@@ -1448,7 +1473,7 @@ export type Collection = {
     slug?: string;
     /**
      * The maximum number of characters allowed for an entry slug.
-     * Entry collection only. Default: infinity.
+     * Entry collection only. Default: `Infinity`.
      */
     slug_length?: number;
     /**
@@ -1509,12 +1534,6 @@ export type Collection = {
      * options.
      */
     yaml_quote?: boolean;
-    /**
-     * A special option to make this collection a divider UI in the
-     * collection list. Default: `false`. If `true`, other options will be ignored, but you still have
-     * to provide a unique `name`.
-     */
-    divider?: boolean;
     /**
      * A field key path to be used to find an
      * entry thumbnail displayed on the entry list. A nested field can be specified using dot notation,
@@ -1525,7 +1544,7 @@ export type Collection = {
     thumbnail?: FieldKeyPath | FieldKeyPath[];
     /**
      * The maximum number of entries that can be created in the collection.
-     * Entry collection only. Default: infinity.
+     * Entry collection only. Default: `Infinity`.
      */
     limit?: number;
 };
@@ -1654,7 +1673,7 @@ export type BackendOptions = {
     /**
      * Whether to enable or disable automatic deployments
      * with any connected CI/CD provider, such as GitHub Actions or Cloudflare Pages. If `false`, the
-     * `[skip ci]` prefix will be added to commit messages. Git backends only. Default: undefined. See
+     * `[skip ci]` prefix will be added to commit messages. Git backends only. Default: `undefined`. See
      * https://github.com/sveltia/sveltia-cms#disabling-automatic-deployments for details.
      */
     automatic_deployments?: boolean;
@@ -1694,7 +1713,7 @@ export type JsonFormatOptions = {
      */
     indent_style?: "space" | "tab";
     /**
-     * Indent size. Default: 2.
+     * Indent size. Default: `2`.
      */
     indent_size?: number;
 };
@@ -1703,7 +1722,7 @@ export type JsonFormatOptions = {
  */
 export type YamlFormatOptions = {
     /**
-     * Indent size. Default: 2.
+     * Indent size. Default: `2`.
      */
     indent_size?: number;
     /**
@@ -1801,15 +1820,16 @@ export type SiteConfig = {
      */
     slug?: SlugOptions;
     /**
-     * Set of collections.
+     * Set of collections. The list can also
+     * contain dividers, which are used to group collections in the collection list.
      */
-    collections: Collection[];
+    collections: (Collection | CollectionDivider)[];
     /**
-     * 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.
+     * 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. The list can also contain dividers.
      */
-    singletons?: CollectionFile[];
+    singletons?: (CollectionFile | CollectionDivider)[];
     /**
      * Global i18n options.
      */