@trieb.work/payload-plugin-backup-mongodb 0.1.1

package/dist/core/db.d.ts

@@ -0,0 +1,24 @@
+import type { Payload } from 'payload';
+export type MongoDb = {
+    collection: (name: string) => {
+        bulkWrite: (operations: unknown[]) => Promise<{
+            modifiedCount: number;
+            upsertedCount: number;
+        }>;
+        countDocuments: (query?: object) => Promise<number>;
+        deleteMany: (query: object) => Promise<unknown>;
+        find: (query: object) => {
+            toArray: () => Promise<unknown[]>;
+        };
+        indexes: () => Promise<{
+            key: Record<string, unknown>;
+            unique?: boolean;
+        }[]>;
+    };
+    listCollections: () => {
+        toArray: () => Promise<{
+            name: string;
+        }[]>;
+    };
+};
+export declare function getDb(payload: Payload): MongoDb;

package/dist/core/db.js

@@ -0,0 +1,12 @@
+export function getDb(payload) {
+    if (payload.db.name !== 'mongoose') {
+        throw new Error('Backup failed: Not a mongoose database adapter');
+    }
+    const db = payload.db.connection?.db;
+    if (!db) {
+        throw new Error('Backup failed: Database not initialized');
+    }
+    return db;
+}
+
+//# sourceMappingURL=db.js.map

package/dist/core/db.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/core/db.ts"],"sourcesContent":["import type { Payload } from 'payload'\n\ntype MongoosePayloadDb = {\n  connection?: { db?: MongoDb }\n}\n\nexport type MongoDb = {\n  collection: (name: string) => {\n    bulkWrite: (operations: unknown[]) => Promise<{ modifiedCount: number; upsertedCount: number }>\n    countDocuments: (query?: object) => Promise<number>\n    deleteMany: (query: object) => Promise<unknown>\n    find: (query: object) => { toArray: () => Promise<unknown[]> }\n    indexes: () => Promise<{ key: Record<string, unknown>; unique?: boolean }[]>\n  }\n  listCollections: () => { toArray: () => Promise<{ name: string }[]> }\n}\n\nexport function getDb(payload: Payload): MongoDb {\n  if (payload.db.name !== 'mongoose') {\n    throw new Error('Backup failed: Not a mongoose database adapter')\n  }\n  const db = (payload.db as MongoosePayloadDb).connection?.db\n  if (!db) {\n    throw new Error('Backup failed: Database not initialized')\n  }\n  return db\n}\n"],"names":["getDb","payload","db","name","Error","connection"],"mappings":"AAiBA,OAAO,SAASA,MAAMC,OAAgB;IACpC,IAAIA,QAAQC,EAAE,CAACC,IAAI,KAAK,YAAY;QAClC,MAAM,IAAIC,MAAM;IAClB;IACA,MAAMF,KAAK,AAACD,QAAQC,EAAE,CAAuBG,UAAU,EAAEH;IACzD,IAAI,CAACA,IAAI;QACP,MAAM,IAAIE,MAAM;IAClB;IACA,OAAOF;AACT"}

package/dist/core/restore.d.ts

@@ -0,0 +1,27 @@
+import type { Payload } from 'payload';
+import { type BackupBlobAccessLevel } from './backupBlobIO';
+export interface RestoreBackupOptions {
+    /**
+     * When set, the archive is loaded with the backup token (fetch + SDK fallback; works for
+     * public and private blobs). Otherwise `downloadUrl` is fetched anonymously.
+     */
+    backupRead?: {
+        pathname: string;
+        token: string;
+    };
+    /**
+     * Preferred Vercel Blob access for re-uploaded media files. When the store rejects the
+     * preferred level (e.g. a private-only store rejects `public`), the other level is tried
+     * automatically. Defaults to `public`.
+     */
+    blobAccess?: BackupBlobAccessLevel;
+    /** Optional explicit Vercel Blob token used for archive media blob uploads. */
+    blobToken?: string;
+    /**
+     * When false, skip uploading media blobs from a tar.gz archive (Mongo `media` and other
+     * collections still restore). Default true.
+     */
+    restoreArchiveMedia?: boolean;
+}
+export declare function restoreBackup(payload: Payload, downloadUrl: string, collectionBlacklist?: string[], mergeData?: boolean, taskId?: string, options?: RestoreBackupOptions): Promise<void>;
+export declare function restoreSeedMedia(payload: Payload, taskId?: string): Promise<string[]>;

package/dist/core/restore.js

