payload 4.0.0-internal.cd69eef → 4.0.0-internal.ce66a41

package/dist/utilities/appendUploadSelectFields.js

@@ -6,20 +6,21 @@
     if (!collectionConfig.upload || !select) {
         return;
     }
+    /** `filename` identifies a populated upload and supplies useful thumbnail alt text. */ select.filename = true;
     select.mimeType = true;
     select.thumbnailURL = true;
     if (collectionConfig.upload.cacheTags) {
         select.updatedAt = true;
     }
-    if (collectionConfig.upload.imageSizes && collectionConfig.upload.imageSizes.length > 0) {
+    if (collectionConfig.upload.variants && collectionConfig.upload.variants.length > 0) {
         if (collectionConfig.upload.adminThumbnail && typeof collectionConfig.upload.adminThumbnail === 'string') {
-            /** Only return image size properties that are required to generate the adminThumbnailURL */ select.sizes = {
+            /** Only return image size properties that are required to generate the adminThumbnailURL */ select.variants = {
                 [collectionConfig.upload.adminThumbnail]: {
                     filename: true
                 }
             };
         } else {
-            /** Only return image size properties that are required for thumbnails */ select.sizes = collectionConfig.upload.imageSizes.reduce((acc, imageSizeConfig)=>{
+            /** Only return image size properties that are required for thumbnails */ select.variants = collectionConfig.upload.variants.reduce((acc, imageSizeConfig)=>{
                 return {
                     ...acc,
                     [imageSizeConfig.name]: {

package/dist/utilities/appendUploadSelectFields.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/utilities/appendUploadSelectFields.ts"],"sourcesContent":["import type { ClientCollectionConfig, SanitizedCollectionConfig, SelectType } from '../index.js'\n\n/**\n * Mutates the incoming select object to append fields required for upload thumbnails\n * @param collectionConfig\n * @param select\n */\nexport const appendUploadSelectFields = ({\n  collectionConfig,\n  select,\n}: {\n  collectionConfig: ClientCollectionConfig | SanitizedCollectionConfig\n  select: SelectType\n}) => {\n  if (!collectionConfig.upload || !select) {\n    return\n  }\n\n  select.mimeType = true\n  select.thumbnailURL = true\n\n  if (collectionConfig.upload.cacheTags) {\n    select.updatedAt = true\n  }\n\n  if (collectionConfig.upload.imageSizes && collectionConfig.upload.imageSizes.length > 0) {\n    if (\n      collectionConfig.upload.adminThumbnail &&\n      typeof collectionConfig.upload.adminThumbnail === 'string'\n    ) {\n      /** Only return image size properties that are required to generate the adminThumbnailURL */\n      select.sizes = {\n        [collectionConfig.upload.adminThumbnail]: {\n          filename: true,\n        },\n      }\n    } else {\n      /** Only return image size properties that are required for thumbnails */\n      select.sizes = collectionConfig.upload.imageSizes.reduce((acc, imageSizeConfig) => {\n        return {\n          ...acc,\n          [imageSizeConfig.name]: {\n            filename: true,\n            url: true,\n            width: true,\n          },\n        }\n      }, {})\n    }\n  } else {\n    select.url = true\n  }\n}\n"],"names":["appendUploadSelectFields","collectionConfig","select","upload","mimeType","thumbnailURL","cacheTags","updatedAt","imageSizes","length","adminThumbnail","sizes","filename","reduce","acc","imageSizeConfig","name","url","width"],"mappings":"AAEA;;;;CAIC,GACD,OAAO,MAAMA,2BAA2B,CAAC,EACvCC,gBAAgB,EAChBC,MAAM,EAIP;IACC,IAAI,CAACD,iBAAiBE,MAAM,IAAI,CAACD,QAAQ;QACvC;IACF;IAEAA,OAAOE,QAAQ,GAAG;IAClBF,OAAOG,YAAY,GAAG;IAEtB,IAAIJ,iBAAiBE,MAAM,CAACG,SAAS,EAAE;QACrCJ,OAAOK,SAAS,GAAG;IACrB;IAEA,IAAIN,iBAAiBE,MAAM,CAACK,UAAU,IAAIP,iBAAiBE,MAAM,CAACK,UAAU,CAACC,MAAM,GAAG,GAAG;QACvF,IACER,iBAAiBE,MAAM,CAACO,cAAc,IACtC,OAAOT,iBAAiBE,MAAM,CAACO,cAAc,KAAK,UAClD;YACA,0FAA0F,GAC1FR,OAAOS,KAAK,GAAG;gBACb,CAACV,iBAAiBE,MAAM,CAACO,cAAc,CAAC,EAAE;oBACxCE,UAAU;gBACZ;YACF;QACF,OAAO;YACL,uEAAuE,GACvEV,OAAOS,KAAK,GAAGV,iBAAiBE,MAAM,CAACK,UAAU,CAACK,MAAM,CAAC,CAACC,KAAKC;gBAC7D,OAAO;oBACL,GAAGD,GAAG;oBACN,CAACC,gBAAgBC,IAAI,CAAC,EAAE;wBACtBJ,UAAU;wBACVK,KAAK;wBACLC,OAAO;oBACT;gBACF;YACF,GAAG,CAAC;QACN;IACF,OAAO;QACLhB,OAAOe,GAAG,GAAG;IACf;AACF,EAAC"}
+{"version":3,"sources":["../../src/utilities/appendUploadSelectFields.ts"],"sourcesContent":["import type { ClientCollectionConfig, SanitizedCollectionConfig, SelectType } from '../index.js'\n\n/**\n * Mutates the incoming select object to append fields required for upload thumbnails\n * @param collectionConfig\n * @param select\n */\nexport const appendUploadSelectFields = ({\n  collectionConfig,\n  select,\n}: {\n  collectionConfig: ClientCollectionConfig | SanitizedCollectionConfig\n  select: SelectType\n}) => {\n  if (!collectionConfig.upload || !select) {\n    return\n  }\n\n  /** `filename` identifies a populated upload and supplies useful thumbnail alt text. */\n  select.filename = true\n  select.mimeType = true\n  select.thumbnailURL = true\n\n  if (collectionConfig.upload.cacheTags) {\n    select.updatedAt = true\n  }\n\n  if (collectionConfig.upload.variants && collectionConfig.upload.variants.length > 0) {\n    if (\n      collectionConfig.upload.adminThumbnail &&\n      typeof collectionConfig.upload.adminThumbnail === 'string'\n    ) {\n      /** Only return image size properties that are required to generate the adminThumbnailURL */\n      select.variants = {\n        [collectionConfig.upload.adminThumbnail]: {\n          filename: true,\n        },\n      }\n    } else {\n      /** Only return image size properties that are required for thumbnails */\n      select.variants = collectionConfig.upload.variants.reduce((acc, imageSizeConfig) => {\n        return {\n          ...acc,\n          [imageSizeConfig.name]: {\n            filename: true,\n            url: true,\n            width: true,\n          },\n        }\n      }, {})\n    }\n  } else {\n    select.url = true\n  }\n}\n"],"names":["appendUploadSelectFields","collectionConfig","select","upload","filename","mimeType","thumbnailURL","cacheTags","updatedAt","variants","length","adminThumbnail","reduce","acc","imageSizeConfig","name","url","width"],"mappings":"AAEA;;;;CAIC,GACD,OAAO,MAAMA,2BAA2B,CAAC,EACvCC,gBAAgB,EAChBC,MAAM,EAIP;IACC,IAAI,CAACD,iBAAiBE,MAAM,IAAI,CAACD,QAAQ;QACvC;IACF;IAEA,qFAAqF,GACrFA,OAAOE,QAAQ,GAAG;IAClBF,OAAOG,QAAQ,GAAG;IAClBH,OAAOI,YAAY,GAAG;IAEtB,IAAIL,iBAAiBE,MAAM,CAACI,SAAS,EAAE;QACrCL,OAAOM,SAAS,GAAG;IACrB;IAEA,IAAIP,iBAAiBE,MAAM,CAACM,QAAQ,IAAIR,iBAAiBE,MAAM,CAACM,QAAQ,CAACC,MAAM,GAAG,GAAG;QACnF,IACET,iBAAiBE,MAAM,CAACQ,cAAc,IACtC,OAAOV,iBAAiBE,MAAM,CAACQ,cAAc,KAAK,UAClD;YACA,0FAA0F,GAC1FT,OAAOO,QAAQ,GAAG;gBAChB,CAACR,iBAAiBE,MAAM,CAACQ,cAAc,CAAC,EAAE;oBACxCP,UAAU;gBACZ;YACF;QACF,OAAO;YACL,uEAAuE,GACvEF,OAAOO,QAAQ,GAAGR,iBAAiBE,MAAM,CAACM,QAAQ,CAACG,MAAM,CAAC,CAACC,KAAKC;gBAC9D,OAAO;oBACL,GAAGD,GAAG;oBACN,CAACC,gBAAgBC,IAAI,CAAC,EAAE;wBACtBX,UAAU;wBACVY,KAAK;wBACLC,OAAO;oBACT;gBACF;YACF,GAAG,CAAC;QACN;IACF,OAAO;QACLf,OAAOc,GAAG,GAAG;IACf;AACF,EAAC"}

package/dist/utilities/batchProcessing.d.ts

@@ -0,0 +1,23 @@
+export type BatchProcessorResult = {
+    shouldContinue?: boolean;
+};
+export type BatchProcessingOptions<T> = {
+    /**
+     * The maximum number of items supplied to one processor call.
+     *
+     * @default 100
+     */
+    batchSize?: number;
+    input: AsyncIterable<T> | Iterable<T>;
+    processBatch: (args: {
+        batch: T[];
+        batchIndex: number;
+    }) => BatchProcessorResult | Promise<BatchProcessorResult | void> | void;
+};
+/**
+ * Processes iterable input in ordered, bounded batches. Processing is sequential and stops when the
+ * processor returns `shouldContinue: false` or throws. This utility does not retry work or manage
+ * transactions.
+ */
+export declare const batchProcessing: <T>({ batchSize, input, processBatch, }: BatchProcessingOptions<T>) => Promise<void>;
+//# sourceMappingURL=batchProcessing.d.ts.map

package/dist/utilities/batchProcessing.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"batchProcessing.d.ts","sourceRoot":"","sources":["../../src/utilities/batchProcessing.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,oBAAoB,GAAG;IACjC,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,sBAAsB,CAAC,CAAC,IAAI;IACtC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAA;IACrC,YAAY,EAAE,CAAC,IAAI,EAAE;QACnB,KAAK,EAAE,CAAC,EAAE,CAAA;QACV,UAAU,EAAE,MAAM,CAAA;KACnB,KAAK,oBAAoB,GAAG,OAAO,CAAC,oBAAoB,GAAG,IAAI,CAAC,GAAG,IAAI,CAAA;CACzE,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,eAAe,GAAU,CAAC,uCAIpC,sBAAsB,CAAC,CAAC,CAAC,KAAG,OAAO,CAAC,IAAI,CA4B1C,CAAA"}

package/dist/utilities/batchProcessing.js

@@ -0,0 +1,34 @@
+/**
+ * Processes iterable input in ordered, bounded batches. Processing is sequential and stops when the
+ * processor returns `shouldContinue: false` or throws. This utility does not retry work or manage
+ * transactions.
+ */ export const batchProcessing = async ({ batchSize = 100, input, processBatch })=>{
+    if (!Number.isInteger(batchSize) || batchSize < 1) {
+        throw new TypeError('batchSize must be a positive integer');
+    }
+    let batch = [];
+    let batchIndex = 0;
+    for await (const item of input){
+        batch.push(item);
+        if (batch.length < batchSize) {
+            continue;
+        }
+        const result = await processBatch({
+            batch,
+            batchIndex
+        });
+        if (result?.shouldContinue === false) {
+            return;
+        }
+        batch = [];
+        batchIndex += 1;
+    }
+    if (batch.length > 0) {
+        await processBatch({
+            batch,
+            batchIndex
+        });
+    }
+};
+
+//# sourceMappingURL=batchProcessing.js.map

package/dist/utilities/batchProcessing.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/utilities/batchProcessing.ts"],"sourcesContent":["export type BatchProcessorResult = {\n  shouldContinue?: boolean\n}\n\nexport type BatchProcessingOptions<T> = {\n  /**\n   * The maximum number of items supplied to one processor call.\n   *\n   * @default 100\n   */\n  batchSize?: number\n  input: AsyncIterable<T> | Iterable<T>\n  processBatch: (args: {\n    batch: T[]\n    batchIndex: number\n  }) => BatchProcessorResult | Promise<BatchProcessorResult | void> | void\n}\n\n/**\n * Processes iterable input in ordered, bounded batches. Processing is sequential and stops when the\n * processor returns `shouldContinue: false` or throws. This utility does not retry work or manage\n * transactions.\n */\nexport const batchProcessing = async <T>({\n  batchSize = 100,\n  input,\n  processBatch,\n}: BatchProcessingOptions<T>): Promise<void> => {\n  if (!Number.isInteger(batchSize) || batchSize < 1) {\n    throw new TypeError('batchSize must be a positive integer')\n  }\n\n  let batch: T[] = []\n  let batchIndex = 0\n\n  for await (const item of input) {\n    batch.push(item)\n\n    if (batch.length < batchSize) {\n      continue\n    }\n\n    const result = await processBatch({ batch, batchIndex })\n\n    if (result?.shouldContinue === false) {\n      return\n    }\n\n    batch = []\n    batchIndex += 1\n  }\n\n  if (batch.length > 0) {\n    await processBatch({ batch, batchIndex })\n  }\n}\n"],"names":["batchProcessing","batchSize","input","processBatch","Number","isInteger","TypeError","batch","batchIndex","item","push","length","result","shouldContinue"],"mappings":"AAkBA;;;;CAIC,GACD,OAAO,MAAMA,kBAAkB,OAAU,EACvCC,YAAY,GAAG,EACfC,KAAK,EACLC,YAAY,EACc;IAC1B,IAAI,CAACC,OAAOC,SAAS,CAACJ,cAAcA,YAAY,GAAG;QACjD,MAAM,IAAIK,UAAU;IACtB;IAEA,IAAIC,QAAa,EAAE;IACnB,IAAIC,aAAa;IAEjB,WAAW,MAAMC,QAAQP,MAAO;QAC9BK,MAAMG,IAAI,CAACD;QAEX,IAAIF,MAAMI,MAAM,GAAGV,WAAW;YAC5B;QACF;QAEA,MAAMW,SAAS,MAAMT,aAAa;YAAEI;YAAOC;QAAW;QAEtD,IAAII,QAAQC,mBAAmB,OAAO;YACpC;QACF;QAEAN,QAAQ,EAAE;QACVC,cAAc;IAChB;IAEA,IAAID,MAAMI,MAAM,GAAG,GAAG;QACpB,MAAMR,aAAa;YAAEI;YAAOC;QAAW;IACzC;AACF,EAAC"}

package/dist/utilities/canAccessAdmin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"canAccessAdmin.d.ts","sourceRoot":"","sources":["../../src/utilities/canAccessAdmin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAIvD;;;;;;;GAOG;AACH,eAAO,MAAM,cAAc,YAAmB;IAAE,GAAG,EAAE,cAAc,CAAA;CAAE,kBA8BpE,CAAA"}
+{"version":3,"file":"canAccessAdmin.d.ts","sourceRoot":"","sources":["../../src/utilities/canAccessAdmin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAIvD;;;;;;;GAOG;AACH,eAAO,MAAM,cAAc,YAAmB;IAAE,GAAG,EAAE,cAAc,CAAA;CAAE,kBA+BpE,CAAA"}

package/dist/utilities/canAccessAdmin.js

@@ -13,6 +13,7 @@ import { UnauthorizedError } from '../errors/UnauthorizedError.js';
         const adminAccessFn = req.payload.collections[incomingUserSlug]?.config.access?.admin;
         if (adminAccessFn) {
             const canAccess = await adminAccessFn({
+                slug: incomingUserSlug,
                 req
             });
             if (!canAccess) {
@@ -27,6 +28,7 @@ import { UnauthorizedError } from '../errors/UnauthorizedError.js';
             collection: adminUserSlug,
             depth: 0,
             limit: 1,
+            overrideAccess: true,
             pagination: false
         });
         // If there are users, we should not allow access because of `/create-first-user`

package/dist/utilities/canAccessAdmin.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/utilities/canAccessAdmin.ts"],"sourcesContent":["import type { PayloadRequest } from '../types/index.js'\n\nimport { UnauthorizedError } from '../errors/UnauthorizedError.js'\n\n/**\n * Protects admin-only routes, server functions, etc.\n * The requesting user must either:\n * a. pass the `access.admin` function on the `users` collection, if defined\n * b. match the `config.admin.user` property on the Payload config\n * c. if no user is present, and there are no users in the system, allow access (for first user creation)\n * @throws {Error} Throws an `Unauthorized` error if access is denied that can be explicitly caught\n */\nexport const canAccessAdmin = async ({ req }: { req: PayloadRequest }) => {\n  const incomingUserSlug = req.user?.collection\n  const adminUserSlug = req.payload.config.admin.user\n\n  if (incomingUserSlug) {\n    const adminAccessFn = req.payload.collections[incomingUserSlug]?.config.access?.admin\n\n    if (adminAccessFn) {\n      const canAccess = await adminAccessFn({ req })\n\n      if (!canAccess) {\n        throw new UnauthorizedError()\n      }\n      // Match the user collection to the global admin config\n    } else if (adminUserSlug !== incomingUserSlug) {\n      throw new UnauthorizedError()\n    }\n  } else {\n    const hasUsers = await req.payload.find({\n      collection: adminUserSlug,\n      depth: 0,\n      limit: 1,\n      pagination: false,\n    })\n\n    // If there are users, we should not allow access because of `/create-first-user`\n    if (hasUsers.docs.length) {\n      throw new UnauthorizedError()\n    }\n  }\n}\n"],"names":["UnauthorizedError","canAccessAdmin","req","incomingUserSlug","user","collection","adminUserSlug","payload","config","admin","adminAccessFn","collections","access","canAccess","hasUsers","find","depth","limit","pagination","docs","length"],"mappings":"AAEA,SAASA,iBAAiB,QAAQ,iCAAgC;AAElE;;;;;;;CAOC,GACD,OAAO,MAAMC,iBAAiB,OAAO,EAAEC,GAAG,EAA2B;IACnE,MAAMC,mBAAmBD,IAAIE,IAAI,EAAEC;IACnC,MAAMC,gBAAgBJ,IAAIK,OAAO,CAACC,MAAM,CAACC,KAAK,CAACL,IAAI;IAEnD,IAAID,kBAAkB;QACpB,MAAMO,gBAAgBR,IAAIK,OAAO,CAACI,WAAW,CAACR,iBAAiB,EAAEK,OAAOI,QAAQH;QAEhF,IAAIC,eAAe;YACjB,MAAMG,YAAY,MAAMH,cAAc;gBAAER;YAAI;YAE5C,IAAI,CAACW,WAAW;gBACd,MAAM,IAAIb;YACZ;QACA,uDAAuD;QACzD,OAAO,IAAIM,kBAAkBH,kBAAkB;YAC7C,MAAM,IAAIH;QACZ;IACF,OAAO;QACL,MAAMc,WAAW,MAAMZ,IAAIK,OAAO,CAACQ,IAAI,CAAC;YACtCV,YAAYC;YACZU,OAAO;YACPC,OAAO;YACPC,YAAY;QACd;QAEA,iFAAiF;QACjF,IAAIJ,SAASK,IAAI,CAACC,MAAM,EAAE;YACxB,MAAM,IAAIpB;QACZ;IACF;AACF,EAAC"}
+{"version":3,"sources":["../../src/utilities/canAccessAdmin.ts"],"sourcesContent":["import type { PayloadRequest } from '../types/index.js'\n\nimport { UnauthorizedError } from '../errors/UnauthorizedError.js'\n\n/**\n * Protects admin-only routes, server functions, etc.\n * The requesting user must either:\n * a. pass the `access.admin` function on the `users` collection, if defined\n * b. match the `config.admin.user` property on the Payload config\n * c. if no user is present, and there are no users in the system, allow access (for first user creation)\n * @throws {Error} Throws an `Unauthorized` error if access is denied that can be explicitly caught\n */\nexport const canAccessAdmin = async ({ req }: { req: PayloadRequest }) => {\n  const incomingUserSlug = req.user?.collection\n  const adminUserSlug = req.payload.config.admin.user\n\n  if (incomingUserSlug) {\n    const adminAccessFn = req.payload.collections[incomingUserSlug]?.config.access?.admin\n\n    if (adminAccessFn) {\n      const canAccess = await adminAccessFn({ slug: incomingUserSlug, req })\n\n      if (!canAccess) {\n        throw new UnauthorizedError()\n      }\n      // Match the user collection to the global admin config\n    } else if (adminUserSlug !== incomingUserSlug) {\n      throw new UnauthorizedError()\n    }\n  } else {\n    const hasUsers = await req.payload.find({\n      collection: adminUserSlug,\n      depth: 0,\n      limit: 1,\n      overrideAccess: true,\n      pagination: false,\n    })\n\n    // If there are users, we should not allow access because of `/create-first-user`\n    if (hasUsers.docs.length) {\n      throw new UnauthorizedError()\n    }\n  }\n}\n"],"names":["UnauthorizedError","canAccessAdmin","req","incomingUserSlug","user","collection","adminUserSlug","payload","config","admin","adminAccessFn","collections","access","canAccess","slug","hasUsers","find","depth","limit","overrideAccess","pagination","docs","length"],"mappings":"AAEA,SAASA,iBAAiB,QAAQ,iCAAgC;AAElE;;;;;;;CAOC,GACD,OAAO,MAAMC,iBAAiB,OAAO,EAAEC,GAAG,EAA2B;IACnE,MAAMC,mBAAmBD,IAAIE,IAAI,EAAEC;IACnC,MAAMC,gBAAgBJ,IAAIK,OAAO,CAACC,MAAM,CAACC,KAAK,CAACL,IAAI;IAEnD,IAAID,kBAAkB;QACpB,MAAMO,gBAAgBR,IAAIK,OAAO,CAACI,WAAW,CAACR,iBAAiB,EAAEK,OAAOI,QAAQH;QAEhF,IAAIC,eAAe;YACjB,MAAMG,YAAY,MAAMH,cAAc;gBAAEI,MAAMX;gBAAkBD;YAAI;YAEpE,IAAI,CAACW,WAAW;gBACd,MAAM,IAAIb;YACZ;QACA,uDAAuD;QACzD,OAAO,IAAIM,kBAAkBH,kBAAkB;YAC7C,MAAM,IAAIH;QACZ;IACF,OAAO;QACL,MAAMe,WAAW,MAAMb,IAAIK,OAAO,CAACS,IAAI,CAAC;YACtCX,YAAYC;YACZW,OAAO;YACPC,OAAO;YACPC,gBAAgB;YAChBC,YAAY;QACd;QAEA,iFAAiF;QACjF,IAAIL,SAASM,IAAI,CAACC,MAAM,EAAE;YACxB,MAAM,IAAItB;QACZ;IACF;AACF,EAAC"}

package/dist/utilities/checkDocumentLockStatus.d.ts

@@ -9,5 +9,24 @@ type CheckDocumentLockStatusArgs = {
     req: PayloadRequest;
 };
 export declare const checkDocumentLockStatus: ({ id, collectionSlug, globalSlug, lockDurationDefault, lockErrorMessage, overrideLock, req, }: CheckDocumentLockStatusArgs) => Promise<void>;
+type BulkLockArgs = {
+    collectionSlug: string;
+    ids: (number | string)[];
+    req: PayloadRequest;
+};
+/**
+ * Batched counterpart to `checkDocumentLockStatus`. Resolves the lock state of every id with a
+ * single query instead of one per document, and returns the ids that are locked by another user.
+ * Callers are expected to report those ids as errors and leave them alone.
+ */
+export declare const getLockedDocumentIds: ({ collectionSlug, ids, lockDurationDefault, overrideLock, req, }: {
+    lockDurationDefault?: number;
+    overrideLock?: boolean;
+} & BulkLockArgs) => Promise<Set<string>>;
+/**
+ * Batched counterpart to the lock cleanup `checkDocumentLockStatus` performs, so that bulk
+ * operations release every lock in one query instead of one per document.
+ */
+export declare const deleteDocumentLocks: ({ collectionSlug, ids, req, }: BulkLockArgs) => Promise<void>;
 export {};
 //# sourceMappingURL=checkDocumentLockStatus.d.ts.map

package/dist/utilities/checkDocumentLockStatus.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"checkDocumentLockStatus.d.ts","sourceRoot":"","sources":["../../src/utilities/checkDocumentLockStatus.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAc,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAKnE,KAAK,2BAA2B,GAAG;IACjC,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACpB,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,GAAG,EAAE,cAAc,CAAA;CACpB,CAAA;AAED,eAAO,MAAM,uBAAuB,kGAQjC,2BAA2B,KAAG,OAAO,CAAC,IAAI,CAgF5C,CAAA"}
+{"version":3,"file":"checkDocumentLockStatus.d.ts","sourceRoot":"","sources":["../../src/utilities/checkDocumentLockStatus.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAc,cAAc,EAAS,MAAM,mBAAmB,CAAA;AAK1E,KAAK,2BAA2B,GAAG;IACjC,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACpB,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,GAAG,EAAE,cAAc,CAAA;CACpB,CAAA;AAED,eAAO,MAAM,uBAAuB,kGAQjC,2BAA2B,KAAG,OAAO,CAAC,IAAI,CAgF5C,CAAA;AAED,KAAK,YAAY,GAAG;IAClB,cAAc,EAAE,MAAM,CAAA;IACtB,GAAG,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAA;IACxB,GAAG,EAAE,cAAc,CAAA;CACpB,CAAA;AAgBD;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,qEAM9B;IACD,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB,GAAG,YAAY,KAAG,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CA+CrC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,mBAAmB,kCAI7B,YAAY,KAAG,OAAO,CAAC,IAAI,CAa7B,CAAA"}

package/dist/utilities/checkDocumentLockStatus.js

@@ -71,5 +71,79 @@ export const checkDocumentLockStatus = async ({ id, collectionSlug, globalSlug,
         where: lockedDocumentQuery
     });
 };
+const buildBulkLockedDocumentQuery = (collectionSlug, ids)=>({
+        and: [
+            {
+                'document.relationTo': {
+                    equals: collectionSlug
+                }
+            },
+            {
+                'document.value': {
+                    in: ids
+                }
+            }
+        ]
+    });
+const isLockingAvailable = (collectionSlug, req)=>{
+    const { payload } = req;
+    if (!payload.collections?.[lockedDocumentsCollectionSlug]) {
+        return false;
+    }
+    return payload.collections?.[collectionSlug]?.config?.lockDocuments !== false;
+};
+/**
+ * Batched counterpart to `checkDocumentLockStatus`. Resolves the lock state of every id with a
+ * single query instead of one per document, and returns the ids that are locked by another user.
+ * Callers are expected to report those ids as errors and leave them alone.
+ */ export const getLockedDocumentIds = async ({ collectionSlug, ids, lockDurationDefault = 300, overrideLock = true, req })=>{
+    const lockedIds = new Set();
+    if (overrideLock || !ids.length || !isLockingAvailable(collectionSlug, req)) {
+        return lockedIds;
+    }
+    const { payload } = req;
+    const lockDocumentsProp = payload.collections?.[collectionSlug]?.config?.lockDocuments;
+    const lockedDocumentResult = await payload.db.find({
+        collection: lockedDocumentsCollectionSlug,
+        limit: 0,
+        pagination: false,
+        sort: '-updatedAt',
+        where: buildBulkLockedDocumentQuery(collectionSlug, ids)
+    });
+    const lockDuration = typeof lockDocumentsProp === 'object' ? lockDocumentsProp.duration : lockDurationDefault;
+    const lockDurationInMilliseconds = lockDuration * 1000;
+    const currentUserId = req.user?.id;
+    const now = new Date().getTime();
+    const resolved = new Set();
+    for (const lockedDoc of lockedDocumentResult?.docs ?? []){
+        const documentId = String(lockedDoc.document?.value);
+        // Sorted by -updatedAt, so the first row seen for an id is its most recent lock
+        if (resolved.has(documentId)) {
+            continue;
+        }
+        resolved.add(documentId);
+        const lastEditedAt = new Date(lockedDoc?.updatedAt).getTime();
+        // document is locked by another user and the lock hasn't expired
+        if (lockedDoc.user?.value !== currentUserId && now - lastEditedAt <= lockDurationInMilliseconds) {
+            lockedIds.add(documentId);
+        }
+    }
+    return lockedIds;
+};
+/**
+ * Batched counterpart to the lock cleanup `checkDocumentLockStatus` performs, so that bulk
+ * operations release every lock in one query instead of one per document.
+ */ export const deleteDocumentLocks = async ({ collectionSlug, ids, req })=>{
+    const { payload } = req;
+    if (!ids.length || !isLockingAvailable(collectionSlug, req)) {
+        return;
+    }
+    await payload.db.deleteMany({
+        collection: lockedDocumentsCollectionSlug,
+        // Not passing req fails on postgres
+        req: payload.db.name === 'mongoose' ? undefined : req,
+        where: buildBulkLockedDocumentQuery(collectionSlug, ids)
+    });
+};
 
 //# sourceMappingURL=checkDocumentLockStatus.js.map

package/dist/utilities/checkDocumentLockStatus.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/utilities/checkDocumentLockStatus.ts"],"sourcesContent":["import type { TypeWithID } from '../collections/config/types.js'\nimport type { PaginatedDocs } from '../database/types.js'\nimport type { JsonObject, PayloadRequest } from '../types/index.js'\n\nimport { Locked } from '../errors/index.js'\nimport { lockedDocumentsCollectionSlug } from '../locked-documents/config.js'\n\ntype CheckDocumentLockStatusArgs = {\n  collectionSlug?: string\n  globalSlug?: string\n  id?: number | string\n  lockDurationDefault?: number\n  lockErrorMessage?: string\n  overrideLock?: boolean\n  req: PayloadRequest\n}\n\nexport const checkDocumentLockStatus = async ({\n  id,\n  collectionSlug,\n  globalSlug,\n  lockDurationDefault = 300, // Default 5 minutes in seconds\n  lockErrorMessage,\n  overrideLock = true,\n  req,\n}: CheckDocumentLockStatusArgs): Promise<void> => {\n  const { payload } = req\n\n  // Check if the locked-documents collection exists\n  if (!payload.collections?.[lockedDocumentsCollectionSlug]) {\n    // If the collection doesn't exist, locking is not available\n    return\n  }\n\n  // Retrieve the lockDocuments property for either collection or global\n  const lockDocumentsProp = collectionSlug\n    ? payload.collections?.[collectionSlug]?.config?.lockDocuments\n    : payload.config?.globals?.find((g) => g.slug === globalSlug)?.lockDocuments\n\n  const isLockingEnabled = lockDocumentsProp !== false\n\n  let lockedDocumentQuery = {}\n\n  if (collectionSlug) {\n    lockedDocumentQuery = {\n      and: [\n        { 'document.relationTo': { equals: collectionSlug } },\n        { 'document.value': { equals: id } },\n      ],\n    }\n  } else if (globalSlug) {\n    lockedDocumentQuery = { globalSlug: { equals: globalSlug } }\n  } else {\n    throw new Error('Either collectionSlug or globalSlug must be provided.')\n  }\n\n  if (!isLockingEnabled) {\n    return\n  }\n\n  // Only perform lock checks if overrideLock is false and locking is enabled\n  if (!overrideLock) {\n    const defaultLockErrorMessage = collectionSlug\n      ? `Document with ID ${id} is currently locked by another user and cannot be modified.`\n      : `Global document with slug \"${globalSlug}\" is currently locked by another user and cannot be modified.`\n\n    const finalLockErrorMessage = lockErrorMessage || defaultLockErrorMessage\n\n    const lockedDocumentResult: PaginatedDocs<JsonObject & TypeWithID> = await payload.db.find({\n      collection: lockedDocumentsCollectionSlug,\n      limit: 1,\n      pagination: false,\n      sort: '-updatedAt',\n      where: lockedDocumentQuery,\n    })\n\n    // If there's a locked document, check lock conditions\n    const lockedDoc = lockedDocumentResult?.docs[0]\n    if (lockedDoc) {\n      const lastEditedAt = new Date(lockedDoc?.updatedAt).getTime()\n      const now = new Date().getTime()\n\n      const lockDuration =\n        typeof lockDocumentsProp === 'object' ? lockDocumentsProp.duration : lockDurationDefault\n\n      const lockDurationInMilliseconds = lockDuration * 1000\n      const currentUserId = req.user?.id\n\n      // document is locked by another user and the lock hasn't expired\n      if (\n        lockedDoc.user?.value !== currentUserId &&\n        now - lastEditedAt <= lockDurationInMilliseconds\n      ) {\n        throw new Locked(finalLockErrorMessage)\n      }\n    }\n  }\n\n  // Perform the delete operation regardless of overrideLock status\n  await payload.db.deleteMany({\n    collection: lockedDocumentsCollectionSlug,\n    // Not passing req fails on postgres\n    req: payload.db.name === 'mongoose' ? undefined : req,\n    where: lockedDocumentQuery,\n  })\n}\n"],"names":["Locked","lockedDocumentsCollectionSlug","checkDocumentLockStatus","id","collectionSlug","globalSlug","lockDurationDefault","lockErrorMessage","overrideLock","req","payload","collections","lockDocumentsProp","config","lockDocuments","globals","find","g","slug","isLockingEnabled","lockedDocumentQuery","and","equals","Error","defaultLockErrorMessage","finalLockErrorMessage","lockedDocumentResult","db","collection","limit","pagination","sort","where","lockedDoc","docs","lastEditedAt","Date","updatedAt","getTime","now","lockDuration","duration","lockDurationInMilliseconds","currentUserId","user","value","deleteMany","name","undefined"],"mappings":"AAIA,SAASA,MAAM,QAAQ,qBAAoB;AAC3C,SAASC,6BAA6B,QAAQ,gCAA+B;AAY7E,OAAO,MAAMC,0BAA0B,OAAO,EAC5CC,EAAE,EACFC,cAAc,EACdC,UAAU,EACVC,sBAAsB,GAAG,EACzBC,gBAAgB,EAChBC,eAAe,IAAI,EACnBC,GAAG,EACyB;IAC5B,MAAM,EAAEC,OAAO,EAAE,GAAGD;IAEpB,kDAAkD;IAClD,IAAI,CAACC,QAAQC,WAAW,EAAE,CAACV,8BAA8B,EAAE;QACzD,4DAA4D;QAC5D;IACF;IAEA,sEAAsE;IACtE,MAAMW,oBAAoBR,iBACtBM,QAAQC,WAAW,EAAE,CAACP,eAAe,EAAES,QAAQC,gBAC/CJ,QAAQG,MAAM,EAAEE,SAASC,KAAK,CAACC,IAAMA,EAAEC,IAAI,KAAKb,aAAaS;IAEjE,MAAMK,mBAAmBP,sBAAsB;IAE/C,IAAIQ,sBAAsB,CAAC;IAE3B,IAAIhB,gBAAgB;QAClBgB,sBAAsB;YACpBC,KAAK;gBACH;oBAAE,uBAAuB;wBAAEC,QAAQlB;oBAAe;gBAAE;gBACpD;oBAAE,kBAAkB;wBAAEkB,QAAQnB;oBAAG;gBAAE;aACpC;QACH;IACF,OAAO,IAAIE,YAAY;QACrBe,sBAAsB;YAAEf,YAAY;gBAAEiB,QAAQjB;YAAW;QAAE;IAC7D,OAAO;QACL,MAAM,IAAIkB,MAAM;IAClB;IAEA,IAAI,CAACJ,kBAAkB;QACrB;IACF;IAEA,2EAA2E;IAC3E,IAAI,CAACX,cAAc;QACjB,MAAMgB,0BAA0BpB,iBAC5B,CAAC,iBAAiB,EAAED,GAAG,4DAA4D,CAAC,GACpF,CAAC,2BAA2B,EAAEE,WAAW,6DAA6D,CAAC;QAE3G,MAAMoB,wBAAwBlB,oBAAoBiB;QAElD,MAAME,uBAA+D,MAAMhB,QAAQiB,EAAE,CAACX,IAAI,CAAC;YACzFY,YAAY3B;YACZ4B,OAAO;YACPC,YAAY;YACZC,MAAM;YACNC,OAAOZ;QACT;QAEA,sDAAsD;QACtD,MAAMa,YAAYP,sBAAsBQ,IAAI,CAAC,EAAE;QAC/C,IAAID,WAAW;YACb,MAAME,eAAe,IAAIC,KAAKH,WAAWI,WAAWC,OAAO;YAC3D,MAAMC,MAAM,IAAIH,OAAOE,OAAO;YAE9B,MAAME,eACJ,OAAO5B,sBAAsB,WAAWA,kBAAkB6B,QAAQ,GAAGnC;YAEvE,MAAMoC,6BAA6BF,eAAe;YAClD,MAAMG,gBAAgBlC,IAAImC,IAAI,EAAEzC;YAEhC,iEAAiE;YACjE,IACE8B,UAAUW,IAAI,EAAEC,UAAUF,iBAC1BJ,MAAMJ,gBAAgBO,4BACtB;gBACA,MAAM,IAAI1C,OAAOyB;YACnB;QACF;IACF;IAEA,iEAAiE;IACjE,MAAMf,QAAQiB,EAAE,CAACmB,UAAU,CAAC;QAC1BlB,YAAY3B;QACZ,oCAAoC;QACpCQ,KAAKC,QAAQiB,EAAE,CAACoB,IAAI,KAAK,aAAaC,YAAYvC;QAClDuB,OAAOZ;IACT;AACF,EAAC"}
+{"version":3,"sources":["../../src/utilities/checkDocumentLockStatus.ts"],"sourcesContent":["import type { TypeWithID } from '../collections/config/types.js'\nimport type { PaginatedDocs } from '../database/types.js'\nimport type { JsonObject, PayloadRequest, Where } from '../types/index.js'\n\nimport { Locked } from '../errors/index.js'\nimport { lockedDocumentsCollectionSlug } from '../locked-documents/config.js'\n\ntype CheckDocumentLockStatusArgs = {\n  collectionSlug?: string\n  globalSlug?: string\n  id?: number | string\n  lockDurationDefault?: number\n  lockErrorMessage?: string\n  overrideLock?: boolean\n  req: PayloadRequest\n}\n\nexport const checkDocumentLockStatus = async ({\n  id,\n  collectionSlug,\n  globalSlug,\n  lockDurationDefault = 300, // Default 5 minutes in seconds\n  lockErrorMessage,\n  overrideLock = true,\n  req,\n}: CheckDocumentLockStatusArgs): Promise<void> => {\n  const { payload } = req\n\n  // Check if the locked-documents collection exists\n  if (!payload.collections?.[lockedDocumentsCollectionSlug]) {\n    // If the collection doesn't exist, locking is not available\n    return\n  }\n\n  // Retrieve the lockDocuments property for either collection or global\n  const lockDocumentsProp = collectionSlug\n    ? payload.collections?.[collectionSlug]?.config?.lockDocuments\n    : payload.config?.globals?.find((g) => g.slug === globalSlug)?.lockDocuments\n\n  const isLockingEnabled = lockDocumentsProp !== false\n\n  let lockedDocumentQuery = {}\n\n  if (collectionSlug) {\n    lockedDocumentQuery = {\n      and: [\n        { 'document.relationTo': { equals: collectionSlug } },\n        { 'document.value': { equals: id } },\n      ],\n    }\n  } else if (globalSlug) {\n    lockedDocumentQuery = { globalSlug: { equals: globalSlug } }\n  } else {\n    throw new Error('Either collectionSlug or globalSlug must be provided.')\n  }\n\n  if (!isLockingEnabled) {\n    return\n  }\n\n  // Only perform lock checks if overrideLock is false and locking is enabled\n  if (!overrideLock) {\n    const defaultLockErrorMessage = collectionSlug\n      ? `Document with ID ${id} is currently locked by another user and cannot be modified.`\n      : `Global document with slug \"${globalSlug}\" is currently locked by another user and cannot be modified.`\n\n    const finalLockErrorMessage = lockErrorMessage || defaultLockErrorMessage\n\n    const lockedDocumentResult: PaginatedDocs<JsonObject & TypeWithID> = await payload.db.find({\n      collection: lockedDocumentsCollectionSlug,\n      limit: 1,\n      pagination: false,\n      sort: '-updatedAt',\n      where: lockedDocumentQuery,\n    })\n\n    // If there's a locked document, check lock conditions\n    const lockedDoc = lockedDocumentResult?.docs[0]\n    if (lockedDoc) {\n      const lastEditedAt = new Date(lockedDoc?.updatedAt).getTime()\n      const now = new Date().getTime()\n\n      const lockDuration =\n        typeof lockDocumentsProp === 'object' ? lockDocumentsProp.duration : lockDurationDefault\n\n      const lockDurationInMilliseconds = lockDuration * 1000\n      const currentUserId = req.user?.id\n\n      // document is locked by another user and the lock hasn't expired\n      if (\n        lockedDoc.user?.value !== currentUserId &&\n        now - lastEditedAt <= lockDurationInMilliseconds\n      ) {\n        throw new Locked(finalLockErrorMessage)\n      }\n    }\n  }\n\n  // Perform the delete operation regardless of overrideLock status\n  await payload.db.deleteMany({\n    collection: lockedDocumentsCollectionSlug,\n    // Not passing req fails on postgres\n    req: payload.db.name === 'mongoose' ? undefined : req,\n    where: lockedDocumentQuery,\n  })\n}\n\ntype BulkLockArgs = {\n  collectionSlug: string\n  ids: (number | string)[]\n  req: PayloadRequest\n}\n\nconst buildBulkLockedDocumentQuery = (collectionSlug: string, ids: (number | string)[]): Where => ({\n  and: [{ 'document.relationTo': { equals: collectionSlug } }, { 'document.value': { in: ids } }],\n})\n\nconst isLockingAvailable = (collectionSlug: string, req: PayloadRequest): boolean => {\n  const { payload } = req\n\n  if (!payload.collections?.[lockedDocumentsCollectionSlug]) {\n    return false\n  }\n\n  return payload.collections?.[collectionSlug]?.config?.lockDocuments !== false\n}\n\n/**\n * Batched counterpart to `checkDocumentLockStatus`. Resolves the lock state of every id with a\n * single query instead of one per document, and returns the ids that are locked by another user.\n * Callers are expected to report those ids as errors and leave them alone.\n */\nexport const getLockedDocumentIds = async ({\n  collectionSlug,\n  ids,\n  lockDurationDefault = 300, // Default 5 minutes in seconds\n  overrideLock = true,\n  req,\n}: {\n  lockDurationDefault?: number\n  overrideLock?: boolean\n} & BulkLockArgs): Promise<Set<string>> => {\n  const lockedIds = new Set<string>()\n\n  if (overrideLock || !ids.length || !isLockingAvailable(collectionSlug, req)) {\n    return lockedIds\n  }\n\n  const { payload } = req\n  const lockDocumentsProp = payload.collections?.[collectionSlug]?.config?.lockDocuments\n\n  const lockedDocumentResult: PaginatedDocs<JsonObject & TypeWithID> = await payload.db.find({\n    collection: lockedDocumentsCollectionSlug,\n    limit: 0,\n    pagination: false,\n    sort: '-updatedAt',\n    where: buildBulkLockedDocumentQuery(collectionSlug, ids),\n  })\n\n  const lockDuration =\n    typeof lockDocumentsProp === 'object' ? lockDocumentsProp.duration : lockDurationDefault\n\n  const lockDurationInMilliseconds = lockDuration * 1000\n  const currentUserId = req.user?.id\n  const now = new Date().getTime()\n  const resolved = new Set<string>()\n\n  for (const lockedDoc of lockedDocumentResult?.docs ?? []) {\n    const documentId = String(lockedDoc.document?.value)\n\n    // Sorted by -updatedAt, so the first row seen for an id is its most recent lock\n    if (resolved.has(documentId)) {\n      continue\n    }\n    resolved.add(documentId)\n\n    const lastEditedAt = new Date(lockedDoc?.updatedAt).getTime()\n\n    // document is locked by another user and the lock hasn't expired\n    if (\n      lockedDoc.user?.value !== currentUserId &&\n      now - lastEditedAt <= lockDurationInMilliseconds\n    ) {\n      lockedIds.add(documentId)\n    }\n  }\n\n  return lockedIds\n}\n\n/**\n * Batched counterpart to the lock cleanup `checkDocumentLockStatus` performs, so that bulk\n * operations release every lock in one query instead of one per document.\n */\nexport const deleteDocumentLocks = async ({\n  collectionSlug,\n  ids,\n  req,\n}: BulkLockArgs): Promise<void> => {\n  const { payload } = req\n\n  if (!ids.length || !isLockingAvailable(collectionSlug, req)) {\n    return\n  }\n\n  await payload.db.deleteMany({\n    collection: lockedDocumentsCollectionSlug,\n    // Not passing req fails on postgres\n    req: payload.db.name === 'mongoose' ? undefined : req,\n    where: buildBulkLockedDocumentQuery(collectionSlug, ids),\n  })\n}\n"],"names":["Locked","lockedDocumentsCollectionSlug","checkDocumentLockStatus","id","collectionSlug","globalSlug","lockDurationDefault","lockErrorMessage","overrideLock","req","payload","collections","lockDocumentsProp","config","lockDocuments","globals","find","g","slug","isLockingEnabled","lockedDocumentQuery","and","equals","Error","defaultLockErrorMessage","finalLockErrorMessage","lockedDocumentResult","db","collection","limit","pagination","sort","where","lockedDoc","docs","lastEditedAt","Date","updatedAt","getTime","now","lockDuration","duration","lockDurationInMilliseconds","currentUserId","user","value","deleteMany","name","undefined","buildBulkLockedDocumentQuery","ids","in","isLockingAvailable","getLockedDocumentIds","lockedIds","Set","length","resolved","documentId","String","document","has","add","deleteDocumentLocks"],"mappings":"AAIA,SAASA,MAAM,QAAQ,qBAAoB;AAC3C,SAASC,6BAA6B,QAAQ,gCAA+B;AAY7E,OAAO,MAAMC,0BAA0B,OAAO,EAC5CC,EAAE,EACFC,cAAc,EACdC,UAAU,EACVC,sBAAsB,GAAG,EACzBC,gBAAgB,EAChBC,eAAe,IAAI,EACnBC,GAAG,EACyB;IAC5B,MAAM,EAAEC,OAAO,EAAE,GAAGD;IAEpB,kDAAkD;IAClD,IAAI,CAACC,QAAQC,WAAW,EAAE,CAACV,8BAA8B,EAAE;QACzD,4DAA4D;QAC5D;IACF;IAEA,sEAAsE;IACtE,MAAMW,oBAAoBR,iBACtBM,QAAQC,WAAW,EAAE,CAACP,eAAe,EAAES,QAAQC,gBAC/CJ,QAAQG,MAAM,EAAEE,SAASC,KAAK,CAACC,IAAMA,EAAEC,IAAI,KAAKb,aAAaS;IAEjE,MAAMK,mBAAmBP,sBAAsB;IAE/C,IAAIQ,sBAAsB,CAAC;IAE3B,IAAIhB,gBAAgB;QAClBgB,sBAAsB;YACpBC,KAAK;gBACH;oBAAE,uBAAuB;wBAAEC,QAAQlB;oBAAe;gBAAE;gBACpD;oBAAE,kBAAkB;wBAAEkB,QAAQnB;oBAAG;gBAAE;aACpC;QACH;IACF,OAAO,IAAIE,YAAY;QACrBe,sBAAsB;YAAEf,YAAY;gBAAEiB,QAAQjB;YAAW;QAAE;IAC7D,OAAO;QACL,MAAM,IAAIkB,MAAM;IAClB;IAEA,IAAI,CAACJ,kBAAkB;QACrB;IACF;IAEA,2EAA2E;IAC3E,IAAI,CAACX,cAAc;QACjB,MAAMgB,0BAA0BpB,iBAC5B,CAAC,iBAAiB,EAAED,GAAG,4DAA4D,CAAC,GACpF,CAAC,2BAA2B,EAAEE,WAAW,6DAA6D,CAAC;QAE3G,MAAMoB,wBAAwBlB,oBAAoBiB;QAElD,MAAME,uBAA+D,MAAMhB,QAAQiB,EAAE,CAACX,IAAI,CAAC;YACzFY,YAAY3B;YACZ4B,OAAO;YACPC,YAAY;YACZC,MAAM;YACNC,OAAOZ;QACT;QAEA,sDAAsD;QACtD,MAAMa,YAAYP,sBAAsBQ,IAAI,CAAC,EAAE;QAC/C,IAAID,WAAW;YACb,MAAME,eAAe,IAAIC,KAAKH,WAAWI,WAAWC,OAAO;YAC3D,MAAMC,MAAM,IAAIH,OAAOE,OAAO;YAE9B,MAAME,eACJ,OAAO5B,sBAAsB,WAAWA,kBAAkB6B,QAAQ,GAAGnC;YAEvE,MAAMoC,6BAA6BF,eAAe;YAClD,MAAMG,gBAAgBlC,IAAImC,IAAI,EAAEzC;YAEhC,iEAAiE;YACjE,IACE8B,UAAUW,IAAI,EAAEC,UAAUF,iBAC1BJ,MAAMJ,gBAAgBO,4BACtB;gBACA,MAAM,IAAI1C,OAAOyB;YACnB;QACF;IACF;IAEA,iEAAiE;IACjE,MAAMf,QAAQiB,EAAE,CAACmB,UAAU,CAAC;QAC1BlB,YAAY3B;QACZ,oCAAoC;QACpCQ,KAAKC,QAAQiB,EAAE,CAACoB,IAAI,KAAK,aAAaC,YAAYvC;QAClDuB,OAAOZ;IACT;AACF,EAAC;AAQD,MAAM6B,+BAA+B,CAAC7C,gBAAwB8C,MAAqC,CAAA;QACjG7B,KAAK;YAAC;gBAAE,uBAAuB;oBAAEC,QAAQlB;gBAAe;YAAE;YAAG;gBAAE,kBAAkB;oBAAE+C,IAAID;gBAAI;YAAE;SAAE;IACjG,CAAA;AAEA,MAAME,qBAAqB,CAAChD,gBAAwBK;IAClD,MAAM,EAAEC,OAAO,EAAE,GAAGD;IAEpB,IAAI,CAACC,QAAQC,WAAW,EAAE,CAACV,8BAA8B,EAAE;QACzD,OAAO;IACT;IAEA,OAAOS,QAAQC,WAAW,EAAE,CAACP,eAAe,EAAES,QAAQC,kBAAkB;AAC1E;AAEA;;;;CAIC,GACD,OAAO,MAAMuC,uBAAuB,OAAO,EACzCjD,cAAc,EACd8C,GAAG,EACH5C,sBAAsB,GAAG,EACzBE,eAAe,IAAI,EACnBC,GAAG,EAIW;IACd,MAAM6C,YAAY,IAAIC;IAEtB,IAAI/C,gBAAgB,CAAC0C,IAAIM,MAAM,IAAI,CAACJ,mBAAmBhD,gBAAgBK,MAAM;QAC3E,OAAO6C;IACT;IAEA,MAAM,EAAE5C,OAAO,EAAE,GAAGD;IACpB,MAAMG,oBAAoBF,QAAQC,WAAW,EAAE,CAACP,eAAe,EAAES,QAAQC;IAEzE,MAAMY,uBAA+D,MAAMhB,QAAQiB,EAAE,CAACX,IAAI,CAAC;QACzFY,YAAY3B;QACZ4B,OAAO;QACPC,YAAY;QACZC,MAAM;QACNC,OAAOiB,6BAA6B7C,gBAAgB8C;IACtD;IAEA,MAAMV,eACJ,OAAO5B,sBAAsB,WAAWA,kBAAkB6B,QAAQ,GAAGnC;IAEvE,MAAMoC,6BAA6BF,eAAe;IAClD,MAAMG,gBAAgBlC,IAAImC,IAAI,EAAEzC;IAChC,MAAMoC,MAAM,IAAIH,OAAOE,OAAO;IAC9B,MAAMmB,WAAW,IAAIF;IAErB,KAAK,MAAMtB,aAAaP,sBAAsBQ,QAAQ,EAAE,CAAE;QACxD,MAAMwB,aAAaC,OAAO1B,UAAU2B,QAAQ,EAAEf;QAE9C,gFAAgF;QAChF,IAAIY,SAASI,GAAG,CAACH,aAAa;YAC5B;QACF;QACAD,SAASK,GAAG,CAACJ;QAEb,MAAMvB,eAAe,IAAIC,KAAKH,WAAWI,WAAWC,OAAO;QAE3D,iEAAiE;QACjE,IACEL,UAAUW,IAAI,EAAEC,UAAUF,iBAC1BJ,MAAMJ,gBAAgBO,4BACtB;YACAY,UAAUQ,GAAG,CAACJ;QAChB;IACF;IAEA,OAAOJ;AACT,EAAC;AAED;;;CAGC,GACD,OAAO,MAAMS,sBAAsB,OAAO,EACxC3D,cAAc,EACd8C,GAAG,EACHzC,GAAG,EACU;IACb,MAAM,EAAEC,OAAO,EAAE,GAAGD;IAEpB,IAAI,CAACyC,IAAIM,MAAM,IAAI,CAACJ,mBAAmBhD,gBAAgBK,MAAM;QAC3D;IACF;IAEA,MAAMC,QAAQiB,EAAE,CAACmB,UAAU,CAAC;QAC1BlB,YAAY3B;QACZ,oCAAoC;QACpCQ,KAAKC,QAAQiB,EAAE,CAACoB,IAAI,KAAK,aAAaC,YAAYvC;QAClDuB,OAAOiB,6BAA6B7C,gBAAgB8C;IACtD;AACF,EAAC"}

package/dist/utilities/createPayloadRequest.d.ts

@@ -1,14 +1,16 @@
-import type { SanitizedConfig } from '../config/types.js';
+import type { Payload, RequestContext, TypedLocale, User } from '../index.js';
 import type { PayloadRequest } from '../types/index.js';
-type Args = {
-    canSetHeaders?: boolean;
-    config: Promise<SanitizedConfig> | SanitizedConfig;
-    params?: {
-        collection: string;
-    };
-    payloadInstanceCacheKey?: string;
-    request: Request;
+export type CreatePayloadRequestArgs = {
+    context?: RequestContext;
+    depth?: number;
+    fallbackLocale?: false | TypedLocale;
+    locale?: string;
+    payload: Payload;
+    req?: Partial<PayloadRequest>;
+    urlSuffix?: string;
+    user?: User;
 };
-export declare const createPayloadRequest: ({ canSetHeaders, config: configPromise, params, payloadInstanceCacheKey, request, }: Args) => Promise<PayloadRequest>;
+type CreatePayloadRequest = (args: CreatePayloadRequestArgs) => Promise<PayloadRequest>;
+export declare const createPayloadRequest: CreatePayloadRequest;
 export {};
 //# sourceMappingURL=createPayloadRequest.d.ts.map

package/dist/utilities/createPayloadRequest.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createPayloadRequest.d.ts","sourceRoot":"","sources":["../../src/utilities/createPayloadRequest.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAA;AAEzD,OAAO,KAAK,EAAkC,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAUvF,KAAK,IAAI,GAAG;IACV,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,MAAM,EAAE,OAAO,CAAC,eAAe,CAAC,GAAG,eAAe,CAAA;IAClD,MAAM,CAAC,EAAE;QACP,UAAU,EAAE,MAAM,CAAA;KACnB,CAAA;IACD,uBAAuB,CAAC,EAAE,MAAM,CAAA;IAChC,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,eAAO,MAAM,oBAAoB,wFAM9B,IAAI,KAAG,OAAO,CAAC,cAAc,CA2G/B,CAAA"}
+{"version":3,"file":"createPayloadRequest.d.ts","sourceRoot":"","sources":["../../src/utilities/createPayloadRequest.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AAC7E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAsFvD,MAAM,MAAM,wBAAwB,GAAG;IACrC,OAAO,CAAC,EAAE,cAAc,CAAA;IACxB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,cAAc,CAAC,EAAE,KAAK,GAAG,WAAW,CAAA;IACpC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,OAAO,CAAA;IAChB,GAAG,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,CAAA;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,IAAI,CAAC,EAAE,IAAI,CAAA;CACZ,CAAA;AAED,KAAK,oBAAoB,GAAG,CAAC,IAAI,EAAE,wBAAwB,KAAK,OAAO,CAAC,cAAc,CAAC,CAAA;AAEvF,eAAO,MAAM,oBAAoB,EAAE,oBA6DlC,CAAA"}

package/dist/utilities/createPayloadRequest.js

@@ -1,92 +1,109 @@
-import { initI18n } from '@payloadcms/translations';
-import * as qs from 'qs-esm';
-import { executeAuthStrategies } from '../auth/executeAuthStrategies.js';
 import { getDataLoader } from '../collections/dataloader.js';
-import { getPayload } from '../index.js';
-import { sanitizeLocales } from './addLocalesToRequest.js';
-import { formatAdminURL } from './formatAdminURL.js';
-import { getRequestLanguage } from './getRequestLanguage.js';
-import { parseCookies } from './parseCookies.js';
-export const createPayloadRequest = async ({ canSetHeaders, config: configPromise, params, payloadInstanceCacheKey, request })=>{
-    const cookies = parseCookies(request.headers);
-    const payload = await getPayload({
-        config: configPromise,
-        cron: true,
-        key: payloadInstanceCacheKey
-    });
-    const { config } = payload;
-    const localization = config.localization;
-    const urlProperties = new URL(request.url);
-    const { pathname, searchParams } = urlProperties;
-    const isGraphQL = !config.graphQL.disable && pathname === formatAdminURL({
-        apiRoute: config.routes.api,
-        path: config.routes.graphQL
-    });
-    const language = getRequestLanguage({
-        config,
-        cookies,
-        headers: request.headers
-    });
-    const i18n = await initI18n({
-        config: config.i18n,
-        context: 'api',
-        language
-    });
-    let locale = searchParams.get('locale');
-    const { search: queryToParse } = urlProperties;
-    const query = queryToParse ? qs.parse(queryToParse, {
-        allowEmptyArrays: true,
-        arrayLimit: 1000,
-        depth: 10,
-        ignoreQueryPrefix: true
-    }) : {};
-    const fallbackFromRequest = query.fallbackLocale || searchParams.get('fallback-locale') || searchParams.get('fallbackLocale');
-    let fallbackLocale = fallbackFromRequest;
+import { getLocalI18n } from '../translations/getLocalI18n.js';
+import { sanitizeFallbackLocale } from '../utilities/sanitizeFallbackLocale.js';
+function getRequestContext(req = {
+    context: null
+}, context = {}) {
+    if (req.context) {
+        if (Object.keys(req.context).length === 0 && req.context.constructor === Object) {
+            // if req.context is `{}` avoid unnecessary spread
+            return context;
+        } else {
+            return {
+                ...req.context,
+                ...context
+            };
+        }
+    } else {
+        return context;
+    }
+}
+const attachFakeURLProperties = (req, urlSuffix)=>{
+    /**
+   * *NOTE*
+   * If no URL is provided, the local API was called outside
+   * the context of a request. Therefore we create a fake URL object.
+   * `ts-expect-error` is used below for properties that are 'read-only'.
+   * Since they do not exist yet we can safely ignore the error.
+   */ let urlObject;
+    function getURLObject() {
+        if (urlObject) {
+            return urlObject;
+        }
+        const fallbackURL = `http://${req.host || 'localhost'}${urlSuffix || ''}`;
+        const urlToUse = req?.url || (req.payload?.config?.serverURL ? `${req.payload?.config.serverURL}${urlSuffix || ''}` : fallbackURL);
+        try {
+            urlObject = new URL(urlToUse);
+        } catch (_err) {
+            req.payload?.logger.error(`Failed to create URL object from URL: ${urlToUse}, falling back to ${fallbackURL}`);
+            urlObject = new URL(fallbackURL);
+        }
+        return urlObject;
+    }
+    if (!req.host) {
+        req.host = getURLObject().host;
+    }
+    if (!req.protocol) {
+        req.protocol = getURLObject().protocol;
+    }
+    if (!req.pathname) {
+        req.pathname = getURLObject().pathname;
+    }
+    if (!req.searchParams) {
+        // @ts-expect-error eslint-disable-next-line no-param-reassign
+        req.searchParams = getURLObject().searchParams;
+    }
+    if (!req.origin) {
+        // @ts-expect-error eslint-disable-next-line no-param-reassign
+        req.origin = getURLObject().origin;
+    }
+    if (!req?.url) {
+        // @ts-expect-error eslint-disable-next-line no-param-reassign
+        req.url = getURLObject().href;
+    }
+};
+export const createPayloadRequest = async ({ context, depth, fallbackLocale, locale: localeArg, payload, req = {}, urlSuffix, user })=>{
+    const localization = payload.config?.localization;
     if (localization) {
-        const locales = sanitizeLocales({
+        const locale = localeArg === '*' ? 'all' : localeArg;
+        const defaultLocale = localization.defaultLocale;
+        const localeCandidate = locale || req?.locale || req?.query?.locale;
+        req.locale = localeCandidate && typeof localeCandidate === 'string' ? localeCandidate : defaultLocale;
+        const sanitizedFallback = sanitizeFallbackLocale({
             fallbackLocale: fallbackLocale,
-            locale: locale,
+            locale: req.locale,
             localization
         });
-        fallbackLocale = locales.fallbackLocale;
-        locale = locales.locale;
+        req.fallbackLocale = sanitizedFallback;
     }
-    const customRequest = {
-        context: {},
-        fallbackLocale: fallbackLocale,
-        hash: urlProperties.hash,
-        host: urlProperties.host,
-        href: urlProperties.href,
-        i18n,
-        locale,
-        origin: urlProperties.origin,
-        pathname: urlProperties.pathname,
-        payload,
-        payloadAPI: isGraphQL ? 'GraphQL' : 'REST',
-        payloadDataLoader: undefined,
-        payloadUploadSizes: {},
-        port: urlProperties.port,
-        protocol: urlProperties.protocol,
-        query,
-        routeParams: params || {},
-        search: urlProperties.search,
-        searchParams: urlProperties.searchParams,
-        t: i18n.t,
-        transactionID: undefined,
-        user: null
-    };
-    const req = Object.assign(request, customRequest);
-    req.payloadDataLoader = getDataLoader(req);
-    const { responseHeaders, user } = await executeAuthStrategies({
-        canSetHeaders,
-        headers: req.headers,
-        isGraphQL,
-        payload
+    const i18n = req?.i18n || await getLocalI18n({
+        config: payload.config,
+        language: payload.config.i18n.fallbackLanguage
     });
-    req.user = user;
-    if (responseHeaders) {
-        req.responseHeaders = responseHeaders;
+    if (!req.headers) {
+        req.headers = new Headers();
+    }
+    req.context = getRequestContext(req, context);
+    req.payloadAPI = req?.payloadAPI || 'local';
+    req.payload = payload;
+    req.i18n = i18n;
+    req.t = i18n.t;
+    req.user = user || req?.user || null;
+    // Ensure user.collection is set for auth-related access control
+    // TODO (4.0): Instead of silently falling back, throw an error if user.collection is missing
+    if (req.user && !req.user.collection) {
+        req.user = {
+            ...req.user,
+            collection: payload.config.admin.user
+        };
+    }
+    req.payloadDataLoader = req?.payloadDataLoader || getDataLoader(req);
+    req.routeParams = req?.routeParams || {};
+    req.query = req?.query || {};
+    if (typeof depth !== 'undefined') {
+        req.query.depth = depth;
     }
+    attachFakeURLProperties(req, urlSuffix);
     return req;
 };
 

package/dist/utilities/createPayloadRequest.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/utilities/createPayloadRequest.ts"],"sourcesContent":["import { initI18n } from '@payloadcms/translations'\nimport * as qs from 'qs-esm'\n\nimport type { SanitizedConfig } from '../config/types.js'\nimport type { TypedFallbackLocale } from '../index.js'\nimport type { CustomPayloadRequestProperties, PayloadRequest } from '../types/index.js'\n\nimport { executeAuthStrategies } from '../auth/executeAuthStrategies.js'\nimport { getDataLoader } from '../collections/dataloader.js'\nimport { getPayload } from '../index.js'\nimport { sanitizeLocales } from './addLocalesToRequest.js'\nimport { formatAdminURL } from './formatAdminURL.js'\nimport { getRequestLanguage } from './getRequestLanguage.js'\nimport { parseCookies } from './parseCookies.js'\n\ntype Args = {\n  canSetHeaders?: boolean\n  config: Promise<SanitizedConfig> | SanitizedConfig\n  params?: {\n    collection: string\n  }\n  payloadInstanceCacheKey?: string\n  request: Request\n}\n\nexport const createPayloadRequest = async ({\n  canSetHeaders,\n  config: configPromise,\n  params,\n  payloadInstanceCacheKey,\n  request,\n}: Args): Promise<PayloadRequest> => {\n  const cookies = parseCookies(request.headers)\n  const payload = await getPayload({\n    config: configPromise,\n    cron: true,\n    key: payloadInstanceCacheKey,\n  })\n\n  const { config } = payload\n  const localization = config.localization\n\n  const urlProperties = new URL(request.url)\n  const { pathname, searchParams } = urlProperties\n\n  const isGraphQL =\n    !config.graphQL.disable &&\n    pathname ===\n      formatAdminURL({\n        apiRoute: config.routes.api,\n        path: config.routes.graphQL as `/${string}`,\n      })\n\n  const language = getRequestLanguage({\n    config,\n    cookies,\n    headers: request.headers,\n  })\n\n  const i18n = await initI18n({\n    config: config.i18n,\n    context: 'api',\n    language,\n  })\n\n  let locale = searchParams.get('locale')\n\n  const { search: queryToParse } = urlProperties\n\n  const query = queryToParse\n    ? qs.parse(queryToParse, {\n        allowEmptyArrays: true,\n        arrayLimit: 1000,\n        depth: 10,\n        ignoreQueryPrefix: true,\n      })\n    : {}\n\n  const fallbackFromRequest = (query.fallbackLocale ||\n    searchParams.get('fallback-locale') ||\n    searchParams.get('fallbackLocale')) as TypedFallbackLocale\n\n  let fallbackLocale = fallbackFromRequest\n\n  if (localization) {\n    const locales = sanitizeLocales({\n      fallbackLocale: fallbackLocale!,\n      locale: locale!,\n      localization,\n    })\n\n    fallbackLocale = locales.fallbackLocale!\n    locale = locales.locale!\n  }\n\n  const customRequest: CustomPayloadRequestProperties = {\n    context: {},\n    fallbackLocale: fallbackLocale!,\n    hash: urlProperties.hash,\n    host: urlProperties.host,\n    href: urlProperties.href,\n    i18n,\n    locale,\n    origin: urlProperties.origin,\n    pathname: urlProperties.pathname,\n    payload,\n    payloadAPI: isGraphQL ? 'GraphQL' : 'REST',\n    payloadDataLoader: undefined!,\n    payloadUploadSizes: {},\n    port: urlProperties.port,\n    protocol: urlProperties.protocol,\n    query,\n    routeParams: params || {},\n    search: urlProperties.search,\n    searchParams: urlProperties.searchParams,\n    t: i18n.t,\n    transactionID: undefined,\n    user: null,\n  }\n\n  const req: PayloadRequest = Object.assign(request, customRequest)\n\n  req.payloadDataLoader = getDataLoader(req)\n\n  const { responseHeaders, user } = await executeAuthStrategies({\n    canSetHeaders,\n    headers: req.headers,\n    isGraphQL,\n    payload,\n  })\n\n  req.user = user\n\n  if (responseHeaders) {\n    req.responseHeaders = responseHeaders\n  }\n\n  return req\n}\n"],"names":["initI18n","qs","executeAuthStrategies","getDataLoader","getPayload","sanitizeLocales","formatAdminURL","getRequestLanguage","parseCookies","createPayloadRequest","canSetHeaders","config","configPromise","params","payloadInstanceCacheKey","request","cookies","headers","payload","cron","key","localization","urlProperties","URL","url","pathname","searchParams","isGraphQL","graphQL","disable","apiRoute","routes","api","path","language","i18n","context","locale","get","search","queryToParse","query","parse","allowEmptyArrays","arrayLimit","depth","ignoreQueryPrefix","fallbackFromRequest","fallbackLocale","locales","customRequest","hash","host","href","origin","payloadAPI","payloadDataLoader","undefined","payloadUploadSizes","port","protocol","routeParams","t","transactionID","user","req","Object","assign","responseHeaders"],"mappings":"AAAA,SAASA,QAAQ,QAAQ,2BAA0B;AACnD,YAAYC,QAAQ,SAAQ;AAM5B,SAASC,qBAAqB,QAAQ,mCAAkC;AACxE,SAASC,aAAa,QAAQ,+BAA8B;AAC5D,SAASC,UAAU,QAAQ,cAAa;AACxC,SAASC,eAAe,QAAQ,2BAA0B;AAC1D,SAASC,cAAc,QAAQ,sBAAqB;AACpD,SAASC,kBAAkB,QAAQ,0BAAyB;AAC5D,SAASC,YAAY,QAAQ,oBAAmB;AAYhD,OAAO,MAAMC,uBAAuB,OAAO,EACzCC,aAAa,EACbC,QAAQC,aAAa,EACrBC,MAAM,EACNC,uBAAuB,EACvBC,OAAO,EACF;IACL,MAAMC,UAAUR,aAAaO,QAAQE,OAAO;IAC5C,MAAMC,UAAU,MAAMd,WAAW;QAC/BO,QAAQC;QACRO,MAAM;QACNC,KAAKN;IACP;IAEA,MAAM,EAAEH,MAAM,EAAE,GAAGO;IACnB,MAAMG,eAAeV,OAAOU,YAAY;IAExC,MAAMC,gBAAgB,IAAIC,IAAIR,QAAQS,GAAG;IACzC,MAAM,EAAEC,QAAQ,EAAEC,YAAY,EAAE,GAAGJ;IAEnC,MAAMK,YACJ,CAAChB,OAAOiB,OAAO,CAACC,OAAO,IACvBJ,aACEnB,eAAe;QACbwB,UAAUnB,OAAOoB,MAAM,CAACC,GAAG;QAC3BC,MAAMtB,OAAOoB,MAAM,CAACH,OAAO;IAC7B;IAEJ,MAAMM,WAAW3B,mBAAmB;QAClCI;QACAK;QACAC,SAASF,QAAQE,OAAO;IAC1B;IAEA,MAAMkB,OAAO,MAAMnC,SAAS;QAC1BW,QAAQA,OAAOwB,IAAI;QACnBC,SAAS;QACTF;IACF;IAEA,IAAIG,SAASX,aAAaY,GAAG,CAAC;IAE9B,MAAM,EAAEC,QAAQC,YAAY,EAAE,GAAGlB;IAEjC,MAAMmB,QAAQD,eACVvC,GAAGyC,KAAK,CAACF,cAAc;QACrBG,kBAAkB;QAClBC,YAAY;QACZC,OAAO;QACPC,mBAAmB;IACrB,KACA,CAAC;IAEL,MAAMC,sBAAuBN,MAAMO,cAAc,IAC/CtB,aAAaY,GAAG,CAAC,sBACjBZ,aAAaY,GAAG,CAAC;IAEnB,IAAIU,iBAAiBD;IAErB,IAAI1B,cAAc;QAChB,MAAM4B,UAAU5C,gBAAgB;YAC9B2C,gBAAgBA;YAChBX,QAAQA;YACRhB;QACF;QAEA2B,iBAAiBC,QAAQD,cAAc;QACvCX,SAASY,QAAQZ,MAAM;IACzB;IAEA,MAAMa,gBAAgD;QACpDd,SAAS,CAAC;QACVY,gBAAgBA;QAChBG,MAAM7B,cAAc6B,IAAI;QACxBC,MAAM9B,cAAc8B,IAAI;QACxBC,MAAM/B,cAAc+B,IAAI;QACxBlB;QACAE;QACAiB,QAAQhC,cAAcgC,MAAM;QAC5B7B,UAAUH,cAAcG,QAAQ;QAChCP;QACAqC,YAAY5B,YAAY,YAAY;QACpC6B,mBAAmBC;QACnBC,oBAAoB,CAAC;QACrBC,MAAMrC,cAAcqC,IAAI;QACxBC,UAAUtC,cAAcsC,QAAQ;QAChCnB;QACAoB,aAAahD,UAAU,CAAC;QACxB0B,QAAQjB,cAAciB,MAAM;QAC5Bb,cAAcJ,cAAcI,YAAY;QACxCoC,GAAG3B,KAAK2B,CAAC;QACTC,eAAeN;QACfO,MAAM;IACR;IAEA,MAAMC,MAAsBC,OAAOC,MAAM,CAACpD,SAASmC;IAEnDe,IAAIT,iBAAiB,GAAGrD,cAAc8D;IAEtC,MAAM,EAAEG,eAAe,EAAEJ,IAAI,EAAE,GAAG,MAAM9D,sBAAsB;QAC5DQ;QACAO,SAASgD,IAAIhD,OAAO;QACpBU;QACAT;IACF;IAEA+C,IAAID,IAAI,GAAGA;IAEX,IAAII,iBAAiB;QACnBH,IAAIG,eAAe,GAAGA;IACxB;IAEA,OAAOH;AACT,EAAC"}
+{"version":3,"sources":["../../src/utilities/createPayloadRequest.ts"],"sourcesContent":["import type { Payload, RequestContext, TypedLocale, User } from '../index.js'\nimport type { PayloadRequest } from '../types/index.js'\n\nimport { getDataLoader } from '../collections/dataloader.js'\nimport { getLocalI18n } from '../translations/getLocalI18n.js'\nimport { sanitizeFallbackLocale } from '../utilities/sanitizeFallbackLocale.js'\n\nfunction getRequestContext(\n  req: Partial<PayloadRequest> = { context: null } as unknown as PayloadRequest,\n  context: RequestContext = {},\n): RequestContext {\n  if (req.context) {\n    if (Object.keys(req.context).length === 0 && req.context.constructor === Object) {\n      // if req.context is `{}` avoid unnecessary spread\n      return context\n    } else {\n      return { ...req.context, ...context }\n    }\n  } else {\n    return context\n  }\n}\n\nconst attachFakeURLProperties = (req: Partial<PayloadRequest>, urlSuffix?: string) => {\n  /**\n   * *NOTE*\n   * If no URL is provided, the local API was called outside\n   * the context of a request. Therefore we create a fake URL object.\n   * `ts-expect-error` is used below for properties that are 'read-only'.\n   * Since they do not exist yet we can safely ignore the error.\n   */\n  let urlObject: undefined | URL\n\n  function getURLObject() {\n    if (urlObject) {\n      return urlObject\n    }\n\n    const fallbackURL = `http://${req.host || 'localhost'}${urlSuffix || ''}`\n\n    const urlToUse =\n      req?.url ||\n      (req.payload?.config?.serverURL\n        ? `${req.payload?.config.serverURL}${urlSuffix || ''}`\n        : fallbackURL)\n\n    try {\n      urlObject = new URL(urlToUse)\n    } catch (_err) {\n      req.payload?.logger.error(\n        `Failed to create URL object from URL: ${urlToUse}, falling back to ${fallbackURL}`,\n      )\n\n      urlObject = new URL(fallbackURL)\n    }\n\n    return urlObject\n  }\n\n  if (!req.host) {\n    req.host = getURLObject().host\n  }\n\n  if (!req.protocol) {\n    req.protocol = getURLObject().protocol\n  }\n\n  if (!req.pathname) {\n    req.pathname = getURLObject().pathname\n  }\n\n  if (!req.searchParams) {\n    // @ts-expect-error eslint-disable-next-line no-param-reassign\n    req.searchParams = getURLObject().searchParams\n  }\n\n  if (!req.origin) {\n    // @ts-expect-error eslint-disable-next-line no-param-reassign\n    req.origin = getURLObject().origin\n  }\n\n  if (!req?.url) {\n    // @ts-expect-error eslint-disable-next-line no-param-reassign\n    req.url = getURLObject().href\n  }\n}\n\nexport type CreatePayloadRequestArgs = {\n  context?: RequestContext\n  depth?: number\n  fallbackLocale?: false | TypedLocale\n  locale?: string\n  payload: Payload\n  req?: Partial<PayloadRequest>\n  urlSuffix?: string\n  user?: User\n}\n\ntype CreatePayloadRequest = (args: CreatePayloadRequestArgs) => Promise<PayloadRequest>\n\nexport const createPayloadRequest: CreatePayloadRequest = async ({\n  context,\n  depth,\n  fallbackLocale,\n  locale: localeArg,\n  payload,\n  req = {} as PayloadRequest,\n  urlSuffix,\n  user,\n}): Promise<PayloadRequest> => {\n  const localization = payload.config?.localization\n\n  if (localization) {\n    const locale = localeArg === '*' ? 'all' : localeArg\n    const defaultLocale = localization.defaultLocale\n    const localeCandidate = locale || req?.locale || req?.query?.locale\n\n    req.locale =\n      localeCandidate && typeof localeCandidate === 'string' ? localeCandidate : defaultLocale\n\n    const sanitizedFallback = sanitizeFallbackLocale({\n      fallbackLocale: fallbackLocale!,\n      locale: req.locale,\n      localization,\n    })\n\n    req.fallbackLocale = sanitizedFallback!\n  }\n\n  const i18n =\n    req?.i18n ||\n    (await getLocalI18n({ config: payload.config, language: payload.config.i18n.fallbackLanguage }))\n\n  if (!req.headers) {\n    req.headers = new Headers()\n  }\n\n  req.context = getRequestContext(req, context)\n  req.payloadAPI = req?.payloadAPI || 'local'\n  req.payload = payload\n  req.i18n = i18n\n  req.t = i18n.t\n  req.user = user || req?.user || null\n\n  // Ensure user.collection is set for auth-related access control\n  // TODO (4.0): Instead of silently falling back, throw an error if user.collection is missing\n  if (req.user && !req.user.collection) {\n    req.user = { ...req.user, collection: payload.config.admin.user }\n  }\n\n  req.payloadDataLoader = req?.payloadDataLoader || getDataLoader(req as PayloadRequest)\n  req.routeParams = req?.routeParams || {}\n  req.query = req?.query || {}\n\n  if (typeof depth !== 'undefined') {\n    req.query.depth = depth\n  }\n\n  attachFakeURLProperties(req, urlSuffix)\n\n  return req as PayloadRequest\n}\n"],"names":["getDataLoader","getLocalI18n","sanitizeFallbackLocale","getRequestContext","req","context","Object","keys","length","attachFakeURLProperties","urlSuffix","urlObject","getURLObject","fallbackURL","host","urlToUse","url","payload","config","serverURL","URL","_err","logger","error","protocol","pathname","searchParams","origin","href","createPayloadRequest","depth","fallbackLocale","locale","localeArg","user","localization","defaultLocale","localeCandidate","query","sanitizedFallback","i18n","language","fallbackLanguage","headers","Headers","payloadAPI","t","collection","admin","payloadDataLoader","routeParams"],"mappings":"AAGA,SAASA,aAAa,QAAQ,+BAA8B;AAC5D,SAASC,YAAY,QAAQ,kCAAiC;AAC9D,SAASC,sBAAsB,QAAQ,yCAAwC;AAE/E,SAASC,kBACPC,MAA+B;IAAEC,SAAS;AAAK,CAA8B,EAC7EA,UAA0B,CAAC,CAAC;IAE5B,IAAID,IAAIC,OAAO,EAAE;QACf,IAAIC,OAAOC,IAAI,CAACH,IAAIC,OAAO,EAAEG,MAAM,KAAK,KAAKJ,IAAIC,OAAO,CAAC,WAAW,KAAKC,QAAQ;YAC/E,kDAAkD;YAClD,OAAOD;QACT,OAAO;YACL,OAAO;gBAAE,GAAGD,IAAIC,OAAO;gBAAE,GAAGA,OAAO;YAAC;QACtC;IACF,OAAO;QACL,OAAOA;IACT;AACF;AAEA,MAAMI,0BAA0B,CAACL,KAA8BM;IAC7D;;;;;;GAMC,GACD,IAAIC;IAEJ,SAASC;QACP,IAAID,WAAW;YACb,OAAOA;QACT;QAEA,MAAME,cAAc,CAAC,OAAO,EAAET,IAAIU,IAAI,IAAI,cAAcJ,aAAa,IAAI;QAEzE,MAAMK,WACJX,KAAKY,OACJZ,CAAAA,IAAIa,OAAO,EAAEC,QAAQC,YAClB,GAAGf,IAAIa,OAAO,EAAEC,OAAOC,YAAYT,aAAa,IAAI,GACpDG,WAAU;QAEhB,IAAI;YACFF,YAAY,IAAIS,IAAIL;QACtB,EAAE,OAAOM,MAAM;YACbjB,IAAIa,OAAO,EAAEK,OAAOC,MAClB,CAAC,sCAAsC,EAAER,SAAS,kBAAkB,EAAEF,aAAa;YAGrFF,YAAY,IAAIS,IAAIP;QACtB;QAEA,OAAOF;IACT;IAEA,IAAI,CAACP,IAAIU,IAAI,EAAE;QACbV,IAAIU,IAAI,GAAGF,eAAeE,IAAI;IAChC;IAEA,IAAI,CAACV,IAAIoB,QAAQ,EAAE;QACjBpB,IAAIoB,QAAQ,GAAGZ,eAAeY,QAAQ;IACxC;IAEA,IAAI,CAACpB,IAAIqB,QAAQ,EAAE;QACjBrB,IAAIqB,QAAQ,GAAGb,eAAea,QAAQ;IACxC;IAEA,IAAI,CAACrB,IAAIsB,YAAY,EAAE;QACrB,8DAA8D;QAC9DtB,IAAIsB,YAAY,GAAGd,eAAec,YAAY;IAChD;IAEA,IAAI,CAACtB,IAAIuB,MAAM,EAAE;QACf,8DAA8D;QAC9DvB,IAAIuB,MAAM,GAAGf,eAAee,MAAM;IACpC;IAEA,IAAI,CAACvB,KAAKY,KAAK;QACb,8DAA8D;QAC9DZ,IAAIY,GAAG,GAAGJ,eAAegB,IAAI;IAC/B;AACF;AAeA,OAAO,MAAMC,uBAA6C,OAAO,EAC/DxB,OAAO,EACPyB,KAAK,EACLC,cAAc,EACdC,QAAQC,SAAS,EACjBhB,OAAO,EACPb,MAAM,CAAC,CAAmB,EAC1BM,SAAS,EACTwB,IAAI,EACL;IACC,MAAMC,eAAelB,QAAQC,MAAM,EAAEiB;IAErC,IAAIA,cAAc;QAChB,MAAMH,SAASC,cAAc,MAAM,QAAQA;QAC3C,MAAMG,gBAAgBD,aAAaC,aAAa;QAChD,MAAMC,kBAAkBL,UAAU5B,KAAK4B,UAAU5B,KAAKkC,OAAON;QAE7D5B,IAAI4B,MAAM,GACRK,mBAAmB,OAAOA,oBAAoB,WAAWA,kBAAkBD;QAE7E,MAAMG,oBAAoBrC,uBAAuB;YAC/C6B,gBAAgBA;YAChBC,QAAQ5B,IAAI4B,MAAM;YAClBG;QACF;QAEA/B,IAAI2B,cAAc,GAAGQ;IACvB;IAEA,MAAMC,OACJpC,KAAKoC,QACJ,MAAMvC,aAAa;QAAEiB,QAAQD,QAAQC,MAAM;QAAEuB,UAAUxB,QAAQC,MAAM,CAACsB,IAAI,CAACE,gBAAgB;IAAC;IAE/F,IAAI,CAACtC,IAAIuC,OAAO,EAAE;QAChBvC,IAAIuC,OAAO,GAAG,IAAIC;IACpB;IAEAxC,IAAIC,OAAO,GAAGF,kBAAkBC,KAAKC;IACrCD,IAAIyC,UAAU,GAAGzC,KAAKyC,cAAc;IACpCzC,IAAIa,OAAO,GAAGA;IACdb,IAAIoC,IAAI,GAAGA;IACXpC,IAAI0C,CAAC,GAAGN,KAAKM,CAAC;IACd1C,IAAI8B,IAAI,GAAGA,QAAQ9B,KAAK8B,QAAQ;IAEhC,gEAAgE;IAChE,6FAA6F;IAC7F,IAAI9B,IAAI8B,IAAI,IAAI,CAAC9B,IAAI8B,IAAI,CAACa,UAAU,EAAE;QACpC3C,IAAI8B,IAAI,GAAG;YAAE,GAAG9B,IAAI8B,IAAI;YAAEa,YAAY9B,QAAQC,MAAM,CAAC8B,KAAK,CAACd,IAAI;QAAC;IAClE;IAEA9B,IAAI6C,iBAAiB,GAAG7C,KAAK6C,qBAAqBjD,cAAcI;IAChEA,IAAI8C,WAAW,GAAG9C,KAAK8C,eAAe,CAAC;IACvC9C,IAAIkC,KAAK,GAAGlC,KAAKkC,SAAS,CAAC;IAE3B,IAAI,OAAOR,UAAU,aAAa;QAChC1B,IAAIkC,KAAK,CAACR,KAAK,GAAGA;IACpB;IAEArB,wBAAwBL,KAAKM;IAE7B,OAAON;AACT,EAAC"}

package/dist/utilities/createPayloadRequestFromWebRequest.d.ts

@@ -0,0 +1,14 @@
+import type { SanitizedConfig } from '../config/types.js';
+import type { PayloadRequest } from '../types/index.js';
+type Args = {
+    canSetHeaders?: boolean;
+    config: Promise<SanitizedConfig> | SanitizedConfig;
+    params?: {
+        collection: string;
+    };
+    payloadInstanceCacheKey?: string;
+    request: Request;
+};
+export declare const createPayloadRequestFromWebRequest: ({ canSetHeaders, config: configPromise, params, payloadInstanceCacheKey, request, }: Args) => Promise<PayloadRequest>;
+export {};
+//# sourceMappingURL=createPayloadRequestFromWebRequest.d.ts.map