payload 3.0.0-beta.7 → 3.0.0-beta.70

package/dist/fields/config/types.d.ts

@@ -1,19 +1,23 @@
 import type { EditorProps } from '@monaco-editor/react';
 import type { CSSProperties } from 'react';
+import type { JSONSchema4 } from 'json-schema';
 import type React from 'react';
-import type { ConditionalDateProps, Description, ErrorProps, LabelProps, RichTextAdapter, RowLabel } from '../../admin/types.js';
+import type { RichTextAdapter, RichTextAdapterProvider } from '../../admin/RichText.js';
+import type { ConditionalDateProps, Description, DescriptionComponent, ErrorProps, LabelProps, RowLabelComponent } from '../../admin/types.js';
 import type { SanitizedCollectionConfig, TypeWithID } from '../../collections/config/types.js';
 import type { CustomComponent, LabelFunction } from '../../config/types.js';
 import type { DBIdentifierName } from '../../database/types.js';
 import type { SanitizedGlobalConfig } from '../../globals/config/types.js';
+import type { CollectionSlug } from '../../index.js';
+import type { DocumentPreferences } from '../../preferences/types.js';
 import type { Operation, PayloadRequest, RequestContext, Where } from '../../types/index.js';
 import type { ClientFieldConfig } from './client.js';
