payload 4.0.0-internal.bc5cf8c → 4.0.0-internal.bf4bcce

package/dist/uploads/fileVersioning/cloudStorage.d.ts

@@ -0,0 +1,24 @@
+import type { SanitizedCollectionConfig } from '../../collections/config/types.js';
+import type { JsonObject, PayloadRequest } from '../../types/index.js';
+import type { FileToSave } from '../types.js';
+/** Preserve the caller's cloud flags; nested Local API calls can replace req.context. */
+export declare const captureCloudHookState: ({ req }: {
+    req: PayloadRequest;
+}) => (() => void);
+export declare const runCloudFileCreation: <T>({ collection, data, files, req, write, }: {
+    collection: SanitizedCollectionConfig;
+    data: JsonObject;
+    files: FileToSave[];
+    req: PayloadRequest;
+    write: () => Promise<T>;
+}) => Promise<T>;
+export declare const runCloudFileUpdate: <T>({ id, collection, current, data, files, req, write, }: {
+    collection: SanitizedCollectionConfig;
+    current: JsonObject;
+    data: JsonObject;
+    files: FileToSave[];
+    id: number | string;
+    req: PayloadRequest;
+    write: () => Promise<T>;
+}) => Promise<T>;
+//# sourceMappingURL=cloudStorage.d.ts.map

package/dist/uploads/fileVersioning/cloudStorage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cloudStorage.d.ts","sourceRoot":"","sources":["../../../src/uploads/fileVersioning/cloudStorage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,mCAAmC,CAAA;AAClF,OAAO,KAAK,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AACtE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAgB7C,yFAAyF;AACzF,eAAO,MAAM,qBAAqB,YAAa;IAAE,GAAG,EAAE,cAAc,CAAA;CAAE,KAAG,CAAC,MAAM,IAAI,CAmBnF,CAAA;AAED,eAAO,MAAM,oBAAoB,GAAU,CAAC,4CAMzC;IACD,UAAU,EAAE,yBAAyB,CAAA;IACrC,IAAI,EAAE,UAAU,CAAA;IAChB,KAAK,EAAE,UAAU,EAAE,CAAA;IACnB,GAAG,EAAE,cAAc,CAAA;IACnB,KAAK,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,CAAA;CACxB,KAAG,OAAO,CAAC,CAAC,CAqCZ,CAAA;AAED,eAAO,MAAM,kBAAkB,GAAU,CAAC,yDAQvC;IACD,UAAU,EAAE,yBAAyB,CAAA;IACrC,OAAO,EAAE,UAAU,CAAA;IACnB,IAAI,EAAE,UAAU,CAAA;IAChB,KAAK,EAAE,UAAU,EAAE,CAAA;IACnB,EAAE,EAAE,MAAM,GAAG,MAAM,CAAA;IACnB,GAAG,EAAE,cAAc,CAAA;IACnB,KAAK,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,CAAA;CACxB,KAAG,OAAO,CAAC,CAAC,CAqEZ,CAAA"}

package/dist/uploads/fileVersioning/cloudStorage.js

