@sveltia/cms 0.117.1 → 0.117.2

package/types/public.d.ts

@@ -443,7 +443,7 @@ export type VariableFieldProps = {
     /**
      * Set of nested Object fields to be selected or added.
      */
-    types?: VariableFieldType[];
+    types: VariableFieldType[];
     /**
      * Property name to store the type name in nested objects. Default:
      * `type`.
@@ -706,6 +706,11 @@ export type ListFieldProps = {
      * the document for details.
      */
     default?: string[] | Record<string, any>[] | Record<string, any>;
+};
+/**
+ * Base properties for a complex List field with subfields or variable types.
+ */
+export type ComplexListFieldBaseProps = {
     /**
      * Whether to allow users to add new items to the list. Default:
      * `true`.
@@ -753,14 +758,6 @@ export type ListFieldProps = {
      * empty.
      */
     minimize_collapsed?: boolean | "auto";
-    /**
-     * Single field to be included in a list item.
-     */
-    field?: Field;
-    /**
-     * Set of fields to be included in a list item.
-     */
-    fields?: Field[];
     /**
      * 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
@@ -770,10 +767,52 @@ export type ListFieldProps = {
      */
     root?: boolean;
 };
+/**
+ * Simple List field definition with primitive item types.
+ */
+export type SimpleListField = CommonFieldProps & StandardFieldProps & ListFieldProps;
+/**
+ * Properties for a complex List field with subfields or variable types.
+ */
+export type ComplexListFieldProps = CommonFieldProps & StandardFieldProps & ListFieldProps & ComplexListFieldBaseProps & MultiValueFieldProps;
+/**
+ * Properties for a List field with a single subfield.
+ */
+export type ListFieldSubFieldProps = {
+    /**
+     * Single field to be included in a list item.
+     */
+    field: Field;
+};
+/**
+ * List field definition with a single subfield.
+ */
+export type ListFieldWithSubField = ComplexListFieldProps & ListFieldSubFieldProps;
+/**
+ * Properties for a List field with multiple subfields.
+ */
+export type ListFieldSubFieldsProps = {
+    /**
+     * Set of fields to be included in a list item.
+     */
+    fields: Field[];
+};
+/**
+ * List field definition with multiple subfields.
+ */
+export type ListFieldWithSubFields = ComplexListFieldProps & ListFieldSubFieldsProps;
+/**
+ * List field definition with variable types.
+ */
+export type ListFieldWithTypes = ComplexListFieldProps & VariableFieldProps;
+/**
+ * List field definition with complex items.
+ */
+export type ComplexListField = ListFieldWithSubField | ListFieldWithSubFields | ListFieldWithTypes;
 /**
  * List field definition.
  */
-export type ListField = CommonFieldProps & StandardFieldProps & ListFieldProps & MultiValueFieldProps & VariableFieldProps;
+export type ListField = SimpleListField | ComplexListField;
 /**
  * Map field properties.
  */
@@ -920,16 +959,32 @@ export type ObjectFieldProps = {
      * Template of a label to be displayed on a collapsed object.
      */
     summary?: string;
+};
+/**
+ * Base properties for a complex Object field with subfields or variable types.
+ */
+export type ComplexObjectFieldProps = CommonFieldProps & StandardFieldProps & ObjectFieldProps;
+/**
+ * Properties for an Object field with multiple subfields.
+ */
+export type ObjectFieldSubFieldsProps = {
     /**
-     * Set of fields to be included. Either the `fields` or `types` option
-     * is required.
+     * Set of fields to be included.
      */
-    fields?: Field[];
+    fields: Field[];
 };
+/**
+ * Object field definition with multiple subfields.
+ */
+export type ObjectFieldWithSubFields = ComplexObjectFieldProps & ObjectFieldSubFieldsProps;
+/**
+ * Object field definition with variable types.
+ */
+export type ObjectFieldWithTypes = ComplexObjectFieldProps & VariableFieldProps;
 /**
  * Object field definition.
  */
-export type ObjectField = CommonFieldProps & StandardFieldProps & ObjectFieldProps & VariableFieldProps;
+export type ObjectField = ObjectFieldWithSubFields | ObjectFieldWithTypes;
 /**
  * Entry filter options for a Relation field.
  */
@@ -1115,6 +1170,14 @@ export type MultiValueField = MediaField | RelationField | SelectField;
  * Field types that have the `min` and `max` options.
  */
 export type MinMaxValueField = MultiValueField | ListField | NumberField;
+/**
+ * Field types that have subfields.
+ */
+export type FieldWithSubFields = ListFieldWithSubFields | ObjectFieldWithSubFields;
+/**
+ * Field types that support variable types.
+ */
+export type FieldWithTypes = ListFieldWithTypes | ObjectFieldWithTypes;
 /**
  * Name of a built-in widget. Sveltia CMS supports all the built-in widgets provided by Decap CMS as
  * well as some new widgets.