@sveltia/cms 0.106.3 → 0.107.0

package/types/public.d.ts

@@ -247,9 +247,9 @@ export type MediaLibraries = {
     stock_assets?: StockAssetMediaLibrary;
 };
 /**
- * Base field properties that are common to all fields.
+ * Common field properties that are shared among all field types.
  */
-export type BaseFieldProps = {
+export type CommonFieldProps = {
     /**
      * Unique identifier for the field. It cannot include periods and spaces.
      */
@@ -281,11 +281,6 @@ export type BaseFieldProps = {
      */
     i18n?: boolean | "duplicate" | "translate" | "none";
 };
-/**
- * Common field properties. We have to allow arbitrary properties because custom widgets can have
- * any properties. This is also required to enable schema autocomplete for the fields in IDEs.
- */
-export type CommonFieldProps = BaseFieldProps & Record<string, any>;
 /**
  * Standard field properties for a built-in widget.
  */
@@ -1119,12 +1114,12 @@ export type CustomFieldProps = {
     /**
      * Widget name.
      */
-    widget: Exclude<string, BuiltInWidgetName>;
+    widget: Exclude<string, BuiltInWidgetName | "">;
 };
 /**
  * Entry field using a custom widget.
  */
-export type CustomField = CommonFieldProps & CustomFieldProps;
+export type CustomField = CommonFieldProps & CustomFieldProps & Record<string, any>;
 /**
  * Entry field.
  */
@@ -1484,10 +1479,9 @@ export type CollectionDivider = {
     divider: boolean;
 };
 /**
- * A raw collection defined in the configuration file. Note: In Sveltia CMS, a folder collection is
- * called an entry collection.
+ * Common collection properties.
  */
-export type Collection = {
+export type CommonCollectionProps = {
     /**
      * Unique identifier for the collection.
      */
@@ -1513,28 +1507,6 @@ export type Collection = {
      * list.
      */
     icon?: string;
-    /**
-     * Field name to be used as the title and slug of an
-     * entry. Entry collection only. Default: `title`.
-     */
-    identifier_field?: FieldKeyPath;
-    /**
-     * A set of files. File collection only.
-     */
-    files?: CollectionFile[];
-    /**
-     * Base folder path relative to the project root. Entry collection only.
-     */
-    folder?: string;
-    /**
-     * Set of fields to be included in entries. Entry collection only.
-     */
-    fields?: Field[];
-    /**
-     * File path relative to `folder`, without a file extension. Entry
-     * collection only.
-     */
-    path?: string;
     /**
      * Internal media folder path for the collection. This overrides
      * the global `media_folder` option. It can be a relative path from the project root if it starts
@@ -1549,33 +1521,15 @@ export type Collection = {
      * overrides the global `public_folder` option. Default: `media_folder` option value.
      */
     public_folder?: string;
-    /**
-     * Entry filter. Entry collection only.
-     */
-    filter?: CollectionFilter;
     /**
      * Whether to hide the collection in the UI. Default: `false`.
      */
     hide?: boolean;
-    /**
-     * Whether to allow users to create entries in the collection. Entry
-     * collection only. Default: `false`.
-     */
-    create?: boolean;
-    /**
-     * Whether to allow users to delete entries in the collection. Entry
-     * collection only. Default: `true`.
-     */
-    delete?: boolean;
     /**
      * Whether to show the publishing control UI for Editorial Workflow.
      * Default: `true`.
      */
     publish?: boolean;
-    /**
-     * File extension. Entry collection only. Default: `md`.
-     */
-    extension?: FileExtension;
     /**
      * File format. It should match the file extension. Default:
      * `yaml-frontmatter`.
@@ -1587,97 +1541,154 @@ export type Collection = {
      */
     frontmatter_delimiter?: string | string[];
     /**
-     * Item slug template. Entry collection only. 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).
+     * 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.
-     * Entry collection only. Default: `Infinity`.
+     * Default: `Infinity`.
      */
     slug_length?: number;
     /**
-     * Entry summary template. Entry collection only. Default:
-     * `identifier_field`.
+     * Entry summary template. Default: `identifier_field`.
      */
     summary?: string;
     /**
-     * Custom sortable fields. Entry
-     * collection only. Default: `title`, `name`, `date`, `author` and `description`. For a Git backend,
-     * commit author and commit date are also included by default. See our
+     * 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.
-     * Entry collection only.
      */
     view_filters?: ViewFilter[] | ViewFilters;
     /**
      * View groups to be used in the entry list.
-     * Entry collection only.
      */
     view_groups?: ViewGroup[] | ViewGroups;
     /**
-     * I18n options. Default: `false`.
-     */
-    i18n?: I18nOptions | boolean;
-    /**
-     * Preview URL path template.
-     */
-    preview_path?: string;
-    /**
-     * Date field name used for `preview_path`.
-     */
-    preview_path_date_field?: string;
-    /**
-     * Editor view options.
-     */
-    editor?: EditorOptions;
-    /**
-     * Options for a nested collection. Entry collection
-     * only.
+     * Options for a nested collection.
      */
     nested?: NestedCollectionOptions;
     /**
-     * Meta data for a nested collection. Entry collection only.
+     * Meta data for a nested collection.
      */
     meta?: CollectionMetaData;
     /**
-     * Index file inclusion options. Entry
-     * collection only. If `true`, the default index file name is `_index`, which is used for Hugo’s
-     * special index file. See our
+     * 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;
-    /**
-     * 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;
     /**
      * A field key path to be used to find an
      * entry thumbnail displayed on the entry list. A nested field can be specified using dot notation,
      * e.g. `heroImage.src`. A wildcard in the key path is also supported, e.g. `images.*.src`. Multiple
      * key paths can be specified as an array for fallbacks. If this option is omitted, the `name` of
-     * any non-nested, non-empty field using the Image or File widget is used. Entry collection only.
+     * 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.
-     * Entry collection only. Default: `Infinity`.
+     * 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.
+ */
+export type FileCollectionProps = {
+    /**
+     * A set of files.
+     */
+    files: CollectionFile[];
+};
+/**
+ * File collection definition.
+ */
+export type FileCollection = CommonCollectionProps & FileCollectionProps;
+/**
+ * Collection definition.
+ */
+export type Collection = EntryCollection | FileCollection;
 /**
  * Supported Git backend name.
  */
@@ -1716,109 +1727,207 @@ export type CommitMessages = {
     openAuthoring?: string;
 };
 /**
- * Backend options.
+ * Git backend properties.
  */
-export type BackendOptions = {
+export type GitBackendProps = {
     /**
-     * Backend name.
+     * Git branch name. If omitted, the default branch, usually `main` or
+     * `master`, will be automatically detected and used.
      */
-    name: BackendName;
+    branch?: string;
     /**
-     * Repository identifier. Required for Git backends. GitHub/Gitea/Forgejo:
-     * organization/user name and repository name joined by a slash, e.g. `owner/repo`. GitLab:
-     * namespace and project name joined by a slash, e.g. `group/project` or `group/subgroup/project`.
+     * Site domain used for OAuth, which will be included in the
+     * `site_id` param to be sent to the API endpoint. Default: [current
+     * hostname](https://developer.mozilla.org/en-US/docs/Web/API/Location/hostname) (or
+     * `cms.netlify.com` on `localhost`).
      */
-    repo?: string;
+    site_domain?: string;
     /**
-     * Git branch name. If omitted, the default branch, usually `main` or
-     * `master`, will be used. Git backends only.
+     * Custom commit messages.
      */
-    branch?: string;
+    commit_messages?: CommitMessages;
     /**
-     * REST API endpoint for the backend. Git backends only. Required when
-     * using GitHub Enterprise Server, a self-hosted GitLab/Gitea/Forgejo instance. Default:
-     * `https://api.github.com` (GitHub), `https://gitlab.com/api/v4` (GitLab) or
-     * `https://gitea.com/api/v1` (Gitea/Forgejo).
+     * Whether to enable or disable automatic deployments
+     * with any connected CI/CD provider. Default: `undefined`.
+     * @deprecated Use the new `skip_ci` option instead, which is more intuitive.
+     * `automatic_deployments: false` is equivalent to `skip_ci: true`, and `automatic_deployments:
+     * true` is equivalent to `skip_ci: false`. See our README
+     * https://github.com/sveltia/sveltia-cms#disabling-automatic-deployments for details.
      */
-    api_root?: string;
+    automatic_deployments?: boolean;
     /**
-     * GraphQL API endpoint for the backend. Git backends only.
-     * Default: inferred from `api_root` option value.
+     * Whether to enable or disable automatic deployments with any
+     * connected CI/CD provider, such as GitHub Actions or Cloudflare Pages. If `true`, the `[skip ci]`
+     * prefix will be added to commit messages. Default: `undefined`. See our
+     * [README](https://github.com/sveltia/sveltia-cms#disabling-automatic-deployments) for details.
      */
-    graphql_api_root?: string;
+    skip_ci?: boolean;
+};
+/**
+ * GitHub backend properties.
+ */
+export type GitHubBackendProps = {
     /**
-     * Site domain used for OAuth, which will be included in the
-     * `site_id` param to be sent to the API endpoint. Git backends only. Default:
-     * [`location.hostname`](https://developer.mozilla.org/en-US/docs/Web/API/Location/hostname).
+     * Backend name.
      */
-    site_domain?: string;
+    name: "github";
+    /**
+     * Repository identifier: organization/user name and repository name joined
+     * by a slash, e.g. `owner/repo`.
+     */
+    repo: string;
+    /**
+     * REST API endpoint for the backend. Required when using GitHub
+     * Enterprise Server. Default: `https://api.github.com`.
+     */
+    api_root?: string;
     /**
-     * OAuth base URL origin. Git backends only. Required when using an
-     * OAuth client other than Netlify, including [Sveltia CMS
-     * Authenticator](https://github.com/sveltia/sveltia-cms-auth). Default: `https://api.netlify.com`
-     * (GitHub), `https://gitlab.com` (GitLab) or `https://gitea.com/` (Gitea/Forgejo).
+     * GraphQL API endpoint for the backend. Default: inferred
+     * from `api_root` option value.
+     */
+    graphql_api_root?: string;
+    /**
+     * OAuth base URL origin. Required when using an OAuth client other
+     * than Netlify, including [Sveltia CMS Authenticator](https://github.com/sveltia/sveltia-cms-auth).
+     * Default: `https://api.netlify.com`.
      */
     base_url?: string;
     /**
-     * OAuth base URL path. Git backends only. Default: `auth`
-     * (GitHub) or `oauth/authorize` (GitLab).
+     * OAuth base URL path. Default: `auth`.
      */
     auth_endpoint?: string;
     /**
-     * OAuth authentication method. GitLab only. Default:
-     * `pkce`.
+     * Pull request label prefix for Editorial Workflow. Default:
+     * `sveltia-cms/`.
+     */
+    cms_label_prefix?: string;
+    /**
+     * Whether to use squash marge for Editorial Workflow. Default:
+     * `false`.
+     */
+    squash_merges?: boolean;
+    /**
+     * Deploy preview link context.
+     */
+    preview_context?: string;
+    /**
+     * Whether to use Open Authoring. Default: `false`.
+     */
+    open_authoring?: boolean;
+    /**
+     * Authentication scope for Open Authoring.
+     */
+    auth_scope?: "repo" | "public_repo";
+};
+/**
+ * GitHub backend.
+ */
+export type GitHubBackend = GitBackendProps & GitHubBackendProps;
+/**
+ * GitLab backend properties.
+ */
+export type GitLabBackendProps = {
+    /**
+     * Backend name.
+     */
+    name: "gitlab";
+    /**
+     * Repository identifier: namespace and project name joined by a slash, e.g.
+     * `group/project` or `group/subgroup/project`.
+     */
+    repo: string;
+    /**
+     * REST API endpoint for the backend. Required when using a
+     * self-hosted GitLab instance. Default: `https://gitlab.com/api/v4`.
+     */
+    api_root?: string;
+    /**
+     * GraphQL API endpoint for the backend. Default: inferred
+     * from `api_root` option value.
+     */
+    graphql_api_root?: string;
+    /**
+     * OAuth base URL origin. Required when using an OAuth client other
+     * than Netlify, including [Sveltia CMS Authenticator](https://github.com/sveltia/sveltia-cms-auth).
+     * Default: `https://gitlab.com`.
+     */
+    base_url?: string;
+    /**
+     * OAuth authorization method. Default: `pkce`.
      */
     auth_type?: "pkce" | "implicit";
     /**
-     * OAuth application ID. GitLab, Gitea/Forgejo only. Required for
-     * Gitea/Forgejo.
+     * OAuth base URL path. Default: `oauth/authorize`.
+     */
+    auth_endpoint?: string;
+    /**
+     * OAuth application ID. Required when using PKCE authorization.
      */
     app_id?: string;
     /**
-     * Custom commit messages. Git backends only.
+     * Pull request label prefix for Editorial Workflow. Default:
+     * `sveltia-cms/`.
      */
-    commit_messages?: CommitMessages;
+    cms_label_prefix?: string;
+};
+/**
+ * GitLab backend.
+ */
+export type GitLabBackend = GitBackendProps & GitLabBackendProps;
+/**
+ * Gitea/Forgejo backend properties.
+ */
+export type GiteaBackendProps = {
     /**
-     * Deploy preview link context. GitHub only.
+     * Backend name.
      */
-    preview_context?: string;
+    name: "gitea";
     /**
-     * Pull request label prefix for Editorial Workflow. Git
-     * backends only. Default: `sveltia-cms/`.
+     * Repository identifier: organization/user name and repository name joined
+     * by a slash, e.g. `owner/repo`.
      */
-    cms_label_prefix?: string;
+    repo: string;
     /**
-     * Whether to use squash marge for Editorial Workflow. Git
-     * backends only. Default: `false`.
+     * REST API endpoint for the backend. Required when using a
+     * self-hosted Gitea/Forgejo instance. Default: `https://gitea.com/api/v1`.
      */
-    squash_merges?: boolean;
+    api_root?: string;
     /**
-     * Whether to use Open Authoring. Git backends only. Default:
-     * `false`.
+     * OAuth base URL origin. Required when using an OAuth client other
+     * than Netlify, including [Sveltia CMS Authenticator](https://github.com/sveltia/sveltia-cms-auth).
+     * Default: `https://gitea.com/`.
      */
-    open_authoring?: boolean;
+    base_url?: string;
     /**
-     * Authentication scope for Open Authoring. Git
-     * backends only.
+     * OAuth base URL path. Default: `login/oauth/authorize`.
      */
-    auth_scope?: "repo" | "public_repo";
+    auth_endpoint?: string;
     /**
-     * Whether to enable or disable automatic deployments
-     * with any connected CI/CD provider. Default: `undefined`.
-     * @deprecated Use the new `skip_ci` option instead, which is more intuitive.
-     * `automatic_deployments: false` is equivalent to `skip_ci: true`, and `automatic_deployments:
-     * true` is equivalent to `skip_ci: false`. See our README
-     * https://github.com/sveltia/sveltia-cms#disabling-automatic-deployments for details.
+     * OAuth application ID.
      */
-    automatic_deployments?: boolean;
+    app_id: string;
+};
+/**
+ * Gitea/Forgejo backend.
+ */
+export type GiteaBackend = GitBackendProps & GiteaBackendProps;
+/**
+ * Git-based backend.
+ */
+export type GitBackend = GitHubBackend | GitLabBackend | GiteaBackend;
+/**
+ * Test backend.
+ */
+export type TestBackend = {
     /**
-     * Whether to enable or disable automatic deployments with any
-     * connected CI/CD provider, such as GitHub Actions or Cloudflare Pages. If `true`, the `[skip ci]`
-     * prefix will be added to commit messages. Git backends only. Default: `undefined`. See our
-     * [README](https://github.com/sveltia/sveltia-cms#disabling-automatic-deployments) for details.
+     * Backend name.
      */
-    skip_ci?: boolean;
+    name: "test-repo";
 };
+/**
+ * Backend options.
+ */
+export type Backend = GitBackend | TestBackend;
 /**
  * Global media library options.
  */
@@ -1916,7 +2025,7 @@ export type SiteConfig = {
     /**
      * Backend options.
      */
-    backend: BackendOptions;
+    backend: Backend;
     /**
      * Publish mode. An empty string is
      * the same as `simple`. Default: `simple`.