@payloadcms/plugin-cloud-storage 3.91.0-internal.c1569dc → 4.0.0-beta.0

package/dist/utilities/initClientUploads.js

@@ -1,66 +0,0 @@
-export const initClientUploads = ({ clientHandler, collections, config, enabled, extraClientHandlerProps, serverHandler, serverHandlerPath })=>{
-    if (enabled) {
-        if (!config.endpoints) {
-            config.endpoints = [];
-        }
-        /**
-     * Tracks how many times the same handler was already applied.
-     * This allows to apply the same plugin multiple times, for example
-     * to use different buckets for different collections.
-     */ let handlerCount = 0;
-        for (const endpoint of config.endpoints){
-            // We want to match on 'path', 'path-1', 'path-2', etc.
-            if (endpoint.path?.startsWith(serverHandlerPath)) {
-                handlerCount++;
-            }
-        }
-        if (handlerCount) {
-            serverHandlerPath = `${serverHandlerPath}-${handlerCount}`;
-        }
-        config.endpoints.push({
-            handler: serverHandler,
-            method: 'post',
-            path: serverHandlerPath
-        });
-    }
-    if (!config.admin) {
-        config.admin = {};
-    }
-    if (!config.admin.dependencies) {
-        config.admin.dependencies = {};
-    }
-    // Ensure client handler is always part of the import map, to avoid
-    // import map discrepancies between dev and prod
-    config.admin.dependencies[clientHandler] = {
-        type: 'function',
-        path: clientHandler
-    };
-    if (!enabled) {
-        return;
-    }
-    if (!config.admin.components) {
-        config.admin.components = {};
-    }
-    if (!config.admin.components.providers) {
-        config.admin.components.providers = [];
-    }
-    for(const collectionSlug in collections){
-        const collection = collections[collectionSlug];
-        let collectionPrefix;
-        if (collection && typeof collection === 'object' && 'prefix' in collection && typeof collection.prefix === 'string') {
-            collectionPrefix = collection.prefix;
-        }
-        config.admin.components.providers.push({
-            clientProps: {
-                collectionSlug,
-                enabled,
-                extra: extraClientHandlerProps ? extraClientHandlerProps(collection) : undefined,
-                prefix: collectionPrefix,
-                serverHandlerPath
-            },
-            path: clientHandler
-        });
-    }
-};
-
-//# sourceMappingURL=initClientUploads.js.map