@@ -0,0 +1,199 @@
+import { EJSON } from 'bson';
+import fs from 'node:fs/promises';
+import path from 'node:path';
+import { resolveTarGzip } from './archive';
+import { COLLECTION_FILE_NAME } from './backup';
+import { putBackupBlobContent, readBackupBlobContentFlexible } from './backupBlobIO';
+import { getDb } from './db';
+import { updateBackupTask } from './taskProgress';
+export async function restoreBackup(payload, downloadUrl, collectionBlacklist = [], mergeData = false, taskId, options) {
+    const restoreArchiveMedia = options?.restoreArchiveMedia !== false;
+    const blobToken = options?.blobToken;
+    const blobAccess = options?.blobAccess ?? 'public';
+    const backupRead = options?.backupRead;
+    const t0 = Date.now();
+    const urlBase = downloadUrl.split('?')?.[0];
+    // Progress is stored in `backup-tasks`. Restoring that collection from the file
+    // would delete/replace the active task doc and break GET .../admin/task/:id polling.
+    const effectiveBlacklist = taskId ? Array.from(new Set([
+        'backup-tasks',
+        ...collectionBlacklist
+    ])) : [
+        ...collectionBlacklist
+    ];
+    payload.logger.info({
+        blacklist: effectiveBlacklist,
+        mergeData,
+        url: urlBase
+    }, '[restore] Starting restore');
+    if (taskId) {
+        await updateBackupTask(payload, taskId, {
+            message: 'Starting restore',
+            status: 'running'
+        });
+    }
+    const db = getDb(payload);
+    const archiveBytes = backupRead ? await readBackupBlobContentFlexible(backupRead.pathname, downloadUrl, backupRead.token) : await (async ()=>{
+        const res = await fetch(downloadUrl);
+        if (!res.ok) {
+            throw new Error(`Failed to download backup (${res.status})`);
+        }
+        return Buffer.from(await res.arrayBuffer());
+    })();
+    let collections = {};
+    if (urlBase?.endsWith('.json')) {
+        payload.logger.info('[restore] Parsing JSON backup');
+        if (taskId) {
+            await updateBackupTask(payload, taskId, {
+                message: 'Parsing JSON backup'
+            });
+        }
+        collections = EJSON.parse(archiveBytes.toString('utf8'));
+    } else if (urlBase?.endsWith('.gz')) {
+        payload.logger.info('[restore] Extracting tar.gz backup');
+        if (taskId) {
+            await updateBackupTask(payload, taskId, {
+                message: 'Extracting tar.gz backup'
+            });
+        }
+        const files = await resolveTarGzip(archiveBytes);
+        collections = EJSON.parse(files.find((file)=>file.name === COLLECTION_FILE_NAME)?.content?.toString() || '{}');
+        const medias = restoreArchiveMedia ? files.filter((file)=>file.name !== COLLECTION_FILE_NAME) : [];
+        if (!restoreArchiveMedia) {
+            payload.logger.info('[restore] Skipping archive media blob upload (restoreArchiveMedia=false)');
+        }
+        payload.logger.info({
+            count: medias.length
+        }, '[restore] Restoring media files to blob storage');
+        if (taskId) {
+            await updateBackupTask(payload, taskId, {
+                message: restoreArchiveMedia ? `Restoring ${medias.length} media file${medias.length === 1 ? '' : 's'}` : 'Skipped media files from archive'
+            });
+        }
+        const mediaResults = await Promise.all(medias.map((media)=>putBackupBlobContent(media.name, media.content, blobToken, blobAccess).then((effectiveAccess)=>({
+                    name: media.name,
+                    effectiveAccess
+                }))));
+        const mismatched = mediaResults.filter((r)=>r.effectiveAccess !== blobAccess);
+        if (mismatched.length > 0) {
+            payload.logger.warn({
+                count: mismatched.length,
+                preferredAccess: blobAccess
+            }, '[restore] Blob store rejected preferred access level for media; uploaded with fallback');
+        }
+        mediaResults.forEach((result)=>{
+            payload.logger.debug({
+                name: result.name,
+                access: result.effectiveAccess
+            }, '[restore] Media file uploaded');
+        });
+    } else {
+        throw new Error(`File type of backup ${downloadUrl} not supported`);
+    }
+    const collectionNames = Object.keys(collections);
+    payload.logger.info({
+        blacklisted: effectiveBlacklist.length,
+        total: collectionNames.length
+    }, '[restore] Restoring collections');
+    if (taskId) {
+        await updateBackupTask(payload, taskId, {
+            message: `Restoring ${collectionNames.length} collection${collectionNames.length === 1 ? '' : 's'}`
+        });
+    }
+    for (const collectionName of collectionNames){
+        if (effectiveBlacklist.includes(collectionName)) {
+            payload.logger.debug({
+                collection: collectionName
+            }, '[restore] Skipping blacklisted collection');
+            continue;
+        }
+        const collectionData = collections[collectionName];
+        if (collectionData.length > 0) {
+            payload.logger.info({
+                collection: collectionName,
+                docs: collectionData.length,
+                mergeData
+            }, '[restore] Restoring collection');
+            const collection = db.collection(collectionName);
+            const indexes = await collection.indexes();
+            const uniqueIndexes = indexes.filter((idx)=>idx.unique).flatMap((idx)=>Object.keys(idx.key));
+            if (!mergeData) {
+                await collection.deleteMany({});
+            }
+            if (taskId) {
+                await updateBackupTask(payload, taskId, {
+                    message: `Restoring collection ${collectionName} (${collectionData.length} docs)`
+                });
+            }
+            const res = await collection.bulkWrite(collectionData.map((doc)=>({
+                    updateOne: {
+                        filter: uniqueIndexes.length > 0 ? {
+                            $or: [
+                                {
+                                    _id: doc._id
+                                },
+                                ...uniqueIndexes.map((field)=>({
+                                        [field]: doc[field]
+                                    }))
+                            ]
+                        } : {
+                            _id: doc._id
+                        },
+                        update: {
+                            $set: doc
+                        },
+                        upsert: true
+                    }
+                })));
+            payload.logger.debug({
+                collection: collectionName,
+                modified: res.modifiedCount,
+                upserted: res.upsertedCount
+            }, '[restore] Collection restored');
+        }
+    }
+    payload.logger.info({
+        durationMs: Date.now() - t0
+    }, '[restore] Restore complete');
+}
+export async function restoreSeedMedia(payload, taskId) {
+    const files = await fs.readdir(path.join(process.cwd(), 'public/seed/media'));
+    if (taskId) {
+        await updateBackupTask(payload, taskId, {
+            message: `Restoring ${files.length} seed media file${files.length === 1 ? '' : 's'}`,
+            status: 'running'
+        });
+    }
+    for (const file of files){
+        const data = await fs.readFile(path.join(process.cwd(), 'public/seed/media', file));
+        if (process.env.BLOB_READ_WRITE_TOKEN) {
+            const effectiveAccess = await putBackupBlobContent(file, data, process.env.BLOB_READ_WRITE_TOKEN, 'public');
+            payload.logger.info({
+                access: effectiveAccess,
+                file
+            }, '[restore] Restored seed media to Vercel Blob storage');
+        } else {
+            const folderPath = path.join(process.cwd(), 'public/media');
+            const publicPath = path.join(folderPath, file);
+            await fs.mkdir(folderPath, {
+                recursive: true
+            });
+            await fs.writeFile(publicPath, data);
+            payload.logger.info({
+                file,
+                publicPath
+            }, '[restore] Restored seed media to public directory');
+        }
+        if (taskId) {
+            await updateBackupTask(payload, taskId, {
+                message: `Restored seed media file ${file}`
+            });
+        }
+    }
+    payload.logger.info({
+        count: files.length
+    }, '[restore] Restored all seed media files');
+    return files;
+}
+
+//# sourceMappingURL=restore.js.map

