@payloadcms/storage-gcs 3.84.0-canary.0 → 3.84.0-internal.d5d6e43
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/dist/client/GcsClientUploadHandler.d.ts.map +1 -1
- package/dist/client/GcsClientUploadHandler.js +4 -3
- package/dist/client/GcsClientUploadHandler.js.map +1 -1
- package/dist/deleteFile.js +1 -1
- package/dist/deleteFile.js.map +1 -1
- package/dist/generateSignedURL.d.ts +2 -1
- package/dist/generateSignedURL.d.ts.map +1 -1
- package/dist/generateSignedURL.js +14 -10
- package/dist/generateSignedURL.js.map +1 -1
- package/dist/generateURL.js +2 -2
- package/dist/generateURL.js.map +1 -1
- package/dist/getFile.d.ts.map +1 -1
- package/dist/getFile.js +3 -4
- package/dist/getFile.js.map +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +2 -1
- package/dist/index.js.map +1 -1
- package/dist/uploadFile.js +1 -1
- package/dist/uploadFile.js.map +1 -1
- package/package.json +4 -4
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"GcsClientUploadHandler.d.ts","sourceRoot":"","sources":["../../src/client/GcsClientUploadHandler.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,sBAAsB;;;;;;;
|
|
1
|
+
{"version":3,"file":"GcsClientUploadHandler.d.ts","sourceRoot":"","sources":["../../src/client/GcsClientUploadHandler.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,sBAAsB;;;;;;;aAyBJ,OAAO,aAQpC,CAAA"}
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
import { createClientUploadHandler } from '@payloadcms/plugin-cloud-storage/client';
|
|
3
3
|
import { formatAdminURL } from 'payload/shared';
|
|
4
4
|
export const GcsClientUploadHandler = createClientUploadHandler({
|
|
5
|
-
handler: async ({ apiRoute, collectionSlug,
|
|
5
|
+
handler: async ({ apiRoute, collectionSlug, docPrefix, file, serverHandlerPath, serverURL })=>{
|
|
6
6
|
const endpointRoute = formatAdminURL({
|
|
7
7
|
apiRoute,
|
|
8
8
|
path: serverHandlerPath,
|
|
@@ -11,13 +11,14 @@ export const GcsClientUploadHandler = createClientUploadHandler({
|
|
|
11
11
|
const response = await fetch(endpointRoute, {
|
|
12
12
|
body: JSON.stringify({
|
|
13
13
|
collectionSlug,
|
|
14
|
+
docPrefix,
|
|
14
15
|
filename: file.name,
|
|
15
16
|
mimeType: file.type
|
|
16
17
|
}),
|
|
17
18
|
credentials: 'include',
|
|
18
19
|
method: 'POST'
|
|
19
20
|
});
|
|
20
|
-
const { url } = await response.json();
|
|
21
|
+
const { docPrefix: sanitizedDocPrefix, url } = await response.json();
|
|
21
22
|
await fetch(url, {
|
|
22
23
|
body: file,
|
|
23
24
|
headers: {
|
|
@@ -27,7 +28,7 @@ export const GcsClientUploadHandler = createClientUploadHandler({
|
|
|
27
28
|
method: 'PUT'
|
|
28
29
|
});
|
|
29
30
|
return {
|
|
30
|
-
prefix
|
|
31
|
+
prefix: sanitizedDocPrefix
|
|
31
32
|
};
|
|
32
33
|
}
|
|
33
34
|
});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/client/GcsClientUploadHandler.ts"],"sourcesContent":["'use client'\nimport { createClientUploadHandler } from '@payloadcms/plugin-cloud-storage/client'\nimport { formatAdminURL } from 'payload/shared'\n\nexport const GcsClientUploadHandler = createClientUploadHandler({\n handler: async ({ apiRoute, collectionSlug,
|
|
1
|
+
{"version":3,"sources":["../../src/client/GcsClientUploadHandler.ts"],"sourcesContent":["'use client'\nimport { createClientUploadHandler } from '@payloadcms/plugin-cloud-storage/client'\nimport { formatAdminURL } from 'payload/shared'\n\nexport const GcsClientUploadHandler = createClientUploadHandler({\n handler: async ({ apiRoute, collectionSlug, docPrefix, file, serverHandlerPath, serverURL }) => {\n const endpointRoute = formatAdminURL({\n apiRoute,\n path: serverHandlerPath,\n serverURL,\n })\n const response = await fetch(endpointRoute, {\n body: JSON.stringify({\n collectionSlug,\n docPrefix,\n filename: file.name,\n mimeType: file.type,\n }),\n credentials: 'include',\n method: 'POST',\n })\n\n const { docPrefix: sanitizedDocPrefix, url } = (await response.json()) as {\n docPrefix: string\n url: string\n }\n\n await fetch(url, {\n body: file,\n headers: { 'Content-Length': file.size.toString(), 'Content-Type': file.type },\n method: 'PUT',\n })\n\n return {\n prefix: sanitizedDocPrefix,\n }\n },\n})\n"],"names":["createClientUploadHandler","formatAdminURL","GcsClientUploadHandler","handler","apiRoute","collectionSlug","docPrefix","file","serverHandlerPath","serverURL","endpointRoute","path","response","fetch","body","JSON","stringify","filename","name","mimeType","type","credentials","method","sanitizedDocPrefix","url","json","headers","size","toString","prefix"],"mappings":"AAAA;AACA,SAASA,yBAAyB,QAAQ,0CAAyC;AACnF,SAASC,cAAc,QAAQ,iBAAgB;AAE/C,OAAO,MAAMC,yBAAyBF,0BAA0B;IAC9DG,SAAS,OAAO,EAAEC,QAAQ,EAAEC,cAAc,EAAEC,SAAS,EAAEC,IAAI,EAAEC,iBAAiB,EAAEC,SAAS,EAAE;QACzF,MAAMC,gBAAgBT,eAAe;YACnCG;YACAO,MAAMH;YACNC;QACF;QACA,MAAMG,WAAW,MAAMC,MAAMH,eAAe;YAC1CI,MAAMC,KAAKC,SAAS,CAAC;gBACnBX;gBACAC;gBACAW,UAAUV,KAAKW,IAAI;gBACnBC,UAAUZ,KAAKa,IAAI;YACrB;YACAC,aAAa;YACbC,QAAQ;QACV;QAEA,MAAM,EAAEhB,WAAWiB,kBAAkB,EAAEC,GAAG,EAAE,GAAI,MAAMZ,SAASa,IAAI;QAKnE,MAAMZ,MAAMW,KAAK;YACfV,MAAMP;YACNmB,SAAS;gBAAE,kBAAkBnB,KAAKoB,IAAI,CAACC,QAAQ;gBAAI,gBAAgBrB,KAAKa,IAAI;YAAC;YAC7EE,QAAQ;QACV;QAEA,OAAO;YACLO,QAAQN;QACV;IACF;AACF,GAAE"}
|
package/dist/deleteFile.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { getFileKey } from '@payloadcms/plugin-cloud-storage/utilities';
|
|
2
2
|
export async function deleteFile({ bucket, client, collectionPrefix = '', docPrefix, filename, useCompositePrefixes = false }) {
|
|
3
|
-
const fileKey = getFileKey({
|
|
3
|
+
const { fileKey } = getFileKey({
|
|
4
4
|
collectionPrefix,
|
|
5
5
|
docPrefix,
|
|
6
6
|
filename,
|
package/dist/deleteFile.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/deleteFile.ts"],"sourcesContent":["import type { Storage } from '@google-cloud/storage'\n\nimport { getFileKey } from '@payloadcms/plugin-cloud-storage/utilities'\n\ninterface DeleteFileArgs {\n bucket: string\n client: Storage\n collectionPrefix?: string\n docPrefix: string\n filename: string\n useCompositePrefixes?: boolean\n}\n\nexport async function deleteFile({\n bucket,\n client,\n collectionPrefix = '',\n docPrefix,\n filename,\n useCompositePrefixes = false,\n}: DeleteFileArgs): Promise<void> {\n const fileKey = getFileKey({\n collectionPrefix,\n docPrefix,\n filename,\n useCompositePrefixes,\n })\n\n await client.bucket(bucket).file(fileKey).delete({\n ignoreNotFound: true,\n })\n}\n"],"names":["getFileKey","deleteFile","bucket","client","collectionPrefix","docPrefix","filename","useCompositePrefixes","fileKey","file","delete","ignoreNotFound"],"mappings":"AAEA,SAASA,UAAU,QAAQ,6CAA4C;AAWvE,OAAO,eAAeC,WAAW,EAC/BC,MAAM,EACNC,MAAM,EACNC,mBAAmB,EAAE,EACrBC,SAAS,EACTC,QAAQ,EACRC,uBAAuB,KAAK,EACb;IACf,
|
|
1
|
+
{"version":3,"sources":["../src/deleteFile.ts"],"sourcesContent":["import type { Storage } from '@google-cloud/storage'\n\nimport { getFileKey } from '@payloadcms/plugin-cloud-storage/utilities'\n\ninterface DeleteFileArgs {\n bucket: string\n client: Storage\n collectionPrefix?: string\n docPrefix: string\n filename: string\n useCompositePrefixes?: boolean\n}\n\nexport async function deleteFile({\n bucket,\n client,\n collectionPrefix = '',\n docPrefix,\n filename,\n useCompositePrefixes = false,\n}: DeleteFileArgs): Promise<void> {\n const { fileKey } = getFileKey({\n collectionPrefix,\n docPrefix,\n filename,\n useCompositePrefixes,\n })\n\n await client.bucket(bucket).file(fileKey).delete({\n ignoreNotFound: true,\n })\n}\n"],"names":["getFileKey","deleteFile","bucket","client","collectionPrefix","docPrefix","filename","useCompositePrefixes","fileKey","file","delete","ignoreNotFound"],"mappings":"AAEA,SAASA,UAAU,QAAQ,6CAA4C;AAWvE,OAAO,eAAeC,WAAW,EAC/BC,MAAM,EACNC,MAAM,EACNC,mBAAmB,EAAE,EACrBC,SAAS,EACTC,QAAQ,EACRC,uBAAuB,KAAK,EACb;IACf,MAAM,EAAEC,OAAO,EAAE,GAAGR,WAAW;QAC7BI;QACAC;QACAC;QACAC;IACF;IAEA,MAAMJ,OAAOD,MAAM,CAACA,QAAQO,IAAI,CAACD,SAASE,MAAM,CAAC;QAC/CC,gBAAgB;IAClB;AACF"}
|
|
@@ -8,7 +8,8 @@ interface Args {
|
|
|
8
8
|
bucket: string;
|
|
9
9
|
collections: GcsStorageOptions['collections'];
|
|
10
10
|
getStorageClient: () => Storage;
|
|
11
|
+
useCompositePrefixes?: boolean;
|
|
11
12
|
}
|
|
12
|
-
export declare const getGenerateSignedURLHandler: ({ access, bucket, collections, getStorageClient, }: Args) => PayloadHandler;
|
|
13
|
+
export declare const getGenerateSignedURLHandler: ({ access, bucket, collections, getStorageClient, useCompositePrefixes, }: Args) => PayloadHandler;
|
|
13
14
|
export {};
|
|
14
15
|
//# sourceMappingURL=generateSignedURL.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"generateSignedURL.d.ts","sourceRoot":"","sources":["../src/generateSignedURL.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;AACpD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,wCAAwC,CAAA;AACjF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;
|
|
1
|
+
{"version":3,"file":"generateSignedURL.d.ts","sourceRoot":"","sources":["../src/generateSignedURL.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;AACpD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,wCAAwC,CAAA;AACjF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAK7C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAEnD,UAAU,IAAI;IACZ,MAAM,CAAC,EAAE,mBAAmB,CAAA;IAC5B,GAAG,CAAC,EAAE,SAAS,GAAG,aAAa,CAAA;IAC/B,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,EAAE,iBAAiB,CAAC,aAAa,CAAC,CAAA;IAC7C,gBAAgB,EAAE,MAAM,OAAO,CAAA;IAC/B,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B;AAID,eAAO,MAAM,2BAA2B,6EAMrC,IAAI,KAAG,cA+CT,CAAA"}
|
|
@@ -1,26 +1,29 @@
|
|
|
1
|
-
import
|
|
1
|
+
import { getFileKey } from '@payloadcms/plugin-cloud-storage/utilities';
|
|
2
2
|
import { APIError, Forbidden } from 'payload';
|
|
3
|
-
import { sanitizeFilename } from 'payload/shared';
|
|
4
3
|
const defaultAccess = ({ req })=>!!req.user;
|
|
5
|
-
export const getGenerateSignedURLHandler = ({ access = defaultAccess, bucket, collections, getStorageClient })=>{
|
|
4
|
+
export const getGenerateSignedURLHandler = ({ access = defaultAccess, bucket, collections, getStorageClient, useCompositePrefixes = false })=>{
|
|
6
5
|
return async (req)=>{
|
|
7
6
|
if (!req.json) {
|
|
8
7
|
throw new APIError('Unreachable');
|
|
9
8
|
}
|
|
10
|
-
const { collectionSlug, filename, mimeType } = await req.json();
|
|
11
|
-
const
|
|
12
|
-
if (!
|
|
13
|
-
throw new APIError(`Collection ${collectionSlug} was not found in
|
|
9
|
+
const { collectionSlug, docPrefix, filename, mimeType } = await req.json();
|
|
10
|
+
const collectionStorageConfig = collections[collectionSlug];
|
|
11
|
+
if (!collectionStorageConfig) {
|
|
12
|
+
throw new APIError(`Collection ${collectionSlug} was not found in GCS storage options`);
|
|
14
13
|
}
|
|
15
|
-
const
|
|
14
|
+
const collectionPrefix = typeof collectionStorageConfig === 'object' && collectionStorageConfig.prefix || '';
|
|
16
15
|
if (!await access({
|
|
17
16
|
collectionSlug,
|
|
18
17
|
req
|
|
19
18
|
})) {
|
|
20
19
|
throw new Forbidden();
|
|
21
20
|
}
|
|
22
|
-
const
|
|
23
|
-
|
|
21
|
+
const { fileKey, sanitizedDocPrefix } = getFileKey({
|
|
22
|
+
collectionPrefix,
|
|
23
|
+
docPrefix,
|
|
24
|
+
filename,
|
|
25
|
+
useCompositePrefixes
|
|
26
|
+
});
|
|
24
27
|
const [url] = await getStorageClient().bucket(bucket).file(fileKey).getSignedUrl({
|
|
25
28
|
action: 'write',
|
|
26
29
|
contentType: mimeType,
|
|
@@ -28,6 +31,7 @@ export const getGenerateSignedURLHandler = ({ access = defaultAccess, bucket, co
|
|
|
28
31
|
version: 'v4'
|
|
29
32
|
});
|
|
30
33
|
return Response.json({
|
|
34
|
+
docPrefix: sanitizedDocPrefix,
|
|
31
35
|
url
|
|
32
36
|
});
|
|
33
37
|
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/generateSignedURL.ts"],"sourcesContent":["import type { Storage } from '@google-cloud/storage'\nimport type { ClientUploadsAccess } from '@payloadcms/plugin-cloud-storage/types'\nimport type { PayloadHandler } from 'payload'\n\nimport
|
|
1
|
+
{"version":3,"sources":["../src/generateSignedURL.ts"],"sourcesContent":["import type { Storage } from '@google-cloud/storage'\nimport type { ClientUploadsAccess } from '@payloadcms/plugin-cloud-storage/types'\nimport type { PayloadHandler } from 'payload'\n\nimport { getFileKey } from '@payloadcms/plugin-cloud-storage/utilities'\nimport { APIError, Forbidden } from 'payload'\n\nimport type { GcsStorageOptions } from './index.js'\n\ninterface Args {\n access?: ClientUploadsAccess\n acl?: 'private' | 'public-read'\n bucket: string\n collections: GcsStorageOptions['collections']\n getStorageClient: () => Storage\n useCompositePrefixes?: boolean\n}\n\nconst defaultAccess: Args['access'] = ({ req }) => !!req.user\n\nexport const getGenerateSignedURLHandler = ({\n access = defaultAccess,\n bucket,\n collections,\n getStorageClient,\n useCompositePrefixes = false,\n}: Args): PayloadHandler => {\n return async (req) => {\n if (!req.json) {\n throw new APIError('Unreachable')\n }\n\n const { collectionSlug, docPrefix, filename, mimeType } = (await req.json()) as {\n collectionSlug: string\n docPrefix?: string\n filename: string\n mimeType: string\n }\n\n const collectionStorageConfig = collections[collectionSlug]\n if (!collectionStorageConfig) {\n throw new APIError(`Collection ${collectionSlug} was not found in GCS storage options`)\n }\n\n const collectionPrefix =\n (typeof collectionStorageConfig === 'object' && collectionStorageConfig.prefix) || ''\n\n if (!(await access({ collectionSlug, req }))) {\n throw new Forbidden()\n }\n\n const { fileKey, sanitizedDocPrefix } = getFileKey({\n collectionPrefix,\n docPrefix,\n filename,\n useCompositePrefixes,\n })\n\n const [url] = await getStorageClient()\n .bucket(bucket)\n .file(fileKey)\n .getSignedUrl({\n action: 'write',\n contentType: mimeType,\n expires: Date.now() + 60 * 60 * 5,\n version: 'v4',\n })\n\n return Response.json({\n docPrefix: sanitizedDocPrefix,\n url,\n })\n }\n}\n"],"names":["getFileKey","APIError","Forbidden","defaultAccess","req","user","getGenerateSignedURLHandler","access","bucket","collections","getStorageClient","useCompositePrefixes","json","collectionSlug","docPrefix","filename","mimeType","collectionStorageConfig","collectionPrefix","prefix","fileKey","sanitizedDocPrefix","url","file","getSignedUrl","action","contentType","expires","Date","now","version","Response"],"mappings":"AAIA,SAASA,UAAU,QAAQ,6CAA4C;AACvE,SAASC,QAAQ,EAAEC,SAAS,QAAQ,UAAS;AAa7C,MAAMC,gBAAgC,CAAC,EAAEC,GAAG,EAAE,GAAK,CAAC,CAACA,IAAIC,IAAI;AAE7D,OAAO,MAAMC,8BAA8B,CAAC,EAC1CC,SAASJ,aAAa,EACtBK,MAAM,EACNC,WAAW,EACXC,gBAAgB,EAChBC,uBAAuB,KAAK,EACvB;IACL,OAAO,OAAOP;QACZ,IAAI,CAACA,IAAIQ,IAAI,EAAE;YACb,MAAM,IAAIX,SAAS;QACrB;QAEA,MAAM,EAAEY,cAAc,EAAEC,SAAS,EAAEC,QAAQ,EAAEC,QAAQ,EAAE,GAAI,MAAMZ,IAAIQ,IAAI;QAOzE,MAAMK,0BAA0BR,WAAW,CAACI,eAAe;QAC3D,IAAI,CAACI,yBAAyB;YAC5B,MAAM,IAAIhB,SAAS,CAAC,WAAW,EAAEY,eAAe,qCAAqC,CAAC;QACxF;QAEA,MAAMK,mBACJ,AAAC,OAAOD,4BAA4B,YAAYA,wBAAwBE,MAAM,IAAK;QAErF,IAAI,CAAE,MAAMZ,OAAO;YAAEM;YAAgBT;QAAI,IAAK;YAC5C,MAAM,IAAIF;QACZ;QAEA,MAAM,EAAEkB,OAAO,EAAEC,kBAAkB,EAAE,GAAGrB,WAAW;YACjDkB;YACAJ;YACAC;YACAJ;QACF;QAEA,MAAM,CAACW,IAAI,GAAG,MAAMZ,mBACjBF,MAAM,CAACA,QACPe,IAAI,CAACH,SACLI,YAAY,CAAC;YACZC,QAAQ;YACRC,aAAaV;YACbW,SAASC,KAAKC,GAAG,KAAK,KAAK,KAAK;YAChCC,SAAS;QACX;QAEF,OAAOC,SAASnB,IAAI,CAAC;YACnBE,WAAWO;YACXC;QACF;IACF;AACF,EAAC"}
|
package/dist/generateURL.js
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
import { getFileKey } from '@payloadcms/plugin-cloud-storage/utilities';
|
|
2
2
|
export function generateURL({ bucket, client, collectionPrefix = '', filename, prefix, useCompositePrefixes = false }) {
|
|
3
|
-
const fileKey = getFileKey({
|
|
3
|
+
const { fileKey } = getFileKey({
|
|
4
4
|
collectionPrefix,
|
|
5
5
|
docPrefix: prefix,
|
|
6
6
|
filename,
|
|
7
7
|
useCompositePrefixes
|
|
8
8
|
});
|
|
9
|
-
return
|
|
9
|
+
return client.bucket(bucket).file(fileKey).publicUrl();
|
|
10
10
|
}
|
|
11
11
|
|
|
12
12
|
//# sourceMappingURL=generateURL.js.map
|
package/dist/generateURL.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/generateURL.ts"],"sourcesContent":["import type { Storage } from '@google-cloud/storage'\n\nimport { getFileKey } from '@payloadcms/plugin-cloud-storage/utilities'\n\ninterface GenerateURLArgs {\n bucket: string\n client: Storage\n collectionPrefix?: string\n filename: string\n prefix: string\n useCompositePrefixes?: boolean\n}\n\nexport function generateURL({\n bucket,\n client,\n collectionPrefix = '',\n filename,\n prefix,\n useCompositePrefixes = false,\n}: GenerateURLArgs): string {\n const fileKey = getFileKey({\n collectionPrefix,\n docPrefix: prefix,\n filename,\n useCompositePrefixes,\n })\n\n return
|
|
1
|
+
{"version":3,"sources":["../src/generateURL.ts"],"sourcesContent":["import type { Storage } from '@google-cloud/storage'\n\nimport { getFileKey } from '@payloadcms/plugin-cloud-storage/utilities'\n\ninterface GenerateURLArgs {\n bucket: string\n client: Storage\n collectionPrefix?: string\n filename: string\n prefix: string\n useCompositePrefixes?: boolean\n}\n\nexport function generateURL({\n bucket,\n client,\n collectionPrefix = '',\n filename,\n prefix,\n useCompositePrefixes = false,\n}: GenerateURLArgs): string {\n const { fileKey } = getFileKey({\n collectionPrefix,\n docPrefix: prefix,\n filename,\n useCompositePrefixes,\n })\n\n return client.bucket(bucket).file(fileKey).publicUrl()\n}\n"],"names":["getFileKey","generateURL","bucket","client","collectionPrefix","filename","prefix","useCompositePrefixes","fileKey","docPrefix","file","publicUrl"],"mappings":"AAEA,SAASA,UAAU,QAAQ,6CAA4C;AAWvE,OAAO,SAASC,YAAY,EAC1BC,MAAM,EACNC,MAAM,EACNC,mBAAmB,EAAE,EACrBC,QAAQ,EACRC,MAAM,EACNC,uBAAuB,KAAK,EACZ;IAChB,MAAM,EAAEC,OAAO,EAAE,GAAGR,WAAW;QAC7BI;QACAK,WAAWH;QACXD;QACAE;IACF;IAEA,OAAOJ,OAAOD,MAAM,CAACA,QAAQQ,IAAI,CAACF,SAASG,SAAS;AACtD"}
|
package/dist/getFile.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"getFile.d.ts","sourceRoot":"","sources":["../src/getFile.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;AACpD,OAAO,KAAK,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;
|
|
1
|
+
{"version":3,"file":"getFile.d.ts","sourceRoot":"","sources":["../src/getFile.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;AACpD,OAAO,KAAK,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAS/D,UAAU,WAAW;IACnB,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,OAAO,CAAA;IACf,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B,UAAU,EAAE,gBAAgB,CAAA;IAC5B,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,QAAQ,EAAE,MAAM,CAAA;IAChB,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,GAAG,EAAE,cAAc,CAAA;IACnB,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B;AAED,wBAAsB,OAAO,CAAC,EAC5B,MAAM,EACN,MAAM,EACN,mBAAmB,EACnB,UAAU,EACV,gBAAqB,EACrB,QAAQ,EACR,eAAe,EACf,gBAAgB,EAChB,GAAG,EACH,oBAA4B,GAC7B,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC,CAiGjC"}
|
package/dist/getFile.js
CHANGED
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
import { ApiError } from '@google-cloud/storage';
|
|
2
2
|
import { getFilePrefix as getDocPrefix, getFileKey } from '@payloadcms/plugin-cloud-storage/utilities';
|
|
3
3
|
import { getRangeRequestInfo } from 'payload/internal';
|
|
4
|
-
import { sanitizeFilename } from 'payload/shared';
|
|
5
4
|
export async function getFile({ bucket, client, clientUploadContext, collection, collectionPrefix = '', filename, incomingHeaders, prefixQueryParam, req, useCompositePrefixes = false }) {
|
|
6
5
|
try {
|
|
7
6
|
const docPrefix = await getDocPrefix({
|
|
@@ -11,13 +10,13 @@ export async function getFile({ bucket, client, clientUploadContext, collection,
|
|
|
11
10
|
prefixQueryParam,
|
|
12
11
|
req
|
|
13
12
|
});
|
|
14
|
-
const
|
|
13
|
+
const { fileKey } = getFileKey({
|
|
15
14
|
collectionPrefix,
|
|
16
15
|
docPrefix,
|
|
17
|
-
filename
|
|
16
|
+
filename,
|
|
18
17
|
useCompositePrefixes
|
|
19
18
|
});
|
|
20
|
-
const file = client.bucket(bucket).file(
|
|
19
|
+
const file = client.bucket(bucket).file(fileKey);
|
|
21
20
|
const [metadata] = await file.getMetadata();
|
|
22
21
|
// Handle range request
|
|
23
22
|
const rangeHeader = req.headers.get('range');
|
package/dist/getFile.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/getFile.ts"],"sourcesContent":["import type { Storage } from '@google-cloud/storage'\nimport type { CollectionConfig, PayloadRequest } from 'payload'\n\nimport { ApiError } from '@google-cloud/storage'\nimport {\n getFilePrefix as getDocPrefix,\n getFileKey,\n} from '@payloadcms/plugin-cloud-storage/utilities'\nimport { getRangeRequestInfo } from 'payload/internal'\
|
|
1
|
+
{"version":3,"sources":["../src/getFile.ts"],"sourcesContent":["import type { Storage } from '@google-cloud/storage'\nimport type { CollectionConfig, PayloadRequest } from 'payload'\n\nimport { ApiError } from '@google-cloud/storage'\nimport {\n getFilePrefix as getDocPrefix,\n getFileKey,\n} from '@payloadcms/plugin-cloud-storage/utilities'\nimport { getRangeRequestInfo } from 'payload/internal'\n\ninterface GetFileArgs {\n bucket: string\n client: Storage\n clientUploadContext?: unknown\n collection: CollectionConfig\n collectionPrefix?: string\n filename: string\n incomingHeaders?: Headers\n prefixQueryParam?: string\n req: PayloadRequest\n useCompositePrefixes?: boolean\n}\n\nexport async function getFile({\n bucket,\n client,\n clientUploadContext,\n collection,\n collectionPrefix = '',\n filename,\n incomingHeaders,\n prefixQueryParam,\n req,\n useCompositePrefixes = false,\n}: GetFileArgs): Promise<Response> {\n try {\n const docPrefix = await getDocPrefix({\n clientUploadContext,\n collection,\n filename,\n prefixQueryParam,\n req,\n })\n\n const { fileKey } = getFileKey({\n collectionPrefix,\n docPrefix,\n filename,\n useCompositePrefixes,\n })\n\n const file = client.bucket(bucket).file(fileKey)\n\n const [metadata] = await file.getMetadata()\n\n // Handle range request\n const rangeHeader = req.headers.get('range')\n const fileSize = Number(metadata.size)\n const rangeResult = getRangeRequestInfo({ fileSize, rangeHeader })\n\n if (rangeResult.type === 'invalid') {\n return new Response(null, {\n headers: new Headers(rangeResult.headers),\n status: rangeResult.status,\n })\n }\n\n const etagFromHeaders = req.headers.get('etag') || req.headers.get('if-none-match')\n const objectEtag = metadata.etag\n\n let headers = new Headers(incomingHeaders)\n\n // Add range-related headers from the result\n for (const [key, value] of Object.entries(rangeResult.headers)) {\n headers.append(key, value)\n }\n\n headers.append('Content-Type', String(metadata.contentType))\n headers.append('ETag', String(metadata.etag))\n\n // Add Content-Security-Policy header for SVG files to prevent executable code\n if (metadata.contentType === 'image/svg+xml') {\n headers.append('Content-Security-Policy', \"script-src 'none'\")\n }\n\n if (\n collection.upload &&\n typeof collection.upload === 'object' &&\n typeof collection.upload.modifyResponseHeaders === 'function'\n ) {\n headers = collection.upload.modifyResponseHeaders({ headers }) || headers\n }\n\n if (etagFromHeaders && etagFromHeaders === objectEtag) {\n return new Response(null, {\n headers,\n status: 304,\n })\n }\n\n // Manually create a ReadableStream for the web from a Node.js stream.\n const readableStream = new ReadableStream({\n start(controller) {\n const streamOptions =\n rangeResult.type === 'partial'\n ? { end: rangeResult.rangeEnd, start: rangeResult.rangeStart }\n : {}\n const nodeStream = file.createReadStream(streamOptions)\n nodeStream.on('data', (chunk) => {\n controller.enqueue(new Uint8Array(chunk))\n })\n nodeStream.on('end', () => {\n controller.close()\n })\n nodeStream.on('error', (err) => {\n controller.error(err)\n })\n },\n })\n\n return new Response(readableStream, {\n headers,\n status: rangeResult.status,\n })\n } catch (err: unknown) {\n if (err instanceof ApiError && err.code === 404) {\n return new Response(null, { status: 404, statusText: 'Not Found' })\n }\n req.payload.logger.error(err)\n return new Response('Internal Server Error', { status: 500 })\n }\n}\n"],"names":["ApiError","getFilePrefix","getDocPrefix","getFileKey","getRangeRequestInfo","getFile","bucket","client","clientUploadContext","collection","collectionPrefix","filename","incomingHeaders","prefixQueryParam","req","useCompositePrefixes","docPrefix","fileKey","file","metadata","getMetadata","rangeHeader","headers","get","fileSize","Number","size","rangeResult","type","Response","Headers","status","etagFromHeaders","objectEtag","etag","key","value","Object","entries","append","String","contentType","upload","modifyResponseHeaders","readableStream","ReadableStream","start","controller","streamOptions","end","rangeEnd","rangeStart","nodeStream","createReadStream","on","chunk","enqueue","Uint8Array","close","err","error","code","statusText","payload","logger"],"mappings":"AAGA,SAASA,QAAQ,QAAQ,wBAAuB;AAChD,SACEC,iBAAiBC,YAAY,EAC7BC,UAAU,QACL,6CAA4C;AACnD,SAASC,mBAAmB,QAAQ,mBAAkB;AAetD,OAAO,eAAeC,QAAQ,EAC5BC,MAAM,EACNC,MAAM,EACNC,mBAAmB,EACnBC,UAAU,EACVC,mBAAmB,EAAE,EACrBC,QAAQ,EACRC,eAAe,EACfC,gBAAgB,EAChBC,GAAG,EACHC,uBAAuB,KAAK,EAChB;IACZ,IAAI;QACF,MAAMC,YAAY,MAAMd,aAAa;YACnCM;YACAC;YACAE;YACAE;YACAC;QACF;QAEA,MAAM,EAAEG,OAAO,EAAE,GAAGd,WAAW;YAC7BO;YACAM;YACAL;YACAI;QACF;QAEA,MAAMG,OAAOX,OAAOD,MAAM,CAACA,QAAQY,IAAI,CAACD;QAExC,MAAM,CAACE,SAAS,GAAG,MAAMD,KAAKE,WAAW;QAEzC,uBAAuB;QACvB,MAAMC,cAAcP,IAAIQ,OAAO,CAACC,GAAG,CAAC;QACpC,MAAMC,WAAWC,OAAON,SAASO,IAAI;QACrC,MAAMC,cAAcvB,oBAAoB;YAAEoB;YAAUH;QAAY;QAEhE,IAAIM,YAAYC,IAAI,KAAK,WAAW;YAClC,OAAO,IAAIC,SAAS,MAAM;gBACxBP,SAAS,IAAIQ,QAAQH,YAAYL,OAAO;gBACxCS,QAAQJ,YAAYI,MAAM;YAC5B;QACF;QAEA,MAAMC,kBAAkBlB,IAAIQ,OAAO,CAACC,GAAG,CAAC,WAAWT,IAAIQ,OAAO,CAACC,GAAG,CAAC;QACnE,MAAMU,aAAad,SAASe,IAAI;QAEhC,IAAIZ,UAAU,IAAIQ,QAAQlB;QAE1B,4CAA4C;QAC5C,KAAK,MAAM,CAACuB,KAAKC,MAAM,IAAIC,OAAOC,OAAO,CAACX,YAAYL,OAAO,EAAG;YAC9DA,QAAQiB,MAAM,CAACJ,KAAKC;QACtB;QAEAd,QAAQiB,MAAM,CAAC,gBAAgBC,OAAOrB,SAASsB,WAAW;QAC1DnB,QAAQiB,MAAM,CAAC,QAAQC,OAAOrB,SAASe,IAAI;QAE3C,8EAA8E;QAC9E,IAAIf,SAASsB,WAAW,KAAK,iBAAiB;YAC5CnB,QAAQiB,MAAM,CAAC,2BAA2B;QAC5C;QAEA,IACE9B,WAAWiC,MAAM,IACjB,OAAOjC,WAAWiC,MAAM,KAAK,YAC7B,OAAOjC,WAAWiC,MAAM,CAACC,qBAAqB,KAAK,YACnD;YACArB,UAAUb,WAAWiC,MAAM,CAACC,qBAAqB,CAAC;gBAAErB;YAAQ,MAAMA;QACpE;QAEA,IAAIU,mBAAmBA,oBAAoBC,YAAY;YACrD,OAAO,IAAIJ,SAAS,MAAM;gBACxBP;gBACAS,QAAQ;YACV;QACF;QAEA,sEAAsE;QACtE,MAAMa,iBAAiB,IAAIC,eAAe;YACxCC,OAAMC,UAAU;gBACd,MAAMC,gBACJrB,YAAYC,IAAI,KAAK,YACjB;oBAAEqB,KAAKtB,YAAYuB,QAAQ;oBAAEJ,OAAOnB,YAAYwB,UAAU;gBAAC,IAC3D,CAAC;gBACP,MAAMC,aAAalC,KAAKmC,gBAAgB,CAACL;gBACzCI,WAAWE,EAAE,CAAC,QAAQ,CAACC;oBACrBR,WAAWS,OAAO,CAAC,IAAIC,WAAWF;gBACpC;gBACAH,WAAWE,EAAE,CAAC,OAAO;oBACnBP,WAAWW,KAAK;gBAClB;gBACAN,WAAWE,EAAE,CAAC,SAAS,CAACK;oBACtBZ,WAAWa,KAAK,CAACD;gBACnB;YACF;QACF;QAEA,OAAO,IAAI9B,SAASe,gBAAgB;YAClCtB;YACAS,QAAQJ,YAAYI,MAAM;QAC5B;IACF,EAAE,OAAO4B,KAAc;QACrB,IAAIA,eAAe3D,YAAY2D,IAAIE,IAAI,KAAK,KAAK;YAC/C,OAAO,IAAIhC,SAAS,MAAM;gBAAEE,QAAQ;gBAAK+B,YAAY;YAAY;QACnE;QACAhD,IAAIiD,OAAO,CAACC,MAAM,CAACJ,KAAK,CAACD;QACzB,OAAO,IAAI9B,SAAS,yBAAyB;YAAEE,QAAQ;QAAI;IAC7D;AACF"}
|
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,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAA;AAC3D,OAAO,KAAK,EACV,mBAAmB,EAEnB,iBAAiB,EAClB,MAAM,wCAAwC,CAAA;AAC/C,OAAO,KAAK,EAAU,MAAM,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AASnE,MAAM,WAAW,iBAAiB;IAChC,GAAG,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAA;IAE1B;;;;;;;;OAQG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAE5B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB;;OAEG;IACH,aAAa,CAAC,EAAE,mBAAmB,CAAA;IACnC;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC,MAAM,CAAC,oBAAoB,EAAE,IAAI,CAAC,iBAAiB,EAAE,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC,CAAA;IAC7F;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;;;OAIG;IACH,OAAO,EAAE,cAAc,CAAA;IAEvB;;;;;;;;;;;;OAYG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B;AAED,KAAK,gBAAgB,GAAG,CAAC,cAAc,EAAE,iBAAiB,KAAK,MAAM,CAAA;AAIrE,eAAO,MAAM,UAAU,EAAE,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAA;AAC3D,OAAO,KAAK,EACV,mBAAmB,EAEnB,iBAAiB,EAClB,MAAM,wCAAwC,CAAA;AAC/C,OAAO,KAAK,EAAU,MAAM,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AASnE,MAAM,WAAW,iBAAiB;IAChC,GAAG,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAA;IAE1B;;;;;;;;OAQG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAE5B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB;;OAEG;IACH,aAAa,CAAC,EAAE,mBAAmB,CAAA;IACnC;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC,MAAM,CAAC,oBAAoB,EAAE,IAAI,CAAC,iBAAiB,EAAE,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC,CAAA;IAC7F;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;;;OAIG;IACH,OAAO,EAAE,cAAc,CAAA;IAEvB;;;;;;;;;;;;OAYG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B;AAED,KAAK,gBAAgB,GAAG,CAAC,cAAc,EAAE,iBAAiB,KAAK,MAAM,CAAA;AAIrE,eAAO,MAAM,UAAU,EAAE,gBAmFtB,CAAA"}
|
package/dist/index.js
CHANGED
|
@@ -30,7 +30,8 @@ export const gcsStorage = (gcsStorageOptions)=>(incomingConfig)=>{
|
|
|
30
30
|
access: typeof gcsStorageOptions.clientUploads === 'object' ? gcsStorageOptions.clientUploads.access : undefined,
|
|
31
31
|
bucket: gcsStorageOptions.bucket,
|
|
32
32
|
collections: gcsStorageOptions.collections,
|
|
33
|
-
getStorageClient
|
|
33
|
+
getStorageClient,
|
|
34
|
+
useCompositePrefixes: gcsStorageOptions.useCompositePrefixes
|
|
34
35
|
}),
|
|
35
36
|
serverHandlerPath: '/storage-gcs-generate-signed-url'
|
|
36
37
|
});
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { StorageOptions } from '@google-cloud/storage'\nimport type {\n ClientUploadsConfig,\n PluginOptions as CloudStoragePluginOptions,\n CollectionOptions,\n} from '@payloadcms/plugin-cloud-storage/types'\nimport type { Config, Plugin, UploadCollectionSlug } from 'payload'\n\nimport { Storage } from '@google-cloud/storage'\nimport { cloudStoragePlugin } from '@payloadcms/plugin-cloud-storage'\nimport { initClientUploads } from '@payloadcms/plugin-cloud-storage/utilities'\n\nimport { createGcsAdapter } from './adapter.js'\nimport { getGenerateSignedURLHandler } from './generateSignedURL.js'\n\nexport interface GcsStorageOptions {\n acl?: 'Private' | 'Public'\n\n /**\n * When enabled, fields (like the prefix field) will always be inserted into\n * the collection schema regardless of whether the plugin is enabled. This\n * ensures a consistent schema across all environments.\n *\n * This will be enabled by default in Payload v4.\n *\n * @default false\n */\n alwaysInsertFields?: boolean\n\n /**\n * The name of the bucket to use.\n */\n bucket: string\n /**\n * Optional cache key to identify the GCS storage client instance.\n * If not provided, a default key will be used.\n *\n * @default `gcs:containerName`\n */\n clientCacheKey?: string\n /**\n * Do uploads directly on the client to bypass limits on Vercel. You must allow CORS PUT method for the bucket to your website.\n */\n clientUploads?: ClientUploadsConfig\n /**\n * Collection options to apply the S3 adapter to.\n */\n collections: Partial<Record<UploadCollectionSlug, Omit<CollectionOptions, 'adapter'> | true>>\n /**\n * Whether or not to enable the plugin\n *\n * Default: true\n */\n enabled?: boolean\n /**\n * Google Cloud Storage client configuration.\n *\n * @see https://github.com/googleapis/nodejs-storage\n */\n options: StorageOptions\n\n /**\n * When true, the collection-level prefix and document-level prefix are combined\n * (compositional). When false (default), document prefix overrides collection\n * prefix entirely.\n *\n * Example:\n * - collection prefix: `collection-prefix/`\n * - document prefix: `document-prefix/`\n * - resulting prefix with useCompositePrefixes=true: `collection-prefix/document-prefix/`\n * - resulting prefix with useCompositePrefixes=false: `document-prefix/`\n *\n * @default false\n */\n useCompositePrefixes?: boolean\n}\n\ntype GcsStoragePlugin = (gcsStorageArgs: GcsStorageOptions) => Plugin\n\nconst gcsClients = new Map<string, Storage>()\n\nexport const gcsStorage: GcsStoragePlugin =\n (gcsStorageOptions: GcsStorageOptions) =>\n (incomingConfig: Config): Config => {\n const cacheKey = gcsStorageOptions.clientCacheKey || `gcs:${gcsStorageOptions.bucket}`\n\n const getStorageClient = (): Storage => {\n if (gcsClients.has(cacheKey)) {\n return gcsClients.get(cacheKey)!\n }\n gcsClients.set(cacheKey, new Storage(gcsStorageOptions.options))\n\n return gcsClients.get(cacheKey)!\n }\n\n const adapter = createGcsAdapter({\n acl: gcsStorageOptions.acl,\n bucket: gcsStorageOptions.bucket,\n clientUploads: gcsStorageOptions.clientUploads,\n getStorageClient,\n useCompositePrefixes: gcsStorageOptions.useCompositePrefixes,\n })\n\n const isPluginDisabled = gcsStorageOptions.enabled === false\n\n initClientUploads({\n clientHandler: '@payloadcms/storage-gcs/client#GcsClientUploadHandler',\n collections: gcsStorageOptions.collections,\n config: incomingConfig,\n enabled: !isPluginDisabled && Boolean(gcsStorageOptions.clientUploads),\n serverHandler: getGenerateSignedURLHandler({\n access:\n typeof gcsStorageOptions.clientUploads === 'object'\n ? gcsStorageOptions.clientUploads.access\n : undefined,\n bucket: gcsStorageOptions.bucket,\n collections: gcsStorageOptions.collections,\n getStorageClient,\n }),\n serverHandlerPath: '/storage-gcs-generate-signed-url',\n })\n\n if (isPluginDisabled) {\n return incomingConfig\n }\n\n // Add adapter to each collection option object\n const collectionsWithAdapter: CloudStoragePluginOptions['collections'] = Object.entries(\n gcsStorageOptions.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 alwaysInsertFields: gcsStorageOptions.alwaysInsertFields,\n collections: collectionsWithAdapter,\n useCompositePrefixes: gcsStorageOptions.useCompositePrefixes,\n })(config)\n }\n"],"names":["Storage","cloudStoragePlugin","initClientUploads","createGcsAdapter","getGenerateSignedURLHandler","gcsClients","Map","gcsStorage","gcsStorageOptions","incomingConfig","cacheKey","clientCacheKey","bucket","getStorageClient","has","get","set","options","adapter","acl","clientUploads","useCompositePrefixes","isPluginDisabled","enabled","clientHandler","collections","config","Boolean","serverHandler","access","undefined","serverHandlerPath","collectionsWithAdapter","Object","entries","reduce","acc","slug","collOptions","map","collection","upload","disableLocalStorage","alwaysInsertFields"],"mappings":"AAQA,SAASA,OAAO,QAAQ,wBAAuB;AAC/C,SAASC,kBAAkB,QAAQ,mCAAkC;AACrE,SAASC,iBAAiB,QAAQ,6CAA4C;AAE9E,SAASC,gBAAgB,QAAQ,eAAc;AAC/C,SAASC,2BAA2B,QAAQ,yBAAwB;AAkEpE,MAAMC,aAAa,IAAIC;AAEvB,OAAO,MAAMC,aACX,CAACC,oBACD,CAACC;QACC,MAAMC,WAAWF,kBAAkBG,cAAc,IAAI,CAAC,IAAI,EAAEH,kBAAkBI,MAAM,EAAE;QAEtF,MAAMC,mBAAmB;YACvB,IAAIR,WAAWS,GAAG,CAACJ,WAAW;gBAC5B,OAAOL,WAAWU,GAAG,CAACL;YACxB;YACAL,WAAWW,GAAG,CAACN,UAAU,IAAIV,QAAQQ,kBAAkBS,OAAO;YAE9D,OAAOZ,WAAWU,GAAG,CAACL;QACxB;QAEA,MAAMQ,UAAUf,iBAAiB;YAC/BgB,KAAKX,kBAAkBW,GAAG;YAC1BP,QAAQJ,kBAAkBI,MAAM;YAChCQ,eAAeZ,kBAAkBY,aAAa;YAC9CP;YACAQ,sBAAsBb,kBAAkBa,oBAAoB;QAC9D;QAEA,MAAMC,mBAAmBd,kBAAkBe,OAAO,KAAK;QAEvDrB,kBAAkB;YAChBsB,eAAe;YACfC,aAAajB,kBAAkBiB,WAAW;YAC1CC,QAAQjB;YACRc,SAAS,CAACD,oBAAoBK,QAAQnB,kBAAkBY,aAAa;YACrEQ,eAAexB,4BAA4B;gBACzCyB,QACE,OAAOrB,kBAAkBY,aAAa,KAAK,WACvCZ,kBAAkBY,aAAa,CAACS,MAAM,GACtCC;gBACNlB,QAAQJ,kBAAkBI,MAAM;gBAChCa,aAAajB,kBAAkBiB,WAAW;gBAC1CZ;
|
|
1
|
+
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { StorageOptions } from '@google-cloud/storage'\nimport type {\n ClientUploadsConfig,\n PluginOptions as CloudStoragePluginOptions,\n CollectionOptions,\n} from '@payloadcms/plugin-cloud-storage/types'\nimport type { Config, Plugin, UploadCollectionSlug } from 'payload'\n\nimport { Storage } from '@google-cloud/storage'\nimport { cloudStoragePlugin } from '@payloadcms/plugin-cloud-storage'\nimport { initClientUploads } from '@payloadcms/plugin-cloud-storage/utilities'\n\nimport { createGcsAdapter } from './adapter.js'\nimport { getGenerateSignedURLHandler } from './generateSignedURL.js'\n\nexport interface GcsStorageOptions {\n acl?: 'Private' | 'Public'\n\n /**\n * When enabled, fields (like the prefix field) will always be inserted into\n * the collection schema regardless of whether the plugin is enabled. This\n * ensures a consistent schema across all environments.\n *\n * This will be enabled by default in Payload v4.\n *\n * @default false\n */\n alwaysInsertFields?: boolean\n\n /**\n * The name of the bucket to use.\n */\n bucket: string\n /**\n * Optional cache key to identify the GCS storage client instance.\n * If not provided, a default key will be used.\n *\n * @default `gcs:containerName`\n */\n clientCacheKey?: string\n /**\n * Do uploads directly on the client to bypass limits on Vercel. You must allow CORS PUT method for the bucket to your website.\n */\n clientUploads?: ClientUploadsConfig\n /**\n * Collection options to apply the S3 adapter to.\n */\n collections: Partial<Record<UploadCollectionSlug, Omit<CollectionOptions, 'adapter'> | true>>\n /**\n * Whether or not to enable the plugin\n *\n * Default: true\n */\n enabled?: boolean\n /**\n * Google Cloud Storage client configuration.\n *\n * @see https://github.com/googleapis/nodejs-storage\n */\n options: StorageOptions\n\n /**\n * When true, the collection-level prefix and document-level prefix are combined\n * (compositional). When false (default), document prefix overrides collection\n * prefix entirely.\n *\n * Example:\n * - collection prefix: `collection-prefix/`\n * - document prefix: `document-prefix/`\n * - resulting prefix with useCompositePrefixes=true: `collection-prefix/document-prefix/`\n * - resulting prefix with useCompositePrefixes=false: `document-prefix/`\n *\n * @default false\n */\n useCompositePrefixes?: boolean\n}\n\ntype GcsStoragePlugin = (gcsStorageArgs: GcsStorageOptions) => Plugin\n\nconst gcsClients = new Map<string, Storage>()\n\nexport const gcsStorage: GcsStoragePlugin =\n (gcsStorageOptions: GcsStorageOptions) =>\n (incomingConfig: Config): Config => {\n const cacheKey = gcsStorageOptions.clientCacheKey || `gcs:${gcsStorageOptions.bucket}`\n\n const getStorageClient = (): Storage => {\n if (gcsClients.has(cacheKey)) {\n return gcsClients.get(cacheKey)!\n }\n gcsClients.set(cacheKey, new Storage(gcsStorageOptions.options))\n\n return gcsClients.get(cacheKey)!\n }\n\n const adapter = createGcsAdapter({\n acl: gcsStorageOptions.acl,\n bucket: gcsStorageOptions.bucket,\n clientUploads: gcsStorageOptions.clientUploads,\n getStorageClient,\n useCompositePrefixes: gcsStorageOptions.useCompositePrefixes,\n })\n\n const isPluginDisabled = gcsStorageOptions.enabled === false\n\n initClientUploads({\n clientHandler: '@payloadcms/storage-gcs/client#GcsClientUploadHandler',\n collections: gcsStorageOptions.collections,\n config: incomingConfig,\n enabled: !isPluginDisabled && Boolean(gcsStorageOptions.clientUploads),\n serverHandler: getGenerateSignedURLHandler({\n access:\n typeof gcsStorageOptions.clientUploads === 'object'\n ? gcsStorageOptions.clientUploads.access\n : undefined,\n bucket: gcsStorageOptions.bucket,\n collections: gcsStorageOptions.collections,\n getStorageClient,\n useCompositePrefixes: gcsStorageOptions.useCompositePrefixes,\n }),\n serverHandlerPath: '/storage-gcs-generate-signed-url',\n })\n\n if (isPluginDisabled) {\n return incomingConfig\n }\n\n // Add adapter to each collection option object\n const collectionsWithAdapter: CloudStoragePluginOptions['collections'] = Object.entries(\n gcsStorageOptions.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 alwaysInsertFields: gcsStorageOptions.alwaysInsertFields,\n collections: collectionsWithAdapter,\n useCompositePrefixes: gcsStorageOptions.useCompositePrefixes,\n })(config)\n }\n"],"names":["Storage","cloudStoragePlugin","initClientUploads","createGcsAdapter","getGenerateSignedURLHandler","gcsClients","Map","gcsStorage","gcsStorageOptions","incomingConfig","cacheKey","clientCacheKey","bucket","getStorageClient","has","get","set","options","adapter","acl","clientUploads","useCompositePrefixes","isPluginDisabled","enabled","clientHandler","collections","config","Boolean","serverHandler","access","undefined","serverHandlerPath","collectionsWithAdapter","Object","entries","reduce","acc","slug","collOptions","map","collection","upload","disableLocalStorage","alwaysInsertFields"],"mappings":"AAQA,SAASA,OAAO,QAAQ,wBAAuB;AAC/C,SAASC,kBAAkB,QAAQ,mCAAkC;AACrE,SAASC,iBAAiB,QAAQ,6CAA4C;AAE9E,SAASC,gBAAgB,QAAQ,eAAc;AAC/C,SAASC,2BAA2B,QAAQ,yBAAwB;AAkEpE,MAAMC,aAAa,IAAIC;AAEvB,OAAO,MAAMC,aACX,CAACC,oBACD,CAACC;QACC,MAAMC,WAAWF,kBAAkBG,cAAc,IAAI,CAAC,IAAI,EAAEH,kBAAkBI,MAAM,EAAE;QAEtF,MAAMC,mBAAmB;YACvB,IAAIR,WAAWS,GAAG,CAACJ,WAAW;gBAC5B,OAAOL,WAAWU,GAAG,CAACL;YACxB;YACAL,WAAWW,GAAG,CAACN,UAAU,IAAIV,QAAQQ,kBAAkBS,OAAO;YAE9D,OAAOZ,WAAWU,GAAG,CAACL;QACxB;QAEA,MAAMQ,UAAUf,iBAAiB;YAC/BgB,KAAKX,kBAAkBW,GAAG;YAC1BP,QAAQJ,kBAAkBI,MAAM;YAChCQ,eAAeZ,kBAAkBY,aAAa;YAC9CP;YACAQ,sBAAsBb,kBAAkBa,oBAAoB;QAC9D;QAEA,MAAMC,mBAAmBd,kBAAkBe,OAAO,KAAK;QAEvDrB,kBAAkB;YAChBsB,eAAe;YACfC,aAAajB,kBAAkBiB,WAAW;YAC1CC,QAAQjB;YACRc,SAAS,CAACD,oBAAoBK,QAAQnB,kBAAkBY,aAAa;YACrEQ,eAAexB,4BAA4B;gBACzCyB,QACE,OAAOrB,kBAAkBY,aAAa,KAAK,WACvCZ,kBAAkBY,aAAa,CAACS,MAAM,GACtCC;gBACNlB,QAAQJ,kBAAkBI,MAAM;gBAChCa,aAAajB,kBAAkBiB,WAAW;gBAC1CZ;gBACAQ,sBAAsBb,kBAAkBa,oBAAoB;YAC9D;YACAU,mBAAmB;QACrB;QAEA,IAAIT,kBAAkB;YACpB,OAAOb;QACT;QAEA,+CAA+C;QAC/C,MAAMuB,yBAAmEC,OAAOC,OAAO,CACrF1B,kBAAkBiB,WAAW,EAC7BU,MAAM,CACN,CAACC,KAAK,CAACC,MAAMC,YAAY,GAAM,CAAA;gBAC7B,GAAGF,GAAG;gBACN,CAACC,KAAK,EAAE;oBACN,GAAIC,gBAAgB,OAAO,CAAC,IAAIA,WAAW;oBAC3CpB;gBACF;YACF,CAAA,GACA,CAAC;QAGH,gFAAgF;QAChF,MAAMQ,SAAS;YACb,GAAGjB,cAAc;YACjBgB,aAAa,AAAChB,CAAAA,eAAegB,WAAW,IAAI,EAAE,AAAD,EAAGc,GAAG,CAAC,CAACC;gBACnD,IAAI,CAACR,sBAAsB,CAACQ,WAAWH,IAAI,CAAC,EAAE;oBAC5C,OAAOG;gBACT;gBAEA,OAAO;oBACL,GAAGA,UAAU;oBACbC,QAAQ;wBACN,GAAI,OAAOD,WAAWC,MAAM,KAAK,WAAWD,WAAWC,MAAM,GAAG,CAAC,CAAC;wBAClEC,qBAAqB;oBACvB;gBACF;YACF;QACF;QAEA,OAAOzC,mBAAmB;YACxB0C,oBAAoBnC,kBAAkBmC,kBAAkB;YACxDlB,aAAaO;YACbX,sBAAsBb,kBAAkBa,oBAAoB;QAC9D,GAAGK;IACL,EAAC"}
|
package/dist/uploadFile.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { getFileKey } from '@payloadcms/plugin-cloud-storage/utilities';
|
|
2
2
|
export async function uploadFile({ acl, bucket, buffer, client, collectionPrefix = '', docPrefix, filename, mimeType, useCompositePrefixes = false }) {
|
|
3
|
-
const fileKey = getFileKey({
|
|
3
|
+
const { fileKey } = getFileKey({
|
|
4
4
|
collectionPrefix,
|
|
5
5
|
docPrefix: docPrefix || '',
|
|
6
6
|
filename,
|
package/dist/uploadFile.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/uploadFile.ts"],"sourcesContent":["import type { Storage } from '@google-cloud/storage'\n\nimport { getFileKey } from '@payloadcms/plugin-cloud-storage/utilities'\n\ninterface UploadFileArgs {\n acl?: 'Private' | 'Public'\n bucket: string\n buffer: Buffer\n client: Storage\n collectionPrefix?: string\n docPrefix?: string\n filename: string\n mimeType: string\n useCompositePrefixes?: boolean\n}\n\nexport async function uploadFile({\n acl,\n bucket,\n buffer,\n client,\n collectionPrefix = '',\n docPrefix,\n filename,\n mimeType,\n useCompositePrefixes = false,\n}: UploadFileArgs): Promise<void> {\n const fileKey = getFileKey({\n collectionPrefix,\n docPrefix: docPrefix || '',\n filename,\n useCompositePrefixes,\n })\n\n const gcsFile = client.bucket(bucket).file(fileKey)\n\n await gcsFile.save(buffer, {\n metadata: {\n contentType: mimeType,\n },\n })\n\n if (acl) {\n await gcsFile[`make${acl}`]()\n }\n}\n"],"names":["getFileKey","uploadFile","acl","bucket","buffer","client","collectionPrefix","docPrefix","filename","mimeType","useCompositePrefixes","fileKey","gcsFile","file","save","metadata","contentType"],"mappings":"AAEA,SAASA,UAAU,QAAQ,6CAA4C;AAcvE,OAAO,eAAeC,WAAW,EAC/BC,GAAG,EACHC,MAAM,EACNC,MAAM,EACNC,MAAM,EACNC,mBAAmB,EAAE,EACrBC,SAAS,EACTC,QAAQ,EACRC,QAAQ,EACRC,uBAAuB,KAAK,EACb;IACf,
|
|
1
|
+
{"version":3,"sources":["../src/uploadFile.ts"],"sourcesContent":["import type { Storage } from '@google-cloud/storage'\n\nimport { getFileKey } from '@payloadcms/plugin-cloud-storage/utilities'\n\ninterface UploadFileArgs {\n acl?: 'Private' | 'Public'\n bucket: string\n buffer: Buffer\n client: Storage\n collectionPrefix?: string\n docPrefix?: string\n filename: string\n mimeType: string\n useCompositePrefixes?: boolean\n}\n\nexport async function uploadFile({\n acl,\n bucket,\n buffer,\n client,\n collectionPrefix = '',\n docPrefix,\n filename,\n mimeType,\n useCompositePrefixes = false,\n}: UploadFileArgs): Promise<void> {\n const { fileKey } = getFileKey({\n collectionPrefix,\n docPrefix: docPrefix || '',\n filename,\n useCompositePrefixes,\n })\n\n const gcsFile = client.bucket(bucket).file(fileKey)\n\n await gcsFile.save(buffer, {\n metadata: {\n contentType: mimeType,\n },\n })\n\n if (acl) {\n await gcsFile[`make${acl}`]()\n }\n}\n"],"names":["getFileKey","uploadFile","acl","bucket","buffer","client","collectionPrefix","docPrefix","filename","mimeType","useCompositePrefixes","fileKey","gcsFile","file","save","metadata","contentType"],"mappings":"AAEA,SAASA,UAAU,QAAQ,6CAA4C;AAcvE,OAAO,eAAeC,WAAW,EAC/BC,GAAG,EACHC,MAAM,EACNC,MAAM,EACNC,MAAM,EACNC,mBAAmB,EAAE,EACrBC,SAAS,EACTC,QAAQ,EACRC,QAAQ,EACRC,uBAAuB,KAAK,EACb;IACf,MAAM,EAAEC,OAAO,EAAE,GAAGX,WAAW;QAC7BM;QACAC,WAAWA,aAAa;QACxBC;QACAE;IACF;IAEA,MAAME,UAAUP,OAAOF,MAAM,CAACA,QAAQU,IAAI,CAACF;IAE3C,MAAMC,QAAQE,IAAI,CAACV,QAAQ;QACzBW,UAAU;YACRC,aAAaP;QACf;IACF;IAEA,IAAIP,KAAK;QACP,MAAMU,OAAO,CAAC,CAAC,IAAI,EAAEV,KAAK,CAAC;IAC7B;AACF"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@payloadcms/storage-gcs",
|
|
3
|
-
"version": "3.84.0-
|
|
3
|
+
"version": "3.84.0-internal.d5d6e43",
|
|
4
4
|
"description": "Payload storage adapter for Google Cloud Storage",
|
|
5
5
|
"homepage": "https://payloadcms.com",
|
|
6
6
|
"repository": {
|
|
@@ -38,13 +38,13 @@
|
|
|
38
38
|
],
|
|
39
39
|
"dependencies": {
|
|
40
40
|
"@google-cloud/storage": "7.19.0",
|
|
41
|
-
"@payloadcms/plugin-cloud-storage": "3.84.0-
|
|
41
|
+
"@payloadcms/plugin-cloud-storage": "3.84.0-internal.d5d6e43"
|
|
42
42
|
},
|
|
43
43
|
"devDependencies": {
|
|
44
|
-
"payload": "3.84.0-
|
|
44
|
+
"payload": "3.84.0-internal.d5d6e43"
|
|
45
45
|
},
|
|
46
46
|
"peerDependencies": {
|
|
47
|
-
"payload": "3.84.0-
|
|
47
|
+
"payload": "3.84.0-internal.d5d6e43"
|
|
48
48
|
},
|
|
49
49
|
"engines": {
|
|
50
50
|
"node": "^18.20.2 || >=20.9.0"
|