@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 storage name.
 */
export type CloudMediaLibraryName = "cloudinary" | "uploadcare" | "aws_s3" | "backblaze_b2" | "cloudflare_r2" | "digitalocean_spaces" | "scaleway_object_storage" | "supabase_storage";
/**
 * Supported media storage 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 the
 * [documentation](https://sveltiacms.app/en/docs/media/internal#image-optimization) for details.
 */
export type RasterImageTransformationOptions = {
    /**
     * New format. Default: `webp`.
     */
    format?: "webp" | undefined;
    /**
     * Image quality between 0 and 100. Default: `85`.
     */
    quality?: number | undefined;
    /**
     * Max width. Default: original width.
     */
    width?: number | undefined;
    /**
     * Max height. Default: original height.
     */
    height?: number | undefined;
};
/**
 * Raster image transformation option map.
 */
export type RasterImageTransformations = {
    /**
     * Raster image transformation options
     * that apply to any supported raster image format.
     */
    raster_image?: RasterImageTransformationOptions | undefined;
    /**
     * AVIF image transformation options.
     */
    avif?: RasterImageTransformationOptions | undefined;
    /**
     * GIF image transformation options.
     */
    gif?: RasterImageTransformationOptions | undefined;
    /**
     * JPEG image transformation options.
     */
    jpeg?: RasterImageTransformationOptions | undefined;
    /**
     * PNG image transformation options.
     */
    png?: RasterImageTransformationOptions | undefined;
    /**
     * WebP image transformation options.
     */
    webp?: RasterImageTransformationOptions | undefined;
};
/**
 * Vector image transformation option map.
 */
export type VectorImageTransformationOptions = {
    /**
     * Whether to optimize the image.
     */
    optimize?: boolean | undefined;
};
/**
 * Vector image transformation option map.
 */
export type VectorImageTransformations = {
    /**
     * SVG image transformation options.
     */
    svg?: VectorImageTransformationOptions | undefined;
};
/**
 * Image transformation option map.
 */
export type ImageTransformations = RasterImageTransformations & VectorImageTransformations;
/**
 * File transformation option map.
 */
export type FileTransformations = ImageTransformations;
/**
 * Shared options that apply to all media libraries.
 */
export type SharedMediaLibraryOptions = {
    /**
     * Maximum file size in bytes that can be accepted for uploading.
     */
    max_file_size?: number | undefined;
    /**
     * 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 | undefined;
    /**
     * 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 the
     * [documentation](https://sveltiacms.app/en/docs/media/internal#image-optimization) for details.
     */
    transformations?: ImageTransformations | undefined;
};
/**
 * Configuration for the default media storage.
 */
export type DefaultMediaLibraryBaseConfig = {
    /**
     * Whether to allow multiple file selection in the media storage.
     * This option is available for compatibility with the Cloudinary and Uploadcare media storage
     * providers, but you can simply use the `multiple` option for the File/Image field types instead.
     */
    multiple?: boolean | undefined;
};
/**
 * Configuration for the default media storage.
 */
export type DefaultMediaLibraryConfig = SharedMediaLibraryOptions & DefaultMediaLibraryBaseConfig;
/**
 * Options for the default media storage.
 */
export type DefaultMediaLibrary = {
    /**
     * Configuration for the default media storage.
     */
    config?: DefaultMediaLibraryConfig | undefined;
};
/**
 * Options for the [Cloudinary media storage](https://sveltiacms.app/en/docs/media/cloudinary).
 */
export type CloudinaryMediaLibrary = {
    /**
     * Whether to output a file name instead of a full URL.
     * Default: `false`.
     */
    output_filename_only?: boolean | undefined;
    /**
     * Whether to include transformation segments in an output
     * URL. Default: `true`.
     */
    use_transformations?: boolean | undefined;
    /**
     * 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> | undefined;
};
/**
 * Settings for the [Uploadcare media storage](https://sveltiacms.app/en/docs/media/uploadcare).
 */
export type UploadcareMediaLibrarySettings = {
    /**
     * Whether to append a file name to an output URL. Default:
     * `false`.
     */
    autoFilename?: boolean | undefined;
    /**
     * Transformation operations to be included in an output URL.
     * Default: empty string.
     */
    defaultOperations?: string | undefined;
};
/**
 * Options for the [Uploadcare media storage](https://sveltiacms.app/en/docs/media/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> | undefined;
    /**
     * Integration settings.
     */
    settings?: UploadcareMediaLibrarySettings | undefined;
};
/**
 * Options for S3-compatible media libraries.
 */
