@sveltia/cms 0.129.0 → 0.129.2

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/types/public.d.ts CHANGED
@@ -1640,7 +1640,7 @@ export type CommonCollectionProps = {
1640
1640
  hide?: boolean;
1641
1641
  /**
1642
1642
  * Whether to show the publishing control UI for Editorial Workflow.
1643
- * Default: `true`.
1643
+ * Default: `true`. Note that Editorial Workflow is not yet supported in Sveltia CMS.
1644
1644
  */
1645
1645
  publish?: boolean;
1646
1646
  /**
@@ -1756,11 +1756,13 @@ export type EntryCollectionProps = {
1756
1756
  */
1757
1757
  view_groups?: ViewGroup[] | ViewGroups;
1758
1758
  /**
1759
- * Options for a nested collection.
1759
+ * Options for a nested collection. Note that nested
1760
+ * collections are not yet supported in Sveltia CMS.
1760
1761
  */
1761
1762
  nested?: NestedCollectionOptions;
1762
1763
  /**
1763
- * Meta data for a nested collection.
1764
+ * Meta data for a nested collection. Note that nested
1765
+ * collections are not yet supported in Sveltia CMS.
1764
1766
  */
1765
1767
  meta?: CollectionMetaData;
1766
1768
  /**
@@ -1925,12 +1927,12 @@ export type GitHubBackendProps = {
1925
1927
  app_id?: string;
1926
1928
  /**
1927
1929
  * Pull request label prefix for Editorial Workflow. Default:
1928
- * `sveltia-cms/`.
1930
+ * `sveltia-cms/`. Note that Editorial Workflow is not yet supported in Sveltia CMS.
1929
1931
  */
1930
1932
  cms_label_prefix?: string;
1931
1933
  /**
1932
1934
  * Whether to use squash marge for Editorial Workflow. Default:
1933
- * `false`.
1935
+ * `false`. Note that Editorial Workflow is not yet supported in Sveltia CMS.
1934
1936
  */
1935
1937
  squash_merges?: boolean;
1936
1938
  /**
@@ -1938,7 +1940,8 @@ export type GitHubBackendProps = {
1938
1940
  */
1939
1941
  preview_context?: string;
1940
1942
  /**
1941
- * Whether to use Open Authoring. Default: `false`.
1943
+ * Whether to use Open Authoring. Default: `false`. Note that
1944
+ * Open Authoring is not yet supported in Sveltia CMS.
1942
1945
  */
1943
1946
  open_authoring?: boolean;
1944
1947
  /**
@@ -1995,12 +1998,12 @@ export type GitLabBackendProps = {
1995
1998
  app_id?: string;
1996
1999
  /**
1997
2000
  * Pull request label prefix for Editorial Workflow. Default:
1998
- * `sveltia-cms/`.
2001
+ * `sveltia-cms/`. Note that Editorial Workflow is not yet supported in Sveltia CMS.
1999
2002
  */
2000
2003
  cms_label_prefix?: string;
2001
2004
  /**
2002
2005
  * Whether to use squash marge for Editorial Workflow. Default:
2003
- * `false`.
2006
+ * `false`. Note that Editorial Workflow is not yet supported in Sveltia CMS.
2004
2007
  */
2005
2008
  squash_merges?: boolean;
2006
2009
  };
@@ -2190,7 +2193,8 @@ export type CmsConfig = {
2190
2193
  backend: Backend;
2191
2194
  /**
2192
2195
  * Publish mode. An empty string is
2193
- * the same as `simple`. Default: `simple`.
2196
+ * the same as `simple`. Default: `simple`. Note that Editorial Workflow is not yet supported in
2197
+ * Sveltia CMS.
2194
2198
  */
2195
2199
  publish_mode?: "" | "simple" | "editorial_workflow";
2196
2200
  /**