payload 1.0.20 → 1.0.21

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

@@ -1,302 +1,302 @@
-import { CSSProperties } from 'react';
-import { Editor } from 'slate';
-import { Operation, Where } from '../../types';
-import { TypeWithID } from '../../collections/config/types';
-import { PayloadRequest } from '../../express/types';
-import { ConditionalDateProps } from '../../admin/components/elements/DatePicker/types';
-import { Description } from '../../admin/components/forms/FieldDescription/types';
-import { User } from '../../auth';
-import { Payload } from '../..';
-export declare type FieldHookArgs<T extends TypeWithID = any, P = any, S = any> = {
-    data?: Partial<T>;
-    findMany?: boolean;
-    originalDoc?: T;
-    operation?: 'create' | 'read' | 'update' | 'delete';
-    req: PayloadRequest;
-    siblingData: Partial<S>;
-    value?: P;
-};
-export declare type FieldHook<T extends TypeWithID = any, P = any, S = any> = (args: FieldHookArgs<T, P, S>) => Promise<P> | P;
-export declare type FieldAccess<T extends TypeWithID = any, P = any> = (args: {
-    req: PayloadRequest;
-    id?: string | number;
-    data?: Partial<T>;
-    siblingData?: Partial<P>;
-    doc?: T;
-}) => Promise<boolean> | boolean;
-export declare type Condition<T extends TypeWithID = any, P = any> = (data: Partial<T>, siblingData: Partial<P>) => boolean;
-export declare type FilterOptionsProps = {
-    id: string | number;
-    user: Partial<User>;
-    data: unknown;
-    siblingData: unknown;
-    relationTo: string | string[];
-};
-export declare type FilterOptions = Where | ((options: FilterOptionsProps) => Where);
-declare type Admin = {
-    position?: 'sidebar';
-    width?: string;
-    style?: CSSProperties;
-    className?: string;
-    readOnly?: boolean;
-    disabled?: boolean;
-    condition?: Condition;
-    description?: Description;
-    components?: {
-        Filter?: React.ComponentType;
-        Cell?: React.ComponentType;
-        Field?: React.ComponentType;
-    };
-    hidden?: boolean;
-};
-export declare type Labels = {
-    singular: string;
-    plural: string;
-};
-export declare type ValidateOptions<T, S, F> = {
-    data: Partial<T>;
-    siblingData: Partial<S>;
-    id?: string | number;
-    user?: Partial<User>;
-    operation?: Operation;
-    payload?: Payload;
-} & F;
-export declare type Validate<T = any, S = any, F = any> = (value?: T, options?: ValidateOptions<F, S, Partial<F>>) => string | true | Promise<string | true>;
-export declare type OptionObject = {
-    label: string;
-    value: string;
-};
-export declare type Option = OptionObject | string;
-export interface FieldBase {
-    name: string;
-    label?: string | false;
-    required?: boolean;
-    unique?: boolean;
-    index?: boolean;
-    defaultValue?: any;
-    hidden?: boolean;
-    saveToJWT?: boolean;
-    localized?: boolean;
-    validate?: Validate;
-    hooks?: {
-        beforeValidate?: FieldHook[];
-        beforeChange?: FieldHook[];
-        afterChange?: FieldHook[];
-        afterRead?: FieldHook[];
-    };
-    admin?: Admin;
-    access?: {
-        create?: FieldAccess;
-        read?: FieldAccess;
-        update?: FieldAccess;
-    };
-}
-export declare type NumberField = FieldBase & {
-    type: 'number';
-    admin?: Admin & {
-        autoComplete?: string;
-        placeholder?: string;
-        step?: number;
-    };
-    min?: number;
-    max?: number;
-};
-export declare type TextField = FieldBase & {
-    type: 'text';
-    maxLength?: number;
-    minLength?: number;
-    admin?: Admin & {
-        placeholder?: string;
-        autoComplete?: string;
-    };
-};
-export declare type EmailField = FieldBase & {
-    type: 'email';
-    admin?: Admin & {
-        placeholder?: string;
-        autoComplete?: string;
-    };
-};
-export declare type TextareaField = FieldBase & {
-    type: 'textarea';
-    maxLength?: number;
-    minLength?: number;
-    admin?: Admin & {
-        placeholder?: string;
-        rows?: number;
-    };
-};
-export declare type CheckboxField = FieldBase & {
-    type: 'checkbox';
-};
-export declare type DateField = FieldBase & {
-    type: 'date';
-    admin?: Admin & {
-        placeholder?: string;
-        date?: ConditionalDateProps;
-    };
-};
-export declare type GroupField = FieldBase & {
-    type: 'group';
-    fields: Field[];
-    admin?: Admin & {
-        hideGutter?: boolean;
-    };
-};
-export declare type RowAdmin = Omit<Admin, 'description'>;
-export declare type RowField = Omit<FieldBase, 'admin' | 'name'> & {
-    admin?: RowAdmin;
-    type: 'row';
-    fields: Field[];
-};
-export declare type CollapsibleField = Omit<FieldBase, 'name'> & {
-    type: 'collapsible';
-    label: string;
-    fields: Field[];
-};
-export declare type TabsAdmin = Omit<Admin, 'description'>;
-export declare type TabsField = Omit<FieldBase, 'admin' | 'name'> & {
-    type: 'tabs';
-    tabs: {
-        label: string;
-        fields: Field[];
-        description?: Description;
-    }[];
-    admin?: TabsAdmin;
-};
-export declare type UIField = {
-    name: string;
-    label?: string;
-    admin: {
-        position?: string;
-        width?: string;
-        condition?: Condition;
-        components?: {
-            Filter?: React.ComponentType<any>;
-            Cell?: React.ComponentType<any>;
-            Field: React.ComponentType<any>;
-        };
-    };
-    type: 'ui';
-};
-export declare type UploadField = FieldBase & {
-    type: 'upload';
-    relationTo: string;
-    maxDepth?: number;
-    filterOptions?: FilterOptions;
-};
-declare type CodeAdmin = Admin & {
-    language?: string;
-};
-export declare type CodeField = Omit<FieldBase, 'admin'> & {
-    admin?: CodeAdmin;
-    minLength?: number;
-    maxLength?: number;
-    type: 'code';
-};
-export declare type SelectField = FieldBase & {
-    type: 'select';
-    options: Option[];
-    hasMany?: boolean;
-    admin?: Admin & {
-        isClearable?: boolean;
-    };
-};
-export declare type RelationshipField = FieldBase & {
-    type: 'relationship';
-    relationTo: string | string[];
-    hasMany?: boolean;
-    maxDepth?: number;
-    filterOptions?: FilterOptions;
-};
-export declare type ValueWithRelation = {
-    relationTo: string;
-    value: string | number;
-};
-export declare function valueIsValueWithRelation(value: unknown): value is ValueWithRelation;
-export declare type RelationshipValue = (string | number) | (string | number)[] | ValueWithRelation | ValueWithRelation[];
-declare type RichTextPlugin = (editor: Editor) => Editor;
-export declare type RichTextCustomElement = {
-    name: string;
-    Button: React.ComponentType;
-    Element: React.ComponentType;
-    plugins?: RichTextPlugin[];
-};
-export declare type RichTextCustomLeaf = {
-    name: string;
-    Button: React.ComponentType;
-    Leaf: React.ComponentType;
-    plugins?: RichTextPlugin[];
-};
-export declare type RichTextElement = 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'blockquote' | 'ul' | 'ol' | 'link' | 'relationship' | 'upload' | 'indent' | RichTextCustomElement;
-export declare type RichTextLeaf = 'bold' | 'italic' | 'underline' | 'strikethrough' | 'code' | RichTextCustomLeaf;
-export declare type RichTextField = FieldBase & {
-    type: 'richText';
-    admin?: Admin & {
-        placeholder?: string;
-        elements?: RichTextElement[];
-        leaves?: RichTextLeaf[];
-        hideGutter?: boolean;
-        upload?: {
-            collections: {
-                [collection: string]: {
-                    fields: Field[];
-                };
-            };
-        };
-    };
-};
-export declare type ArrayField = FieldBase & {
-    type: 'array';
-    minRows?: number;
-    maxRows?: number;
-    labels?: Labels;
-    fields?: Field[];
-};
-export declare type RadioField = FieldBase & {
-    type: 'radio';
-    options: Option[];
-    admin?: Admin & {
-        layout?: 'horizontal' | 'vertical';
-    };
-};
-export declare type Block = {
-    slug: string;
-    labels?: Labels;
-    fields: Field[];
-    imageURL?: string;
-    imageAltText?: string;
-};
-export declare type BlockField = FieldBase & {
-    type: 'blocks';
-    minRows?: number;
-    maxRows?: number;
-    blocks?: Block[];
-    defaultValue?: unknown;
-    labels?: Labels;
-};
-export declare type PointField = FieldBase & {
-    type: 'point';
-};
-export declare type Field = TextField | NumberField | EmailField | TextareaField | CheckboxField | DateField | BlockField | GroupField | RadioField | RelationshipField | ArrayField | RichTextField | SelectField | UploadField | CodeField | PointField | RowField | CollapsibleField | TabsField | UIField;
-export declare type FieldAffectingData = TextField | NumberField | EmailField | TextareaField | CheckboxField | DateField | BlockField | GroupField | RadioField | RelationshipField | ArrayField | RichTextField | SelectField | UploadField | CodeField | PointField;
-export declare type NonPresentationalField = TextField | NumberField | EmailField | TextareaField | CheckboxField | DateField | BlockField | GroupField | RadioField | RelationshipField | ArrayField | RichTextField | SelectField | UploadField | CodeField | PointField | RowField | TabsField | CollapsibleField;
-export declare type FieldWithPath = Field & {
-    path?: string;
-};
-export declare type FieldWithSubFields = GroupField | ArrayField | RowField | CollapsibleField;
-export declare type FieldPresentationalOnly = UIField;
-export declare type FieldWithMany = SelectField | RelationshipField;
-export declare type FieldWithMaxDepth = UploadField | RelationshipField;
-export declare function fieldHasSubFields(field: Field): field is FieldWithSubFields;
-export declare function fieldIsArrayType(field: Field): field is ArrayField;
-export declare function fieldIsBlockType(field: Field): field is BlockField;
-export declare function optionIsObject(option: Option): option is OptionObject;
-export declare function optionsAreObjects(options: Option[]): options is OptionObject[];
-export declare function optionIsValue(option: Option): option is string;
-export declare function fieldSupportsMany(field: Field): field is FieldWithMany;
-export declare function fieldHasMaxDepth(field: Field): field is FieldWithMaxDepth;
-export declare function fieldIsPresentationalOnly(field: Field): field is UIField;
-export declare function fieldAffectsData(field: Field): field is FieldAffectingData;
-export declare type HookName = 'beforeRead' | 'beforeChange' | 'beforeValidate' | 'afterChange' | 'afterRead';
-export {};
+import { CSSProperties } from 'react';
+import { Editor } from 'slate';
+import { Operation, Where } from '../../types';
+import { TypeWithID } from '../../collections/config/types';
+import { PayloadRequest } from '../../express/types';
+import { ConditionalDateProps } from '../../admin/components/elements/DatePicker/types';
+import { Description } from '../../admin/components/forms/FieldDescription/types';
+import { User } from '../../auth';
+import { Payload } from '../..';
+export declare type FieldHookArgs<T extends TypeWithID = any, P = any, S = any> = {
+    data?: Partial<T>;
+    findMany?: boolean;
+    originalDoc?: T;
+    operation?: 'create' | 'read' | 'update' | 'delete';
+    req: PayloadRequest;
+    siblingData: Partial<S>;
+    value?: P;
+};
+export declare type FieldHook<T extends TypeWithID = any, P = any, S = any> = (args: FieldHookArgs<T, P, S>) => Promise<P> | P;
+export declare type FieldAccess<T extends TypeWithID = any, P = any> = (args: {
+    req: PayloadRequest;
+    id?: string | number;
+    data?: Partial<T>;
+    siblingData?: Partial<P>;
+    doc?: T;
+}) => Promise<boolean> | boolean;
+export declare type Condition<T extends TypeWithID = any, P = any> = (data: Partial<T>, siblingData: Partial<P>) => boolean;
+export declare type FilterOptionsProps = {
+    id: string | number;
+    user: Partial<User>;
+    data: unknown;
+    siblingData: unknown;
+    relationTo: string | string[];
+};
+export declare type FilterOptions = Where | ((options: FilterOptionsProps) => Where);
+declare type Admin = {
+    position?: 'sidebar';
+    width?: string;
+    style?: CSSProperties;
+    className?: string;
+    readOnly?: boolean;
+    disabled?: boolean;
+    condition?: Condition;
+    description?: Description;
+    components?: {
+        Filter?: React.ComponentType;
+        Cell?: React.ComponentType;
+        Field?: React.ComponentType;
+    };
+    hidden?: boolean;
+};
+export declare type Labels = {
+    singular: string;
+    plural: string;
+};
+export declare type ValidateOptions<T, S, F> = {
+    data: Partial<T>;
+    siblingData: Partial<S>;
+    id?: string | number;
+    user?: Partial<User>;
+    operation?: Operation;
+    payload?: Payload;
+} & F;
+export declare type Validate<T = any, S = any, F = any> = (value?: T, options?: ValidateOptions<F, S, Partial<F>>) => string | true | Promise<string | true>;
+export declare type OptionObject = {
+    label: string;
+    value: string;
+};
+export declare type Option = OptionObject | string;
+export interface FieldBase {
+    name: string;
+    label?: string | false;
+    required?: boolean;
+    unique?: boolean;
+    index?: boolean;
+    defaultValue?: any;
+    hidden?: boolean;
+    saveToJWT?: boolean;
+    localized?: boolean;
+    validate?: Validate;
+    hooks?: {
+        beforeValidate?: FieldHook[];
+        beforeChange?: FieldHook[];
+        afterChange?: FieldHook[];
+        afterRead?: FieldHook[];
+    };
+    admin?: Admin;
+    access?: {
+        create?: FieldAccess;
+        read?: FieldAccess;
+        update?: FieldAccess;
+    };
+}
+export declare type NumberField = FieldBase & {
+    type: 'number';
+    admin?: Admin & {
+        autoComplete?: string;
+        placeholder?: string;
+        step?: number;
+    };
+    min?: number;
+    max?: number;
+};
+export declare type TextField = FieldBase & {
+    type: 'text';
+    maxLength?: number;
+    minLength?: number;
+    admin?: Admin & {
+        placeholder?: string;
+        autoComplete?: string;
+    };
+};
+export declare type EmailField = FieldBase & {
+    type: 'email';
+    admin?: Admin & {
+        placeholder?: string;
+        autoComplete?: string;
+    };
+};
+export declare type TextareaField = FieldBase & {
+    type: 'textarea';
+    maxLength?: number;
+    minLength?: number;
+    admin?: Admin & {
+        placeholder?: string;
+        rows?: number;
+    };
+};
+export declare type CheckboxField = FieldBase & {
+    type: 'checkbox';
+};
+export declare type DateField = FieldBase & {
+    type: 'date';
+    admin?: Admin & {
+        placeholder?: string;
+        date?: ConditionalDateProps;
+    };
+};
+export declare type GroupField = FieldBase & {
+    type: 'group';
+    fields: Field[];
+    admin?: Admin & {
+        hideGutter?: boolean;
+    };
+};
+export declare type RowAdmin = Omit<Admin, 'description'>;
+export declare type RowField = Omit<FieldBase, 'admin' | 'name'> & {
+    admin?: RowAdmin;
+    type: 'row';
+    fields: Field[];
+};
+export declare type CollapsibleField = Omit<FieldBase, 'name'> & {
+    type: 'collapsible';
+    label: string;
+    fields: Field[];
+};
+export declare type TabsAdmin = Omit<Admin, 'description'>;
+export declare type TabsField = Omit<FieldBase, 'admin' | 'name'> & {
+    type: 'tabs';
+    tabs: {
+        label: string;
+        fields: Field[];
+        description?: Description;
+    }[];
+    admin?: TabsAdmin;
+};
+export declare type UIField = {
+    name: string;
+    label?: string;
+    admin: {
+        position?: string;
+        width?: string;
+        condition?: Condition;
+        components?: {
+            Filter?: React.ComponentType<any>;
+            Cell?: React.ComponentType<any>;
+            Field: React.ComponentType<any>;
+        };
+    };
+    type: 'ui';
+};
+export declare type UploadField = FieldBase & {
+    type: 'upload';
+    relationTo: string;
+    maxDepth?: number;
+    filterOptions?: FilterOptions;
+};
+declare type CodeAdmin = Admin & {
+    language?: string;
+};
+export declare type CodeField = Omit<FieldBase, 'admin'> & {
+    admin?: CodeAdmin;
+    minLength?: number;
+    maxLength?: number;
+    type: 'code';
+};
+export declare type SelectField = FieldBase & {
+    type: 'select';
+    options: Option[];
+    hasMany?: boolean;
+    admin?: Admin & {
+        isClearable?: boolean;
+    };
+};
+export declare type RelationshipField = FieldBase & {
+    type: 'relationship';
+    relationTo: string | string[];
+    hasMany?: boolean;
+    maxDepth?: number;
+    filterOptions?: FilterOptions;
+};
+export declare type ValueWithRelation = {
+    relationTo: string;
+    value: string | number;
+};
+export declare function valueIsValueWithRelation(value: unknown): value is ValueWithRelation;
+export declare type RelationshipValue = (string | number) | (string | number)[] | ValueWithRelation | ValueWithRelation[];
+declare type RichTextPlugin = (editor: Editor) => Editor;
+export declare type RichTextCustomElement = {
+    name: string;
+    Button: React.ComponentType;
+    Element: React.ComponentType;
+    plugins?: RichTextPlugin[];
+};
+export declare type RichTextCustomLeaf = {
+    name: string;
+    Button: React.ComponentType;
+    Leaf: React.ComponentType;
+    plugins?: RichTextPlugin[];
+};
+export declare type RichTextElement = 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'blockquote' | 'ul' | 'ol' | 'link' | 'relationship' | 'upload' | 'indent' | RichTextCustomElement;
+export declare type RichTextLeaf = 'bold' | 'italic' | 'underline' | 'strikethrough' | 'code' | RichTextCustomLeaf;
+export declare type RichTextField = FieldBase & {
+    type: 'richText';
+    admin?: Admin & {
+        placeholder?: string;
+        elements?: RichTextElement[];
+        leaves?: RichTextLeaf[];
+        hideGutter?: boolean;
+        upload?: {
+            collections: {
+                [collection: string]: {
+                    fields: Field[];
+                };
+            };
+        };
+    };
+};
+export declare type ArrayField = FieldBase & {
+    type: 'array';
+    minRows?: number;
+    maxRows?: number;
+    labels?: Labels;
+    fields?: Field[];
+};
+export declare type RadioField = FieldBase & {
+    type: 'radio';
+    options: Option[];
+    admin?: Admin & {
+        layout?: 'horizontal' | 'vertical';
+    };
+};
+export declare type Block = {
+    slug: string;
+    labels?: Labels;
+    fields: Field[];
+    imageURL?: string;
+    imageAltText?: string;
+};
+export declare type BlockField = FieldBase & {
+    type: 'blocks';
+    minRows?: number;
+    maxRows?: number;
+    blocks?: Block[];
+    defaultValue?: unknown;
+    labels?: Labels;
+};
+export declare type PointField = FieldBase & {
+    type: 'point';
+};
+export declare type Field = TextField | NumberField | EmailField | TextareaField | CheckboxField | DateField | BlockField | GroupField | RadioField | RelationshipField | ArrayField | RichTextField | SelectField | UploadField | CodeField | PointField | RowField | CollapsibleField | TabsField | UIField;
+export declare type FieldAffectingData = TextField | NumberField | EmailField | TextareaField | CheckboxField | DateField | BlockField | GroupField | RadioField | RelationshipField | ArrayField | RichTextField | SelectField | UploadField | CodeField | PointField;
+export declare type NonPresentationalField = TextField | NumberField | EmailField | TextareaField | CheckboxField | DateField | BlockField | GroupField | RadioField | RelationshipField | ArrayField | RichTextField | SelectField | UploadField | CodeField | PointField | RowField | TabsField | CollapsibleField;
+export declare type FieldWithPath = Field & {
+    path?: string;
+};
+export declare type FieldWithSubFields = GroupField | ArrayField | RowField | CollapsibleField;
+export declare type FieldPresentationalOnly = UIField;
+export declare type FieldWithMany = SelectField | RelationshipField;
+export declare type FieldWithMaxDepth = UploadField | RelationshipField;
+export declare function fieldHasSubFields(field: Field): field is FieldWithSubFields;
+export declare function fieldIsArrayType(field: Field): field is ArrayField;
+export declare function fieldIsBlockType(field: Field): field is BlockField;
+export declare function optionIsObject(option: Option): option is OptionObject;
+export declare function optionsAreObjects(options: Option[]): options is OptionObject[];
+export declare function optionIsValue(option: Option): option is string;
+export declare function fieldSupportsMany(field: Field): field is FieldWithMany;
+export declare function fieldHasMaxDepth(field: Field): field is FieldWithMaxDepth;
+export declare function fieldIsPresentationalOnly(field: Field): field is UIField;
+export declare function fieldAffectsData(field: Field): field is FieldAffectingData;
+export declare type HookName = 'beforeRead' | 'beforeChange' | 'beforeValidate' | 'afterChange' | 'afterRead';
+export {};