export type S3MediaLibrary = {
    /**
     * Media library name (used when configuring via legacy `media_library`).
     */
    name?: string | undefined;
    /**
     * AWS access key ID or equivalent (safe to store in config).
     */
    access_key_id: string;
    /**
     * Bucket name.
     */
    bucket: string;
    /**
     * AWS region (e.g., 'us-east-1'). Required for Amazon S3, DigitalOcean
     * Spaces, Scaleway Object Storage, and Supabase Storage.
     */
    region?: string | undefined;
    /**
     * Cloudflare account ID. Required for Cloudflare R2.
     */
    account_id?: string | undefined;
    /**
     * Cloudflare R2 jurisdiction. Required for
     * buckets created in the EU or FedRAMP jurisdictions; the global endpoint returns an error for
     * those buckets. Default: `'default'`.
     */
    jurisdiction?: "default" | "eu" | "fedramp" | undefined;
    /**
     * Supabase project reference ID. Required for Supabase Storage.
     */
    project_id?: string | undefined;
    /**
     * Custom endpoint URL for S3-compatible services.
     */
    endpoint?: string | undefined;
    /**
     * Path prefix within bucket.
     */
    prefix?: string | undefined;
    /**
     * Use path-style URLs instead of virtual-hosted-style.
     */
    force_path_style?: boolean | undefined;
    /**
     * Base URL for public asset access. When set, asset preview and
     * download URLs are constructed as `{public_url}/{key}` instead of the S3 API endpoint URL.
     * Required for Cloudflare R2 (S3 API endpoint always requires authentication); set to the `r2.dev`
     * development URL (e.g. `https://pub-abcd1234.r2.dev`) or a custom domain. Optional for Amazon S3
     * and DigitalOcean Spaces — use when serving assets through a CDN or custom domain (e.g. CloudFront
     * or Route 53 for S3, CDN endpoint for Spaces).
     */
    public_url?: string | undefined;
};
/**
 * Name of supported stock photo/video provider.
 */
export type StockAssetProviderName = "pexels" | "picsum" | "pixabay" | "unsplash";
/**
 * Options for the unified stock photo/video providers.
 */
export type StockMediaLibrary = {
    /**
     * 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[] | undefined;
};
/**
 * Supported cloud media storage options.
 */
export type CloudMediaLibrary = CloudinaryMediaLibrary | UploadcareMediaLibrary | S3MediaLibrary;
/**
 * Supported [media storage](https://sveltiacms.app/en/docs/media).
 */
export type MediaLibrary = DefaultMediaLibrary | CloudMediaLibrary | StockMediaLibrary;
/**
 * Unified media storage option that supports multiple storage providers. See the
 * [documentation](https://sveltiacms.app/en/docs/media#configuration) for details.
 */
export type MediaLibraries = {
    /**
     * Default options that apply to all internal and cloud
     * media libraries, except for Cloudinary, which uses its own widget. These options can be
     * overridden by library-specific options.
     */
    all?: SharedMediaLibraryOptions | undefined;
    /**
     * Options for the default media storage. Set to
     * `false` to explicitly disable the default (internal) storage.
     */
    default?: false | DefaultMediaLibrary | undefined;
    /**
     * Options for the Cloudinary media storage.
     * Set to `false` to explicitly disable.
     */
    cloudinary?: false | CloudinaryMediaLibrary | undefined;
    /**
     * Options for the Uploadcare media storage.
     * Set to `false` to explicitly disable.
     */
    uploadcare?: false | UploadcareMediaLibrary | undefined;
    /**
     * Options for the Amazon S3 media storage. Set to
     * `false` to explicitly disable.
     */
    aws_s3?: false | S3MediaLibrary | undefined;
    /**
     * Options for the Cloudflare R2 media storage.
     * Set to `false` to explicitly disable.
     */
    cloudflare_r2?: false | S3MediaLibrary | undefined;
    /**
     * Options for the DigitalOcean Spaces
     * media storage. Set to `false` to explicitly disable.
     */
    digitalocean_spaces?: false | S3MediaLibrary | undefined;
    /**
     * Options for the Backblaze B2 media storage. Set
     * to `false` to explicitly disable.
     */
    backblaze_b2?: false | S3MediaLibrary | undefined;
    /**
     * Options for the Scaleway Object
     * Storage media storage. Set to `false` to explicitly disable.
     */
    scaleway_object_storage?: false | S3MediaLibrary | undefined;
    /**
     * Options for the Supabase Storage media
     * storage. Set to `false` to explicitly disable.
     */
    supabase_storage?: false | S3MediaLibrary | undefined;
    /**
     * Options for the unified stock photo/video
     * media library. Set to `false` to explicitly disable.
     */
    stock_assets?: false | StockMediaLibrary | undefined;
};
/**
 * Parsed, localized entry content.
 */
export type RawEntryContent = Record<string, any>;
/**
 * 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;
    /**
     * 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. See the
     * [documentation](https://sveltiacms.app/en/docs/i18n#field-level-configuration) for details.
     */
    i18n?: boolean | "none" | "translate" | "duplicate" | undefined;
};
/**
 * Properties for a field that is visible in the editor UI.
 */