package/dist/core/restore.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/core/restore.ts"],"sourcesContent":["import type { Payload } from 'payload'\n\nimport { EJSON } from 'bson'\nimport fs from 'node:fs/promises'\nimport path from 'node:path'\n\nimport { resolveTarGzip } from './archive'\nimport { COLLECTION_FILE_NAME } from './backup'\nimport {\n  type BackupBlobAccessLevel,\n  putBackupBlobContent,\n  readBackupBlobContentFlexible,\n} from './backupBlobIO'\nimport { getDb } from './db'\nimport { updateBackupTask } from './taskProgress'\n\nexport interface RestoreBackupOptions {\n  /**\n   * When set, the archive is loaded with the backup token (fetch + SDK fallback; works for\n   * public and private blobs). Otherwise `downloadUrl` is fetched anonymously.\n   */\n  backupRead?: { pathname: string; token: string }\n  /**\n   * Preferred Vercel Blob access for re-uploaded media files. When the store rejects the\n   * preferred level (e.g. a private-only store rejects `public`), the other level is tried\n   * automatically. Defaults to `public`.\n   */\n  blobAccess?: BackupBlobAccessLevel\n  /** Optional explicit Vercel Blob token used for archive media blob uploads. */\n  blobToken?: string\n  /**\n   * When false, skip uploading media blobs from a tar.gz archive (Mongo `media` and other\n   * collections still restore). Default true.\n   */\n  restoreArchiveMedia?: boolean\n}\n\nexport async function restoreBackup(\n  payload: Payload,\n  downloadUrl: string,\n  collectionBlacklist: string[] = [],\n  mergeData = false,\n  taskId?: string,\n  options?: RestoreBackupOptions,\n): Promise<void> {\n  const restoreArchiveMedia = options?.restoreArchiveMedia !== false\n  const blobToken = options?.blobToken\n  const blobAccess: BackupBlobAccessLevel = options?.blobAccess ?? 'public'\n  const backupRead = options?.backupRead\n  const t0 = Date.now()\n  const urlBase = downloadUrl.split('?')?.[0]\n\n  // Progress is stored in `backup-tasks`. Restoring that collection from the file\n  // would delete/replace the active task doc and break GET .../admin/task/:id polling.\n  const effectiveBlacklist = taskId\n    ? Array.from(new Set(['backup-tasks', ...collectionBlacklist]))\n    : [...collectionBlacklist]\n\n  payload.logger.info(\n    { blacklist: effectiveBlacklist, mergeData, url: urlBase },\n    '[restore] Starting restore',\n  )\n  if (taskId) {\n    await updateBackupTask(payload, taskId, {\n      message: 'Starting restore',\n      status: 'running',\n    })\n  }\n\n  const db = getDb(payload)\n  const archiveBytes = backupRead\n    ? await readBackupBlobContentFlexible(backupRead.pathname, downloadUrl, backupRead.token)\n    : await (async () => {\n        const res = await fetch(downloadUrl)\n        if (!res.ok) {\n          throw new Error(`Failed to download backup (${res.status})`)\n        }\n        return Buffer.from(await res.arrayBuffer())\n      })()\n  let collections: Record<string, Record<string, unknown>[]> = {}\n\n  if (urlBase?.endsWith('.json')) {\n    payload.logger.info('[restore] Parsing JSON backup')\n    if (taskId) {\n      await updateBackupTask(payload, taskId, {\n        message: 'Parsing JSON backup',\n      })\n    }\n    collections = EJSON.parse(archiveBytes.toString('utf8'))\n  } else if (urlBase?.endsWith('.gz')) {\n    payload.logger.info('[restore] Extracting tar.gz backup')\n    if (taskId) {\n      await updateBackupTask(payload, taskId, {\n        message: 'Extracting tar.gz backup',\n      })\n    }\n    const files = await resolveTarGzip(archiveBytes)\n    collections = EJSON.parse(\n      files.find((file) => file.name === COLLECTION_FILE_NAME)?.content?.toString() || '{}',\n    )\n    const medias = restoreArchiveMedia\n      ? files.filter((file) => file.name !== COLLECTION_FILE_NAME)\n      : []\n    if (!restoreArchiveMedia) {\n      payload.logger.info(\n        '[restore] Skipping archive media blob upload (restoreArchiveMedia=false)',\n      )\n    }\n    payload.logger.info({ count: medias.length }, '[restore] Restoring media files to blob storage')\n    if (taskId) {\n      await updateBackupTask(payload, taskId, {\n        message: restoreArchiveMedia\n          ? `Restoring ${medias.length} media file${medias.length === 1 ? '' : 's'}`\n          : 'Skipped media files from archive',\n      })\n    }\n    const mediaResults = await Promise.all(\n      medias.map((media) =>\n        putBackupBlobContent(media.name, media.content, blobToken, blobAccess).then(\n          (effectiveAccess) => ({ name: media.name, effectiveAccess }),\n        ),\n      ),\n    )\n    const mismatched = mediaResults.filter((r) => r.effectiveAccess !== blobAccess)\n    if (mismatched.length > 0) {\n      payload.logger.warn(\n        { count: mismatched.length, preferredAccess: blobAccess },\n        '[restore] Blob store rejected preferred access level for media; uploaded with fallback',\n      )\n    }\n    mediaResults.forEach((result) => {\n      payload.logger.debug(\n        { name: result.name, access: result.effectiveAccess },\n        '[restore] Media file uploaded',\n      )\n    })\n  } else {\n    throw new Error(`File type of backup ${downloadUrl} not supported`)\n  }\n\n  const collectionNames = Object.keys(collections)\n  payload.logger.info(\n    { blacklisted: effectiveBlacklist.length, total: collectionNames.length },\n    '[restore] Restoring collections',\n  )\n  if (taskId) {\n    await updateBackupTask(payload, taskId, {\n      message: `Restoring ${collectionNames.length} collection${collectionNames.length === 1 ? '' : 's'}`,\n    })\n  }\n\n  for (const collectionName of collectionNames) {\n    if (effectiveBlacklist.includes(collectionName)) {\n      payload.logger.debug(\n        { collection: collectionName },\n        '[restore] Skipping blacklisted collection',\n      )\n      continue\n    }\n    const collectionData = collections[collectionName]\n    if (collectionData.length > 0) {\n      payload.logger.info(\n        { collection: collectionName, docs: collectionData.length, mergeData },\n        '[restore] Restoring collection',\n      )\n      const collection = db.collection(collectionName)\n      const indexes = await collection.indexes()\n      const uniqueIndexes = indexes\n        .filter((idx) => idx.unique)\n        .flatMap((idx) => Object.keys(idx.key))\n      if (!mergeData) {\n        await collection.deleteMany({})\n      }\n      if (taskId) {\n        await updateBackupTask(payload, taskId, {\n          message: `Restoring collection ${collectionName} (${collectionData.length} docs)`,\n        })\n      }\n      const res = await collection.bulkWrite(\n        collectionData.map((doc) => ({\n          updateOne: {\n            filter:\n              uniqueIndexes.length > 0\n                ? {\n                    $or: [\n                      { _id: doc._id },\n                      ...uniqueIndexes.map((field) => ({ [field]: doc[field] })),\n                    ],\n                  }\n                : { _id: doc._id },\n            update: { $set: doc },\n            upsert: true,\n          },\n        })),\n      )\n      payload.logger.debug(\n        { collection: collectionName, modified: res.modifiedCount, upserted: res.upsertedCount },\n        '[restore] Collection restored',\n      )\n    }\n  }\n\n  payload.logger.info({ durationMs: Date.now() - t0 }, '[restore] Restore complete')\n}\n\nexport async function restoreSeedMedia(payload: Payload, taskId?: string): Promise<string[]> {\n  const files = await fs.readdir(path.join(process.cwd(), 'public/seed/media'))\n  if (taskId) {\n    await updateBackupTask(payload, taskId, {\n      message: `Restoring ${files.length} seed media file${files.length === 1 ? '' : 's'}`,\n      status: 'running',\n    })\n  }\n  for (const file of files) {\n    const data = await fs.readFile(path.join(process.cwd(), 'public/seed/media', file))\n    if (process.env.BLOB_READ_WRITE_TOKEN) {\n      const effectiveAccess = await putBackupBlobContent(\n        file,\n        data,\n        process.env.BLOB_READ_WRITE_TOKEN,\n        'public',\n      )\n      payload.logger.info(\n        { access: effectiveAccess, file },\n        '[restore] Restored seed media to Vercel Blob storage',\n      )\n    } else {\n      const folderPath = path.join(process.cwd(), 'public/media')\n      const publicPath = path.join(folderPath, file)\n      await fs.mkdir(folderPath, { recursive: true })\n      await fs.writeFile(publicPath, data)\n      payload.logger.info({ file, publicPath }, '[restore] Restored seed media to public directory')\n    }\n    if (taskId) {\n      await updateBackupTask(payload, taskId, {\n        message: `Restored seed media file ${file}`,\n      })\n    }\n  }\n  payload.logger.info({ count: files.length }, '[restore] Restored all seed media files')\n  return files\n}\n"],"names":["EJSON","fs","path","resolveTarGzip","COLLECTION_FILE_NAME","putBackupBlobContent","readBackupBlobContentFlexible","getDb","updateBackupTask","restoreBackup","payload","downloadUrl","collectionBlacklist","mergeData","taskId","options","restoreArchiveMedia","blobToken","blobAccess","backupRead","t0","Date","now","urlBase","split","effectiveBlacklist","Array","from","Set","logger","info","blacklist","url","message","status","db","archiveBytes","pathname","token","res","fetch","ok","Error","Buffer","arrayBuffer","collections","endsWith","parse","toString","files","find","file","name","content","medias","filter","count","length","mediaResults","Promise","all","map","media","then","effectiveAccess","mismatched","r","warn","preferredAccess","forEach","result","debug","access","collectionNames","Object","keys","blacklisted","total","collectionName","includes","collection","collectionData","docs","indexes","uniqueIndexes","idx","unique","flatMap","key","deleteMany","bulkWrite","doc","updateOne","$or","_id","field","update","$set","upsert","modified","modifiedCount","upserted","upsertedCount","durationMs","restoreSeedMedia","readdir","join","process","cwd","data","readFile","env","BLOB_READ_WRITE_TOKEN","folderPath","publicPath","mkdir","recursive","writeFile"],"mappings":"AAEA,SAASA,KAAK,QAAQ,OAAM;AAC5B,OAAOC,QAAQ,mBAAkB;AACjC,OAAOC,UAAU,YAAW;AAE5B,SAASC,cAAc,QAAQ,YAAW;AAC1C,SAASC,oBAAoB,QAAQ,WAAU;AAC/C,SAEEC,oBAAoB,EACpBC,6BAA6B,QACxB,iBAAgB;AACvB,SAASC,KAAK,QAAQ,OAAM;AAC5B,SAASC,gBAAgB,QAAQ,iBAAgB;AAuBjD,OAAO,eAAeC,cACpBC,OAAgB,EAChBC,WAAmB,EACnBC,sBAAgC,EAAE,EAClCC,YAAY,KAAK,EACjBC,MAAe,EACfC,OAA8B;IAE9B,MAAMC,sBAAsBD,SAASC,wBAAwB;IAC7D,MAAMC,YAAYF,SAASE;IAC3B,MAAMC,aAAoCH,SAASG,cAAc;IACjE,MAAMC,aAAaJ,SAASI;IAC5B,MAAMC,KAAKC,KAAKC,GAAG;IACnB,MAAMC,UAAUZ,YAAYa,KAAK,CAAC,MAAM,CAAC,EAAE;IAE3C,gFAAgF;IAChF,qFAAqF;IACrF,MAAMC,qBAAqBX,SACvBY,MAAMC,IAAI,CAAC,IAAIC,IAAI;QAAC;WAAmBhB;KAAoB,KAC3D;WAAIA;KAAoB;IAE5BF,QAAQmB,MAAM,CAACC,IAAI,CACjB;QAAEC,WAAWN;QAAoBZ;QAAWmB,KAAKT;IAAQ,GACzD;IAEF,IAAIT,QAAQ;QACV,MAAMN,iBAAiBE,SAASI,QAAQ;YACtCmB,SAAS;YACTC,QAAQ;QACV;IACF;IAEA,MAAMC,KAAK5B,MAAMG;IACjB,MAAM0B,eAAejB,aACjB,MAAMb,8BAA8Ba,WAAWkB,QAAQ,EAAE1B,aAAaQ,WAAWmB,KAAK,IACtF,MAAM,AAAC,CAAA;QACL,MAAMC,MAAM,MAAMC,MAAM7B;QACxB,IAAI,CAAC4B,IAAIE,EAAE,EAAE;YACX,MAAM,IAAIC,MAAM,CAAC,2BAA2B,EAAEH,IAAIL,MAAM,CAAC,CAAC,CAAC;QAC7D;QACA,OAAOS,OAAOhB,IAAI,CAAC,MAAMY,IAAIK,WAAW;IAC1C,CAAA;IACJ,IAAIC,cAAyD,CAAC;IAE9D,IAAItB,SAASuB,SAAS,UAAU;QAC9BpC,QAAQmB,MAAM,CAACC,IAAI,CAAC;QACpB,IAAIhB,QAAQ;YACV,MAAMN,iBAAiBE,SAASI,QAAQ;gBACtCmB,SAAS;YACX;QACF;QACAY,cAAc7C,MAAM+C,KAAK,CAACX,aAAaY,QAAQ,CAAC;IAClD,OAAO,IAAIzB,SAASuB,SAAS,QAAQ;QACnCpC,QAAQmB,MAAM,CAACC,IAAI,CAAC;QACpB,IAAIhB,QAAQ;YACV,MAAMN,iBAAiBE,SAASI,QAAQ;gBACtCmB,SAAS;YACX;QACF;QACA,MAAMgB,QAAQ,MAAM9C,eAAeiC;QACnCS,cAAc7C,MAAM+C,KAAK,CACvBE,MAAMC,IAAI,CAAC,CAACC,OAASA,KAAKC,IAAI,KAAKhD,uBAAuBiD,SAASL,cAAc;QAEnF,MAAMM,SAAStC,sBACXiC,MAAMM,MAAM,CAAC,CAACJ,OAASA,KAAKC,IAAI,KAAKhD,wBACrC,EAAE;QACN,IAAI,CAACY,qBAAqB;YACxBN,QAAQmB,MAAM,CAACC,IAAI,CACjB;QAEJ;QACApB,QAAQmB,MAAM,CAACC,IAAI,CAAC;YAAE0B,OAAOF,OAAOG,MAAM;QAAC,GAAG;QAC9C,IAAI3C,QAAQ;YACV,MAAMN,iBAAiBE,SAASI,QAAQ;gBACtCmB,SAASjB,sBACL,CAAC,UAAU,EAAEsC,OAAOG,MAAM,CAAC,WAAW,EAAEH,OAAOG,MAAM,KAAK,IAAI,KAAK,KAAK,GACxE;YACN;QACF;QACA,MAAMC,eAAe,MAAMC,QAAQC,GAAG,CACpCN,OAAOO,GAAG,CAAC,CAACC,QACVzD,qBAAqByD,MAAMV,IAAI,EAAEU,MAAMT,OAAO,EAAEpC,WAAWC,YAAY6C,IAAI,CACzE,CAACC,kBAAqB,CAAA;oBAAEZ,MAAMU,MAAMV,IAAI;oBAAEY;gBAAgB,CAAA;QAIhE,MAAMC,aAAaP,aAAaH,MAAM,CAAC,CAACW,IAAMA,EAAEF,eAAe,KAAK9C;QACpE,IAAI+C,WAAWR,MAAM,GAAG,GAAG;YACzB/C,QAAQmB,MAAM,CAACsC,IAAI,CACjB;gBAAEX,OAAOS,WAAWR,MAAM;gBAAEW,iBAAiBlD;YAAW,GACxD;QAEJ;QACAwC,aAAaW,OAAO,CAAC,CAACC;YACpB5D,QAAQmB,MAAM,CAAC0C,KAAK,CAClB;gBAAEnB,MAAMkB,OAAOlB,IAAI;gBAAEoB,QAAQF,OAAON,eAAe;YAAC,GACpD;QAEJ;IACF,OAAO;QACL,MAAM,IAAItB,MAAM,CAAC,oBAAoB,EAAE/B,YAAY,cAAc,CAAC;IACpE;IAEA,MAAM8D,kBAAkBC,OAAOC,IAAI,CAAC9B;IACpCnC,QAAQmB,MAAM,CAACC,IAAI,CACjB;QAAE8C,aAAanD,mBAAmBgC,MAAM;QAAEoB,OAAOJ,gBAAgBhB,MAAM;IAAC,GACxE;IAEF,IAAI3C,QAAQ;QACV,MAAMN,iBAAiBE,SAASI,QAAQ;YACtCmB,SAAS,CAAC,UAAU,EAAEwC,gBAAgBhB,MAAM,CAAC,WAAW,EAAEgB,gBAAgBhB,MAAM,KAAK,IAAI,KAAK,KAAK;QACrG;IACF;IAEA,KAAK,MAAMqB,kBAAkBL,gBAAiB;QAC5C,IAAIhD,mBAAmBsD,QAAQ,CAACD,iBAAiB;YAC/CpE,QAAQmB,MAAM,CAAC0C,KAAK,CAClB;gBAAES,YAAYF;YAAe,GAC7B;YAEF;QACF;QACA,MAAMG,iBAAiBpC,WAAW,CAACiC,eAAe;QAClD,IAAIG,eAAexB,MAAM,GAAG,GAAG;YAC7B/C,QAAQmB,MAAM,CAACC,IAAI,CACjB;gBAAEkD,YAAYF;gBAAgBI,MAAMD,eAAexB,MAAM;gBAAE5C;YAAU,GACrE;YAEF,MAAMmE,aAAa7C,GAAG6C,UAAU,CAACF;YACjC,MAAMK,UAAU,MAAMH,WAAWG,OAAO;YACxC,MAAMC,gBAAgBD,QACnB5B,MAAM,CAAC,CAAC8B,MAAQA,IAAIC,MAAM,EAC1BC,OAAO,CAAC,CAACF,MAAQX,OAAOC,IAAI,CAACU,IAAIG,GAAG;YACvC,IAAI,CAAC3E,WAAW;gBACd,MAAMmE,WAAWS,UAAU,CAAC,CAAC;YAC/B;YACA,IAAI3E,QAAQ;gBACV,MAAMN,iBAAiBE,SAASI,QAAQ;oBACtCmB,SAAS,CAAC,qBAAqB,EAAE6C,eAAe,EAAE,EAAEG,eAAexB,MAAM,CAAC,MAAM,CAAC;gBACnF;YACF;YACA,MAAMlB,MAAM,MAAMyC,WAAWU,SAAS,CACpCT,eAAepB,GAAG,CAAC,CAAC8B,MAAS,CAAA;oBAC3BC,WAAW;wBACTrC,QACE6B,cAAc3B,MAAM,GAAG,IACnB;4BACEoC,KAAK;gCACH;oCAAEC,KAAKH,IAAIG,GAAG;gCAAC;mCACZV,cAAcvB,GAAG,CAAC,CAACkC,QAAW,CAAA;wCAAE,CAACA,MAAM,EAAEJ,GAAG,CAACI,MAAM;oCAAC,CAAA;6BACxD;wBACH,IACA;4BAAED,KAAKH,IAAIG,GAAG;wBAAC;wBACrBE,QAAQ;4BAAEC,MAAMN;wBAAI;wBACpBO,QAAQ;oBACV;gBACF,CAAA;YAEFxF,QAAQmB,MAAM,CAAC0C,KAAK,CAClB;gBAAES,YAAYF;gBAAgBqB,UAAU5D,IAAI6D,aAAa;gBAAEC,UAAU9D,IAAI+D,aAAa;YAAC,GACvF;QAEJ;IACF;IAEA5F,QAAQmB,MAAM,CAACC,IAAI,CAAC;QAAEyE,YAAYlF,KAAKC,GAAG,KAAKF;IAAG,GAAG;AACvD;AAEA,OAAO,eAAeoF,iBAAiB9F,OAAgB,EAAEI,MAAe;IACtE,MAAMmC,QAAQ,MAAMhD,GAAGwG,OAAO,CAACvG,KAAKwG,IAAI,CAACC,QAAQC,GAAG,IAAI;IACxD,IAAI9F,QAAQ;QACV,MAAMN,iBAAiBE,SAASI,QAAQ;YACtCmB,SAAS,CAAC,UAAU,EAAEgB,MAAMQ,MAAM,CAAC,gBAAgB,EAAER,MAAMQ,MAAM,KAAK,IAAI,KAAK,KAAK;YACpFvB,QAAQ;QACV;IACF;IACA,KAAK,MAAMiB,QAAQF,MAAO;QACxB,MAAM4D,OAAO,MAAM5G,GAAG6G,QAAQ,CAAC5G,KAAKwG,IAAI,CAACC,QAAQC,GAAG,IAAI,qBAAqBzD;QAC7E,IAAIwD,QAAQI,GAAG,CAACC,qBAAqB,EAAE;YACrC,MAAMhD,kBAAkB,MAAM3D,qBAC5B8C,MACA0D,MACAF,QAAQI,GAAG,CAACC,qBAAqB,EACjC;YAEFtG,QAAQmB,MAAM,CAACC,IAAI,CACjB;gBAAE0C,QAAQR;gBAAiBb;YAAK,GAChC;QAEJ,OAAO;YACL,MAAM8D,aAAa/G,KAAKwG,IAAI,CAACC,QAAQC,GAAG,IAAI;YAC5C,MAAMM,aAAahH,KAAKwG,IAAI,CAACO,YAAY9D;YACzC,MAAMlD,GAAGkH,KAAK,CAACF,YAAY;gBAAEG,WAAW;YAAK;YAC7C,MAAMnH,GAAGoH,SAAS,CAACH,YAAYL;YAC/BnG,QAAQmB,MAAM,CAACC,IAAI,CAAC;gBAAEqB;gBAAM+D;YAAW,GAAG;QAC5C;QACA,IAAIpG,QAAQ;YACV,MAAMN,iBAAiBE,SAASI,QAAQ;gBACtCmB,SAAS,CAAC,yBAAyB,EAAEkB,MAAM;YAC7C;QACF;IACF;IACAzC,QAAQmB,MAAM,CAACC,IAAI,CAAC;QAAE0B,OAAOP,MAAMQ,MAAM;IAAC,GAAG;IAC7C,OAAOR;AACT"}

package/dist/core/restorePreview.d.ts

@@ -0,0 +1,64 @@
+import type { Payload } from 'payload';
+export type RestorePreviewFileKind = 'json' | 'tar-gzip';
+export type RestorePreviewAdminHiddenReason = 'collection-config' | 'version-history';
+export type RestorePreviewGroup = {
+    adminHidden: boolean;
+    adminHiddenReasons: RestorePreviewAdminHiddenReason[];
+    affectsAuthSession: boolean;
+    /** e.g. "Seiten (pages)" */
+    displayTitle: string;
+    /** Stable id for UI + skip payload (Payload collection slug when known, else mongo name). */
+    groupId: string;
+    main?: {
+        docCount: number;
+        mongoName: string;
+    };
+    /** All Mongo names restored when this group is checked. */
+    mongoNames: string[];
+    versions?: {
+        docCount: number;
+        mongoName: string;
+    };
+};
+export type RestorePreviewResponse = {
+    fileKind: RestorePreviewFileKind;
+    groups: RestorePreviewGroup[];
+    mediaBlobCount: number;
+};
+/**
+ * Index in sidebar order, or `null` if the group is not a visible nav collection
+ * (hidden config, unknown mongo name, etc.).
+ */
+export declare function navVisibleCollectionOrderIndex(payload: Payload, groupId: string): null | number;
+export declare function loadRestoreBackupIndex(downloadUrl: string, readAuth?: {
+    pathname: string;
+    token: string;
+}): Promise<{
+    byName: Record<string, unknown[]>;
+    fileKind: RestorePreviewFileKind;
+    mediaBlobCount: number;
+}>;
+/** Group Mongo collection names + doc counts (live DB or backup file) for admin UI lists. */
+export declare function buildCollectionPreviewGroups(payload: Payload, countsByMongo: Record<string, number>, options?: {
+    excludeMongo?: Set<string>;
+    /** When true, list collections with 0 documents (e.g. manual backup UI). Default false. */
+    includeEmptyCollections?: boolean;
+    preferredLocales?: string[];
+    /** When true, order like Payload admin sidebar; unknown / hidden-only groups last by title. */
+    sortLikeAdminNav?: boolean;
+}): RestorePreviewGroup[];
+export declare function buildRestorePreviewGroups(payload: Payload, parsed: {
+    byName: Record<string, unknown[]>;
+    fileKind: RestorePreviewFileKind;
+    mediaBlobCount: number;
+}, options?: {
+    excludeMongo?: Set<string>;
+    preferredLocales?: string[];
+}): RestorePreviewResponse;
+export declare function getRestorePreviewForAdminRestore(payload: Payload, downloadUrl: string, options?: {
+    backupRead?: {
+        pathname: string;
+        token: string;
+    };
+    preferredLocales?: string[];
+}): Promise<RestorePreviewResponse>;

package/dist/core/restorePreview.js

@@ -0,0 +1,266 @@
+import { EJSON } from 'bson';
+import { resolveTarGzip } from './archive';
+import { COLLECTION_FILE_NAME } from './backup';
+import { readBackupBlobContentFlexible } from './backupBlobIO';
+/** Mongo collection names that invalidate the current admin session when replaced. */ const AUTH_SESSION_MONGO_NAMES = new Set([
+    'payload-preferences',
+    'roles',
+    'sessions',
+    'users'
+]);
+const MONGO_VERSIONS = /^_(.+)_versions$/i;
+function docCount(byName, name) {
+    const docs = byName[name];
+    return Array.isArray(docs) ? docs.length : 0;
+}
+function isVersionsMongoName(name) {
+    return MONGO_VERSIONS.test(name);
+}
+function resolveAdminHidden(payload, mongoName) {
+    const col = payload.config.collections.find((c)=>{
+        const dbName = c.dbName ?? c.slug;
+        return dbName === mongoName || c.slug === mongoName;
+    });
+    if (col?.admin?.hidden) {
+        return {
+            adminHidden: true,
+            adminHiddenReason: 'collection-config'
+        };
+    }
+    if (isVersionsMongoName(mongoName)) {
+        return {
+            adminHidden: true,
+            adminHiddenReason: 'version-history'
+        };
+    }
+    return {
+        adminHidden: false,
+        adminHiddenReason: null
+    };
+}
+function pickLocalizedLabel(labels, preferredLocales) {
+    if (!labels || typeof labels !== 'object') {
+        return undefined;
+    }
+    const l = labels;
+    const pickField = (field)=>{
+        if (typeof field === 'string') {
+            return field;
+        }
+        if (field && typeof field === 'object') {
+            const map = field;
+            for (const loc of preferredLocales){
+                const v = map[loc];
+                if (v) {
+                    return v;
+                }
+            }
+            const first = Object.values(map).find(Boolean);
+            return first;
+        }
+        return undefined;
+    };
+    return pickField(l.plural) || pickField(l.singular);
+}
+function humanizeSlug(slug) {
+    return slug.split('-').map((w)=>w ? w.charAt(0).toUpperCase() + w.slice(1) : '').join(' ');
+}
+/** Collections shown in the default Payload admin sidebar: config order, skipping `admin.hidden`. */ function getNavVisibleCollections(payload) {
+    return payload.config.collections.filter((c)=>c.admin?.hidden !== true);
+}
+/**
+ * Index in sidebar order, or `null` if the group is not a visible nav collection
+ * (hidden config, unknown mongo name, etc.).
+ */ export function navVisibleCollectionOrderIndex(payload, groupId) {
+    const visible = getNavVisibleCollections(payload);
+    const idx = visible.findIndex((c)=>{
+        const dbName = c.dbName ?? c.slug;
+        return c.slug === groupId || dbName === groupId;
+    });
+    return idx === -1 ? null : idx;
+}
+function sortPreviewGroupsLikeAdminNav(payload, groups, preferredLocales) {
+    const locale = preferredLocales[0] ?? 'en';
+    groups.sort((a, b)=>{
+        const ia = navVisibleCollectionOrderIndex(payload, a.groupId);
+        const ib = navVisibleCollectionOrderIndex(payload, b.groupId);
+        if (ia !== null && ib !== null && ia !== ib) {
+            return ia - ib;
+        }
+        if (ia !== null && ib === null) {
+            return -1;
+        }
+        if (ia === null && ib !== null) {
+            return 1;
+        }
+        return a.displayTitle.localeCompare(b.displayTitle, locale);
+    });
+}
+function buildDisplayTitle(payload, groupSlug, preferredLocales) {
+    const col = payload.config.collections.find((c)=>c.slug === groupSlug);
+    const label = pickLocalizedLabel(col?.labels, preferredLocales) || humanizeSlug(groupSlug);
+    return `${label} (${groupSlug})`;
+}
+export async function loadRestoreBackupIndex(downloadUrl, readAuth) {
+    const urlBase = downloadUrl.split('?')?.[0];
+    const bytes = readAuth ? await readBackupBlobContentFlexible(readAuth.pathname, downloadUrl, readAuth.token) : await (async ()=>{
+        const res = await fetch(downloadUrl);
+        if (!res.ok) {
+            throw new Error(`Failed to download backup (${res.status})`);
+        }
+        return Buffer.from(await res.arrayBuffer());
+    })();
+    let byName = {};
+    let mediaBlobCount = 0;
+    let fileKind;
+    if (urlBase?.endsWith('.json')) {
+        fileKind = 'json';
+        byName = EJSON.parse(bytes.toString('utf8'));
+    } else if (urlBase?.endsWith('.gz')) {
+        fileKind = 'tar-gzip';
+        const files = await resolveTarGzip(bytes);
+        byName = EJSON.parse(files.find((f)=>f.name === COLLECTION_FILE_NAME)?.content?.toString() || '{}');
+        mediaBlobCount = files.filter((f)=>f.name !== COLLECTION_FILE_NAME).length;
+    } else {
+        throw new Error('Unsupported backup file type (expected .json or .gz)');
+    }
+    return {
+        byName,
+        fileKind,
+        mediaBlobCount
+    };
+}
+function rebuildMongoNames(g) {
+    return [
+        g.main?.mongoName,
+        g.versions?.mongoName
+    ].filter(Boolean);
+}
+function countsFromByName(byName) {
+    const out = {};
+    for (const k of Object.keys(byName)){
+        out[k] = docCount(byName, k);
+    }
+    return out;
+}
+/** Ensures every configured Payload collection appears (0 if absent from backup JSON), like live-DB preview. */ function mergeConfiguredCollectionZeros(payload, fileCounts, excludeMongo) {
+    const merged = {
+        ...fileCounts
+    };
+    for (const col of payload.config.collections){
+        const mongo = col.dbName ?? col.slug;
+        if (excludeMongo.has(mongo)) {
+            continue;
+        }
+        if (!(mongo in merged)) {
+            merged[mongo] = 0;
+        }
+    }
+    return merged;
+}
+/** Group Mongo collection names + doc counts (live DB or backup file) for admin UI lists. */ export function buildCollectionPreviewGroups(payload, countsByMongo, options = {}) {
+    const preferredLocales = options.preferredLocales?.length ? options.preferredLocales : [
+        'de',
+        'en'
+    ];
+    const excludeMongo = options.excludeMongo ?? new Set([
+        'backup-tasks'
+    ]);
+    const includeEmptyCollections = options.includeEmptyCollections ?? false;
+    const sortLikeAdminNav = options.sortLikeAdminNav ?? false;
+    const aggs = new Map();
+    for (const [mongoName, count] of Object.entries(countsByMongo)){
+        if (excludeMongo.has(mongoName)) {
+            continue;
+        }
+        if (!includeEmptyCollections && count === 0) {
+            continue;
+        }
+        const versionMatch = mongoName.match(MONGO_VERSIONS);
+        if (versionMatch) {
+            const groupId = versionMatch[1];
+            const prev = aggs.get(groupId) ?? {
+                groupId
+            };
+            aggs.set(groupId, {
+                ...prev,
+                groupId,
+                versions: {
+                    docCount: count,
+                    mongoName
+                }
+            });
+        } else {
+            const groupId = mongoName;
+            const prev = aggs.get(groupId) ?? {
+                groupId
+            };
+            aggs.set(groupId, {
+                ...prev,
+                groupId,
+                main: {
+                    docCount: count,
+                    mongoName
+                }
+            });
+        }
+    }
+    const groups = [
+        ...aggs.values()
+    ].map((agg)=>{
+        const mongoNames = rebuildMongoNames(agg);
+        const reasons = new Set();
+        let adminHidden = false;
+        for (const mn of mongoNames){
+            const r = resolveAdminHidden(payload, mn);
+            if (r.adminHidden && r.adminHiddenReason) {
+                adminHidden = true;
+                reasons.add(r.adminHiddenReason);
+            }
+        }
+        const affectsAuthSession = mongoNames.some((n)=>AUTH_SESSION_MONGO_NAMES.has(n));
+        return {
+            adminHidden,
+            adminHiddenReasons: [
+                ...reasons
+            ],
+            affectsAuthSession,
+            displayTitle: buildDisplayTitle(payload, agg.groupId, preferredLocales),
+            groupId: agg.groupId,
+            main: agg.main,
+            mongoNames,
+            versions: agg.versions
+        };
+    });
+    if (sortLikeAdminNav) {
+        sortPreviewGroupsLikeAdminNav(payload, groups, preferredLocales);
+    } else {
+        const locale = preferredLocales[0] ?? 'en';
+        groups.sort((a, b)=>a.displayTitle.localeCompare(b.displayTitle, locale));
+    }
+    return groups;
+}
+export function buildRestorePreviewGroups(payload, parsed, options = {}) {
+    const excludeMongo = options.excludeMongo ?? new Set([
+        'backup-tasks'
+    ]);
+    const rawCounts = countsFromByName(parsed.byName);
+    const counts = mergeConfiguredCollectionZeros(payload, rawCounts, excludeMongo);
+    const groups = buildCollectionPreviewGroups(payload, counts, {
+        excludeMongo,
+        includeEmptyCollections: true,
+        preferredLocales: options.preferredLocales,
+        sortLikeAdminNav: true
+    });
+    return {
+        fileKind: parsed.fileKind,
+        groups,
+        mediaBlobCount: parsed.mediaBlobCount
+    };
+}
+export async function getRestorePreviewForAdminRestore(payload, downloadUrl, options = {}) {
+    const parsed = await loadRestoreBackupIndex(downloadUrl, options.backupRead);
+    return buildRestorePreviewGroups(payload, parsed, options);
+}
+
+//# sourceMappingURL=restorePreview.js.map