@sveltia/cms 0.126.0 → 0.128.0

package/types/public.d.ts

@@ -12,11 +12,11 @@ export type LocaleCode = string;
  */
 export type FieldKeyPath = string;
 /**
- * Cloud media library name.
+ * Cloud media storage name.
  */
 export type CloudMediaLibraryName = "cloudinary" | "uploadcare";
 /**
- * Supported media library name.
+ * Supported media storage name.
  */
 export type MediaLibraryName = "default" | CloudMediaLibraryName | "stock_assets";
 /**
@@ -35,7 +35,7 @@ export type VectorImageFormat = "svg";
 export type RasterImageConversionFormat = "webp";
 /**
  * Raster image transformation options. See our
- * [README](https://github.com/sveltia/sveltia-cms#optimizing-images-for-upload) for details.
+ * [documentation](https://sveltiacms.app/en/docs/media/internal#image-optimization) for details.
  */
 export type RasterImageTransformationOptions = {
     /**
@@ -112,13 +112,13 @@ export type ImageTransformations = RasterImageTransformations & VectorImageTrans
  */
 export type FileTransformations = ImageTransformations;
 /**
- * Configuration for the default media library.
+ * Configuration for the default media storage.
  */
 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 field types instead.
+     * 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;
     /**
@@ -136,21 +136,21 @@ export type DefaultMediaLibraryConfig = {
      * 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.
+     * [documentation](https://sveltiacms.app/en/docs/media/internal#image-optimization) for details.
      */
     transformations?: FileTransformations;
 };
 /**
- * Options for the default media library.
+ * Options for the default media storage.
  */
 export type DefaultMediaLibrary = {
     /**
-     * Configuration for the default media library.
+     * Configuration for the default media storage.
      */
     config?: DefaultMediaLibraryConfig;
 };
 /**
- * Options for the [Cloudinary media library](https://decapcms.org/docs/cloudinary/).
+ * Options for the [Cloudinary media storage](https://sveltiacms.app/en/docs/media/cloudinary).
  */
 export type CloudinaryMediaLibrary = {
     /**
@@ -174,7 +174,7 @@ export type CloudinaryMediaLibrary = {
     config?: Record<string, any>;
 };
 /**
- * Settings for the [Uploadcare media library](https://decapcms.org/docs/uploadcare/).
+ * Settings for the [Uploadcare media storage](https://sveltiacms.app/en/docs/media/uploadcare).
  */
 export type UploadcareMediaLibrarySettings = {
     /**
@@ -189,7 +189,7 @@ export type UploadcareMediaLibrarySettings = {
     defaultOperations?: string;
 };
 /**
- * Options for the [Uploadcare media library](https://decapcms.org/docs/uploadcare/).
+ * Options for the [Uploadcare media storage](https://sveltiacms.app/en/docs/media/uploadcare).
  */
 export type UploadcareMediaLibrary = {
     /**
@@ -210,7 +210,7 @@ export type UploadcareMediaLibrary = {
  */
 export type StockAssetProviderName = "pexels" | "pixabay" | "unsplash";
 /**
- * Options for the unified stock photo/video media library.
+ * Options for the unified stock photo/video providers.
  */
 export type StockAssetMediaLibrary = {
     /**
@@ -221,25 +221,24 @@ export type StockAssetMediaLibrary = {
     providers?: StockAssetProviderName[];
 };
 /**
- * Supported [media library](https://decapcms.org/docs/configuration-options/#media-library).
+ * Supported [media storage](https://sveltiacms.app/en/docs/media).
  */
 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.
+ * Unified media storage option that supports multiple storage providers. See our
+ * [documentation](https://sveltiacms.app/en/docs/media#configuration) for details.
  */
 export type MediaLibraries = {
     /**
-     * Options for the default media library.
+     * Options for the default media storage.
      */
     default?: DefaultMediaLibrary;
     /**
-     * Options for the Cloudinary media library.
+     * Options for the Cloudinary media storage.
      */
     cloudinary?: CloudinaryMediaLibrary;
     /**
-     * Options for the Uploadcare media library.
+     * Options for the Uploadcare media storage.
      */
     uploadcare?: UploadcareMediaLibrary;
     /**
@@ -316,7 +315,7 @@ export type FieldValidationProps = {
     pattern?: [string | RegExp, string];
 };
 /**
- * Field-level media library options.
+ * Field-level media storage options.
  */
 export type FieldMediaLibraryOptions = {
     /**
@@ -370,13 +369,13 @@ export type MediaFieldProps = {
      */
     public_folder?: string;
     /**
-     * Legacy media library option
+     * 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;
     /**
-     * Unified media library option that supports multiple
+     * Unified media storage option that supports multiple
      * libraries. This overrides the global `media_libraries` option.
      */
     media_libraries?: MediaLibraries;
@@ -787,8 +786,7 @@ export type ComplexListFieldBaseProps = {
      * 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.
+     * [documentation](https://sveltiacms.app/en/docs/fields/list#top-level-list) for details.
      */
     root?: boolean;
 };
@@ -1273,7 +1271,7 @@ export type I18nOptions = {
      * 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
+     * [documentation](https://sveltiacms.app/en/docs/i18n#disabling-non-default-locale-content) for
      * details.
      */
     initial_locales?: LocaleCode[] | "all" | "default";
@@ -1281,8 +1279,8 @@ export type I18nOptions = {
      * 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: false` is equivalent to `initial_locales: all`. See our documentation
+     * https://sveltiacms.app/en/docs/i18n#disabling-non-default-locale-content for details.
      */
     save_all_locales?: boolean;
     /**
@@ -1290,7 +1288,7 @@ export type I18nOptions = {
      * 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.
+     * [documentation](https://sveltiacms.app/en/docs/i18n#localizing-entry-slugs) for details.
      */
     canonical_slug?: {
         key?: string;
@@ -1321,8 +1319,7 @@ export type CollectionFile = {
      * 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.
+     * [documentation](https://sveltiacms.app/en/docs/collections#icons) for details.
      */
     icon?: string;
     /**
@@ -1427,8 +1424,7 @@ export type SortableFields = {
     fields: FieldKeyPath[];
     /**
      * Default sort settings. See our
-     * [README](https://github.com/sveltia/sveltia-cms#specifying-default-sort-field-and-direction) for
-     * details.
+     * [documentation](https://sveltiacms.app/en/docs/collections/entries#sorting) for details.
      */
     default?: SortableFieldsDefaultOptions;
 };
@@ -1556,7 +1552,7 @@ export type CollectionMetaData = {
 };
 /**
  * Index file inclusion options. See our
- * [README](https://github.com/sveltia/sveltia-cms#including-hugos-special-index-file-in-a-folder-collection)
+ * [documentation](https://sveltiacms.app/en/docs/collections/entries#managing-hugo-s-special-index-file)
  * for details.
  */
 export type CollectionIndexFile = {
@@ -1588,8 +1584,7 @@ export type CollectionIndexFile = {
 };
 /**
  * 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.
+ * [documentation](https://sveltiacms.app/en/docs/collections#dividers) for details.
  */
 export type CollectionDivider = {
     /**
@@ -1639,7 +1634,7 @@ export type CommonCollectionProps = {
      * 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
+     * [documentation](https://sveltiacms.app/en/docs/media/internal#collection-level-configuration) for
      * details.
      */
     media_folder?: string;
@@ -1687,8 +1682,8 @@ export type CommonCollectionProps = {
      * 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.
+     * double`. See our documentation https://sveltiacms.app/en/docs/data-output#controlling-data-output
+     * for details.
      */
     yaml_quote?: boolean;
 };
@@ -1738,16 +1733,16 @@ export type EntryCollectionProps = {
     /**
      * Item slug template. Default: `identifier_field` option value. It cannot
      * contain slashes; to organize entries in subfolders, use the `path` option instead. 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).
+     * to [localize the slug](https://sveltiacms.app/en/docs/i18n#localizing-entry-slugs) or [use a
+     * random ID](https://sveltiacms.app/en/docs/collections/entries#slug-template-tags). 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`.
+     * @deprecated Use the global `slug.maxlength` option instead.
      */
     slug_length?: number;
     /**
@@ -1758,8 +1753,7 @@ export type EntryCollectionProps = {
      * 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.
+     * [documentation](https://sveltiacms.app/en/docs/collections/entries#sorting) for details.
      */
     sortable_fields?: FieldKeyPath[] | SortableFields;
     /**
@@ -1781,7 +1775,7 @@ export type EntryCollectionProps = {
     /**
      * 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)
+     * [documentation](https://sveltiacms.app/en/docs/collections/entries#managing-hugo-s-special-index-file)
      * for details.
      */
     index_file?: CollectionIndexFile | boolean;
@@ -1883,15 +1877,16 @@ export type GitBackendProps = {
      * 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.
+     * true` is equivalent to `skip_ci: false`. See our documentation
+     * https://sveltiacms.app/en/docs/deployments#disabling-automatic-deployments for details.
      */
     automatic_deployments?: boolean;
     /**
      * 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.
+     * [documentation](https://sveltiacms.app/en/docs/deployments#disabling-automatic-deployments) for
+     * details.
      */
     skip_ci?: boolean;
 };
@@ -2077,7 +2072,7 @@ export type TestBackend = {
  */
 export type Backend = GitBackend | TestBackend;
 /**
- * Global media library options.
+ * Global media storage options.
  */
 export type GlobalMediaLibraryOptions = {
     /**
@@ -2115,11 +2110,20 @@ export type SlugOptions = {
      * String to replace sanitized characters. Default: `-`.
      */
     sanitize_replacement?: string;
+    /**
+     * The maximum number of characters allowed for an entry slug.
+     * Default: `Infinity`.
+     */
+    maxlength?: number;
     /**
      * Whether to trim leading and trailing replacement characters. Default:
      * `true`.
      */
     trim?: boolean;
+    /**
+     * Whether to convert the slug to lowercase. Default: `true`.
+     */
+    lowercase?: boolean;
 };
 /**
  * JSON format options.
@@ -2184,7 +2188,7 @@ export type OutputOptions = {
 export type CmsConfig = {
     /**
      * Whether to load YAML/JSON CMS configuration file(s) when
-     * [manually initializing the CMS](https://decapcms.org/docs/manual-initialization/). This works
+     * [manually initializing the CMS](https://sveltiacms.app/en/docs/api/initialization). This works
      * only in the `CMS.init()` method’s `config` option. Default: `true`.
      */
     load_config_file?: boolean;
@@ -2199,7 +2203,7 @@ export type CmsConfig = {
     publish_mode?: "" | "simple" | "editorial_workflow";
     /**
      * Global internal media folder path, relative to the project’s
-     * root directory. Required unless a cloud media library is configured.
+     * root directory. Required unless a cloud media storage is configured.
      */
     media_folder?: string;
     /**
@@ -2208,15 +2212,14 @@ export type CmsConfig = {
      */
     public_folder?: string;
     /**
-     * Legacy media library option
+     * 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_libraries` instead to support multiple storage providers.
      */
     media_library?: MediaLibrary & GlobalMediaLibraryOptions;
     /**
-     * Unified media library option that supports multiple
-     * libraries. See our
-     * [README](https://github.com/sveltia/sveltia-cms#configuring-multiple-media-libraries) for
+     * Unified media storage option that supports multiple
+     * libraries. See our [documentation](https://sveltiacms.app/en/docs/media#configuration) for
      * details.
      */
     media_libraries?: MediaLibraries;
@@ -2263,7 +2266,7 @@ export type CmsConfig = {
      * Set of singleton files, such as
      * the CMS configuration file or the homepage file. They are not part of any collection and can be
      * accessed directly through the collection list. The list can also contain dividers. See our
-     * [README](https://github.com/sveltia/sveltia-cms#using-singletons) for details.
+     * [documentation](https://sveltiacms.app/en/docs/collections/singletons) for details.
      */
     singletons?: (CollectionFile | CollectionDivider)[];
     /**
@@ -2276,7 +2279,7 @@ export type CmsConfig = {
     editor?: EditorOptions;
     /**
      * Data output options. See our
-     * [README](https://github.com/sveltia/sveltia-cms#controlling-data-output) for details.
+     * [documentation](https://sveltiacms.app/en/docs/data-output#controlling-data-output) for details.
      */
     output?: OutputOptions;
 };