export type VisibleFieldProps = {
    /**
     * Label of the field to be displayed in the editor UI. Default: `name`
     * field value.
     */
    label?: string | undefined;
    /**
     * Short description of the field to be displayed in the editor UI.
     */
    comment?: string | undefined;
    /**
     * Help message to be displayed below the input UI. Limited Markdown
     * formatting is supported: bold, italic, strikethrough and links.
     */
    hint?: string | undefined;
    /**
     * Whether to show the preview of the field. Default: `true`.
     */
    preview?: boolean | undefined;
    /**
     * 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 | string[] | undefined;
    /**
     * 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 | undefined;
};
/**
 * Field validation properties.
 */
export type FieldValidationProps = {
    /**
     * Validation format. The first argument is a
     * regular expression matching pattern for a valid input value, and the second argument is an error
     * message to be displayed when the input value does not match the pattern.
     */
    pattern?: [string | RegExp, string] | undefined;
};
/**
 * Field-level media storage options.
 */
export type FieldMediaLibraryOptions = {
    /**
     * Library name.
     */
    name?: MediaLibraryName | undefined;
};
/**
 * 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[] | undefined;
    /**
     * Whether to allow multiple file selection for the field. Default:
     * `false`.
     */
    multiple?: boolean | undefined;
    /**
     * Minimum number of files that can be selected. Ignored unless the
     * `multiple` option is set to `true`. Default: `0`.
     */
    min?: number | undefined;
    /**
     * Maximum number of files that can be selected.  Ignored unless the
     * `multiple` option is set to `true`. Default: `Infinity`.
     */
    max?: number | undefined;
    /**
     * 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 | undefined;
    /**
     * Whether to show the URL input UI. Default: `true`.
     */
    choose_url?: boolean | undefined;
    /**
     * Internal media folder path for the field. Default: global or
     * collection-level `media_folder` value.
     */
    media_folder?: string | undefined;
    /**
     * Public media folder path for the field. Default:
     * `media_folder` option value.
     */
    public_folder?: string | undefined;
    /**
     * Legacy media storage 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) | undefined;
    /**
     * Unified media storage option that supports multiple
     * libraries. This overrides the global `media_libraries` option.
     */
    media_libraries?: MediaLibraries | undefined;
};
/**
 * Options for a field accepting multiple values.
 */
export type MultiValueFieldProps = {
    /**
     * Minimum number of items that can be added. Default: `0`.
     */
    min?: number | undefined;
    /**
     * Maximum number of items that can be added. Default: `Infinity`.
     */
    max?: number | undefined;
};
/**
 * Options for a field showing multiple options.
 */
export type MultiOptionFieldProps = {
    /**
     * Whether to accept multiple values. Default: `false`.
     */
    multiple?: boolean | undefined;
    /**
     * Minimum number of items that can be selected. Ignored if `multiple` is
     * `false`. Default: `0`.
     */
    min?: number | undefined;
    /**
     * Maximum number of items that can be selected. Ignored if `multiple` is
     * `false`. Default: `Infinity`.
     */
    max?: number | undefined;
    /**
     * 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 | undefined;
};
/**
 * 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 | undefined;
    /**
     * Field type. Values other than `object` are ignored.
     */
    widget?: "object" | undefined;
    /**
     * Template of a label to be displayed on a collapsed object.
     */
    summary?: string | undefined;
    /**
     * Set of subfields. This option can be omitted; in that case, only the
     * `type` property will be saved.
     */
    fields?: Field[] | undefined;
};
/**
 * 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 | undefined;
};
/**
 * 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 | undefined;
    /**
     * An extra label to be displayed after the input UI. Markdown is
     * supported. Default: empty string.
     */
    after_input?: string | undefined;
};
/**
 * 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 | undefined;
    /**
     * Maximum number of characters that can be entered in the input.
     * Default: `Infinity`.
     */
    maxlength?: number | undefined;
};
/**
 * Boolean field properties.
 */