-export type FieldHookArgs<T extends TypeWithID = any, P = any, S = any> = {
+export type FieldHookArgs<TData extends TypeWithID = any, TValue = any, TSiblingData = any> = {
     /** The collection which the field belongs to. If the field belongs to a global, this will be null. */
     collection: SanitizedCollectionConfig | null;
     context: RequestContext;
     /** The data passed to update the document within create and update operations, and the full document itself in the afterRead hook. */
-    data?: Partial<T>;
+    data?: Partial<TData>;
     /** The field which the hook is running against. */
     field: FieldAffectingData;
     /** Boolean to denote if this hook is running against finding one, or finding many within the afterRead hook. */
@@ -23,49 +27,62 @@ export type FieldHookArgs<T extends TypeWithID = any, P = any, S = any> = {
     /** A string relating to which operation the field type is currently executing within. Useful within beforeValidate, beforeChange, and afterChange hooks to differentiate between create and update operations. */
     operation?: 'create' | 'delete' | 'read' | 'update';
     /** The full original document in `update` operations. In the `afterChange` hook, this is the resulting document of the operation. */
-    originalDoc?: T;
+    originalDoc?: TData;
+    overrideAccess?: boolean;
+    /**
+     * The path of the field, e.g. ["group", "myArray", 1, "textField"]. The path is the schemaPath but with indexes and would be used in the context of field data, not field schemas.
+     */
+    path: (number | string)[];
     /** The document before changes were applied, only in `afterChange` hooks. */
-    previousDoc?: T;
-    /** The sibling data of the document before changes being applied, only in `beforeChange` and `afterChange` hook. */
-    previousSiblingDoc?: T;
-    /** The previous value of the field, before changes, only in `beforeChange` and `afterChange` hooks. */
-    previousValue?: P;
+    previousDoc?: TData;
+    /** The sibling data of the document before changes being applied, only in `beforeChange`, `beforeValidate`, `beforeDuplicate` and `afterChange` field hooks. */
+    previousSiblingDoc?: TData;
+    /** The previous value of the field, before changes, only in `beforeChange`, `afterChange`, `beforeDuplicate` and `beforeValidate` field hooks. */
+    previousValue?: TValue;
     /** The Express request object. It is mocked for Local API operations. */
     req: PayloadRequest;
+    /**
+     * The schemaPath of the field, e.g. ["group", "myArray", "textField"]. The schemaPath is the path but without indexes and would be used in the context of field schemas, not field data.
+     */
+    schemaPath: string[];
     /** The sibling data passed to a field that the hook is running against. */
-    siblingData: Partial<S>;
+    siblingData: Partial<TSiblingData>;
+    /**
+     * The original siblingData with locales (not modified by any hooks). Only available in `beforeChange` and `beforeDuplicate` field hooks.
+     */
+    siblingDocWithLocales?: Record<string, unknown>;
     /** The value of the field. */
-    value?: P;
+    value?: TValue;
 };
-export type FieldHook<T extends TypeWithID = any, P = any, S = any> = (args: FieldHookArgs<T, P, S>) => P | Promise<P>;
-export type FieldAccess<T extends TypeWithID = any, P = any, U = any> = (args: {
+export type FieldHook<TData extends TypeWithID = any, TValue = any, TSiblingData = any> = (args: FieldHookArgs<TData, TValue, TSiblingData>) => Promise<TValue> | TValue;
+export type FieldAccess<TData extends TypeWithID = any, TSiblingData = any> = (args: {
     /**
      * The incoming data used to `create` or `update` the document with. `data` is undefined during the `read` operation.
      */
-    data?: Partial<T>;
+    data?: Partial<TData>;
     /**
      * The original data of the document before the `update` is applied. `doc` is undefined during the `create` operation.
      */
-    doc?: T;
+    doc?: TData;
     /**
      * The `id` of the current document being read or updated. `id` is undefined during the `create` operation.
      */
     id?: number | string;
     /** The `payload` object to interface with the payload API */
-    req: PayloadRequest<U>;
+    req: PayloadRequest;
     /**
      * Immediately adjacent data to this field. For example, if this is a `group` field, then `siblingData` will be the other fields within the group.
      */
-    siblingData?: Partial<P>;
+    siblingData?: Partial<TSiblingData>;
 }) => Promise<boolean> | boolean;
-export type Condition<T extends TypeWithID = any, P = any> = (data: Partial<T>, siblingData: Partial<P>, { user }: {
+export type Condition<TData extends TypeWithID = any, TSiblingData = any> = (data: Partial<TData>, siblingData: Partial<TSiblingData>, { user }: {
     user: PayloadRequest['user'];
 }) => boolean;
-export type FilterOptionsProps<T = any> = {
+export type FilterOptionsProps<TData = any> = {
     /**
      * An object containing the full collection or global document currently being edited.
      */
-    data: T;
+    data: TData;
     /**
      * The `id` of the current document being edited. `id` is undefined during the `create` operation.
      */
@@ -73,7 +90,7 @@ export type FilterOptionsProps<T = any> = {
     /**
      * The collection `slug` to filter against, limited to this field's `relationTo` property.
      */
-    relationTo: string;
+    relationTo: CollectionSlug;
     /**
      * An object containing document data that is scoped to only fields within the same parent of this field.
      */
@@ -83,12 +100,17 @@ export type FilterOptionsProps<T = any> = {
      */
     user: Partial<PayloadRequest['user']>;
 };
-export type FilterOptions<T = any> = ((options: FilterOptionsProps<T>) => Promise<Where | boolean> | Where | boolean) | Where | null;
+export type FilterOptionsFunc<TData = any> = (options: FilterOptionsProps<TData>) => Promise<Where | boolean> | Where | boolean;
+export type FilterOptions<TData = any> = ((options: FilterOptionsProps<TData>) => Promise<Where | boolean> | Where | boolean) | Where | null;
 type Admin = {
     className?: string;
     components?: {
         Cell?: CustomComponent;
+        Description?: DescriptionComponent;
         Field?: CustomComponent;
+        /**
+         * The Filter component has to be a client component
+         */
         Filter?: React.ComponentType<any>;
     };
     /**
@@ -96,8 +118,20 @@ type Admin = {
      * This is also run on the server, to determine if the field should be validated.
      */
     condition?: Condition;
+    /** Extension point to add your custom data. Available in server and client. */
+    custom?: Record<string, any>;
     description?: Description;
     disableBulkEdit?: boolean;
+    /**
+     * Shows / hides fields from appearing in the list view column selector.
+     * @type boolean
+     */
+    disableListColumn?: boolean;
+    /**
+     * Shows / hides fields from appearing in the list view filter options.
+     * @type boolean
+     */
+    disableListFilter?: boolean;
     disabled?: boolean;
     hidden?: boolean;
     position?: 'sidebar';
@@ -113,6 +147,7 @@ export type BaseValidateOptions<TData, TSiblingData> = {
     data: Partial<TData>;
     id?: number | string;
     operation?: Operation;
+    preferences: DocumentPreferences;
     req: PayloadRequest;
     siblingData: Partial<TSiblingData>;
 };
@@ -131,7 +166,7 @@ export interface FieldBase {
         update?: FieldAccess;
     };
     admin?: Admin;
-    /** Extension point to add your custom data. */
+    /** Extension point to add your custom data. Server only. */
     custom?: Record<string, any>;
     defaultValue?: any;
     hidden?: boolean;
@@ -148,14 +183,27 @@ export interface FieldBase {
     index?: boolean;
     label?: LabelFunction | Record<string, string> | false | string;
     localized?: boolean;
+    /**
+     * The name of the field. Must be alphanumeric and cannot contain ' . '
+     *
+     * Must not be one of reserved field names: ['__v', 'salt', 'hash', 'file']
+     * @link https://payloadcms.com/docs/fields/overview#field-names
+     */
     name: string;
     required?: boolean;
     saveToJWT?: boolean | string;
+    /**
+     * Allows you to modify the base JSON schema that is generated during generate:types for this field.
+     * This JSON schema will be used to generate the TypeScript interface of this field.
+     */
+    typescriptSchema?: Array<(args: {
+        jsonSchema: JSONSchema4;
+    }) => JSONSchema4>;
     unique?: boolean;
     validate?: Validate;
 }
-export type NumberField = FieldBase & {
-    admin?: Admin & {
+export type NumberField = {
+    admin?: {
         /** Set this property to a string that will be used for browser autocomplete. */
         autoComplete?: string;
         components?: {
@@ -168,7 +216,7 @@ export type NumberField = FieldBase & {
         placeholder?: Record<string, string> | string;
         /** Set a value for the number field to increment / decrement using browser controls. */
         step?: number;
-    };
+    } & Admin;
     /** Maximum value accepted. Used in the default `validation` function. */
     max?: number;
     /** Minimum value accepted. Used in the default `validation` function. */
@@ -188,9 +236,9 @@ export type NumberField = FieldBase & {
     maxRows?: undefined;
     /** Minimum number of numbers in the numbers array, if `hasMany` is set to true. */
     minRows?: undefined;
-});
-export type TextField = FieldBase & {
-    admin?: Admin & {
+}) & FieldBase;
+export type TextField = {
+    admin?: {
         autoComplete?: string;
         components?: {
             Error?: CustomComponent<ErrorProps>;
@@ -200,7 +248,7 @@ export type TextField = FieldBase & {
         };
         placeholder?: Record<string, string> | string;
         rtl?: boolean;
-    };
+    } & Admin;
     maxLength?: number;
     minLength?: number;
     type: 'text';
@@ -218,9 +266,9 @@ export type TextField = FieldBase & {
     maxRows?: undefined;
     /** Minimum number of strings in the strings array, if `hasMany` is set to true. */
     minRows?: undefined;
-});
-export type EmailField = FieldBase & {
-    admin?: Admin & {
+}) & FieldBase;
+export type EmailField = {
+    admin?: {
         autoComplete?: string;
         components?: {
             Error?: CustomComponent<ErrorProps>;
@@ -229,11 +277,11 @@ export type EmailField = FieldBase & {
             beforeInput?: CustomComponent[];
         };
         placeholder?: Record<string, string> | string;
-    };
+    } & Admin;
     type: 'email';
-};
-export type TextareaField = FieldBase & {
-    admin?: Admin & {
+} & FieldBase;
+export type TextareaField = {
+    admin?: {
         components?: {
             Error?: CustomComponent<ErrorProps>;
             Label?: CustomComponent<LabelProps>;
@@ -243,24 +291,24 @@ export type TextareaField = FieldBase & {
         placeholder?: Record<string, string> | string;
         rows?: number;
         rtl?: boolean;
-    };
+    } & Admin;
     maxLength?: number;
     minLength?: number;
     type: 'textarea';
-};
-export type CheckboxField = FieldBase & {
-    admin?: Admin & {
+} & FieldBase;
+export type CheckboxField = {
+    admin?: {
         components?: {
             Error?: CustomComponent<ErrorProps>;
             Label?: CustomComponent<LabelProps>;
             afterInput?: CustomComponent[];
             beforeInput?: CustomComponent[];
         };
-    };
+    } & Admin;
     type: 'checkbox';
-};
-export type DateField = FieldBase & {
-    admin?: Admin & {
+} & FieldBase;
+export type DateField = {
+    admin?: {
         components?: {
             Error?: CustomComponent<ErrorProps>;
             Label?: CustomComponent<LabelProps>;
@@ -269,54 +317,63 @@ export type DateField = FieldBase & {
         };
         date?: ConditionalDateProps;
         placeholder?: Record<string, string> | string;
-    };
+    } & Admin;
     type: 'date';
-};
-export type GroupField = Omit<FieldBase, 'required' | 'validation'> & {
-    admin?: Admin & {
+} & FieldBase;
+export type GroupField = {
+    admin?: {
         hideGutter?: boolean;
-    };
+    } & Admin;
     fields: Field[];
     /** Customize generated GraphQL and Typescript schema names.
-     * By default it is bound to the collection.
+     * By default, it is bound to the collection.
      *
      * This is useful if you would like to generate a top level type to share amongst collections/fields.
-     * **Note**: Top level types can collide, ensure they are unique among collections, arrays, groups, blocks, tabs.
+     * **Note**: Top level types can collide, ensure they are unique amongst collections, arrays, groups, blocks, tabs.
      */
     interfaceName?: string;
     type: 'group';
-};
+} & Omit<FieldBase, 'required' | 'validation'>;
 export type RowAdmin = Omit<Admin, 'description'>;
-export type RowField = Omit<FieldBase, 'admin' | 'label' | 'name'> & {
+export type RowField = {
     admin?: RowAdmin;
     fields: Field[];
     type: 'row';
-};
-export type CollapsibleField = Omit<FieldBase, 'label' | 'name'> & {
-    admin?: Admin & {
-        initCollapsed?: boolean;
-    };
+} & Omit<FieldBase, 'admin' | 'label' | 'name'>;
+export type CollapsibleField = {
     fields: Field[];
-    label: RowLabel;
     type: 'collapsible';
-};
+} & ({
+    admin: {
+        components: {
+            RowLabel: RowLabelComponent;
+        } & Admin['components'];
+        initCollapsed?: boolean;
+    } & Admin;
+    label?: Required<FieldBase['label']>;
+} | {
+    admin?: {
+        initCollapsed?: boolean;
+    } & Admin;
+    label: Required<FieldBase['label']>;
+}) & Omit<FieldBase, 'label' | 'name'>;
 export type TabsAdmin = Omit<Admin, 'description'>;
-type TabBase = Omit<FieldBase, 'required' | 'validation'> & {
+type TabBase = {
     description?: Description;
     fields: Field[];
     interfaceName?: string;
     saveToJWT?: boolean | string;
-};
-export type NamedTab = TabBase & {
+} & Omit<FieldBase, 'required' | 'validation'>;
+export type NamedTab = {
     /** Customize generated GraphQL and Typescript schema names.
      * The slug is used by default.
      *
      * This is useful if you would like to generate a top level type to share amongst collections/fields.
-     * **Note**: Top level types can collide, ensure they are unique among collections, arrays, groups, blocks, tabs.
+     * **Note**: Top level types can collide, ensure they are unique amongst collections, arrays, groups, blocks, tabs.
      */
     interfaceName?: string;
-};
-export type UnnamedTab = Omit<TabBase, 'name'> & {
+} & TabBase;
+export type UnnamedTab = {
     interfaceName?: never;
     /**
      * Can be either:
@@ -327,36 +384,46 @@ export type UnnamedTab = Omit<TabBase, 'name'> & {
         [selectedLanguage: string]: string;
     } | LabelFunction | string;
     localized?: never;
-};
+} & Omit<TabBase, 'name'>;
 export type Tab = NamedTab | UnnamedTab;
-export type TabsField = Omit<FieldBase, 'admin' | 'localized' | 'name' | 'saveToJWT'> & {
+export type TabsField = {
     admin?: TabsAdmin;
     tabs: Tab[];
     type: 'tabs';
-};
-export type TabAsField = Tab & {
+} & Omit<FieldBase, 'admin' | 'localized' | 'name' | 'saveToJWT'>;
+export type TabAsField = {
     name?: string;
     type: 'tab';
-};
+} & Tab;
 export type UIField = {
     admin: {
         components?: {
             Cell?: CustomComponent;
             Field: CustomComponent;
+            /**
+             * The Filter component has to be a client component
+             */
             Filter?: React.ComponentType<any>;
         };
         condition?: Condition;
+        /** Extension point to add your custom data. Available in server and client. */
+        custom?: Record<string, any>;
         disableBulkEdit?: boolean;
+        /**
+         * Shows / hides fields from appearing in the list view column selector.
+         * @type boolean
+         */
+        disableListColumn?: boolean;
         position?: string;
         width?: string;
     };
-    /** Extension point to add your custom data. */
+    /** Extension point to add your custom data. Server only. */
     custom?: Record<string, any>;
     label?: Record<string, string> | string;
     name: string;
     type: 'ui';
 };
-export type UploadField = FieldBase & {
+export type UploadField = {
     admin?: {
         components?: {
             Error?: CustomComponent<ErrorProps>;
@@ -364,44 +431,54 @@ export type UploadField = FieldBase & {
         };
     };
     filterOptions?: FilterOptions;
+    /**
+     * Sets a maximum population depth for this field, regardless of the remaining depth when this field is reached.
+     *
+     * {@link https://payloadcms.com/docs/getting-started/concepts#field-level-max-depth}
+     */
     maxDepth?: number;
-    relationTo: string;
+    relationTo: CollectionSlug;
     type: 'upload';
-};
-type CodeAdmin = Admin & {
+} & FieldBase;
+type CodeAdmin = {
     components?: {
         Error?: CustomComponent<ErrorProps>;
         Label?: CustomComponent<LabelProps>;
     };
     editorOptions?: EditorProps['options'];
     language?: string;
-};
-export type CodeField = Omit<FieldBase, 'admin'> & {
+} & Admin;
+export type CodeField = {
     admin?: CodeAdmin;
     maxLength?: number;
     minLength?: number;
     type: 'code';
-};
-type JSONAdmin = Admin & {
+} & Omit<FieldBase, 'admin'>;
+type JSONAdmin = {
     components?: {
         Error?: CustomComponent<ErrorProps>;
         Label?: CustomComponent<LabelProps>;
     };
     editorOptions?: EditorProps['options'];
-};
-export type JSONField = Omit<FieldBase, 'admin'> & {
+} & Admin;
+export type JSONField = {
     admin?: JSONAdmin;
+    jsonSchema?: {
+        fileMatch: string[];
+        schema: JSONSchema4;
+        uri: string;
+    };
     type: 'json';
-};
-export type SelectField = FieldBase & {
-    admin?: Admin & {
+} & Omit<FieldBase, 'admin'>;
+export type SelectField = {
+    admin?: {
         components?: {
             Error?: CustomComponent<ErrorProps>;
             Label?: CustomComponent<LabelProps>;
         };
         isClearable?: boolean;
         isSortable?: boolean;
-    };
+    } & Admin;
     /**
      * Customize the SQL table name
      */
@@ -413,10 +490,15 @@ export type SelectField = FieldBase & {
     hasMany?: boolean;
     options: Option[];
     type: 'select';
-};
-type SharedRelationshipProperties = FieldBase & {
+} & FieldBase;
+type SharedRelationshipProperties = {
     filterOptions?: FilterOptions;
     hasMany?: boolean;
+    /**
+     * Sets a maximum population depth for this field, regardless of the remaining depth when this field is reached.
+     *
+     * {@link https://payloadcms.com/docs/getting-started/concepts#field-level-max-depth}
+     */
     maxDepth?: number;
     type: 'relationship';
 } & ({
@@ -443,81 +525,88 @@ type SharedRelationshipProperties = FieldBase & {
      */
     min?: undefined;
     minRows?: undefined;
-});
-type RelationshipAdmin = Admin & {
+}) & FieldBase;
+type RelationshipAdmin = {
     allowCreate?: boolean;
     components?: {
         Error?: CustomComponent<ErrorProps>;
         Label?: CustomComponent<LabelProps>;
     };
     isSortable?: boolean;
-};
-export type PolymorphicRelationshipField = SharedRelationshipProperties & {
-    admin?: RelationshipAdmin & {
+} & Admin;
+export type PolymorphicRelationshipField = {
+    admin?: {
         sortOptions?: {
-            [collectionSlug: string]: string;
+            [collectionSlug: CollectionSlug]: string;
         };
-    };
-    relationTo: string[];
-};
-export type SingleRelationshipField = SharedRelationshipProperties & {
-    admin?: RelationshipAdmin & {
+    } & RelationshipAdmin;
+    relationTo: CollectionSlug[];
+} & SharedRelationshipProperties;
+export type SingleRelationshipField = {
+    admin?: {
         sortOptions?: string;
-    };
-    relationTo: string;
-};
+    } & RelationshipAdmin;
+    relationTo: CollectionSlug;
+} & SharedRelationshipProperties;
 export type RelationshipField = PolymorphicRelationshipField | SingleRelationshipField;
 export type ValueWithRelation = {
-    relationTo: string;
+    relationTo: CollectionSlug;
     value: number | string;
 };
 export declare function valueIsValueWithRelation(value: unknown): value is ValueWithRelation;
 export type RelationshipValue = (number | string)[] | ValueWithRelation | ValueWithRelation[] | (number | string);
-export type RichTextField<Value extends object = any, AdapterProps = any, ExtraProperties = object> = FieldBase & {
-    admin?: Admin & {
+export type RichTextField<Value extends object = any, AdapterProps = any, ExtraProperties = object> = {
+    admin?: {
         components?: {
             Error?: CustomComponent<ErrorProps>;
             Label?: CustomComponent<LabelProps>;
         };
-    };
-    editor?: RichTextAdapter<Value, AdapterProps, AdapterProps>;
+    } & Admin;
+    editor?: RichTextAdapter<Value, AdapterProps, AdapterProps> | RichTextAdapterProvider<Value, AdapterProps, AdapterProps>;
+    /**
+     * Sets a maximum population depth for this field, regardless of the remaining depth when this field is reached.
+     *
+     * {@link https://payloadcms.com/docs/getting-started/concepts#field-level-max-depth}
+     */
+    maxDepth?: number;
     type: 'richText';
-} & ExtraProperties;
-export type RichTextFieldRequiredEditor<Value extends object = any, AdapterProps = any, ExtraProperties = object> = Omit<RichTextField<Value, AdapterProps, ExtraProperties>, 'editor'> & {
-    editor: RichTextAdapter<Value, AdapterProps, ExtraProperties>;
-};
-export type ArrayField = FieldBase & {
-    admin?: Admin & {
+} & ExtraProperties & FieldBase;
+export type ArrayField = {
+    admin?: {
         components?: {
-            RowLabel?: RowLabel;
+            RowLabel?: RowLabelComponent;
         } & Admin['components'];
         initCollapsed?: boolean;
-    };
+        /**
+         * Disable drag and drop sorting
+         */
+        isSortable?: boolean;
+    } & Admin;
     /**
      * Customize the SQL table name
      */
     dbName?: DBIdentifierName;
     fields: Field[];
     /** Customize generated GraphQL and Typescript schema names.
-     * By default it is bound to the collection.
+     * By default, it is bound to the collection.
      *
      * This is useful if you would like to generate a top level type to share amongst collections/fields.
-     * **Note**: Top level types can collide, ensure they are unique among collections, arrays, groups, blocks, tabs.
+     * **Note**: Top level types can collide, ensure they are unique amongst collections, arrays, groups, blocks, tabs.
      */
     interfaceName?: string;
     labels?: Labels;
     maxRows?: number;
     minRows?: number;
     type: 'array';
-};
-export type RadioField = FieldBase & {
-    admin?: Admin & {
+} & FieldBase;
+export type RadioField = {
+    admin?: {
         components?: {
             Error?: CustomComponent<ErrorProps>;
             Label?: CustomComponent<LabelProps>;
         };
         layout?: 'horizontal' | 'vertical';
-    };
+    } & Admin;
     /**
      * Customize the SQL table name
      */
@@ -528,9 +617,22 @@ export type RadioField = FieldBase & {
     enumName?: DBIdentifierName;
     options: Option[];
     type: 'radio';
-};
+} & FieldBase;
 export type Block = {
-    /** Extension point to add your custom data. */
+    admin?: {
+        components?: {
+            Label?: React.FC<{
+                blockKind: 'block' | 'lexicalBlock' | 'lexicalInlineBlock' | string;
+                /**
+                 * May contain the formData
+                 */
+                formData: Record<string, any>;
+            }>;
+        };
+        /** Extension point to add your custom data. Available in server and client. */
+        custom?: Record<string, any>;
+    };
+    /** Extension point to add your custom data. Server only. */
     custom?: Record<string, any>;
     /**
      * Customize the SQL table name
@@ -547,33 +649,36 @@ export type Block = {
      * The slug is used by default.
      *
      * This is useful if you would like to generate a top level type to share amongst collections/fields.
-     * **Note**: Top level types can collide, ensure they are unique among collections, arrays, groups, blocks, tabs.
+     * **Note**: Top level types can collide, ensure they are unique amongst collections, arrays, groups, blocks, tabs.
      */
     interfaceName?: string;
     labels?: Labels;
     slug: string;
 };
-export type BlockField = FieldBase & {
-    admin?: Admin & {
+export type BlockField = {
+    admin?: {
         initCollapsed?: boolean;
-    };
+        /**
+         * Disable drag and drop sorting
+         */
+        isSortable?: boolean;
+    } & Admin;
     blocks: Block[];
     defaultValue?: unknown;
     labels?: Labels;
     maxRows?: number;
     minRows?: number;
     type: 'blocks';
-};
-export type PointField = FieldBase & {
+} & FieldBase;
+export type PointField = {
     type: 'point';
-};
+} & FieldBase;
 export type Field = ArrayField | BlockField | CheckboxField | CodeField | CollapsibleField | DateField | EmailField | GroupField | JSONField | NumberField | PointField | RadioField | RelationshipField | RichTextField | RowField | SelectField | TabsField | TextField | TextareaField | UIField | UploadField;
-export type FieldWithRichTextRequiredEditor = Exclude<Field, RichTextField> | RichTextFieldRequiredEditor;
 export type FieldAffectingData = ArrayField | BlockField | CheckboxField | CodeField | DateField | EmailField | GroupField | JSONField | NumberField | PointField | RadioField | RelationshipField | RichTextField | SelectField | TabAsField | TextField | TextareaField | UploadField;
 export type NonPresentationalField = ArrayField | BlockField | CheckboxField | CodeField | CollapsibleField | DateField | EmailField | GroupField | JSONField | NumberField | PointField | RadioField | RelationshipField | RichTextField | RowField | SelectField | TabsField | TextField | TextareaField | UploadField;
-export type FieldWithPath = Field & {
+export type FieldWithPath = {
     path?: string;
-};
+} & Field;
 export type FieldWithSubFields = ArrayField | CollapsibleField | GroupField | RowField;
 export type FieldPresentationalOnly = UIField;
 export type FieldWithMany = RelationshipField | SelectField;