@sveltia/cms/types/public.d.ts

Sveltia CMS is a modern, lightweight, Git-based headless content management system.

/**
 * Standard [IETF locale tag](https://en.wikipedia.org/wiki/IETF_language_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](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API/Basic_Terminology#key_path),
 * and use it everywhere, as entry data is managed as a [flatten
 * object](https://www.npmjs.com/package/flat) for easier access.
 */
export type FieldKeyPath = string;
/**
 * Cloud media library name.
 */
export type CloudMediaLibraryName = "cloudinary" | "uploadcare";
/**
 * Supported media library name.
 */
export type MediaLibraryName = "default" | CloudMediaLibraryName | "stock_assets";
/**
 * Supported raster image format.
 */
export type RasterImageFormat = "avif" | "gif" | "jpeg" | "png" | "webp";
/**
 * Supported vector image format.
 */
export type VectorImageFormat = "svg";
/**
 * Supported raster image conversion format. We don’t support AVIF at this time because no browser
 * supports AVIF encoding natively and `@jsquash/avif` is slow. Meanwhile, browsers other than
 * Safari support WebP encoding and `@jsquash/webp` is relatively fast.
 */
export type RasterImageConversionFormat = "webp";
/**
 * Raster image transformation options. See our
 * [README](https://github.com/sveltia/sveltia-cms#optimizing-images-for-upload) for details.
 */
export type RasterImageTransformationOptions = {
    /**
     * New format. Default: `webp`.
     */
    format?: RasterImageConversionFormat;
    /**
     * Image quality between 0 and 100. Default: `85`.
     */
    quality?: number;
    /**
     * Max width. Default: original width.
     */
    width?: number;
    /**
     * Max height. Default: original height.
     */
    height?: number;
};
/**
 * Raster image transformation option map.
 */
export type RasterImageTransformations = {
    /**
     * Raster image transformation options
     * that apply to any supported raster image format.
     */
    raster_image?: RasterImageTransformationOptions;
    /**
     * AVIF image transformation options.
     */
    avif?: RasterImageTransformationOptions;
    /**
     * GIF image transformation options.
     */
    gif?: RasterImageTransformationOptions;
    /**
     * JPEG image transformation options.
     */
    jpeg?: RasterImageTransformationOptions;
    /**
     * PNG image transformation options.
     */
    png?: RasterImageTransformationOptions;
    /**
     * WebP image transformation options.
     */
    webp?: RasterImageTransformationOptions;
};
/**
 * Vector image transformation option map.
 */
export type VectorImageTransformationOptions = {
    /**
     * Whether to optimize the image.
     */
    optimize?: boolean;
};
/**
 * Vector image transformation option map.
 */
export type VectorImageTransformations = {
    /**
     * SVG image transformation options.
     */
    svg?: VectorImageTransformationOptions;
};
/**
 * Image transformation option map.
 */
export type ImageTransformations = RasterImageTransformations & VectorImageTransformations;
/**
 * File transformation option map.
 */
export type FileTransformations = ImageTransformations;
/**
 * Configuration for the default media library.
 */
export type DefaultMediaLibraryConfig = {
    /**
     * Whether to allow multiple file selection in the media library.
     * This option is available for compatibility with the Cloudinary and Uploadcare media libraries,
     * but you can simply use the `multiple` option for the File/Image widgets instead.
     */
    multiple?: boolean;
    /**
     * Maximum file size in bytes that can be accepted for uploading.
     */
    max_file_size?: number;
    /**
     * Whether to rename an original asset file when saving it,
     * according to the global `slug` option. Default: `false`, meaning that the original file name is
     * kept by default, while Netlify/Decap CMS forces to slugify file names. If set to `true`, for
     * example, `Hello World (1).webp` would be `hello-world-1.webp`.
     */
    slugify_filename?: boolean;
    /**
     * File transformation option map. The key is an
     * original format like `png` or `jpeg`. It can also be `raster_image` that matches any supported
     * raster image format. See our
     * [README](https://github.com/sveltia/sveltia-cms#optimizing-images-for-upload) for details.
     */
    transformations?: FileTransformations;
};
/**
 * Options for the default media library.
 */