export type BooleanFieldProps = {
    /**
     * Field type.
     */
    widget: "boolean";
    /**
     * Default value. Accepts `true` or `false`.
     */
    default?: boolean | undefined;
};
/**
 * Boolean field definition.
 */
export type BooleanField = CommonFieldProps & VisibleFieldProps & BooleanFieldProps & AdjacentLabelProps;
/**
 * Code field properties.
 */
export type CodeFieldProps = {
    /**
     * Field type.
     */
    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> | undefined;
    /**
     * 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 | undefined;
    /**
     * 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 | undefined;
    /**
     * Whether to output code snippet only. Default: `false`.
     */
    output_code_only?: boolean | undefined;
    /**
     * Output property names. It has no effect if
     * `output_code_only` is `true`. Default: `{ code: 'code', lang: 'lang' }`.
     */
    keys?: {
        code: string;
        lang: string;
    } | undefined;
};
/**
 * Code field definition.
 */
export type CodeField = CommonFieldProps & VisibleFieldProps & FieldValidationProps & CodeFieldProps;
/**
 * Color field properties.
 */
export type ColorFieldProps = {
    /**
     * Field type.
     */
    widget: "color";
    /**
     * Default value. Accepts a Hex color code in the six-value (`#RRGGBB`)
     * or eight-value (`#RRGGBBAA`) syntax.
     */
    default?: string | undefined;
    /**
     * Whether to show a textbox that allows users to manually edit the
     * value. Default: `false`.
     */
    allowInput?: boolean | undefined;
    /**
     * Whether to edit/save the alpha channel value. Default: `false`.
     */
    enableAlpha?: boolean | undefined;
};
/**
 * Color field definition.
 */
export type ColorField = CommonFieldProps & VisibleFieldProps & FieldValidationProps & ColorFieldProps;
/**
 * Compute field properties.
 */
export type ComputeFieldProps = {
    /**
     * Field type.
     */
    widget: "compute";
    /**
     * Value template, like `posts-{{fields.slug}}`.
     */
    value: string;
};
/**
 * Compute field definition.
 */
export type ComputeField = CommonFieldProps & VisibleFieldProps & ComputeFieldProps;
/**
 * DateTime input type. It’s based on the supported date/time input types defined in the HTML spec.
 */
export type DateTimeInputType = "datetime-local" | "date" | "time";
/**
 * DateTime field properties.
 */
export type DateTimeFieldProps = {
    /**
     * Field type.
     */
    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 | undefined;
    /**
     * The
     * [`type`](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#input_types)
     * HTML attribute value for the date/time input. If `type` is set to `date`, the input will only
     * accept date values and the time part will be disabled. If `type` is set to `time`, the input will
     * only accept time values and the date part will be disabled. Default: `datetime-local`, which
     * accepts both date and time values.
     */
    type?: DateTimeInputType | undefined;
    /**
     * The
     * [`min`](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Attributes/min) HTML
     * attribute value for the date/time input. The expected format depends on the `type` option:
     * `YYYY-MM-DDTHH:mm` for `datetime-local`, `YYYY-MM-DD` for `date`, and `HH:mm` for `time`.
     */
    min?: string | undefined;
    /**
     * The
     * [`max`](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Attributes/max) HTML
     * attribute value for the date/time input. The expected format depends on the `type` option:
     * `YYYY-MM-DDTHH:mm` for `datetime-local`, `YYYY-MM-DD` for `date`, and `HH:mm` for `time`.
     */
    max?: string | undefined;
    /**
     * The
     * [`step`](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Attributes/step) HTML
     * attribute value for the date/time input. Accepts a positive integer or `'any'`. For
     * `datetime-local` and `time` inputs, the integer represents the step in seconds (e.g. `300` for
     * 5-minute steps). For `date` inputs, the integer represents the step in days (e.g. `7` for weekly
     * steps). Default: `60` seconds for `datetime-local` and `time`; `1` day for `date`.
     */
    step?: number | "any" | undefined;
    /**
     * Storage format written in [Day.js
     * tokens](https://day.js.org/docs/en/display/format). Default: ISO 8601 format.
     */
    format?: string | undefined;
    /**
     * 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. This option is available for backward compatibility
     * with Netlify CMS; use the `format` or `type` option instead.
     */
    date_format?: string | boolean | undefined;
    /**
     * 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. This option is available for backward compatibility
     * with Netlify CMS; use the `format` or `type` option instead.
     */
    time_format?: string | boolean | undefined;
    /**
     * Whether to make the date input/output UTC. Default: `false`.
     * This option is available for backward compatibility with Netlify/Decap CMS. The newer
     * `input_timezone` and `output_utc` options provide more flexibility and supersede this option when
     * explicitly set. `picker_utc: true` is equivalent to `input_timezone: 'utc'`.
     */
    picker_utc?: boolean | undefined;
    /**
     * Timezone used by the date/time input. This
     * option supersedes `picker_utc`. If set to `local`, the browser’s local timezone is used. If set
     * to `utc`, UTC is used. A custom IANA timezone name such as `America/New_York` or `Asia/Tokyo` may
     * also be provided as a string. Default: `local`.
     */
    input_timezone?: string | undefined;
    /**
     * Whether to convert stored values to UTC. This option supersedes
     * `picker_utc`. If `false`, output values preserve the timezone semantics of `input_timezone`:
     * `local` omits timezone information, `utc` appends a `Z` suffix, and custom timezones preserve
     * their offset (e.g., `-05:00`). If `true`, the input value is converted to UTC for storage. When
     * no custom `format` is specified, a `Z` suffix is appended to the ISO 8601 output. When a custom
     * `format` is used, the value is stored in UTC but formatted according to that pattern — which
     * won’t include an explicit timezone indicator unless the format itself contains `Z`. Note that
     * `input_timezone: 'utc'` already implies UTC semantics, so `output_utc` has no additional effect
     * in that case. Default: `false`.
     */
    output_utc?: boolean | undefined;
};
/**
 * DateTime field definition.
 */