package/dist/utilities/initClientUploads.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/utilities/initClientUploads.ts"],"sourcesContent":["import type { Config, PayloadHandler } from 'payload'\n\nexport const initClientUploads = <ExtraProps extends Record<string, unknown>, T>({\n  clientHandler,\n  collections,\n  config,\n  enabled,\n  extraClientHandlerProps,\n  serverHandler,\n  serverHandlerPath,\n}: {\n  /** Path to clientHandler component */\n  clientHandler: string\n  collections: Record<string, T>\n  config: Config\n  enabled: boolean\n  /** extra props to pass to the client handler */\n  extraClientHandlerProps?: (collection: T) => ExtraProps\n  serverHandler: PayloadHandler\n  serverHandlerPath: string\n}) => {\n  if (enabled) {\n    if (!config.endpoints) {\n      config.endpoints = []\n    }\n\n    /**\n     * Tracks how many times the same handler was already applied.\n     * This allows to apply the same plugin multiple times, for example\n     * to use different buckets for different collections.\n     */\n    let handlerCount = 0\n\n    for (const endpoint of config.endpoints) {\n      // We want to match on 'path', 'path-1', 'path-2', etc.\n      if (endpoint.path?.startsWith(serverHandlerPath)) {\n        handlerCount++\n      }\n    }\n\n    if (handlerCount) {\n      serverHandlerPath = `${serverHandlerPath}-${handlerCount}`\n    }\n\n    config.endpoints.push({\n      handler: serverHandler,\n      method: 'post',\n      path: serverHandlerPath,\n    })\n  }\n\n  if (!config.admin) {\n    config.admin = {}\n  }\n\n  if (!config.admin.dependencies) {\n    config.admin.dependencies = {}\n  }\n  // Ensure client handler is always part of the import map, to avoid\n  // import map discrepancies between dev and prod\n  config.admin.dependencies[clientHandler] = {\n    type: 'function',\n    path: clientHandler,\n  }\n\n  if (!enabled) {\n    return\n  }\n\n  if (!config.admin.components) {\n    config.admin.components = {}\n  }\n\n  if (!config.admin.components.providers) {\n    config.admin.components.providers = []\n  }\n\n  for (const collectionSlug in collections) {\n    const collection = collections[collectionSlug]\n\n    let collectionPrefix: string | undefined\n\n    if (\n      collection &&\n      typeof collection === 'object' &&\n      'prefix' in collection &&\n      typeof collection.prefix === 'string'\n    ) {\n      collectionPrefix = collection.prefix\n    }\n\n    config.admin.components.providers.push({\n      clientProps: {\n        collectionSlug,\n        enabled,\n        extra: extraClientHandlerProps ? extraClientHandlerProps(collection!) : undefined,\n        prefix: collectionPrefix,\n        serverHandlerPath,\n      },\n      path: clientHandler,\n    })\n  }\n}\n"],"names":["initClientUploads","clientHandler","collections","config","enabled","extraClientHandlerProps","serverHandler","serverHandlerPath","endpoints","handlerCount","endpoint","path","startsWith","push","handler","method","admin","dependencies","type","components","providers","collectionSlug","collection","collectionPrefix","prefix","clientProps","extra","undefined"],"mappings":"AAEA,OAAO,MAAMA,oBAAoB,CAAgD,EAC/EC,aAAa,EACbC,WAAW,EACXC,MAAM,EACNC,OAAO,EACPC,uBAAuB,EACvBC,aAAa,EACbC,iBAAiB,EAWlB;IACC,IAAIH,SAAS;QACX,IAAI,CAACD,OAAOK,SAAS,EAAE;YACrBL,OAAOK,SAAS,GAAG,EAAE;QACvB;QAEA;;;;KAIC,GACD,IAAIC,eAAe;QAEnB,KAAK,MAAMC,YAAYP,OAAOK,SAAS,CAAE;YACvC,uDAAuD;YACvD,IAAIE,SAASC,IAAI,EAAEC,WAAWL,oBAAoB;gBAChDE;YACF;QACF;QAEA,IAAIA,cAAc;YAChBF,oBAAoB,GAAGA,kBAAkB,CAAC,EAAEE,cAAc;QAC5D;QAEAN,OAAOK,SAAS,CAACK,IAAI,CAAC;YACpBC,SAASR;YACTS,QAAQ;YACRJ,MAAMJ;QACR;IACF;IAEA,IAAI,CAACJ,OAAOa,KAAK,EAAE;QACjBb,OAAOa,KAAK,GAAG,CAAC;IAClB;IAEA,IAAI,CAACb,OAAOa,KAAK,CAACC,YAAY,EAAE;QAC9Bd,OAAOa,KAAK,CAACC,YAAY,GAAG,CAAC;IAC/B;IACA,mEAAmE;IACnE,gDAAgD;IAChDd,OAAOa,KAAK,CAACC,YAAY,CAAChB,cAAc,GAAG;QACzCiB,MAAM;QACNP,MAAMV;IACR;IAEA,IAAI,CAACG,SAAS;QACZ;IACF;IAEA,IAAI,CAACD,OAAOa,KAAK,CAACG,UAAU,EAAE;QAC5BhB,OAAOa,KAAK,CAACG,UAAU,GAAG,CAAC;IAC7B;IAEA,IAAI,CAAChB,OAAOa,KAAK,CAACG,UAAU,CAACC,SAAS,EAAE;QACtCjB,OAAOa,KAAK,CAACG,UAAU,CAACC,SAAS,GAAG,EAAE;IACxC;IAEA,IAAK,MAAMC,kBAAkBnB,YAAa;QACxC,MAAMoB,aAAapB,WAAW,CAACmB,eAAe;QAE9C,IAAIE;QAEJ,IACED,cACA,OAAOA,eAAe,YACtB,YAAYA,cACZ,OAAOA,WAAWE,MAAM,KAAK,UAC7B;YACAD,mBAAmBD,WAAWE,MAAM;QACtC;QAEArB,OAAOa,KAAK,CAACG,UAAU,CAACC,SAAS,CAACP,IAAI,CAAC;YACrCY,aAAa;gBACXJ;gBACAjB;gBACAsB,OAAOrB,0BAA0BA,wBAAwBiB,cAAeK;gBACxEH,QAAQD;gBACRhB;YACF;YACAI,MAAMV;QACR;IACF;AACF,EAAC"}

package/dist/utilities/initClientUploads.spec.js

@@ -1,31 +0,0 @@
-import { describe, expect, it, vi } from 'vitest';
-import { initClientUploads } from './initClientUploads.js';
-describe('initClientUploads', ()=>{
-    it('does not add Admin providers when client uploads are disabled', ()=>{
-        const clientHandler = '@payloadcms/storage-s3/client#S3ClientUploadHandler';
-        const collections = Object.fromEntries(Array.from({
-            length: 50
-        }, (_, index)=>[
-                `upload-${index}`,
-                true
-            ]));
-        const config = {};
-        initClientUploads({
-            clientHandler,
-            collections,
-            config,
-            enabled: false,
-            serverHandler: vi.fn(),
-            serverHandlerPath: '/storage-s3-generate-signed-url'
-        });
-        expect(config.admin?.dependencies).toEqual({
-            [clientHandler]: {
-                path: clientHandler,
-                type: 'function'
-            }
-        });
-        expect(config.admin?.components?.providers).toBeUndefined();
-    });
-});
-
-//# sourceMappingURL=initClientUploads.spec.js.map

package/dist/utilities/initClientUploads.spec.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/utilities/initClientUploads.spec.ts"],"sourcesContent":["import type { Config, PayloadHandler } from 'payload'\n\nimport { describe, expect, it, vi } from 'vitest'\n\nimport { initClientUploads } from './initClientUploads.js'\n\ndescribe('initClientUploads', () => {\n  it('does not add Admin providers when client uploads are disabled', () => {\n    const clientHandler = '@payloadcms/storage-s3/client#S3ClientUploadHandler'\n    const collections = Object.fromEntries(\n      Array.from({ length: 50 }, (_, index) => [`upload-${index}`, true] as const),\n    )\n    const config = {} as Config\n\n    initClientUploads({\n      clientHandler,\n      collections,\n      config,\n      enabled: false,\n      serverHandler: vi.fn() as PayloadHandler,\n      serverHandlerPath: '/storage-s3-generate-signed-url',\n    })\n\n    expect(config.admin?.dependencies).toEqual({\n      [clientHandler]: {\n        path: clientHandler,\n        type: 'function',\n      },\n    })\n    expect(config.admin?.components?.providers).toBeUndefined()\n  })\n})\n"],"names":["describe","expect","it","vi","initClientUploads","clientHandler","collections","Object","fromEntries","Array","from","length","_","index","config","enabled","serverHandler","fn","serverHandlerPath","admin","dependencies","toEqual","path","type","components","providers","toBeUndefined"],"mappings":"AAEA,SAASA,QAAQ,EAAEC,MAAM,EAAEC,EAAE,EAAEC,EAAE,QAAQ,SAAQ;AAEjD,SAASC,iBAAiB,QAAQ,yBAAwB;AAE1DJ,SAAS,qBAAqB;IAC5BE,GAAG,iEAAiE;QAClE,MAAMG,gBAAgB;QACtB,MAAMC,cAAcC,OAAOC,WAAW,CACpCC,MAAMC,IAAI,CAAC;YAAEC,QAAQ;QAAG,GAAG,CAACC,GAAGC,QAAU;gBAAC,CAAC,OAAO,EAAEA,OAAO;gBAAE;aAAK;QAEpE,MAAMC,SAAS,CAAC;QAEhBV,kBAAkB;YAChBC;YACAC;YACAQ;YACAC,SAAS;YACTC,eAAeb,GAAGc,EAAE;YACpBC,mBAAmB;QACrB;QAEAjB,OAAOa,OAAOK,KAAK,EAAEC,cAAcC,OAAO,CAAC;YACzC,CAAChB,cAAc,EAAE;gBACfiB,MAAMjB;gBACNkB,MAAM;YACR;QACF;QACAtB,OAAOa,OAAOK,KAAK,EAAEK,YAAYC,WAAWC,aAAa;IAC3D;AACF"}

package/dist/utilities/resolveSignedURLKey.spec.js

@@ -1,56 +0,0 @@
-import { beforeEach, describe, expect, it, vi } from 'vitest';
-import { createClientUploadReceipt, getSafeFileName } from 'payload/internal';
-import { resolveSignedURLKey } from './resolveSignedURLKey.js';
-vi.mock('payload/internal', ()=>({
-        createClientUploadReceipt: vi.fn(()=>'receipt'),
-        getSafeFileName: vi.fn()
-    }));
-describe('resolveSignedURLKey', ()=>{
-    beforeEach(()=>{
-        vi.clearAllMocks();
-    });
-    it('should deduplicate within the resolved document prefix', async ()=>{
-        vi.mocked(getSafeFileName).mockImplementation(async ({ desiredFilename })=>{
-            expect(desiredFilename).toBe('photo.jpg');
-            return 'photo-1.jpg';
-        });
-        const result = await resolveSignedURLKey({
-            collectionPrefix: 'media',
-            collectionSlug: 'media',
-            docPrefix: 'media-archive',
-            filename: 'photo.jpg',
-            req: {}
-        });
-        expect(result.sanitizedDocPrefix).toBe('media/media-archive');
-        expect(result.fileKey).toMatch(/^media\/media-archive\/[0-9a-f-]+\/photo-1\.jpg$/);
-        expect(result.sanitizedFilename).toBe('photo-1.jpg');
-        expect(result._objectKey).toMatch(/^[0-9a-f-]+$/);
-        expect(result.clientUploadContext).toMatchObject({
-            _objectKey: result._objectKey,
-            prefix: 'media/media-archive',
-            signedReceipt: 'receipt'
-        });
-    });
-    it('should mint the receipt for a prefix contained by the collection prefix', async ()=>{
-        vi.mocked(getSafeFileName).mockResolvedValue('photo-1.jpg');
-        const { _objectKey, sanitizedDocPrefix } = await resolveSignedURLKey({
-            collectionPrefix: 'media',
-            collectionSlug: 'media',
-            docPrefix: 'media-archive',
-            filename: 'photo.jpg',
-            req: {}
-        });
-        expect(sanitizedDocPrefix).toBe('media/media-archive');
-        expect(createClientUploadReceipt).toHaveBeenCalledWith({
-            collectionSlug: 'media',
-            context: {
-                _objectKey,
-                prefix: sanitizedDocPrefix
-            },
-            filename: 'photo-1.jpg',
-            req: {}
-        });
-    });
-});
-
-//# sourceMappingURL=resolveSignedURLKey.spec.js.map

package/dist/utilities/resolveSignedURLKey.spec.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/utilities/resolveSignedURLKey.spec.ts"],"sourcesContent":["import type { PayloadRequest } from 'payload'\n\nimport { beforeEach, describe, expect, it, vi } from 'vitest'\n\nimport { createClientUploadReceipt, getSafeFileName } from 'payload/internal'\n\nimport { resolveSignedURLKey } from './resolveSignedURLKey.js'\n\nvi.mock('payload/internal', () => ({\n  createClientUploadReceipt: vi.fn(() => 'receipt'),\n  getSafeFileName: vi.fn(),\n}))\n\ndescribe('resolveSignedURLKey', () => {\n  beforeEach(() => {\n    vi.clearAllMocks()\n  })\n\n  it('should deduplicate within the resolved document prefix', async () => {\n    vi.mocked(getSafeFileName).mockImplementation(async ({ desiredFilename }) => {\n      expect(desiredFilename).toBe('photo.jpg')\n      return 'photo-1.jpg'\n    })\n\n    const result = await resolveSignedURLKey({\n      collectionPrefix: 'media',\n      collectionSlug: 'media',\n      docPrefix: 'media-archive',\n      filename: 'photo.jpg',\n      req: {} as PayloadRequest,\n    })\n\n    expect(result.sanitizedDocPrefix).toBe('media/media-archive')\n    expect(result.fileKey).toMatch(/^media\\/media-archive\\/[0-9a-f-]+\\/photo-1\\.jpg$/)\n    expect(result.sanitizedFilename).toBe('photo-1.jpg')\n    expect(result._objectKey).toMatch(/^[0-9a-f-]+$/)\n    expect(result.clientUploadContext).toMatchObject({\n      _objectKey: result._objectKey,\n      prefix: 'media/media-archive',\n      signedReceipt: 'receipt',\n    })\n  })\n\n  it('should mint the receipt for a prefix contained by the collection prefix', async () => {\n    vi.mocked(getSafeFileName).mockResolvedValue('photo-1.jpg')\n\n    const { _objectKey, sanitizedDocPrefix } = await resolveSignedURLKey({\n      collectionPrefix: 'media',\n      collectionSlug: 'media',\n      docPrefix: 'media-archive',\n      filename: 'photo.jpg',\n      req: {} as PayloadRequest,\n    })\n\n    expect(sanitizedDocPrefix).toBe('media/media-archive')\n    expect(createClientUploadReceipt).toHaveBeenCalledWith({\n      collectionSlug: 'media',\n      context: { _objectKey, prefix: sanitizedDocPrefix },\n      filename: 'photo-1.jpg',\n      req: {},\n    })\n  })\n})\n"],"names":["beforeEach","describe","expect","it","vi","createClientUploadReceipt","getSafeFileName","resolveSignedURLKey","mock","fn","clearAllMocks","mocked","mockImplementation","desiredFilename","toBe","result","collectionPrefix","collectionSlug","docPrefix","filename","req","sanitizedDocPrefix","fileKey","toMatch","sanitizedFilename","_objectKey","clientUploadContext","toMatchObject","prefix","signedReceipt","mockResolvedValue","toHaveBeenCalledWith","context"],"mappings":"AAEA,SAASA,UAAU,EAAEC,QAAQ,EAAEC,MAAM,EAAEC,EAAE,EAAEC,EAAE,QAAQ,SAAQ;AAE7D,SAASC,yBAAyB,EAAEC,eAAe,QAAQ,mBAAkB;AAE7E,SAASC,mBAAmB,QAAQ,2BAA0B;AAE9DH,GAAGI,IAAI,CAAC,oBAAoB,IAAO,CAAA;QACjCH,2BAA2BD,GAAGK,EAAE,CAAC,IAAM;QACvCH,iBAAiBF,GAAGK,EAAE;IACxB,CAAA;AAEAR,SAAS,uBAAuB;IAC9BD,WAAW;QACTI,GAAGM,aAAa;IAClB;IAEAP,GAAG,0DAA0D;QAC3DC,GAAGO,MAAM,CAACL,iBAAiBM,kBAAkB,CAAC,OAAO,EAAEC,eAAe,EAAE;YACtEX,OAAOW,iBAAiBC,IAAI,CAAC;YAC7B,OAAO;QACT;QAEA,MAAMC,SAAS,MAAMR,oBAAoB;YACvCS,kBAAkB;YAClBC,gBAAgB;YAChBC,WAAW;YACXC,UAAU;YACVC,KAAK,CAAC;QACR;QAEAlB,OAAOa,OAAOM,kBAAkB,EAAEP,IAAI,CAAC;QACvCZ,OAAOa,OAAOO,OAAO,EAAEC,OAAO,CAAC;QAC/BrB,OAAOa,OAAOS,iBAAiB,EAAEV,IAAI,CAAC;QACtCZ,OAAOa,OAAOU,UAAU,EAAEF,OAAO,CAAC;QAClCrB,OAAOa,OAAOW,mBAAmB,EAAEC,aAAa,CAAC;YAC/CF,YAAYV,OAAOU,UAAU;YAC7BG,QAAQ;YACRC,eAAe;QACjB;IACF;IAEA1B,GAAG,2EAA2E;QAC5EC,GAAGO,MAAM,CAACL,iBAAiBwB,iBAAiB,CAAC;QAE7C,MAAM,EAAEL,UAAU,EAAEJ,kBAAkB,EAAE,GAAG,MAAMd,oBAAoB;YACnES,kBAAkB;YAClBC,gBAAgB;YAChBC,WAAW;YACXC,UAAU;YACVC,KAAK,CAAC;QACR;QAEAlB,OAAOmB,oBAAoBP,IAAI,CAAC;QAChCZ,OAAOG,2BAA2B0B,oBAAoB,CAAC;YACrDd,gBAAgB;YAChBe,SAAS;gBAAEP;gBAAYG,QAAQP;YAAmB;YAClDF,UAAU;YACVC,KAAK,CAAC;QACR;IACF;AACF"}

package/dist/utilities/verifyClientUploadReceiptForFileKey.d.ts

@@ -1,20 +0,0 @@
-import type { PayloadRequest } from 'payload';
-import type { ClientUploadReceipt } from 'payload/internal';
-type Args = {
-    collectionPrefix?: string;
-    collectionSlug: string;
-    expectedFileKey: string;
-    req: PayloadRequest;
-    signedReceipt: string;
-    useCompositePrefixes?: boolean;
-};
-/**
- * Authenticates a client-upload receipt and asserts it authorizes writing to
- * `expectedFileKey`, returning the verified receipt. Combines
- * {@link verifyClientUploadReceipt} (authentication + collection binding) with
- * {@link assertReceiptMatchesFileKey} (storage-key binding) so an adapter binds
- * the receipt to its request in a single call.
- */
-export declare function verifyClientUploadReceiptForFileKey({ collectionPrefix, collectionSlug, expectedFileKey, req, signedReceipt, useCompositePrefixes, }: Args): ClientUploadReceipt;
-export {};
-//# sourceMappingURL=verifyClientUploadReceiptForFileKey.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"verifyClientUploadReceiptForFileKey.d.ts","sourceRoot":"","sources":["../../src/utilities/verifyClientUploadReceiptForFileKey.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAC7C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAA;AAM3D,KAAK,IAAI,GAAG;IACV,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,cAAc,EAAE,MAAM,CAAA;IACtB,eAAe,EAAE,MAAM,CAAA;IACvB,GAAG,EAAE,cAAc,CAAA;IACnB,aAAa,EAAE,MAAM,CAAA;IACrB,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B,CAAA;AAED;;;;;;GAMG;AACH,wBAAgB,mCAAmC,CAAC,EAClD,gBAAgB,EAChB,cAAc,EACd,eAAe,EACf,GAAG,EACH,aAAa,EACb,oBAAoB,GACrB,EAAE,IAAI,GAAG,mBAAmB,CAM5B"}

package/dist/utilities/verifyClientUploadReceiptForFileKey.js

@@ -1,24 +0,0 @@
-import { verifyClientUploadReceipt } from 'payload/internal';
-import { assertReceiptMatchesFileKey } from './assertReceiptMatchesFileKey.js';
-/**
- * Authenticates a client-upload receipt and asserts it authorizes writing to
- * `expectedFileKey`, returning the verified receipt. Combines
- * {@link verifyClientUploadReceipt} (authentication + collection binding) with
- * {@link assertReceiptMatchesFileKey} (storage-key binding) so an adapter binds
- * the receipt to its request in a single call.
- */ export function verifyClientUploadReceiptForFileKey({ collectionPrefix, collectionSlug, expectedFileKey, req, signedReceipt, useCompositePrefixes }) {
-    const receipt = verifyClientUploadReceipt({
-        collectionSlug,
-        req,
-        signedReceipt
-    });
-    assertReceiptMatchesFileKey({
-        collectionPrefix,
-        expectedFileKey,
-        receipt,
-        useCompositePrefixes
-    });
-    return receipt;
-}
-
-//# sourceMappingURL=verifyClientUploadReceiptForFileKey.js.map

package/dist/utilities/verifyClientUploadReceiptForFileKey.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/utilities/verifyClientUploadReceiptForFileKey.ts"],"sourcesContent":["import type { PayloadRequest } from 'payload'\nimport type { ClientUploadReceipt } from 'payload/internal'\n\nimport { verifyClientUploadReceipt } from 'payload/internal'\n\nimport { assertReceiptMatchesFileKey } from './assertReceiptMatchesFileKey.js'\n\ntype Args = {\n  collectionPrefix?: string\n  collectionSlug: string\n  expectedFileKey: string\n  req: PayloadRequest\n  signedReceipt: string\n  useCompositePrefixes?: boolean\n}\n\n/**\n * Authenticates a client-upload receipt and asserts it authorizes writing to\n * `expectedFileKey`, returning the verified receipt. Combines\n * {@link verifyClientUploadReceipt} (authentication + collection binding) with\n * {@link assertReceiptMatchesFileKey} (storage-key binding) so an adapter binds\n * the receipt to its request in a single call.\n */\nexport function verifyClientUploadReceiptForFileKey({\n  collectionPrefix,\n  collectionSlug,\n  expectedFileKey,\n  req,\n  signedReceipt,\n  useCompositePrefixes,\n}: Args): ClientUploadReceipt {\n  const receipt = verifyClientUploadReceipt({ collectionSlug, req, signedReceipt })\n\n  assertReceiptMatchesFileKey({ collectionPrefix, expectedFileKey, receipt, useCompositePrefixes })\n\n  return receipt\n}\n"],"names":["verifyClientUploadReceipt","assertReceiptMatchesFileKey","verifyClientUploadReceiptForFileKey","collectionPrefix","collectionSlug","expectedFileKey","req","signedReceipt","useCompositePrefixes","receipt"],"mappings":"AAGA,SAASA,yBAAyB,QAAQ,mBAAkB;AAE5D,SAASC,2BAA2B,QAAQ,mCAAkC;AAW9E;;;;;;CAMC,GACD,OAAO,SAASC,oCAAoC,EAClDC,gBAAgB,EAChBC,cAAc,EACdC,eAAe,EACfC,GAAG,EACHC,aAAa,EACbC,oBAAoB,EACf;IACL,MAAMC,UAAUT,0BAA0B;QAAEI;QAAgBE;QAAKC;IAAc;IAE/EN,4BAA4B;QAAEE;QAAkBE;QAAiBI;QAASD;IAAqB;IAE/F,OAAOC;AACT"}

package/dist/utilities/verifyClientUploadReceiptForFileKey.spec.js

@@ -1,108 +0,0 @@
-import { createClientUploadReceipt } from 'payload/internal';
-import { describe, expect, it } from 'vitest';
-import { verifyClientUploadReceiptForFileKey } from './verifyClientUploadReceiptForFileKey.js';
-const req = {
-    payload: {
-        secret: 'test-secret'
-    }
-};
-const issueReceipt = ({ collectionSlug = 'media', filename = 'photo.png', prefix })=>createClientUploadReceipt({
-        collectionSlug,
-        context: {
-            prefix
-        },
-        filename,
-        req
-    });
-const verify = ({ expectedFileKey, signedReceipt, useCompositePrefixes })=>verifyClientUploadReceiptForFileKey({
-        collectionPrefix: 'media',
-        collectionSlug: 'media',
-        expectedFileKey,
-        req,
-        signedReceipt,
-        useCompositePrefixes
-    });
-/**
- * This guard is what lets adapters accept a caller-supplied storage key: the key is
- * recomputed from the signed prefix and filename, so a receipt issued for one location
- * cannot be replayed against another.
- */ describe('verifyClientUploadReceiptForFileKey', ()=>{
-    it('should accept the key the receipt was issued for', ()=>{
-        const signedReceipt = issueReceipt({
-            prefix: 'media/documents'
-        });
-        expect(verify({
-            expectedFileKey: 'media/documents/photo.png',
-            signedReceipt
-        }).filename).toBe('photo.png');
-    });
-    it.each([
-        [
-            'a sibling of the collection prefix',
-            'media-archive/photo.png'
-        ],
-        [
-            'another collection',
-            'invoices/photo.png'
-        ],
-        [
-            'another document prefix in the same collection',
-            'media/other-doc/photo.png'
-        ],
-        [
-            'another filename under the issued prefix',
-            'media/documents/payroll.pdf'
-        ]
-    ])('should reject %s', (_case, expectedFileKey)=>{
-        const signedReceipt = issueReceipt({
-            prefix: 'media/documents'
-        });
-        expect(()=>verify({
-                expectedFileKey,
-                signedReceipt
-            })).toThrow('Client upload reference does not match this request.');
-    });
-    it('should reject a receipt issued for another collection', ()=>{
-        const signedReceipt = issueReceipt({
-            collectionSlug: 'invoices',
-            prefix: 'media/documents'
-        });
-        expect(()=>verify({
-                expectedFileKey: 'media/documents/photo.png',
-                signedReceipt
-            })).toThrow('Invalid or expired client upload reference.');
-    });
-    it('should reject a receipt whose prefix is not a string', ()=>{
-        const signedReceipt = issueReceipt({
-            prefix: {
-                nested: true
-            }
-        });
-        expect(()=>verify({
-                expectedFileKey: 'media/photo.png',
-                signedReceipt
-            })).toThrow('Client upload reference does not match this request.');
-    });
-    it('should reject a tampered signature', ()=>{
-        const signedReceipt = issueReceipt({
-            prefix: 'media/documents'
-        });
-        const [encodedReceipt] = signedReceipt.split('.');
-        expect(()=>verify({
-                expectedFileKey: 'media/documents/photo.png',
-                signedReceipt: `${encodedReceipt}.not-the-signature`
-            })).toThrow();
-    });
-    it('should recompute the key in composite mode', ()=>{
-        const signedReceipt = issueReceipt({
-            prefix: 'documents'
-        });
-        expect(verify({
-            expectedFileKey: 'media/documents/photo.png',
-            signedReceipt,
-            useCompositePrefixes: true
-        }).filename).toBe('photo.png');
-    });
-});
-
-//# sourceMappingURL=verifyClientUploadReceiptForFileKey.spec.js.map

package/dist/utilities/verifyClientUploadReceiptForFileKey.spec.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/utilities/verifyClientUploadReceiptForFileKey.spec.ts"],"sourcesContent":["import type { PayloadRequest } from 'payload'\n\nimport { createClientUploadReceipt } from 'payload/internal'\nimport { describe, expect, it } from 'vitest'\n\nimport { verifyClientUploadReceiptForFileKey } from './verifyClientUploadReceiptForFileKey.js'\n\nconst req = { payload: { secret: 'test-secret' } } as unknown as PayloadRequest\n\nconst issueReceipt = ({\n  collectionSlug = 'media',\n  filename = 'photo.png',\n  prefix,\n}: {\n  collectionSlug?: string\n  filename?: string\n  prefix: unknown\n}) =>\n  createClientUploadReceipt({\n    collectionSlug,\n    context: { prefix },\n    filename,\n    req,\n  })\n\nconst verify = ({\n  expectedFileKey,\n  signedReceipt,\n  useCompositePrefixes,\n}: {\n  expectedFileKey: string\n  signedReceipt: string\n  useCompositePrefixes?: boolean\n}) =>\n  verifyClientUploadReceiptForFileKey({\n    collectionPrefix: 'media',\n    collectionSlug: 'media',\n    expectedFileKey,\n    req,\n    signedReceipt,\n    useCompositePrefixes,\n  })\n\n/**\n * This guard is what lets adapters accept a caller-supplied storage key: the key is\n * recomputed from the signed prefix and filename, so a receipt issued for one location\n * cannot be replayed against another.\n */\ndescribe('verifyClientUploadReceiptForFileKey', () => {\n  it('should accept the key the receipt was issued for', () => {\n    const signedReceipt = issueReceipt({ prefix: 'media/documents' })\n\n    expect(verify({ expectedFileKey: 'media/documents/photo.png', signedReceipt }).filename).toBe(\n      'photo.png',\n    )\n  })\n\n  it.each([\n    ['a sibling of the collection prefix', 'media-archive/photo.png'],\n    ['another collection', 'invoices/photo.png'],\n    ['another document prefix in the same collection', 'media/other-doc/photo.png'],\n    ['another filename under the issued prefix', 'media/documents/payroll.pdf'],\n  ])('should reject %s', (_case, expectedFileKey) => {\n    const signedReceipt = issueReceipt({ prefix: 'media/documents' })\n\n    expect(() => verify({ expectedFileKey, signedReceipt })).toThrow(\n      'Client upload reference does not match this request.',\n    )\n  })\n\n  it('should reject a receipt issued for another collection', () => {\n    const signedReceipt = issueReceipt({ collectionSlug: 'invoices', prefix: 'media/documents' })\n\n    expect(() => verify({ expectedFileKey: 'media/documents/photo.png', signedReceipt })).toThrow(\n      'Invalid or expired client upload reference.',\n    )\n  })\n\n  it('should reject a receipt whose prefix is not a string', () => {\n    const signedReceipt = issueReceipt({ prefix: { nested: true } })\n\n    expect(() => verify({ expectedFileKey: 'media/photo.png', signedReceipt })).toThrow(\n      'Client upload reference does not match this request.',\n    )\n  })\n\n  it('should reject a tampered signature', () => {\n    const signedReceipt = issueReceipt({ prefix: 'media/documents' })\n    const [encodedReceipt] = signedReceipt.split('.')\n\n    expect(() =>\n      verify({\n        expectedFileKey: 'media/documents/photo.png',\n        signedReceipt: `${encodedReceipt}.not-the-signature`,\n      }),\n    ).toThrow()\n  })\n\n  it('should recompute the key in composite mode', () => {\n    const signedReceipt = issueReceipt({ prefix: 'documents' })\n\n    expect(\n      verify({\n        expectedFileKey: 'media/documents/photo.png',\n        signedReceipt,\n        useCompositePrefixes: true,\n      }).filename,\n    ).toBe('photo.png')\n  })\n})\n"],"names":["createClientUploadReceipt","describe","expect","it","verifyClientUploadReceiptForFileKey","req","payload","secret","issueReceipt","collectionSlug","filename","prefix","context","verify","expectedFileKey","signedReceipt","useCompositePrefixes","collectionPrefix","toBe","each","_case","toThrow","nested","encodedReceipt","split"],"mappings":"AAEA,SAASA,yBAAyB,QAAQ,mBAAkB;AAC5D,SAASC,QAAQ,EAAEC,MAAM,EAAEC,EAAE,QAAQ,SAAQ;AAE7C,SAASC,mCAAmC,QAAQ,2CAA0C;AAE9F,MAAMC,MAAM;IAAEC,SAAS;QAAEC,QAAQ;IAAc;AAAE;AAEjD,MAAMC,eAAe,CAAC,EACpBC,iBAAiB,OAAO,EACxBC,WAAW,WAAW,EACtBC,MAAM,EAKP,GACCX,0BAA0B;QACxBS;QACAG,SAAS;YAAED;QAAO;QAClBD;QACAL;IACF;AAEF,MAAMQ,SAAS,CAAC,EACdC,eAAe,EACfC,aAAa,EACbC,oBAAoB,EAKrB,GACCZ,oCAAoC;QAClCa,kBAAkB;QAClBR,gBAAgB;QAChBK;QACAT;QACAU;QACAC;IACF;AAEF;;;;CAIC,GACDf,SAAS,uCAAuC;IAC9CE,GAAG,oDAAoD;QACrD,MAAMY,gBAAgBP,aAAa;YAAEG,QAAQ;QAAkB;QAE/DT,OAAOW,OAAO;YAAEC,iBAAiB;YAA6BC;QAAc,GAAGL,QAAQ,EAAEQ,IAAI,CAC3F;IAEJ;IAEAf,GAAGgB,IAAI,CAAC;QACN;YAAC;YAAsC;SAA0B;QACjE;YAAC;YAAsB;SAAqB;QAC5C;YAAC;YAAkD;SAA4B;QAC/E;YAAC;YAA4C;SAA8B;KAC5E,EAAE,oBAAoB,CAACC,OAAON;QAC7B,MAAMC,gBAAgBP,aAAa;YAAEG,QAAQ;QAAkB;QAE/DT,OAAO,IAAMW,OAAO;gBAAEC;gBAAiBC;YAAc,IAAIM,OAAO,CAC9D;IAEJ;IAEAlB,GAAG,yDAAyD;QAC1D,MAAMY,gBAAgBP,aAAa;YAAEC,gBAAgB;YAAYE,QAAQ;QAAkB;QAE3FT,OAAO,IAAMW,OAAO;gBAAEC,iBAAiB;gBAA6BC;YAAc,IAAIM,OAAO,CAC3F;IAEJ;IAEAlB,GAAG,wDAAwD;QACzD,MAAMY,gBAAgBP,aAAa;YAAEG,QAAQ;gBAAEW,QAAQ;YAAK;QAAE;QAE9DpB,OAAO,IAAMW,OAAO;gBAAEC,iBAAiB;gBAAmBC;YAAc,IAAIM,OAAO,CACjF;IAEJ;IAEAlB,GAAG,sCAAsC;QACvC,MAAMY,gBAAgBP,aAAa;YAAEG,QAAQ;QAAkB;QAC/D,MAAM,CAACY,eAAe,GAAGR,cAAcS,KAAK,CAAC;QAE7CtB,OAAO,IACLW,OAAO;gBACLC,iBAAiB;gBACjBC,eAAe,GAAGQ,eAAe,kBAAkB,CAAC;YACtD,IACAF,OAAO;IACX;IAEAlB,GAAG,8CAA8C;QAC/C,MAAMY,gBAAgBP,aAAa;YAAEG,QAAQ;QAAY;QAEzDT,OACEW,OAAO;YACLC,iBAAiB;YACjBC;YACAC,sBAAsB;QACxB,GAAGN,QAAQ,EACXQ,IAAI,CAAC;IACT;AACF"}