klz-cables.com/.pnpm-store/v10/files/0b/318cc8d73d93279efa10503a8ed37f4631c7cafae8174e11308eb66ae719d254703db658d37e613f3d813edad331371c0c6c3196411186a582d6809ffa2cb7

import type { Document, PayloadRequest, PopulateType, SelectType, TransformCollectionWithSelect } from '../../../types/index.js';
import type { File } from '../../../uploads/types.js';
import type { CollectionsWithoutDrafts, DataFromCollectionSlug, DraftDataFromCollectionSlug, RequiredDataFromCollectionSlug, SelectFromCollectionSlug } from '../../config/types.js';
import { type CollectionSlug, type FindOptions, type GeneratedTypes, type Payload, type RequestContext, type TypedLocale } from '../../../index.js';
type BaseOptions<TSlug extends CollectionSlug, TSelect extends SelectType> = {
    /**
     * the Collection slug to operate against.
     */
    collection: TSlug;
    /**
     * [Context](https://payloadcms.com/docs/hooks/context), which will then be passed to `context` and `req.context`,
     * which can be read by hooks. Useful if you want to pass additional information to the hooks which
     * shouldn't be necessarily part of the document, for example a `triggerBeforeChange` option which can be read by the BeforeChange hook
     * to determine if it should run or not.
     */
    context?: RequestContext;
    /**
     * [Control auto-population](https://payloadcms.com/docs/queries/depth) of nested relationship and upload fields.
     */
    depth?: number;
    /**
     * When set to `true`, a [database transactions](https://payloadcms.com/docs/database/transactions) will not be initialized.
     * @default false
     */
    disableTransaction?: boolean;
    /**
     * If creating verification-enabled auth doc,
     * you can disable the email that is auto-sent
     */
    disableVerificationEmail?: boolean;
    /**
     * If you want to create a document that is a duplicate of another document
     */
    duplicateFromID?: DataFromCollectionSlug<TSlug>['id'];
    /**
     * Specify a [fallback locale](https://payloadcms.com/docs/configuration/localization) to use for any returned documents.
     */
    fallbackLocale?: false | TypedLocale;
    /**
     * A `File` object when creating a collection with `upload: true`.
     */
    file?: File;
    /**
     * A file path when creating a collection with `upload: true`.
     */
    filePath?: string;
    /**
     * Specify [locale](https://payloadcms.com/docs/configuration/localization) for any returned documents.
     */
    locale?: TypedLocale;
    /**
     * Skip access control.
     * Set to `false` if you want to respect Access Control for the operation, for example when fetching data for the front-end.
     * @default true
     */
    overrideAccess?: boolean;
    /**
     * If you are uploading a file and would like to replace
     * the existing file instead of generating a new filename,
     * you can set the following property to `true`
     */
    overwriteExistingFiles?: boolean;
    /**
     * Specify [populate](https://payloadcms.com/docs/queries/select#populate) to control which fields to include to the result from populated documents.
     */
    populate?: PopulateType;
    /**
     * Publish to all locales
     */
    publishAllLocales?: boolean;
    /**
     * The `PayloadRequest` object. You can pass it to thread the current [transaction](https://payloadcms.com/docs/database/transactions), user and locale to the operation.
     * Recommended to pass when using the Local API from hooks, as usually you want to execute the operation within the current transaction.
     */
    req?: Partial<PayloadRequest>;
    /**
     * Opt-in to receiving hidden fields. By default, they are hidden from returned documents in accordance to your config.
     * @default false
     */
    showHiddenFields?: boolean;
    /**
     * If you set `overrideAccess` to `false`, you can pass a user to use against the access control checks.
     */
    user?: Document;
} & Pick<FindOptions<TSlug, TSelect>, 'select'>;
export type Options<TSlug extends CollectionSlug, TSelect extends SelectType> = GeneratedTypes extends {
    strictDraftTypes: true;
} ? CollectionsWithoutDrafts extends TSlug ? {
    /**
     * The data for the document to create.
     */
    data: DataFromCollectionSlug<TSlug>;
    /**
     * Create a **draft** document. [More](https://payloadcms.com/docs/versions/drafts#draft-api)
     */
    draft?: boolean;
} & BaseOptions<TSlug, TSelect> : TSlug extends CollectionsWithoutDrafts ? {
    data: RequiredDataFromCollectionSlug<TSlug>;
    /**
     * The `draft` property is not allowed because this collection does not have `versions.drafts` enabled.
     */
    draft?: never;
} & BaseOptions<TSlug, TSelect> : ({
    /**
     * The data for the document to create.
     */
    data: RequiredDataFromCollectionSlug<TSlug>;
    /**
     * Create a **draft** document. [More](https://payloadcms.com/docs/versions/drafts#draft-api)
     * Omit this property or set to `false` to create a published document.
     */
    draft?: false;
} | {
    /**
     * The data for the document to create.
     * When creating a draft, required fields are optional as validation is skipped by default.
     */
    data: DraftDataFromCollectionSlug<TSlug>;
    /**
     * Create a **draft** document. [More](https://payloadcms.com/docs/versions/drafts#draft-api)
     */
    draft: true;
}) & BaseOptions<TSlug, TSelect> : ({
    /**
     * The data for the document to create.
     */
    data: RequiredDataFromCollectionSlug<TSlug>;
    /**
     * Create a **draft** document. [More](https://payloadcms.com/docs/versions/drafts#draft-api)
     */
    draft?: false;
} & BaseOptions<TSlug, TSelect>) | ({
    /**
     * The data for the document to create.
     * When creating a draft, required fields are optional as validation is skipped by default.
     */
    data: DraftDataFromCollectionSlug<TSlug>;
    /**
     * Create a **draft** document. [More](https://payloadcms.com/docs/versions/drafts#draft-api)
     */
    draft: true;
} & BaseOptions<TSlug, TSelect>);
export declare function createLocal<TSlug extends CollectionSlug, TSelect extends SelectFromCollectionSlug<TSlug>>(payload: Payload, options: Options<TSlug, TSelect>): Promise<TransformCollectionWithSelect<TSlug, TSelect>>;
export {};
//# sourceMappingURL=create.d.ts.map