export type DateTimeField = CommonFieldProps & VisibleFieldProps & FieldValidationProps & DateTimeFieldProps;
/**
 * File field properties.
 */
export type FileFieldProps = {
    /**
     * Field type.
     */
    widget: "file";
};
/**
 * File field definition.
 */
export type FileField = CommonFieldProps & VisibleFieldProps & FieldValidationProps & MediaFieldProps & FileFieldProps;
/**
 * Hidden field properties.
 */
export type HiddenFieldProps = {
    /**
     * Field type.
     */
    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 = {
    /**
     * Field type.
     */
    widget: "image";
};
/**
 * Image field definition.
 */
export type ImageField = CommonFieldProps & VisibleFieldProps & FieldValidationProps & MediaFieldProps & ImageFieldProps;
/**
 * KeyValue field properties compatible with Static CMS.
 */
export type KeyValueFieldProps = {
    /**
     * Field type.
     */
    widget: "keyvalue";
    /**
     * Default key-value pairs.
     */
    default?: Record<string, string> | undefined;
    /**
     * Label for the key column. Default: Key.
     */
    key_label?: string | undefined;
    /**
     * Label for the value column. Default: Value.
     */
    value_label?: string | undefined;
    /**
     * 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 key-value pairs will
     * still be saved under locale keys. Default: `false`. See the
     * [documentation](https://sveltiacms.app/en/docs/fields/keyvalue#top-level-key-value-pairs) for
     * details.
     */
    root?: boolean | undefined;
};
/**
 * KeyValue field definition.
 */
export type KeyValueField = CommonFieldProps & VisibleFieldProps & KeyValueFieldProps & MultiValueFieldProps;
/**
 * List field properties.
 */
export type ListFieldProps = {
    /**
     * Field type.
     */
    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>[] | undefined;
};
/**
 * Base properties for a List field.
 */
export type ListFieldBaseProps = CommonFieldProps & VisibleFieldProps & ListFieldProps & MultiValueFieldProps;
/**
 * Simple List field definition with primitive item types.
 */
export type SimpleListField = ListFieldBaseProps & FieldValidationProps;
/**
 * Base properties for a complex List field with subfields or variable types.
 */
export type ComplexListFieldBaseProps = {
    /**
     * Whether to allow users to add new items to the list. Default:
     * `true`.
     */
    allow_add?: boolean | undefined;
    /**
     * Whether to allow users to remove items from the list. Default:
     * `true`.
     */
    allow_remove?: boolean | undefined;
    /**
     * Whether to allow users to duplicate items in the list.
     * Default: `true`.
     */
    allow_duplicate?: boolean | undefined;
    /**
     * Whether to allow users to reorder items in the list. Default:
     * `true`.
     */
    allow_reorder?: boolean | undefined;
    /**
     * Whether to add new items to the top of the list instead of the
     * bottom. Default: `false`.
     */
    add_to_top?: boolean | undefined;
    /**
     * Label to be displayed on the Add button. Default: `label`
     * field value.
     */
    label_singular?: string | undefined;
    /**
     * Template of a label to be displayed on a collapsed list item.
     */
    summary?: string | undefined;
    /**
     * Subfield name to be used as a thumbnail image for a list item. It
     * will be displayed along with the summary label when the item is collapsed. The subfield must be
     * an Image field. Default: none.
     */
    thumbnail?: string | undefined;
    /**
     * 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" | undefined;
    /**
     * 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" | undefined;
    /**
     * 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 the
     * [documentation](https://sveltiacms.app/en/docs/fields/list#top-level-list) for details.
     */
    root?: boolean | undefined;
};
/**
 * Properties for a complex List field with subfields or variable types.
 */
export type ComplexListFieldProps = ListFieldBaseProps & ComplexListFieldBaseProps;
/**
 * Properties for a List field with a single subfield.
 */
export type ListFieldSubFieldProps = {
    /**
     * Single field to be included in a list item.
     */
    field: Field;
};
/**
 * List field definition with a single subfield.
 */
export type ListFieldWithSubField = ComplexListFieldProps & ListFieldSubFieldProps;
/**
 * Properties for a List field with multiple subfields.
 */
export type ListFieldSubFieldsProps = {
    /**
     * Set of fields to be included in a list item.
     */
    fields: Field[];
};
/**
 * List field definition with multiple subfields.
 */
export type ListFieldWithSubFields = ComplexListFieldProps & ListFieldSubFieldsProps;
/**
 * List field definition with variable types.
 */
export type ListFieldWithTypes = ComplexListFieldProps & VariableFieldProps;
/**
 * List field definition with complex items.
 */
export type ComplexListField = ListFieldWithSubField | ListFieldWithSubFields | ListFieldWithTypes;
/**
 * List field definition.
 */
export type ListField = SimpleListField | ListFieldWithSubField | ListFieldWithSubFields | ListFieldWithTypes;
/**
 * Map field properties.
 */
export type MapFieldProps = {
    /**
     * Field type.
     */
    widget: "map";
    /**
     * Default value. Accepts a stringified single
     * [GeoJSON](https://geojson.org/) geometry object that contains `type` and `coordinates`
     * properties.
     */
    default?: string | undefined;
    /**
     * Precision of coordinates to be saved. Default: `7`.
     */
    decimals?: number | undefined;
    /**
     * Geometry type. Default: `Point`.
     */
    type?: "Point" | "LineString" | "Polygon" | undefined;
    /**
     * Default center coordinates as `[longitude, latitude]`.
     * Default: `[0, 0]`.
     */
    center?: [number, number] | undefined;
    /**
     * Default zoom level. Default: `2`.
     */
    zoom?: number | undefined;
};
/**
 * Map field definition.
 */
export type MapField = CommonFieldProps & VisibleFieldProps & FieldValidationProps & 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";
/**
 * RichText field base properties.
 */
export type RichTextFieldBaseProps = {
    /**
     * Default value.
     */
    default?: string | undefined;
    /**
     * Whether to minimize the toolbar height.
     */
    minimal?: boolean | undefined;
    /**
     * Names of formatting buttons and menu items to be
     * enabled in the editor UI. Default: all the supported button names.
     */
    buttons?: RichTextEditorButtonName[] | undefined;
    /**
     * 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?: string[] | undefined;
    /**
     * Whether to allow nested rich text
     * editor components in the editor UI. If set to `'exclude_self'`, nested components are disabled if
     * the parent components include the current component; this is useful to prevent unexpected
     * behavior due to regex matching limitations. Default: `true`.
     */
    allow_nested_components?: boolean | "exclude_self" | undefined;
    /**
     * Editor modes to be enabled. If it’s `[raw, rich_text]`,
     * rich text mode is disabled by default. Default: `[rich_text, raw]`.
     */
    modes?: RichTextEditorMode[] | undefined;
    /**
     * 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 | undefined;
    /**
     * 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 | undefined;
    /**
     * Whether to enable Markdown shortcuts in the rich
     * text editor. Default: `true`. When enabled, typing `-` or `*` at the start of a line creates a
     * bulleted list, `1.` creates a numbered list, `>` creates a blockquote, and `#`, `##`, `###`
     * create headings. Note that standard keyboard shortcuts like `Ctrl+B` for bold and `Ctrl+I` for
     * italic are always enabled regardless of this option.
     */
    use_markdown_shortcuts?: boolean | undefined;
};
/**
 * RichText field properties.
 */
export type RichTextFieldProps = {
    /**
     * Field type.
     */
    widget: "richtext";
};
/**
 * RichText field definition.
 */
export type RichTextField = CommonFieldProps & VisibleFieldProps & FieldValidationProps & RichTextFieldBaseProps & RichTextFieldProps;
/**
 * Markdown field properties.
 */
export type MarkdownFieldProps = {
    /**
     * Field type.
     */
    widget: "markdown";
};
/**
 * Markdown field definition.
 */
export type MarkdownField = CommonFieldProps & VisibleFieldProps & FieldValidationProps & RichTextFieldBaseProps & MarkdownFieldProps;
/**
 * Number field properties.
 */
export type NumberFieldProps = {
    /**
     * Field type.
     */
    widget: "number";
    /**
     * Default value.
     */
    default?: string | number | undefined;
    /**
     * Type of the value. `int`
     * makes the input accept only an integer value and saves it as a number. `float` makes the input
     * accept only a floating-point value and saves it as a number. `int/string` and `float/string` make
     * the input accept only an integer or floating-point value, respectively, but save it as a string.
     * Default: `int`.
     */
    value_type?: "float" | "int" | "int/string" | "float/string" | undefined;
    /**
     * Minimum value that can be entered in the input. Default: `-Infinity`.
     */
    min?: number | undefined;
    /**
     * Maximum value that can be entered in the input. Default: `Infinity`.
     */
    max?: number | undefined;
    /**
     * Number to increase/decrease with the arrow key/button. Default: `1`.
     */
    step?: number | undefined;
};
/**
 * Number field definition.
 */
export type NumberField = CommonFieldProps & VisibleFieldProps & FieldValidationProps & NumberFieldProps & AdjacentLabelProps;
/**
 * Object field properties.
 */
export type ObjectFieldProps = {
    /**
     * Field type.
     */
    widget: "object";
    /**
     * Default values.
     */
    default?: Record<string, any> | undefined;
    /**
     * 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" | undefined;
    /**
     * Template of a label to be displayed on a collapsed object.
     */
    summary?: string | undefined;
};
/**
 * Base properties for a complex Object field with subfields or variable types.
 */
export type ComplexObjectFieldProps = CommonFieldProps & VisibleFieldProps & ObjectFieldProps;
/**
 * Properties for an Object field with multiple subfields.
 */
export type ObjectFieldSubFieldsProps = {
    /**
     * Set of fields to be included.
     */
    fields: Field[];
};
/**
 * Object field definition with multiple subfields.
 */
export type ObjectFieldWithSubFields = ComplexObjectFieldProps & ObjectFieldSubFieldsProps;
/**
 * Object field definition with variable types.
 */
export type ObjectFieldWithTypes = ComplexObjectFieldProps & VariableFieldProps;
/**
 * Object field definition.
 */
export type ObjectField = ObjectFieldWithSubFields | ObjectFieldWithTypes;
/**
 * Entry filter options for a Relation field.
 */
export type RelationFieldFilterOptions = {
    /**
     * Field name.
     */
    field: FieldKeyPath;
    /**
     * One or more values to be matched. String values may contain template
     * tags — `{{fields.fieldName}}` (resolved from the current entry’s field values) or `{{slug}}`
     * (resolved from the current entry’s slug) — that are resolved against the entry currently being
     * edited. Unresolvable templates (e.g. `{{slug}}` for a new, unsaved entry) are ignored.
     */
    values: any[];
    /**
     * If `true`, entries matching this filter are excluded instead of
     * included. Default: `false`.
     */
    exclude?: boolean | undefined;
};
/**
 * Relation field properties.
 */
export type RelationFieldProps = {
    /**
     * Field type.
     */
    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 | undefined;
    /**
     * 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?: string | undefined;
    /**
     * 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?: string[] | undefined;
    /**
     * Name of fields to be searched. Default:
     * `display_fields` field value.
     */
    search_fields?: string[] | undefined;
    /**
     * Entry filter options.
     */
    filters?: RelationFieldFilterOptions[] | undefined;
};
/**
 * Relation field definition.
 */
export type RelationField = CommonFieldProps & VisibleFieldProps & FieldValidationProps & RelationFieldProps & MultiOptionFieldProps;
/**
 * Select field option value.
 */
export type SelectFieldValue = string | number | null;
/**
 * Select field properties.
 */
export type SelectFieldProps = {
    /**
     * Field type.
     */
    widget: "select";
    /**
     * Default value that matches one of the
     * options. When `multiple` is `true`, it should be an array of valid values.
     */
    default?: SelectFieldValue | SelectFieldValue[] | undefined;
    /**
     * Options.
     */
    options: SelectFieldValue[] | {
        label: string;
        value: SelectFieldValue;
    }[];
};
/**
 * Select field definition.
 */
export type SelectField = CommonFieldProps & VisibleFieldProps & FieldValidationProps & SelectFieldProps & MultiOptionFieldProps;
/**
 * String field properties.
 */
export type StringFieldProps = {
    /**
     * Field type.
     */
    widget?: "string" | undefined;
    /**
     * Default value.
     */
    default?: string | undefined;
    /**
     * Data type. It’s useful when the input value needs a
     * validation. Default: `text`.
     */
    type?: "url" | "text" | "email" | undefined;
    /**
     * A string to be prepended to the value. Default: empty string.
     */
    prefix?: string | undefined;
    /**
     * A string to be appended to the value. Default: empty string.
     */
    suffix?: string | undefined;
};
/**
 * String field definition.
 */
export type StringField = CommonFieldProps & VisibleFieldProps & FieldValidationProps & StringFieldProps & AdjacentLabelProps & CharCountProps;
/**
 * Text field properties.
 */
export type TextFieldProps = {
    /**
     * Field type.
     */
    widget: "text";
    /**
     * Default value.
     */
    default?: string | undefined;
};
/**
 * Text field definition.
 */
export type TextField = CommonFieldProps & VisibleFieldProps & FieldValidationProps & TextFieldProps & CharCountProps;
/**
 * UUID field properties.
 */
export type UuidFieldProps = {
    /**
     * Field type.
     */
    widget: "uuid";
    /**
     * Default value.
     */
    default?: string | undefined;
    /**
     * A string to be prepended to the value. Default: empty string.
     */
    prefix?: string | undefined;
    /**
     * Whether to encode the value with Base32. Default: `false`.
     */
    use_b32_encoding?: boolean | undefined;
    /**
     * Whether to make the field read-only. Default: `true`.
     * @deprecated Use the `readonly` common field option instead, which defaults to `true` for the
     * UUID field type.
     */
    read_only?: boolean | undefined;
};
/**
 * UUID field definition.
 */
export type UuidField = CommonFieldProps & VisibleFieldProps & UuidFieldProps;
/**
 * Visible field types.
 */
export type VisibleField = BooleanField | CodeField | ColorField | ComputeField | DateTimeField | FileField | ImageField | KeyValueField | ListField | MapField | MarkdownField | NumberField | ObjectField | RelationField | RichTextField | SelectField | StringField | TextField | UuidField;
/**
 * Entry field using a built-in field type.
 */
export type StandardField = VisibleField | HiddenField;
/**
 * 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 | DateTimeField | ListField | NumberField;
/**
 * Field types that have subfields.
 */
export type FieldWithSubFields = ListFieldWithSubFields | ObjectFieldWithSubFields;
/**
 * Field types that support variable types.
 */
export type FieldWithTypes = ListFieldWithTypes | ObjectFieldWithTypes;
/**
 * Built-in field type name. Sveltia CMS supports all the built-in field types provided by Decap CMS
 * as well as some new field types.
 */
export type BuiltInFieldType = "boolean" | "code" | "color" | "compute" | "datetime" | "file" | "hidden" | "image" | "keyvalue" | "list" | "map" | "markdown" | "number" | "object" | "relation" | "richtext" | "select" | "string" | "text" | "uuid";
/**
 * Custom field properties.
 */
export type CustomFieldProps = {
    /**
     * Field type.
     */
    widget: Exclude<string, BuiltInFieldType | "">;
};
/**
 * Entry field using a custom field type.
 */
export type CustomField = CommonFieldProps & VisibleFieldProps & CustomFieldProps & Record<string, any>;
/**
 * Entry field.
 */
export type Field = StandardField | CustomField;
/**
 * Internationalization (i18n) file structure type.
 */
export type I18nFileStructure = "single_file" | "single_file_default_root" | "multiple_files" | "multiple_folders" | "multiple_folders_i18n_root" | "multiple_root_folders";
/**
 * Global, collection-level or collection file-level i18n options. See the
 * [documentation](https://sveltiacms.app/en/docs/i18n) for details.
 */
export type I18nOptions = {
    /**
     * File structure for entry collections. **Required for
     * the global i18n options**. File/singleton collection must define the structure using `{{locale}}`
     * in the `file` option. `multiple_folders_i18n_root` has been deprecated in favor of
     * `multiple_root_folders`. See the
     * [documentation](https://sveltiacms.app/en/docs/i18n#managing-content-structure) for details.
     */
    structure?: I18nFileStructure | undefined;
    /**
     * List of all available locales. **Required for the global i18n
     * options**.
     */
    locales?: string[] | undefined;
    /**
     * Default locale. Default: first locale in the `locales`
     * option.
     */
    default_locale?: string | undefined;
    /**
     * 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 the
     * [documentation](https://sveltiacms.