@depup/payload 3.79.1-depup.0

package/dist/collections/operations/local/create.d.ts

@@ -0,0 +1,145 @@
+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

package/dist/collections/operations/local/create.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create.d.ts","sourceRoot":"","sources":["../../../../src/collections/operations/local/create.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,QAAQ,EACR,cAAc,EACd,YAAY,EACZ,UAAU,EACV,6BAA6B,EAC9B,MAAM,yBAAyB,CAAA;AAChC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,2BAA2B,CAAA;AAErD,OAAO,KAAK,EACV,wBAAwB,EACxB,sBAAsB,EACtB,2BAA2B,EAC3B,8BAA8B,EAC9B,wBAAwB,EACzB,MAAM,uBAAuB,CAAA;AAG9B,OAAO,EACL,KAAK,cAAc,EAEnB,KAAK,WAAW,EAChB,KAAK,cAAc,EACnB,KAAK,OAAO,EACZ,KAAK,cAAc,EACnB,KAAK,WAAW,EACjB,MAAM,mBAAmB,CAAA;AAK1B,KAAK,WAAW,CAAC,KAAK,SAAS,cAAc,EAAE,OAAO,SAAS,UAAU,IAAI;IAC3E;;OAEG;IACH,UAAU,EAAE,KAAK,CAAA;IACjB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,cAAc,CAAA;IACxB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B;;;OAGG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAA;IAClC;;OAEG;IACH,eAAe,CAAC,EAAE,sBAAsB,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAA;IACrD;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,GAAG,WAAW,CAAA;IACpC;;OAEG;IACH,IAAI,CAAC,EAAE,IAAI,CAAA;IACX;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAA;IACpB;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAA;IAChC;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAA;IACvB;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B;;;OAGG;IACH,GAAG,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,CAAA;IAC7B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAE1B;;OAEG;IACH,IAAI,CAAC,EAAE,QAAQ,CAAA;CAChB,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,QAAQ,CAAC,CAAA;AAE/C,MAAM,MAAM,OAAO,CACjB,KAAK,SAAS,cAAc,EAC5B,OAAO,SAAS,UAAU,IACxB,cAAc,SAAS;IAAE,gBAAgB,EAAE,IAAI,CAAA;CAAE,GACjD,wBAAwB,SAAS,KAAK,GACpC;IACE;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC,KAAK,CAAC,CAAA;IACnC;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB,GAAG,WAAW,CAAC,KAAK,EAAE,OAAO,CAAC,GAC/B,KAAK,SAAS,wBAAwB,GACpC;IACE,IAAI,EAAE,8BAA8B,CAAC,KAAK,CAAC,CAAA;IAC3C;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAA;CACd,GAAG,WAAW,CAAC,KAAK,EAAE,OAAO,CAAC,GAC/B,CACI;IACE;;OAEG;IACH,IAAI,EAAE,8BAA8B,CAAC,KAAK,CAAC,CAAA;IAC3C;;;OAGG;IACH,KAAK,CAAC,EAAE,KAAK,CAAA;CACd,GACD;IACE;;;OAGG;IACH,IAAI,EAAE,2BAA2B,CAAC,KAAK,CAAC,CAAA;IACxC;;OAEG;IACH,KAAK,EAAE,IAAI,CAAA;CACZ,CACJ,GACC,WAAW,CAAC,KAAK,EAAE,OAAO,CAAC,GAE7B,CAAC;IACC;;OAEG;IACH,IAAI,EAAE,8BAA8B,CAAC,KAAK,CAAC,CAAA;IAC3C;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAA;CACd,GAAG,WAAW,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,GAChC,CAAC;IACC;;;OAGG;IACH,IAAI,EAAE,2BAA2B,CAAC,KAAK,CAAC,CAAA;IACxC;;OAEG;IACH,KAAK,EAAE,IAAI,CAAA;CACZ,GAAG,WAAW,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAA;AAExC,wBAAsB,WAAW,CAC/B,KAAK,SAAS,cAAc,EAC5B,OAAO,SAAS,wBAAwB,CAAC,KAAK,CAAC,EAE/C,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,GAC/B,OAAO,CAAC,6BAA6B,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CA+CxD"}

package/dist/collections/operations/local/create.js

@@ -0,0 +1,32 @@
+import { APIError } from '../../../errors/index.js';
+import { deepCopyObjectSimple } from '../../../index.js';
+import { getFileByPath } from '../../../uploads/getFileByPath.js';
+import { createLocalReq } from '../../../utilities/createLocalReq.js';
+import { createOperation } from '../create.js';
+export async function createLocal(payload, options) {
+    const { collection: collectionSlug, data, depth, disableTransaction, disableVerificationEmail, draft, duplicateFromID, file, filePath, overrideAccess = true, overwriteExistingFiles = false, populate, publishAllLocales, select, showHiddenFields } = options;
+    const collection = payload.collections[collectionSlug];
+    if (!collection) {
+        throw new APIError(`The collection with slug ${String(collectionSlug)} can't be found. Create Operation.`);
+    }
+    const req = await createLocalReq(options, payload);
+    req.file = file ?? await getFileByPath(filePath);
+    return createOperation({
+        collection,
+        data: deepCopyObjectSimple(data),
+        depth,
+        disableTransaction,
+        disableVerificationEmail,
+        draft,
+        duplicateFromID,
+        overrideAccess,
+        overwriteExistingFiles,
+        populate,
+        publishAllLocales,
+        req,
+        select,
+        showHiddenFields
+    });
+}
+
+//# sourceMappingURL=create.js.map

