payload/dist/fields/hooks/beforeChange/traverseFields.d.ts

Node, React, Headless CMS and Application Framework built on Next.js

import type { SanitizedCollectionConfig } from '../../../collections/config/types.js';
import type { ValidationFieldError } from '../../../errors/index.js';
import type { SanitizedGlobalConfig } from '../../../globals/config/types.js';
import type { RequestContext } from '../../../index.js';
import type { JsonObject, Operation, PayloadRequest } from '../../../types/index.js';
import type { Field, TabAsField } from '../../config/types.js';
type Args = {
    /**
     * Data of the nearest parent block. If no parent block exists, this will be the `undefined`
     */
    blockData?: JsonObject;
    collection: null | SanitizedCollectionConfig;
    context: RequestContext;
    data: JsonObject;
    /**
     * The original data (not modified by any hooks)
     */
    doc: JsonObject;
    /**
     * The original data with locales (not modified by any hooks)
     */
    docWithLocales: JsonObject;
    errors: ValidationFieldError[];
    /**
     * Built up labels of parent fields
     *
     * @example "Group Field > Tab Field > Text Field"
     */
    fieldLabelPath: string;
    fields: (Field | TabAsField)[];
    global: null | SanitizedGlobalConfig;
    id?: number | string;
    mergeLocaleActions: (() => Promise<void> | void)[];
    operation: Operation;
    parentIndexPath: string;
    /**
     * @todo make required in v4.0
     */
    parentIsLocalized?: boolean;
    parentPath: string;
    parentSchemaPath: string;
    req: PayloadRequest;
    siblingData: JsonObject;
    /**
     * The original siblingData (not modified by any hooks)
     */
    siblingDoc: JsonObject;
    /**
     * The original siblingData with locales (not modified by any hooks)
     */
    siblingDocWithLocales: JsonObject;
    skipValidation?: boolean;
};
/**
 * This function is responsible for the following actions, in order:
 * - Run condition
 * - Execute field hooks
 * - Validate data
 * - Transform data for storage
 * - Unflatten locales. The input `data` is the normal document for one locale. The output result will become the document with locales.
 */
export declare const traverseFields: ({ id, blockData, collection, context, data, doc, docWithLocales, errors, fieldLabelPath, fields, global, mergeLocaleActions, operation, parentIndexPath, parentIsLocalized, parentPath, parentSchemaPath, req, siblingData, siblingDoc, siblingDocWithLocales, skipValidation, }: Args) => Promise<void>;
export {};
//# sourceMappingURL=traverseFields.d.ts.map