@websolutespa/payload-plugin-storage 2.0.1-next.0

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @websolutespa/payload-plugin-storage
+
+## 2.0.1-next.0
+
+### Major Changes
+
+- e74b305: Release: Payload 3.7.0

package/README.md

@@ -0,0 +1,25 @@
+# @websolutespa/payload-plugin-storage
+
+[![npm version](https://badge.fury.io/js/%40websolutespa%2Fpayload-plugin-storage.svg)](https://badge.fury.io/js/%40websolutespa%2Fpayload-plugin-storage)
+
+[![status alpha](https://img.shields.io/badge/status-alpha-red.svg)](https://shields.io/)
+
+Storage plugin for PayloadCms.
+
+# Payload Storage Plugin
+
+A plugin for [Payload CMS](https://github.com/payloadcms/payload) that handle multiple storage adapters.
+
+### Requirements:
+
+- Payload version 3.48.0 or higher is required.
+
+## Installation
+
+```bash
+npm i @websolutespa/payload-plugin-storage
+```
+
+---
+
+##### *this library is for internal usage and not production ready*

package/dist/index.d.ts

@@ -0,0 +1,40 @@
+import { AzureStorageOptions } from "@payloadcms/storage-azure";
+import { GcsStorageOptions } from "@payloadcms/storage-gcs";
+import { S3StorageOptions } from "@payloadcms/storage-s3";
+import { FSStorageOptions } from "@websolutespa/payload-plugin-cloud-storage-fs";
+import * as payload0 from "payload";
+import { Plugin, UploadCollectionSlug } from "payload";
+
+//#region src/types.d.ts
+type StorageFsOptions = {
+  adapter: 'fs';
+  collections?: UploadCollectionSlug[];
+} & Partial<FSStorageOptions>;
+type StorageAzureOptions = {
+  adapter: 'azure';
+  collections?: AzureStorageOptions['collections'] | string[] | string;
+} & Omit<Partial<AzureStorageOptions>, 'collections'>;
+type StorageGcsOptions = {
+  adapter: 'gcs';
+  collections?: GcsStorageOptions['collections'] | string[] | string;
+} & Partial<GcsStorageOptions>;
+type StorageS3Options = {
+  adapter: 's3';
+  collections?: S3StorageOptions['collections'] | string[] | string;
+} & Partial<S3StorageOptions>;
+type StorageOptions = StorageFsOptions | StorageAzureOptions | StorageGcsOptions | StorageS3Options;
+//# sourceMappingURL=types.d.ts.map
+//#endregion
+//#region src/plugin.d.ts
+declare const storage: (options: StorageOptions & {
+  enabled?: boolean;
+}) => Plugin;
+//# sourceMappingURL=plugin.d.ts.map
+//#endregion
+//#region src/index.d.ts
+declare const storagePlugin: (options: StorageOptions & {
+  enabled?: boolean;
+}) => payload0.Plugin;
+//#endregion
+export { StorageAzureOptions, StorageFsOptions, StorageGcsOptions, StorageOptions, StorageS3Options, storage as default, storagePlugin };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../../src/types.ts","../../src/plugin.ts","../../src/index.ts"],"sourcesContent":[],"mappings":";;;;;;;;KAMY,gBAAA;;gBAEI;AAFhB,CAAA,GAGI,OAHQ,CAGA,gBAHgB,CAAA;AAAA,KAKhB,mBAAA,GALgB;EAAA,OAEZ,EAAA,OAAA;EAAoB,WACxB,CAAA,EAII,mBAJJ,CAAA,aAAA,CAAA,GAAA,MAAA,EAAA,GAAA,MAAA;CAAgB,GAKxB,IALA,CAKK,OALL,CAKa,mBALb,CAAA,EAAA,aAAA,CAAA;AAAO,KAOC,iBAAA,GAPD;EAEC,OAAA,EAAA,KAAA;EAAmB,WAAA,CAAA,EAOf,iBAPe,CAAA,aAAA,CAAA,GAAA,MAAA,EAAA,GAAA,MAAA;CAAA,GAQ3B,OANY,CAMJ,iBANI,CAAA;AACC,KAOL,gBAAA,GAPK;EAAmB,OAA3B,EAAA,IAAA;EAAO,WAAZ,CAAA,EASY,gBATZ,CAAA,aAAA,CAAA,GAAA,MAAA,EAAA,GAAA,MAAA;AAAI,CAAA,GAUJ,OAVI,CAUI,gBAVJ,CAAA;AAEI,KAUA,cAAA,GAAiB,gBAVA,GAUmB,mBAVnB,GAUyC,iBAVzC,GAU6D,gBAV7D;;;;cCNhB,mBAAoB;;MAAyC;;;;cCN7D,yBAAuB,cAAA;;MAAV,QAAA,CAAA"}

package/dist/index.js

@@ -0,0 +1,6 @@
+export * from './types';
+import { storage } from './plugin';
+export const storagePlugin = storage;
+export default storage;
+
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export * from './types';\r\n\r\nimport { storage } from './plugin';\r\n\r\nexport const storagePlugin = storage;\r\n\r\nexport default storage;\r\n"],"names":["storage","storagePlugin"],"mappings":"AAAA,cAAc,UAAU;AAExB,SAASA,OAAO,QAAQ,WAAW;AAEnC,OAAO,MAAMC,gBAAgBD,QAAQ;AAErC,eAAeA,QAAQ"}

package/dist/plugin.js

@@ -0,0 +1,155 @@
+import { cloudStoragePlugin } from '@payloadcms/plugin-cloud-storage';
+import { azureStorage } from '@payloadcms/storage-azure';
+import { gcsStorage } from '@payloadcms/storage-gcs';
+import { s3Storage } from '@payloadcms/storage-s3';
+import { fsStorageAdapter } from '@websolutespa/payload-plugin-cloud-storage-fs';
+import payload from 'payload';
+export const storage = (options)=>async (sourceConfig)=>{
+        if (options.enabled === false) {
+            return sourceConfig;
+        }
+        options.adapter = options.adapter || 'fs';
+        const targetConfig = {
+            ...sourceConfig,
+            admin: {
+                ...sourceConfig.admin,
+                dependencies: {
+                    ...sourceConfig.admin?.dependencies,
+                    azureComponent: {
+                        path: '@payloadcms/storage-azure/client#AzureClientUploadHandler',
+                        type: 'function'
+                    },
+                    cgsComponent: {
+                        path: '@payloadcms/storage-gcs/client#GcsClientUploadHandler',
+                        type: 'function'
+                    },
+                    s3Component: {
+                        path: '@payloadcms/storage-s3/client#S3ClientUploadHandler',
+                        type: 'function'
+                    }
+                }
+            },
+            onInit: async (payload)=>{
+                if (typeof sourceConfig.onInit === 'function') {
+                    await sourceConfig.onInit(payload);
+                }
+                console.log('@websolutespa/payload-plugin-localization.onInit');
+            }
+        };
+        const storage = getStoragePlugin(options);
+        return await storage(targetConfig);
+    };
+function getStoragePlugin(options) {
+    switch(options.adapter){
+        case 'azure':
+            {
+                const collections = getCollections(options.collections);
+                const connectionString = getEnv('AZURE_STORAGE_CONNECTION_STRING');
+                const containerName = getEnv('AZURE_STORAGE_CONTAINER_NAME');
+                const allowContainerCreate = getEnvBool('AZURE_STORAGE_ALLOW_CONTAINER_CREATE');
+                const baseURL = getEnv('AZURE_STORAGE_ACCOUNT_BASEURL');
+                return azureStorage({
+                    connectionString,
+                    containerName,
+                    allowContainerCreate,
+                    baseURL,
+                    collections
+                });
+            }
+        case 's3':
+            {
+                const collections = getCollections(options.collections);
+                const bucket = getEnv('S3_STORAGE_BUCKET');
+                const region = getEnv('S3_STORAGE_REGION');
+                const accessKeyId = getEnv('S3_STORAGE_ACCESS_KEY_ID');
+                const secretAccessKey = getEnv('S3_STORAGE_SECRET_ACCESS_KEY');
+                const endpoint = getEnv('S3_STORAGE_ENDPOINT') || undefined;
+                return s3Storage({
+                    bucket,
+                    config: {
+                        region,
+                        credentials: {
+                            accessKeyId,
+                            secretAccessKey
+                        },
+                        endpoint
+                    },
+                    collections
+                });
+            }
+        case 'gcs':
+            {
+                const collections = getCollections(options.collections);
+                const bucket = getEnv('GCS_STORAGE_BUCKET');
+                const credentials = getEnvJson('GCS_STORAGE_JSON_CREDENTIALS') || undefined;
+                return gcsStorage({
+                    bucket,
+                    options: {
+                        credentials
+                    },
+                    collections
+                });
+            }
+        default:
+            {
+                const keys = options.collections || [
+                    'media'
+                ];
+                const baseDir = getEnv('FS_STORAGE_BASEDIR');
+                const baseURL = getEnv('FS_STORAGE_BASEURL');
+                const disablePayloadAccessControl = getEnvBool('FS_STORAGE_DISABLE_PAYLOAD_ACCESS_CONTROL') || undefined;
+                const generateFileURLEnabled = getEnvBool('FS_STORAGE_ENABLE_GENERATE_FILE_URL');
+                const baseUrl = getEnv('FS_STORAGE_BASEURL');
+                const collections = Object.fromEntries(keys.map((k)=>[
+                        k,
+                        {
+                            adapter: fsStorageAdapter({
+                                baseDir,
+                                baseURL
+                            }),
+                            disablePayloadAccessControl,
+                            generateFileURL: generateFileURLEnabled ? ({ filename })=>`${baseUrl}/${filename}` : undefined
+                        }
+                    ]));
+                return cloudStoragePlugin({
+                    collections
+                });
+            }
+    }
+}
+function getCollections(options) {
+    if (!options) {
+        return {
+            media: true
+        };
+    }
+    if (typeof options === 'string') {
+        return {
+            [options]: true
+        };
+    }
+    if (Array.isArray(options)) {
+        return Object.fromEntries(options.map((k)=>[
+                k,
+                true
+            ]));
+    }
+    return options;
+}
+function getEnv(key) {
+    const value = (process.env[key] || '').trim();
+    if (!value) {
+        const logger = payload.logger || console;
+        logger.error(`[Storage] missing env var [${key}]`);
+    }
+    return value;
+}
+function getEnvBool(key) {
+    return (process.env[key] || '').trim() === 'true';
+}
+function getEnvJson(key) {
+    const value = getEnv(key);
+    return JSON.parse(value);
+}
+
+//# sourceMappingURL=plugin.js.map

package/dist/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/plugin.ts"],"sourcesContent":["import { cloudStoragePlugin } from '@payloadcms/plugin-cloud-storage';\r\nimport type { CollectionOptions } from '@payloadcms/plugin-cloud-storage/types';\r\nimport { azureStorage } from '@payloadcms/storage-azure';\r\nimport { gcsStorage } from '@payloadcms/storage-gcs';\r\nimport { s3Storage } from '@payloadcms/storage-s3';\r\nimport { fsStorageAdapter } from '@websolutespa/payload-plugin-cloud-storage-fs';\r\nimport type { CollectionConfig, Config, Plugin, UploadCollectionSlug } from 'payload';\r\nimport payload, { ImageSize, Payload } from 'payload';\r\nimport { StorageOptions } from './types';\r\n\r\nexport const storage = (options: StorageOptions & { enabled?: boolean }): Plugin => async (sourceConfig: Config): Promise<Config> => {\r\n  if (options.enabled === false) {\r\n    return sourceConfig;\r\n  }\r\n  options.adapter = options.adapter || 'fs';\r\n  const targetConfig: Config = {\r\n    ...sourceConfig,\r\n    admin: {\r\n      ...sourceConfig.admin,\r\n      dependencies: {\r\n        ...sourceConfig.admin?.dependencies,\r\n        azureComponent: {\r\n          path: '@payloadcms/storage-azure/client#AzureClientUploadHandler',\r\n          type: 'function',\r\n        },\r\n        cgsComponent: {\r\n          path: '@payloadcms/storage-gcs/client#GcsClientUploadHandler',\r\n          type: 'function',\r\n        },\r\n        s3Component: {\r\n          path: '@payloadcms/storage-s3/client#S3ClientUploadHandler',\r\n          type: 'function',\r\n        },\r\n      },\r\n    },\r\n    onInit: async (payload: Payload) => {\r\n      if (typeof sourceConfig.onInit === 'function') {\r\n        await sourceConfig.onInit(payload);\r\n      }\r\n      console.log('@websolutespa/payload-plugin-localization.onInit');\r\n    },\r\n  };\r\n  const storage = getStoragePlugin(options);\r\n  return await storage(targetConfig);\r\n};\r\n\r\nfunction getStoragePlugin(options: StorageOptions) {\r\n\r\n  switch (options.adapter) {\r\n    case 'azure': {\r\n      const collections = getCollections(options.collections);\r\n      const connectionString = getEnv('AZURE_STORAGE_CONNECTION_STRING');\r\n      const containerName = getEnv('AZURE_STORAGE_CONTAINER_NAME');\r\n      const allowContainerCreate = getEnvBool('AZURE_STORAGE_ALLOW_CONTAINER_CREATE');\r\n      const baseURL = getEnv('AZURE_STORAGE_ACCOUNT_BASEURL');\r\n\r\n      return azureStorage({\r\n        connectionString,\r\n        containerName,\r\n        allowContainerCreate,\r\n        baseURL,\r\n        collections,\r\n      });\r\n    }\r\n    case 's3': {\r\n      const collections = getCollections(options.collections);\r\n      const bucket = getEnv('S3_STORAGE_BUCKET');\r\n      const region = getEnv('S3_STORAGE_REGION');\r\n      const accessKeyId = getEnv('S3_STORAGE_ACCESS_KEY_ID');\r\n      const secretAccessKey = getEnv('S3_STORAGE_SECRET_ACCESS_KEY');\r\n      const endpoint = getEnv('S3_STORAGE_ENDPOINT') || undefined;\r\n\r\n      return s3Storage({\r\n        bucket,\r\n        config: {\r\n          region,\r\n          credentials: {\r\n            accessKeyId,\r\n            secretAccessKey,\r\n          },\r\n          endpoint,\r\n        },\r\n        collections,\r\n      });\r\n    }\r\n    case 'gcs': {\r\n      const collections = getCollections(options.collections);\r\n      const bucket = getEnv('GCS_STORAGE_BUCKET');\r\n      const credentials = getEnvJson('GCS_STORAGE_JSON_CREDENTIALS') || undefined;\r\n\r\n      return gcsStorage({\r\n        bucket,\r\n        options: {\r\n          credentials,\r\n        },\r\n        collections,\r\n      });\r\n    }\r\n    default: {\r\n      const keys = options.collections || ['media'];\r\n      const baseDir = getEnv('FS_STORAGE_BASEDIR');\r\n      const baseURL = getEnv('FS_STORAGE_BASEURL');\r\n      const disablePayloadAccessControl = getEnvBool('FS_STORAGE_DISABLE_PAYLOAD_ACCESS_CONTROL') || undefined;\r\n      const generateFileURLEnabled = getEnvBool('FS_STORAGE_ENABLE_GENERATE_FILE_URL');\r\n      const baseUrl = getEnv('FS_STORAGE_BASEURL');\r\n\r\n      const collections: Record<string, CollectionOptions> = Object.fromEntries(\r\n        keys.map(k => [k, {\r\n          adapter: fsStorageAdapter({\r\n            baseDir,\r\n            baseURL,\r\n          }),\r\n          disablePayloadAccessControl,\r\n          generateFileURL: generateFileURLEnabled ? ({\r\n            filename,\r\n          }: {\r\n            collection: CollectionConfig;\r\n            filename: string;\r\n            prefix?: string;\r\n            size?: ImageSize;\r\n          }) => `${baseUrl}/${filename}` : undefined,\r\n        }]\r\n        )\r\n      );\r\n\r\n      return cloudStoragePlugin({\r\n        collections,\r\n      });\r\n    }\r\n  }\r\n}\r\n\r\nfunction getCollections(options: StorageOptions['collections']): Partial<Record<UploadCollectionSlug, Omit<CollectionOptions, 'adapter'> | true>> {\r\n  if (!options) {\r\n    return {\r\n      media: true,\r\n    };\r\n  }\r\n  if (typeof options === 'string') {\r\n    return {\r\n      [options]: true,\r\n    };\r\n  }\r\n  if (Array.isArray(options)) {\r\n    return Object.fromEntries(options.map(k => [k, true]));\r\n  }\r\n  return options;\r\n}\r\n\r\nfunction getEnv(key: string) {\r\n  const value = (process.env[key] || '').trim();\r\n  if (!value) {\r\n    const logger = payload.logger || console;\r\n    logger.error(`[Storage] missing env var [${key}]`);\r\n  }\r\n  return value;\r\n}\r\n\r\nfunction getEnvBool(key: string) {\r\n  return (process.env[key] || '').trim() === 'true';\r\n}\r\n\r\nfunction getEnvJson(key: string) {\r\n  const value = getEnv(key);\r\n  return JSON.parse(value);\r\n}\r\n"],"names":["cloudStoragePlugin","azureStorage","gcsStorage","s3Storage","fsStorageAdapter","payload","storage","options","sourceConfig","enabled","adapter","targetConfig","admin","dependencies","azureComponent","path","type","cgsComponent","s3Component","onInit","console","log","getStoragePlugin","collections","getCollections","connectionString","getEnv","containerName","allowContainerCreate","getEnvBool","baseURL","bucket","region","accessKeyId","secretAccessKey","endpoint","undefined","config","credentials","getEnvJson","keys","baseDir","disablePayloadAccessControl","generateFileURLEnabled","baseUrl","Object","fromEntries","map","k","generateFileURL","filename","media","Array","isArray","key","value","process","env","trim","logger","error","JSON","parse"],"mappings":"AAAA,SAASA,kBAAkB,QAAQ,mCAAmC;AAEtE,SAASC,YAAY,QAAQ,4BAA4B;AACzD,SAASC,UAAU,QAAQ,0BAA0B;AACrD,SAASC,SAAS,QAAQ,yBAAyB;AACnD,SAASC,gBAAgB,QAAQ,gDAAgD;AAEjF,OAAOC,aAAqC,UAAU;AAGtD,OAAO,MAAMC,UAAU,CAACC,UAA4D,OAAOC;QACzF,IAAID,QAAQE,OAAO,KAAK,OAAO;YAC7B,OAAOD;QACT;QACAD,QAAQG,OAAO,GAAGH,QAAQG,OAAO,IAAI;QACrC,MAAMC,eAAuB;YAC3B,GAAGH,YAAY;YACfI,OAAO;gBACL,GAAGJ,aAAaI,KAAK;gBACrBC,cAAc;oBACZ,GAAGL,aAAaI,KAAK,EAAEC,YAAY;oBACnCC,gBAAgB;wBACdC,MAAM;wBACNC,MAAM;oBACR;oBACAC,cAAc;wBACZF,MAAM;wBACNC,MAAM;oBACR;oBACAE,aAAa;wBACXH,MAAM;wBACNC,MAAM;oBACR;gBACF;YACF;YACAG,QAAQ,OAAOd;gBACb,IAAI,OAAOG,aAAaW,MAAM,KAAK,YAAY;oBAC7C,MAAMX,aAAaW,MAAM,CAACd;gBAC5B;gBACAe,QAAQC,GAAG,CAAC;YACd;QACF;QACA,MAAMf,UAAUgB,iBAAiBf;QACjC,OAAO,MAAMD,QAAQK;IACvB,EAAE;AAEF,SAASW,iBAAiBf,OAAuB;IAE/C,OAAQA,QAAQG,OAAO;QACrB,KAAK;YAAS;gBACZ,MAAMa,cAAcC,eAAejB,QAAQgB,WAAW;gBACtD,MAAME,mBAAmBC,OAAO;gBAChC,MAAMC,gBAAgBD,OAAO;gBAC7B,MAAME,uBAAuBC,WAAW;gBACxC,MAAMC,UAAUJ,OAAO;gBAEvB,OAAOzB,aAAa;oBAClBwB;oBACAE;oBACAC;oBACAE;oBACAP;gBACF;YACF;QACA,KAAK;YAAM;gBACT,MAAMA,cAAcC,eAAejB,QAAQgB,WAAW;gBACtD,MAAMQ,SAASL,OAAO;gBACtB,MAAMM,SAASN,OAAO;gBACtB,MAAMO,cAAcP,OAAO;gBAC3B,MAAMQ,kBAAkBR,OAAO;gBAC/B,MAAMS,WAAWT,OAAO,0BAA0BU;gBAElD,OAAOjC,UAAU;oBACf4B;oBACAM,QAAQ;wBACNL;wBACAM,aAAa;4BACXL;4BACAC;wBACF;wBACAC;oBACF;oBACAZ;gBACF;YACF;QACA,KAAK;YAAO;gBACV,MAAMA,cAAcC,eAAejB,QAAQgB,WAAW;gBACtD,MAAMQ,SAASL,OAAO;gBACtB,MAAMY,cAAcC,WAAW,mCAAmCH;gBAElE,OAAOlC,WAAW;oBAChB6B;oBACAxB,SAAS;wBACP+B;oBACF;oBACAf;gBACF;YACF;QACA;YAAS;gBACP,MAAMiB,OAAOjC,QAAQgB,WAAW,IAAI;oBAAC;iBAAQ;gBAC7C,MAAMkB,UAAUf,OAAO;gBACvB,MAAMI,UAAUJ,OAAO;gBACvB,MAAMgB,8BAA8Bb,WAAW,gDAAgDO;gBAC/F,MAAMO,yBAAyBd,WAAW;gBAC1C,MAAMe,UAAUlB,OAAO;gBAEvB,MAAMH,cAAiDsB,OAAOC,WAAW,CACvEN,KAAKO,GAAG,CAACC,CAAAA,IAAK;wBAACA;wBAAG;4BAChBtC,SAASN,iBAAiB;gCACxBqC;gCACAX;4BACF;4BACAY;4BACAO,iBAAiBN,yBAAyB,CAAC,EACzCO,QAAQ,EAMT,GAAK,CAAC,EAAEN,QAAQ,CAAC,EAAEM,SAAS,CAAC,GAAGd;wBACnC;qBAAE;gBAIJ,OAAOpC,mBAAmB;oBACxBuB;gBACF;YACF;IACF;AACF;AAEA,SAASC,eAAejB,OAAsC;IAC5D,IAAI,CAACA,SAAS;QACZ,OAAO;YACL4C,OAAO;QACT;IACF;IACA,IAAI,OAAO5C,YAAY,UAAU;QAC/B,OAAO;YACL,CAACA,QAAQ,EAAE;QACb;IACF;IACA,IAAI6C,MAAMC,OAAO,CAAC9C,UAAU;QAC1B,OAAOsC,OAAOC,WAAW,CAACvC,QAAQwC,GAAG,CAACC,CAAAA,IAAK;gBAACA;gBAAG;aAAK;IACtD;IACA,OAAOzC;AACT;AAEA,SAASmB,OAAO4B,GAAW;IACzB,MAAMC,QAAQ,AAACC,CAAAA,QAAQC,GAAG,CAACH,IAAI,IAAI,EAAC,EAAGI,IAAI;IAC3C,IAAI,CAACH,OAAO;QACV,MAAMI,SAAStD,QAAQsD,MAAM,IAAIvC;QACjCuC,OAAOC,KAAK,CAAC,CAAC,2BAA2B,EAAEN,IAAI,CAAC,CAAC;IACnD;IACA,OAAOC;AACT;AAEA,SAAS1B,WAAWyB,GAAW;IAC7B,OAAO,AAACE,CAAAA,QAAQC,GAAG,CAACH,IAAI,IAAI,EAAC,EAAGI,IAAI,OAAO;AAC7C;AAEA,SAASnB,WAAWe,GAAW;IAC7B,MAAMC,QAAQ7B,OAAO4B;IACrB,OAAOO,KAAKC,KAAK,CAACP;AACpB"}