@sveltia/cms 0.65.0 → 0.67.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sveltia/cms",
-  "version": "0.65.0",
+  "version": "0.67.0",
   "license": "MIT",
   "type": "module",
   "repository": {

package/types/public.d.ts

@@ -14,7 +14,7 @@ export type FieldKeyPath = string;
  */
 export type MediaLibraryName = "default" | "cloudinary" | "uploadcare";
 /**
- * Configuration for the built-in media library.
+ * Configuration for the default media library.
  */
 export type DefaultMediaLibraryOptions = {
     /**
@@ -23,11 +23,11 @@ export type DefaultMediaLibraryOptions = {
     max_file_size?: number;
 };
 /**
- * Options for the built-in media library.
+ * Options for the default media library.
  */
 export type DefaultMediaLibrary = {
     /**
-     * Configuration for the built-in media library.
+     * Configuration for the default media library.
      */
     config?: DefaultMediaLibraryOptions;
 };
@@ -94,9 +94,9 @@ export type MediaLibrary = DefaultMediaLibrary | CloudinaryMediaLibrary | Upload
 /**
  * Unified media library option that supports multiple libraries.
  */
-export type MediaLibraries = {
+export type MediaLibraryMap = {
     /**
-     * Options for the built-in media library.
+     * Options for the default media library.
      */
     default?: DefaultMediaLibrary;
     /**
@@ -194,14 +194,15 @@ export type MediaFieldProps = {
     public_folder?: string;
     /**
      * Legacy media library option
-     * that allows only one library. Use `media_libraries` to support multiple libraries.
+     * 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.
+     * libraries. This overrides the global `media_libraries` option.
      */
-    media_libraries?: MediaLibraries;
+    media_libraries?: MediaLibraryMap;
     /**
      * Whether to enable multiple item selection in an external
      * media library. Default: `true`.
@@ -230,13 +231,13 @@ export type MultiOptionFieldProps = {
      */
     multiple?: boolean;
     /**
-     * Minimum number of items that can be selected. Default: 0. Ignored if
-     * `multiple` is `false`.
+     * 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. Default: infinity. Ignored
-     * if `multiple` is `false`.
+     * Maximum number of items that can be selected. Ignored if `multiple` is
+     * `false`. Default: infinity.
      */
     max?: number;
     /**
@@ -277,7 +278,7 @@ export type VariableFieldType = {
  */
 export type VariableFieldProps = {
     /**
-     * Set of nested Object widgets to be selected or added.
+     * Set of nested Object fields to be selected or added.
      */
     types?: VariableFieldType[];
     /**
@@ -348,7 +349,8 @@ export type CodeFieldProps = {
     default?: string | Record<string, string>;
     /**
      * Default language to be selected, like `js`. See
-     * https://prismjs.com/#supported-languages for a list of supported languages.
+     * https://prismjs.com/#supported-languages for a list of supported languages. Default: empty
+     * string, which is plaintext.
      */
     default_language?: string;
     /**
@@ -392,7 +394,7 @@ export type ColorFieldProps = {
      */
     allowInput?: boolean;
     /**
-     * Whether to edit/save the alpha channel value.
+     * Whether to edit/save the alpha channel value. Default: `false`.
      */
     enableAlpha?: boolean;
 };
@@ -823,9 +825,10 @@ export type StringFieldProps = {
      */
     default?: string;
     /**
-     * Input type. Default: text.
+     * Data type. It’s useful when the input value needs a
+     * validation. Default: text.
      */
-    type?: "email" | "url" | "text";
+    type?: "text" | "url" | "email";
     /**
      * A string to be prepended to the value. Default: empty string.
      */
@@ -1145,7 +1148,7 @@ export type Collection = {
     icon?: string;
     /**
      * Field name to be used as the title and slug of an
-     * entry. Entry collection only. Default: `title` or `name`.
+     * entry. Entry collection only. Default: `title`.
      */
     identifier_field?: FieldKeyPath;
     /**
@@ -1293,10 +1296,14 @@ export type Collection = {
      */
     limit?: number;
 };
+/**
+ * Supported Git backend name.
+ */
+export type GitBackendName = "github" | "gitlab";
 /**
  * Supported backend name.
  */
-export type BackendName = "github" | "gitlab" | "test-repo";
+export type BackendName = GitBackendName | "test-repo";
 /**
  * Custom commit messages.
  */
@@ -1468,7 +1475,7 @@ export type YamlFormatOptions = {
      * String value’s default quote type. Default:
      * 'none'.
      */
-    quote?: "none" | "double" | "single";
+    quote?: "none" | "single" | "double";
 };
 /**
  * Data output options.
@@ -1493,8 +1500,9 @@ export type OutputOptions = {
  */
 export type SiteConfig = {
     /**
-     * Whether to load the `config.yml` file when using manual
-     * initialization. This works only in the `CMS.init()` method’s `config` option. Default: `true`.
+     * Whether to load YAML/JSON site configuration file(s) when
+     * manually initializing the CMS. This works only in the `CMS.init()` method’s `config` option.
+     * Default: `true`.
      */
     load_config_file?: boolean;
     /**
@@ -1502,7 +1510,8 @@ export type SiteConfig = {
      */
     backend: BackendOptions;
     /**
-     * Publish mode. Default: simple.
+     * Publish mode. An empty string is
+     * the same as `simple`. Default: `simple`.
      */
     publish_mode?: "simple" | "editorial_workflow" | "";
     /**
@@ -1518,16 +1527,16 @@ export type SiteConfig = {
     /**
      * Legacy media library option
      * that allows only one library. This overrides the global `media_library` option. Use
-     * `media_libraries` to support multiple libraries.
+     * `media_libraries` instead to support multiple libraries.
      */
     media_library?: MediaLibrary & GlobalMediaLibraryOptions;
     /**
      * Unified media library option that supports multiple
-     * libraries. This overrides the global `media_libraries` option.
+     * libraries.
      */
-    media_libraries?: MediaLibraries;
+    media_libraries?: MediaLibraryMap;
     /**
-     * Site URL. Default: `location.origin`.
+     * Site URL. Default: current site’s origin (`location.origin`).
      */
     site_url?: string;
     /**
@@ -1536,7 +1545,7 @@ export type SiteConfig = {
     display_url?: string;
     /**
      * Absolute URL or absolute path to the site logo that will be
-     * displayed on the Sign-In page and the browser’s tab (favicon). A square image works best.
+     * displayed on the entrance page and the browser’s tab (favicon). A square image works best.
      * Default: Sveltia logo.
      */
     logo_url?: string;