package/dist/collections/operations/local/create.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/collections/operations/local/create.ts"],"sourcesContent":["import type {\n  Document,\n  PayloadRequest,\n  PopulateType,\n  SelectType,\n  TransformCollectionWithSelect,\n} from '../../../types/index.js'\nimport type { File } from '../../../uploads/types.js'\nimport type { CreateLocalReqOptions } from '../../../utilities/createLocalReq.js'\nimport type {\n  CollectionsWithoutDrafts,\n  DataFromCollectionSlug,\n  DraftDataFromCollectionSlug,\n  RequiredDataFromCollectionSlug,\n  SelectFromCollectionSlug,\n} from '../../config/types.js'\n\nimport { APIError } from '../../../errors/index.js'\nimport {\n  type CollectionSlug,\n  deepCopyObjectSimple,\n  type FindOptions,\n  type GeneratedTypes,\n  type Payload,\n  type RequestContext,\n  type TypedLocale,\n} from '../../../index.js'\nimport { getFileByPath } from '../../../uploads/getFileByPath.js'\nimport { createLocalReq } from '../../../utilities/createLocalReq.js'\nimport { createOperation } from '../create.js'\n\ntype BaseOptions<TSlug extends CollectionSlug, TSelect extends SelectType> = {\n  /**\n   * the Collection slug to operate against.\n   */\n  collection: TSlug\n  /**\n   * [Context](https://payloadcms.com/docs/hooks/context), which will then be passed to `context` and `req.context`,\n   * which can be read by hooks. Useful if you want to pass additional information to the hooks which\n   * shouldn't be necessarily part of the document, for example a `triggerBeforeChange` option which can be read by the BeforeChange hook\n   * to determine if it should run or not.\n   */\n  context?: RequestContext\n  /**\n   * [Control auto-population](https://payloadcms.com/docs/queries/depth) of nested relationship and upload fields.\n   */\n  depth?: number\n  /**\n   * When set to `true`, a [database transactions](https://payloadcms.com/docs/database/transactions) will not be initialized.\n   * @default false\n   */\n  disableTransaction?: boolean\n  /**\n   * If creating verification-enabled auth doc,\n   * you can disable the email that is auto-sent\n   */\n  disableVerificationEmail?: boolean\n  /**\n   * If you want to create a document that is a duplicate of another document\n   */\n  duplicateFromID?: DataFromCollectionSlug<TSlug>['id']\n  /**\n   * Specify a [fallback locale](https://payloadcms.com/docs/configuration/localization) to use for any returned documents.\n   */\n  fallbackLocale?: false | TypedLocale\n  /**\n   * A `File` object when creating a collection with `upload: true`.\n   */\n  file?: File\n  /**\n   * A file path when creating a collection with `upload: true`.\n   */\n  filePath?: string\n  /**\n   * Specify [locale](https://payloadcms.com/docs/configuration/localization) for any returned documents.\n   */\n  locale?: TypedLocale\n  /**\n   * Skip access control.\n   * Set to `false` if you want to respect Access Control for the operation, for example when fetching data for the front-end.\n   * @default true\n   */\n  overrideAccess?: boolean\n  /**\n   * If you are uploading a file and would like to replace\n   * the existing file instead of generating a new filename,\n   * you can set the following property to `true`\n   */\n  overwriteExistingFiles?: boolean\n  /**\n   * Specify [populate](https://payloadcms.com/docs/queries/select#populate) to control which fields to include to the result from populated documents.\n   */\n  populate?: PopulateType\n  /**\n   * Publish to all locales\n   */\n  publishAllLocales?: boolean\n  /**\n   * The `PayloadRequest` object. You can pass it to thread the current [transaction](https://payloadcms.com/docs/database/transactions), user and locale to the operation.\n   * Recommended to pass when using the Local API from hooks, as usually you want to execute the operation within the current transaction.\n   */\n  req?: Partial<PayloadRequest>\n  /**\n   * Opt-in to receiving hidden fields. By default, they are hidden from returned documents in accordance to your config.\n   * @default false\n   */\n  showHiddenFields?: boolean\n  // TODO: Strongly type User as TypedUser (= User in v4.0)\n  /**\n   * If you set `overrideAccess` to `false`, you can pass a user to use against the access control checks.\n   */\n  user?: Document\n} & Pick<FindOptions<TSlug, TSelect>, 'select'>\n\nexport type Options<\n  TSlug extends CollectionSlug,\n  TSelect extends SelectType,\n> = GeneratedTypes extends { strictDraftTypes: true }\n  ? CollectionsWithoutDrafts extends TSlug\n    ? {\n        /**\n         * The data for the document to create.\n         */\n        data: DataFromCollectionSlug<TSlug>\n        /**\n         * Create a **draft** document. [More](https://payloadcms.com/docs/versions/drafts#draft-api)\n         */\n        draft?: boolean\n      } & BaseOptions<TSlug, TSelect>\n    : TSlug extends CollectionsWithoutDrafts\n      ? {\n          data: RequiredDataFromCollectionSlug<TSlug>\n          /**\n           * The `draft` property is not allowed because this collection does not have `versions.drafts` enabled.\n           */\n          draft?: never\n        } & BaseOptions<TSlug, TSelect>\n      : (\n          | {\n              /**\n               * The data for the document to create.\n               */\n              data: RequiredDataFromCollectionSlug<TSlug>\n              /**\n               * Create a **draft** document. [More](https://payloadcms.com/docs/versions/drafts#draft-api)\n               * Omit this property or set to `false` to create a published document.\n               */\n              draft?: false\n            }\n          | {\n              /**\n               * The data for the document to create.\n               * When creating a draft, required fields are optional as validation is skipped by default.\n               */\n              data: DraftDataFromCollectionSlug<TSlug>\n              /**\n               * Create a **draft** document. [More](https://payloadcms.com/docs/versions/drafts#draft-api)\n               */\n              draft: true\n            }\n        ) &\n          BaseOptions<TSlug, TSelect>\n  :\n      | ({\n          /**\n           * The data for the document to create.\n           */\n          data: RequiredDataFromCollectionSlug<TSlug>\n          /**\n           * Create a **draft** document. [More](https://payloadcms.com/docs/versions/drafts#draft-api)\n           */\n          draft?: false\n        } & BaseOptions<TSlug, TSelect>)\n      | ({\n          /**\n           * The data for the document to create.\n           * When creating a draft, required fields are optional as validation is skipped by default.\n           */\n          data: DraftDataFromCollectionSlug<TSlug>\n          /**\n           * Create a **draft** document. [More](https://payloadcms.com/docs/versions/drafts#draft-api)\n           */\n          draft: true\n        } & BaseOptions<TSlug, TSelect>)\n\nexport async function createLocal<\n  TSlug extends CollectionSlug,\n  TSelect extends SelectFromCollectionSlug<TSlug>,\n>(\n  payload: Payload,\n  options: Options<TSlug, TSelect>,\n): Promise<TransformCollectionWithSelect<TSlug, TSelect>> {\n  const {\n    collection: collectionSlug,\n    data,\n    depth,\n    disableTransaction,\n    disableVerificationEmail,\n    draft,\n    duplicateFromID,\n    file,\n    filePath,\n    overrideAccess = true,\n    overwriteExistingFiles = false,\n    populate,\n    publishAllLocales,\n    select,\n    showHiddenFields,\n  } = options\n\n  const collection = payload.collections[collectionSlug]\n\n  if (!collection) {\n    throw new APIError(\n      `The collection with slug ${String(collectionSlug)} can't be found. Create Operation.`,\n    )\n  }\n\n  const req = await createLocalReq(options as CreateLocalReqOptions, payload)\n\n  req.file = file ?? (await getFileByPath(filePath!))\n\n  return createOperation<TSlug, TSelect>({\n    collection,\n    data: deepCopyObjectSimple(data), // Ensure mutation of data in create operation hooks doesn't affect the original data\n    depth,\n    disableTransaction,\n    disableVerificationEmail,\n    draft,\n    duplicateFromID,\n    overrideAccess,\n    overwriteExistingFiles,\n    populate,\n    publishAllLocales,\n    req,\n    select,\n    showHiddenFields,\n  })\n}\n"],"names":["APIError","deepCopyObjectSimple","getFileByPath","createLocalReq","createOperation","createLocal","payload","options","collection","collectionSlug","data","depth","disableTransaction","disableVerificationEmail","draft","duplicateFromID","file","filePath","overrideAccess","overwriteExistingFiles","populate","publishAllLocales","select","showHiddenFields","collections","String","req"],"mappings":"AAiBA,SAASA,QAAQ,QAAQ,2BAA0B;AACnD,SAEEC,oBAAoB,QAMf,oBAAmB;AAC1B,SAASC,aAAa,QAAQ,oCAAmC;AACjE,SAASC,cAAc,QAAQ,uCAAsC;AACrE,SAASC,eAAe,QAAQ,eAAc;AA4J9C,OAAO,eAAeC,YAIpBC,OAAgB,EAChBC,OAAgC;IAEhC,MAAM,EACJC,YAAYC,cAAc,EAC1BC,IAAI,EACJC,KAAK,EACLC,kBAAkB,EAClBC,wBAAwB,EACxBC,KAAK,EACLC,eAAe,EACfC,IAAI,EACJC,QAAQ,EACRC,iBAAiB,IAAI,EACrBC,yBAAyB,KAAK,EAC9BC,QAAQ,EACRC,iBAAiB,EACjBC,MAAM,EACNC,gBAAgB,EACjB,GAAGhB;IAEJ,MAAMC,aAAaF,QAAQkB,WAAW,CAACf,eAAe;IAEtD,IAAI,CAACD,YAAY;QACf,MAAM,IAAIR,SACR,CAAC,yBAAyB,EAAEyB,OAAOhB,gBAAgB,kCAAkC,CAAC;IAE1F;IAEA,MAAMiB,MAAM,MAAMvB,eAAeI,SAAkCD;IAEnEoB,IAAIV,IAAI,GAAGA,QAAS,MAAMd,cAAce;IAExC,OAAOb,gBAAgC;QACrCI;QACAE,MAAMT,qBAAqBS;QAC3BC;QACAC;QACAC;QACAC;QACAC;QACAG;QACAC;QACAC;QACAC;QACAK;QACAJ;QACAC;IACF;AACF"}

package/dist/collections/operations/local/delete.d.ts

@@ -0,0 +1,96 @@
+import type { CollectionSlug, FindOptions, Payload, RequestContext, TypedLocale } from '../../../index.js';
+import type { Document, PayloadRequest, PopulateType, SelectType, TransformCollectionWithSelect, Where } from '../../../types/index.js';
+import type { BulkOperationResult, SelectFromCollectionSlug } from '../../config/types.js';
+export 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;
+    /**
+     * Specify a [fallback locale](https://payloadcms.com/docs/configuration/localization) to use for any returned documents.
+     */
+    fallbackLocale?: false | TypedLocale;
+    /**
+     * 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;
+    /**
+     * By default, document locks are ignored (`true`). Set to `false` to enforce locks and prevent operations when a document is locked by another user. [More details](https://payloadcms.com/docs/admin/locked-documents).
+     * @default true
+     */
+    overrideLock?: boolean;
+    /**
+     * Specify [populate](https://payloadcms.com/docs/queries/select#populate) to control which fields to include to the result from populated documents.
+     */
+    populate?: PopulateType;
+    /**
+     * 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;
+    /**
+     * When set to `true`, the operation will permanently delete both normal and trashed documents.
+     * By default (`false`), only normal (non-trashed) documents will be permanently deleted.
+     *
+     * This argument has no effect unless `trash` is enabled on the collection.
+     * @default false
+     */
+    trash?: 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 ByIDOptions<TSlug extends CollectionSlug, TSelect extends SelectFromCollectionSlug<TSlug>> = {
+    /**
+     * The ID of the document to delete.
+     */
+    id: number | string;
+    /**
+     * A filter [query](https://payloadcms.com/docs/queries/overview)
+     */
+    where?: never;
+} & BaseOptions<TSlug, TSelect>;
+export type ManyOptions<TSlug extends CollectionSlug, TSelect extends SelectFromCollectionSlug<TSlug>> = {
+    /**
+     * The ID of the document to delete.
+     */
+    id?: never;
+    /**
+     * A filter [query](https://payloadcms.com/docs/queries/overview)
+     */
+    where: Where;
+} & BaseOptions<TSlug, TSelect>;
+export type Options<TSlug extends CollectionSlug, TSelect extends SelectFromCollectionSlug<TSlug>> = ByIDOptions<TSlug, TSelect> | ManyOptions<TSlug, TSelect>;
+declare function deleteLocal<TSlug extends CollectionSlug, TSelect extends SelectFromCollectionSlug<TSlug>>(payload: Payload, options: ByIDOptions<TSlug, TSelect>): Promise<TransformCollectionWithSelect<TSlug, TSelect>>;
+declare function deleteLocal<TSlug extends CollectionSlug, TSelect extends SelectFromCollectionSlug<TSlug>>(payload: Payload, options: ManyOptions<TSlug, TSelect>): Promise<BulkOperationResult<TSlug, TSelect>>;
+declare function deleteLocal<TSlug extends CollectionSlug, TSelect extends SelectFromCollectionSlug<TSlug>>(payload: Payload, options: Options<TSlug, TSelect>): Promise<BulkOperationResult<TSlug, TSelect> | TransformCollectionWithSelect<TSlug, TSelect>>;
+export { deleteLocal };
+//# sourceMappingURL=delete.d.ts.map

package/dist/collections/operations/local/delete.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"delete.d.ts","sourceRoot":"","sources":["../../../../src/collections/operations/local/delete.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,WAAW,EACX,OAAO,EACP,cAAc,EACd,WAAW,EACZ,MAAM,mBAAmB,CAAA;AAC1B,OAAO,KAAK,EACV,QAAQ,EACR,cAAc,EACd,YAAY,EACZ,UAAU,EACV,6BAA6B,EAC7B,KAAK,EACN,MAAM,yBAAyB,CAAA;AAEhC,OAAO,KAAK,EAAE,mBAAmB,EAAE,wBAAwB,EAAE,MAAM,uBAAuB,CAAA;AAO1F,MAAM,MAAM,WAAW,CAAC,KAAK,SAAS,cAAc,EAAE,OAAO,SAAS,UAAU,IAAI;IAClF;;OAEG;IACH,UAAU,EAAE,KAAK,CAAA;IACjB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,cAAc,CAAA;IACxB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,GAAG,WAAW,CAAA;IACpC;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAA;IACpB;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAA;IACvB;;;OAGG;IACH,GAAG,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,CAAA;IAC7B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,QAAQ,CAAA;CAChB,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,QAAQ,CAAC,CAAA;AAE/C,MAAM,MAAM,WAAW,CACrB,KAAK,SAAS,cAAc,EAC5B,OAAO,SAAS,wBAAwB,CAAC,KAAK,CAAC,IAC7C;IACF;;OAEG;IACH,EAAE,EAAE,MAAM,GAAG,MAAM,CAAA;IACnB;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAA;CACd,GAAG,WAAW,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;AAE/B,MAAM,MAAM,WAAW,CACrB,KAAK,SAAS,cAAc,EAC5B,OAAO,SAAS,wBAAwB,CAAC,KAAK,CAAC,IAC7C;IACF;;OAEG;IACH,EAAE,CAAC,EAAE,KAAK,CAAA;IACV;;OAEG;IACH,KAAK,EAAE,KAAK,CAAA;CACb,GAAG,WAAW,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;AAE/B,MAAM,MAAM,OAAO,CACjB,KAAK,SAAS,cAAc,EAC5B,OAAO,SAAS,wBAAwB,CAAC,KAAK,CAAC,IAC7C,WAAW,CAAC,KAAK,EAAE,OAAO,CAAC,GAAG,WAAW,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;AAE7D,iBAAe,WAAW,CACxB,KAAK,SAAS,cAAc,EAC5B,OAAO,SAAS,wBAAwB,CAAC,KAAK,CAAC,EAE/C,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,WAAW,CAAC,KAAK,EAAE,OAAO,CAAC,GACnC,OAAO,CAAC,6BAA6B,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAA;AACzD,iBAAe,WAAW,CACxB,KAAK,SAAS,cAAc,EAC5B,OAAO,SAAS,wBAAwB,CAAC,KAAK,CAAC,EAE/C,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,WAAW,CAAC,KAAK,EAAE,OAAO,CAAC,GACnC,OAAO,CAAC,mBAAmB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAA;AAC/C,iBAAe,WAAW,CACxB,KAAK,SAAS,cAAc,EAC5B,OAAO,SAAS,wBAAwB,CAAC,KAAK,CAAC,EAE/C,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,GAC/B,OAAO,CAAC,mBAAmB,CAAC,KAAK,EAAE,OAAO,CAAC,GAAG,6BAA6B,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAA;AAqD/F,OAAO,EAAE,WAAW,EAAE,CAAA"}

package/dist/collections/operations/local/delete.js

@@ -0,0 +1,34 @@
+import { APIError } from '../../../errors/index.js';
+import { createLocalReq } from '../../../utilities/createLocalReq.js';
+import { deleteOperation } from '../delete.js';
+import { deleteByIDOperation } from '../deleteByID.js';
+async function deleteLocal(payload, options) {
+    const { id, collection: collectionSlug, depth, disableTransaction, overrideAccess = true, overrideLock, populate, select, showHiddenFields, trash = false, where } = options;
+    const collection = payload.collections[collectionSlug];
+    if (!collection) {
+        throw new APIError(`The collection with slug ${String(collectionSlug)} can't be found. Delete Operation.`);
+    }
+    const args = {
+        id,
+        collection,
+        depth,
+        disableTransaction,
+        overrideAccess,
+        overrideLock,
+        populate,
+        req: await createLocalReq(options, payload),
+        select,
+        showHiddenFields,
+        trash,
+        where
+    };
+    if (options.id) {
+        // @ts-expect-error - vestiges of when tsconfig was not strict. Feel free to improve
+        return deleteByIDOperation(args);
+    }
+    // @ts-expect-error - vestiges of when tsconfig was not strict. Feel free to improve
+    return deleteOperation(args);
+}
+export { deleteLocal };
+
+//# sourceMappingURL=delete.js.map

package/dist/collections/operations/local/delete.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/collections/operations/local/delete.ts"],"sourcesContent":["import type {\n  CollectionSlug,\n  FindOptions,\n  Payload,\n  RequestContext,\n  TypedLocale,\n} from '../../../index.js'\nimport type {\n  Document,\n  PayloadRequest,\n  PopulateType,\n  SelectType,\n  TransformCollectionWithSelect,\n  Where,\n} from '../../../types/index.js'\nimport type { CreateLocalReqOptions } from '../../../utilities/createLocalReq.js'\nimport type { BulkOperationResult, SelectFromCollectionSlug } from '../../config/types.js'\n\nimport { APIError } from '../../../errors/index.js'\nimport { createLocalReq } from '../../../utilities/createLocalReq.js'\nimport { deleteOperation } from '../delete.js'\nimport { deleteByIDOperation } from '../deleteByID.js'\n\nexport type BaseOptions<TSlug extends CollectionSlug, TSelect extends SelectType> = {\n  /**\n   * the Collection slug to operate against.\n   */\n  collection: TSlug\n  /**\n   * [Context](https://payloadcms.com/docs/hooks/context), which will then be passed to `context` and `req.context`,\n   * which can be read by hooks. Useful if you want to pass additional information to the hooks which\n   * shouldn't be necessarily part of the document, for example a `triggerBeforeChange` option which can be read by the BeforeChange hook\n   * to determine if it should run or not.\n   */\n  context?: RequestContext\n  /**\n   * [Control auto-population](https://payloadcms.com/docs/queries/depth) of nested relationship and upload fields.\n   */\n  depth?: number\n  /**\n   * When set to `true`, a [database transactions](https://payloadcms.com/docs/database/transactions) will not be initialized.\n   * @default false\n   */\n  disableTransaction?: boolean\n  /**\n   * Specify a [fallback locale](https://payloadcms.com/docs/configuration/localization) to use for any returned documents.\n   */\n  fallbackLocale?: false | TypedLocale\n  /**\n   * Specify [locale](https://payloadcms.com/docs/configuration/localization) for any returned documents.\n   */\n  locale?: TypedLocale\n  /**\n   * Skip access control.\n   * Set to `false` if you want to respect Access Control for the operation, for example when fetching data for the front-end.\n   * @default true\n   */\n  overrideAccess?: boolean\n  /**\n   * By default, document locks are ignored (`true`). Set to `false` to enforce locks and prevent operations when a document is locked by another user. [More details](https://payloadcms.com/docs/admin/locked-documents).\n   * @default true\n   */\n  overrideLock?: boolean\n  /**\n   * Specify [populate](https://payloadcms.com/docs/queries/select#populate) to control which fields to include to the result from populated documents.\n   */\n  populate?: PopulateType\n  /**\n   * The `PayloadRequest` object. You can pass it to thread the current [transaction](https://payloadcms.com/docs/database/transactions), user and locale to the operation.\n   * Recommended to pass when using the Local API from hooks, as usually you want to execute the operation within the current transaction.\n   */\n  req?: Partial<PayloadRequest>\n  /**\n   * Opt-in to receiving hidden fields. By default, they are hidden from returned documents in accordance to your config.\n   * @default false\n   */\n  showHiddenFields?: boolean\n  /**\n   * When set to `true`, the operation will permanently delete both normal and trashed documents.\n   * By default (`false`), only normal (non-trashed) documents will be permanently deleted.\n   *\n   * This argument has no effect unless `trash` is enabled on the collection.\n   * @default false\n   */\n  trash?: boolean\n  // TODO: Strongly type User as TypedUser (= User in v4.0)\n  /**\n   * If you set `overrideAccess` to `false`, you can pass a user to use against the access control checks.\n   */\n  user?: Document\n} & Pick<FindOptions<TSlug, TSelect>, 'select'>\n\nexport type ByIDOptions<\n  TSlug extends CollectionSlug,\n  TSelect extends SelectFromCollectionSlug<TSlug>,\n> = {\n  /**\n   * The ID of the document to delete.\n   */\n  id: number | string\n  /**\n   * A filter [query](https://payloadcms.com/docs/queries/overview)\n   */\n  where?: never\n} & BaseOptions<TSlug, TSelect>\n\nexport type ManyOptions<\n  TSlug extends CollectionSlug,\n  TSelect extends SelectFromCollectionSlug<TSlug>,\n> = {\n  /**\n   * The ID of the document to delete.\n   */\n  id?: never\n  /**\n   * A filter [query](https://payloadcms.com/docs/queries/overview)\n   */\n  where: Where\n} & BaseOptions<TSlug, TSelect>\n\nexport type Options<\n  TSlug extends CollectionSlug,\n  TSelect extends SelectFromCollectionSlug<TSlug>,\n> = ByIDOptions<TSlug, TSelect> | ManyOptions<TSlug, TSelect>\n\nasync function deleteLocal<\n  TSlug extends CollectionSlug,\n  TSelect extends SelectFromCollectionSlug<TSlug>,\n>(\n  payload: Payload,\n  options: ByIDOptions<TSlug, TSelect>,\n): Promise<TransformCollectionWithSelect<TSlug, TSelect>>\nasync function deleteLocal<\n  TSlug extends CollectionSlug,\n  TSelect extends SelectFromCollectionSlug<TSlug>,\n>(\n  payload: Payload,\n  options: ManyOptions<TSlug, TSelect>,\n): Promise<BulkOperationResult<TSlug, TSelect>>\nasync function deleteLocal<\n  TSlug extends CollectionSlug,\n  TSelect extends SelectFromCollectionSlug<TSlug>,\n>(\n  payload: Payload,\n  options: Options<TSlug, TSelect>,\n): Promise<BulkOperationResult<TSlug, TSelect> | TransformCollectionWithSelect<TSlug, TSelect>>\nasync function deleteLocal<\n  TSlug extends CollectionSlug,\n  TSelect extends SelectFromCollectionSlug<TSlug>,\n>(\n  payload: Payload,\n  options: Options<TSlug, TSelect>,\n): Promise<BulkOperationResult<TSlug, TSelect> | TransformCollectionWithSelect<TSlug, TSelect>> {\n  const {\n    id,\n    collection: collectionSlug,\n    depth,\n    disableTransaction,\n    overrideAccess = true,\n    overrideLock,\n    populate,\n    select,\n    showHiddenFields,\n    trash = false,\n    where,\n  } = options\n\n  const collection = payload.collections[collectionSlug]\n\n  if (!collection) {\n    throw new APIError(\n      `The collection with slug ${String(collectionSlug)} can't be found. Delete Operation.`,\n    )\n  }\n\n  const args = {\n    id,\n    collection,\n    depth,\n    disableTransaction,\n    overrideAccess,\n    overrideLock,\n    populate,\n    req: await createLocalReq(options as CreateLocalReqOptions, payload),\n    select,\n    showHiddenFields,\n    trash,\n    where,\n  }\n\n  if (options.id) {\n    // @ts-expect-error - vestiges of when tsconfig was not strict. Feel free to improve\n    return deleteByIDOperation<TSlug, TSelect>(args)\n  }\n  // @ts-expect-error - vestiges of when tsconfig was not strict. Feel free to improve\n  return deleteOperation<TSlug, TSelect>(args)\n}\n\nexport { deleteLocal }\n"],"names":["APIError","createLocalReq","deleteOperation","deleteByIDOperation","deleteLocal","payload","options","id","collection","collectionSlug","depth","disableTransaction","overrideAccess","overrideLock","populate","select","showHiddenFields","trash","where","collections","String","args","req"],"mappings":"AAkBA,SAASA,QAAQ,QAAQ,2BAA0B;AACnD,SAASC,cAAc,QAAQ,uCAAsC;AACrE,SAASC,eAAe,QAAQ,eAAc;AAC9C,SAASC,mBAAmB,QAAQ,mBAAkB;AA6HtD,eAAeC,YAIbC,OAAgB,EAChBC,OAAgC;IAEhC,MAAM,EACJC,EAAE,EACFC,YAAYC,cAAc,EAC1BC,KAAK,EACLC,kBAAkB,EAClBC,iBAAiB,IAAI,EACrBC,YAAY,EACZC,QAAQ,EACRC,MAAM,EACNC,gBAAgB,EAChBC,QAAQ,KAAK,EACbC,KAAK,EACN,GAAGZ;IAEJ,MAAME,aAAaH,QAAQc,WAAW,CAACV,eAAe;IAEtD,IAAI,CAACD,YAAY;QACf,MAAM,IAAIR,SACR,CAAC,yBAAyB,EAAEoB,OAAOX,gBAAgB,kCAAkC,CAAC;IAE1F;IAEA,MAAMY,OAAO;QACXd;QACAC;QACAE;QACAC;QACAC;QACAC;QACAC;QACAQ,KAAK,MAAMrB,eAAeK,SAAkCD;QAC5DU;QACAC;QACAC;QACAC;IACF;IAEA,IAAIZ,QAAQC,EAAE,EAAE;QACd,oFAAoF;QACpF,OAAOJ,oBAAoCkB;IAC7C;IACA,oFAAoF;IACpF,OAAOnB,gBAAgCmB;AACzC;AAEA,SAASjB,WAAW,GAAE"}

package/dist/collections/operations/local/duplicate.d.ts

@@ -0,0 +1,76 @@
+import type { DeepPartial } from 'ts-essentials';
+import type { CollectionSlug, TypedLocale } from '../../..//index.js';
+import type { FindOptions, Payload, RequestContext } from '../../../index.js';
+import type { Document, PayloadRequest, PopulateType, SelectType, TransformCollectionWithSelect } from '../../../types/index.js';
+import type { DraftFlagFromCollectionSlug, RequiredDataFromCollectionSlug, SelectFromCollectionSlug } from '../../config/types.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;
+    /**
+     * Override the data for the document to duplicate.
+     */
+    data?: DeepPartial<RequiredDataFromCollectionSlug<TSlug>>;
+    /**
+     * [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;
+    /**
+     * Specify a [fallback locale](https://payloadcms.com/docs/configuration/localization) to use for any returned documents.
+     */
+    fallbackLocale?: false | TypedLocale;
+    /**
+     * The ID of the document to duplicate from.
+     */
+    id: number | 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;
+    /**
+     * Specify [populate](https://payloadcms.com/docs/queries/select#populate) to control which fields to include to the result from populated documents.
+     */
+    populate?: PopulateType;
+    /**
+     * 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>;
+    /**
+     * Specifies which locales to include when duplicating localized fields. Non-localized data is always duplicated.
+     * By default, all locales are duplicated.
+     */
+    selectedLocales?: string[];
+    /**
+     * 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> = BaseOptions<TSlug, TSelect> & DraftFlagFromCollectionSlug<TSlug>;
+export declare function duplicateLocal<TSlug extends CollectionSlug, TSelect extends SelectFromCollectionSlug<TSlug>>(payload: Payload, options: Options<TSlug, TSelect>): Promise<TransformCollectionWithSelect<TSlug, TSelect>>;
+export {};
+//# sourceMappingURL=duplicate.d.ts.map

package/dist/collections/operations/local/duplicate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"duplicate.d.ts","sourceRoot":"","sources":["../../../../src/collections/operations/local/duplicate.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAEhD,OAAO,KAAK,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AACrE,OAAO,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAC7E,OAAO,KAAK,EACV,QAAQ,EACR,cAAc,EACd,YAAY,EACZ,UAAU,EACV,6BAA6B,EAC9B,MAAM,yBAAyB,CAAA;AAEhC,OAAO,KAAK,EACV,2BAA2B,EAC3B,8BAA8B,EAC9B,wBAAwB,EACzB,MAAM,uBAAuB,CAAA;AAM9B,KAAK,WAAW,CAAC,KAAK,SAAS,cAAc,EAAE,OAAO,SAAS,UAAU,IAAI;IAC3E;;OAEG;IACH,UAAU,EAAE,KAAK,CAAA;IACjB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,cAAc,CAAA;IACxB;;OAEG;IACH,IAAI,CAAC,EAAE,WAAW,CAAC,8BAA8B,CAAC,KAAK,CAAC,CAAC,CAAA;IACzD;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,GAAG,WAAW,CAAA;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,GAAG,MAAM,CAAA;IACnB;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAA;IACpB;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAA;IACvB;;;OAGG;IACH,GAAG,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,CAAA;IAC7B;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,EAAE,CAAA;IAC1B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAE1B;;OAEG;IACH,IAAI,CAAC,EAAE,QAAQ,CAAA;CAChB,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,QAAQ,CAAC,CAAA;AAE/C,MAAM,MAAM,OAAO,CAAC,KAAK,SAAS,cAAc,EAAE,OAAO,SAAS,UAAU,IAC1E,WAAW,CAAC,KAAK,EAAE,OAAO,CAAC,GAAG,2BAA2B,CAAC,KAAK,CAAC,CAAA;AAElE,wBAAsB,cAAc,CAClC,KAAK,SAAS,cAAc,EAC5B,OAAO,SAAS,wBAAwB,CAAC,KAAK,CAAC,EAE/C,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,GAC/B,OAAO,CAAC,6BAA6B,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CA8CxD"}

package/dist/collections/operations/local/duplicate.js

@@ -0,0 +1,30 @@
+import { APIError } from '../../../errors/index.js';
+import { createLocalReq } from '../../../utilities/createLocalReq.js';
+import { duplicateOperation } from '../duplicate.js';
+export async function duplicateLocal(payload, options) {
+    const { id, collection: collectionSlug, data, depth, disableTransaction, draft, overrideAccess = true, populate, select, selectedLocales, showHiddenFields } = options;
+    const collection = payload.collections[collectionSlug];
+    if (!collection) {
+        throw new APIError(`The collection with slug ${String(collectionSlug)} can't be found. Duplicate Operation.`);
+    }
+    if (collection.config.disableDuplicate === true) {
+        throw new APIError(`The collection with slug ${String(collectionSlug)} cannot be duplicated.`, 400);
+    }
+    const req = await createLocalReq(options, payload);
+    return duplicateOperation({
+        id,
+        collection,
+        data,
+        depth,
+        disableTransaction,
+        draft,
+        overrideAccess,
+        populate,
+        req,
+        select,
+        selectedLocales,
+        showHiddenFields
+    });
+}
+
+//# sourceMappingURL=duplicate.js.map

package/dist/collections/operations/local/duplicate.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/collections/operations/local/duplicate.ts"],"sourcesContent":["import type { DeepPartial } from 'ts-essentials'\n\nimport type { CollectionSlug, TypedLocale } from '../../..//index.js'\nimport type { FindOptions, Payload, RequestContext } from '../../../index.js'\nimport type {\n  Document,\n  PayloadRequest,\n  PopulateType,\n  SelectType,\n  TransformCollectionWithSelect,\n} from '../../../types/index.js'\nimport type { CreateLocalReqOptions } from '../../../utilities/createLocalReq.js'\nimport type {\n  DraftFlagFromCollectionSlug,\n  RequiredDataFromCollectionSlug,\n  SelectFromCollectionSlug,\n} from '../../config/types.js'\n\nimport { APIError } from '../../../errors/index.js'\nimport { createLocalReq } from '../../../utilities/createLocalReq.js'\nimport { duplicateOperation } from '../duplicate.js'\n\ntype BaseOptions<TSlug extends CollectionSlug, TSelect extends SelectType> = {\n  /**\n   * the Collection slug to operate against.\n   */\n  collection: TSlug\n  /**\n   * [Context](https://payloadcms.com/docs/hooks/context), which will then be passed to `context` and `req.context`,\n   * which can be read by hooks. Useful if you want to pass additional information to the hooks which\n   * shouldn't be necessarily part of the document, for example a `triggerBeforeChange` option which can be read by the BeforeChange hook\n   * to determine if it should run or not.\n   */\n  context?: RequestContext\n  /**\n   * Override the data for the document to duplicate.\n   */\n  data?: DeepPartial<RequiredDataFromCollectionSlug<TSlug>>\n  /**\n   * [Control auto-population](https://payloadcms.com/docs/queries/depth) of nested relationship and upload fields.\n   */\n  depth?: number\n  /**\n   * When set to `true`, a [database transactions](https://payloadcms.com/docs/database/transactions) will not be initialized.\n   * @default false\n   */\n  disableTransaction?: boolean\n  /**\n   * Specify a [fallback locale](https://payloadcms.com/docs/configuration/localization) to use for any returned documents.\n   */\n  fallbackLocale?: false | TypedLocale\n  /**\n   * The ID of the document to duplicate from.\n   */\n  id: number | string\n  /**\n   * Specify [locale](https://payloadcms.com/docs/configuration/localization) for any returned documents.\n   */\n  locale?: TypedLocale\n  /**\n   * Skip access control.\n   * Set to `false` if you want to respect Access Control for the operation, for example when fetching data for the front-end.\n   * @default true\n   */\n  overrideAccess?: boolean\n  /**\n   * Specify [populate](https://payloadcms.com/docs/queries/select#populate) to control which fields to include to the result from populated documents.\n   */\n  populate?: PopulateType\n  /**\n   * The `PayloadRequest` object. You can pass it to thread the current [transaction](https://payloadcms.com/docs/database/transactions), user and locale to the operation.\n   * Recommended to pass when using the Local API from hooks, as usually you want to execute the operation within the current transaction.\n   */\n  req?: Partial<PayloadRequest>\n  /**\n   * Specifies which locales to include when duplicating localized fields. Non-localized data is always duplicated.\n   * By default, all locales are duplicated.\n   */\n  selectedLocales?: string[]\n  /**\n   * Opt-in to receiving hidden fields. By default, they are hidden from returned documents in accordance to your config.\n   * @default false\n   */\n  showHiddenFields?: boolean\n  // TODO: Strongly type User as TypedUser (= User in v4.0)\n  /**\n   * If you set `overrideAccess` to `false`, you can pass a user to use against the access control checks.\n   */\n  user?: Document\n} & Pick<FindOptions<TSlug, TSelect>, 'select'>\n\nexport type Options<TSlug extends CollectionSlug, TSelect extends SelectType> =\n  BaseOptions<TSlug, TSelect> & DraftFlagFromCollectionSlug<TSlug>\n\nexport async function duplicateLocal<\n  TSlug extends CollectionSlug,\n  TSelect extends SelectFromCollectionSlug<TSlug>,\n>(\n  payload: Payload,\n  options: Options<TSlug, TSelect>,\n): Promise<TransformCollectionWithSelect<TSlug, TSelect>> {\n  const {\n    id,\n    collection: collectionSlug,\n    data,\n    depth,\n    disableTransaction,\n    draft,\n    overrideAccess = true,\n    populate,\n    select,\n    selectedLocales,\n    showHiddenFields,\n  } = options\n\n  const collection = payload.collections[collectionSlug]\n\n  if (!collection) {\n    throw new APIError(\n      `The collection with slug ${String(collectionSlug)} can't be found. Duplicate Operation.`,\n    )\n  }\n\n  if (collection.config.disableDuplicate === true) {\n    throw new APIError(\n      `The collection with slug ${String(collectionSlug)} cannot be duplicated.`,\n      400,\n    )\n  }\n\n  const req = await createLocalReq(options as CreateLocalReqOptions, payload)\n\n  return duplicateOperation<TSlug, TSelect>({\n    id,\n    collection,\n    data,\n    depth,\n    disableTransaction,\n    draft,\n    overrideAccess,\n    populate,\n    req,\n    select,\n    selectedLocales,\n    showHiddenFields,\n  })\n}\n"],"names":["APIError","createLocalReq","duplicateOperation","duplicateLocal","payload","options","id","collection","collectionSlug","data","depth","disableTransaction","draft","overrideAccess","populate","select","selectedLocales","showHiddenFields","collections","String","config","disableDuplicate","req"],"mappings":"AAkBA,SAASA,QAAQ,QAAQ,2BAA0B;AACnD,SAASC,cAAc,QAAQ,uCAAsC;AACrE,SAASC,kBAAkB,QAAQ,kBAAiB;AA0EpD,OAAO,eAAeC,eAIpBC,OAAgB,EAChBC,OAAgC;IAEhC,MAAM,EACJC,EAAE,EACFC,YAAYC,cAAc,EAC1BC,IAAI,EACJC,KAAK,EACLC,kBAAkB,EAClBC,KAAK,EACLC,iBAAiB,IAAI,EACrBC,QAAQ,EACRC,MAAM,EACNC,eAAe,EACfC,gBAAgB,EACjB,GAAGZ;IAEJ,MAAME,aAAaH,QAAQc,WAAW,CAACV,eAAe;IAEtD,IAAI,CAACD,YAAY;QACf,MAAM,IAAIP,SACR,CAAC,yBAAyB,EAAEmB,OAAOX,gBAAgB,qCAAqC,CAAC;IAE7F;IAEA,IAAID,WAAWa,MAAM,CAACC,gBAAgB,KAAK,MAAM;QAC/C,MAAM,IAAIrB,SACR,CAAC,yBAAyB,EAAEmB,OAAOX,gBAAgB,sBAAsB,CAAC,EAC1E;IAEJ;IAEA,MAAMc,MAAM,MAAMrB,eAAeI,SAAkCD;IAEnE,OAAOF,mBAAmC;QACxCI;QACAC;QACAE;QACAC;QACAC;QACAC;QACAC;QACAC;QACAQ;QACAP;QACAC;QACAC;IACF;AACF"}