@payloadcms/storage-gcs 3.24.0 → 3.25.0-canary.3d5c763

package/README.md

@@ -14,6 +14,7 @@ pnpm add @payloadcms/storage-gcs
 
 - 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.
 - When enabled, this package will automatically set `disableLocalStorage` to `true` for each collection.
+- When deploying to Vercel, server uploads are limited with 4.5MB. Set `clientUploads` to `true` to do uploads directly on the client. You must allow CORS PUT method for the bucket to your website.
 
 ```ts
 import { gcsStorage } from '@payloadcms/storage-gcs'

package/dist/client/GcsClientUploadHandler.d.ts

@@ -0,0 +1,8 @@
+export declare const GcsClientUploadHandler: ({ children, collectionSlug, enabled, extra, serverHandlerPath, }: {
+    children: import("react").ReactNode;
+    collectionSlug: import("packages/payload/src/index.js").UploadCollectionSlug;
+    enabled?: boolean;
+    extra: Record<string, unknown>;
+    serverHandlerPath: string;
+}) => import("react").JSX.Element;
+//# sourceMappingURL=GcsClientUploadHandler.d.ts.map

package/dist/client/GcsClientUploadHandler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GcsClientUploadHandler.d.ts","sourceRoot":"","sources":["../../src/client/GcsClientUploadHandler.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,sBAAsB;;;;;;aAqB0B,OAAO,aADlE,CAAA"}

package/dist/client/GcsClientUploadHandler.js

@@ -0,0 +1,26 @@
+'use client';
+import { createClientUploadHandler } from '@payloadcms/plugin-cloud-storage/client';
+export const GcsClientUploadHandler = createClientUploadHandler({
+    handler: async ({ apiRoute, collectionSlug, file, serverHandlerPath, serverURL })=>{
+        const response = await fetch(`${serverURL}${apiRoute}${serverHandlerPath}`, {
+            body: JSON.stringify({
+                collectionSlug,
+                filename: file.name,
+                mimeType: file.type
+            }),
+            credentials: 'include',
+            method: 'POST'
+        });
+        const { url } = await response.json();
+        await fetch(url, {
+            body: file,
+            headers: {
+                'Content-Length': file.size.toString(),
+                'Content-Type': file.type
+            },
+            method: 'PUT'
+        });
+    }
+});
+
+//# sourceMappingURL=GcsClientUploadHandler.js.map

package/dist/client/GcsClientUploadHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/client/GcsClientUploadHandler.ts"],"sourcesContent":["'use client'\nimport { createClientUploadHandler } from '@payloadcms/plugin-cloud-storage/client'\n\nexport const GcsClientUploadHandler = createClientUploadHandler({\n  handler: async ({ apiRoute, collectionSlug, file, serverHandlerPath, serverURL }) => {\n    const response = await fetch(`${serverURL}${apiRoute}${serverHandlerPath}`, {\n      body: JSON.stringify({\n        collectionSlug,\n        filename: file.name,\n        mimeType: file.type,\n      }),\n      credentials: 'include',\n      method: 'POST',\n    })\n\n    const { url } = await response.json()\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})\n"],"names":["createClientUploadHandler","GcsClientUploadHandler","handler","apiRoute","collectionSlug","file","serverHandlerPath","serverURL","response","fetch","body","JSON","stringify","filename","name","mimeType","type","credentials","method","url","json","headers","size","toString"],"mappings":"AAAA;AACA,SAASA,yBAAyB,QAAQ,0CAAyC;AAEnF,OAAO,MAAMC,yBAAyBD,0BAA0B;IAC9DE,SAAS,OAAO,EAAEC,QAAQ,EAAEC,cAAc,EAAEC,IAAI,EAAEC,iBAAiB,EAAEC,SAAS,EAAE;QAC9E,MAAMC,WAAW,MAAMC,MAAM,GAAGF,YAAYJ,WAAWG,mBAAmB,EAAE;YAC1EI,MAAMC,KAAKC,SAAS,CAAC;gBACnBR;gBACAS,UAAUR,KAAKS,IAAI;gBACnBC,UAAUV,KAAKW,IAAI;YACrB;YACAC,aAAa;YACbC,QAAQ;QACV;QAEA,MAAM,EAAEC,GAAG,EAAE,GAAG,MAAMX,SAASY,IAAI;QAEnC,MAAMX,MAAMU,KAAK;YACfT,MAAML;YACNgB,SAAS;gBAAE,kBAAkBhB,KAAKiB,IAAI,CAACC,QAAQ;gBAAI,gBAAgBlB,KAAKW,IAAI;YAAC;YAC7EE,QAAQ;QACV;IACF;AACF,GAAE"}

package/dist/exports/client.d.ts

@@ -0,0 +1,2 @@
+export { GcsClientUploadHandler } from '../client/GcsClientUploadHandler.js';
+//# sourceMappingURL=client.d.ts.map

package/dist/exports/client.d.ts.map

@@ -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

@@ -0,0 +1,3 @@
+export { GcsClientUploadHandler } from '../client/GcsClientUploadHandler.js';
+
+//# sourceMappingURL=client.js.map

package/dist/exports/client.js.map

@@ -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"}

package/dist/generateSignedURL.d.ts

@@ -0,0 +1,14 @@
+import type { Storage } from '@google-cloud/storage';
+import type { ClientUploadsAccess } from '@payloadcms/plugin-cloud-storage/types';
+import type { PayloadHandler } from 'payload';
+import type { GcsStorageOptions } from './index.js';
+interface Args {
+    access?: ClientUploadsAccess;
+    acl?: 'private' | 'public-read';
+    bucket: string;
+    collections: GcsStorageOptions['collections'];
+    getStorageClient: () => Storage;
+}
+export declare const getGenerateSignedURLHandler: ({ access, bucket, collections, getStorageClient, }: Args) => PayloadHandler;
+export {};
+//# sourceMappingURL=generateSignedURL.d.ts.map

package/dist/generateSignedURL.d.ts.map

@@ -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;CAChC;AAID,eAAO,MAAM,2BAA2B,uDAKrC,IAAI,KAAG,cAiCT,CAAA"}

package/dist/generateSignedURL.js

@@ -0,0 +1,34 @@
+import path from 'path';
+import { APIError, Forbidden } from 'payload';
+const defaultAccess = ({ req })=>!!req.user;
+export const getGenerateSignedURLHandler = ({ access = defaultAccess, bucket, collections, getStorageClient })=>{
+    return async (req)=>{
+        if (!req.json) {
+            throw new APIError('Unreachable');
+        }
+        const { collectionSlug, filename, mimeType } = await req.json();
+        const collectionS3Config = collections[collectionSlug];
+        if (!collectionS3Config) {
+            throw new APIError(`Collection ${collectionSlug} was not found in S3 options`);
+        }
+        const prefix = typeof collectionS3Config === 'object' && collectionS3Config.prefix || '';
+        if (!await access({
+            collectionSlug,
+            req
+        })) {
+            throw new Forbidden();
+        }
+        const fileKey = path.posix.join(prefix, filename);
+        const [url] = await getStorageClient().bucket(bucket).file(fileKey).getSignedUrl({
+            action: 'write',
+            contentType: mimeType,
+            expires: Date.now() + 60 * 60 * 5,
+            version: 'v4'
+        });
+        return Response.json({
+            url
+        });
+    };
+};
+
+//# sourceMappingURL=generateSignedURL.js.map

package/dist/generateSignedURL.js.map

@@ -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 path from 'path'\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}\n\nconst defaultAccess: Args['access'] = ({ req }) => !!req.user\n\nexport const getGenerateSignedURLHandler = ({\n  access = defaultAccess,\n  bucket,\n  collections,\n  getStorageClient,\n}: Args): PayloadHandler => {\n  return async (req) => {\n    if (!req.json) {\n      throw new APIError('Unreachable')\n    }\n\n    const { collectionSlug, filename, mimeType } = await req.json()\n\n    const collectionS3Config = collections[collectionSlug]\n    if (!collectionS3Config) {\n      throw new APIError(`Collection ${collectionSlug} was not found in S3 options`)\n    }\n\n    const prefix = (typeof collectionS3Config === 'object' && collectionS3Config.prefix) || ''\n\n    if (!(await access({ collectionSlug, req }))) {\n      throw new Forbidden()\n    }\n\n    const fileKey = path.posix.join(prefix, filename)\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({ url })\n  }\n}\n"],"names":["path","APIError","Forbidden","defaultAccess","req","user","getGenerateSignedURLHandler","access","bucket","collections","getStorageClient","json","collectionSlug","filename","mimeType","collectionS3Config","prefix","fileKey","posix","join","url","file","getSignedUrl","action","contentType","expires","Date","now","version","Response"],"mappings":"AAIA,OAAOA,UAAU,OAAM;AACvB,SAASC,QAAQ,EAAEC,SAAS,QAAQ,UAAS;AAY7C,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,EACX;IACL,OAAO,OAAON;QACZ,IAAI,CAACA,IAAIO,IAAI,EAAE;YACb,MAAM,IAAIV,SAAS;QACrB;QAEA,MAAM,EAAEW,cAAc,EAAEC,QAAQ,EAAEC,QAAQ,EAAE,GAAG,MAAMV,IAAIO,IAAI;QAE7D,MAAMI,qBAAqBN,WAAW,CAACG,eAAe;QACtD,IAAI,CAACG,oBAAoB;YACvB,MAAM,IAAId,SAAS,CAAC,WAAW,EAAEW,eAAe,4BAA4B,CAAC;QAC/E;QAEA,MAAMI,SAAS,AAAC,OAAOD,uBAAuB,YAAYA,mBAAmBC,MAAM,IAAK;QAExF,IAAI,CAAE,MAAMT,OAAO;YAAEK;YAAgBR;QAAI,IAAK;YAC5C,MAAM,IAAIF;QACZ;QAEA,MAAMe,UAAUjB,KAAKkB,KAAK,CAACC,IAAI,CAACH,QAAQH;QAExC,MAAM,CAACO,IAAI,GAAG,MAAMV,mBACjBF,MAAM,CAACA,QACPa,IAAI,CAACJ,SACLK,YAAY,CAAC;YACZC,QAAQ;YACRC,aAAaV;YACbW,SAASC,KAAKC,GAAG,KAAK,KAAK,KAAK;YAChCC,SAAS;QACX;QAEF,OAAOC,SAASlB,IAAI,CAAC;YAAES;QAAI;IAC7B;AACF,EAAC"}

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import type { StorageOptions } from '@google-cloud/storage';
-import type { CollectionOptions } from '@payloadcms/plugin-cloud-storage/types';
+import type { ClientUploadsConfig, CollectionOptions } from '@payloadcms/plugin-cloud-storage/types';
 import type { Plugin, UploadCollectionSlug } from 'payload';
 export interface GcsStorageOptions {
     acl?: 'Private' | 'Public';
@@ -7,6 +7,10 @@ export interface GcsStorageOptions {
      * The name of the bucket to use.
      */
     bucket: string;
+    /**
+     * Do uploads directly on the client to bypass limits on Vercel. You must allow CORS PUT method for the bucket to your website.
+     */
+    clientUploads?: ClientUploadsConfig;
     /**
      * Collection options to apply the S3 adapter to.
      */

package/dist/index.d.ts.map

@@ -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,EAGV,iBAAiB,EAElB,MAAM,wCAAwC,CAAA;AAC/C,OAAO,KAAK,EAAU,MAAM,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAUnE,MAAM,WAAW,iBAAiB;IAChC,GAAG,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAA;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;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;IAEjB;;;;OAIG;IACH,OAAO,EAAE,cAAc,CAAA;CACxB;AAED,KAAK,gBAAgB,GAAG,CAAC,cAAc,EAAE,iBAAiB,KAAK,MAAM,CAAA;AAErE,eAAO,MAAM,UAAU,EAAE,gBA4CtB,CAAA"}
+{"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,EAEV,mBAAmB,EAEnB,iBAAiB,EAElB,MAAM,wCAAwC,CAAA;AAC/C,OAAO,KAAK,EAAU,MAAM,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAWnE,MAAM,WAAW,iBAAiB;IAChC,GAAG,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAA;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;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;IAEjB;;;;OAIG;IACH,OAAO,EAAE,cAAc,CAAA;CACxB;AAED,KAAK,gBAAgB,GAAG,CAAC,cAAc,EAAE,iBAAiB,KAAK,MAAM,CAAA;AAErE,eAAO,MAAM,UAAU,EAAE,gBAiGtB,CAAA"}

package/dist/index.js

@@ -1,5 +1,6 @@
 import { Storage } from '@google-cloud/storage';
 import { cloudStoragePlugin } from '@payloadcms/plugin-cloud-storage';
+import { getGenerateSignedURLHandler } from './generateSignedURL.js';
 import { getGenerateURL } from './generateURL.js';
 import { getHandleDelete } from './handleDelete.js';
 import { getHandleUpload } from './handleUpload.js';
@@ -8,7 +9,48 @@ export const gcsStorage = (gcsStorageOptions)=>(incomingConfig)=>{
         if (gcsStorageOptions.enabled === false) {
             return incomingConfig;
         }
-        const adapter = gcsStorageInternal(gcsStorageOptions);
+        let storageClient = null;
+        const getStorageClient = ()=>{
+            if (storageClient) {
+                return storageClient;
+            }
+            storageClient = new Storage(gcsStorageOptions.options);
+            return storageClient;
+        };
+        const adapter = gcsStorageInternal(getStorageClient, gcsStorageOptions);
+        if (gcsStorageOptions.clientUploads) {
+            if (!incomingConfig.endpoints) {
+                incomingConfig.endpoints = [];
+            }
+            incomingConfig.endpoints.push({
+                handler: getGenerateSignedURLHandler({
+                    access: typeof gcsStorageOptions.clientUploads === 'object' ? gcsStorageOptions.clientUploads.access : undefined,
+                    bucket: gcsStorageOptions.bucket,
+                    collections: gcsStorageOptions.collections,
+                    getStorageClient
+                }),
+                method: 'post',
+                path: '/storage-gcs-generate-signed-url'
+            });
+        }
+        if (!incomingConfig.admin) {
+            incomingConfig.admin = {};
+        }
+        if (!incomingConfig.admin.components) {
+            incomingConfig.admin.components = {};
+        }
+        if (!incomingConfig.admin.components.providers) {
+            incomingConfig.admin.components.providers = [];
+        }
+        for(const collectionSlug in gcsStorageOptions.collections){
+            incomingConfig.admin.components.providers.push({
+                clientProps: {
+                    collectionSlug,
+                    enabled: !!gcsStorageOptions.clientUploads
+                },
+                path: '@payloadcms/storage-gcs/client#GcsClientUploadHandler'
+            });
+        }
         // Add adapter to each collection option object
         const collectionsWithAdapter = Object.entries(gcsStorageOptions.collections).reduce((acc, [slug, collOptions])=>({
                 ...acc,
@@ -37,16 +79,8 @@ export const gcsStorage = (gcsStorageOptions)=>(incomingConfig)=>{
             collections: collectionsWithAdapter
         })(config);
     };
-function gcsStorageInternal({ acl, bucket, options }) {
+function gcsStorageInternal(getStorageClient, { acl, bucket }) {
     return ({ collection, prefix })=>{
-        let storageClient = null;
-        const getStorageClient = ()=>{
-            if (storageClient) {
-                return storageClient;
-            }
-            storageClient = new Storage(options);
-            return storageClient;
-        };
         return {
             name: 'gcs',
             generateURL: getGenerateURL({

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { StorageOptions } from '@google-cloud/storage'\nimport type {\n  Adapter,\n  PluginOptions as CloudStoragePluginOptions,\n  CollectionOptions,\n  GeneratedAdapter,\n} from '@payloadcms/plugin-cloud-storage/types'\nimport type { Config, Plugin, UploadCollectionSlug } from 'payload'\n\nimport { Storage } from '@google-cloud/storage'\nimport { cloudStoragePlugin } from '@payloadcms/plugin-cloud-storage'\n\nimport { getGenerateURL } from './generateURL.js'\nimport { getHandleDelete } from './handleDelete.js'\nimport { getHandleUpload } from './handleUpload.js'\nimport { getHandler } from './staticHandler.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   * 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  /**\n   * Google Cloud Storage client configuration.\n   *\n   * @see https://github.com/googleapis/nodejs-storage\n   */\n  options: StorageOptions\n}\n\ntype GcsStoragePlugin = (gcsStorageArgs: GcsStorageOptions) => Plugin\n\nexport const gcsStorage: GcsStoragePlugin =\n  (gcsStorageOptions: GcsStorageOptions) =>\n  (incomingConfig: Config): Config => {\n    if (gcsStorageOptions.enabled === false) {\n      return incomingConfig\n    }\n\n    const adapter = gcsStorageInternal(gcsStorageOptions)\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    })(config)\n  }\n\nfunction gcsStorageInternal({ acl, bucket, options }: GcsStorageOptions): Adapter {\n  return ({ collection, prefix }): GeneratedAdapter => {\n    let storageClient: null | Storage = null\n\n    const getStorageClient = (): Storage => {\n      if (storageClient) {\n        return storageClient\n      }\n      storageClient = new Storage(options)\n      return storageClient\n    }\n\n    return {\n      name: 'gcs',\n      generateURL: getGenerateURL({ bucket, getStorageClient }),\n      handleDelete: getHandleDelete({ bucket, getStorageClient }),\n      handleUpload: getHandleUpload({\n        acl,\n        bucket,\n        collection,\n        getStorageClient,\n        prefix,\n      }),\n      staticHandler: getHandler({ bucket, collection, getStorageClient }),\n    }\n  }\n}\n"],"names":["Storage","cloudStoragePlugin","getGenerateURL","getHandleDelete","getHandleUpload","getHandler","gcsStorage","gcsStorageOptions","incomingConfig","enabled","adapter","gcsStorageInternal","collectionsWithAdapter","Object","entries","collections","reduce","acc","slug","collOptions","config","map","collection","upload","disableLocalStorage","acl","bucket","options","prefix","storageClient","getStorageClient","name","generateURL","handleDelete","handleUpload","staticHandler"],"mappings":"AASA,SAASA,OAAO,QAAQ,wBAAuB;AAC/C,SAASC,kBAAkB,QAAQ,mCAAkC;AAErE,SAASC,cAAc,QAAQ,mBAAkB;AACjD,SAASC,eAAe,QAAQ,oBAAmB;AACnD,SAASC,eAAe,QAAQ,oBAAmB;AACnD,SAASC,UAAU,QAAQ,qBAAoB;AA8B/C,OAAO,MAAMC,aACX,CAACC,oBACD,CAACC;QACC,IAAID,kBAAkBE,OAAO,KAAK,OAAO;YACvC,OAAOD;QACT;QAEA,MAAME,UAAUC,mBAAmBJ;QAEnC,+CAA+C;QAC/C,MAAMK,yBAAmEC,OAAOC,OAAO,CACrFP,kBAAkBQ,WAAW,EAC7BC,MAAM,CACN,CAACC,KAAK,CAACC,MAAMC,YAAY,GAAM,CAAA;gBAC7B,GAAGF,GAAG;gBACN,CAACC,KAAK,EAAE;oBACN,GAAIC,gBAAgB,OAAO,CAAC,IAAIA,WAAW;oBAC3CT;gBACF;YACF,CAAA,GACA,CAAC;QAGH,gFAAgF;QAChF,MAAMU,SAAS;YACb,GAAGZ,cAAc;YACjBO,aAAa,AAACP,CAAAA,eAAeO,WAAW,IAAI,EAAE,AAAD,EAAGM,GAAG,CAAC,CAACC;gBACnD,IAAI,CAACV,sBAAsB,CAACU,WAAWJ,IAAI,CAAC,EAAE;oBAC5C,OAAOI;gBACT;gBAEA,OAAO;oBACL,GAAGA,UAAU;oBACbC,QAAQ;wBACN,GAAI,OAAOD,WAAWC,MAAM,KAAK,WAAWD,WAAWC,MAAM,GAAG,CAAC,CAAC;wBAClEC,qBAAqB;oBACvB;gBACF;YACF;QACF;QAEA,OAAOvB,mBAAmB;YACxBc,aAAaH;QACf,GAAGQ;IACL,EAAC;AAEH,SAAST,mBAAmB,EAAEc,GAAG,EAAEC,MAAM,EAAEC,OAAO,EAAqB;IACrE,OAAO,CAAC,EAAEL,UAAU,EAAEM,MAAM,EAAE;QAC5B,IAAIC,gBAAgC;QAEpC,MAAMC,mBAAmB;YACvB,IAAID,eAAe;gBACjB,OAAOA;YACT;YACAA,gBAAgB,IAAI7B,QAAQ2B;YAC5B,OAAOE;QACT;QAEA,OAAO;YACLE,MAAM;YACNC,aAAa9B,eAAe;gBAAEwB;gBAAQI;YAAiB;YACvDG,cAAc9B,gBAAgB;gBAAEuB;gBAAQI;YAAiB;YACzDI,cAAc9B,gBAAgB;gBAC5BqB;gBACAC;gBACAJ;gBACAQ;gBACAF;YACF;YACAO,eAAe9B,WAAW;gBAAEqB;gBAAQJ;gBAAYQ;YAAiB;QACnE;IACF;AACF"}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { StorageOptions } from '@google-cloud/storage'\nimport type {\n  Adapter,\n  ClientUploadsConfig,\n  PluginOptions as CloudStoragePluginOptions,\n  CollectionOptions,\n  GeneratedAdapter,\n} from '@payloadcms/plugin-cloud-storage/types'\nimport type { Config, Plugin, UploadCollectionSlug } from 'payload'\n\nimport { Storage } from '@google-cloud/storage'\nimport { cloudStoragePlugin } from '@payloadcms/plugin-cloud-storage'\n\nimport { getGenerateSignedURLHandler } from './generateSignedURL.js'\nimport { getGenerateURL } from './generateURL.js'\nimport { getHandleDelete } from './handleDelete.js'\nimport { getHandleUpload } from './handleUpload.js'\nimport { getHandler } from './staticHandler.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   * Do uploads directly on the client to bypass limits on Vercel. You must allow CORS PUT method for the bucket to your website.\n   */\n  clientUploads?: ClientUploadsConfig\n  /**\n   * Collection options to apply the S3 adapter to.\n   */\n  collections: Partial<Record<UploadCollectionSlug, Omit<CollectionOptions, 'adapter'> | true>>\n  /**\n   * Whether or not to enable the plugin\n   *\n   * Default: true\n   */\n  enabled?: boolean\n\n  /**\n   * Google Cloud Storage client configuration.\n   *\n   * @see https://github.com/googleapis/nodejs-storage\n   */\n  options: StorageOptions\n}\n\ntype GcsStoragePlugin = (gcsStorageArgs: GcsStorageOptions) => Plugin\n\nexport const gcsStorage: GcsStoragePlugin =\n  (gcsStorageOptions: GcsStorageOptions) =>\n  (incomingConfig: Config): Config => {\n    if (gcsStorageOptions.enabled === false) {\n      return incomingConfig\n    }\n\n    let storageClient: null | Storage = null\n\n    const getStorageClient = (): Storage => {\n      if (storageClient) {\n        return storageClient\n      }\n      storageClient = new Storage(gcsStorageOptions.options)\n\n      return storageClient\n    }\n\n    const adapter = gcsStorageInternal(getStorageClient, gcsStorageOptions)\n\n    if (gcsStorageOptions.clientUploads) {\n      if (!incomingConfig.endpoints) {\n        incomingConfig.endpoints = []\n      }\n\n      incomingConfig.endpoints.push({\n        handler: getGenerateSignedURLHandler({\n          access:\n            typeof gcsStorageOptions.clientUploads === 'object'\n              ? gcsStorageOptions.clientUploads.access\n              : undefined,\n          bucket: gcsStorageOptions.bucket,\n          collections: gcsStorageOptions.collections,\n          getStorageClient,\n        }),\n        method: 'post',\n        path: '/storage-gcs-generate-signed-url',\n      })\n    }\n\n    if (!incomingConfig.admin) {\n      incomingConfig.admin = {}\n    }\n\n    if (!incomingConfig.admin.components) {\n      incomingConfig.admin.components = {}\n    }\n\n    if (!incomingConfig.admin.components.providers) {\n      incomingConfig.admin.components.providers = []\n    }\n\n    for (const collectionSlug in gcsStorageOptions.collections) {\n      incomingConfig.admin.components.providers.push({\n        clientProps: {\n          collectionSlug,\n          enabled: !!gcsStorageOptions.clientUploads,\n        },\n        path: '@payloadcms/storage-gcs/client#GcsClientUploadHandler',\n      })\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    })(config)\n  }\n\nfunction gcsStorageInternal(\n  getStorageClient: () => Storage,\n  { acl, bucket }: GcsStorageOptions,\n): Adapter {\n  return ({ collection, prefix }): GeneratedAdapter => {\n    return {\n      name: 'gcs',\n      generateURL: getGenerateURL({ bucket, getStorageClient }),\n      handleDelete: getHandleDelete({ bucket, getStorageClient }),\n      handleUpload: getHandleUpload({\n        acl,\n        bucket,\n        collection,\n        getStorageClient,\n        prefix,\n      }),\n      staticHandler: getHandler({ bucket, collection, getStorageClient }),\n    }\n  }\n}\n"],"names":["Storage","cloudStoragePlugin","getGenerateSignedURLHandler","getGenerateURL","getHandleDelete","getHandleUpload","getHandler","gcsStorage","gcsStorageOptions","incomingConfig","enabled","storageClient","getStorageClient","options","adapter","gcsStorageInternal","clientUploads","endpoints","push","handler","access","undefined","bucket","collections","method","path","admin","components","providers","collectionSlug","clientProps","collectionsWithAdapter","Object","entries","reduce","acc","slug","collOptions","config","map","collection","upload","disableLocalStorage","acl","prefix","name","generateURL","handleDelete","handleUpload","staticHandler"],"mappings":"AAUA,SAASA,OAAO,QAAQ,wBAAuB;AAC/C,SAASC,kBAAkB,QAAQ,mCAAkC;AAErE,SAASC,2BAA2B,QAAQ,yBAAwB;AACpE,SAASC,cAAc,QAAQ,mBAAkB;AACjD,SAASC,eAAe,QAAQ,oBAAmB;AACnD,SAASC,eAAe,QAAQ,oBAAmB;AACnD,SAASC,UAAU,QAAQ,qBAAoB;AAkC/C,OAAO,MAAMC,aACX,CAACC,oBACD,CAACC;QACC,IAAID,kBAAkBE,OAAO,KAAK,OAAO;YACvC,OAAOD;QACT;QAEA,IAAIE,gBAAgC;QAEpC,MAAMC,mBAAmB;YACvB,IAAID,eAAe;gBACjB,OAAOA;YACT;YACAA,gBAAgB,IAAIX,QAAQQ,kBAAkBK,OAAO;YAErD,OAAOF;QACT;QAEA,MAAMG,UAAUC,mBAAmBH,kBAAkBJ;QAErD,IAAIA,kBAAkBQ,aAAa,EAAE;YACnC,IAAI,CAACP,eAAeQ,SAAS,EAAE;gBAC7BR,eAAeQ,SAAS,GAAG,EAAE;YAC/B;YAEAR,eAAeQ,SAAS,CAACC,IAAI,CAAC;gBAC5BC,SAASjB,4BAA4B;oBACnCkB,QACE,OAAOZ,kBAAkBQ,aAAa,KAAK,WACvCR,kBAAkBQ,aAAa,CAACI,MAAM,GACtCC;oBACNC,QAAQd,kBAAkBc,MAAM;oBAChCC,aAAaf,kBAAkBe,WAAW;oBAC1CX;gBACF;gBACAY,QAAQ;gBACRC,MAAM;YACR;QACF;QAEA,IAAI,CAAChB,eAAeiB,KAAK,EAAE;YACzBjB,eAAeiB,KAAK,GAAG,CAAC;QAC1B;QAEA,IAAI,CAACjB,eAAeiB,KAAK,CAACC,UAAU,EAAE;YACpClB,eAAeiB,KAAK,CAACC,UAAU,GAAG,CAAC;QACrC;QAEA,IAAI,CAAClB,eAAeiB,KAAK,CAACC,UAAU,CAACC,SAAS,EAAE;YAC9CnB,eAAeiB,KAAK,CAACC,UAAU,CAACC,SAAS,GAAG,EAAE;QAChD;QAEA,IAAK,MAAMC,kBAAkBrB,kBAAkBe,WAAW,CAAE;YAC1Dd,eAAeiB,KAAK,CAACC,UAAU,CAACC,SAAS,CAACV,IAAI,CAAC;gBAC7CY,aAAa;oBACXD;oBACAnB,SAAS,CAAC,CAACF,kBAAkBQ,aAAa;gBAC5C;gBACAS,MAAM;YACR;QACF;QAEA,+CAA+C;QAC/C,MAAMM,yBAAmEC,OAAOC,OAAO,CACrFzB,kBAAkBe,WAAW,EAC7BW,MAAM,CACN,CAACC,KAAK,CAACC,MAAMC,YAAY,GAAM,CAAA;gBAC7B,GAAGF,GAAG;gBACN,CAACC,KAAK,EAAE;oBACN,GAAIC,gBAAgB,OAAO,CAAC,IAAIA,WAAW;oBAC3CvB;gBACF;YACF,CAAA,GACA,CAAC;QAGH,gFAAgF;QAChF,MAAMwB,SAAS;YACb,GAAG7B,cAAc;YACjBc,aAAa,AAACd,CAAAA,eAAec,WAAW,IAAI,EAAE,AAAD,EAAGgB,GAAG,CAAC,CAACC;gBACnD,IAAI,CAACT,sBAAsB,CAACS,WAAWJ,IAAI,CAAC,EAAE;oBAC5C,OAAOI;gBACT;gBAEA,OAAO;oBACL,GAAGA,UAAU;oBACbC,QAAQ;wBACN,GAAI,OAAOD,WAAWC,MAAM,KAAK,WAAWD,WAAWC,MAAM,GAAG,CAAC,CAAC;wBAClEC,qBAAqB;oBACvB;gBACF;YACF;QACF;QAEA,OAAOzC,mBAAmB;YACxBsB,aAAaQ;QACf,GAAGO;IACL,EAAC;AAEH,SAASvB,mBACPH,gBAA+B,EAC/B,EAAE+B,GAAG,EAAErB,MAAM,EAAqB;IAElC,OAAO,CAAC,EAAEkB,UAAU,EAAEI,MAAM,EAAE;QAC5B,OAAO;YACLC,MAAM;YACNC,aAAa3C,eAAe;gBAAEmB;gBAAQV;YAAiB;YACvDmC,cAAc3C,gBAAgB;gBAAEkB;gBAAQV;YAAiB;YACzDoC,cAAc3C,gBAAgB;gBAC5BsC;gBACArB;gBACAkB;gBACA5B;gBACAgC;YACF;YACAK,eAAe3C,WAAW;gBAAEgB;gBAAQkB;gBAAY5B;YAAiB;QACnE;IACF;AACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@payloadcms/storage-gcs",
-  "version": "3.24.0",
+  "version": "3.25.0-canary.3d5c763",
   "description": "Payload storage adapter for Google Cloud Storage",
   "homepage": "https://payloadcms.com",
   "repository": {
@@ -23,6 +23,11 @@
       "import": "./dist/index.js",
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
+    },
+    "./client": {
+      "import": "./dist/exports/client.js",
+      "types": "./dist/exports/client.d.ts",
+      "default": "./dist/exports/client.js"
     }
   },
   "main": "./dist/index.js",
@@ -32,13 +37,13 @@
   ],
   "dependencies": {
     "@google-cloud/storage": "^7.7.0",
-    "@payloadcms/plugin-cloud-storage": "3.24.0"
+    "@payloadcms/plugin-cloud-storage": "3.25.0-canary.3d5c763"
   },
   "devDependencies": {
-    "payload": "3.24.0"
+    "payload": "3.25.0-canary.3d5c763"
   },
   "peerDependencies": {
-    "payload": "3.24.0"
+    "payload": "3.25.0-canary.3d5c763"
   },
   "engines": {
     "node": "^18.20.2 || >=20.9.0"