@payloadcms/storage-gcs 4.0.0-canary.33 → 4.0.0-canary.35

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.
@@ -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;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,CAqEhC"}
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
@@ -23,38 +23,33 @@ export function createGcsAdapter({ acl, bucket, clientUploads, getStorageClient,
23
23
  getStorageClient,
24
24
  useCompositePrefixes
25
25
  }),
26
+ requiresUploadReceipt: true,
26
27
  useInAdmin: true
27
28
  },
28
- handleDelete: ({ doc: { prefix: docPrefix = '' }, filename })=>deleteFile({
29
+ handleDelete: ({ storageFilePath })=>deleteFile({
29
30
  bucket,
30
31
  client: getStorageClient(),
31
- collectionPrefix: prefix,
32
- docPrefix,
33
- filename,
34
- useCompositePrefixes
32
+ storageFilePath
35
33
  }),
36
- handleUpload: async ({ data, file })=>{
34
+ handleUpload: async ({ data, file, storageFilePath })=>{
37
35
  await uploadFile({
38
36
  acl,
39
37
  bucket,
40
38
  buffer: file.buffer,
41
39
  client: getStorageClient(),
42
- collectionPrefix: prefix,
43
- docPrefix: data.prefix,
44
- filename: file.filename,
45
40
  mimeType: file.mimeType,
46
- useCompositePrefixes
41
+ storageFilePath
47
42
  });
48
43
  return data;
49
44
  },
50
- staticHandler: (req, { headers, params: { filename, prefix: prefixQueryParam, uploadReference } })=>getFile({
45
+ staticHandler: (req, { doc, headers, params: { filename, uploadReference } })=>getFile({
51
46
  bucket,
52
47
  client: getStorageClient(),
53
48
  collection,
54
49
  collectionPrefix: prefix,
50
+ doc,
55
51
  filename,
56
52
  incomingHeaders: headers,
57
- prefixQueryParam,
58
53
  req,
59
54
  uploadReference,
60
55
  useCompositePrefixes
@@ -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 { 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 useInAdmin: true,\n },\n\n handleDelete: ({ doc: { prefix: docPrefix = '' }, filename }) =>\n deleteFile({\n bucket,\n client: getStorageClient(),\n collectionPrefix: prefix,\n docPrefix,\n filename,\n useCompositePrefixes,\n }),\n\n handleUpload: async ({ data, file }) => {\n await uploadFile({\n acl,\n bucket,\n buffer: file.buffer,\n client: getStorageClient(),\n collectionPrefix: prefix,\n docPrefix: data.prefix,\n filename: file.filename,\n mimeType: file.mimeType,\n useCompositePrefixes,\n })\n\n return data\n },\n\n staticHandler: (\n req,\n { headers, params: { filename, prefix: prefixQueryParam, uploadReference } },\n ) =>\n getFile({\n bucket,\n client: getStorageClient(),\n collection,\n collectionPrefix: prefix,\n filename,\n incomingHeaders: headers,\n prefixQueryParam,\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","useInAdmin","handleDelete","doc","docPrefix","handleUpload","data","file","buffer","mimeType","staticHandler","req","headers","params","prefixQueryParam","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,YAAY;YACd;YAEAC,cAAc,CAAC,EAAEC,KAAK,EAAEd,QAAQe,YAAY,EAAE,EAAE,EAAEb,QAAQ,EAAE,GAC1Dd,WAAW;oBACTO;oBACAS,QAAQP;oBACRQ,kBAAkBL;oBAClBe;oBACAb;oBACAJ;gBACF;YAEFkB,cAAc,OAAO,EAAEC,IAAI,EAAEC,IAAI,EAAE;gBACjC,MAAM1B,WAAW;oBACfE;oBACAC;oBACAwB,QAAQD,KAAKC,MAAM;oBACnBf,QAAQP;oBACRQ,kBAAkBL;oBAClBe,WAAWE,KAAKjB,MAAM;oBACtBE,UAAUgB,KAAKhB,QAAQ;oBACvBkB,UAAUF,KAAKE,QAAQ;oBACvBtB;gBACF;gBAEA,OAAOmB;YACT;YAEAI,eAAe,CACbC,KACA,EAAEC,OAAO,EAAEC,QAAQ,EAAEtB,QAAQ,EAAEF,QAAQyB,gBAAgB,EAAEC,eAAe,EAAE,EAAE,GAE5EnC,QAAQ;oBACNI;oBACAS,QAAQP;oBACRE;oBACAM,kBAAkBL;oBAClBE;oBACAyB,iBAAiBJ;oBACjBE;oBACAH;oBACAI;oBACA5B;gBACF;QACJ,CAAA;AACF"}
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"}
@@ -2,11 +2,8 @@ import type { Storage } from '@google-cloud/storage';
2
2
  interface DeleteFileArgs {
3
3
  bucket: string;
4
4
  client: Storage;
5
- collectionPrefix?: string;
6
- docPrefix: string;
7
- filename: string;
8
- useCompositePrefixes?: boolean;
5
+ storageFilePath: string;
9
6
  }
10
- export declare function deleteFile({ bucket, client, collectionPrefix, docPrefix, filename, useCompositePrefixes, }: DeleteFileArgs): Promise<void>;
7
+ export declare function deleteFile({ bucket, client, storageFilePath, }: DeleteFileArgs): Promise<void>;
11
8
  export {};
12
9
  //# sourceMappingURL=deleteFile.d.ts.map
@@ -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;AAIpD,UAAU,cAAc;IACtB,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,OAAO,CAAA;IACf,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B;AAED,wBAAsB,UAAU,CAAC,EAC/B,MAAM,EACN,MAAM,EACN,gBAAqB,EACrB,SAAS,EACT,QAAQ,EACR,oBAA4B,GAC7B,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAWhC"}
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"}
@@ -1,12 +1,5 @@
1
- import { getFileKey } from '@payloadcms/plugin-cloud-storage/utilities';
2
- export async function deleteFile({ bucket, client, collectionPrefix = '', docPrefix, filename, useCompositePrefixes = false }) {
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
  }
@@ -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,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"}
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"}
@@ -1,12 +1,12 @@
1
- import { getFileKey } from '@payloadcms/plugin-cloud-storage/utilities';
1
+ import { buildStoragePathData } from '@payloadcms/plugin-cloud-storage/utilities';
2
2
  export function generateURL({ bucket, client, collectionPrefix = '', filename, prefix, useCompositePrefixes = false }) {
3
- const { fileKey } = getFileKey({
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(fileKey).publicUrl();
9
+ return client.bucket(bucket).file(storageFilePath).publicUrl();
10
10
  }
11
11
 
12
12
  //# sourceMappingURL=generateURL.js.map
@@ -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 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"}
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,2 @@
1
+ export {};
2
+ //# sourceMappingURL=generateUploadInstructions.createOnly.spec.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"generateUploadInstructions.createOnly.spec.d.ts","sourceRoot":"","sources":["../src/generateUploadInstructions.createOnly.spec.ts"],"names":[],"mappings":""}
@@ -0,0 +1,59 @@
1
+ import { describe, expect, it, vi } from 'vitest';
2
+ vi.mock('@payloadcms/plugin-cloud-storage/utilities', ()=>({
3
+ resolveSignedURLKey: vi.fn(async ()=>({
4
+ storageFilePath: 'reference.png',
5
+ sanitizedDocPrefix: '',
6
+ sanitizedFilename: 'reference.png'
7
+ }))
8
+ }));
9
+ import { generateUploadInstructions } from './generateUploadInstructions.js';
10
+ describe('generateUploadInstructions', ()=>{
11
+ it('should issue create-only GCS upload instructions', async ()=>{
12
+ const getSignedUrl = vi.fn(async ()=>[
13
+ 'https://example.com/reference.png'
14
+ ]);
15
+ const generate = generateUploadInstructions({
16
+ bucket: 'media',
17
+ collectionPrefix: '',
18
+ getStorageClient: ()=>({
19
+ bucket: ()=>({
20
+ file: ()=>({
21
+ getSignedUrl
22
+ })
23
+ })
24
+ })
25
+ });
26
+ const instructions = await generate({
27
+ collectionSlug: 'media',
28
+ filename: 'reference.png',
29
+ filesize: 100,
30
+ mimeType: 'image/png',
31
+ overrideAccess: true,
32
+ req: {
33
+ payload: {
34
+ collections: {
35
+ media: {
36
+ config: {
37
+ upload: true
38
+ }
39
+ }
40
+ }
41
+ }
42
+ }
43
+ });
44
+ expect(getSignedUrl).toHaveBeenCalledWith(expect.objectContaining({
45
+ extensionHeaders: {
46
+ 'x-goog-if-generation-match': '0'
47
+ }
48
+ }));
49
+ expect(instructions).toMatchObject({
50
+ request: {
51
+ headers: {
52
+ 'x-goog-if-generation-match': '0'
53
+ }
54
+ }
55
+ });
56
+ });
57
+ });
58
+
59
+ //# sourceMappingURL=generateUploadInstructions.createOnly.spec.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/generateUploadInstructions.createOnly.spec.ts"],"sourcesContent":["import type { Storage } from '@google-cloud/storage'\nimport type { PayloadRequest } from 'payload'\n\nimport { describe, expect, it, vi } from 'vitest'\n\nvi.mock('@payloadcms/plugin-cloud-storage/utilities', () => ({\n resolveSignedURLKey: vi.fn(async () => ({\n storageFilePath: 'reference.png',\n sanitizedDocPrefix: '',\n sanitizedFilename: 'reference.png',\n })),\n}))\n\nimport { generateUploadInstructions } from './generateUploadInstructions.js'\n\ndescribe('generateUploadInstructions', () => {\n it('should issue create-only GCS upload instructions', async () => {\n const getSignedUrl = vi.fn(async () => ['https://example.com/reference.png'])\n const generate = generateUploadInstructions({\n bucket: 'media',\n collectionPrefix: '',\n getStorageClient: () =>\n ({\n bucket: () => ({ file: () => ({ getSignedUrl }) }),\n }) as unknown as Storage,\n })\n\n const instructions = await generate({\n collectionSlug: 'media',\n filename: 'reference.png',\n filesize: 100,\n mimeType: 'image/png',\n overrideAccess: true,\n req: {\n payload: {\n collections: {\n media: {\n config: {\n upload: true,\n },\n },\n },\n },\n } as unknown as PayloadRequest,\n })\n\n expect(getSignedUrl).toHaveBeenCalledWith(\n expect.objectContaining({\n extensionHeaders: { 'x-goog-if-generation-match': '0' },\n }),\n )\n expect(instructions).toMatchObject({\n request: {\n headers: { 'x-goog-if-generation-match': '0' },\n },\n })\n })\n})\n"],"names":["describe","expect","it","vi","mock","resolveSignedURLKey","fn","storageFilePath","sanitizedDocPrefix","sanitizedFilename","generateUploadInstructions","getSignedUrl","generate","bucket","collectionPrefix","getStorageClient","file","instructions","collectionSlug","filename","filesize","mimeType","overrideAccess","req","payload","collections","media","config","upload","toHaveBeenCalledWith","objectContaining","extensionHeaders","toMatchObject","request","headers"],"mappings":"AAGA,SAASA,QAAQ,EAAEC,MAAM,EAAEC,EAAE,EAAEC,EAAE,QAAQ,SAAQ;AAEjDA,GAAGC,IAAI,CAAC,8CAA8C,IAAO,CAAA;QAC3DC,qBAAqBF,GAAGG,EAAE,CAAC,UAAa,CAAA;gBACtCC,iBAAiB;gBACjBC,oBAAoB;gBACpBC,mBAAmB;YACrB,CAAA;IACF,CAAA;AAEA,SAASC,0BAA0B,QAAQ,kCAAiC;AAE5EV,SAAS,8BAA8B;IACrCE,GAAG,oDAAoD;QACrD,MAAMS,eAAeR,GAAGG,EAAE,CAAC,UAAY;gBAAC;aAAoC;QAC5E,MAAMM,WAAWF,2BAA2B;YAC1CG,QAAQ;YACRC,kBAAkB;YAClBC,kBAAkB,IACf,CAAA;oBACCF,QAAQ,IAAO,CAAA;4BAAEG,MAAM,IAAO,CAAA;oCAAEL;gCAAa,CAAA;wBAAG,CAAA;gBAClD,CAAA;QACJ;QAEA,MAAMM,eAAe,MAAML,SAAS;YAClCM,gBAAgB;YAChBC,UAAU;YACVC,UAAU;YACVC,UAAU;YACVC,gBAAgB;YAChBC,KAAK;gBACHC,SAAS;oBACPC,aAAa;wBACXC,OAAO;4BACLC,QAAQ;gCACNC,QAAQ;4BACV;wBACF;oBACF;gBACF;YACF;QACF;QAEA3B,OAAOU,cAAckB,oBAAoB,CACvC5B,OAAO6B,gBAAgB,CAAC;YACtBC,kBAAkB;gBAAE,8BAA8B;YAAI;QACxD;QAEF9B,OAAOgB,cAAce,aAAa,CAAC;YACjCC,SAAS;gBACPC,SAAS;oBAAE,8BAA8B;gBAAI;YAC/C;QACF;IACF;AACF"}
@@ -1 +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;AAKnF,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;AAED,eAAO,MAAM,0BAA0B,kFAMpC,IAAI,KAAG,0BAmDT,CAAA"}
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"}
@@ -1,5 +1,9 @@
1
1
  import { resolveSignedURLKey } from '@payloadcms/plugin-cloud-storage/utilities';
2
2
  import { Forbidden } from 'payload';
3
+ import { assertClientUploadAllowed } from 'payload/internal';
4
+ const createOnlyHeaders = {
5
+ 'x-goog-if-generation-match': '0'
6
+ };
3
7
  export const generateUploadInstructions = ({ access, bucket, collectionPrefix, getStorageClient, useCompositePrefixes = false })=>{
4
8
  return async ({ collectionSlug, docPrefix, filename, filesize, mimeType, overrideAccess, req })=>{
5
9
  if (!overrideAccess && (access ? !await access({
@@ -8,7 +12,12 @@ export const generateUploadInstructions = ({ access, bucket, collectionPrefix, g
8
12
  }) : !req.user)) {
9
13
  throw new Forbidden(req.t);
10
14
  }
11
- const { fileKey, sanitizedDocPrefix, sanitizedFilename } = await resolveSignedURLKey({
15
+ assertClientUploadAllowed({
16
+ collection: req.payload.collections[collectionSlug]?.config,
17
+ filename,
18
+ mimeType
19
+ });
20
+ const { sanitizedFilename, storageFilePath, uploadReference } = await resolveSignedURLKey({
12
21
  collectionPrefix,
13
22
  collectionSlug,
14
23
  docPrefix,
@@ -16,10 +25,11 @@ export const generateUploadInstructions = ({ access, bucket, collectionPrefix, g
16
25
  req,
17
26
  useCompositePrefixes
18
27
  });
19
- const [url] = await getStorageClient().bucket(bucket).file(fileKey).getSignedUrl({
28
+ const [url] = await getStorageClient().bucket(bucket).file(storageFilePath).getSignedUrl({
20
29
  action: 'write',
21
30
  contentType: mimeType,
22
31
  expires: Date.now() + 60 * 60 * 5,
32
+ extensionHeaders: createOnlyHeaders,
23
33
  version: 'v4'
24
34
  });
25
35
  return {
@@ -28,14 +38,13 @@ export const generateUploadInstructions = ({ access, bucket, collectionPrefix, g
28
38
  filename: sanitizedFilename,
29
39
  mimeType,
30
40
  size: filesize,
31
- uploadReference: {
32
- prefix: sanitizedDocPrefix
33
- }
41
+ uploadReference
34
42
  },
35
43
  request: {
36
44
  headers: {
37
45
  'Content-Length': String(filesize),
38
- 'Content-Type': mimeType
46
+ 'Content-Type': mimeType,
47
+ ...createOnlyHeaders
39
48
  },
40
49
  method: 'PUT',
41
50
  url
@@ -1 +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'\n\ninterface Args {\n access?: UploadInstructionsAccess\n bucket: string\n collectionPrefix: string\n getStorageClient: () => Storage\n useCompositePrefixes?: boolean\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 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 {\n type: 'http',\n file: {\n filename: sanitizedFilename,\n mimeType,\n size: filesize,\n uploadReference: { prefix: sanitizedDocPrefix },\n },\n request: {\n headers: {\n 'Content-Length': String(filesize),\n 'Content-Type': mimeType,\n },\n method: 'PUT',\n url,\n },\n }\n }\n}\n"],"names":["resolveSignedURLKey","Forbidden","generateUploadInstructions","access","bucket","collectionPrefix","getStorageClient","useCompositePrefixes","collectionSlug","docPrefix","filename","filesize","mimeType","overrideAccess","req","user","t","fileKey","sanitizedDocPrefix","sanitizedFilename","url","file","getSignedUrl","action","contentType","expires","Date","now","version","type","size","uploadReference","prefix","request","headers","String","method"],"mappings":"AAGA,SAASA,mBAAmB,QAAQ,6CAA4C;AAChF,SAASC,SAAS,QAAQ,UAAS;AAUnC,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,IAAId,UAAUa,IAAIE,CAAC;QAC3B;QAEA,MAAM,EAAEC,OAAO,EAAEC,kBAAkB,EAAEC,iBAAiB,EAAE,GAAG,MAAMnB,oBAAoB;YACnFK;YACAG;YACAC;YACAC;YACAI;YACAP;QACF;QAEA,MAAM,CAACa,IAAI,GAAG,MAAMd,mBACjBF,MAAM,CAACA,QACPiB,IAAI,CAACJ,SACLK,YAAY,CAAC;YACZC,QAAQ;YACRC,aAAaZ;YACba,SAASC,KAAKC,GAAG,KAAK,KAAK,KAAK;YAChCC,SAAS;QACX;QAEF,OAAO;YACLC,MAAM;YACNR,MAAM;gBACJX,UAAUS;gBACVP;gBACAkB,MAAMnB;gBACNoB,iBAAiB;oBAAEC,QAAQd;gBAAmB;YAChD;YACAe,SAAS;gBACPC,SAAS;oBACP,kBAAkBC,OAAOxB;oBACzB,gBAAgBC;gBAClB;gBACAwB,QAAQ;gBACRhB;YACF;QACF;IACF;AACF,EAAC"}
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
6
  collection: CollectionConfig;
7
7
  collectionPrefix?: string;
8
+ doc?: TypeWithID;
8
9
  filename: string;
9
10
  incomingHeaders?: Headers;
10
- prefixQueryParam?: string;
11
11
  req: PayloadRequest;
12
12
  uploadReference?: unknown;
13
13
  useCompositePrefixes?: boolean;
14
14
  }
15
- export declare function getFile({ bucket, client, collection, collectionPrefix, filename, incomingHeaders, prefixQueryParam, req, uploadReference, useCompositePrefixes, }: GetFileArgs): Promise<Response>;
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
@@ -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;AAS/D,UAAU,WAAW;IACnB,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,OAAO,CAAA;IACf,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,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,QAAQ,EACR,eAAe,EACf,gBAAgB,EAChB,GAAG,EACH,eAAe,EACf,oBAA4B,GAC7B,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC,CAiGjC"}
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, getFileKey } from '@payloadcms/plugin-cloud-storage/utilities';
3
- import { getRangeRequestInfo } from 'payload/internal';
4
- export async function getFile({ bucket, client, collection, collectionPrefix = '', filename, incomingHeaders, prefixQueryParam, req, uploadReference, useCompositePrefixes = false }) {
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
7
  collection,
8
+ collectionPrefix,
9
+ doc,
8
10
  filename,
9
- prefixQueryParam,
10
11
  req,
11
- uploadReference
12
+ uploadReference,
13
+ useCompositePrefixes
12
14
  });
13
- const { fileKey } = getFileKey({
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(fileKey);
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, collection, collectionPrefix = '
40
42
  }
41
43
  headers.append('Content-Type', String(metadata.contentType));
42
44
  headers.append('ETag', String(metadata.etag));
43
- // Add Content-Security-Policy header for SVG files to prevent executable code
44
- if (metadata.contentType === 'image/svg+xml') {
45
- headers.append('Content-Security-Policy', "script-src 'none'");
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({
@@ -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'\n\ninterface GetFileArgs {\n bucket: string\n client: Storage\n collection: CollectionConfig\n collectionPrefix?: string\n filename: string\n incomingHeaders?: Headers\n prefixQueryParam?: string\n req: PayloadRequest\n uploadReference?: unknown\n useCompositePrefixes?: boolean\n}\n\nexport async function getFile({\n bucket,\n client,\n collection,\n collectionPrefix = '',\n filename,\n incomingHeaders,\n prefixQueryParam,\n req,\n uploadReference,\n useCompositePrefixes = false,\n}: GetFileArgs): Promise<Response> {\n try {\n const docPrefix = await getDocPrefix({\n collection,\n filename,\n prefixQueryParam,\n req,\n uploadReference,\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","collection","collectionPrefix","filename","incomingHeaders","prefixQueryParam","req","uploadReference","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,UAAU,EACVC,mBAAmB,EAAE,EACrBC,QAAQ,EACRC,eAAe,EACfC,gBAAgB,EAChBC,GAAG,EACHC,eAAe,EACfC,uBAAuB,KAAK,EAChB;IACZ,IAAI;QACF,MAAMC,YAAY,MAAMd,aAAa;YACnCM;YACAE;YACAE;YACAC;YACAC;QACF;QAEA,MAAM,EAAEG,OAAO,EAAE,GAAGd,WAAW;YAC7BM;YACAO;YACAN;YACAK;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,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,kBAAkBnB,IAAIS,OAAO,CAACC,GAAG,CAAC,WAAWV,IAAIS,OAAO,CAACC,GAAG,CAAC;QACnE,MAAMU,aAAad,SAASe,IAAI;QAEhC,IAAIZ,UAAU,IAAIQ,QAAQnB;QAE1B,4CAA4C;QAC5C,KAAK,MAAM,CAACwB,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,IACE/B,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,eAAe3D,YAAY2D,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"}
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
@@ -46,14 +46,15 @@ export interface GcsStorageOptions {
46
46
  options: StorageOptions;
47
47
  /**
48
48
  * When true, the collection-level prefix and document-level prefix are combined
49
- * (compositional). When false (default), document prefix overrides collection
50
- * prefix entirely.
49
+ * (compositional). When false (default), a document prefix already within the
50
+ * collection prefix is used as-is for new uploads; otherwise it is nested beneath it.
51
+ * Existing files retain their stored prefixes for reads, URLs, and cleanup.
51
52
  *
52
- * Example:
53
- * - collection prefix: `collection-prefix/`
54
- * - document prefix: `document-prefix/`
55
- * - resulting prefix with useCompositePrefixes=true: `collection-prefix/document-prefix/`
56
- * - resulting prefix with useCompositePrefixes=false: `document-prefix/`
53
+ * Example with a document prefix already contained by the collection prefix:
54
+ * - collection prefix: `uploads/`
55
+ * - document prefix: `uploads/documents/`
56
+ * - resulting prefix with useCompositePrefixes=true: `uploads/uploads/documents/`
57
+ * - resulting prefix with useCompositePrefixes=false: `uploads/documents/`
57
58
  *
58
59
  * @default false
59
60
  */
@@ -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;AAO3E,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,iBAAiB,GAAG,CAAC,cAAc,EAAE,iBAAiB,KAAK,cAAc,CAAA;AAI9E,eAAO,MAAM,UAAU,EAAE,iBAqEvB,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;;;;;;;;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;;;;;;;;;;;;;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,iBAqEvB,CAAA"}
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'\n\nimport { createGcsAdapter } from './adapter.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 * 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), 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 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 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})\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","collectionsWithAdapter","entries","reduce","acc","slug","collOptions","config","map","collection","upload","disableLocalStorage","alwaysInsertFields"],"mappings":"AAQA,SAASA,OAAO,QAAQ,wBAAuB;AAC/C,SAASC,kBAAkB,QAAQ,mCAAkC;AAErE,SAASC,gBAAgB,QAAQ,eAAc;AAkE/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,OAAOb;YACT;YAEA,+CAA+C;YAC/C,MAAMe,yBAAmElB,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,MAAMY,SAAS;gBACb,GAAGrB,cAAc;gBACjBJ,aAAa,AAACI,CAAAA,eAAeJ,WAAW,IAAI,EAAE,AAAD,EAAG0B,GAAG,CAAC,CAACC;oBACnD,IAAI,CAACR,sBAAsB,CAACQ,WAAWJ,IAAI,CAAC,EAAE;wBAC5C,OAAOI;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,OAAOpC,mBAAmB;gBACxBqC,oBAAoBhC,kBAAkBgC,kBAAkB;gBACxD9B,aAAamB;gBACbH,sBAAsBlB,kBAAkBkB,oBAAoB;YAC9D,GAAGS;QACL;IACF,CAAA,EAAE"}
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 * 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 * 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 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})\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","collectionsWithAdapter","entries","reduce","acc","slug","collOptions","config","map","collection","upload","disableLocalStorage","alwaysInsertFields"],"mappings":"AAQA,SAASA,OAAO,QAAQ,wBAAuB;AAC/C,SAASC,kBAAkB,QAAQ,mCAAkC;AAErE,SAASC,gBAAgB,QAAQ,eAAc;AAmE/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,OAAOb;YACT;YAEA,+CAA+C;YAC/C,MAAMe,yBAAmElB,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,MAAMY,SAAS;gBACb,GAAGrB,cAAc;gBACjBJ,aAAa,AAACI,CAAAA,eAAeJ,WAAW,IAAI,EAAE,AAAD,EAAG0B,GAAG,CAAC,CAACC;oBACnD,IAAI,CAACR,sBAAsB,CAACQ,WAAWJ,IAAI,CAAC,EAAE;wBAC5C,OAAOI;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,OAAOpC,mBAAmB;gBACxBqC,oBAAoBhC,kBAAkBgC,kBAAkB;gBACxD9B,aAAamB;gBACbH,sBAAsBlB,kBAAkBkB,oBAAoB;YAC9D,GAAGS;QACL;IACF,CAAA,EAAE"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=staticHandler.spec.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"staticHandler.spec.d.ts","sourceRoot":"","sources":["../src/staticHandler.spec.ts"],"names":[],"mappings":""}
@@ -0,0 +1,66 @@
1
+ import { Readable } from 'node:stream';
2
+ import { describe, expect, it, vi } from 'vitest';
3
+ import { createGcsAdapter } from './adapter.js';
4
+ describe('static handler document locations', ()=>{
5
+ it('should read the checked document without another lookup', async ()=>{
6
+ const file = vi.fn(()=>({
7
+ createReadStream: ()=>Readable.from([
8
+ Buffer.from('file')
9
+ ]),
10
+ getMetadata: vi.fn(async ()=>[
11
+ {
12
+ contentType: 'image/png',
13
+ size: 4
14
+ }
15
+ ])
16
+ }));
17
+ const adapter = createGcsAdapter({
18
+ bucket: 'bucket',
19
+ getStorageClient: ()=>({
20
+ bucket: ()=>({
21
+ file
22
+ })
23
+ })
24
+ });
25
+ const find = vi.fn(async ()=>({
26
+ docs: [
27
+ {
28
+ prefix: 'database'
29
+ }
30
+ ]
31
+ }));
32
+ const generatedAdapter = adapter({
33
+ collection: {
34
+ fields: [],
35
+ slug: 'media',
36
+ upload: {}
37
+ },
38
+ prefix: 'media'
39
+ });
40
+ const doc = {
41
+ id: 'authorized',
42
+ prefix: 'legacy'
43
+ };
44
+ const response = await generatedAdapter.staticHandler({
45
+ headers: new Headers(),
46
+ payload: {
47
+ find,
48
+ logger: {
49
+ error: vi.fn()
50
+ }
51
+ }
52
+ }, {
53
+ doc,
54
+ params: {
55
+ collection: 'media',
56
+ filename: 'original.png'
57
+ }
58
+ });
59
+ expect(response.status).toBe(200);
60
+ expect(await response.text()).toBe('file');
61
+ expect(file).toHaveBeenCalledWith('legacy/original.png');
62
+ expect(find).not.toHaveBeenCalled();
63
+ });
64
+ });
65
+
66
+ //# sourceMappingURL=staticHandler.spec.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/staticHandler.spec.ts"],"sourcesContent":["import { Readable } from 'node:stream'\nimport { describe, expect, it, vi } from 'vitest'\n\nimport { createGcsAdapter } from './adapter.js'\n\ndescribe('static handler document locations', () => {\n it('should read the checked document without another lookup', async () => {\n const file = vi.fn(() => ({\n createReadStream: () => Readable.from([Buffer.from('file')]),\n getMetadata: vi.fn(async () => [{ contentType: 'image/png', size: 4 }]),\n }))\n const adapter = createGcsAdapter({\n bucket: 'bucket',\n getStorageClient: () => ({ bucket: () => ({ file }) }) as never,\n })\n const find = vi.fn(async () => ({ docs: [{ prefix: 'database' }] }))\n const generatedAdapter = adapter({\n collection: {\n fields: [],\n slug: 'media',\n upload: {},\n },\n prefix: 'media',\n })\n const doc = {\n id: 'authorized',\n prefix: 'legacy',\n }\n const response = await generatedAdapter.staticHandler(\n {\n headers: new Headers(),\n payload: { find, logger: { error: vi.fn() } },\n } as never,\n {\n doc,\n params: { collection: 'media', filename: 'original.png' },\n },\n )\n\n expect(response.status).toBe(200)\n expect(await response.text()).toBe('file')\n expect(file).toHaveBeenCalledWith('legacy/original.png')\n expect(find).not.toHaveBeenCalled()\n })\n})\n"],"names":["Readable","describe","expect","it","vi","createGcsAdapter","file","fn","createReadStream","from","Buffer","getMetadata","contentType","size","adapter","bucket","getStorageClient","find","docs","prefix","generatedAdapter","collection","fields","slug","upload","doc","id","response","staticHandler","headers","Headers","payload","logger","error","params","filename","status","toBe","text","toHaveBeenCalledWith","not","toHaveBeenCalled"],"mappings":"AAAA,SAASA,QAAQ,QAAQ,cAAa;AACtC,SAASC,QAAQ,EAAEC,MAAM,EAAEC,EAAE,EAAEC,EAAE,QAAQ,SAAQ;AAEjD,SAASC,gBAAgB,QAAQ,eAAc;AAE/CJ,SAAS,qCAAqC;IAC5CE,GAAG,2DAA2D;QAC5D,MAAMG,OAAOF,GAAGG,EAAE,CAAC,IAAO,CAAA;gBACxBC,kBAAkB,IAAMR,SAASS,IAAI,CAAC;wBAACC,OAAOD,IAAI,CAAC;qBAAQ;gBAC3DE,aAAaP,GAAGG,EAAE,CAAC,UAAY;wBAAC;4BAAEK,aAAa;4BAAaC,MAAM;wBAAE;qBAAE;YACxE,CAAA;QACA,MAAMC,UAAUT,iBAAiB;YAC/BU,QAAQ;YACRC,kBAAkB,IAAO,CAAA;oBAAED,QAAQ,IAAO,CAAA;4BAAET;wBAAK,CAAA;gBAAG,CAAA;QACtD;QACA,MAAMW,OAAOb,GAAGG,EAAE,CAAC,UAAa,CAAA;gBAAEW,MAAM;oBAAC;wBAAEC,QAAQ;oBAAW;iBAAE;YAAC,CAAA;QACjE,MAAMC,mBAAmBN,QAAQ;YAC/BO,YAAY;gBACVC,QAAQ,EAAE;gBACVC,MAAM;gBACNC,QAAQ,CAAC;YACX;YACAL,QAAQ;QACV;QACA,MAAMM,MAAM;YACVC,IAAI;YACJP,QAAQ;QACV;QACA,MAAMQ,WAAW,MAAMP,iBAAiBQ,aAAa,CACnD;YACEC,SAAS,IAAIC;YACbC,SAAS;gBAAEd;gBAAMe,QAAQ;oBAAEC,OAAO7B,GAAGG,EAAE;gBAAG;YAAE;QAC9C,GACA;YACEkB;YACAS,QAAQ;gBAAEb,YAAY;gBAASc,UAAU;YAAe;QAC1D;QAGFjC,OAAOyB,SAASS,MAAM,EAAEC,IAAI,CAAC;QAC7BnC,OAAO,MAAMyB,SAASW,IAAI,IAAID,IAAI,CAAC;QACnCnC,OAAOI,MAAMiC,oBAAoB,CAAC;QAClCrC,OAAOe,MAAMuB,GAAG,CAACC,gBAAgB;IACnC;AACF"}
@@ -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
- useCompositePrefixes?: boolean;
8
+ storageFilePath: string;
12
9
  }
13
- export declare function uploadFile({ acl, bucket, buffer, client, collectionPrefix, docPrefix, filename, mimeType, useCompositePrefixes, }: UploadFileArgs): Promise<void>;
10
+ export declare function uploadFile({ acl, bucket, buffer, client, mimeType, storageFilePath, }: UploadFileArgs): Promise<void>;
14
11
  export {};
15
12
  //# sourceMappingURL=uploadFile.d.ts.map
@@ -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;AAIpD,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,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B;AAED,wBAAsB,UAAU,CAAC,EAC/B,GAAG,EACH,MAAM,EACN,MAAM,EACN,MAAM,EACN,gBAAqB,EACrB,SAAS,EACT,QAAQ,EACR,QAAQ,EACR,oBAA4B,GAC7B,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAmBhC"}
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"}
@@ -1,12 +1,5 @@
1
- import { getFileKey } from '@payloadcms/plugin-cloud-storage/utilities';
2
- export async function uploadFile({ acl, bucket, buffer, client, collectionPrefix = '', docPrefix, filename, mimeType, useCompositePrefixes = false }) {
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
@@ -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,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"}
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-canary.33",
3
+ "version": "4.0.0-canary.35",
4
4
  "description": "Payload storage adapter for Google Cloud Storage",
5
5
  "homepage": "https://payloadcms.com",
6
6
  "repository": {
@@ -33,13 +33,13 @@
33
33
  ],
34
34
  "dependencies": {
35
35
  "@google-cloud/storage": "7.19.0",
36
- "@payloadcms/plugin-cloud-storage": "4.0.0-canary.33"
36
+ "@payloadcms/plugin-cloud-storage": "4.0.0-canary.35"
37
37
  },
38
38
  "devDependencies": {
39
- "payload": "4.0.0-canary.33"
39
+ "payload": "4.0.0-canary.35"
40
40
  },
41
41
  "peerDependencies": {
42
- "payload": "4.0.0-canary.33"
42
+ "payload": "4.0.0-canary.35"
43
43
  },
44
44
  "engines": {
45
45
  "node": ">=24.15.0"