@sveltia/cms 0.101.0 → 0.102.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sveltia/cms",
3
- "version": "0.101.0",
3
+ "version": "0.102.0",
4
4
  "description": "Sveltia CMS is a modern, lightweight, Git-based headless content management system.",
5
5
  "keywords": [
6
6
  "cms",
@@ -322,8 +322,10 @@
322
322
  },
323
323
  "automatic_deployments": {
324
324
  "type": "boolean",
325
- "description": "Whether to enable or disable automatic deployments with any connected CI/CD provider, such as GitHub Actions or Cloudflare Pages. If `false`, 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. DEPRECATED in favor of the `skip_ci` option, which takes an opposite boolean value.",
326
- "markdownDescription": "Whether to enable or disable automatic deployments with any connected CI/CD provider, such as GitHub Actions or Cloudflare Pages. If `false`, 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. DEPRECATED in favor of the `skip_ci` option, which takes an opposite boolean value."
325
+ "description": "Whether to enable or disable automatic deployments with any connected CI/CD provider. Default: `undefined`.",
326
+ "markdownDescription": "Whether to enable or disable automatic deployments with any connected CI/CD provider. Default: `undefined`.",
327
+ "deprecated": true,
328
+ "deprecationMessage": "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."
327
329
  },
328
330
  "skip_ci": {
329
331
  "type": "boolean",
@@ -921,8 +923,10 @@
921
923
  },
922
924
  "yaml_quote": {
923
925
  "type": "boolean",
924
- "description": "Whether to double-quote all the strings values if the YAML format is used for file output. Default: `false`. DEPRECATED in favor of the global YAML format options.",
925
- "markdownDescription": "Whether to double-quote all the strings values if the YAML format is used for file output. Default: `false`. DEPRECATED in favor of the global YAML format options."
926
+ "description": "Whether to double-quote all the strings values if the YAML format is used for file output. Default: `false`.",
927
+ "markdownDescription": "Whether to double-quote all the strings values if the YAML format is used for file output. Default: `false`.",
928
+ "deprecated": true,
929
+ "deprecationMessage": "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."
926
930
  },
927
931
  "thumbnail": {
928
932
  "anyOf": [
@@ -4052,8 +4056,10 @@
4052
4056
  },
4053
4057
  "read_only": {
4054
4058
  "type": "boolean",
4055
- "description": "Whether to make the field read-only. Default: `true`. DEPRECATED in favor of the `readonly` common field property.",
4056
- "markdownDescription": "Whether to make the field read-only. Default: `true`. DEPRECATED in favor of the `readonly` common field property."
4059
+ "description": "Whether to make the field read-only. Default: `true`.",
4060
+ "markdownDescription": "Whether to make the field read-only. Default: `true`.",
4061
+ "deprecated": true,
4062
+ "deprecationMessage": "Use the `readonly` common field option instead, which defaults to `true` for the UUID widget."
4057
4063
  },
4058
4064
  "required": {
4059
4065
  "anyOf": [
@@ -4296,8 +4302,10 @@
4296
4302
  },
4297
4303
  "save_all_locales": {
4298
4304
  "type": "boolean",
4299
- "description": "Whether to save collection entries in all the locales. If `false`, users will be able to disable the output of non-default locales through the UI. See our [README](https://github.com/sveltia/sveltia-cms#disabling-non-default-locale-content) for details. DEPRECATED in favor of the `initial_locales` option.",
4300
- "markdownDescription": "Whether to save collection entries in all the locales. If `false`, users will be able to disable the output of non-default locales through the UI. See our [README](https://github.com/sveltia/sveltia-cms#disabling-non-default-locale-content) for details. DEPRECATED in favor of the `initial_locales` option."
4305
+ "description": "Whether to save collection entries in all the locales. Default: `true`.",
4306
+ "markdownDescription": "Whether to save collection entries in all the locales. Default: `true`.",
4307
+ "deprecated": true,
4308
+ "deprecationMessage": "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."
4301
4309
  },
4302
4310
  "canonical_slug": {
4303
4311
  "type": "object",
package/types/public.d.ts CHANGED
@@ -1061,8 +1061,9 @@ export type UuidFieldProps = {
1061
1061
  */
1062
1062
  use_b32_encoding?: boolean;
1063
1063
  /**
1064
- * Whether to make the field read-only. Default: `true`. DEPRECATED
1065
- * in favor of the `readonly` common field property.
1064
+ * Whether to make the field read-only. Default: `true`.
1065
+ * @deprecated Use the `readonly` common field option instead, which defaults to `true` for the
1066
+ * UUID widget.
1066
1067
  */
1067
1068
  read_only?: boolean;
1068
1069
  };
@@ -1139,10 +1140,11 @@ export type I18nOptions = {
1139
1140
  */
1140
1141
  initial_locales?: LocaleCode[] | "all" | "default";
1141
1142
  /**
1142
- * Whether to save collection entries in all the locales. If
1143
- * `false`, users will be able to disable the output of non-default locales through the UI. See our
1144
- * [README](https://github.com/sveltia/sveltia-cms#disabling-non-default-locale-content) for
1145
- * details. DEPRECATED in favor of the `initial_locales` option.
1143
+ * Whether to save collection entries in all the locales.
1144
+ * Default: `true`.
1145
+ * @deprecated Use the `initial_locales` option instead, which provides more flexibility.
1146
+ * `save_all_locales: false` is equivalent to `initial_locales: all`. See our README
1147
+ * https://github.com/sveltia/sveltia-cms#disabling-non-default-locale-content for details.
1146
1148
  */
1147
1149
  save_all_locales?: boolean;
1148
1150
  /**
@@ -1634,8 +1636,10 @@ export type Collection = {
1634
1636
  index_file?: CollectionIndexFile | boolean;
1635
1637
  /**
1636
1638
  * Whether to double-quote all the strings values if the YAML
1637
- * format is used for file output. Default: `false`. DEPRECATED in favor of the global YAML format
1638
- * options.
1639
+ * format is used for file output. Default: `false`.
1640
+ * @deprecated Use the global YAML format options. `yaml_quote: true` is equivalent to `quote:
1641
+ * double`. See our README https://github.com/sveltia/sveltia-cms#controlling-data-output for
1642
+ * details.
1639
1643
  */
1640
1644
  yaml_quote?: boolean;
1641
1645
  /**
@@ -1778,10 +1782,11 @@ export type BackendOptions = {
1778
1782
  auth_scope?: "repo" | "public_repo";
1779
1783
  /**
1780
1784
  * Whether to enable or disable automatic deployments
1781
- * with any connected CI/CD provider, such as GitHub Actions or Cloudflare Pages. If `false`, the
1782
- * `[skip ci]` prefix will be added to commit messages. Git backends only. Default: `undefined`. See
1783
- * our [README](https://github.com/sveltia/sveltia-cms#disabling-automatic-deployments) for details.
1784
- * DEPRECATED in favor of the `skip_ci` option, which takes an opposite boolean value.
1785
+ * with any connected CI/CD provider. Default: `undefined`.
1786
+ * @deprecated Use the new `skip_ci` option instead, which is more intuitive.
1787
+ * `automatic_deployments: false` is equivalent to `skip_ci: true`, and `automatic_deployments:
1788
+ * true` is equivalent to `skip_ci: false`. See our README
1789
+ * https://github.com/sveltia/sveltia-cms#disabling-automatic-deployments for details.
1785
1790
  */
1786
1791
  automatic_deployments?: boolean;
1787
1792
  /**