@payloadcms/plugin-cloud-storage 1.0.16 → 1.0.17-beta.0

package/dev/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "lib": [
+      "dom",
+      "dom.iterable",
+      "esnext"
+    ],
+    "strict": false,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "outDir": "./dist",
+    "rootDir": "../",
+    "jsx": "react",
+    "sourceMap": true
+  },
+  "ts-node": {
+    "transpileOnly": true
+  }
+}

package/dist/plugin.d.ts

@@ -1,3 +1,3 @@
 import type { Config } from 'payload/config';
 import type { PluginOptions } from './types';
-export declare const cloudStorage: (pluginOptions: PluginOptions) => (config: Config) => Config;
+export declare const cloudStorage: (pluginOptions: PluginOptions) => (incomingConfig: Config) => Config;

package/dist/plugin.js

@@ -68,11 +68,17 @@ var getFields_1 = require("./fields/getFields");
 // 1. handleUpload, 2. handleDelete, 3. generateURL, 4. staticHandler
 // Optionally, the adapter can specify any Webpack config overrides if they are necessary.
 var cloudStorage = function (pluginOptions) {
-    return function (config) {
-        var allCollectionOptions = pluginOptions.collections;
-        var webpack = (0, webpack_1.extendWebpackConfig)({ options: pluginOptions, config: config });
+    return function (incomingConfig) {
+        var allCollectionOptions = pluginOptions.collections, enabled = pluginOptions.enabled;
+        var config = __assign({}, incomingConfig);
+        var webpack = (0, webpack_1.extendWebpackConfig)({ options: pluginOptions, config: incomingConfig });
+        config.admin = __assign(__assign({}, (config.admin || {})), { webpack: webpack });
+        // Return early if disabled. Only webpack config mods are applied.
+        if (enabled === false) {
+            return config;
+        }
         var initFunctions = [];
-        return __assign(__assign({}, config), { admin: __assign(__assign({}, (config.admin || {})), { webpack: webpack }), collections: (config.collections || []).map(function (existingCollection) {
+        return __assign(__assign({}, config), { collections: (config.collections || []).map(function (existingCollection) {
                 var _a, _b;
                 var options = allCollectionOptions[existingCollection.slug];
                 if (options === null || options === void 0 ? void 0 : options.adapter) {

package/dist/plugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,qCAA+C;AAE/C,qDAA0D;AAC1D,mDAAwD;AACxD,gDAA8C;AAE9C,4EAA4E;AAC5E,4DAA4D;AAE5D,4FAA4F;AAC5F,iFAAiF;AACjF,qEAAqE;AAErE,0FAA0F;AAEnF,IAAM,YAAY,GACvB,UAAC,aAA4B;IAC7B,OAAA,UAAC,MAAc;QACL,IAAa,oBAAoB,GAAK,aAAa,YAAlB,CAAkB;QAE3D,IAAM,OAAO,GAAG,IAAA,6BAAmB,EAAC,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,QAAA,EAAE,CAAC,CAAA;QAEvE,IAAM,aAAa,GAAsB,EAAE,CAAA;QAE3C,6BACK,MAAM,KACT,KAAK,wBACA,CAAC,MAAM,CAAC,KAAK,IAAI,EAAE,CAAC,KACvB,OAAO,SAAA,KAET,WAAW,EAAE,CAAC,MAAM,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,UAAA,kBAAkB;;gBAC5D,IAAM,OAAO,GAAG,oBAAoB,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAA;gBAE7D,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,EAAE;oBACpB,IAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;wBAC9B,UAAU,EAAE,kBAAkB;wBAC9B,MAAM,EAAE,OAAO,CAAC,MAAM;qBACvB,CAAC,CAAA;oBAEF,IAAI,OAAO,CAAC,MAAM;wBAAE,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;oBAEtD,IAAM,MAAM,GAAG,IAAA,qBAAS,EAAC;wBACvB,UAAU,EAAE,kBAAkB;wBAC9B,2BAA2B,EAAE,OAAO,CAAC,2BAA2B;wBAChE,eAAe,EAAE,OAAO,CAAC,eAAe;wBACxC,MAAM,EAAE,OAAO,CAAC,MAAM;wBACtB,OAAO,SAAA;qBACR,CAAC,CAAA;oBAEF,IAAM,QAAQ,qBACT,CAAC,OAAO,kBAAkB,CAAC,MAAM,KAAK,QAAQ;wBACjD,KAAK,CAAC,OAAO,CAAC,kBAAkB,CAAC,MAAM,CAAC,QAAQ,CAAC;wBAC/C,CAAC,CAAC,kBAAkB,CAAC,MAAM,CAAC,QAAQ;wBACpC,CAAC,CAAC,EAAE,CAAC,OACR,CAAA;oBAED,IAAI,CAAC,OAAO,CAAC,2BAA2B,EAAE;wBACxC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAA;qBACrC;oBAED,6BACK,kBAAkB,KACrB,MAAM,wBACD,CAAC,OAAO,kBAAkB,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,KACnF,QAAQ,UAAA,EACR,mBAAmB,EACjB,OAAO,OAAO,CAAC,mBAAmB,KAAK,SAAS;gCAC9C,CAAC,CAAC,OAAO,CAAC,mBAAmB;gCAC7B,CAAC,CAAC,IAAI,KAEZ,KAAK,wBACA,CAAC,kBAAkB,CAAC,KAAK,IAAI,EAAE,CAAC,KACnC,YAAY,kCACP,CAAC,CAAA,MAAA,kBAAkB,CAAC,KAAK,0CAAE,YAAY,KAAI,EAAE,CAAC;gCACjD,IAAA,kCAAmB,EAAC,EAAE,OAAO,SAAA,EAAE,UAAU,EAAE,kBAAkB,EAAE,CAAC;uCAElE,WAAW,kCACN,CAAC,CAAA,MAAA,kBAAkB,CAAC,KAAK,0CAAE,WAAW,KAAI,EAAE,CAAC;gCAChD,IAAA,gCAAkB,EAAC,EAAE,OAAO,SAAA,EAAE,UAAU,EAAE,kBAAkB,EAAE,CAAC;0CAGnE,MAAM,QAAA,IACP;iBACF;gBAED,OAAO,kBAAkB,CAAA;YAC3B,CAAC,CAAC,EACF,MAAM,EAAE,UAAM,OAAO;;;;4BACnB,aAAa,CAAC,OAAO,CAAC,UAAA,EAAE,IAAI,OAAA,EAAE,EAAE,EAAJ,CAAI,CAAC,CAAA;iCAC7B,MAAM,CAAC,MAAM,EAAb,wBAAa;4BAAE,qBAAM,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,EAAA;;4BAA5B,SAA4B,CAAA;;;;;iBAChD,IACF;IACH,CAAC;AA3ED,CA2EC,CAAA;AA7EU,QAAA,YAAY,gBA6EtB"}
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,qCAA+C;AAE/C,qDAA0D;AAC1D,mDAAwD;AACxD,gDAA8C;AAE9C,4EAA4E;AAC5E,4DAA4D;AAE5D,4FAA4F;AAC5F,iFAAiF;AACjF,qEAAqE;AAErE,0FAA0F;AAEnF,IAAM,YAAY,GACvB,UAAC,aAA4B;IAC7B,OAAA,UAAC,cAAsB;QACb,IAAa,oBAAoB,GAAc,aAAa,YAA3B,EAAE,OAAO,GAAK,aAAa,QAAlB,CAAkB;QACpE,IAAM,MAAM,gBAAQ,cAAc,CAAE,CAAA;QAEpC,IAAM,OAAO,GAAG,IAAA,6BAAmB,EAAC,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC,CAAA;QAEvF,MAAM,CAAC,KAAK,yBACP,CAAC,MAAM,CAAC,KAAK,IAAI,EAAE,CAAC,KACvB,OAAO,SAAA,GACR,CAAA;QAED,kEAAkE;QAClE,IAAI,OAAO,KAAK,KAAK,EAAE;YACrB,OAAO,MAAM,CAAA;SACd;QAED,IAAM,aAAa,GAAsB,EAAE,CAAA;QAE3C,6BACK,MAAM,KACT,WAAW,EAAE,CAAC,MAAM,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,UAAA,kBAAkB;;gBAC5D,IAAM,OAAO,GAAG,oBAAoB,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAA;gBAE7D,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,EAAE;oBACpB,IAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;wBAC9B,UAAU,EAAE,kBAAkB;wBAC9B,MAAM,EAAE,OAAO,CAAC,MAAM;qBACvB,CAAC,CAAA;oBAEF,IAAI,OAAO,CAAC,MAAM;wBAAE,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;oBAEtD,IAAM,MAAM,GAAG,IAAA,qBAAS,EAAC;wBACvB,UAAU,EAAE,kBAAkB;wBAC9B,2BAA2B,EAAE,OAAO,CAAC,2BAA2B;wBAChE,eAAe,EAAE,OAAO,CAAC,eAAe;wBACxC,MAAM,EAAE,OAAO,CAAC,MAAM;wBACtB,OAAO,SAAA;qBACR,CAAC,CAAA;oBAEF,IAAM,QAAQ,qBACT,CAAC,OAAO,kBAAkB,CAAC,MAAM,KAAK,QAAQ;wBACjD,KAAK,CAAC,OAAO,CAAC,kBAAkB,CAAC,MAAM,CAAC,QAAQ,CAAC;wBAC/C,CAAC,CAAC,kBAAkB,CAAC,MAAM,CAAC,QAAQ;wBACpC,CAAC,CAAC,EAAE,CAAC,OACR,CAAA;oBAED,IAAI,CAAC,OAAO,CAAC,2BAA2B,EAAE;wBACxC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAA;qBACrC;oBAED,6BACK,kBAAkB,KACrB,MAAM,wBACD,CAAC,OAAO,kBAAkB,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,KACnF,QAAQ,UAAA,EACR,mBAAmB,EACjB,OAAO,OAAO,CAAC,mBAAmB,KAAK,SAAS;gCAC9C,CAAC,CAAC,OAAO,CAAC,mBAAmB;gCAC7B,CAAC,CAAC,IAAI,KAEZ,KAAK,wBACA,CAAC,kBAAkB,CAAC,KAAK,IAAI,EAAE,CAAC,KACnC,YAAY,kCACP,CAAC,CAAA,MAAA,kBAAkB,CAAC,KAAK,0CAAE,YAAY,KAAI,EAAE,CAAC;gCACjD,IAAA,kCAAmB,EAAC,EAAE,OAAO,SAAA,EAAE,UAAU,EAAE,kBAAkB,EAAE,CAAC;uCAElE,WAAW,kCACN,CAAC,CAAA,MAAA,kBAAkB,CAAC,KAAK,0CAAE,WAAW,KAAI,EAAE,CAAC;gCAChD,IAAA,gCAAkB,EAAC,EAAE,OAAO,SAAA,EAAE,UAAU,EAAE,kBAAkB,EAAE,CAAC;0CAGnE,MAAM,QAAA,IACP;iBACF;gBAED,OAAO,kBAAkB,CAAA;YAC3B,CAAC,CAAC,EACF,MAAM,EAAE,UAAM,OAAO;;;;4BACnB,aAAa,CAAC,OAAO,CAAC,UAAA,EAAE,IAAI,OAAA,EAAE,EAAE,EAAJ,CAAI,CAAC,CAAA;iCAC7B,MAAM,CAAC,MAAM,EAAb,wBAAa;4BAAE,qBAAM,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,EAAA;;4BAA5B,SAA4B,CAAA;;;;;iBAChD,IACF;IACH,CAAC;AAlFD,CAkFC,CAAA;AApFU,QAAA,YAAY,gBAoFtB"}

package/dist/types.d.ts

@@ -58,5 +58,11 @@ export interface CollectionOptions {
     adapter: Adapter | null;
 }
 export interface PluginOptions {
+    /**
+     * Whether or not to enable the plugin
+     *
+     * Default: true
+     */
+    enabled?: boolean;
     collections: Record<string, CollectionOptions>;
 }

package/docs/local-dev.md

@@ -0,0 +1,47 @@
+# Developing with this plugin locally
+
+This repository includes a local development environment for local testing and development of this plugin. To run the local sandbox, follow the instructions below.
+
+1. Make sure you have Node and a MongoDB to work with
+1. Clone the repo
+1. `yarn` in both the root folder of the repo, and the `./dev` folder
+1. `cd` into `./dev` and run `cp .env.example .env` to create an `.env` file
+1. Open your newly created `./dev/.env` file and _completely_ fill out each property
+
+### Azure Adapter Development
+
+This repository comes with a Docker emulator for Azure Blob Storage.
+
+If you would like to test locally with an emulated blob storage container, you can `cd` into `./src/adapters/azure/emulator` and then run `docker-compose up -d`.
+
+The default `./dev/.env.example` file comes pre-loaded with correct `env` variables that correspond to the Azure Docker emulator.
+
+Otherwise, if you are not using the emulator, make sure your environment variables within `./dev/.env` are configured for your Azure connection.
+
+Finally, to start the Payload dev server with the Azure adapter, run `yarn dev:azure` and then open `http://localhost:3000/admin` in your browser.
+
+### S3 Adapter Development
+
+This repository also includes a Docker LocalStack emulator for S3. It requires a few more steps to get up and running.
+
+To use the S3 emulator, use the following steps:
+
+1. Make sure you have `awscli` installed. On Mac, run `brew install awscli` to get started.
+1. Make sure you have an AWS profile created. LocalStack does not verify credentials, so you can create a profile with dummy credentials. However, your `region` will need to match. To create a dummy profile for LocalStack, type `aws configure --profile localstack`. Use the access key and secret from the `./dev/.env.example` and use region `us-east-1`.
+1. Now you can start the Docker container via moving to the `./src/adapters/s3/emulator` folder and running `docker-compose up -d`.
+1. Once the Docker container is running, you can create a new bucket with the following command: `aws --endpoint-url=http://localhost:4566 s3 mb s3://payload-bucket`. Note that our bucket is called `payload-bucket`.
+1. Finally, attach an ACL to the bucket so it is readable: `aws --endpoint-url=http://localhost:4566 s3api put-bucket-acl --bucket payload-bucket --acl public-read`
+
+Finally, you can run `yarn dev:s3` and then open `http://localhost:3000/admin` in your browser.
+
+### Google Cloud Storage(GCS) Adapter Development
+
+This repository comes with a Docker emulator for Google Cloud Storage.
+
+If you would like to test locally with an emulated GCS container, you can `cd` into `./src/adapters/gcs/emulator` and then run `docker-compose up -d`.
+
+The default `./dev/.env.example` file comes pre-loaded with correct `env` variables that correspond to the GCS Docker emulator.
+
+Otherwise, if you are not using the emulator, make sure your environment variables within `./dev/.env` are configured for your Google connection.
+
+Finally, to start the Payload dev server with the GCS adapter, run `yarn dev:gcs` and then open `http://localhost:3000/admin` in your browser.

package/eslint-config/index.js

@@ -0,0 +1,15 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  extends: [
+    'airbnb-base',
+    require.resolve('./rules/style.js'),
+    require.resolve('./rules/import.js'),
+    require.resolve('./rules/typescript.js'),
+    require.resolve('./rules/prettier.js'),
+  ],
+  env: {
+    es6: true,
+    browser: true,
+    node: true,
+  },
+}

package/eslint-config/rules/import.js

@@ -0,0 +1,38 @@
+module.exports = {
+  env: {
+    es6: true,
+  },
+  extends: ['plugin:import/errors', 'plugin:import/warnings', 'plugin:import/typescript'],
+  plugins: ['import'],
+  settings: {
+    'import/parsers': {
+      '@typescript-eslint/parser': ['.ts'],
+    },
+  },
+  rules: {
+    /**
+     * https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-unresolved.md
+     */
+    'import/no-unresolved': ['error', { commonjs: true, caseSensitive: true }],
+    'import/no-default-export': 'off',
+    'import/prefer-default-export': 'off',
+    'import/extensions': [
+      'error',
+      'ignorePackages',
+      {
+        ts: 'never',
+        tsx: 'never',
+        js: 'never',
+        jsx: 'never',
+      },
+    ],
+    'import/no-extraneous-dependencies': 'off',
+    /**
+     * https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/named.md#when-not-to-use-it
+     */
+    'import/named': 'error',
+    'import/no-relative-packages': 'warn',
+    'import/no-import-module-exports': 'warn',
+    'import/no-cycle': 'warn',
+  },
+}

package/eslint-config/rules/prettier.js

@@ -0,0 +1,7 @@
+module.exports = {
+  plugins: ['prettier'],
+  extends: ['plugin:prettier/recommended'],
+  rules: {
+    'prettier/prettier': 'error',
+  },
+}

package/eslint-config/rules/style.js

@@ -0,0 +1,21 @@
+module.exports = {
+  rules: {
+    'prefer-named-exports': 'off',
+
+  'prefer-destructuring': 'off',
+    // 'prefer-destructuring': ['warn', { object: true, array: true }],
+    // ensure all object/arrays end with a comma
+    'comma-dangle': ['error', 'always-multiline'],
+    'class-methods-use-this': 'off',
+    // consistent new lines
+    'function-paren-newline': ['error', 'consistent'],
+    'eol-last': ['error', 'always'],
+    // allow restricted syntax like for...of loops
+    'no-restricted-syntax': 'off',
+    'no-await-in-loop': 'off',
+    'no-console': 'error',
+    // 'no-floating-promises': true,
+    // do not allow process.env access in files
+    'no-process-env': 'warn',
+  },
+}