@payloadcms/storage-vercel-blob 3.25.0-canary.f62445f → 3.25.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -0
- package/dist/client/VercelBlobClientUploadHandler.d.ts +13 -0
- package/dist/client/VercelBlobClientUploadHandler.d.ts.map +1 -0
- package/dist/client/VercelBlobClientUploadHandler.js +19 -0
- package/dist/client/VercelBlobClientUploadHandler.js.map +1 -0
- package/dist/exports/client.d.ts +2 -0
- package/dist/exports/client.d.ts.map +1 -0
- package/dist/exports/client.js +3 -0
- package/dist/exports/client.js.map +1 -0
- package/dist/getClientUploadRoute.d.ts +13 -0
- package/dist/getClientUploadRoute.d.ts.map +1 -0
- package/dist/getClientUploadRoute.js +35 -0
- package/dist/getClientUploadRoute.js.map +1 -0
- package/dist/index.d.ts +6 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +20 -0
- package/dist/index.js.map +1 -1
- package/dist/staticHandler.d.ts.map +1 -1
- package/dist/staticHandler.js.map +1 -1
- package/package.json +9 -4
package/README.md
CHANGED
|
@@ -15,6 +15,7 @@ pnpm add @payloadcms/storage-vercel-blob
|
|
|
15
15
|
- Configure the `collections` object to specify which collections should use the Vercel Blob adapter. The slug _must_ match one of your existing collection slugs.
|
|
16
16
|
- Ensure you have `BLOB_READ_WRITE_TOKEN` set in your Vercel environment variables. This is usually set by Vercel automatically after adding blob storage to your project.
|
|
17
17
|
- When enabled, this package will automatically set `disableLocalStorage` to `true` for each collection.
|
|
18
|
+
- When deploying to Vercel, server uploads are limited with 4.5MB. Set `clientUploads` to `true` to do uploads directly on the client.
|
|
18
19
|
|
|
19
20
|
```ts
|
|
20
21
|
import { vercelBlobStorage } from '@payloadcms/storage-vercel-blob'
|
|
@@ -47,3 +48,4 @@ export default buildConfig({
|
|
|
47
48
|
| `addRandomSuffix` | Add a random suffix to the uploaded file name in Vercel Blob storage | `false` |
|
|
48
49
|
| `cacheControlMaxAge` | Cache-Control max-age in seconds | `365 * 24 * 60 * 60` (1 Year) |
|
|
49
50
|
| `token` | Vercel Blob storage read/write token | `''` |
|
|
51
|
+
| `clientUploads` | Do uploads directly on the client to bypass limits on Vercel | |
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
export type VercelBlobClientUploadHandlerExtra = {
|
|
2
|
+
addRandomSuffix: boolean;
|
|
3
|
+
baseURL: string;
|
|
4
|
+
prefix: string;
|
|
5
|
+
};
|
|
6
|
+
export declare const VercelBlobClientUploadHandler: ({ children, collectionSlug, enabled, extra, serverHandlerPath, }: {
|
|
7
|
+
children: import("react").ReactNode;
|
|
8
|
+
collectionSlug: import("payload").UploadCollectionSlug;
|
|
9
|
+
enabled?: boolean;
|
|
10
|
+
extra: VercelBlobClientUploadHandlerExtra;
|
|
11
|
+
serverHandlerPath: string;
|
|
12
|
+
}) => import("react").JSX.Element;
|
|
13
|
+
//# sourceMappingURL=VercelBlobClientUploadHandler.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"VercelBlobClientUploadHandler.d.ts","sourceRoot":"","sources":["../../src/client/VercelBlobClientUploadHandler.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,kCAAkC,GAAG;IAC/C,eAAe,EAAE,OAAO,CAAA;IACxB,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED,eAAO,MAAM,6BAA6B;;;;;;aAeG,OAAO,aAQhD,CAAA"}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
'use client';
|
|
2
|
+
import { createClientUploadHandler } from '@payloadcms/plugin-cloud-storage/client';
|
|
3
|
+
import { upload } from '@vercel/blob/client';
|
|
4
|
+
export const VercelBlobClientUploadHandler = createClientUploadHandler({
|
|
5
|
+
handler: async ({ apiRoute, collectionSlug, extra: { addRandomSuffix, baseURL, prefix = '' }, file, serverHandlerPath, serverURL, updateFilename })=>{
|
|
6
|
+
const result = await upload(`${prefix}${file.name}`, file, {
|
|
7
|
+
access: 'public',
|
|
8
|
+
clientPayload: collectionSlug,
|
|
9
|
+
contentType: file.type,
|
|
10
|
+
handleUploadUrl: `${serverURL}${apiRoute}${serverHandlerPath}`
|
|
11
|
+
});
|
|
12
|
+
// Update filename with suffix from returned url
|
|
13
|
+
if (addRandomSuffix) {
|
|
14
|
+
updateFilename(result.url.replace(`${baseURL}/`, ''));
|
|
15
|
+
}
|
|
16
|
+
}
|
|
17
|
+
});
|
|
18
|
+
|
|
19
|
+
//# sourceMappingURL=VercelBlobClientUploadHandler.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../src/client/VercelBlobClientUploadHandler.ts"],"sourcesContent":["'use client'\nimport { createClientUploadHandler } from '@payloadcms/plugin-cloud-storage/client'\nimport { upload } from '@vercel/blob/client'\n\nexport type VercelBlobClientUploadHandlerExtra = {\n addRandomSuffix: boolean\n baseURL: string\n prefix: string\n}\n\nexport const VercelBlobClientUploadHandler =\n createClientUploadHandler<VercelBlobClientUploadHandlerExtra>({\n handler: async ({\n apiRoute,\n collectionSlug,\n extra: { addRandomSuffix, baseURL, prefix = '' },\n file,\n serverHandlerPath,\n serverURL,\n updateFilename,\n }) => {\n const result = await upload(`${prefix}${file.name}`, file, {\n access: 'public',\n clientPayload: collectionSlug,\n contentType: file.type,\n handleUploadUrl: `${serverURL}${apiRoute}${serverHandlerPath}`,\n })\n\n // Update filename with suffix from returned url\n if (addRandomSuffix) {\n updateFilename(result.url.replace(`${baseURL}/`, ''))\n }\n },\n })\n"],"names":["createClientUploadHandler","upload","VercelBlobClientUploadHandler","handler","apiRoute","collectionSlug","extra","addRandomSuffix","baseURL","prefix","file","serverHandlerPath","serverURL","updateFilename","result","name","access","clientPayload","contentType","type","handleUploadUrl","url","replace"],"mappings":"AAAA;AACA,SAASA,yBAAyB,QAAQ,0CAAyC;AACnF,SAASC,MAAM,QAAQ,sBAAqB;AAQ5C,OAAO,MAAMC,gCACXF,0BAA8D;IAC5DG,SAAS,OAAO,EACdC,QAAQ,EACRC,cAAc,EACdC,OAAO,EAAEC,eAAe,EAAEC,OAAO,EAAEC,SAAS,EAAE,EAAE,EAChDC,IAAI,EACJC,iBAAiB,EACjBC,SAAS,EACTC,cAAc,EACf;QACC,MAAMC,SAAS,MAAMb,OAAO,GAAGQ,SAASC,KAAKK,IAAI,EAAE,EAAEL,MAAM;YACzDM,QAAQ;YACRC,eAAeZ;YACfa,aAAaR,KAAKS,IAAI;YACtBC,iBAAiB,GAAGR,YAAYR,WAAWO,mBAAmB;QAChE;QAEA,gDAAgD;QAChD,IAAIJ,iBAAiB;YACnBM,eAAeC,OAAOO,GAAG,CAACC,OAAO,CAAC,GAAGd,QAAQ,CAAC,CAAC,EAAE;QACnD;IACF;AACF,GAAE"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/exports/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,6BAA6B,EAAE,MAAM,4CAA4C,CAAA"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../src/exports/client.ts"],"sourcesContent":["export { VercelBlobClientUploadHandler } from '../client/VercelBlobClientUploadHandler.js'\n"],"names":["VercelBlobClientUploadHandler"],"mappings":"AAAA,SAASA,6BAA6B,QAAQ,6CAA4C"}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import type { PayloadHandler, PayloadRequest, UploadCollectionSlug } from 'payload';
|
|
2
|
+
type Args = {
|
|
3
|
+
access?: (args: {
|
|
4
|
+
collectionSlug: UploadCollectionSlug;
|
|
5
|
+
req: PayloadRequest;
|
|
6
|
+
}) => boolean | Promise<boolean>;
|
|
7
|
+
addRandomSuffix?: boolean;
|
|
8
|
+
cacheControlMaxAge?: number;
|
|
9
|
+
token: string;
|
|
10
|
+
};
|
|
11
|
+
export declare const getClientUploadRoute: ({ access, addRandomSuffix, cacheControlMaxAge, token }: Args) => PayloadHandler;
|
|
12
|
+
export {};
|
|
13
|
+
//# sourceMappingURL=getClientUploadRoute.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"getClientUploadRoute.d.ts","sourceRoot":"","sources":["../src/getClientUploadRoute.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAKnF,KAAK,IAAI,GAAG;IACV,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE;QACd,cAAc,EAAE,oBAAoB,CAAA;QACpC,GAAG,EAAE,cAAc,CAAA;KACpB,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAChC,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAID,eAAO,MAAM,oBAAoB,2DAC0C,IAAI,KAAG,cA+B/E,CAAA"}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { handleUpload } from '@vercel/blob/client';
|
|
2
|
+
import { APIError, Forbidden } from 'payload';
|
|
3
|
+
const defaultAccess = ({ req })=>!!req.user;
|
|
4
|
+
export const getClientUploadRoute = ({ access = defaultAccess, addRandomSuffix, cacheControlMaxAge, token })=>async (req)=>{
|
|
5
|
+
const body = await req.json();
|
|
6
|
+
try {
|
|
7
|
+
const jsonResponse = await handleUpload({
|
|
8
|
+
body,
|
|
9
|
+
onBeforeGenerateToken: async (_pathname, collectionSlug)=>{
|
|
10
|
+
if (!collectionSlug) {
|
|
11
|
+
throw new APIError('No payload was provided');
|
|
12
|
+
}
|
|
13
|
+
if (!await access({
|
|
14
|
+
collectionSlug,
|
|
15
|
+
req
|
|
16
|
+
})) {
|
|
17
|
+
throw new Forbidden();
|
|
18
|
+
}
|
|
19
|
+
return Promise.resolve({
|
|
20
|
+
addRandomSuffix,
|
|
21
|
+
cacheControlMaxAge
|
|
22
|
+
});
|
|
23
|
+
},
|
|
24
|
+
onUploadCompleted: async ()=>{},
|
|
25
|
+
request: req,
|
|
26
|
+
token
|
|
27
|
+
});
|
|
28
|
+
return Response.json(jsonResponse);
|
|
29
|
+
} catch (error) {
|
|
30
|
+
req.payload.logger.error(error);
|
|
31
|
+
throw new APIError('storage-vercel-blob client upload route error');
|
|
32
|
+
}
|
|
33
|
+
};
|
|
34
|
+
|
|
35
|
+
//# sourceMappingURL=getClientUploadRoute.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/getClientUploadRoute.ts"],"sourcesContent":["import type { PayloadHandler, PayloadRequest, UploadCollectionSlug } from 'payload'\n\nimport { handleUpload, type HandleUploadBody } from '@vercel/blob/client'\nimport { APIError, Forbidden } from 'payload'\n\ntype Args = {\n access?: (args: {\n collectionSlug: UploadCollectionSlug\n req: PayloadRequest\n }) => boolean | Promise<boolean>\n addRandomSuffix?: boolean\n cacheControlMaxAge?: number\n token: string\n}\n\nconst defaultAccess: Args['access'] = ({ req }) => !!req.user\n\nexport const getClientUploadRoute =\n ({ access = defaultAccess, addRandomSuffix, cacheControlMaxAge, token }: Args): PayloadHandler =>\n async (req) => {\n const body = (await req.json!()) as HandleUploadBody\n\n try {\n const jsonResponse = await handleUpload({\n body,\n onBeforeGenerateToken: async (_pathname: string, collectionSlug: null | string) => {\n if (!collectionSlug) {\n throw new APIError('No payload was provided')\n }\n\n if (!(await access({ collectionSlug, req }))) {\n throw new Forbidden()\n }\n\n return Promise.resolve({\n addRandomSuffix,\n cacheControlMaxAge,\n })\n },\n onUploadCompleted: async () => {},\n request: req as Request,\n token,\n })\n\n return Response.json(jsonResponse)\n } catch (error) {\n req.payload.logger.error(error)\n throw new APIError('storage-vercel-blob client upload route error')\n }\n }\n"],"names":["handleUpload","APIError","Forbidden","defaultAccess","req","user","getClientUploadRoute","access","addRandomSuffix","cacheControlMaxAge","token","body","json","jsonResponse","onBeforeGenerateToken","_pathname","collectionSlug","Promise","resolve","onUploadCompleted","request","Response","error","payload","logger"],"mappings":"AAEA,SAASA,YAAY,QAA+B,sBAAqB;AACzE,SAASC,QAAQ,EAAEC,SAAS,QAAQ,UAAS;AAY7C,MAAMC,gBAAgC,CAAC,EAAEC,GAAG,EAAE,GAAK,CAAC,CAACA,IAAIC,IAAI;AAE7D,OAAO,MAAMC,uBACX,CAAC,EAAEC,SAASJ,aAAa,EAAEK,eAAe,EAAEC,kBAAkB,EAAEC,KAAK,EAAQ,GAC7E,OAAON;QACL,MAAMO,OAAQ,MAAMP,IAAIQ,IAAI;QAE5B,IAAI;YACF,MAAMC,eAAe,MAAMb,aAAa;gBACtCW;gBACAG,uBAAuB,OAAOC,WAAmBC;oBAC/C,IAAI,CAACA,gBAAgB;wBACnB,MAAM,IAAIf,SAAS;oBACrB;oBAEA,IAAI,CAAE,MAAMM,OAAO;wBAAES;wBAAgBZ;oBAAI,IAAK;wBAC5C,MAAM,IAAIF;oBACZ;oBAEA,OAAOe,QAAQC,OAAO,CAAC;wBACrBV;wBACAC;oBACF;gBACF;gBACAU,mBAAmB,WAAa;gBAChCC,SAAShB;gBACTM;YACF;YAEA,OAAOW,SAAST,IAAI,CAACC;QACvB,EAAE,OAAOS,OAAO;YACdlB,IAAImB,OAAO,CAACC,MAAM,CAACF,KAAK,CAACA;YACzB,MAAM,IAAIrB,SAAS;QACrB;IACF,EAAC"}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { CollectionOptions } from '@payloadcms/plugin-cloud-storage/types';
|
|
1
|
+
import type { ClientUploadsConfig, CollectionOptions } from '@payloadcms/plugin-cloud-storage/types';
|
|
2
2
|
import type { Plugin, UploadCollectionSlug } from 'payload';
|
|
3
3
|
export type VercelBlobStorageOptions = {
|
|
4
4
|
/**
|
|
@@ -17,9 +17,13 @@ export type VercelBlobStorageOptions = {
|
|
|
17
17
|
/**
|
|
18
18
|
* Cache-Control max-age in seconds
|
|
19
19
|
*
|
|
20
|
-
* @
|
|
20
|
+
* @default 365 * 24 * 60 * 60 // (1 Year)
|
|
21
21
|
*/
|
|
22
22
|
cacheControlMaxAge?: number;
|
|
23
|
+
/**
|
|
24
|
+
* Do uploads directly on the client, to bypass limits on Vercel.
|
|
25
|
+
*/
|
|
26
|
+
clientUploads?: ClientUploadsConfig;
|
|
23
27
|
/**
|
|
24
28
|
* Collections to apply the Vercel Blob adapter to
|
|
25
29
|
*/
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,mBAAmB,EAEnB,iBAAiB,EAElB,MAAM,wCAAwC,CAAA;AAC/C,OAAO,KAAK,EAAU,MAAM,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAanE,MAAM,MAAM,wBAAwB,GAAG;IACrC;;;;;OAKG;IACH,MAAM,CAAC,EAAE,QAAQ,CAAA;IAEjB;;;;OAIG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IAEzB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,mBAAmB,CAAA;IAEnC;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC,MAAM,CAAC,oBAAoB,EAAE,IAAI,CAAC,iBAAiB,EAAE,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC,CAAA;IAE7F;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IAEjB;;;;;;OAMG;IACH,KAAK,EAAE,MAAM,GAAG,SAAS,CAAA;CAC1B,CAAA;AASD,KAAK,uBAAuB,GAAG,CAAC,qBAAqB,EAAE,wBAAwB,KAAK,MAAM,CAAA;AAE1F,eAAO,MAAM,iBAAiB,EAAE,uBAoF7B,CAAA"}
|
package/dist/index.js
CHANGED
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
import { cloudStoragePlugin } from '@payloadcms/plugin-cloud-storage';
|
|
2
|
+
import { initClientUploads } from '@payloadcms/plugin-cloud-storage/utilities';
|
|
2
3
|
import { getGenerateUrl } from './generateURL.js';
|
|
4
|
+
import { getClientUploadRoute } from './getClientUploadRoute.js';
|
|
3
5
|
import { getHandleDelete } from './handleDelete.js';
|
|
4
6
|
import { getHandleUpload } from './handleUpload.js';
|
|
5
7
|
import { getStaticHandler } from './staticHandler.js';
|
|
@@ -24,6 +26,24 @@ export const vercelBlobStorage = (options)=>(incomingConfig)=>{
|
|
|
24
26
|
...options
|
|
25
27
|
};
|
|
26
28
|
const baseUrl = `https://${storeId}.${optionsWithDefaults.access}.blob.vercel-storage.com`;
|
|
29
|
+
initClientUploads({
|
|
30
|
+
clientHandler: '@payloadcms/storage-vercel-blob/client#VercelBlobClientUploadHandler',
|
|
31
|
+
collections: options.collections,
|
|
32
|
+
config: incomingConfig,
|
|
33
|
+
enabled: !!options.clientUploads,
|
|
34
|
+
extraClientHandlerProps: (collection)=>({
|
|
35
|
+
addRandomSuffix: !!optionsWithDefaults.addRandomSuffix,
|
|
36
|
+
baseURL: baseUrl,
|
|
37
|
+
prefix: typeof collection === 'object' && collection.prefix || ''
|
|
38
|
+
}),
|
|
39
|
+
serverHandler: getClientUploadRoute({
|
|
40
|
+
access: typeof options.clientUploads === 'object' ? options.clientUploads.access : undefined,
|
|
41
|
+
addRandomSuffix: optionsWithDefaults.addRandomSuffix,
|
|
42
|
+
cacheControlMaxAge: options.cacheControlMaxAge,
|
|
43
|
+
token: options.token
|
|
44
|
+
}),
|
|
45
|
+
serverHandlerPath: '/vercel-blob-client-upload-route'
|
|
46
|
+
});
|
|
27
47
|
const adapter = vercelBlobStorageInternal({
|
|
28
48
|
...optionsWithDefaults,
|
|
29
49
|
baseUrl
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type {\n Adapter,\n PluginOptions as CloudStoragePluginOptions,\n CollectionOptions,\n GeneratedAdapter,\n} from '@payloadcms/plugin-cloud-storage/types'\nimport type { Config, Plugin, UploadCollectionSlug } from 'payload'\n\nimport { cloudStoragePlugin } from '@payloadcms/plugin-cloud-storage'\n\nimport { getGenerateUrl } from './generateURL.js'\nimport { getHandleDelete } from './handleDelete.js'\nimport { getHandleUpload } from './handleUpload.js'\nimport { getStaticHandler } from './staticHandler.js'\n\nexport type VercelBlobStorageOptions = {\n /**\n * Access control level. Currently, only 'public' is supported.\n * Vercel plans on adding support for private blobs in the future.\n *\n * @default 'public'\n */\n access?: 'public'\n\n /**\n * Add a random suffix to the uploaded file name in Vercel Blob storage\n *\n * @default false\n */\n addRandomSuffix?: boolean\n\n /**\n * Cache-Control max-age in seconds\n *\n * @
|
|
1
|
+
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type {\n Adapter,\n ClientUploadsConfig,\n PluginOptions as CloudStoragePluginOptions,\n CollectionOptions,\n GeneratedAdapter,\n} from '@payloadcms/plugin-cloud-storage/types'\nimport type { Config, Plugin, UploadCollectionSlug } from 'payload'\n\nimport { cloudStoragePlugin } from '@payloadcms/plugin-cloud-storage'\nimport { initClientUploads } from '@payloadcms/plugin-cloud-storage/utilities'\n\nimport type { VercelBlobClientUploadHandlerExtra } from './client/VercelBlobClientUploadHandler.js'\n\nimport { getGenerateUrl } from './generateURL.js'\nimport { getClientUploadRoute } from './getClientUploadRoute.js'\nimport { getHandleDelete } from './handleDelete.js'\nimport { getHandleUpload } from './handleUpload.js'\nimport { getStaticHandler } from './staticHandler.js'\n\nexport type VercelBlobStorageOptions = {\n /**\n * Access control level. Currently, only 'public' is supported.\n * Vercel plans on adding support for private blobs in the future.\n *\n * @default 'public'\n */\n access?: 'public'\n\n /**\n * Add a random suffix to the uploaded file name in Vercel Blob storage\n *\n * @default false\n */\n addRandomSuffix?: boolean\n\n /**\n * Cache-Control max-age in seconds\n *\n * @default 365 * 24 * 60 * 60 // (1 Year)\n */\n cacheControlMaxAge?: number\n\n /**\n * Do uploads directly on the client, to bypass limits on Vercel.\n */\n clientUploads?: ClientUploadsConfig\n\n /**\n * Collections to apply the Vercel Blob adapter to\n */\n collections: Partial<Record<UploadCollectionSlug, Omit<CollectionOptions, 'adapter'> | true>>\n\n /**\n * Whether or not to enable the plugin\n *\n * Default: true\n */\n enabled?: boolean\n\n /**\n * Vercel Blob storage read/write token\n *\n * Usually process.env.BLOB_READ_WRITE_TOKEN set by Vercel\n *\n * If unset, the plugin will be disabled and will fallback to local storage\n */\n token: string | undefined\n}\n\nconst defaultUploadOptions: Partial<VercelBlobStorageOptions> = {\n access: 'public',\n addRandomSuffix: false,\n cacheControlMaxAge: 60 * 60 * 24 * 365, // 1 year\n enabled: true,\n}\n\ntype VercelBlobStoragePlugin = (vercelBlobStorageOpts: VercelBlobStorageOptions) => Plugin\n\nexport const vercelBlobStorage: VercelBlobStoragePlugin =\n (options: VercelBlobStorageOptions) =>\n (incomingConfig: Config): Config => {\n // If the plugin is disabled or no token is provided, do not enable the plugin\n if (options.enabled === false || !options.token) {\n return incomingConfig\n }\n\n // Parse storeId from token\n const storeId = options.token.match(/^vercel_blob_rw_([a-z\\d]+)_[a-z\\d]+$/i)?.[1]?.toLowerCase()\n\n if (!storeId) {\n throw new Error(\n 'Invalid token format for Vercel Blob adapter. Should be vercel_blob_rw_<store_id>_<random_string>.',\n )\n }\n\n const optionsWithDefaults = {\n ...defaultUploadOptions,\n ...options,\n }\n\n const baseUrl = `https://${storeId}.${optionsWithDefaults.access}.blob.vercel-storage.com`\n\n initClientUploads<\n VercelBlobClientUploadHandlerExtra,\n VercelBlobStorageOptions['collections'][string]\n >({\n clientHandler: '@payloadcms/storage-vercel-blob/client#VercelBlobClientUploadHandler',\n collections: options.collections,\n config: incomingConfig,\n enabled: !!options.clientUploads,\n extraClientHandlerProps: (collection) => ({\n addRandomSuffix: !!optionsWithDefaults.addRandomSuffix,\n baseURL: baseUrl,\n prefix: (typeof collection === 'object' && collection.prefix) || '',\n }),\n serverHandler: getClientUploadRoute({\n access:\n typeof options.clientUploads === 'object' ? options.clientUploads.access : undefined,\n addRandomSuffix: optionsWithDefaults.addRandomSuffix,\n cacheControlMaxAge: options.cacheControlMaxAge,\n token: options.token,\n }),\n serverHandlerPath: '/vercel-blob-client-upload-route',\n })\n\n const adapter = vercelBlobStorageInternal({ ...optionsWithDefaults, baseUrl })\n\n // Add adapter to each collection option object\n const collectionsWithAdapter: CloudStoragePluginOptions['collections'] = Object.entries(\n options.collections,\n ).reduce(\n (acc, [slug, collOptions]) => ({\n ...acc,\n [slug]: {\n ...(collOptions === true ? {} : collOptions),\n adapter,\n },\n }),\n {} as Record<string, CollectionOptions>,\n )\n\n // Set disableLocalStorage: true for collections specified in the plugin options\n const config = {\n ...incomingConfig,\n collections: (incomingConfig.collections || []).map((collection) => {\n if (!collectionsWithAdapter[collection.slug]) {\n return collection\n }\n\n return {\n ...collection,\n upload: {\n ...(typeof collection.upload === 'object' ? collection.upload : {}),\n disableLocalStorage: true,\n },\n }\n }),\n }\n\n return cloudStoragePlugin({\n collections: collectionsWithAdapter,\n })(config)\n }\n\nfunction vercelBlobStorageInternal(\n options: { baseUrl: string } & VercelBlobStorageOptions,\n): Adapter {\n return ({ collection, prefix }): GeneratedAdapter => {\n const { access, addRandomSuffix, baseUrl, cacheControlMaxAge, token } = options\n\n if (!token) {\n throw new Error('Vercel Blob storage token is required')\n }\n\n return {\n name: 'vercel-blob',\n generateURL: getGenerateUrl({ baseUrl, prefix }),\n handleDelete: getHandleDelete({ baseUrl, prefix, token }),\n handleUpload: getHandleUpload({\n access,\n addRandomSuffix,\n baseUrl,\n cacheControlMaxAge,\n prefix,\n token,\n }),\n staticHandler: getStaticHandler({ baseUrl, cacheControlMaxAge, token }, collection),\n }\n }\n}\n"],"names":["cloudStoragePlugin","initClientUploads","getGenerateUrl","getClientUploadRoute","getHandleDelete","getHandleUpload","getStaticHandler","defaultUploadOptions","access","addRandomSuffix","cacheControlMaxAge","enabled","vercelBlobStorage","options","incomingConfig","token","storeId","match","toLowerCase","Error","optionsWithDefaults","baseUrl","clientHandler","collections","config","clientUploads","extraClientHandlerProps","collection","baseURL","prefix","serverHandler","undefined","serverHandlerPath","adapter","vercelBlobStorageInternal","collectionsWithAdapter","Object","entries","reduce","acc","slug","collOptions","map","upload","disableLocalStorage","name","generateURL","handleDelete","handleUpload","staticHandler"],"mappings":"AASA,SAASA,kBAAkB,QAAQ,mCAAkC;AACrE,SAASC,iBAAiB,QAAQ,6CAA4C;AAI9E,SAASC,cAAc,QAAQ,mBAAkB;AACjD,SAASC,oBAAoB,QAAQ,4BAA2B;AAChE,SAASC,eAAe,QAAQ,oBAAmB;AACnD,SAASC,eAAe,QAAQ,oBAAmB;AACnD,SAASC,gBAAgB,QAAQ,qBAAoB;AAoDrD,MAAMC,uBAA0D;IAC9DC,QAAQ;IACRC,iBAAiB;IACjBC,oBAAoB,KAAK,KAAK,KAAK;IACnCC,SAAS;AACX;AAIA,OAAO,MAAMC,oBACX,CAACC,UACD,CAACC;QACC,8EAA8E;QAC9E,IAAID,QAAQF,OAAO,KAAK,SAAS,CAACE,QAAQE,KAAK,EAAE;YAC/C,OAAOD;QACT;QAEA,2BAA2B;QAC3B,MAAME,UAAUH,QAAQE,KAAK,CAACE,KAAK,CAAC,0CAA0C,CAAC,EAAE,EAAEC;QAEnF,IAAI,CAACF,SAAS;YACZ,MAAM,IAAIG,MACR;QAEJ;QAEA,MAAMC,sBAAsB;YAC1B,GAAGb,oBAAoB;YACvB,GAAGM,OAAO;QACZ;QAEA,MAAMQ,UAAU,CAAC,QAAQ,EAAEL,QAAQ,CAAC,EAAEI,oBAAoBZ,MAAM,CAAC,wBAAwB,CAAC;QAE1FP,kBAGE;YACAqB,eAAe;YACfC,aAAaV,QAAQU,WAAW;YAChCC,QAAQV;YACRH,SAAS,CAAC,CAACE,QAAQY,aAAa;YAChCC,yBAAyB,CAACC,aAAgB,CAAA;oBACxClB,iBAAiB,CAAC,CAACW,oBAAoBX,eAAe;oBACtDmB,SAASP;oBACTQ,QAAQ,AAAC,OAAOF,eAAe,YAAYA,WAAWE,MAAM,IAAK;gBACnE,CAAA;YACAC,eAAe3B,qBAAqB;gBAClCK,QACE,OAAOK,QAAQY,aAAa,KAAK,WAAWZ,QAAQY,aAAa,CAACjB,MAAM,GAAGuB;gBAC7EtB,iBAAiBW,oBAAoBX,eAAe;gBACpDC,oBAAoBG,QAAQH,kBAAkB;gBAC9CK,OAAOF,QAAQE,KAAK;YACtB;YACAiB,mBAAmB;QACrB;QAEA,MAAMC,UAAUC,0BAA0B;YAAE,GAAGd,mBAAmB;YAAEC;QAAQ;QAE5E,+CAA+C;QAC/C,MAAMc,yBAAmEC,OAAOC,OAAO,CACrFxB,QAAQU,WAAW,EACnBe,MAAM,CACN,CAACC,KAAK,CAACC,MAAMC,YAAY,GAAM,CAAA;gBAC7B,GAAGF,GAAG;gBACN,CAACC,KAAK,EAAE;oBACN,GAAIC,gBAAgB,OAAO,CAAC,IAAIA,WAAW;oBAC3CR;gBACF;YACF,CAAA,GACA,CAAC;QAGH,gFAAgF;QAChF,MAAMT,SAAS;YACb,GAAGV,cAAc;YACjBS,aAAa,AAACT,CAAAA,eAAeS,WAAW,IAAI,EAAE,AAAD,EAAGmB,GAAG,CAAC,CAACf;gBACnD,IAAI,CAACQ,sBAAsB,CAACR,WAAWa,IAAI,CAAC,EAAE;oBAC5C,OAAOb;gBACT;gBAEA,OAAO;oBACL,GAAGA,UAAU;oBACbgB,QAAQ;wBACN,GAAI,OAAOhB,WAAWgB,MAAM,KAAK,WAAWhB,WAAWgB,MAAM,GAAG,CAAC,CAAC;wBAClEC,qBAAqB;oBACvB;gBACF;YACF;QACF;QAEA,OAAO5C,mBAAmB;YACxBuB,aAAaY;QACf,GAAGX;IACL,EAAC;AAEH,SAASU,0BACPrB,OAAuD;IAEvD,OAAO,CAAC,EAAEc,UAAU,EAAEE,MAAM,EAAE;QAC5B,MAAM,EAAErB,MAAM,EAAEC,eAAe,EAAEY,OAAO,EAAEX,kBAAkB,EAAEK,KAAK,EAAE,GAAGF;QAExE,IAAI,CAACE,OAAO;YACV,MAAM,IAAII,MAAM;QAClB;QAEA,OAAO;YACL0B,MAAM;YACNC,aAAa5C,eAAe;gBAAEmB;gBAASQ;YAAO;YAC9CkB,cAAc3C,gBAAgB;gBAAEiB;gBAASQ;gBAAQd;YAAM;YACvDiC,cAAc3C,gBAAgB;gBAC5BG;gBACAC;gBACAY;gBACAX;gBACAmB;gBACAd;YACF;YACAkC,eAAe3C,iBAAiB;gBAAEe;gBAASX;gBAAoBK;YAAM,GAAGY;QAC1E;IACF;AACF"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"staticHandler.d.ts","sourceRoot":"","sources":["../src/staticHandler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wCAAwC,CAAA;AAC3E,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AAM/C,KAAK,iBAAiB,GAAG;IACvB,OAAO,EAAE,MAAM,CAAA;IACf,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,eAAO,MAAM,gBAAgB,2CACiB,iBAAiB,cACjD,gBAAgB,KAC3B,
|
|
1
|
+
{"version":3,"file":"staticHandler.d.ts","sourceRoot":"","sources":["../src/staticHandler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wCAAwC,CAAA;AAC3E,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AAM/C,KAAK,iBAAiB,GAAG;IACvB,OAAO,EAAE,MAAM,CAAA;IACf,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,eAAO,MAAM,gBAAgB,2CACiB,iBAAiB,cACjD,gBAAgB,KAC3B,aA0DF,CAAA"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/staticHandler.ts"],"sourcesContent":["import type { StaticHandler } from '@payloadcms/plugin-cloud-storage/types'\nimport type { CollectionConfig } from 'payload'\n\nimport { getFilePrefix } from '@payloadcms/plugin-cloud-storage/utilities'\nimport { BlobNotFoundError, head } from '@vercel/blob'\nimport path from 'path'\n\ntype StaticHandlerArgs = {\n baseUrl: string\n cacheControlMaxAge?: number\n token: string\n}\n\nexport const getStaticHandler = (\n { baseUrl, cacheControlMaxAge = 0, token }: StaticHandlerArgs,\n collection: CollectionConfig,\n): StaticHandler => {\n return async (req, { params: { filename } }) => {\n try {\n const prefix = await getFilePrefix({ collection, filename, req })\n const fileKey = path.posix.join(prefix, encodeURIComponent(filename))\n\n const fileUrl = `${baseUrl}/${fileKey}`\n const etagFromHeaders = req.headers.get('etag') || req.headers.get('if-none-match')\n
|
|
1
|
+
{"version":3,"sources":["../src/staticHandler.ts"],"sourcesContent":["import type { StaticHandler } from '@payloadcms/plugin-cloud-storage/types'\nimport type { CollectionConfig } from 'payload'\n\nimport { getFilePrefix } from '@payloadcms/plugin-cloud-storage/utilities'\nimport { BlobNotFoundError, head } from '@vercel/blob'\nimport path from 'path'\n\ntype StaticHandlerArgs = {\n baseUrl: string\n cacheControlMaxAge?: number\n token: string\n}\n\nexport const getStaticHandler = (\n { baseUrl, cacheControlMaxAge = 0, token }: StaticHandlerArgs,\n collection: CollectionConfig,\n): StaticHandler => {\n return async (req, { params: { filename } }) => {\n try {\n const prefix = await getFilePrefix({ collection, filename, req })\n const fileKey = path.posix.join(prefix, encodeURIComponent(filename))\n\n const fileUrl = `${baseUrl}/${fileKey}`\n const etagFromHeaders = req.headers.get('etag') || req.headers.get('if-none-match')\n const blobMetadata = await head(fileUrl, { token })\n const uploadedAtString = blobMetadata.uploadedAt.toISOString()\n const ETag = `\"${fileKey}-${uploadedAtString}\"`\n\n const { contentDisposition, contentType, size } = blobMetadata\n\n if (etagFromHeaders && etagFromHeaders === ETag) {\n return new Response(null, {\n headers: new Headers({\n 'Cache-Control': `public, max-age=${cacheControlMaxAge}`,\n 'Content-Disposition': contentDisposition,\n 'Content-Length': String(size),\n 'Content-Type': contentType,\n ETag,\n }),\n status: 304,\n })\n }\n\n const response = await fetch(`${fileUrl}?${uploadedAtString}`, {\n cache: 'no-store',\n })\n\n const blob = await response.blob()\n\n if (!blob) {\n return new Response(null, { status: 204, statusText: 'No Content' })\n }\n\n const bodyBuffer = await blob.arrayBuffer()\n\n return new Response(bodyBuffer, {\n headers: new Headers({\n 'Cache-Control': `public, max-age=${cacheControlMaxAge}`,\n 'Content-Disposition': contentDisposition,\n 'Content-Length': String(size),\n 'Content-Type': contentType,\n ETag,\n 'Last-Modified': blobMetadata.uploadedAt.toUTCString(),\n }),\n status: 200,\n })\n } catch (err: unknown) {\n if (err instanceof BlobNotFoundError) {\n return new Response(null, { status: 404, statusText: 'Not Found' })\n }\n req.payload.logger.error({ err, msg: 'Unexpected error in staticHandler' })\n return new Response('Internal Server Error', { status: 500 })\n }\n }\n}\n"],"names":["getFilePrefix","BlobNotFoundError","head","path","getStaticHandler","baseUrl","cacheControlMaxAge","token","collection","req","params","filename","prefix","fileKey","posix","join","encodeURIComponent","fileUrl","etagFromHeaders","headers","get","blobMetadata","uploadedAtString","uploadedAt","toISOString","ETag","contentDisposition","contentType","size","Response","Headers","String","status","response","fetch","cache","blob","statusText","bodyBuffer","arrayBuffer","toUTCString","err","payload","logger","error","msg"],"mappings":"AAGA,SAASA,aAAa,QAAQ,6CAA4C;AAC1E,SAASC,iBAAiB,EAAEC,IAAI,QAAQ,eAAc;AACtD,OAAOC,UAAU,OAAM;AAQvB,OAAO,MAAMC,mBAAmB,CAC9B,EAAEC,OAAO,EAAEC,qBAAqB,CAAC,EAAEC,KAAK,EAAqB,EAC7DC;IAEA,OAAO,OAAOC,KAAK,EAAEC,QAAQ,EAAEC,QAAQ,EAAE,EAAE;QACzC,IAAI;YACF,MAAMC,SAAS,MAAMZ,cAAc;gBAAEQ;gBAAYG;gBAAUF;YAAI;YAC/D,MAAMI,UAAUV,KAAKW,KAAK,CAACC,IAAI,CAACH,QAAQI,mBAAmBL;YAE3D,MAAMM,UAAU,GAAGZ,QAAQ,CAAC,EAAEQ,SAAS;YACvC,MAAMK,kBAAkBT,IAAIU,OAAO,CAACC,GAAG,CAAC,WAAWX,IAAIU,OAAO,CAACC,GAAG,CAAC;YACnE,MAAMC,eAAe,MAAMnB,KAAKe,SAAS;gBAAEV;YAAM;YACjD,MAAMe,mBAAmBD,aAAaE,UAAU,CAACC,WAAW;YAC5D,MAAMC,OAAO,CAAC,CAAC,EAAEZ,QAAQ,CAAC,EAAES,iBAAiB,CAAC,CAAC;YAE/C,MAAM,EAAEI,kBAAkB,EAAEC,WAAW,EAAEC,IAAI,EAAE,GAAGP;YAElD,IAAIH,mBAAmBA,oBAAoBO,MAAM;gBAC/C,OAAO,IAAII,SAAS,MAAM;oBACxBV,SAAS,IAAIW,QAAQ;wBACnB,iBAAiB,CAAC,gBAAgB,EAAExB,oBAAoB;wBACxD,uBAAuBoB;wBACvB,kBAAkBK,OAAOH;wBACzB,gBAAgBD;wBAChBF;oBACF;oBACAO,QAAQ;gBACV;YACF;YAEA,MAAMC,WAAW,MAAMC,MAAM,GAAGjB,QAAQ,CAAC,EAAEK,kBAAkB,EAAE;gBAC7Da,OAAO;YACT;YAEA,MAAMC,OAAO,MAAMH,SAASG,IAAI;YAEhC,IAAI,CAACA,MAAM;gBACT,OAAO,IAAIP,SAAS,MAAM;oBAAEG,QAAQ;oBAAKK,YAAY;gBAAa;YACpE;YAEA,MAAMC,aAAa,MAAMF,KAAKG,WAAW;YAEzC,OAAO,IAAIV,SAASS,YAAY;gBAC9BnB,SAAS,IAAIW,QAAQ;oBACnB,iBAAiB,CAAC,gBAAgB,EAAExB,oBAAoB;oBACxD,uBAAuBoB;oBACvB,kBAAkBK,OAAOH;oBACzB,gBAAgBD;oBAChBF;oBACA,iBAAiBJ,aAAaE,UAAU,CAACiB,WAAW;gBACtD;gBACAR,QAAQ;YACV;QACF,EAAE,OAAOS,KAAc;YACrB,IAAIA,eAAexC,mBAAmB;gBACpC,OAAO,IAAI4B,SAAS,MAAM;oBAAEG,QAAQ;oBAAKK,YAAY;gBAAY;YACnE;YACA5B,IAAIiC,OAAO,CAACC,MAAM,CAACC,KAAK,CAAC;gBAAEH;gBAAKI,KAAK;YAAoC;YACzE,OAAO,IAAIhB,SAAS,yBAAyB;gBAAEG,QAAQ;YAAI;QAC7D;IACF;AACF,EAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@payloadcms/storage-vercel-blob",
|
|
3
|
-
"version": "3.25.0
|
|
3
|
+
"version": "3.25.0",
|
|
4
4
|
"description": "Payload storage adapter for Vercel Blob Storage",
|
|
5
5
|
"homepage": "https://payloadcms.com",
|
|
6
6
|
"repository": {
|
|
@@ -23,6 +23,11 @@
|
|
|
23
23
|
"import": "./dist/index.js",
|
|
24
24
|
"types": "./dist/index.d.ts",
|
|
25
25
|
"default": "./dist/index.js"
|
|
26
|
+
},
|
|
27
|
+
"./client": {
|
|
28
|
+
"import": "./dist/exports/client.js",
|
|
29
|
+
"types": "./dist/exports/client.d.ts",
|
|
30
|
+
"default": "./dist/exports/client.js"
|
|
26
31
|
}
|
|
27
32
|
},
|
|
28
33
|
"main": "./dist/index.js",
|
|
@@ -32,13 +37,13 @@
|
|
|
32
37
|
],
|
|
33
38
|
"dependencies": {
|
|
34
39
|
"@vercel/blob": "^0.22.3",
|
|
35
|
-
"@payloadcms/plugin-cloud-storage": "3.25.0
|
|
40
|
+
"@payloadcms/plugin-cloud-storage": "3.25.0"
|
|
36
41
|
},
|
|
37
42
|
"devDependencies": {
|
|
38
|
-
"payload": "3.25.0
|
|
43
|
+
"payload": "3.25.0"
|
|
39
44
|
},
|
|
40
45
|
"peerDependencies": {
|
|
41
|
-
"payload": "3.25.0
|
|
46
|
+
"payload": "3.25.0"
|
|
42
47
|
},
|
|
43
48
|
"engines": {
|
|
44
49
|
"node": "^18.20.2 || >=20.9.0"
|