export type DefaultMediaLibrary = {
    /**
     * Configuration for the default media library.
     */
    config?: DefaultMediaLibraryConfig;
};
/**
 * Options for the [Cloudinary media library](https://decapcms.org/docs/cloudinary/).
 */
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;
    /**
     * 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
     * the [Cloudinary
     * documentation](https://cloudinary.com/documentation/media_library_widget#2_set_the_configuration_options)
     * for a full list of available options. Some options, including `inline_container`, will be ignored
     * in Sveltia CMS because we use an API-based integration instead of Cloudinary’s pre-built widget.
     */
    config?: Record<string, any>;
};
/**
 * Settings for the [Uploadcare media library](https://decapcms.org/docs/uploadcare/).
 */
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](https://decapcms.org/docs/uploadcare/).
 */
export type UploadcareMediaLibrary = {
    /**
     * Options to be passed to Uploadcare, such as `multiple`.
     * The `publicKey` option is required for the global `media_library` option. See the [Uploadcare
     * documentation](https://uploadcare.com/docs/uploads/file-uploader-options/) for a full list of
     * available options. Some options, including `previewStep`, will be ignored in Sveltia CMS because
     * we use an API-based integration instead of Uploadcare’s deprecated jQuery File Uploader.
     */
    config?: Record<string, any>;
    /**
     * Integration settings.
     */
    settings?: UploadcareMediaLibrarySettings;
};
/**
 * Name of supported stock photo/video provider.
 */
export type StockAssetProviderName = "pexels" | "pixabay" | "unsplash";
/**
 * Options for the unified stock photo/video media library.
 */
export type StockAssetMediaLibrary = {
    /**
     * Enabled stock photo/video providers. The stock
     * photo/video section in the asset browser is hidden if an empty array is given. Default: all
     * supported providers.
     */
    providers?: StockAssetProviderName[];
};
/**
 * Supported [media library](https://decapcms.org/docs/configuration-options/#media-library).
 */
export type MediaLibrary = DefaultMediaLibrary | CloudinaryMediaLibrary | UploadcareMediaLibrary | StockAssetMediaLibrary;
/**
 * Unified media library option that supports multiple libraries. See our
 * [README](https://github.com/sveltia/sveltia-cms#configuring-multiple-media-libraries) for
 * details.
 */
export type MediaLibraries = {
    /**
     * Options for the default media library.
     */
    default?: DefaultMediaLibrary;
    /**
     * Options for the Cloudinary media library.
     */
    cloudinary?: CloudinaryMediaLibrary;
    /**
     * Options for the Uploadcare media library.
     */
    uploadcare?: UploadcareMediaLibrary;
    /**
     * Options for the unified stock photo/video media
     * library.
     */
    stock_assets?: StockAssetMediaLibrary;
};
/**
 * Common field properties that are shared among all field types.
 */
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;
    /**
     * 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";
};
/**
 * 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
     * 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[];
    /**
     * Whether to make the field read-only. Default: `false`. This is
     * useful when a `default` value is provided and the field should not be editable by users.
     */
    readonly?: boolean;
    /**
     * Validation format. The first argument is a
     * regular expression matching 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 | RegExp, string];
};
/**
 * Field-level media library options.
 */
export type FieldMediaLibraryOptions = {
    /**
     * Library name.
     */
    name?: MediaLibraryName;
};
/**
 * Media field properties.
 */
export type MediaFieldProps = {
    /**
     * Default value. Accepts a file path or complete URL. If
     * the `multiple` option is set to `true`, it accepts an array of file paths or URLs.
     */
    default?: string | string[];
    /**
     * Whether to allow multiple file selection for the field. Default:
     * `false`.
     */
    multiple?: boolean;
    /**
     * Minimum number of files that can be selected. Ignored unless the
     * `multiple` option is set to `true`. Default: `0`.
     */
    min?: number;
    /**
     * Maximum number of files that can be selected.  Ignored unless the
     * `multiple` option is set to `true`. Default: `Infinity`.
     */
    max?: number;
    /**
     * File types that the field should accept. The value would be a
     * comma-separated list of unique file type specifiers, the format used for the HTML
     * [`accept`](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Attributes/accept)
     * attribute.
     */
    accept?: 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;
    /**
     * Legacy media library option
     * that allows only one library. This overrides the global `media_library` option. Use
     * `media_libraries` instead to support multiple libraries.
     */
    media_library?: MediaLibrary & FieldMediaLibraryOptions;
    /**
     * Unified media library option that supports multiple
     * libraries. This overrides the global `media_libraries` option.
     */
    media_libraries?: MediaLibraries;
};
/**
 * 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. Ignored if `multiple` is
     * `false`. Default: `0`.
     */
    min?: number;
    /**
     * Maximum number of items that can be selected. Ignored if `multiple` is
     * `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`.
     */
    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 fields 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. Accepts `true` or `false`.
     */
    default?: boolean;
};
/**
 * Boolean field definition.
 */
