@sveltia/cms 0.123.0 → 0.124.0

package/types/public.d.ts

@@ -118,7 +118,7 @@ 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 widgets instead.
+     * but you can simply use the `multiple` option for the File/Image field types instead.
      */
     multiple?: boolean;
     /**
@@ -258,7 +258,7 @@ export type CommonFieldProps = {
     name: string;
 };
 /**
- * Standard field properties for a built-in widget.
+ * Standard field properties for a built-in field type.
  */
 export type StandardFieldProps = {
     /**
@@ -432,7 +432,7 @@ export type VariableFieldType = {
      */
     label?: string;
     /**
-     * Widget name. Values other than `object` are ignored.
+     * Field type. Values other than `object` are ignored.
      */
     widget?: "object";
     /**
@@ -494,7 +494,7 @@ export type CharCountProps = {
  */
 export type BooleanFieldProps = {
     /**
-     * Widget name.
+     * Field type.
      */
     widget: "boolean";
     /**
@@ -511,7 +511,7 @@ export type BooleanField = VisibleFieldProps & BooleanFieldProps & AdjacentLabel
  */
 export type CodeFieldProps = {
     /**
-     * Widget name.
+     * Field type.
      */
     widget: "code";
     /**
@@ -552,7 +552,7 @@ export type CodeField = VisibleFieldProps & FieldValidationProps & CodeFieldProp
  */
 export type ColorFieldProps = {
     /**
-     * Widget name.
+     * Field type.
      */
     widget: "color";
     /**
@@ -579,7 +579,7 @@ export type ColorField = VisibleFieldProps & FieldValidationProps & ColorFieldPr
  */
 export type ComputeFieldProps = {
     /**
-     * Widget name.
+     * Field type.
      */
     widget: "compute";
     /**
@@ -596,7 +596,7 @@ export type ComputeField = VisibleFieldProps & ComputeFieldProps;
  */
 export type DateTimeFieldProps = {
     /**
-     * Widget name.
+     * Field type.
      */
     widget: "datetime";
     /**
@@ -637,7 +637,7 @@ export type DateTimeField = VisibleFieldProps & FieldValidationProps & DateTimeF
  */
 export type FileFieldProps = {
     /**
-     * Widget name.
+     * Field type.
      */
     widget: "file";
 };
@@ -650,7 +650,7 @@ export type FileField = VisibleFieldProps & FieldValidationProps & MediaFieldPro
  */
 export type HiddenFieldProps = {
     /**
-     * Widget name.
+     * Field type.
      */
     widget: "hidden";
     /**
@@ -676,7 +676,7 @@ export type HiddenField = CommonFieldProps & HiddenFieldProps;
  */
 export type ImageFieldProps = {
     /**
-     * Widget name.
+     * Field type.
      */
     widget: "image";
 };
@@ -689,7 +689,7 @@ export type ImageField = VisibleFieldProps & FieldValidationProps & MediaFieldPr
  */
 export type KeyValueFieldProps = {
     /**
-     * Widget name.
+     * Field type.
      */
     widget: "keyvalue";
     /**
@@ -714,7 +714,7 @@ export type KeyValueField = VisibleFieldProps & KeyValueFieldProps & MultiValueF
  */
 export type ListFieldProps = {
     /**
-     * Widget name.
+     * Field type.
      */
     widget: "list";
     /**
@@ -839,7 +839,7 @@ export type ListField = SimpleListField | ListFieldWithSubField | ListFieldWithS
  */
 export type MapFieldProps = {
     /**
-     * Widget name.
+     * Field type.
      */
     widget: "map";
     /**
@@ -874,13 +874,9 @@ export type RichTextEditorComponentName = "code-block" | "image";
  */
 export type RichTextEditorMode = "rich_text" | "raw";
 /**
- * Markdown field properties.
+ * RichText field base properties.
  */
-export type MarkdownFieldProps = {
-    /**
-     * Widget name.
-     */
-    widget: "markdown";
+export type RichTextFieldBaseProps = {
     /**
      * Default value.
      */
@@ -921,16 +917,38 @@ export type MarkdownFieldProps = {
      */
     linked_images?: boolean;
 };
+/**
+ * RichText field properties.
+ */
+export type RichTextFieldProps = {
+    /**
+     * Field type.
+     */
+    widget: "richtext";
+};
+/**
+ * RichText field definition.
+ */
+export type RichTextField = VisibleFieldProps & FieldValidationProps & RichTextFieldBaseProps & RichTextFieldProps;
+/**
+ * Markdown field properties.
+ */
+export type MarkdownFieldProps = {
+    /**
+     * Field type.
+     */
+    widget: "markdown";
+};
 /**
  * Markdown field definition.
  */
-export type MarkdownField = VisibleFieldProps & FieldValidationProps & MarkdownFieldProps;
+export type MarkdownField = VisibleFieldProps & FieldValidationProps & RichTextFieldBaseProps & MarkdownFieldProps;
 /**
  * Number field properties.
  */
 export type NumberFieldProps = {
     /**
-     * Widget name.
+     * Field type.
      */
     widget: "number";
     /**
@@ -963,7 +981,7 @@ export type NumberField = VisibleFieldProps & FieldValidationProps & NumberField
  */
 export type ObjectFieldProps = {
     /**
-     * Widget name.
+     * Field type.
      */
     widget: "object";
     /**
@@ -1024,7 +1042,7 @@ export type RelationFieldFilterOptions = {
  */
 export type RelationFieldProps = {
     /**
-     * Widget name.
+     * Field type.
      */
     widget: "relation";
     /**
@@ -1077,7 +1095,7 @@ export type SelectFieldValue = string | number | null;
  */
 export type SelectFieldProps = {
     /**
-     * Widget name.
+     * Field type.
      */
     widget: "select";
     /**
@@ -1102,7 +1120,7 @@ export type SelectField = VisibleFieldProps & FieldValidationProps & SelectField
  */
 export type StringFieldProps = {
     /**
-     * Widget name.
+     * Field type.
      */
     widget?: "string";
     /**
@@ -1132,7 +1150,7 @@ export type StringField = VisibleFieldProps & FieldValidationProps & StringField
  */
 export type TextFieldProps = {
     /**
-     * Widget name.
+     * Field type.
      */
     widget: "text";
     /**
@@ -1149,7 +1167,7 @@ export type TextField = VisibleFieldProps & FieldValidationProps & TextFieldProp
  */
 export type UuidFieldProps = {
     /**
-     * Widget name.
+     * Field type.
      */
     widget: "uuid";
     /**
@@ -1167,7 +1185,7 @@ export type UuidFieldProps = {
     /**
      * Whether to make the field read-only. Default: `true`.
      * @deprecated Use the `readonly` common field option instead, which defaults to `true` for the
-     * UUID widget.
+     * UUID field type.
      */
     read_only?: boolean;
 };
@@ -1178,9 +1196,9 @@ export type UuidField = VisibleFieldProps & UuidFieldProps;
 /**
  * Visible field types.
  */
-export type VisibleField = BooleanField | CodeField | ColorField | ComputeField | DateTimeField | FileField | ImageField | KeyValueField | ListField | MapField | MarkdownField | NumberField | ObjectField | RelationField | SelectField | StringField | TextField | UuidField;
+export type VisibleField = BooleanField | CodeField | ColorField | ComputeField | DateTimeField | FileField | ImageField | KeyValueField | ListField | MapField | MarkdownField | NumberField | ObjectField | RelationField | RichTextField | SelectField | StringField | TextField | UuidField;
 /**
- * Entry field using a built-in widget.
+ * Entry field using a built-in field type.
  */
 export type StandardField = VisibleField | HiddenField;
 /**
@@ -1204,21 +1222,21 @@ export type FieldWithSubFields = ListFieldWithSubFields | ObjectFieldWithSubFiel
  */
 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.
+ * Built-in field type name. Sveltia CMS supports all the built-in field types provided by Decap CMS
+ * as well as some new field types.
  */
-export type BuiltInWidgetName = "boolean" | "code" | "color" | "compute" | "datetime" | "file" | "hidden" | "image" | "keyvalue" | "list" | "map" | "markdown" | "number" | "object" | "relation" | "select" | "string" | "text" | "uuid";
+export type BuiltInFieldType = "boolean" | "code" | "color" | "compute" | "datetime" | "file" | "hidden" | "image" | "keyvalue" | "list" | "map" | "markdown" | "number" | "object" | "relation" | "richtext" | "select" | "string" | "text" | "uuid";
 /**
  * Custom field properties.
  */
 export type CustomFieldProps = {
     /**
-     * Widget name.
+     * Field type.
      */
-    widget: Exclude<string, BuiltInWidgetName | "">;
+    widget: Exclude<string, BuiltInFieldType | "">;
 };
 /**
- * Entry field using a custom widget.
+ * Entry field using a custom field type.
  */
 export type CustomField = CommonFieldProps & CustomFieldProps & Record<string, any>;
 /**
@@ -1511,7 +1529,7 @@ export type NestedCollectionOptions = {
  */
 export type CollectionMetaDataPath = {
     /**
-     * Widget for editing the path name.
+     * Field type for editing the path name.
      */
     widget?: "string";
     /**
@@ -2262,7 +2280,7 @@ export type FileParser = (text: string) => any | Promise<any>;
  */
 export type FileFormatter = (value: any) => string | Promise<string>;
 /**
- * Custom editor component options.
+ * Custom rich text editor component options.
  */
 export type EditorComponentDefinition = {
     /**
@@ -2457,14 +2475,14 @@ export type CustomPreviewTemplateProps = {
     document: Document;
     window: Window;
 };
-export type CustomWidgetControlProps = {
+export type CustomFieldControlProps = {
     value: any;
     field: Record<string, any>;
     forID: string;
     classNameWrapper: string;
     onChange: (value: any) => void;
 };
-export type CustomWidgetPreviewProps = {
+export type CustomFieldPreviewProps = {
     value: any;
     field: Record<string, any>;
     metadata: Record<string, any>;
@@ -2472,7 +2490,7 @@ export type CustomWidgetPreviewProps = {
     getAsset: (name: string) => any;
     fieldsMetaData: Record<string, any>;
 };
-export type CustomWidgetSchema = {
+export type CustomFieldSchema = {
     properties: Record<string, any>;
 };
 import type { JSX } from 'react';