@payloadcms/storage-gcs 4.0.0-internal.697830c → 4.0.0-internal.77191e5
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 +1 -1
- package/dist/adapter.d.ts.map +1 -1
- package/dist/adapter.js +19 -13
- package/dist/adapter.js.map +1 -1
- package/dist/deleteFile.d.ts +2 -5
- package/dist/deleteFile.d.ts.map +1 -1
- package/dist/deleteFile.js +2 -9
- package/dist/deleteFile.js.map +1 -1
- package/dist/generateURL.js +3 -3
- package/dist/generateURL.js.map +1 -1
- package/dist/generateUploadInstructions.d.ts +12 -0
- package/dist/generateUploadInstructions.d.ts.map +1 -0
- package/dist/generateUploadInstructions.js +56 -0
- package/dist/generateUploadInstructions.js.map +1 -0
- package/dist/getFile.d.ts +4 -4
- package/dist/getFile.d.ts.map +1 -1
- package/dist/getFile.js +13 -11
- package/dist/getFile.js.map +1 -1
- package/dist/index.d.ts +9 -18
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +14 -18
- package/dist/index.js.map +1 -1
- package/dist/uploadFile.d.ts +2 -5
- package/dist/uploadFile.d.ts.map +1 -1
- package/dist/uploadFile.js +2 -9
- package/dist/uploadFile.js.map +1 -1
- package/package.json +4 -9
- package/dist/client/GcsClientUploadHandler.d.ts +0 -9
- package/dist/client/GcsClientUploadHandler.d.ts.map +0 -1
- package/dist/client/GcsClientUploadHandler.js +0 -39
- package/dist/client/GcsClientUploadHandler.js.map +0 -1
- package/dist/exports/client.d.ts +0 -2
- package/dist/exports/client.d.ts.map +0 -1
- package/dist/exports/client.js +0 -3
- package/dist/exports/client.js.map +0 -1
- package/dist/generateSignedURL.d.ts +0 -15
- package/dist/generateSignedURL.d.ts.map +0 -1
- package/dist/generateSignedURL.js +0 -43
- package/dist/generateSignedURL.js.map +0 -1
package/README.md
CHANGED
|
@@ -14,7 +14,7 @@ pnpm add @payloadcms/storage-gcs
|
|
|
14
14
|
|
|
15
15
|
- Configure the `collections` object to specify which collections should use the Google Cloud Storage adapter. The slug _must_ match one of your existing collection slugs.
|
|
16
16
|
- When enabled, this package will automatically set `disableLocalStorage` to `true` for each collection.
|
|
17
|
-
- When deploying to Vercel, server uploads are limited
|
|
17
|
+
- When deploying to Vercel, server uploads are limited to 4.5MB. Set `clientUploads` to `true` to use upload instructions and send files directly to GCS. You must allow CORS `PUT` requests from your website.
|
|
18
18
|
|
|
19
19
|
```ts
|
|
20
20
|
import { gcsStorage } from '@payloadcms/storage-gcs'
|
package/dist/adapter.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../src/adapter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;AACpD,OAAO,KAAK,EACV,OAAO,EACP,mBAAmB,EAEpB,MAAM,wCAAwC,CAAA;
|
|
1
|
+
{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../src/adapter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;AACpD,OAAO,KAAK,EACV,OAAO,EACP,mBAAmB,EAEpB,MAAM,wCAAwC,CAAA;AAQ/C,UAAU,oBAAoB;IAC5B,GAAG,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAA;IAC1B,MAAM,EAAE,MAAM,CAAA;IACd,aAAa,CAAC,EAAE,mBAAmB,CAAA;IACnC,gBAAgB,EAAE,MAAM,OAAO,CAAA;IAC/B,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B;AAED,wBAAgB,gBAAgB,CAAC,EAC/B,GAAG,EACH,MAAM,EACN,aAAa,EACb,gBAAgB,EAChB,oBAA4B,GAC7B,EAAE,oBAAoB,GAAG,OAAO,CA6DhC"}
|
package/dist/adapter.js
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
import { deleteFile } from './deleteFile.js';
|
|
2
|
+
import { generateUploadInstructions } from './generateUploadInstructions.js';
|
|
2
3
|
import { generateURL } from './generateURL.js';
|
|
3
4
|
import { getFile } from './getFile.js';
|
|
4
5
|
import { uploadFile } from './uploadFile.js';
|
|
5
6
|
export function createGcsAdapter({ acl, bucket, clientUploads, getStorageClient, useCompositePrefixes = false }) {
|
|
6
7
|
return ({ collection, prefix = '' })=>({
|
|
7
8
|
name: 'gcs',
|
|
8
|
-
clientUploads,
|
|
9
9
|
generateURL: ({ filename, prefix: urlPrefix = '' })=>generateURL({
|
|
10
10
|
bucket,
|
|
11
11
|
client: getStorageClient(),
|
|
@@ -14,38 +14,44 @@ export function createGcsAdapter({ acl, bucket, clientUploads, getStorageClient,
|
|
|
14
14
|
prefix: urlPrefix,
|
|
15
15
|
useCompositePrefixes
|
|
16
16
|
}),
|
|
17
|
-
|
|
17
|
+
uploadInstructions: {
|
|
18
|
+
enabled: Boolean(clientUploads),
|
|
19
|
+
generate: generateUploadInstructions({
|
|
20
|
+
access: typeof clientUploads === 'object' ? clientUploads.access : undefined,
|
|
18
21
|
bucket,
|
|
19
|
-
client: getStorageClient(),
|
|
20
22
|
collectionPrefix: prefix,
|
|
21
|
-
|
|
22
|
-
filename,
|
|
23
|
+
getStorageClient,
|
|
23
24
|
useCompositePrefixes
|
|
24
25
|
}),
|
|
25
|
-
|
|
26
|
+
requiresUploadReceipt: true,
|
|
27
|
+
useInAdmin: true
|
|
28
|
+
},
|
|
29
|
+
handleDelete: ({ storageFilePath })=>deleteFile({
|
|
30
|
+
bucket,
|
|
31
|
+
client: getStorageClient(),
|
|
32
|
+
storageFilePath
|
|
33
|
+
}),
|
|
34
|
+
handleUpload: async ({ data, file, storageFilePath })=>{
|
|
26
35
|
await uploadFile({
|
|
27
36
|
acl,
|
|
28
37
|
bucket,
|
|
29
38
|
buffer: file.buffer,
|
|
30
39
|
client: getStorageClient(),
|
|
31
|
-
collectionPrefix: prefix,
|
|
32
|
-
docPrefix: data.prefix,
|
|
33
|
-
filename: file.filename,
|
|
34
40
|
mimeType: file.mimeType,
|
|
35
|
-
|
|
41
|
+
storageFilePath
|
|
36
42
|
});
|
|
37
43
|
return data;
|
|
38
44
|
},
|
|
39
|
-
staticHandler: (req, { headers, params: {
|
|
45
|
+
staticHandler: (req, { doc, headers, params: { filename, uploadReference } })=>getFile({
|
|
40
46
|
bucket,
|
|
41
47
|
client: getStorageClient(),
|
|
42
|
-
clientUploadContext,
|
|
43
48
|
collection,
|
|
44
49
|
collectionPrefix: prefix,
|
|
50
|
+
doc,
|
|
45
51
|
filename,
|
|
46
52
|
incomingHeaders: headers,
|
|
47
|
-
prefixQueryParam,
|
|
48
53
|
req,
|
|
54
|
+
uploadReference,
|
|
49
55
|
useCompositePrefixes
|
|
50
56
|
})
|
|
51
57
|
});
|
package/dist/adapter.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/adapter.ts"],"sourcesContent":["import type { Storage } from '@google-cloud/storage'\nimport type {\n Adapter,\n ClientUploadsConfig,\n GeneratedAdapter,\n} from '@payloadcms/plugin-cloud-storage/types'\n\nimport { deleteFile } from './deleteFile.js'\nimport { generateURL } from './generateURL.js'\nimport { getFile } from './getFile.js'\nimport { uploadFile } from './uploadFile.js'\n\ninterface CreateGcsAdapterArgs {\n acl?: 'Private' | 'Public'\n bucket: string\n clientUploads?: ClientUploadsConfig\n getStorageClient: () => Storage\n useCompositePrefixes?: boolean\n}\n\nexport function createGcsAdapter({\n acl,\n bucket,\n clientUploads,\n getStorageClient,\n useCompositePrefixes = false,\n}: CreateGcsAdapterArgs): Adapter {\n return ({ collection, prefix = '' }): GeneratedAdapter => ({\n name: 'gcs',\n
|
|
1
|
+
{"version":3,"sources":["../src/adapter.ts"],"sourcesContent":["import type { Storage } from '@google-cloud/storage'\nimport type {\n Adapter,\n ClientUploadsConfig,\n GeneratedAdapter,\n} from '@payloadcms/plugin-cloud-storage/types'\n\nimport { deleteFile } from './deleteFile.js'\nimport { generateUploadInstructions } from './generateUploadInstructions.js'\nimport { generateURL } from './generateURL.js'\nimport { getFile } from './getFile.js'\nimport { uploadFile } from './uploadFile.js'\n\ninterface CreateGcsAdapterArgs {\n acl?: 'Private' | 'Public'\n bucket: string\n clientUploads?: ClientUploadsConfig\n getStorageClient: () => Storage\n useCompositePrefixes?: boolean\n}\n\nexport function createGcsAdapter({\n acl,\n bucket,\n clientUploads,\n getStorageClient,\n useCompositePrefixes = false,\n}: CreateGcsAdapterArgs): Adapter {\n return ({ collection, prefix = '' }): GeneratedAdapter => ({\n name: 'gcs',\n\n generateURL: ({ filename, prefix: urlPrefix = '' }) =>\n generateURL({\n bucket,\n client: getStorageClient(),\n collectionPrefix: prefix,\n filename,\n prefix: urlPrefix,\n useCompositePrefixes,\n }),\n\n uploadInstructions: {\n enabled: Boolean(clientUploads),\n generate: generateUploadInstructions({\n access: typeof clientUploads === 'object' ? clientUploads.access : undefined,\n bucket,\n collectionPrefix: prefix,\n getStorageClient,\n useCompositePrefixes,\n }),\n requiresUploadReceipt: true,\n useInAdmin: true,\n },\n\n handleDelete: ({ storageFilePath }) =>\n deleteFile({\n bucket,\n client: getStorageClient(),\n storageFilePath,\n }),\n\n handleUpload: async ({ data, file, storageFilePath }) => {\n await uploadFile({\n acl,\n bucket,\n buffer: file.buffer,\n client: getStorageClient(),\n mimeType: file.mimeType,\n storageFilePath,\n })\n\n return data\n },\n\n staticHandler: (req, { doc, headers, params: { filename, uploadReference } }) =>\n getFile({\n bucket,\n client: getStorageClient(),\n collection,\n collectionPrefix: prefix,\n doc,\n filename,\n incomingHeaders: headers,\n req,\n uploadReference,\n useCompositePrefixes,\n }),\n })\n}\n"],"names":["deleteFile","generateUploadInstructions","generateURL","getFile","uploadFile","createGcsAdapter","acl","bucket","clientUploads","getStorageClient","useCompositePrefixes","collection","prefix","name","filename","urlPrefix","client","collectionPrefix","uploadInstructions","enabled","Boolean","generate","access","undefined","requiresUploadReceipt","useInAdmin","handleDelete","storageFilePath","handleUpload","data","file","buffer","mimeType","staticHandler","req","doc","headers","params","uploadReference","incomingHeaders"],"mappings":"AAOA,SAASA,UAAU,QAAQ,kBAAiB;AAC5C,SAASC,0BAA0B,QAAQ,kCAAiC;AAC5E,SAASC,WAAW,QAAQ,mBAAkB;AAC9C,SAASC,OAAO,QAAQ,eAAc;AACtC,SAASC,UAAU,QAAQ,kBAAiB;AAU5C,OAAO,SAASC,iBAAiB,EAC/BC,GAAG,EACHC,MAAM,EACNC,aAAa,EACbC,gBAAgB,EAChBC,uBAAuB,KAAK,EACP;IACrB,OAAO,CAAC,EAAEC,UAAU,EAAEC,SAAS,EAAE,EAAE,GAAwB,CAAA;YACzDC,MAAM;YAENX,aAAa,CAAC,EAAEY,QAAQ,EAAEF,QAAQG,YAAY,EAAE,EAAE,GAChDb,YAAY;oBACVK;oBACAS,QAAQP;oBACRQ,kBAAkBL;oBAClBE;oBACAF,QAAQG;oBACRL;gBACF;YAEFQ,oBAAoB;gBAClBC,SAASC,QAAQZ;gBACjBa,UAAUpB,2BAA2B;oBACnCqB,QAAQ,OAAOd,kBAAkB,WAAWA,cAAcc,MAAM,GAAGC;oBACnEhB;oBACAU,kBAAkBL;oBAClBH;oBACAC;gBACF;gBACAc,uBAAuB;gBACvBC,YAAY;YACd;YAEAC,cAAc,CAAC,EAAEC,eAAe,EAAE,GAChC3B,WAAW;oBACTO;oBACAS,QAAQP;oBACRkB;gBACF;YAEFC,cAAc,OAAO,EAAEC,IAAI,EAAEC,IAAI,EAAEH,eAAe,EAAE;gBAClD,MAAMvB,WAAW;oBACfE;oBACAC;oBACAwB,QAAQD,KAAKC,MAAM;oBACnBf,QAAQP;oBACRuB,UAAUF,KAAKE,QAAQ;oBACvBL;gBACF;gBAEA,OAAOE;YACT;YAEAI,eAAe,CAACC,KAAK,EAAEC,GAAG,EAAEC,OAAO,EAAEC,QAAQ,EAAEvB,QAAQ,EAAEwB,eAAe,EAAE,EAAE,GAC1EnC,QAAQ;oBACNI;oBACAS,QAAQP;oBACRE;oBACAM,kBAAkBL;oBAClBuB;oBACArB;oBACAyB,iBAAiBH;oBACjBF;oBACAI;oBACA5B;gBACF;QACJ,CAAA;AACF"}
|
package/dist/deleteFile.d.ts
CHANGED
|
@@ -2,11 +2,8 @@ import type { Storage } from '@google-cloud/storage';
|
|
|
2
2
|
interface DeleteFileArgs {
|
|
3
3
|
bucket: string;
|
|
4
4
|
client: Storage;
|
|
5
|
-
|
|
6
|
-
docPrefix: string;
|
|
7
|
-
filename: string;
|
|
8
|
-
useCompositePrefixes?: boolean;
|
|
5
|
+
storageFilePath: string;
|
|
9
6
|
}
|
|
10
|
-
export declare function deleteFile({ bucket, client,
|
|
7
|
+
export declare function deleteFile({ bucket, client, storageFilePath, }: DeleteFileArgs): Promise<void>;
|
|
11
8
|
export {};
|
|
12
9
|
//# sourceMappingURL=deleteFile.d.ts.map
|
package/dist/deleteFile.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"deleteFile.d.ts","sourceRoot":"","sources":["../src/deleteFile.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;
|
|
1
|
+
{"version":3,"file":"deleteFile.d.ts","sourceRoot":"","sources":["../src/deleteFile.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;AAEpD,UAAU,cAAc;IACtB,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,OAAO,CAAA;IACf,eAAe,EAAE,MAAM,CAAA;CACxB;AAED,wBAAsB,UAAU,CAAC,EAC/B,MAAM,EACN,MAAM,EACN,eAAe,GAChB,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAIhC"}
|
package/dist/deleteFile.js
CHANGED
|
@@ -1,12 +1,5 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
const { fileKey } = getFileKey({
|
|
4
|
-
collectionPrefix,
|
|
5
|
-
docPrefix,
|
|
6
|
-
filename,
|
|
7
|
-
useCompositePrefixes
|
|
8
|
-
});
|
|
9
|
-
await client.bucket(bucket).file(fileKey).delete({
|
|
1
|
+
export async function deleteFile({ bucket, client, storageFilePath }) {
|
|
2
|
+
await client.bucket(bucket).file(storageFilePath).delete({
|
|
10
3
|
ignoreNotFound: true
|
|
11
4
|
});
|
|
12
5
|
}
|
package/dist/deleteFile.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/deleteFile.ts"],"sourcesContent":["import type { Storage } from '@google-cloud/storage'\n\
|
|
1
|
+
{"version":3,"sources":["../src/deleteFile.ts"],"sourcesContent":["import type { Storage } from '@google-cloud/storage'\n\ninterface DeleteFileArgs {\n bucket: string\n client: Storage\n storageFilePath: string\n}\n\nexport async function deleteFile({\n bucket,\n client,\n storageFilePath,\n}: DeleteFileArgs): Promise<void> {\n await client.bucket(bucket).file(storageFilePath).delete({\n ignoreNotFound: true,\n })\n}\n"],"names":["deleteFile","bucket","client","storageFilePath","file","delete","ignoreNotFound"],"mappings":"AAQA,OAAO,eAAeA,WAAW,EAC/BC,MAAM,EACNC,MAAM,EACNC,eAAe,EACA;IACf,MAAMD,OAAOD,MAAM,CAACA,QAAQG,IAAI,CAACD,iBAAiBE,MAAM,CAAC;QACvDC,gBAAgB;IAClB;AACF"}
|
package/dist/generateURL.js
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { buildStoragePathData } from '@payloadcms/plugin-cloud-storage/utilities';
|
|
2
2
|
export function generateURL({ bucket, client, collectionPrefix = '', filename, prefix, useCompositePrefixes = false }) {
|
|
3
|
-
const {
|
|
3
|
+
const { storageFilePath } = buildStoragePathData({
|
|
4
4
|
collectionPrefix,
|
|
5
5
|
docPrefix: prefix,
|
|
6
6
|
filename,
|
|
7
7
|
useCompositePrefixes
|
|
8
8
|
});
|
|
9
|
-
return client.bucket(bucket).file(
|
|
9
|
+
return client.bucket(bucket).file(storageFilePath).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 {
|
|
1
|
+
{"version":3,"sources":["../src/generateURL.ts"],"sourcesContent":["import type { Storage } from '@google-cloud/storage'\n\nimport { buildStoragePathData } 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 { storageFilePath } = buildStoragePathData({\n collectionPrefix,\n docPrefix: prefix,\n filename,\n useCompositePrefixes,\n })\n\n return client.bucket(bucket).file(storageFilePath).publicUrl()\n}\n"],"names":["buildStoragePathData","generateURL","bucket","client","collectionPrefix","filename","prefix","useCompositePrefixes","storageFilePath","docPrefix","file","publicUrl"],"mappings":"AAEA,SAASA,oBAAoB,QAAQ,6CAA4C;AAWjF,OAAO,SAASC,YAAY,EAC1BC,MAAM,EACNC,MAAM,EACNC,mBAAmB,EAAE,EACrBC,QAAQ,EACRC,MAAM,EACNC,uBAAuB,KAAK,EACZ;IAChB,MAAM,EAAEC,eAAe,EAAE,GAAGR,qBAAqB;QAC/CI;QACAK,WAAWH;QACXD;QACAE;IACF;IAEA,OAAOJ,OAAOD,MAAM,CAACA,QAAQQ,IAAI,CAACF,iBAAiBG,SAAS;AAC9D"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type { Storage } from '@google-cloud/storage';
|
|
2
|
+
import type { GenerateUploadInstructions, UploadInstructionsAccess } from 'payload';
|
|
3
|
+
interface Args {
|
|
4
|
+
access?: UploadInstructionsAccess;
|
|
5
|
+
bucket: string;
|
|
6
|
+
collectionPrefix: string;
|
|
7
|
+
getStorageClient: () => Storage;
|
|
8
|
+
useCompositePrefixes?: boolean;
|
|
9
|
+
}
|
|
10
|
+
export declare const generateUploadInstructions: ({ access, bucket, collectionPrefix, getStorageClient, useCompositePrefixes, }: Args) => GenerateUploadInstructions;
|
|
11
|
+
export {};
|
|
12
|
+
//# sourceMappingURL=generateUploadInstructions.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"generateUploadInstructions.d.ts","sourceRoot":"","sources":["../src/generateUploadInstructions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;AACpD,OAAO,KAAK,EAAE,0BAA0B,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAA;AAMnF,UAAU,IAAI;IACZ,MAAM,CAAC,EAAE,wBAAwB,CAAA;IACjC,MAAM,EAAE,MAAM,CAAA;IACd,gBAAgB,EAAE,MAAM,CAAA;IACxB,gBAAgB,EAAE,MAAM,OAAO,CAAA;IAC/B,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B;AAMD,eAAO,MAAM,0BAA0B,kFAMpC,IAAI,KAAG,0BA0DT,CAAA"}
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
import { resolveSignedURLKey } from '@payloadcms/plugin-cloud-storage/utilities';
|
|
2
|
+
import { Forbidden } from 'payload';
|
|
3
|
+
import { assertClientUploadAllowed } from 'payload/internal';
|
|
4
|
+
const createOnlyHeaders = {
|
|
5
|
+
'x-goog-if-generation-match': '0'
|
|
6
|
+
};
|
|
7
|
+
export const generateUploadInstructions = ({ access, bucket, collectionPrefix, getStorageClient, useCompositePrefixes = false })=>{
|
|
8
|
+
return async ({ collectionSlug, docPrefix, filename, filesize, mimeType, overrideAccess, req })=>{
|
|
9
|
+
if (!overrideAccess && (access ? !await access({
|
|
10
|
+
collectionSlug,
|
|
11
|
+
req
|
|
12
|
+
}) : !req.user)) {
|
|
13
|
+
throw new Forbidden(req.t);
|
|
14
|
+
}
|
|
15
|
+
assertClientUploadAllowed({
|
|
16
|
+
collection: req.payload.collections[collectionSlug]?.config,
|
|
17
|
+
filename,
|
|
18
|
+
mimeType
|
|
19
|
+
});
|
|
20
|
+
const { sanitizedFilename, storageFilePath, uploadReference } = await resolveSignedURLKey({
|
|
21
|
+
collectionPrefix,
|
|
22
|
+
collectionSlug,
|
|
23
|
+
docPrefix,
|
|
24
|
+
filename,
|
|
25
|
+
req,
|
|
26
|
+
useCompositePrefixes
|
|
27
|
+
});
|
|
28
|
+
const [url] = await getStorageClient().bucket(bucket).file(storageFilePath).getSignedUrl({
|
|
29
|
+
action: 'write',
|
|
30
|
+
contentType: mimeType,
|
|
31
|
+
expires: Date.now() + 60 * 60 * 5,
|
|
32
|
+
extensionHeaders: createOnlyHeaders,
|
|
33
|
+
version: 'v4'
|
|
34
|
+
});
|
|
35
|
+
return {
|
|
36
|
+
type: 'http',
|
|
37
|
+
file: {
|
|
38
|
+
filename: sanitizedFilename,
|
|
39
|
+
mimeType,
|
|
40
|
+
size: filesize,
|
|
41
|
+
uploadReference
|
|
42
|
+
},
|
|
43
|
+
request: {
|
|
44
|
+
headers: {
|
|
45
|
+
'Content-Length': String(filesize),
|
|
46
|
+
'Content-Type': mimeType,
|
|
47
|
+
...createOnlyHeaders
|
|
48
|
+
},
|
|
49
|
+
method: 'PUT',
|
|
50
|
+
url
|
|
51
|
+
}
|
|
52
|
+
};
|
|
53
|
+
};
|
|
54
|
+
};
|
|
55
|
+
|
|
56
|
+
//# sourceMappingURL=generateUploadInstructions.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/generateUploadInstructions.ts"],"sourcesContent":["import type { Storage } from '@google-cloud/storage'\nimport type { GenerateUploadInstructions, UploadInstructionsAccess } from 'payload'\n\nimport { resolveSignedURLKey } from '@payloadcms/plugin-cloud-storage/utilities'\nimport { Forbidden } from 'payload'\nimport { assertClientUploadAllowed } from 'payload/internal'\n\ninterface Args {\n access?: UploadInstructionsAccess\n bucket: string\n collectionPrefix: string\n getStorageClient: () => Storage\n useCompositePrefixes?: boolean\n}\n\nconst createOnlyHeaders = {\n 'x-goog-if-generation-match': '0',\n}\n\nexport const generateUploadInstructions = ({\n access,\n bucket,\n collectionPrefix,\n getStorageClient,\n useCompositePrefixes = false,\n}: Args): GenerateUploadInstructions => {\n return async ({\n collectionSlug,\n docPrefix,\n filename,\n filesize,\n mimeType,\n overrideAccess,\n req,\n }) => {\n if (!overrideAccess && (access ? !(await access({ collectionSlug, req })) : !req.user)) {\n throw new Forbidden(req.t)\n }\n\n assertClientUploadAllowed({\n collection: req.payload.collections[collectionSlug]?.config,\n filename,\n mimeType,\n })\n const { sanitizedFilename, storageFilePath, uploadReference } = await resolveSignedURLKey({\n collectionPrefix,\n collectionSlug,\n docPrefix,\n filename,\n req,\n useCompositePrefixes,\n })\n\n const [url] = await getStorageClient()\n .bucket(bucket)\n .file(storageFilePath)\n .getSignedUrl({\n action: 'write',\n contentType: mimeType,\n expires: Date.now() + 60 * 60 * 5,\n extensionHeaders: createOnlyHeaders,\n version: 'v4',\n })\n\n return {\n type: 'http',\n file: {\n filename: sanitizedFilename,\n mimeType,\n size: filesize,\n uploadReference,\n },\n request: {\n headers: {\n 'Content-Length': String(filesize),\n 'Content-Type': mimeType,\n ...createOnlyHeaders,\n },\n method: 'PUT',\n url,\n },\n }\n }\n}\n"],"names":["resolveSignedURLKey","Forbidden","assertClientUploadAllowed","createOnlyHeaders","generateUploadInstructions","access","bucket","collectionPrefix","getStorageClient","useCompositePrefixes","collectionSlug","docPrefix","filename","filesize","mimeType","overrideAccess","req","user","t","collection","payload","collections","config","sanitizedFilename","storageFilePath","uploadReference","url","file","getSignedUrl","action","contentType","expires","Date","now","extensionHeaders","version","type","size","request","headers","String","method"],"mappings":"AAGA,SAASA,mBAAmB,QAAQ,6CAA4C;AAChF,SAASC,SAAS,QAAQ,UAAS;AACnC,SAASC,yBAAyB,QAAQ,mBAAkB;AAU5D,MAAMC,oBAAoB;IACxB,8BAA8B;AAChC;AAEA,OAAO,MAAMC,6BAA6B,CAAC,EACzCC,MAAM,EACNC,MAAM,EACNC,gBAAgB,EAChBC,gBAAgB,EAChBC,uBAAuB,KAAK,EACvB;IACL,OAAO,OAAO,EACZC,cAAc,EACdC,SAAS,EACTC,QAAQ,EACRC,QAAQ,EACRC,QAAQ,EACRC,cAAc,EACdC,GAAG,EACJ;QACC,IAAI,CAACD,kBAAmBV,CAAAA,SAAS,CAAE,MAAMA,OAAO;YAAEK;YAAgBM;QAAI,KAAM,CAACA,IAAIC,IAAI,AAAD,GAAI;YACtF,MAAM,IAAIhB,UAAUe,IAAIE,CAAC;QAC3B;QAEAhB,0BAA0B;YACxBiB,YAAYH,IAAII,OAAO,CAACC,WAAW,CAACX,eAAe,EAAEY;YACrDV;YACAE;QACF;QACA,MAAM,EAAES,iBAAiB,EAAEC,eAAe,EAAEC,eAAe,EAAE,GAAG,MAAMzB,oBAAoB;YACxFO;YACAG;YACAC;YACAC;YACAI;YACAP;QACF;QAEA,MAAM,CAACiB,IAAI,GAAG,MAAMlB,mBACjBF,MAAM,CAACA,QACPqB,IAAI,CAACH,iBACLI,YAAY,CAAC;YACZC,QAAQ;YACRC,aAAahB;YACbiB,SAASC,KAAKC,GAAG,KAAK,KAAK,KAAK;YAChCC,kBAAkB/B;YAClBgC,SAAS;QACX;QAEF,OAAO;YACLC,MAAM;YACNT,MAAM;gBACJf,UAAUW;gBACVT;gBACAuB,MAAMxB;gBACNY;YACF;YACAa,SAAS;gBACPC,SAAS;oBACP,kBAAkBC,OAAO3B;oBACzB,gBAAgBC;oBAChB,GAAGX,iBAAiB;gBACtB;gBACAsC,QAAQ;gBACRf;YACF;QACF;IACF;AACF,EAAC"}
|
package/dist/getFile.d.ts
CHANGED
|
@@ -1,17 +1,17 @@
|
|
|
1
1
|
import type { Storage } from '@google-cloud/storage';
|
|
2
|
-
import type { CollectionConfig, PayloadRequest } from 'payload';
|
|
2
|
+
import type { CollectionConfig, PayloadRequest, TypeWithID } from 'payload';
|
|
3
3
|
interface GetFileArgs {
|
|
4
4
|
bucket: string;
|
|
5
5
|
client: Storage;
|
|
6
|
-
clientUploadContext?: unknown;
|
|
7
6
|
collection: CollectionConfig;
|
|
8
7
|
collectionPrefix?: string;
|
|
8
|
+
doc?: TypeWithID;
|
|
9
9
|
filename: string;
|
|
10
10
|
incomingHeaders?: Headers;
|
|
11
|
-
prefixQueryParam?: string;
|
|
12
11
|
req: PayloadRequest;
|
|
12
|
+
uploadReference?: unknown;
|
|
13
13
|
useCompositePrefixes?: boolean;
|
|
14
14
|
}
|
|
15
|
-
export declare function getFile({ bucket, client,
|
|
15
|
+
export declare function getFile({ bucket, client, collection, collectionPrefix, doc, filename, incomingHeaders, req, uploadReference, useCompositePrefixes, }: GetFileArgs): Promise<Response>;
|
|
16
16
|
export {};
|
|
17
17
|
//# sourceMappingURL=getFile.d.ts.map
|
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,UAAU,EAAE,MAAM,SAAS,CAAA;AAS3E,UAAU,WAAW;IACnB,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,OAAO,CAAA;IACf,UAAU,EAAE,gBAAgB,CAAA;IAC5B,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,GAAG,CAAC,EAAE,UAAU,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,GAAG,EAAE,cAAc,CAAA;IACnB,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B;AAED,wBAAsB,OAAO,CAAC,EAC5B,MAAM,EACN,MAAM,EACN,UAAU,EACV,gBAAqB,EACrB,GAAG,EACH,QAAQ,EACR,eAAe,EACf,GAAG,EACH,eAAe,EACf,oBAA4B,GAC7B,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC,CAmGjC"}
|
package/dist/getFile.js
CHANGED
|
@@ -1,22 +1,24 @@
|
|
|
1
1
|
import { ApiError } from '@google-cloud/storage';
|
|
2
|
-
import { getFilePrefix as getDocPrefix
|
|
3
|
-
import { getRangeRequestInfo } from 'payload/internal';
|
|
4
|
-
export async function getFile({ bucket, client,
|
|
2
|
+
import { buildStoragePathData, getFilePrefix as getDocPrefix } from '@payloadcms/plugin-cloud-storage/utilities';
|
|
3
|
+
import { getRangeRequestInfo, isXmlMimeType, uploadContentSecurityPolicy } from 'payload/internal';
|
|
4
|
+
export async function getFile({ bucket, client, collection, collectionPrefix = '', doc, filename, incomingHeaders, req, uploadReference, useCompositePrefixes = false }) {
|
|
5
5
|
try {
|
|
6
6
|
const docPrefix = await getDocPrefix({
|
|
7
|
-
clientUploadContext,
|
|
8
7
|
collection,
|
|
8
|
+
collectionPrefix,
|
|
9
|
+
doc,
|
|
9
10
|
filename,
|
|
10
|
-
|
|
11
|
-
|
|
11
|
+
req,
|
|
12
|
+
uploadReference,
|
|
13
|
+
useCompositePrefixes
|
|
12
14
|
});
|
|
13
|
-
const {
|
|
15
|
+
const { storageFilePath } = buildStoragePathData({
|
|
14
16
|
collectionPrefix,
|
|
15
17
|
docPrefix,
|
|
16
18
|
filename,
|
|
17
19
|
useCompositePrefixes
|
|
18
20
|
});
|
|
19
|
-
const file = client.bucket(bucket).file(
|
|
21
|
+
const file = client.bucket(bucket).file(storageFilePath);
|
|
20
22
|
const [metadata] = await file.getMetadata();
|
|
21
23
|
// Handle range request
|
|
22
24
|
const rangeHeader = req.headers.get('range');
|
|
@@ -40,9 +42,9 @@ export async function getFile({ bucket, client, clientUploadContext, collection,
|
|
|
40
42
|
}
|
|
41
43
|
headers.append('Content-Type', String(metadata.contentType));
|
|
42
44
|
headers.append('ETag', String(metadata.etag));
|
|
43
|
-
//
|
|
44
|
-
if (metadata.contentType
|
|
45
|
-
headers.append('Content-Security-Policy',
|
|
45
|
+
// Apply a restrictive policy to XML-family responses served through Payload.
|
|
46
|
+
if (isXmlMimeType(metadata.contentType)) {
|
|
47
|
+
headers.append('Content-Security-Policy', uploadContentSecurityPolicy);
|
|
46
48
|
}
|
|
47
49
|
if (collection.upload && typeof collection.upload === 'object' && typeof collection.upload.modifyResponseHeaders === 'function') {
|
|
48
50
|
headers = collection.upload.modifyResponseHeaders({
|
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
|
|
1
|
+
{"version":3,"sources":["../src/getFile.ts"],"sourcesContent":["import type { Storage } from '@google-cloud/storage'\nimport type { CollectionConfig, PayloadRequest, TypeWithID } from 'payload'\n\nimport { ApiError } from '@google-cloud/storage'\nimport {\n buildStoragePathData,\n getFilePrefix as getDocPrefix,\n} from '@payloadcms/plugin-cloud-storage/utilities'\nimport { getRangeRequestInfo, isXmlMimeType, uploadContentSecurityPolicy } from 'payload/internal'\n\ninterface GetFileArgs {\n bucket: string\n client: Storage\n collection: CollectionConfig\n collectionPrefix?: string\n doc?: TypeWithID\n filename: string\n incomingHeaders?: Headers\n req: PayloadRequest\n uploadReference?: unknown\n useCompositePrefixes?: boolean\n}\n\nexport async function getFile({\n bucket,\n client,\n collection,\n collectionPrefix = '',\n doc,\n filename,\n incomingHeaders,\n req,\n uploadReference,\n useCompositePrefixes = false,\n}: GetFileArgs): Promise<Response> {\n try {\n const docPrefix = await getDocPrefix({\n collection,\n collectionPrefix,\n doc,\n filename,\n req,\n uploadReference,\n useCompositePrefixes,\n })\n\n const { storageFilePath } = buildStoragePathData({\n collectionPrefix,\n docPrefix,\n filename,\n useCompositePrefixes,\n })\n\n const file = client.bucket(bucket).file(storageFilePath)\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 // Apply a restrictive policy to XML-family responses served through Payload.\n if (isXmlMimeType(metadata.contentType)) {\n headers.append('Content-Security-Policy', uploadContentSecurityPolicy)\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","buildStoragePathData","getFilePrefix","getDocPrefix","getRangeRequestInfo","isXmlMimeType","uploadContentSecurityPolicy","getFile","bucket","client","collection","collectionPrefix","doc","filename","incomingHeaders","req","uploadReference","useCompositePrefixes","docPrefix","storageFilePath","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,oBAAoB,EACpBC,iBAAiBC,YAAY,QACxB,6CAA4C;AACnD,SAASC,mBAAmB,EAAEC,aAAa,EAAEC,2BAA2B,QAAQ,mBAAkB;AAelG,OAAO,eAAeC,QAAQ,EAC5BC,MAAM,EACNC,MAAM,EACNC,UAAU,EACVC,mBAAmB,EAAE,EACrBC,GAAG,EACHC,QAAQ,EACRC,eAAe,EACfC,GAAG,EACHC,eAAe,EACfC,uBAAuB,KAAK,EAChB;IACZ,IAAI;QACF,MAAMC,YAAY,MAAMf,aAAa;YACnCO;YACAC;YACAC;YACAC;YACAE;YACAC;YACAC;QACF;QAEA,MAAM,EAAEE,eAAe,EAAE,GAAGlB,qBAAqB;YAC/CU;YACAO;YACAL;YACAI;QACF;QAEA,MAAMG,OAAOX,OAAOD,MAAM,CAACA,QAAQY,IAAI,CAACD;QAExC,MAAM,CAACE,SAAS,GAAG,MAAMD,KAAKE,WAAW;QAEzC,uBAAuB;QACvB,MAAMC,cAAcR,IAAIS,OAAO,CAACC,GAAG,CAAC;QACpC,MAAMC,WAAWC,OAAON,SAASO,IAAI;QACrC,MAAMC,cAAczB,oBAAoB;YAAEsB;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,kBAAkBnB,IAAIS,OAAO,CAACC,GAAG,CAAC,WAAWV,IAAIS,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,6EAA6E;QAC7E,IAAI/B,cAAcgB,SAASsB,WAAW,GAAG;YACvCnB,QAAQiB,MAAM,CAAC,2BAA2BnC;QAC5C;QAEA,IACEI,WAAWkC,MAAM,IACjB,OAAOlC,WAAWkC,MAAM,KAAK,YAC7B,OAAOlC,WAAWkC,MAAM,CAACC,qBAAqB,KAAK,YACnD;YACArB,UAAUd,WAAWkC,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,eAAe7D,YAAY6D,IAAIE,IAAI,KAAK,KAAK;YAC/C,OAAO,IAAIhC,SAAS,MAAM;gBAAEE,QAAQ;gBAAK+B,YAAY;YAAY;QACnE;QACAjD,IAAIkD,OAAO,CAACC,MAAM,CAACJ,KAAK,CAACD;QACzB,OAAO,IAAI9B,SAAS,yBAAyB;YAAEE,QAAQ;QAAI;IAC7D;AACF"}
|
package/dist/index.d.ts
CHANGED
|
@@ -3,16 +3,6 @@ import type { ClientUploadsConfig, CollectionOptions } from '@payloadcms/plugin-
|
|
|
3
3
|
import type { StorageAdapter, UploadCollectionSlug } from 'payload';
|
|
4
4
|
export interface GcsStorageOptions {
|
|
5
5
|
acl?: 'Private' | 'Public';
|
|
6
|
-
/**
|
|
7
|
-
* When enabled, fields (like the prefix field) will always be inserted into
|
|
8
|
-
* the collection schema regardless of whether the plugin is enabled. This
|
|
9
|
-
* ensures a consistent schema across all environments.
|
|
10
|
-
*
|
|
11
|
-
* This will be enabled by default in Payload v4.
|
|
12
|
-
*
|
|
13
|
-
* @default false
|
|
14
|
-
*/
|
|
15
|
-
alwaysInsertFields?: boolean;
|
|
16
6
|
/**
|
|
17
7
|
* The name of the bucket to use.
|
|
18
8
|
*/
|
|
@@ -25,7 +15,7 @@ export interface GcsStorageOptions {
|
|
|
25
15
|
*/
|
|
26
16
|
clientCacheKey?: string;
|
|
27
17
|
/**
|
|
28
|
-
*
|
|
18
|
+
* Upload directly to GCS instead of through Payload. You must allow CORS PUT requests from your website.
|
|
29
19
|
*/
|
|
30
20
|
clientUploads?: ClientUploadsConfig;
|
|
31
21
|
/**
|
|
@@ -46,14 +36,15 @@ export interface GcsStorageOptions {
|
|
|
46
36
|
options: StorageOptions;
|
|
47
37
|
/**
|
|
48
38
|
* When true, the collection-level prefix and document-level prefix are combined
|
|
49
|
-
* (compositional). When false (default), document prefix
|
|
50
|
-
* prefix
|
|
39
|
+
* (compositional). When false (default), a document prefix already within the
|
|
40
|
+
* collection prefix is used as-is for new uploads; otherwise it is nested beneath it.
|
|
41
|
+
* Existing files retain their stored prefixes for reads, URLs, and cleanup.
|
|
51
42
|
*
|
|
52
|
-
* Example:
|
|
53
|
-
* - collection prefix: `
|
|
54
|
-
* - document prefix: `
|
|
55
|
-
* - resulting prefix with useCompositePrefixes=true: `
|
|
56
|
-
* - resulting prefix with useCompositePrefixes=false: `
|
|
43
|
+
* Example with a document prefix already contained by the collection prefix:
|
|
44
|
+
* - collection prefix: `uploads/`
|
|
45
|
+
* - document prefix: `uploads/documents/`
|
|
46
|
+
* - resulting prefix with useCompositePrefixes=true: `uploads/uploads/documents/`
|
|
47
|
+
* - resulting prefix with useCompositePrefixes=false: `uploads/documents/`
|
|
57
48
|
*
|
|
58
49
|
* @default false
|
|
59
50
|
*/
|
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,cAAc,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;
|
|
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,cAAc,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAO3E,MAAM,WAAW,iBAAiB;IAChC,GAAG,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAA;IAE1B;;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;;;;;;;;;;;;;OAaG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B;AAED,KAAK,iBAAiB,GAAG,CAAC,cAAc,EAAE,iBAAiB,KAAK,cAAc,CAAA;AAI9E,eAAO,MAAM,UAAU,EAAE,iBAoFvB,CAAA"}
|
package/dist/index.js
CHANGED
|
@@ -1,8 +1,6 @@
|
|
|
1
1
|
import { Storage } from '@google-cloud/storage';
|
|
2
2
|
import { cloudStoragePlugin } from '@payloadcms/plugin-cloud-storage';
|
|
3
|
-
import { initClientUploads } from '@payloadcms/plugin-cloud-storage/utilities';
|
|
4
3
|
import { createGcsAdapter } from './adapter.js';
|
|
5
|
-
import { getGenerateSignedURLHandler } from './generateSignedURL.js';
|
|
6
4
|
const gcsClients = new Map();
|
|
7
5
|
export const gcsStorage = (gcsStorageOptions)=>({
|
|
8
6
|
name: 'gcs',
|
|
@@ -24,22 +22,21 @@ export const gcsStorage = (gcsStorageOptions)=>({
|
|
|
24
22
|
useCompositePrefixes: gcsStorageOptions.useCompositePrefixes
|
|
25
23
|
});
|
|
26
24
|
const isPluginDisabled = gcsStorageOptions.enabled === false;
|
|
27
|
-
initClientUploads({
|
|
28
|
-
clientHandler: '@payloadcms/storage-gcs/client#GcsClientUploadHandler',
|
|
29
|
-
collections: gcsStorageOptions.collections,
|
|
30
|
-
config: incomingConfig,
|
|
31
|
-
enabled: !isPluginDisabled && Boolean(gcsStorageOptions.clientUploads),
|
|
32
|
-
serverHandler: getGenerateSignedURLHandler({
|
|
33
|
-
access: typeof gcsStorageOptions.clientUploads === 'object' ? gcsStorageOptions.clientUploads.access : undefined,
|
|
34
|
-
bucket: gcsStorageOptions.bucket,
|
|
35
|
-
collections: gcsStorageOptions.collections,
|
|
36
|
-
getStorageClient,
|
|
37
|
-
useCompositePrefixes: gcsStorageOptions.useCompositePrefixes
|
|
38
|
-
}),
|
|
39
|
-
serverHandlerPath: '/storage-gcs-generate-signed-url'
|
|
40
|
-
});
|
|
41
25
|
if (isPluginDisabled) {
|
|
42
|
-
|
|
26
|
+
// Still call cloudStoragePlugin with adapter: null so fields (like prefix) are
|
|
27
|
+
// inserted into the schema, keeping it consistent across environments.
|
|
28
|
+
const collectionsWithoutAdapter = Object.entries(gcsStorageOptions.collections).reduce((acc, [slug, collOptions])=>({
|
|
29
|
+
...acc,
|
|
30
|
+
[slug]: {
|
|
31
|
+
...collOptions === true ? {} : collOptions,
|
|
32
|
+
adapter: null
|
|
33
|
+
}
|
|
34
|
+
}), {});
|
|
35
|
+
return cloudStoragePlugin({
|
|
36
|
+
collections: collectionsWithoutAdapter,
|
|
37
|
+
enabled: false,
|
|
38
|
+
useCompositePrefixes: gcsStorageOptions.useCompositePrefixes
|
|
39
|
+
})(incomingConfig);
|
|
43
40
|
}
|
|
44
41
|
// Add adapter to each collection option object
|
|
45
42
|
const collectionsWithAdapter = Object.entries(gcsStorageOptions.collections).reduce((acc, [slug, collOptions])=>({
|
|
@@ -66,7 +63,6 @@ export const gcsStorage = (gcsStorageOptions)=>({
|
|
|
66
63
|
})
|
|
67
64
|
};
|
|
68
65
|
return cloudStoragePlugin({
|
|
69
|
-
alwaysInsertFields: gcsStorageOptions.alwaysInsertFields,
|
|
70
66
|
collections: collectionsWithAdapter,
|
|
71
67
|
useCompositePrefixes: gcsStorageOptions.useCompositePrefixes
|
|
72
68
|
})(config);
|
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, StorageAdapter, UploadCollectionSlug } from 'payload'\n\nimport { Storage } from '@google-cloud/storage'\nimport { cloudStoragePlugin } from '@payloadcms/plugin-cloud-storage'\
|
|
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, StorageAdapter, UploadCollectionSlug } from 'payload'\n\nimport { Storage } from '@google-cloud/storage'\nimport { cloudStoragePlugin } from '@payloadcms/plugin-cloud-storage'\n\nimport { createGcsAdapter } from './adapter.js'\n\nexport interface GcsStorageOptions {\n acl?: 'Private' | 'Public'\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 * Upload directly to GCS instead of through Payload. You must allow CORS PUT requests from 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), a document prefix already within the\n * collection prefix is used as-is for new uploads; otherwise it is nested beneath it.\n * Existing files retain their stored prefixes for reads, URLs, and cleanup.\n *\n * Example with a document prefix already contained by the collection prefix:\n * - collection prefix: `uploads/`\n * - document prefix: `uploads/documents/`\n * - resulting prefix with useCompositePrefixes=true: `uploads/uploads/documents/`\n * - resulting prefix with useCompositePrefixes=false: `uploads/documents/`\n *\n * @default false\n */\n useCompositePrefixes?: boolean\n}\n\ntype GcsStorageFactory = (gcsStorageArgs: GcsStorageOptions) => StorageAdapter\n\nconst gcsClients = new Map<string, Storage>()\n\nexport const gcsStorage: GcsStorageFactory = (\n gcsStorageOptions: GcsStorageOptions,\n): StorageAdapter => ({\n name: 'gcs',\n collections: Object.keys(gcsStorageOptions.collections),\n init: (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 if (isPluginDisabled) {\n // Still call cloudStoragePlugin with adapter: null so fields (like prefix) are\n // inserted into the schema, keeping it consistent across environments.\n const collectionsWithoutAdapter: CloudStoragePluginOptions['collections'] = Object.entries(\n gcsStorageOptions.collections,\n ).reduce(\n (acc, [slug, collOptions]) => ({\n ...acc,\n [slug]: { ...(collOptions === true ? {} : collOptions), adapter: null },\n }),\n {} as Record<string, CollectionOptions>,\n )\n\n return cloudStoragePlugin({\n collections: collectionsWithoutAdapter,\n enabled: false,\n useCompositePrefixes: gcsStorageOptions.useCompositePrefixes,\n })(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 collections: collectionsWithAdapter,\n useCompositePrefixes: gcsStorageOptions.useCompositePrefixes,\n })(config)\n },\n})\n"],"names":["Storage","cloudStoragePlugin","createGcsAdapter","gcsClients","Map","gcsStorage","gcsStorageOptions","name","collections","Object","keys","init","incomingConfig","cacheKey","clientCacheKey","bucket","getStorageClient","has","get","set","options","adapter","acl","clientUploads","useCompositePrefixes","isPluginDisabled","enabled","collectionsWithoutAdapter","entries","reduce","acc","slug","collOptions","collectionsWithAdapter","config","map","collection","upload","disableLocalStorage"],"mappings":"AAQA,SAASA,OAAO,QAAQ,wBAAuB;AAC/C,SAASC,kBAAkB,QAAQ,mCAAkC;AAErE,SAASC,gBAAgB,QAAQ,eAAc;AAwD/C,MAAMC,aAAa,IAAIC;AAEvB,OAAO,MAAMC,aAAgC,CAC3CC,oBACoB,CAAA;QACpBC,MAAM;QACNC,aAAaC,OAAOC,IAAI,CAACJ,kBAAkBE,WAAW;QACtDG,MAAM,CAACC;YACL,MAAMC,WAAWP,kBAAkBQ,cAAc,IAAI,CAAC,IAAI,EAAER,kBAAkBS,MAAM,EAAE;YAEtF,MAAMC,mBAAmB;gBACvB,IAAIb,WAAWc,GAAG,CAACJ,WAAW;oBAC5B,OAAOV,WAAWe,GAAG,CAACL;gBACxB;gBACAV,WAAWgB,GAAG,CAACN,UAAU,IAAIb,QAAQM,kBAAkBc,OAAO;gBAE9D,OAAOjB,WAAWe,GAAG,CAACL;YACxB;YAEA,MAAMQ,UAAUnB,iBAAiB;gBAC/BoB,KAAKhB,kBAAkBgB,GAAG;gBAC1BP,QAAQT,kBAAkBS,MAAM;gBAChCQ,eAAejB,kBAAkBiB,aAAa;gBAC9CP;gBACAQ,sBAAsBlB,kBAAkBkB,oBAAoB;YAC9D;YAEA,MAAMC,mBAAmBnB,kBAAkBoB,OAAO,KAAK;YAEvD,IAAID,kBAAkB;gBACpB,+EAA+E;gBAC/E,uEAAuE;gBACvE,MAAME,4BAAsElB,OAAOmB,OAAO,CACxFtB,kBAAkBE,WAAW,EAC7BqB,MAAM,CACN,CAACC,KAAK,CAACC,MAAMC,YAAY,GAAM,CAAA;wBAC7B,GAAGF,GAAG;wBACN,CAACC,KAAK,EAAE;4BAAE,GAAIC,gBAAgB,OAAO,CAAC,IAAIA,WAAW;4BAAGX,SAAS;wBAAK;oBACxE,CAAA,GACA,CAAC;gBAGH,OAAOpB,mBAAmB;oBACxBO,aAAamB;oBACbD,SAAS;oBACTF,sBAAsBlB,kBAAkBkB,oBAAoB;gBAC9D,GAAGZ;YACL;YAEA,+CAA+C;YAC/C,MAAMqB,yBAAmExB,OAAOmB,OAAO,CACrFtB,kBAAkBE,WAAW,EAC7BqB,MAAM,CACN,CAACC,KAAK,CAACC,MAAMC,YAAY,GAAM,CAAA;oBAC7B,GAAGF,GAAG;oBACN,CAACC,KAAK,EAAE;wBACN,GAAIC,gBAAgB,OAAO,CAAC,IAAIA,WAAW;wBAC3CX;oBACF;gBACF,CAAA,GACA,CAAC;YAGH,gFAAgF;YAChF,MAAMa,SAAS;gBACb,GAAGtB,cAAc;gBACjBJ,aAAa,AAACI,CAAAA,eAAeJ,WAAW,IAAI,EAAE,AAAD,EAAG2B,GAAG,CAAC,CAACC;oBACnD,IAAI,CAACH,sBAAsB,CAACG,WAAWL,IAAI,CAAC,EAAE;wBAC5C,OAAOK;oBACT;oBAEA,OAAO;wBACL,GAAGA,UAAU;wBACbC,QAAQ;4BACN,GAAI,OAAOD,WAAWC,MAAM,KAAK,WAAWD,WAAWC,MAAM,GAAG,CAAC,CAAC;4BAClEC,qBAAqB;wBACvB;oBACF;gBACF;YACF;YAEA,OAAOrC,mBAAmB;gBACxBO,aAAayB;gBACbT,sBAAsBlB,kBAAkBkB,oBAAoB;YAC9D,GAAGU;QACL;IACF,CAAA,EAAE"}
|
package/dist/uploadFile.d.ts
CHANGED
|
@@ -4,12 +4,9 @@ interface UploadFileArgs {
|
|
|
4
4
|
bucket: string;
|
|
5
5
|
buffer: Buffer;
|
|
6
6
|
client: Storage;
|
|
7
|
-
collectionPrefix?: string;
|
|
8
|
-
docPrefix?: string;
|
|
9
|
-
filename: string;
|
|
10
7
|
mimeType: string;
|
|
11
|
-
|
|
8
|
+
storageFilePath: string;
|
|
12
9
|
}
|
|
13
|
-
export declare function uploadFile({ acl, bucket, buffer, client,
|
|
10
|
+
export declare function uploadFile({ acl, bucket, buffer, client, mimeType, storageFilePath, }: UploadFileArgs): Promise<void>;
|
|
14
11
|
export {};
|
|
15
12
|
//# sourceMappingURL=uploadFile.d.ts.map
|
package/dist/uploadFile.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"uploadFile.d.ts","sourceRoot":"","sources":["../src/uploadFile.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;
|
|
1
|
+
{"version":3,"file":"uploadFile.d.ts","sourceRoot":"","sources":["../src/uploadFile.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;AAEpD,UAAU,cAAc;IACtB,GAAG,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAA;IAC1B,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,OAAO,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;IAChB,eAAe,EAAE,MAAM,CAAA;CACxB;AAED,wBAAsB,UAAU,CAAC,EAC/B,GAAG,EACH,MAAM,EACN,MAAM,EACN,MAAM,EACN,QAAQ,EACR,eAAe,GAChB,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAYhC"}
|
package/dist/uploadFile.js
CHANGED
|
@@ -1,12 +1,5 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
const { fileKey } = getFileKey({
|
|
4
|
-
collectionPrefix,
|
|
5
|
-
docPrefix: docPrefix || '',
|
|
6
|
-
filename,
|
|
7
|
-
useCompositePrefixes
|
|
8
|
-
});
|
|
9
|
-
const gcsFile = client.bucket(bucket).file(fileKey);
|
|
1
|
+
export async function uploadFile({ acl, bucket, buffer, client, mimeType, storageFilePath }) {
|
|
2
|
+
const gcsFile = client.bucket(bucket).file(storageFilePath);
|
|
10
3
|
await gcsFile.save(buffer, {
|
|
11
4
|
metadata: {
|
|
12
5
|
contentType: mimeType
|
package/dist/uploadFile.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/uploadFile.ts"],"sourcesContent":["import type { Storage } from '@google-cloud/storage'\n\
|
|
1
|
+
{"version":3,"sources":["../src/uploadFile.ts"],"sourcesContent":["import type { Storage } from '@google-cloud/storage'\n\ninterface UploadFileArgs {\n acl?: 'Private' | 'Public'\n bucket: string\n buffer: Buffer\n client: Storage\n mimeType: string\n storageFilePath: string\n}\n\nexport async function uploadFile({\n acl,\n bucket,\n buffer,\n client,\n mimeType,\n storageFilePath,\n}: UploadFileArgs): Promise<void> {\n const gcsFile = client.bucket(bucket).file(storageFilePath)\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":["uploadFile","acl","bucket","buffer","client","mimeType","storageFilePath","gcsFile","file","save","metadata","contentType"],"mappings":"AAWA,OAAO,eAAeA,WAAW,EAC/BC,GAAG,EACHC,MAAM,EACNC,MAAM,EACNC,MAAM,EACNC,QAAQ,EACRC,eAAe,EACA;IACf,MAAMC,UAAUH,OAAOF,MAAM,CAACA,QAAQM,IAAI,CAACF;IAE3C,MAAMC,QAAQE,IAAI,CAACN,QAAQ;QACzBO,UAAU;YACRC,aAAaN;QACf;IACF;IAEA,IAAIJ,KAAK;QACP,MAAMM,OAAO,CAAC,CAAC,IAAI,EAAEN,KAAK,CAAC;IAC7B;AACF"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@payloadcms/storage-gcs",
|
|
3
|
-
"version": "4.0.0-internal.
|
|
3
|
+
"version": "4.0.0-internal.77191e5",
|
|
4
4
|
"description": "Payload storage adapter for Google Cloud Storage",
|
|
5
5
|
"homepage": "https://payloadcms.com",
|
|
6
6
|
"repository": {
|
|
@@ -24,11 +24,6 @@
|
|
|
24
24
|
"import": "./dist/index.js",
|
|
25
25
|
"types": "./dist/index.d.ts",
|
|
26
26
|
"default": "./dist/index.js"
|
|
27
|
-
},
|
|
28
|
-
"./client": {
|
|
29
|
-
"import": "./dist/exports/client.js",
|
|
30
|
-
"types": "./dist/exports/client.d.ts",
|
|
31
|
-
"default": "./dist/exports/client.js"
|
|
32
27
|
}
|
|
33
28
|
},
|
|
34
29
|
"main": "./dist/index.js",
|
|
@@ -38,13 +33,13 @@
|
|
|
38
33
|
],
|
|
39
34
|
"dependencies": {
|
|
40
35
|
"@google-cloud/storage": "7.19.0",
|
|
41
|
-
"@payloadcms/plugin-cloud-storage": "4.0.0-internal.
|
|
36
|
+
"@payloadcms/plugin-cloud-storage": "4.0.0-internal.77191e5"
|
|
42
37
|
},
|
|
43
38
|
"devDependencies": {
|
|
44
|
-
"payload": "4.0.0-internal.
|
|
39
|
+
"payload": "4.0.0-internal.77191e5"
|
|
45
40
|
},
|
|
46
41
|
"peerDependencies": {
|
|
47
|
-
"payload": "4.0.0-internal.
|
|
42
|
+
"payload": "4.0.0-internal.77191e5"
|
|
48
43
|
},
|
|
49
44
|
"engines": {
|
|
50
45
|
"node": ">=24.15.0"
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
export declare const GcsClientUploadHandler: ({ children, collectionSlug, enabled, extra, prefix, serverHandlerPath, }: {
|
|
2
|
-
children: import("react").ReactNode;
|
|
3
|
-
collectionSlug: import("payload").UploadCollectionSlug;
|
|
4
|
-
enabled?: boolean;
|
|
5
|
-
extra: Record<string, unknown>;
|
|
6
|
-
prefix?: string;
|
|
7
|
-
serverHandlerPath: `/${string}`;
|
|
8
|
-
}) => import("react").JSX.Element;
|
|
9
|
-
//# sourceMappingURL=GcsClientUploadHandler.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"GcsClientUploadHandler.d.ts","sourceRoot":"","sources":["../../src/client/GcsClientUploadHandler.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,sBAAsB;;;;;;;iCAkDjC,CAAA"}
|
|
@@ -1,39 +0,0 @@
|
|
|
1
|
-
'use client';
|
|
2
|
-
import { createClientUploadHandler } from '@payloadcms/plugin-cloud-storage/client';
|
|
3
|
-
import { formatAdminURL } from 'payload/shared';
|
|
4
|
-
export const GcsClientUploadHandler = createClientUploadHandler({
|
|
5
|
-
handler: async ({ apiRoute, collectionSlug, docPrefix, file, serverHandlerPath, serverURL, updateFilename })=>{
|
|
6
|
-
const endpointRoute = formatAdminURL({
|
|
7
|
-
apiRoute,
|
|
8
|
-
path: serverHandlerPath,
|
|
9
|
-
serverURL
|
|
10
|
-
});
|
|
11
|
-
const response = await fetch(endpointRoute, {
|
|
12
|
-
body: JSON.stringify({
|
|
13
|
-
collectionSlug,
|
|
14
|
-
docPrefix,
|
|
15
|
-
filename: file.name,
|
|
16
|
-
mimeType: file.type
|
|
17
|
-
}),
|
|
18
|
-
credentials: 'include',
|
|
19
|
-
method: 'POST'
|
|
20
|
-
});
|
|
21
|
-
const { docPrefix: sanitizedDocPrefix, filename: sanitizedFilename, url } = await response.json();
|
|
22
|
-
if (sanitizedFilename && sanitizedFilename !== file.name) {
|
|
23
|
-
updateFilename(sanitizedFilename);
|
|
24
|
-
}
|
|
25
|
-
await fetch(url, {
|
|
26
|
-
body: file,
|
|
27
|
-
headers: {
|
|
28
|
-
'Content-Length': file.size.toString(),
|
|
29
|
-
'Content-Type': file.type
|
|
30
|
-
},
|
|
31
|
-
method: 'PUT'
|
|
32
|
-
});
|
|
33
|
-
return {
|
|
34
|
-
prefix: sanitizedDocPrefix
|
|
35
|
-
};
|
|
36
|
-
}
|
|
37
|
-
});
|
|
38
|
-
|
|
39
|
-
//# sourceMappingURL=GcsClientUploadHandler.js.map
|
|
@@ -1 +0,0 @@
|
|
|
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 ({\n apiRoute,\n collectionSlug,\n docPrefix,\n file,\n serverHandlerPath,\n serverURL,\n updateFilename,\n }) => {\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 {\n docPrefix: sanitizedDocPrefix,\n filename: sanitizedFilename,\n url,\n } = (await response.json()) as {\n docPrefix: string\n filename?: string\n url: string\n }\n\n if (sanitizedFilename && sanitizedFilename !== file.name) {\n updateFilename(sanitizedFilename)\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","updateFilename","endpointRoute","path","response","fetch","body","JSON","stringify","filename","name","mimeType","type","credentials","method","sanitizedDocPrefix","sanitizedFilename","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,EACdC,QAAQ,EACRC,cAAc,EACdC,SAAS,EACTC,IAAI,EACJC,iBAAiB,EACjBC,SAAS,EACTC,cAAc,EACf;QACC,MAAMC,gBAAgBV,eAAe;YACnCG;YACAQ,MAAMJ;YACNC;QACF;QACA,MAAMI,WAAW,MAAMC,MAAMH,eAAe;YAC1CI,MAAMC,KAAKC,SAAS,CAAC;gBACnBZ;gBACAC;gBACAY,UAAUX,KAAKY,IAAI;gBACnBC,UAAUb,KAAKc,IAAI;YACrB;YACAC,aAAa;YACbC,QAAQ;QACV;QAEA,MAAM,EACJjB,WAAWkB,kBAAkB,EAC7BN,UAAUO,iBAAiB,EAC3BC,GAAG,EACJ,GAAI,MAAMb,SAASc,IAAI;QAMxB,IAAIF,qBAAqBA,sBAAsBlB,KAAKY,IAAI,EAAE;YACxDT,eAAee;QACjB;QAEA,MAAMX,MAAMY,KAAK;YACfX,MAAMR;YACNqB,SAAS;gBAAE,kBAAkBrB,KAAKsB,IAAI,CAACC,QAAQ;gBAAI,gBAAgBvB,KAAKc,IAAI;YAAC;YAC7EE,QAAQ;QACV;QAEA,OAAO;YACLQ,QAAQP;QACV;IACF;AACF,GAAE"}
|
package/dist/exports/client.d.ts
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/exports/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAA"}
|
package/dist/exports/client.js
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/exports/client.ts"],"sourcesContent":["export { GcsClientUploadHandler } from '../client/GcsClientUploadHandler.js'\n"],"names":["GcsClientUploadHandler"],"mappings":"AAAA,SAASA,sBAAsB,QAAQ,sCAAqC"}
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
import type { Storage } from '@google-cloud/storage';
|
|
2
|
-
import type { ClientUploadsAccess } from '@payloadcms/plugin-cloud-storage/types';
|
|
3
|
-
import type { PayloadHandler } from 'payload';
|
|
4
|
-
import type { GcsStorageOptions } from './index.js';
|
|
5
|
-
interface Args {
|
|
6
|
-
access?: ClientUploadsAccess;
|
|
7
|
-
acl?: 'private' | 'public-read';
|
|
8
|
-
bucket: string;
|
|
9
|
-
collections: GcsStorageOptions['collections'];
|
|
10
|
-
getStorageClient: () => Storage;
|
|
11
|
-
useCompositePrefixes?: boolean;
|
|
12
|
-
}
|
|
13
|
-
export declare const getGenerateSignedURLHandler: ({ access, bucket, collections, getStorageClient, useCompositePrefixes, }: Args) => PayloadHandler;
|
|
14
|
-
export {};
|
|
15
|
-
//# sourceMappingURL=generateSignedURL.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
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,GAAI,0EAMzC,IAAI,KAAG,cAkDT,CAAA"}
|
|
@@ -1,43 +0,0 @@
|
|
|
1
|
-
import { resolveSignedURLKey } from '@payloadcms/plugin-cloud-storage/utilities';
|
|
2
|
-
import { APIError, Forbidden } from 'payload';
|
|
3
|
-
const defaultAccess = ({ req })=>!!req.user;
|
|
4
|
-
export const getGenerateSignedURLHandler = ({ access = defaultAccess, bucket, collections, getStorageClient, useCompositePrefixes = false })=>{
|
|
5
|
-
return async (req)=>{
|
|
6
|
-
if (!req.json) {
|
|
7
|
-
throw new APIError('Unreachable');
|
|
8
|
-
}
|
|
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`);
|
|
13
|
-
}
|
|
14
|
-
const collectionPrefix = typeof collectionStorageConfig === 'object' && collectionStorageConfig.prefix || '';
|
|
15
|
-
if (!await access({
|
|
16
|
-
collectionSlug,
|
|
17
|
-
req
|
|
18
|
-
})) {
|
|
19
|
-
throw new Forbidden();
|
|
20
|
-
}
|
|
21
|
-
const { fileKey, sanitizedDocPrefix, sanitizedFilename } = await resolveSignedURLKey({
|
|
22
|
-
collectionPrefix,
|
|
23
|
-
collectionSlug,
|
|
24
|
-
docPrefix,
|
|
25
|
-
filename,
|
|
26
|
-
req,
|
|
27
|
-
useCompositePrefixes
|
|
28
|
-
});
|
|
29
|
-
const [url] = await getStorageClient().bucket(bucket).file(fileKey).getSignedUrl({
|
|
30
|
-
action: 'write',
|
|
31
|
-
contentType: mimeType,
|
|
32
|
-
expires: Date.now() + 60 * 60 * 5,
|
|
33
|
-
version: 'v4'
|
|
34
|
-
});
|
|
35
|
-
return Response.json({
|
|
36
|
-
docPrefix: sanitizedDocPrefix,
|
|
37
|
-
filename: sanitizedFilename,
|
|
38
|
-
url
|
|
39
|
-
});
|
|
40
|
-
};
|
|
41
|
-
};
|
|
42
|
-
|
|
43
|
-
//# sourceMappingURL=generateSignedURL.js.map
|
|
@@ -1 +0,0 @@
|
|
|
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 { resolveSignedURLKey } 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, sanitizedFilename } = await resolveSignedURLKey({\n collectionPrefix,\n collectionSlug,\n docPrefix,\n filename,\n req,\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 filename: sanitizedFilename,\n url,\n })\n }\n}\n"],"names":["resolveSignedURLKey","APIError","Forbidden","defaultAccess","req","user","getGenerateSignedURLHandler","access","bucket","collections","getStorageClient","useCompositePrefixes","json","collectionSlug","docPrefix","filename","mimeType","collectionStorageConfig","collectionPrefix","prefix","fileKey","sanitizedDocPrefix","sanitizedFilename","url","file","getSignedUrl","action","contentType","expires","Date","now","version","Response"],"mappings":"AAIA,SAASA,mBAAmB,QAAQ,6CAA4C;AAChF,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,EAAEC,iBAAiB,EAAE,GAAG,MAAMtB,oBAAoB;YACnFkB;YACAL;YACAC;YACAC;YACAX;YACAO;QACF;QAEA,MAAM,CAACY,IAAI,GAAG,MAAMb,mBACjBF,MAAM,CAACA,QACPgB,IAAI,CAACJ,SACLK,YAAY,CAAC;YACZC,QAAQ;YACRC,aAAaX;YACbY,SAASC,KAAKC,GAAG,KAAK,KAAK,KAAK;YAChCC,SAAS;QACX;QAEF,OAAOC,SAASpB,IAAI,CAAC;YACnBE,WAAWO;YACXN,UAAUO;YACVC;QACF;IACF;AACF,EAAC"}
|