Marc Mintel
5397309103
Some checks failed
Build & Deploy / 🔍 Prepare (push) Successful in 20s
Build & Deploy / 🧪 QA (push) Failing after 34s
Build & Deploy / 🏗️ Build (push) Has started running
Build & Deploy / 🚀 Deploy (push) Has been cancelled
Build & Deploy / 🧪 Smoke Test (push) Has been cancelled
Build & Deploy / ⚡ Lighthouse (push) Has been cancelled
Build & Deploy / 🔔 Notify (push) Has been cancelled
50 lines
2.2 KiB
Plaintext
50 lines
2.2 KiB
Plaintext
import type { CollectionConfig, SanitizedJoin, SanitizedJoins } from '../../collections/config/types.js';
|
|
import type { Config, SanitizedConfig } from '../../config/types.js';
|
|
import type { GlobalConfig } from '../../globals/config/types.js';
|
|
import type { Field } from './types.js';
|
|
type Args = {
|
|
collectionConfig?: CollectionConfig;
|
|
config: Config;
|
|
existingFieldNames?: Set<string>;
|
|
fields: Field[];
|
|
globalConfig?: GlobalConfig;
|
|
/**
|
|
* Used to prevent unnecessary sanitization of fields that are not top-level.
|
|
*/
|
|
isTopLevelField?: boolean;
|
|
joinPath?: string;
|
|
/**
|
|
* When not passed in, assume that join are not supported (globals, arrays, blocks)
|
|
*/
|
|
joins?: SanitizedJoins;
|
|
/**
|
|
* A string of '-' separated indexes representing where
|
|
* to find this field in a given field schema array.
|
|
*/
|
|
parentIndexPath?: string;
|
|
parentIsLocalized: boolean;
|
|
/**
|
|
* Path for parent fields relative to their position in the schema.
|
|
*/
|
|
parentSchemaPath?: string;
|
|
polymorphicJoins?: SanitizedJoin[];
|
|
/**
|
|
* If true, a richText field will require an editor property to be set, as the sanitizeFields function will not add it from the payload config if not present.
|
|
*
|
|
* @default false
|
|
*/
|
|
requireFieldLevelRichTextEditor?: boolean;
|
|
/**
|
|
* If this property is set, RichText fields won't be sanitized immediately. Instead, they will be added to this array as promises
|
|
* so that you can sanitize them together, after the config has been sanitized.
|
|
*/
|
|
richTextSanitizationPromises?: Array<(config: SanitizedConfig) => Promise<void>>;
|
|
/**
|
|
* If not null, will validate that upload and relationship fields do not relate to a collection that is not in this array.
|
|
* This validation will be skipped if validRelationships is null.
|
|
*/
|
|
validRelationships: null | string[];
|
|
};
|
|
export declare const sanitizeFields: ({ collectionConfig, config, existingFieldNames, fields, globalConfig, isTopLevelField, joinPath, joins, parentIndexPath, parentIsLocalized, parentSchemaPath, polymorphicJoins, requireFieldLevelRichTextEditor, richTextSanitizationPromises, validRelationships, }: Args) => Promise<Field[]>;
|
|
export {};
|
|
//# sourceMappingURL=sanitize.d.ts.map |