@sveltia/cms 0.63.0 → 0.63.1

package/types/public.d.ts

@@ -0,0 +1,1625 @@
+/**
+ * Standard IETF locale tag like `en` or `en-US`.
+ */
+export type LocaleCode = string;
+/**
+ * An entry field name. It can be written in dot notation like `author.name` if the field is nested
+ * with an Object field. For a List subfield, a wildcard can be used like `authors.*.name`. We
+ * call this a key path, which is derived from the IndexedDB API terminology, and use it everywhere,
+ * as entry data is managed as a flatten object for easier access.
+ */
+export type FieldKeyPath = string;
+/**
+ * Supported media library name.
+ */
+export type MediaLibraryName = "default" | "cloudinary" | "uploadcare";
+/**
+ * Configuration for the built-in media library.
+ */
+export type DefaultMediaLibraryOptions = {
+    /**
+     * Maximum file size in bytes that can be accepted for uploading.
+     */
+    max_file_size?: number;
+};
+/**
+ * Options for the built-in media library.
+ */
+export type DefaultMediaLibrary = {
+    /**
+     * Configuration for the built-in media library.
+     */
+    config?: DefaultMediaLibraryOptions;
+};
+/**
+ * Options for the Cloudinary media library.
+ */
+export type CloudinaryMediaLibrary = {
+    /**
+     * Whether to output a file name instead of a full URL.
+     * Default: `false`.
+     */
+    output_filename_only?: boolean;
+    /**
+     * Whether to include transformation segments in an output
+     * URL. Default: `true`.
+     */
+    use_transformations?: boolean;
+    /**
+     * Whether to use an HTTP URL. Default: `true`.
+     */
+    use_secure_url?: boolean;
+    /**
+     * Options to be passed to Uploadcare, 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.
+     */
+    config?: Record<string, any>;
+};
+/**
+ * Settings for the Uploadcare media library.
+ */
+export type UploadcareMediaLibrarySettings = {
+    /**
+     * Whether to append a file name to an output URL. Default:
+     * `false`.
+     */
+    autoFilename?: boolean;
+    /**
+     * Transformation operations to be included in an output URL.
+     * Default: empty string.
+     */
+    defaultOperations?: string;
+};
+/**
+ * Options for the Uploadcare media library.
+ */
+export type UploadcareMediaLibrary = {
+    /**
+     * Options to be passed to Uploadcare, such as `multiple`.
+     * The `publicKey` option is required for the global `media_library` option. See
+     * https://uploadcare.com/docs/uploads/file-uploader-options/ for a full list of available options.
+     */
+    config?: Record<string, any>;
+    /**
+     * Integration settings.
+     */
+    settings?: UploadcareMediaLibrarySettings;
+};
+/**
+ * Supported media library.
+ */
+export type MediaLibrary = DefaultMediaLibrary | CloudinaryMediaLibrary | UploadcareMediaLibrary;
+/**
+ * Common field properties.
+ */
+export type CommonFieldProps = {
+    /**
+     * Unique identifier for the field. It cannot include periods and spaces.
+     */
+    name: string;
+    /**
+     * Label of the field to be displayed in the editor UI. Default: `name`
+     * field value.
+     */
+    label?: string;
+    /**
+     * Short description of the field to be displayed in the editor UI.
+     */
+    comment?: string;
+    /**
+     * Name of a widget that defines the input UI and data type. Default:
+     * `string`.
+     */
+    widget?: string;
+    /**
+     * Whether to make data input on the field required.
+     * Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global
+     * output option is `true`. If i18n is enabled and the field doesn’t require input in all locales,
+     * required locale codes can be passed as an array like `[en, fr]` instead of a boolean.
+     */
+    required?: boolean | LocaleCode[];
+    /**
+     * Validation format. The first argument is a regular
+     * expression pattern for a valid input value, and the second argument is an error message. This
+     * option has no effect on a List or Object field with subfields.
+     */
+    pattern?: [string, 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.
+ */
+export type FieldMediaLibraryOptions = {
+    /**
+     * Library name.
+     */
+    name?: MediaLibraryName;
+};
+/**
+ * Media field properties.
+ */
+export type MediaFieldProps = {
+    /**
+     * Default value. A file path or complete URL.
+     */
+    default?: string;
+    /**
+     * Whether to show the URL input UI. Default: `true`.
+     */
+    choose_url?: boolean;
+    /**
+     * Internal media folder path for the field. Default: global or
+     * collection-level `media_folder` value.
+     */
+    media_folder?: string;
+    /**
+     * Public media folder path for the field. Default:
+     * `media_folder` option value.
+     */
+    public_folder?: string;
+    /**
+     * Media library options for the
+     * field. Default: global `media_library` value.
+     */
+    media_library?: MediaLibrary & FieldMediaLibraryOptions;
+    /**
+     * Whether to enable multiple item selection in an external
+     * media library. Default: `true`.
+     */
+    allow_multiple?: boolean;
+};
+/**
+ * Options for a field accepting multiple values.
+ */
+export type MultiValueFieldProps = {
+    /**
+     * Minimum number of items that can be added. Default: 0.
+     */
+    min?: number;
+    /**
+     * Maximum number of items that can be added. Default: infinity.
+     */
+    max?: number;
+};
+/**
+ * Options for a field showing multiple options.
+ */
+export type MultiOptionFieldProps = {
+    /**
+     * Whether to accept multiple values. Default: `false`.
+     */
+    multiple?: boolean;
+    /**
+     * Minimum number of items that can be selected. Default: 0. Ignored if
+     * `multiple` is `false`.
+     */
+    min?: number;
+    /**
+     * Maximum number of items that can be selected. Default: infinity. Ignored
+     * if `multiple` is `false`.
+     */
+    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.
+     */
+    dropdown_threshold?: number;
+};
+/**
+ * Variable type for List/Object fields.
+ */
+export type VariableFieldType = {
+    /**
+     * Unique identifier for the type.
+     */
+    name: string;
+    /**
+     * Label of the type to be displayed in the editor UI. Default: `name`
+     * field value.
+     */
+    label?: string;
+    /**
+     * Widget name. Values other than `object` are ignored.
+     */
+    widget?: "object";
+    /**
+     * Template of a label to be displayed on a collapsed object.
+     */
+    summary?: string;
+    /**
+     * Set of subfields. This option can be omitted; in that case, only
+     * the `type` property will be saved.
+     */
+    fields?: Field[];
+};
+/**
+ * Variable field properties.
+ */
+export type VariableFieldProps = {
+    /**
+     * Set of nested Object widgets to be selected or added.
+     */
+    types?: VariableFieldType[];
+    /**
+     * Property name to store the type name in nested objects. Default:
+     * `type`.
+     */
+    typeKey?: string;
+};
+/**
+ * Options for a field with a simple input UI that allows for extra labels.
+ */
+export type AdjacentLabelProps = {
+    /**
+     * An extra label to be displayed before the input UI. Markdown is
+     * supported. Default: empty string.
+     */
+    before_input?: string;
+    /**
+     * An extra label to be displayed after the input UI. Markdown is
+     * supported. Default: empty string.
+     */
+    after_input?: string;
+};
+/**
+ * Options for a field with a string-type input UI that counts the number of characters.
+ */
+export type CharCountProps = {
+    /**
+     * Minimum number of characters that can be entered in the input.
+     * Default: 0.
+     */
+    minlength?: number;
+    /**
+     * Maximum number of characters that can be entered in the input.
+     * Default: infinity.
+     */
+    maxlength?: number;
+};
+/**
+ * Boolean field properties.
+ */
+export type BooleanFieldProps = {
+    /**
+     * Widget name.
+     */
+    widget: "boolean";
+    /**
+     * Default value.
+     */
+    default?: boolean;
+};
+/**
+ * Boolean field definition.
+ */
+export type BooleanField = CommonFieldProps & BooleanFieldProps & AdjacentLabelProps;
+/**
+ * Code field properties.
+ */
+export type CodeFieldProps = {
+    /**
+     * Widget name.
+     */
+    widget: "code";
+    /**
+     * Default value. It must be a string if
+     * `output_code_only` is `false`. Otherwise it must be an object that match the `keys` option.
+     */
+    default?: string | Record<string, string>;
+    /**
+     * Default language to be selected, like `js`. See
+     * https://prismjs.com/#supported-languages for a list of supported languages.
+     */
+    default_language?: string;
+    /**
+     * Whether to show a language switcher so that users
+     * can change the language mode. Default: `true` (the Decap CMS document is wrong).
+     */
+    allow_language_selection?: boolean;
+    /**
+     * Whether to output code snippet only. Default: `false`.
+     */
+    output_code_only?: boolean;
+    /**
+     * Output property names. It has no effect if
+     * `output_code_only` is `true`.
+     */
+    keys?: {
+        code: string;
+        lang: string;
+    };
+};
+/**
+ * Code field definition.
+ */
+export type CodeField = CommonFieldProps & CodeFieldProps;
+/**
+ * Color field properties.
+ */
+export type ColorFieldProps = {
+    /**
+     * Widget name.
+     */
+    widget: "color";
+    /**
+     * Default value. Accepts a Hex color code.
+     */
+    default?: string;
+    /**
+     * Whether to show a textbox that allows users to manually edit the
+     * value. Default: `false`.
+     */
+    allowInput?: boolean;
+    /**
+     * Whether to edit/save the alpha channel value.
+     */
+    enableAlpha?: boolean;
+};
+/**
+ * Color field definition.
+ */
+export type ColorField = CommonFieldProps & ColorFieldProps;
+/**
+ * Compute field properties.
+ */
+export type ComputeFieldProps = {
+    /**
+     * Widget name.
+     */
+    widget: "compute";
+    /**
+     * Value template, like `posts-{{fields.slug}}`.
+     */
+    value: string;
+};
+/**
+ * Compute field definition.
+ */
+export type ComputeField = CommonFieldProps & ComputeFieldProps;
+/**
+ * DateTime field properties.
+ */
+export type DateTimeFieldProps = {
+    /**
+     * Widget name.
+     */
+    widget: "datetime";
+    /**
+     * Default value. Accepts a date/time string that matches the `format`,
+     * or `{{now}}` to populate the current date/time. Default: empty string.
+     */
+    default?: string;
+    /**
+     * Storage format written in Moment.js tokens. See
+     * https://momentjs.com/docs/#/displaying/format/ for supported tokens. Default: ISO 8601 format.
+     */
+    format?: string;
+    /**
+     * Date storage format written in Moment.js tokens if the
+     * value is a string and the `format` option is not defined. If `true`, ISO 8601 format is used
+     * unless the `format` option is defined. If `false`, date input/output is disabled.
+     */
+    date_format?: string | boolean;
+    /**
+     * Time storage format written in Moment.js tokens if the
+     * value is a string and the `format` option is not defined. If `true`, ISO 8601 format is used
+     * unless the `format` option is defined. If `false`, time input/output is disabled.
+     */
+    time_format?: string | boolean;
+    /**
+     * Whether to make the date input/output UTC. Default: `false`.
+     */
+    picker_utc?: boolean;
+};
+/**
+ * DateTime field definition.
+ */
+export type DateTimeField = CommonFieldProps & DateTimeFieldProps;
+/**
+ * File field properties.
+ */
+export type FileFieldProps = {
+    /**
+     * Widget name.
+     */
+    widget: "file";
+};
+/**
+ * File field definition.
+ */
+export type FileField = CommonFieldProps & MediaFieldProps & FileFieldProps;
+/**
+ * Hidden field properties.
+ */
+export type HiddenFieldProps = {
+    /**
+     * Widget name.
+     */
+    widget: "hidden";
+    /**
+     * Default value. Accepts any data type that can be stored with the
+     * configured file format.
+     */
+    default?: any;
+};
+/**
+ * Hidden field definition.
+ */
+export type HiddenField = CommonFieldProps & HiddenFieldProps;
+/**
+ * Image field properties.
+ */
+export type ImageFieldProps = {
+    /**
+     * Widget name.
+     */
+    widget: "image";
+};
+/**
+ * Image field definition.
+ */
+export type ImageField = CommonFieldProps & MediaFieldProps & ImageFieldProps;
+/**
+ * KeyValue field properties.
+ */
+export type KeyValueFieldProps = {
+    /**
+     * Widget name.
+     */
+    widget: "keyvalue";
+    /**
+     * Default key-value pairs.
+     */
+    default?: Record<string, string>;
+    /**
+     * Label for the key column. Default: Key.
+     */
+    key_label?: string;
+    /**
+     * Label for the value column. Default: Value.
+     */
+    value_label?: string;
+};
+/**
+ * KeyValue field definition.
+ */
+export type KeyValueField = CommonFieldProps & KeyValueFieldProps & MultiValueFieldProps;
+/**
+ * List field properties.
+ */
+export type ListFieldProps = {
+    /**
+     * Widget name.
+     */
+    widget: "list";
+    /**
+     * Default value.
+     */
+    default?: string[] | Record<string, any>[] | Record<string, any>;
+    /**
+     * Whether to allow users to add new values. Default: `true`.
+     */
+    allow_add?: boolean;
+    /**
+     * Whether to add new items to the top of the list instead of the
+     * bottom. Default: `false`.
+     */
+    add_to_top?: boolean;
+    /**
+     * Label to be displayed on the Add button. Default: `label`
+     * field value.
+     */
+    label_singular?: string;
+    /**
+     * Template of a label to be displayed on a collapsed list item.
+     */
+    summary?: string;
+    /**
+     * Whether to collapse the UI by default. Default: `false`.
+     */
+    collapsed?: boolean;
+    /**
+     * Whether to collapse the entire UI. Default: `false`.
+     */
+    minimize_collapsed?: boolean;
+    /**
+     * Single field to be included in a list item.
+     */
+    field?: Field;
+    /**
+     * Set of fields to be included in a list item.
+     */
+    fields?: Field[];
+    /**
+     * Whether to save the field value at the top-level of the data file
+     * without the field name. If the `single_file` i18n structure is enabled, the lists will still be
+     * saved under locale keys. Default: `false`. See
+     * https://github.com/sveltia/sveltia-cms#editing-data-files-with-a-top-level-list for details.
+     */
+    root?: boolean;
+};
+/**
+ * List field definition.
+ */
+export type ListField = CommonFieldProps & ListFieldProps & MultiValueFieldProps & VariableFieldProps;
+/**
+ * Map field properties.
+ */
+export type MapFieldProps = {
+    /**
+     * Widget name.
+     */
+    widget: "map";
+    /**
+     * Default value. Accepts a stringified single GeoJSON geometry object.
+     */
+    default?: string;
+    /**
+     * Precision of coordinates to be saved. Default: 7.
+     */
+    decimals?: number;
+    /**
+     * Geometry type. Default: Point.
+     */
+    type?: "Point" | "LineString" | "Polygon";
+};
+/**
+ * Map field definition.
+ */
+export type MapField = CommonFieldProps & MapFieldProps;
+/**
+ * Supported button name for the rich text editor.
+ */
+export type RichTextEditorButtonName = "bold" | "italic" | "code" | "link" | "heading-one" | "heading-two" | "heading-three" | "heading-four" | "heading-five" | "heading-six" | "quote" | "bulleted-list" | "numbered-list";
+/**
+ * Built-in editor component name for the rich text editor.
+ */
+export type RichTextEditorComponentName = "code-block" | "image";
+/**
+ * Supported mode name for the rich text editor.
+ */
+export type RichTextEditorMode = "rich_text" | "raw";
+/**
+ * Markdown field properties.
+ */
+export type MarkdownFieldProps = {
+    /**
+     * Widget name.
+     */
+    widget: "markdown";
+    /**
+     * Default value.
+     */
+    default?: string;
+    /**
+     * Whether to minimize the toolbar height.
+     */
+    minimal?: boolean;
+    /**
+     * Names of formatting buttons and menu items to be
+     * enabled in the editor UI. Default: all the supported button names.
+     */
+    buttons?: RichTextEditorButtonName[];
+    /**
+     * Names of components to
+     * be enabled in the editor UI. This may include custom component names. Default: all the built-in
+     * component names.
+     */
+    editor_components?: (RichTextEditorComponentName | string)[];
+    /**
+     * Editor modes to be enabled. If it’s `[raw, rich_text]`,
+     * rich text mode is disabled by default. Default: `[rich_text, raw]`.
+     */
+    modes?: RichTextEditorMode[];
+    /**
+     * Whether to sanitize the preview HTML. Default: `false`.
+     */
+    sanitize_preview?: boolean;
+};
+/**
+ * Markdown field definition.
+ */
+export type MarkdownField = CommonFieldProps & MarkdownFieldProps;
+/**
+ * Number field properties.
+ */
+export type NumberFieldProps = {
+    /**
+     * Widget name.
+     */
+    widget: "number";
+    /**
+     * Default value.
+     */
+    default?: number | string;
+    /**
+     * Type of value to be saved. Default: `int`.
+     */
+    value_type?: "int" | "float" | string;
+    /**
+     * Minimum value that can be entered in the input. Default: undefined.
+     */
+    min?: number;
+    /**
+     * Maximum value that can be entered in the input. Default: undefined.
+     */
+    max?: number;
+    /**
+     * Number to increase/decrease with the arrow key/button. Default: 1.
+     */
+    step?: number;
+};
+/**
+ * Number field definition.
+ */
+export type NumberField = CommonFieldProps & NumberFieldProps & AdjacentLabelProps;
+/**
+ * Object field properties.
+ */
+export type ObjectFieldProps = {
+    /**
+     * Widget name.
+     */
+    widget: "object";
+    /**
+     * Default values.
+     */
+    default?: Record<string, any>;
+    /**
+     * Whether to collapse the UI by default. Default: `false`.
+     */
+    collapsed?: boolean;
+    /**
+     * Template of a label to be displayed on a collapsed object.
+     */
+    summary?: string;
+    /**
+     * Set of fields to be included.
+     */
+    fields: Field[];
+};
+/**
+ * Object field definition.
+ */
+export type ObjectField = CommonFieldProps & ObjectFieldProps & VariableFieldProps;
+/**
+ * Entry filter options for a Relation field.
+ */
+export type RelationFieldFilterOptions = {
+    /**
+     * Field name.
+     */
+    field: FieldKeyPath;
+    /**
+     * One or more values to be matched.
+     */
+    values: any[];
+};
+/**
+ * Relation field properties.
+ */
+export type RelationFieldProps = {
+    /**
+     * Widget name.
+     */
+    widget: "relation";
+    /**
+     * Default value.
+     */
+    default?: any;
+    /**
+     * Referenced collection name.
+     */
+    collection: string;
+    /**
+     * Referenced file identifier for a file collection. Required if the
+     * `collection` is a file collection.
+     */
+    file?: string;
+    /**
+     * Field name to be stored as the value, or
+     * `{{slug}}`. It can contain a locale prefix like `{{locale}}/{{slug}}` if i18n is enabled.
+     */
+    value_field: FieldKeyPath | string;
+    /**
+     * Name of fields to be displayed. It can
+     * contain string templates. Default: `value_field` field value.
+     */
+    display_fields?: (FieldKeyPath | string)[];
+    /**
+     * Name of fields to be searched. Default:
+     * `display_fields` field value.
+     */
+    search_fields?: FieldKeyPath[];
+    /**
+     * Entry filter options.
+     */
+    filters?: RelationFieldFilterOptions[];
+};
+/**
+ * Relation field definition.
+ */
+export type RelationField = CommonFieldProps & RelationFieldProps & MultiOptionFieldProps;
+/**
+ * Select field properties.
+ */
+export type SelectFieldProps = {
+    /**
+     * Widget name.
+     */
+    widget: "select";
+    /**
+     * Default values, which should math the options.
+     */
+    default?: string[];
+    /**
+     * Options.
+     */
+    options: string[] | {
+        label: string;
+        value: string;
+    }[];
+};
+/**
+ * Select field definition.
+ */
+export type SelectField = CommonFieldProps & SelectFieldProps & MultiOptionFieldProps;
+/**
+ * String field properties.
+ */
+export type StringFieldProps = {
+    /**
+     * Widget name.
+     */
+    widget: "string";
+    /**
+     * Default value.
+     */
+    default?: string;
+    /**
+     * Input type. Default: text.
+     */
+    type?: "email" | "url" | "text";
+    /**
+     * A string to be prepended to the value. Default: empty string.
+     */
+    prefix?: string;
+    /**
+     * A string to be appended to the value. Default: empty string.
+     */
+    suffix?: string;
+};
+/**
+ * String field definition.
+ */
+export type StringField = CommonFieldProps & StringFieldProps & AdjacentLabelProps & CharCountProps;
+/**
+ * Text field properties.
+ */
+export type TextFieldProps = {
+    /**
+     * Widget name.
+     */
+    widget: "text";
+    /**
+     * Default value.
+     */
+    default?: string;
+};
+/**
+ * Text field definition.
+ */
+export type TextField = CommonFieldProps & TextFieldProps & CharCountProps;
+/**
+ * UUID field properties.
+ */
+export type UuidFieldProps = {
+    /**
+     * Widget name.
+     */
+    widget: "uuid";
+    /**
+     * A string to be prepended to the value. Default: empty string.
+     */
+    prefix?: string;
+    /**
+     * Whether to encode the value with Base32. Default: `false`.
+     */
+    use_b32_encoding?: boolean;
+    /**
+     * Whether to make the field read-only. Default: `true`.
+     */
+    read_only?: boolean;
+};
+/**
+ * UUID field definition.
+ */
+export type UuidField = CommonFieldProps & UuidFieldProps;
+/**
+ * Custom field definition. It can contain any properties.
+ */
+export type CustomField = CommonFieldProps & Record<string, any>;
+/**
+ * Entry field.
+ */
+export type Field = BooleanField | CodeField | ColorField | ComputeField | DateTimeField | FileField | HiddenField | ImageField | KeyValueField | ListField | MapField | MarkdownField | NumberField | ObjectField | RelationField | SelectField | StringField | TextField | UuidField | CustomField;
+/**
+ * Internationalization (i18n) file structure type.
+ */
+export type I18nFileStructure = "single_file" | "multiple_files" | "multiple_folders" | "multiple_folders_i18n_root";
+/**
+ * Global, collection-level or collection file-level i18n options.
+ */
+export type I18nOptions = {
+    /**
+     * File structure for entry collections. File collections
+     * must define the structure using `{{locale}}` in the `file` option.
+     */
+    structure: I18nFileStructure;
+    /**
+     * List of all available locales.
+     */
+    locales: LocaleCode[];
+    /**
+     * Default locale. Default: first locale in the `locales`
+     * option.
+     */
+    default_locale?: LocaleCode;
+    /**
+     * Locales to be enabled when
+     * creating a new entry draft. If this option is used, users will be able to disable the output of
+     * non-default locales through the UI. See
+     * https://github.com/sveltia/sveltia-cms#disabling-non-default-locale-content for details.
+     */
+    initial_locales?: LocaleCode[] | "all" | "default";
+    /**
+     * Whether to save collection entries in all the locales. If
+     * `false`, users will be able to disable the output of non-default locales through the UI. See
+     * https://github.com/sveltia/sveltia-cms#disabling-non-default-locale-content for details.
+     */
+    save_all_locales?: boolean;
+    /**
+     * Property name and value template used
+     * to add a canonical slug to entry files, which helps Sveltia CMS and some frameworks to link
+     * localized files when entry slugs are localized. The default property name is `translationKey`
+     * used in Hugo’s multilingual support, and the default value is the default locale’s slug. See
+     * https://github.com/sveltia/sveltia-cms#localizing-entry-slugs for details.
+     */
+    canonical_slug?: {
+        key: string;
+        value: string;
+    };
+};
+/**
+ * Single file in a file collection.
+ */
+export type CollectionFile = {
+    /**
+     * Unique identifier for the file.
+     */
+    name: string;
+    /**
+     * Label to be displayed in the editor UI. Default: `name` option value.
+     */
+    label?: string;
+    /**
+     * File path relative to the project root.
+     */
+    file: string;
+    /**
+     * Set of fields to be included in the file.
+     */
+    fields: Field[];
+    /**
+     * I18n options. Default: `false`.
+     */
+    i18n?: I18nOptions | boolean;
+    /**
+     * Preview URL path template.
+     */
+    preview_path?: string;
+    /**
+     * Date field name used for `preview_path`.
+     */
+    preview_path_date_field?: FieldKeyPath;
+};
+/**
+ * Supported file extension.
+ */
+export type FileExtension = "yml" | "yaml" | "toml" | "json" | "md" | "markdown" | "html" | string;
+/**
+ * Supported Markdown front matter format.
+ */
+export type FrontMatterFormat = "yaml-frontmatter" | "toml-frontmatter" | "json-frontmatter";
+/**
+ * Supported file format.
+ */
+export type FileFormat = "yml" | "yaml" | "toml" | "json" | "frontmatter" | FrontMatterFormat;
+/**
+ * Collection filter options.
+ */
+export type CollectionFilter = {
+    /**
+     * Field name.
+     */
+    field: FieldKeyPath;
+    /**
+     * Field value. `null` can be used to match an undefined field.
+     * Multiple values can be defined with an array. This option or `pattern` is required.
+     */
+    value?: any | any[];
+    /**
+     * Regex matching pattern.
+     */
+    pattern?: string;
+};
+/**
+ * The default options for the sortable fields.
+ */
+export type SortableFieldsDefaultOptions = {
+    /**
+     * A field name to be sorted by default.
+     */
+    field: FieldKeyPath;
+    /**
+     * Default
+     * sort direction. Title case values are supported for Static CMS compatibility. However, `None` is
+     * the same as `ascending`. Default: `ascending`.
+     */
+    direction?: "ascending" | "descending" | "Ascending" | "Descending" | "None";
+};
+/**
+ * A collection’s advanced sortable fields definition, which is compatible with Static CMS.
+ */
+export type SortableFields = {
+    /**
+     * A list of sortable field names.
+     */
+    fields: FieldKeyPath[];
+    /**
+     * Default sort settings. See
+     * https://github.com/sveltia/sveltia-cms#specifying-default-sort-field-and-direction for details.
+     */
+    default?: SortableFieldsDefaultOptions;
+};
+/**
+ * View filter.
+ */
+export type ViewFilter = {
+    /**
+     * Label.
+     */
+    label: string;
+    /**
+     * Field name.
+     */
+    field: FieldKeyPath;
+    /**
+     * Regex matching pattern or exact value.
+     */
+    pattern: string | boolean;
+};
+/**
+ * View group.
+ */
+export type ViewGroup = {
+    /**
+     * Label.
+     */
+    label: string;
+    /**
+     * Field name.
+     */
+    field: FieldKeyPath;
+    /**
+     * Regex matching pattern or exact value.
+     */
+    pattern: string | boolean;
+};
+/**
+ * Editor options.
+ */
+export type EditorOptions = {
+    /**
+     * Whether to show the preview pane. Default: `true`.
+     */
+    preview: boolean;
+};
+/**
+ * Nested collection options.
+ */
+export type NestedCollectionOptions = {
+    /**
+     * Maximum depth to show nested items in the collection tree. Default:
+     * infinity.
+     */
+    depth?: number;
+    /**
+     * Summary template for a tree item. Default: `{{title}}`.
+     */
+    summary?: string;
+};
+/**
+ * Collection meta data’s path options.
+ */
+export type CollectionMetaDataPath = {
+    /**
+     * Widget for editing the path name.
+     */
+    widget?: "string";
+    /**
+     * Label for the path editor.
+     */
+    label?: string;
+    /**
+     * Index file name to be used.
+     */
+    index_file?: string;
+};
+/**
+ * Collection meta data.
+ */
+export type CollectionMetaData = {
+    /**
+     * Entry path options.
+     */
+    path?: CollectionMetaDataPath;
+};
+/**
+ * A raw collection defined in the configuration file. Note: In Sveltia CMS, a folder collection is
+ * called an entry collection.
+ */
+export type Collection = {
+    /**
+     * Unique identifier for the collection.
+     */
+    name: string;
+    /**
+     * Label of the field to be displayed in the editor UI. Default: `name`
+     * option value.
+     */
+    label?: string;
+    /**
+     * Singular UI label. It will be Blog Post if the `label` is
+     * Blog Posts, for example. Default: `label` option value.
+     */
+    label_singular?: string;
+    /**
+     * Short description of the collection to be displayed in the
+     * editor UI.
+     */
+    description?: string;
+    /**
+     * Name of a Material Symbols icon to be displayed in the collection list.
+     */
+    icon?: string;
+    /**
+     * Field name to be used as the title and slug of an
+     * entry. Entry collection only. Default: `title` or `name`.
+     */
+    identifier_field?: FieldKeyPath;
+    /**
+     * A set of files. File collection only.
+     */
+    files?: CollectionFile[];
+    /**
+     * Base folder path relative to the project root. Entry collection only.
+     */
+    folder?: string;
+    /**
+     * Set of fields to be included in entries. Entry collection only.
+     */
+    fields?: Field[];
+    /**
+     * File path relative to `folder`, without a file extension. Entry
+     * collection only.
+     */
+    path?: string;
+    /**
+     * Internal media folder path for the collection. This overrides
+     * the global `media_folder` option.
+     */
+    media_folder?: string;
+    /**
+     * Public media folder path for an entry collection. This
+     * overrides the global `public_folder` option. Default: `media_folder` option value.
+     */
+    public_folder?: string;
+    /**
+     * Entry filter. Entry collection only.
+     */
+    filter?: CollectionFilter;
+    /**
+     * Whether to hide the collection in the UI. Default: `false`.
+     */
+    hide?: boolean;
+    /**
+     * Whether to allow users to create entries in the collection. Entry
+     * collection only. Default: `false`.
+     */
+    create?: boolean;
+    /**
+     * Whether to allow users to delete entries in the collection. Entry
+     * collection only. Default: `true`.
+     */
+    delete?: boolean;
+    /**
+     * Whether to show the publishing control UI for Editorial Workflow.
+     * Default: `true`.
+     */
+    publish?: boolean;
+    /**
+     * File extension. Entry collection only. Default: `md`.
+     */
+    extension?: FileExtension;
+    /**
+     * File format. Entry collection only. Default: `yaml-frontmatter`.
+     */
+    format?: FileFormat;
+    /**
+     * Delimiters to be used for the front matter
+     * format. Entry collection only. Default: depends on the front matter type.
+     */
+    frontmatter_delimiter?: string | string[];
+    /**
+     * Item slug template. Entry collection only. Default: `identifier_field`
+     * option value.
+     */
+    slug?: string;
+    /**
+     * The maximum number of characters allowed for an entry slug.
+     * Entry collection only. Default: infinity.
+     */
+    slug_length?: number;
+    /**
+     * Entry summary template. Entry collection only. Default:
+     * `identifier_field`.
+     */
+    summary?: string;
+    /**
+     * Custom sortable fields. Entry
+     * collection only. Default: `title`, `name`, `date`, `author` and `description`. For a Git backend,
+     * commit author and commit date are also included by default.
+     */
+    sortable_fields?: FieldKeyPath[] | SortableFields;
+    /**
+     * View filters to be used in the entry list. Entry
+     * collection only.
+     */
+    view_filters?: ViewFilter[];
+    /**
+     * View groups to be used in the entry list. Entry collection
+     * only.
+     */
+    view_groups?: ViewGroup[];
+    /**
+     * I18n options. Default: `false`.
+     */
+    i18n?: I18nOptions | boolean;
+    /**
+     * Preview URL path template.
+     */
+    preview_path?: string;
+    /**
+     * Date field name used for `preview_path`.
+     */
+    preview_path_date_field?: string;
+    /**
+     * Editor view options.
+     */
+    editor?: EditorOptions;
+    /**
+     * Options for a nested collection. Entry collection
+     * only.
+     */
+    nested?: NestedCollectionOptions;
+    /**
+     * Meta data for a nested collection. Entry collection only.
+     */
+    meta?: CollectionMetaData;
+    /**
+     * Whether to double-quote all the strings values if the YAML
+     * format is used for file output. Default: `false`. DEPRECATED in favor of the global YAML format
+     * options.
+     */
+    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`.
+     */
+    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,
+     * e.g. `heroImage.src`. A wildcard in the key path is also supported, e.g. `images.*.src`. Multiple
+     * key paths can be specified as an array for fallbacks. If this option is omitted, the `name` of
+     * any non-nested, non-empty field using the Image or File widget is used. Entry collection only.
+     */
+    thumbnail?: FieldKeyPath | FieldKeyPath[];
+    /**
+     * The maximum number of entries that can be created in the collection.
+     * Entry collection only. Default: infinity.
+     */
+    limit?: number;
+};
+/**
+ * Supported backend name.
+ */
+export type BackendName = "github" | "gitlab";
+/**
+ * Custom commit messages.
+ */
+export type CommitMessages = {
+    /**
+     * Message to be used when a new entry is created.
+     */
+    create?: string;
+    /**
+     * Message to be used when existing entries are updated.
+     */
+    update?: string;
+    /**
+     * Message to be used when existing entries are deleted.
+     */
+    delete?: string;
+    /**
+     * Message to be used when new files are uploaded/updated.
+     */
+    uploadMedia?: string;
+    /**
+     * Message to be used when existing files are deleted.
+     */
+    deleteMedia?: string;
+    /**
+     * Message to be used when committed via a forked repository.
+     */
+    openAuthoring?: string;
+};
+/**
+ * Backend options.
+ */
+export type BackendOptions = {
+    /**
+     * Backend name.
+     */
+    name: BackendName;
+    /**
+     * Required for the GitHub and GitLab backends. GitHub: organization/user
+     * name and repository name joined by a slash, e.g. `owner/repo`. GitLab: namespace and project name
+     * joined by a slash, e.g. `group/project` or `group/subgroup/project`.
+     */
+    repo?: string;
+    /**
+     * Git branch name. If omitted, the default branch, usually `main` or
+     * `master`, will be used.
+     */
+    branch?: string;
+    /**
+     * API endpoint of the backend. Required when using GitHub Enterprise
+     * Server or a self-hosted GitLab instance. Default: `https://api.github.com` (GitHub) or
+     * `https://gitlab.com/api/v4` (GitLab).
+     */
+    api_root?: string;
+    /**
+     * Site domain used for OAuth, which will be included in the
+     * `site_id` param to be sent to the API endpoint. Default: `location.hostname`.
+     */
+    site_domain?: string;
+    /**
+     * OAuth base URL origin. Required when using an OAuth client other
+     * than Netlify, including Sveltia CMS Authenticator. Default: `https://api.netlify.com`.
+     */
+    base_url?: string;
+    /**
+     * OAuth base URL path. Default: `auth` (GitHub) or
+     * `oauth/authorize` (GitLab).
+     */
+    auth_endpoint?: string;
+    /**
+     * OAuth authentication method. GitLab only. Default:
+     * `pkce`.
+     */
+    auth_type?: "pkce" | "implicit";
+    /**
+     * OAuth application ID. GitLab only.
+     */
+    app_id?: string;
+    /**
+     * Custom commit messages.
+     */
+    commit_messages?: CommitMessages;
+    /**
+     * Deploy preview link context. GitHub only.
+     */
+    preview_context?: string;
+    /**
+     * Pull request label prefix for Editorial Workflow. Default:
+     * `sveltia-cms/`.
+     */
+    cms_label_prefix?: string;
+    /**
+     * Whether to use squash marge for Editorial Workflow. Default:
+     * `false`.
+     */
+    squash_merges?: boolean;
+    /**
+     * Whether to use Open Authoring. Default: `false`.
+     */
+    open_authoring?: boolean;
+    /**
+     * Authentication scope for Open Authoring.
+     */
+    auth_scope?: "repo" | "public_repo";
+    /**
+     * 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
+     * https://github.com/sveltia/sveltia-cms#disabling-automatic-deployments for details.
+     */
+    automatic_deployments?: boolean;
+};
+/**
+ * Global media library options.
+ */
+export type GlobalMediaLibraryOptions = {
+    /**
+     * Library name.
+     */
+    name: MediaLibraryName;
+};
+/**
+ * Entry slug options.
+ */
+export type SlugOptions = {
+    /**
+     * Encoding option. Default: `unicode`.
+     */
+    encoding?: "unicode" | "ascii";
+    /**
+     * Whether to remove accents. Default: `false`.
+     */
+    clean_accents?: boolean;
+    /**
+     * String to replace sanitized characters. Default: `-`.
+     */
+    sanitize_replacement?: string;
+};
+/**
+ * JSON format options.
+ */
+export type JsonFormatOptions = {
+    /**
+     * Indent style. Default: 'space'.
+     */
+    indent_style?: "space" | "tab";
+    /**
+     * Indent size. Default: 2.
+     */
+    indent_size?: number;
+};
+/**
+ * YAML format options.
+ */
+export type YamlFormatOptions = {
+    /**
+     * Indent size. Default: 2.
+     */
+    indent_size?: number;
+    /**
+     * String value’s default quote type. Default:
+     * 'none'.
+     */
+    quote?: "none" | "double" | "single";
+};
+/**
+ * Data output options.
+ */
+export type OutputOptions = {
+    /**
+     * Whether to prevent fields with `required: false`
+     * and an empty value from being included in entry data output. Default: `false`.
+     */
+    omit_empty_optional_fields?: boolean;
+    /**
+     * JSON format options.
+     */
+    json?: JsonFormatOptions;
+    /**
+     * YAML format options.
+     */
+    yaml?: YamlFormatOptions;
+};
+/**
+ * Site configuration.
+ */
+export type SiteConfig = {
+    /**
+     * Whether to load the `config.yml` file when using manual
+     * initialization. This works only in the `CMS.init()` method’s `config` option. Default: `true`.
+     */
+    load_config_file?: boolean;
+    /**
+     * Backend options.
+     */
+    backend: BackendOptions;
+    /**
+     * Publish mode. Default: simple.
+     */
+    publish_mode?: "simple" | "editorial_workflow" | "";
+    /**
+     * Global internal media folder path, relative to the project’s root
+     * directory.
+     */
+    media_folder: string;
+    /**
+     * Global public media folder path, relative to the project’s
+     * public URL. It must be an absolute path starting with `/`. Default: `media_folder` option value.
+     */
+    public_folder?: string;
+    /**
+     * Media library options.
+     */
+    media_library?: MediaLibrary & GlobalMediaLibraryOptions;
+    /**
+     * Site URL. Default: `location.origin`.
+     */
+    site_url?: string;
+    /**
+     * Site URL linked from the UI. Default: `site_url` option value.
+     */
+    display_url?: string;
+    /**
+     * Absolute URL or absolute path to the site logo that will be
+     * displayed on the Sign-In page and the browser’s tab (favicon). A square image works best.
+     * Default: Sveltia logo.
+     */
+    logo_url?: string;
+    /**
+     * Whether to show site preview links. Default: `true`.
+     */
+    show_preview_links?: boolean;
+    /**
+     * Entry slug options.
+     */
+    slug?: SlugOptions;
+    /**
+     * Set of collections.
+     */
+    collections: Collection[];
+    /**
+     * Global i18n options.
+     */
+    i18n?: I18nOptions;
+    /**
+     * Editor view options.
+     */
+    editor?: EditorOptions;
+    /**
+     * Data output options.
+     */
+    output?: OutputOptions;
+};
+/**
+ * Entry file Parser.
+ */
+export type FileParser = (text: string) => any | Promise<any>;
+/**
+ * Entry file formatter.
+ */
+export type FileFormatter = (value: any) => string | Promise<string>;
+/**
+ * Custom editor component options.
+ */
+export type EditorComponentDefinition = {
+    /**
+     * Unique identifier for the component.
+     */
+    id: string;
+    /**
+     * Label of the component to be displayed in the editor UI.
+     */
+    label: string;
+    /**
+     * Name of a Material Symbols icon to be displayed in the editor UI.
+     */
+    icon?: string;
+    /**
+     * Set of fields to be displayed in the component.
+     */
+    fields: Field[];
+    /**
+     * Regular expression to search a block from Markdown document.
+     */
+    pattern: RegExp;
+    /**
+     * Function to convert
+     * the matching result to field properties. This can be omitted if the `pattern` regex contains
+     * named capturing group(s) that will be passed directly to the internal `createNode` method.
+     */
+    fromBlock?: (match: RegExpMatchArray) => {
+        [key: string]: any;
+    };
+    /**
+     * Function to convert field
+     * properties to Markdown content.
+     */
+    toBlock: (props: {
+        [key: string]: any;
+    }) => string;
+    /**
+     * Function to convert
+     * field properties to field preview.
+     */
+    toPreview: (props: {
+        [key: string]: any;
+    }) => string | JSX.Element;
+};
+/**
+ * Supported event type.
+ */
+export type AppEventType = "prePublish" | "postPublish" | "preUnpublish" | "postUnpublish" | "preSave" | "postSave";
+/**
+ * Event listener properties.
+ */
+export type AppEventListener = {
+    /**
+     * Event type.
+     */
+    name: AppEventType;
+    /**
+     * Event handler.
+     */
+    handler: (args: {
+        entry: Record<string, any>;
+        author?: {
+            login: string;
+            name: string;
+        };
+    }) => any;
+};
+export type CustomPreviewTemplateProps = {
+    entry: Record<string, any>;
+    widgetFor: (name: string) => any;
+    widgetsFor: (name: string) => any;
+    getAsset: (name: string) => any;
+    getCollection: (collectionName: string, slug?: string) => any;
+    document: Document;
+    window: Window;
+};
+export type CustomWidgetControlProps = {
+    value: any;
+    field: Record<string, any>;
+    forID: string;
+    classNameWrapper: string;
+    onChange: (value: any) => void;
+};
+export type CustomWidgetPreviewProps = {
+    value: any;
+    field: Record<string, any>;
+    metadata: Record<string, any>;
+    entry: Record<string, any>;
+    getAsset: (name: string) => any;
+    fieldsMetaData: Record<string, any>;
+};
+export type CustomWidgetSchema = {
+    properties: Record<string, any>;
+};
+import type { JSX } from 'react';