@@ -0,0 +1,260 @@
+import { saveVersion } from '../../versions/saveVersion.js';
+import { collectStoredFiles as collectSavedFiles, removeUnreferencedStagedObjects, scheduleUnreferencedFileCleanup } from './cleanup.js';
+import { runFileCreationPlan, runFileOperationPlan } from './fileOperationManager.js';
+import { collectStoredFiles, getStoredFileIdentity, withLegacyCloudUploadFileData } from './storedFiles.js';
+/** Preserve the caller's cloud flags; nested Local API calls can replace req.context. */ export const captureCloudHookState = ({ req })=>{
+    const previousState = [
+        '_payloadManagedCloudStorage',
+        '_payloadManagedCloudMetadata'
+    ].map((key)=>({
+            hasProperty: Object.hasOwn(req.context ?? {}, key),
+            key,
+            value: req.context?.[key]
+        }));
+    return ()=>{
+        req.context ??= {};
+        for (const { hasProperty, key, value } of previousState){
+            if (hasProperty) {
+                req.context[key] = value;
+            } else {
+                delete req.context[key];
+            }
+        }
+    };
+};
+export const runCloudFileCreation = async ({ collection, data, files, req, write })=>{
+    const operations = collection.upload.fileOperations;
+    if (!operations || req.context?.skipCloudStorage || files.length === 0 && !req.context?._payloadVerifiedProviderOriginal) {
+        return write();
+    }
+    let metadata = {};
+    return runFileCreationPlan({
+        cleanupStagedAfterWriteFailure: (objects)=>removeUnreferencedStagedObjects({
+                collection,
+                objects,
+                req
+            }),
+        req,
+        stage: async ({ trackStagedObject })=>{
+            trackClientUploadOriginal({
+                collection,
+                data,
+                req,
+                trackStagedObject
+            });
+            const staged = await operations.stage({
+                data,
+                files,
+                req,
+                trackStagedObject
+            });
+            metadata = staged.metadata;
+            Object.assign(data, metadata);
+        },
+        // Create's version and afterChange hooks run after the database insert. The
+        // outer create operation restores the previous guard after those hooks finish.
+        write: ()=>{
+            req.context ??= {};
+            req.context._payloadManagedCloudStorage = true;
+            req.context._payloadManagedCloudMetadata = metadata;
+            return write();
+        }
+    });
+};
+export const runCloudFileUpdate = async ({ id, collection, current, data, files, req, write })=>{
+    const operations = collection.upload.fileOperations;
+    const storedCurrent = operations ? await withLegacyCloudUploadFileData({
+        collection,
+        doc: current,
+        req
+    }) : current;
+    const nextFiles = collectStoredFiles({
+        collection,
+        doc: {
+            ...storedCurrent,
+            ...data
+        },
+        req,
+        trustGenerated: true
+    });
+    const currentFiles = collectStoredFiles({
+        collection,
+        doc: storedCurrent,
+        req
+    });
+    const nextIdentities = new Set(nextFiles.map(getStoredFileIdentity));
+    const hasStoredFileChange = nextIdentities.size !== currentFiles.length || currentFiles.some((file)=>!nextIdentities.has(getStoredFileIdentity(file)));
+    if (!operations || req.context?.skipCloudStorage || files.length === 0 && !req.context?._payloadVerifiedProviderOriginal && !hasStoredFileChange) {
+        return write();
+    }
+    let metadata = {};
+    return runFileOperationPlan({
+        cleanupStagedAfterWriteFailure: (objects)=>removeUnreferencedStagedObjects({
+                collection,
+                objects,
+                req
+            }),
+        req,
+        stage: async ({ trackStagedObject })=>{
+            if (files.length === 0 && !req.context?._payloadVerifiedProviderOriginal) {
+                return;
+            }
+            trackClientUploadOriginal({
+                collection,
+                data,
+                req,
+                trackStagedObject
+            });
+            const staged = await operations.stage({
+                data,
+                files,
+                req,
+                trackStagedObject
+            });
+            metadata = staged.metadata;
+            Object.assign(data, metadata);
+        },
+        write: async ()=>{
+            if (collection.versions && !hasStoredOriginal({
+                doc: current
+            }) && hasStoredOriginal({
+                doc: storedCurrent
+            })) {
+                await persistLegacyCloudVersions({
+                    id,
+                    collection,
+                    current: storedCurrent,
+                    req
+                });
+            }
+            const result = await withCloudHookGuard({
+                metadata,
+                req,
+                write
+            });
+            await scheduleUnreferencedFileCleanup({
+                candidates: await collectSavedFiles({
+                    collection,
+                    doc: storedCurrent,
+                    req
+                }),
+                collection,
+                req
+            });
+            return result;
+        }
+    });
+};
+/** Track a verified client-uploaded source, retaining it if another document still references it. */ const trackClientUploadOriginal = ({ collection, data, req, trackStagedObject })=>{
+    const verifiedOriginal = req.context?._payloadVerifiedProviderOriginal;
+    if (!verifiedOriginal) {
+        return;
+    }
+    const original = collectStoredFiles({
+        collection,
+        doc: data,
+        req,
+        trustGenerated: true
+    }).find(({ key, roles })=>key === verifiedOriginal.key && roles.some((role)=>role.type === 'original'));
+    if (!original) {
+        return;
+    }
+    const object = {
+        key: original.key,
+        remove: ()=>collection.upload.fileOperations.delete({
+                key: original.key,
+                req
+            })
+    };
+    trackStagedObject({
+        key: object.key,
+        remove: ()=>removeUnreferencedStagedObjects({
+                collection,
+                objects: [
+                    object
+                ],
+                req
+            })
+    });
+};
+const persistLegacyCloudVersions = async ({ id, collection, current, req })=>{
+    let page = 1;
+    let hasVersions = false;
+    while(true){
+        const versions = await req.payload.db.findVersions({
+            collection: collection.slug,
+            limit: 100,
+            page,
+            req,
+            where: {
+                parent: {
+                    equals: id
+                }
+            }
+        });
+        for (const row of versions.docs){
+            hasVersions = true;
+            if (hasStoredOriginal({
+                doc: row.version
+            })) {
+                continue;
+            }
+            const version = await withLegacyCloudUploadFileData({
+                collection,
+                doc: row.version,
+                req
+            });
+            if (!hasStoredOriginal({
+                doc: version
+            })) {
+                continue;
+            }
+            await req.payload.db.updateVersion({
+                id: row.id,
+                collection: collection.slug,
+                req,
+                versionData: {
+                    createdAt: row.createdAt,
+                    latest: row.latest,
+                    parent: row.parent,
+                    publishedLocale: row.publishedLocale,
+                    updatedAt: row.updatedAt,
+                    version
+                }
+            });
+        }
+        if (versions.docs.length < 100) {
+            break;
+        }
+        page += 1;
+    }
+    if (!hasVersions && hasStoredOriginal({
+        doc: current
+    })) {
+        await saveVersion({
+            id,
+            collection,
+            docWithLocales: current,
+            draft: false,
+            operation: 'update',
+            payload: req.payload,
+            req
+        });
+    }
+};
+const hasStoredOriginal = ({ doc })=>Boolean(doc.original && typeof doc.original === 'object' && typeof doc.original.filename === 'string');
+const withCloudHookGuard = async ({ metadata, req, write })=>{
+    const restoreCloudHookState = captureCloudHookState({
+        req
+    });
+    req.context ??= {};
+    req.context._payloadManagedCloudStorage = true;
+    req.context._payloadManagedCloudMetadata = metadata;
+    try {
+        return await write();
+    } finally{
+        restoreCloudHookState();
+    }
+};
+
+//# sourceMappingURL=cloudStorage.js.map