export type BooleanField = CommonFieldProps & StandardFieldProps & 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 the [Prism
     * documentation](https://prismjs.com/#supported-languages) for a list of supported languages.
     * Default: empty string, which is plaintext.
     */
    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`. Default: `{ code: 'code', lang: 'lang' }`.
     */
    keys?: {
        code: string;
        lang: string;
    };
};
/**
 * Code field definition.
 */
export type CodeField = CommonFieldProps & StandardFieldProps & CodeFieldProps;
/**
 * Color field properties.
 */
export type ColorFieldProps = {
    /**
     * Widget name.
     */
    widget: "color";
    /**
     * Default value. Accepts a Hex color code in the six-value (`#RRGGBB`)
     * or eight-value (`#RRGGBBAA`) syntax.
     */
    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. Default: `false`.
     */
    enableAlpha?: boolean;
};
/**
 * Color field definition.
 */
export type ColorField = CommonFieldProps & StandardFieldProps & 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 & StandardFieldProps & 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 [Day.js
     * tokens](https://day.js.org/docs/en/display/format). Default: ISO 8601 format.
     */
    format?: string;
    /**
     * Date storage format written in [Day.js
     * tokens](https://day.js.org/docs/en/display/format) 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 [Day.js
     * tokens](https://day.js.org/docs/en/display/format) 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 & StandardFieldProps & DateTimeFieldProps;
/**
 * File field properties.
 */
export type FileFieldProps = {
    /**
     * Widget name.
     */
    widget: "file";
};
/**
 * File field definition.
 */
export type FileField = CommonFieldProps & StandardFieldProps & 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 & StandardFieldProps & HiddenFieldProps;
/**
 * Image field properties.
 */
export type ImageFieldProps = {
    /**
     * Widget name.
     */
    widget: "image";
};
/**
 * Image field definition.
 */
export type ImageField = CommonFieldProps & StandardFieldProps & MediaFieldProps & ImageFieldProps;
/**
 * KeyValue field properties compatible with Static CMS.
 */
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 & StandardFieldProps & KeyValueFieldProps & MultiValueFieldProps;
/**
 * List field properties.
 */
export type ListFieldProps = {
    /**
     * Widget name.
     */
    widget: "list";
    /**
     * Default value. The
     * format depends on how the field is configured, with or without `field`, `fields` or `types`. See
     * the document for details.
     */
    default?: string[] | Record<string, any>[] | Record<string, any>;
    /**
     * Whether to allow users to add new items to the list. Default:
     * `true`.
     */
    allow_add?: boolean;
    /**
     * Whether to allow users to remove items from the list. Default:
     * `true`.
     */
    allow_remove?: boolean;
    /**
     * Whether to allow users to reorder items in the list. Default:
     * `true`.
     */
    allow_reorder?: 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 list items by default. Default:
     * `false`. If set to `auto`, the UI is collapsed if the item has any filled subfields and expanded
     * if all the subfields are empty.
     */
    collapsed?: boolean | "auto";
    /**
     * Whether to collapse the entire list. Default:
     * `false`. If set to `auto`, the UI is collapsed if the list has any items and expanded if it’s
     * empty.
     */
    minimize_collapsed?: boolean | "auto";
    /**
     * 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 our
     * [README](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 & StandardFieldProps & ListFieldProps & MultiValueFieldProps & VariableFieldProps;
/**
 * Map field properties.
 */
export type MapFieldProps = {
    /**
     * Widget name.
     */
    widget: "map";
    /**
     * Default value. Accepts a stringified single
     * [GeoJSON](https://geojson.org/) geometry object that contains `type` and `coordinates`
     * properties.
     */
    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 & StandardFieldProps & MapFieldProps;
/**
 * Supported button name for the rich text editor.
 */
export type RichTextEditorButtonName = "bold" | "italic" | "strikethrough" | "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: `true`.
     * Note that Sveltia CMS has changed the default value from `false` to `true` to enhance security,
     * whereas Netlify/Decap CMS keeps it as `false`. We recommend keeping this option enabled unless
     * disabling it fixes a broken preview and you fully trust all users of your CMS.
     */
    sanitize_preview?: boolean;
    /**
     * Whether to enable the linked images feature for the built-in
     * `image` component. Default: `true`. When enabled, the image component provides an additional text
     * field for specifying a URL to wrap the image as a link. The resulting Markdown output will be in
     * the format `[![alt](src)](link)`, where clicking the image navigates to the provided link. This
     * feature can be disabled if it causes conflicts with certain frameworks.
     */
    linked_images?: boolean;
};
/**
 * Markdown field definition.
 */
export type MarkdownField = CommonFieldProps & StandardFieldProps & 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: `-Infinity`.
     */
    min?: number;
    /**
     * Maximum value that can be entered in the input. Default: `Infinity`.
     */
    max?: number;
    /**
     * Number to increase/decrease with the arrow key/button. Default: `1`.
     */
    step?: number;
};
/**
 * Number field definition.
 */
export type NumberField = CommonFieldProps & StandardFieldProps & NumberFieldProps & AdjacentLabelProps;
/**
 * Object field properties.
 */
export type ObjectFieldProps = {
    /**
     * Widget name.
     */
    widget: "object";
    /**
     * Default values.
     */
    default?: Record<string, any>;
    /**
     * Whether to collapse the object by default. Default:
     * `false`. If set to `auto`, the UI is collapsed if the object has any filled subfields and
     * expanded if all the subfields are empty.
     */
    collapsed?: boolean | "auto";
    /**
     * Template of a label to be displayed on a collapsed object.
     */
    summary?: string;
    /**
     * Set of fields to be included. Either the `fields` or `types` option
     * is required.
     */
    fields?: Field[];
};
/**
 * Object field definition.
 */
export type ObjectField = CommonFieldProps & StandardFieldProps & 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(s), which should match the options. When
     * `multiple` is `false`, it should be a single value that matches the `value_field` option.
     */
    default?: any | any[];
    /**
     * Referenced collection name. Use `_singletons` for the singleton
     * collection.
     */
    collection: string;
    /**
     * Referenced file identifier for a file/singleton collection. Required if
     * the `collection` is defined.
     */
    file?: string;
    /**
     * Field name to be stored as the value, or
     * `{{slug}}` (entry slug). It can contain a locale prefix like `{{locale}}/{{slug}}` if i18n is
     * enabled. Default: `{{slug}}`.
     */
    value_field?: FieldKeyPath | string;
    /**
     * Name of fields to be displayed. It can
     * contain string templates. Default: `value_field` field value or the referenced collection’s
     * `identifier_field`, which is `title` by default.
     */
    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 & StandardFieldProps & RelationFieldProps & MultiOptionFieldProps;
/**
 * Select field properties.
 */
export type SelectFieldProps = {
    /**
     * Widget name.
     */
    widget: "select";
    /**
     * Default value(s), which should match the options. When
     * `multiple` is `false`, it should be a single value that matches the `value` option.
     */
    default?: any | any[];
    /**
     * Options.
     */
    options: string[] | {
        label: string;
        value: string;
    }[];
};
/**
 * Select field definition.
 */
export type SelectField = CommonFieldProps & StandardFieldProps & SelectFieldProps & MultiOptionFieldProps;
/**
 * String field properties.
 */
export type StringFieldProps = {
    /**
     * Widget name.
     */
    widget?: "string";
    /**
     * Default value.
     */
    default?: string;
    /**
     * Data type. It’s useful when the input value needs a
     * validation. Default: `text`.
     */
    type?: "text" | "url" | "email";
    /**
     * 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 & StandardFieldProps & StringFieldProps & AdjacentLabelProps & CharCountProps;
/**
 * Text field properties.
 */
export type TextFieldProps = {
    /**
     * Widget name.
     */
    widget: "text";
    /**
     * Default value.
     */
    default?: string;
};
/**
 * Text field definition.
 */
export type TextField = CommonFieldProps & StandardFieldProps & TextFieldProps & CharCountProps;
/**
 * UUID field properties.
 */
export type UuidFieldProps = {
    /**
     * Widget name.
     */
    widget: "uuid";
    /**
     * Default value.
     */
    default?: string;
    /**
     * 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`.
     * @deprecated Use the `readonly` common field option instead, which defaults to `true` for the
     * UUID widget.
     */
    read_only?: boolean;
};
/**
 * UUID field definition.
 */
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;
/**
 * Media field types.
 */
export type MediaField = FileField | ImageField;
/**
 * Field types that have the `multiple` option.
 */
export type MultiValueField = MediaField | RelationField | SelectField;
/**
 * Field types that have the `min` and `max` options.
 */
export type MinMaxValueField = MultiValueField | ListField | NumberField;
/**
 * Name of a built-in widget. Sveltia CMS supports all the built-in widgets provided by Decap CMS as
 * well as some new widgets.
 */
export type BuiltInWidgetName = "boolean" | "code" | "color" | "compute" | "datetime" | "file" | "hidden" | "image" | "keyvalue" | "list" | "map" | "markdown" | "number" | "object" | "relation" | "select" | "string" | "text" | "uuid";
/**
 * Custom field properties.
 */
export type CustomFieldProps = {
    /**
     * Widget name.
     */
    widget: Exclude<string, BuiltInWidgetName | "">;
};
/**
 * Entry field using a custom widget.
 */
export type CustomField = CommonFieldProps & CustomFieldProps & Record<string, any>;
/**
 * Entry field.
 */
export type Field = StandardField | 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/singleton
     * collection 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 our
     * [README](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.
     * Default: `true`.
     * @deprecated Use the `initial_locales` option instead, which provides more flexibility.
     * `save_all_locales: false` is equivalent to `initial_locales: all`. See our README
     * 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 our
     * [README](https://github.com/sveltia/sveltia-cms#localizing-entry-slugs) for details.
     */
    canonical_slug?: {
        key?: string;
        value?: string;
    };
    /**
     * 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/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/singleton 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;
    /**
     * Name of a [Material Symbols
     * icon](https://fonts.google.com/icons?icon.set=Material+Symbols) to be displayed in the collection
     * file list and other places. See our
     * [README](https://github.com/sveltia/sveltia-cms#using-a-custom-icon-for-a-collection) for
     * details.
     */
    icon?: string;
    /**
     * File path relative to the project root.
     */
    file: string;
    /**
     * Set of fields to be included in the file.
     */
    fields: Field[];
    /**
     * Internal media folder path for the collection. This overrides
     * the global or collection-level `media_folder` option.
     */
    media_folder?: string;
    /**
     * Public media folder path for an entry collection. This
     * overrides the global or collection-level `public_folder` option. Default: `media_folder` option
     * value.
     */
    public_folder?: string;
    /**
     * File format. This overrides the collection-level `format` option.
     * Default: `yaml-frontmatter`.
     */
    format?: FileFormat;
    /**
     * Delimiters to be used for the front matter
     * format. This overrides the collection-level `frontmatter_delimiter` option. Default: depends on
     * the front matter type.
     */
    frontmatter_delimiter?: string | string[];
    /**
     * 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;
    /**
     * Editor view options.
     */
    editor?: EditorOptions;
};
/**
 * Supported file extension. Actually it can be any string.
 */
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[];
    /**
     * Regular expression matching pattern.
     */
    pattern?: string | RegExp;
};
/**
 * 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 our
     * [README](https://github.com/sveltia/sveltia-cms#specifying-default-sort-field-and-direction) for
     * details.
     */
    default?: SortableFieldsDefaultOptions;
};
/**
 * View filter.
 */
export type ViewFilter = {
    /**
     * Unique identifier for the filter.
     */
    name?: string;
    /**
     * Label.
     */
    label: string;
    /**
     * Field name.
     */
    field: FieldKeyPath;
    /**
     * Regular expression matching pattern or exact value.
     */
    pattern: string | RegExp | boolean;
};
/**
 * A collection’s advanced filter definition, which is compatible with Static CMS.
 */
export type ViewFilters = {
    /**
     * A list of view filters.
     */
    filters: ViewFilter[];
    /**
     * Default filter name.
     */
    default?: string;
};
/**
 * View group.
 */
export type ViewGroup = {
    /**
     * Unique identifier for the group.
     */
    name?: string;
    /**
     * Label.
     */
    label: string;
    /**
     * Field name.
     */
    field: FieldKeyPath;
    /**
     * Regular expression matching pattern or exact
     * value.
     */
    pattern?: string | RegExp | boolean;
};
/**
 * A collection’s advanced group definition, which is compatible with Static CMS.
 */
export type ViewGroups = {
    /**
     * A list of view groups.
     */
    groups: ViewGroup[];
    /**
     * Default group name.
     */
    default?: string;
};
/**
 * 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;
    /**
     * Whether to include subfolders. Default: `true`.
     */
    subfolders?: boolean;
};
/**
 * 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;
};
/**
 * Index file inclusion options. See our
 * [README](https://github.com/sveltia/sveltia-cms#including-hugos-special-index-file-in-a-folder-collection)
 * for details.
 */
