klz-cables.com/.pnpm-store/v10/files/51/8a3469510fa8573fc8038bbb2c0bcea5fa7c0f546f11cbc432397c0ce4abd671ff0a9b4952011813e79c65eab4b6dcc86524f5fdbd58c89040319a4966ee1b

import { type SupportedLanguages } from '@payloadcms/translations';
import type { SanitizedDocumentPermissions } from '../../auth/types.js';
import type { Field, Option, TabAsField, Validate } from '../../fields/config/types.js';
import type { TypedLocale } from '../../index.js';
import type { DocumentPreferences } from '../../preferences/types.js';
import type { PayloadRequest, SelectType, Where } from '../../types/index.js';
export type Data = {
    [key: string]: any;
};
export type Row = {
    addedByServer?: FieldState['addedByServer'];
    blockType?: string;
    collapsed?: boolean;
    customComponents?: {
        RowLabel?: React.ReactNode;
    };
    id: string;
    isLoading?: boolean;
    lastRenderedPath?: string;
};
export type FilterOptionsResult = {
    [relation: string]: boolean | Where;
};
export type FieldState = {
    /**
     * This is used to determine if the field was added by the server.
     * This ensures the field is not ignored by the client when merging form state.
     * This can happen because the current local state is treated as the source of truth.
     * See `mergeServerFormState` for more details.
     */
    addedByServer?: boolean;
    /**
     * If the field is a `blocks` field, this will contain the slugs of blocks that are allowed, based on the result of `field.filterOptions`.
     * If this is undefined, all blocks are allowed.
     * If this is an empty array, no blocks are allowed.
     */
    blocksFilterOptions?: string[];
    customComponents?: {
        /**
         * This is used by UI fields, as they can have arbitrary components defined if used
         * as a vessel to bring in custom components.
         */
        [key: string]: React.ReactNode | React.ReactNode[] | undefined;
        AfterInput?: React.ReactNode;
        BeforeInput?: React.ReactNode;
        Description?: React.ReactNode;
        Error?: React.ReactNode;
        Field?: React.ReactNode;
        Label?: React.ReactNode;
    };
    disableFormData?: boolean;
    errorMessage?: string;
    errorPaths?: string[];
    /**
     * The fieldSchema may be part of the form state if `includeSchema: true` is passed to buildFormState.
     * This will never be in the form state of the client.
     */
    fieldSchema?: Field | TabAsField;
    filterOptions?: FilterOptionsResult;
    initialValue?: unknown;
    /**
     * Every time a field is changed locally, this flag is set to true. Prevents form state from server from overwriting local changes.
     * After merging server form state, this flag is reset.
     *
     * @experimental This property is experimental and may change in the future. Use at your own risk.
     */
    isModified?: boolean;
    /**
     * The path of the field when its custom components were last rendered.
     * This is used to denote if a field has been rendered, and if so,
     * what path it was rendered under last.
     *
     * If this path is undefined, or, if it is different
     * from the current path of a given field, the field's components will be re-rendered.
     */
    lastRenderedPath?: string;
    passesCondition?: boolean;
    rows?: Row[];
    /**
     * The result of running `field.filterOptions` on select fields.
     */
    selectFilterOptions?: Option[];
    valid?: boolean;
    validate?: Validate;
    value?: unknown;
};
export type FieldStateWithoutComponents = Omit<FieldState, 'customComponents'>;
export type FormState = {
    [path: string]: FieldState;
};
export type FormStateWithoutComponents = {
    [path: string]: FieldStateWithoutComponents;
};
export type BuildFormStateArgs = {
    data?: Data;
    docPermissions: SanitizedDocumentPermissions | undefined;
    docPreferences: DocumentPreferences;
    /**
     * In case `formState` is not the top-level, document form state, this can be passed to
     * provide the top-level form state.
     */
    documentFormState?: FormState;
    fallbackLocale?: false | TypedLocale;
    formState?: FormState;
    id?: number | string;
    initialBlockData?: Data;
    initialBlockFormState?: FormState;
    language?: keyof SupportedLanguages;
    locale?: string;
    /**
     * If true, will not render RSCs and instead return a simple string in their place.
     * This is useful for environments that lack RSC support, such as Jest.
     * Form state can still be built, but any server components will be omitted.
     * @default false
     */
    mockRSCs?: boolean;
    operation?: 'create' | 'update';
    readOnly?: boolean;
    /**
     * If true, will render field components within their state object.
     * Performance optimization: Setting to `false` ensures that only fields that have changed paths will re-render, e.g. new array rows, etc.
     * For example, you only need to render ALL fields on initial render, not on every onChange.
     */
    renderAllFields?: boolean;
    req: PayloadRequest;
    /**
     * If true, will return a fresh URL for live preview based on the current form state.
     * Note: this will run on every form state event, so if your `livePreview.url` function is long running or expensive,
     * ensure it caches itself as needed.
     */
    returnLivePreviewURL?: boolean;
    returnLockStatus?: boolean;
    /**
     * If true, will return a fresh URL for preview based on the current form state.
     * Note: this will run on every form state event, so if your `preview` function is long running or expensive,
     * ensure it caches itself as needed.
     */
    returnPreviewURL?: boolean;
    schemaPath: string;
    select?: SelectType;
    /**
     * When true, sets `user: true` when calling `getClientConfig`.
     * This will retrieve the client config in its entirety, even when unauthenticated.
     * For example, the create-first-user view needs the entire config, but there is no user yet.
     *
     * @experimental This property is experimental and may change in the future. Use at your own risk.
     */
    skipClientConfigAuth?: boolean;
    skipValidation?: boolean;
    updateLastEdited?: boolean;
} & ({
    collectionSlug: string;
    globalSlug?: string;
} | {
    collectionSlug?: string;
    globalSlug: string;
});
//# sourceMappingURL=Form.d.ts.map