package/dist/uploads/fileVersioning/cloudStorage.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/uploads/fileVersioning/cloudStorage.ts"],"sourcesContent":["import type { SanitizedCollectionConfig } from '../../collections/config/types.js'\nimport type { JsonObject, PayloadRequest } from '../../types/index.js'\nimport type { FileToSave } from '../types.js'\nimport type { StagedObject } from './fileOperationManager.js'\n\nimport { saveVersion } from '../../versions/saveVersion.js'\nimport {\n  collectStoredFiles as collectSavedFiles,\n  removeUnreferencedStagedObjects,\n  scheduleUnreferencedFileCleanup,\n} from './cleanup.js'\nimport { runFileCreationPlan, runFileOperationPlan } from './fileOperationManager.js'\nimport {\n  collectStoredFiles,\n  getStoredFileIdentity,\n  withLegacyCloudUploadFileData,\n} from './storedFiles.js'\n\n/** Preserve the caller's cloud flags; nested Local API calls can replace req.context. */\nexport const captureCloudHookState = ({ req }: { req: PayloadRequest }): (() => void) => {\n  const previousState = ['_payloadManagedCloudStorage', '_payloadManagedCloudMetadata'].map(\n    (key) => ({\n      hasProperty: Object.hasOwn(req.context ?? {}, key),\n      key,\n      value: req.context?.[key],\n    }),\n  )\n\n  return () => {\n    req.context ??= {}\n    for (const { hasProperty, key, value } of previousState) {\n      if (hasProperty) {\n        req.context[key] = value\n      } else {\n        delete req.context[key]\n      }\n    }\n  }\n}\n\nexport const runCloudFileCreation = async <T>({\n  collection,\n  data,\n  files,\n  req,\n  write,\n}: {\n  collection: SanitizedCollectionConfig\n  data: JsonObject\n  files: FileToSave[]\n  req: PayloadRequest\n  write: () => Promise<T>\n}): Promise<T> => {\n  const operations = collection.upload.fileOperations\n\n  if (\n    !operations ||\n    req.context?.skipCloudStorage ||\n    (files.length === 0 && !req.context?._payloadVerifiedProviderOriginal)\n  ) {\n    return write()\n  }\n\n  let metadata: Record<string, unknown> = {}\n\n  return runFileCreationPlan({\n    cleanupStagedAfterWriteFailure: (objects) =>\n      removeUnreferencedStagedObjects({ collection, objects, req }),\n    req,\n    stage: async ({ trackStagedObject }) => {\n      trackClientUploadOriginal({ collection, data, req, trackStagedObject })\n      const staged = await operations.stage({\n        data,\n        files,\n        req,\n        trackStagedObject,\n      })\n      metadata = staged.metadata\n      Object.assign(data, metadata)\n    },\n    // Create's version and afterChange hooks run after the database insert. The\n    // outer create operation restores the previous guard after those hooks finish.\n    write: () => {\n      req.context ??= {}\n      req.context._payloadManagedCloudStorage = true\n      req.context._payloadManagedCloudMetadata = metadata\n      return write()\n    },\n  })\n}\n\nexport const runCloudFileUpdate = async <T>({\n  id,\n  collection,\n  current,\n  data,\n  files,\n  req,\n  write,\n}: {\n  collection: SanitizedCollectionConfig\n  current: JsonObject\n  data: JsonObject\n  files: FileToSave[]\n  id: number | string\n  req: PayloadRequest\n  write: () => Promise<T>\n}): Promise<T> => {\n  const operations = collection.upload.fileOperations\n  const storedCurrent = operations\n    ? await withLegacyCloudUploadFileData({ collection, doc: current, req })\n    : current\n  const nextFiles = collectStoredFiles({\n    collection,\n    doc: { ...storedCurrent, ...data },\n    req,\n    trustGenerated: true,\n  })\n  const currentFiles = collectStoredFiles({ collection, doc: storedCurrent, req })\n  const nextIdentities = new Set(nextFiles.map(getStoredFileIdentity))\n  const hasStoredFileChange =\n    nextIdentities.size !== currentFiles.length ||\n    currentFiles.some((file) => !nextIdentities.has(getStoredFileIdentity(file)))\n\n  if (\n    !operations ||\n    req.context?.skipCloudStorage ||\n    (files.length === 0 && !req.context?._payloadVerifiedProviderOriginal && !hasStoredFileChange)\n  ) {\n    return write()\n  }\n\n  let metadata: Record<string, unknown> = {}\n\n  return runFileOperationPlan({\n    cleanupStagedAfterWriteFailure: (objects) =>\n      removeUnreferencedStagedObjects({ collection, objects, req }),\n    req,\n    stage: async ({ trackStagedObject }) => {\n      if (files.length === 0 && !req.context?._payloadVerifiedProviderOriginal) {\n        return\n      }\n      trackClientUploadOriginal({ collection, data, req, trackStagedObject })\n      const staged = await operations.stage({\n        data,\n        files,\n        req,\n        trackStagedObject,\n      })\n      metadata = staged.metadata\n      Object.assign(data, metadata)\n    },\n    write: async () => {\n      if (\n        collection.versions &&\n        !hasStoredOriginal({ doc: current }) &&\n        hasStoredOriginal({ doc: storedCurrent })\n      ) {\n        await persistLegacyCloudVersions({ id, collection, current: storedCurrent, req })\n      }\n\n      const result = await withCloudHookGuard({\n        metadata,\n        req,\n        write,\n      })\n\n      await scheduleUnreferencedFileCleanup({\n        candidates: await collectSavedFiles({ collection, doc: storedCurrent, req }),\n        collection,\n        req,\n      })\n\n      return result\n    },\n  })\n}\n\n/** Track a verified client-uploaded source, retaining it if another document still references it. */\nconst trackClientUploadOriginal = ({\n  collection,\n  data,\n  req,\n  trackStagedObject,\n}: {\n  collection: SanitizedCollectionConfig\n  data: JsonObject\n  req: PayloadRequest\n  trackStagedObject: (object: StagedObject) => void\n}): void => {\n  const verifiedOriginal = req.context?._payloadVerifiedProviderOriginal as\n    | { key: string }\n    | undefined\n\n  if (!verifiedOriginal) {\n    return\n  }\n\n  const original = collectStoredFiles({ collection, doc: data, req, trustGenerated: true }).find(\n    ({ key, roles }) =>\n      key === verifiedOriginal.key && roles.some((role) => role.type === 'original'),\n  )\n\n  if (!original) {\n    return\n  }\n\n  const object: StagedObject = {\n    key: original.key,\n    remove: () => collection.upload.fileOperations!.delete({ key: original.key, req }),\n  }\n\n  trackStagedObject({\n    key: object.key,\n    remove: () => removeUnreferencedStagedObjects({ collection, objects: [object], req }),\n  })\n}\n\nconst persistLegacyCloudVersions = async ({\n  id,\n  collection,\n  current,\n  req,\n}: {\n  collection: SanitizedCollectionConfig\n  current: JsonObject\n  id: number | string\n  req: PayloadRequest\n}): Promise<void> => {\n  let page = 1\n  let hasVersions = false\n\n  while (true) {\n    const versions = await req.payload.db.findVersions<JsonObject>({\n      collection: collection.slug,\n      limit: 100,\n      page,\n      req,\n      where: { parent: { equals: id } },\n    })\n\n    for (const row of versions.docs) {\n      hasVersions = true\n      if (hasStoredOriginal({ doc: row.version })) {\n        continue\n      }\n\n      const version = await withLegacyCloudUploadFileData({\n        collection,\n        doc: row.version,\n        req,\n      })\n      if (!hasStoredOriginal({ doc: version })) {\n        continue\n      }\n\n      await req.payload.db.updateVersion({\n        id: row.id,\n        collection: collection.slug,\n        req,\n        versionData: {\n          createdAt: row.createdAt,\n          latest: row.latest,\n          parent: row.parent,\n          publishedLocale: row.publishedLocale,\n          updatedAt: row.updatedAt,\n          version,\n        },\n      })\n    }\n\n    if (versions.docs.length < 100) {\n      break\n    }\n    page += 1\n  }\n\n  if (!hasVersions && hasStoredOriginal({ doc: current })) {\n    await saveVersion({\n      id,\n      collection,\n      docWithLocales: current,\n      draft: false,\n      operation: 'update',\n      payload: req.payload,\n      req,\n    })\n  }\n}\n\nconst hasStoredOriginal = ({ doc }: { doc: JsonObject }): boolean =>\n  Boolean(\n    doc.original &&\n      typeof doc.original === 'object' &&\n      typeof (doc.original as Record<string, unknown>).filename === 'string',\n  )\n\nconst withCloudHookGuard = async <T>({\n  metadata,\n  req,\n  write,\n}: {\n  metadata: Record<string, unknown>\n  req: PayloadRequest\n  write: () => Promise<T>\n}): Promise<T> => {\n  const restoreCloudHookState = captureCloudHookState({ req })\n  req.context ??= {}\n  req.context._payloadManagedCloudStorage = true\n  req.context._payloadManagedCloudMetadata = metadata\n\n  try {\n    return await write()\n  } finally {\n    restoreCloudHookState()\n  }\n}\n"],"names":["saveVersion","collectStoredFiles","collectSavedFiles","removeUnreferencedStagedObjects","scheduleUnreferencedFileCleanup","runFileCreationPlan","runFileOperationPlan","getStoredFileIdentity","withLegacyCloudUploadFileData","captureCloudHookState","req","previousState","map","key","hasProperty","Object","hasOwn","context","value","runCloudFileCreation","collection","data","files","write","operations","upload","fileOperations","skipCloudStorage","length","_payloadVerifiedProviderOriginal","metadata","cleanupStagedAfterWriteFailure","objects","stage","trackStagedObject","trackClientUploadOriginal","staged","assign","_payloadManagedCloudStorage","_payloadManagedCloudMetadata","runCloudFileUpdate","id","current","storedCurrent","doc","nextFiles","trustGenerated","currentFiles","nextIdentities","Set","hasStoredFileChange","size","some","file","has","versions","hasStoredOriginal","persistLegacyCloudVersions","result","withCloudHookGuard","candidates","verifiedOriginal","original","find","roles","role","type","object","remove","delete","page","hasVersions","payload","db","findVersions","slug","limit","where","parent","equals","row","docs","version","updateVersion","versionData","createdAt","latest","publishedLocale","updatedAt","docWithLocales","draft","operation","Boolean","filename","restoreCloudHookState"],"mappings":"AAKA,SAASA,WAAW,QAAQ,gCAA+B;AAC3D,SACEC,sBAAsBC,iBAAiB,EACvCC,+BAA+B,EAC/BC,+BAA+B,QAC1B,eAAc;AACrB,SAASC,mBAAmB,EAAEC,oBAAoB,QAAQ,4BAA2B;AACrF,SACEL,kBAAkB,EAClBM,qBAAqB,EACrBC,6BAA6B,QACxB,mBAAkB;AAEzB,uFAAuF,GACvF,OAAO,MAAMC,wBAAwB,CAAC,EAAEC,GAAG,EAA2B;IACpE,MAAMC,gBAAgB;QAAC;QAA+B;KAA+B,CAACC,GAAG,CACvF,CAACC,MAAS,CAAA;YACRC,aAAaC,OAAOC,MAAM,CAACN,IAAIO,OAAO,IAAI,CAAC,GAAGJ;YAC9CA;YACAK,OAAOR,IAAIO,OAAO,EAAE,CAACJ,IAAI;QAC3B,CAAA;IAGF,OAAO;QACLH,IAAIO,OAAO,KAAK,CAAC;QACjB,KAAK,MAAM,EAAEH,WAAW,EAAED,GAAG,EAAEK,KAAK,EAAE,IAAIP,cAAe;YACvD,IAAIG,aAAa;gBACfJ,IAAIO,OAAO,CAACJ,IAAI,GAAGK;YACrB,OAAO;gBACL,OAAOR,IAAIO,OAAO,CAACJ,IAAI;YACzB;QACF;IACF;AACF,EAAC;AAED,OAAO,MAAMM,uBAAuB,OAAU,EAC5CC,UAAU,EACVC,IAAI,EACJC,KAAK,EACLZ,GAAG,EACHa,KAAK,EAON;IACC,MAAMC,aAAaJ,WAAWK,MAAM,CAACC,cAAc;IAEnD,IACE,CAACF,cACDd,IAAIO,OAAO,EAAEU,oBACZL,MAAMM,MAAM,KAAK,KAAK,CAAClB,IAAIO,OAAO,EAAEY,kCACrC;QACA,OAAON;IACT;IAEA,IAAIO,WAAoC,CAAC;IAEzC,OAAOzB,oBAAoB;QACzB0B,gCAAgC,CAACC,UAC/B7B,gCAAgC;gBAAEiB;gBAAYY;gBAAStB;YAAI;QAC7DA;QACAuB,OAAO,OAAO,EAAEC,iBAAiB,EAAE;YACjCC,0BAA0B;gBAAEf;gBAAYC;gBAAMX;gBAAKwB;YAAkB;YACrE,MAAME,SAAS,MAAMZ,WAAWS,KAAK,CAAC;gBACpCZ;gBACAC;gBACAZ;gBACAwB;YACF;YACAJ,WAAWM,OAAON,QAAQ;YAC1Bf,OAAOsB,MAAM,CAAChB,MAAMS;QACtB;QACA,4EAA4E;QAC5E,+EAA+E;QAC/EP,OAAO;YACLb,IAAIO,OAAO,KAAK,CAAC;YACjBP,IAAIO,OAAO,CAACqB,2BAA2B,GAAG;YAC1C5B,IAAIO,OAAO,CAACsB,4BAA4B,GAAGT;YAC3C,OAAOP;QACT;IACF;AACF,EAAC;AAED,OAAO,MAAMiB,qBAAqB,OAAU,EAC1CC,EAAE,EACFrB,UAAU,EACVsB,OAAO,EACPrB,IAAI,EACJC,KAAK,EACLZ,GAAG,EACHa,KAAK,EASN;IACC,MAAMC,aAAaJ,WAAWK,MAAM,CAACC,cAAc;IACnD,MAAMiB,gBAAgBnB,aAClB,MAAMhB,8BAA8B;QAAEY;QAAYwB,KAAKF;QAAShC;IAAI,KACpEgC;IACJ,MAAMG,YAAY5C,mBAAmB;QACnCmB;QACAwB,KAAK;YAAE,GAAGD,aAAa;YAAE,GAAGtB,IAAI;QAAC;QACjCX;QACAoC,gBAAgB;IAClB;IACA,MAAMC,eAAe9C,mBAAmB;QAAEmB;QAAYwB,KAAKD;QAAejC;IAAI;IAC9E,MAAMsC,iBAAiB,IAAIC,IAAIJ,UAAUjC,GAAG,CAACL;IAC7C,MAAM2C,sBACJF,eAAeG,IAAI,KAAKJ,aAAanB,MAAM,IAC3CmB,aAAaK,IAAI,CAAC,CAACC,OAAS,CAACL,eAAeM,GAAG,CAAC/C,sBAAsB8C;IAExE,IACE,CAAC7B,cACDd,IAAIO,OAAO,EAAEU,oBACZL,MAAMM,MAAM,KAAK,KAAK,CAAClB,IAAIO,OAAO,EAAEY,oCAAoC,CAACqB,qBAC1E;QACA,OAAO3B;IACT;IAEA,IAAIO,WAAoC,CAAC;IAEzC,OAAOxB,qBAAqB;QAC1ByB,gCAAgC,CAACC,UAC/B7B,gCAAgC;gBAAEiB;gBAAYY;gBAAStB;YAAI;QAC7DA;QACAuB,OAAO,OAAO,EAAEC,iBAAiB,EAAE;YACjC,IAAIZ,MAAMM,MAAM,KAAK,KAAK,CAAClB,IAAIO,OAAO,EAAEY,kCAAkC;gBACxE;YACF;YACAM,0BAA0B;gBAAEf;gBAAYC;gBAAMX;gBAAKwB;YAAkB;YACrE,MAAME,SAAS,MAAMZ,WAAWS,KAAK,CAAC;gBACpCZ;gBACAC;gBACAZ;gBACAwB;YACF;YACAJ,WAAWM,OAAON,QAAQ;YAC1Bf,OAAOsB,MAAM,CAAChB,MAAMS;QACtB;QACAP,OAAO;YACL,IACEH,WAAWmC,QAAQ,IACnB,CAACC,kBAAkB;gBAAEZ,KAAKF;YAAQ,MAClCc,kBAAkB;gBAAEZ,KAAKD;YAAc,IACvC;gBACA,MAAMc,2BAA2B;oBAAEhB;oBAAIrB;oBAAYsB,SAASC;oBAAejC;gBAAI;YACjF;YAEA,MAAMgD,SAAS,MAAMC,mBAAmB;gBACtC7B;gBACApB;gBACAa;YACF;YAEA,MAAMnB,gCAAgC;gBACpCwD,YAAY,MAAM1D,kBAAkB;oBAAEkB;oBAAYwB,KAAKD;oBAAejC;gBAAI;gBAC1EU;gBACAV;YACF;YAEA,OAAOgD;QACT;IACF;AACF,EAAC;AAED,mGAAmG,GACnG,MAAMvB,4BAA4B,CAAC,EACjCf,UAAU,EACVC,IAAI,EACJX,GAAG,EACHwB,iBAAiB,EAMlB;IACC,MAAM2B,mBAAmBnD,IAAIO,OAAO,EAAEY;IAItC,IAAI,CAACgC,kBAAkB;QACrB;IACF;IAEA,MAAMC,WAAW7D,mBAAmB;QAAEmB;QAAYwB,KAAKvB;QAAMX;QAAKoC,gBAAgB;IAAK,GAAGiB,IAAI,CAC5F,CAAC,EAAElD,GAAG,EAAEmD,KAAK,EAAE,GACbnD,QAAQgD,iBAAiBhD,GAAG,IAAImD,MAAMZ,IAAI,CAAC,CAACa,OAASA,KAAKC,IAAI,KAAK;IAGvE,IAAI,CAACJ,UAAU;QACb;IACF;IAEA,MAAMK,SAAuB;QAC3BtD,KAAKiD,SAASjD,GAAG;QACjBuD,QAAQ,IAAMhD,WAAWK,MAAM,CAACC,cAAc,CAAE2C,MAAM,CAAC;gBAAExD,KAAKiD,SAASjD,GAAG;gBAAEH;YAAI;IAClF;IAEAwB,kBAAkB;QAChBrB,KAAKsD,OAAOtD,GAAG;QACfuD,QAAQ,IAAMjE,gCAAgC;gBAAEiB;gBAAYY,SAAS;oBAACmC;iBAAO;gBAAEzD;YAAI;IACrF;AACF;AAEA,MAAM+C,6BAA6B,OAAO,EACxChB,EAAE,EACFrB,UAAU,EACVsB,OAAO,EACPhC,GAAG,EAMJ;IACC,IAAI4D,OAAO;IACX,IAAIC,cAAc;IAElB,MAAO,KAAM;QACX,MAAMhB,WAAW,MAAM7C,IAAI8D,OAAO,CAACC,EAAE,CAACC,YAAY,CAAa;YAC7DtD,YAAYA,WAAWuD,IAAI;YAC3BC,OAAO;YACPN;YACA5D;YACAmE,OAAO;gBAAEC,QAAQ;oBAAEC,QAAQtC;gBAAG;YAAE;QAClC;QAEA,KAAK,MAAMuC,OAAOzB,SAAS0B,IAAI,CAAE;YAC/BV,cAAc;YACd,IAAIf,kBAAkB;gBAAEZ,KAAKoC,IAAIE,OAAO;YAAC,IAAI;gBAC3C;YACF;YAEA,MAAMA,UAAU,MAAM1E,8BAA8B;gBAClDY;gBACAwB,KAAKoC,IAAIE,OAAO;gBAChBxE;YACF;YACA,IAAI,CAAC8C,kBAAkB;gBAAEZ,KAAKsC;YAAQ,IAAI;gBACxC;YACF;YAEA,MAAMxE,IAAI8D,OAAO,CAACC,EAAE,CAACU,aAAa,CAAC;gBACjC1C,IAAIuC,IAAIvC,EAAE;gBACVrB,YAAYA,WAAWuD,IAAI;gBAC3BjE;gBACA0E,aAAa;oBACXC,WAAWL,IAAIK,SAAS;oBACxBC,QAAQN,IAAIM,MAAM;oBAClBR,QAAQE,IAAIF,MAAM;oBAClBS,iBAAiBP,IAAIO,eAAe;oBACpCC,WAAWR,IAAIQ,SAAS;oBACxBN;gBACF;YACF;QACF;QAEA,IAAI3B,SAAS0B,IAAI,CAACrD,MAAM,GAAG,KAAK;YAC9B;QACF;QACA0C,QAAQ;IACV;IAEA,IAAI,CAACC,eAAef,kBAAkB;QAAEZ,KAAKF;IAAQ,IAAI;QACvD,MAAM1C,YAAY;YAChByC;YACArB;YACAqE,gBAAgB/C;YAChBgD,OAAO;YACPC,WAAW;YACXnB,SAAS9D,IAAI8D,OAAO;YACpB9D;QACF;IACF;AACF;AAEA,MAAM8C,oBAAoB,CAAC,EAAEZ,GAAG,EAAuB,GACrDgD,QACEhD,IAAIkB,QAAQ,IACV,OAAOlB,IAAIkB,QAAQ,KAAK,YACxB,OAAO,AAAClB,IAAIkB,QAAQ,CAA6B+B,QAAQ,KAAK;AAGpE,MAAMlC,qBAAqB,OAAU,EACnC7B,QAAQ,EACRpB,GAAG,EACHa,KAAK,EAKN;IACC,MAAMuE,wBAAwBrF,sBAAsB;QAAEC;IAAI;IAC1DA,IAAIO,OAAO,KAAK,CAAC;IACjBP,IAAIO,OAAO,CAACqB,2BAA2B,GAAG;IAC1C5B,IAAIO,OAAO,CAACsB,4BAA4B,GAAGT;IAE3C,IAAI;QACF,OAAO,MAAMP;IACf,SAAU;QACRuE;IACF;AACF"}

package/dist/uploads/fileVersioning/fileOperationManager.d.ts

@@ -0,0 +1,65 @@
+import type { PayloadRequest } from '../../types/index.js';
+import type { FileToSave } from '../types.js';
+export type StagedObject = {
+    key: string;
+    remove: () => Promise<void>;
+};
+type RunFileOperationPlanArgs<T> = {
+    cleanupStagedAfterWriteFailure?: (objects: StagedObject[]) => Promise<void>;
+    req: PayloadRequest;
+    stage: (args: {
+        trackStagedObject: (object: StagedObject) => void;
+    }) => Promise<void>;
+    write: (args: {
+        trackStagedObject: (object: StagedObject) => void;
+    }) => Promise<T>;
+};
+/** Same-transaction request proxies must finish their files with the owning request. */
+export declare const shareFileOperationScope: ({ owner, req, }: {
+    owner: PayloadRequest;
+    req: PayloadRequest;
+}) => void;
+/** Keeps no-transaction cleanup pending until an outer upload operation finishes. */
+export declare const beginFileOperationScope: ({ req }: {
+    req: PayloadRequest;
+}) => void;
+export declare const completeFileOperationScope: ({ req, }: {
+    req: PayloadRequest;
+}) => Promise<void>;
+export declare const abortFileOperationScope: ({ req }: {
+    req: PayloadRequest;
+}) => Promise<void>;
+/** Runs cleanup after the outer operation and its database transaction succeed. */
+export declare const deferFileCleanup: ({ cleanup, req, shouldCleanupAfterFailure, }: {
+    cleanup: () => Promise<void>;
+    req: PayloadRequest;
+    /** Enable only for cleanup that rechecks persisted references before deleting. */
+    shouldCleanupAfterFailure?: boolean;
+}) => Promise<void>;
+/** Stages owned objects before writing document or version data. */
+export declare const runFileOperationPlan: <T>({ cleanupStagedAfterWriteFailure, req, stage, write, }: RunFileOperationPlanArgs<T>) => Promise<T>;
+/** Creates use the same rollback and outer-scope compensation without an existing document. */
+export declare const runFileCreationPlan: <T>({ cleanupStagedAfterWriteFailure, req, stage, write, }: {
+    cleanupStagedAfterWriteFailure?: (objects: StagedObject[]) => Promise<void>;
+    req: PayloadRequest;
+    stage: (args: {
+        trackStagedObject: (object: StagedObject) => void;
+    }) => Promise<void>;
+    write: () => Promise<T>;
+}) => Promise<T>;
+/** Writes each planned local object exclusively and registers only completed writes for rollback. */
+export declare const stageLocalUploadFiles: ({ files, staticDir, trackStagedObject, }: {
+    files: FileToSave[];
+    staticDir: string;
+    trackStagedObject: (object: StagedObject) => void;
+}) => Promise<void>;
+/** Called only after the owning database transaction commits. */
+export declare const commitFileOperations: ({ req }: {
+    req: PayloadRequest;
+}) => Promise<void>;
+/** Called only after the owning database transaction rolls back. */
+export declare const rollbackFileOperations: ({ req }: {
+    req: PayloadRequest;
+}) => Promise<void>;
+export {};
+//# sourceMappingURL=fileOperationManager.d.ts.map

package/dist/uploads/fileVersioning/fileOperationManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fileOperationManager.d.ts","sourceRoot":"","sources":["../../../src/uploads/fileVersioning/fileOperationManager.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAC1D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAI7C,MAAM,MAAM,YAAY,GAAG;IACzB,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;CAC5B,CAAA;AAeD,KAAK,wBAAwB,CAAC,CAAC,IAAI;IACjC,8BAA8B,CAAC,EAAE,CAAC,OAAO,EAAE,YAAY,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IAC3E,GAAG,EAAE,cAAc,CAAA;IACnB,KAAK,EAAE,CAAC,IAAI,EAAE;QAAE,iBAAiB,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,IAAI,CAAA;KAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IACrF,KAAK,EAAE,CAAC,IAAI,EAAE;QAAE,iBAAiB,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,IAAI,CAAA;KAAE,KAAK,OAAO,CAAC,CAAC,CAAC,CAAA;CACnF,CAAA;AAKD,wFAAwF;AACxF,eAAO,MAAM,uBAAuB,oBAGjC;IACD,KAAK,EAAE,cAAc,CAAA;IACrB,GAAG,EAAE,cAAc,CAAA;CACpB,KAAG,IAEH,CAAA;AAED,qFAAqF;AACrF,eAAO,MAAM,uBAAuB,YAAa;IAAE,GAAG,EAAE,cAAc,CAAA;CAAE,KAAG,IAE1E,CAAA;AAED,eAAO,MAAM,0BAA0B,aAEpC;IACD,GAAG,EAAE,cAAc,CAAA;CACpB,KAAG,OAAO,CAAC,IAAI,CAWf,CAAA;AAED,eAAO,MAAM,uBAAuB,YAAmB;IAAE,GAAG,EAAE,cAAc,CAAA;CAAE,KAAG,OAAO,CAAC,IAAI,CAY5F,CAAA;AAED,mFAAmF;AACnF,eAAO,MAAM,gBAAgB,iDAI1B;IACD,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;IAC5B,GAAG,EAAE,cAAc,CAAA;IACnB,kFAAkF;IAClF,yBAAyB,CAAC,EAAE,OAAO,CAAA;CACpC,KAAG,OAAO,CAAC,IAAI,CAMf,CAAA;AAED,oEAAoE;AACpE,eAAO,MAAM,oBAAoB,GAAU,CAAC,0DAKzC,wBAAwB,CAAC,CAAC,CAAC,KAAG,OAAO,CAAC,CAAC,CAgCzC,CAAA;AAED,+FAA+F;AAC/F,eAAO,MAAM,mBAAmB,GAAU,CAAC,0DAKxC;IACD,8BAA8B,CAAC,EAAE,CAAC,OAAO,EAAE,YAAY,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IAC3E,GAAG,EAAE,cAAc,CAAA;IACnB,KAAK,EAAE,CAAC,IAAI,EAAE;QAAE,iBAAiB,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,IAAI,CAAA;KAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IACrF,KAAK,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,CAAA;CACxB,KAAG,OAAO,CAAC,CAAC,CA8BZ,CAAA;AAED,qGAAqG;AACrG,eAAO,MAAM,qBAAqB,6CAI/B;IACD,KAAK,EAAE,UAAU,EAAE,CAAA;IACnB,SAAS,EAAE,MAAM,CAAA;IACjB,iBAAiB,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,IAAI,CAAA;CAClD,KAAG,OAAO,CAAC,IAAI,CA8Bf,CAAA;AAED,iEAAiE;AACjE,eAAO,MAAM,oBAAoB,YAAmB;IAAE,GAAG,EAAE,cAAc,CAAA;CAAE,KAAG,OAAO,CAAC,IAAI,CAYzF,CAAA;AAED,oEAAoE;AACpE,eAAO,MAAM,sBAAsB,YAAmB;IAAE,GAAG,EAAE,cAAc,CAAA;CAAE,KAAG,OAAO,CAAC,IAAI,CAW3F,CAAA"}