export type CollectionIndexFile = {
    /**
     * Index file name without a locale or file extension. Default: `_index`,
     * which is used for Hugo’s special index file.
     */
    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](https://fonts.google.com/icons?icon.set=Material+Symbols) 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.
     */
    fields?: Field[];
    /**
     * Editor view options.
     */
    editor?: EditorOptions;
};
/**
 * A divider in the collection list and singleton list. See our
 * [README](https://github.com/sveltia/sveltia-cms#adding-dividers-to-the-collection-list) for
 * details.
 */
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;
};
/**
 * Common collection properties.
 */
export type CommonCollectionProps = {
    /**
     * 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](https://fonts.google.com/icons?icon.set=Material+Symbols) to be displayed in the collection
     * list.
     */
    icon?: string;
    /**
     * Internal media folder path for the collection. This overrides
     * the global `media_folder` option. It can be a relative path from the project root if it starts
     * with a slash. Otherwise it’s a path relative to the entry. If this option is omitted, the global
     * `media_folder` option value is used. See our
     * [README](https://github.com/sveltia/sveltia-cms#using-a-custom-media-folder-for-a-collection) for
     * details.
     */
    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;
    /**
     * Whether to hide the collection in the UI. Default: `false`.
     */
    hide?: boolean;
    /**
     * Whether to show the publishing control UI for Editorial Workflow.
     * Default: `true`.
     */
    publish?: boolean;
    /**
     * File format. It should match the file extension. Default:
     * `yaml-frontmatter`.
     */
    format?: FileFormat;
    /**
     * Delimiters to be used for the front matter
     * format. Default: depends on the front matter type.
     */
    frontmatter_delimiter?: string | string[];
    /**
     * 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;
    /**
     * Whether to double-quote all the strings values if the YAML
     * format is used for file output. Default: `false`.
     * @deprecated Use the global YAML format options. `yaml_quote: true` is equivalent to `quote:
     * double`. See our README https://github.com/sveltia/sveltia-cms#controlling-data-output for
     * details.
     */
    yaml_quote?: boolean;
};
/**
 * Entry collection properties.
 */
export type EntryCollectionProps = {
    /**
     * Base folder path relative to the project root.
     */
    folder: string;
    /**
     * Set of fields to be included in entries.
     */
    fields: Field[];
    /**
     * File path relative to `folder`, without a file extension.
     */
    path?: string;
    /**
     * Entry filter.
     */
    filter?: CollectionFilter;
    /**
     * Whether to allow users to create entries in the collection. Default:
     * `false`.
     */
    create?: boolean;
    /**
     * Whether to allow users to delete entries in the collection. Default:
     * `true`.
     */
    delete?: boolean;
    /**
     * File extension. Default: `md`.
     */
    extension?: FileExtension;
    /**
     * Field name to be used as the title and slug of an
     * entry. Default: `title`.
     */
    identifier_field?: FieldKeyPath;
    /**
     * Item slug template. Default: `identifier_field` option value. It’s
     * possible to [localize the slug](https://github.com/sveltia/sveltia-cms#localizing-entry-slugs) or
     * [use a random ID](https://github.com/sveltia/sveltia-cms#using-a-random-id-for-an-entry-slug).
     * Also, it’s possible to show a special slug editor field in initial entry drafts by using
     * `{{fields._slug}}` (with an underscore prefix) or `{{fields._slug | localize}}` (to localize the
     * slug).
     */
    slug?: string;
    /**
     * The maximum number of characters allowed for an entry slug.
     * Default: `Infinity`.
     */
    slug_length?: number;
    /**
     * Entry summary template. Default: `identifier_field`.
     */
    summary?: string;
    /**
     * Custom sortable fields. Default:
     * `title`, `name`, `date`, `author` and `description`. For a Git backend, commit author and commit
     * date are also included by default. See our
     * [README](https://github.com/sveltia/sveltia-cms#specifying-default-sort-field-and-direction) for
     * details.
     */
    sortable_fields?: FieldKeyPath[] | SortableFields;
    /**
     * View filters to be used in the entry list.
     */
    view_filters?: ViewFilter[] | ViewFilters;
    /**
     * View groups to be used in the entry list.
     */
    view_groups?: ViewGroup[] | ViewGroups;
    /**
     * Options for a nested collection.
     */
    nested?: NestedCollectionOptions;
    /**
     * Meta data for a nested collection.
     */
    meta?: CollectionMetaData;
    /**
     * Index file inclusion options. If `true`,
     * the default index file name is `_index`, which is used for Hugo’s special index file. See our
     * [README](https://github.com/sveltia/sveltia-cms#including-hugos-special-index-file-in-a-folder-collection)
     * for details.
     */
    index_file?: CollectionIndexFile | 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.
     */
    thumbnail?: FieldKeyPath | FieldKeyPath[];
    /**
     * The maximum number of entries that can be created in the collection.
     * Default: `Infinity`.
     */
    limit?: number;
};
/**
 * Entry collection definition. In Netlify/Decap CMS, an entry collection is called a folder
 * collection.
 */
export type EntryCollection = CommonCollectionProps & EntryCollectionProps;
/**
 * File collection properties.
 */