@payloadcms/plugin-cloud-storage 1.0.14 → 1.0.15

package/dist/utilities/getIncomingFiles.js

@@ -1,38 +1,38 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getIncomingFiles = void 0;
-function getIncomingFiles(_a) {
-    var _b;
-    var req = _a.req, data = _a.data;
-    var file = (_b = req.files) === null || _b === void 0 ? void 0 : _b.file;
-    var files = [];
-    if (file && data.filename && data.mimeType) {
-        var mainFile = {
-            filename: data.filename,
-            mimeType: data.mimeType,
-            buffer: file.data,
-            tempFilePath: file.tempFilePath,
-            filesize: file.size,
-        };
-        files = [mainFile];
-        if (data === null || data === void 0 ? void 0 : data.sizes) {
-            Object.entries(data.sizes).forEach(function (_a) {
-                var _b;
-                var key = _a[0], resizedFileData = _a[1];
-                if (((_b = req.payloadUploadSizes) === null || _b === void 0 ? void 0 : _b[key]) && data.mimeType) {
-                    files = files.concat([
-                        {
-                            filename: "".concat(resizedFileData.filename),
-                            mimeType: data.mimeType,
-                            buffer: req.payloadUploadSizes[key],
-                            filesize: req.payloadUploadSizes[key].length,
-                        },
-                    ]);
-                }
-            });
-        }
-    }
-    return files;
-}
-exports.getIncomingFiles = getIncomingFiles;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getIncomingFiles = void 0;
+function getIncomingFiles(_a) {
+    var _b;
+    var req = _a.req, data = _a.data;
+    var file = (_b = req.files) === null || _b === void 0 ? void 0 : _b.file;
+    var files = [];
+    if (file && data.filename && data.mimeType) {
+        var mainFile = {
+            filename: data.filename,
+            mimeType: data.mimeType,
+            buffer: file.data,
+            tempFilePath: file.tempFilePath,
+            filesize: file.size,
+        };
+        files = [mainFile];
+        if (data === null || data === void 0 ? void 0 : data.sizes) {
+            Object.entries(data.sizes).forEach(function (_a) {
+                var _b;
+                var key = _a[0], resizedFileData = _a[1];
+                if (((_b = req.payloadUploadSizes) === null || _b === void 0 ? void 0 : _b[key]) && data.mimeType) {
+                    files = files.concat([
+                        {
+                            filename: "".concat(resizedFileData.filename),
+                            mimeType: data.mimeType,
+                            buffer: req.payloadUploadSizes[key],
+                            filesize: req.payloadUploadSizes[key].length,
+                        },
+                    ]);
+                }
+            });
+        }
+    }
+    return files;
+}
+exports.getIncomingFiles = getIncomingFiles;
 //# sourceMappingURL=getIncomingFiles.js.map

package/dist/utilities/getRangeFromHeader.d.ts

@@ -0,0 +1,6 @@
+import type { BlockBlobClient } from '@azure/storage-blob';
+declare const getRangeFromHeader: (blockBlobClient: BlockBlobClient, rangeHeader?: string) => Promise<{
+    start: number;
+    end: number | undefined;
+}>;
+export default getRangeFromHeader;

package/dist/utilities/getRangeFromHeader.js

@@ -0,0 +1,67 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var range_parser_1 = __importDefault(require("range-parser"));
+var getRangeFromHeader = function (blockBlobClient, rangeHeader) { return __awaiter(void 0, void 0, void 0, function () {
+    var fullRange, size, range;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                fullRange = { start: 0, end: undefined };
+                if (!rangeHeader) {
+                    return [2 /*return*/, fullRange];
+                }
+                return [4 /*yield*/, blockBlobClient.getProperties().then(function (props) { return props.contentLength; })];
+            case 1:
+                size = _a.sent();
+                if (size === undefined) {
+                    return [2 /*return*/, fullRange];
+                }
+                range = (0, range_parser_1.default)(size, rangeHeader);
+                if (range === -1 || range === -2 || range.type !== 'bytes' || range.length !== 1) {
+                    return [2 /*return*/, fullRange];
+                }
+                return [2 /*return*/, range[0]];
+        }
+    });
+}); };
+exports.default = getRangeFromHeader;
+//# sourceMappingURL=getRangeFromHeader.js.map

package/dist/utilities/getRangeFromHeader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getRangeFromHeader.js","sourceRoot":"","sources":["../../src/utilities/getRangeFromHeader.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,8DAAqC;AAErC,IAAM,kBAAkB,GAAG,UACzB,eAAgC,EAChC,WAAoB;;;;;gBAEd,SAAS,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,SAAS,EAAE,CAAA;gBAE9C,IAAI,CAAC,WAAW,EAAE;oBAChB,sBAAO,SAAS,EAAA;iBACjB;gBAEY,qBAAM,eAAe,CAAC,aAAa,EAAE,CAAC,IAAI,CAAC,UAAA,KAAK,IAAI,OAAA,KAAK,CAAC,aAAa,EAAnB,CAAmB,CAAC,EAAA;;gBAA/E,IAAI,GAAG,SAAwE;gBACrF,IAAI,IAAI,KAAK,SAAS,EAAE;oBACtB,sBAAO,SAAS,EAAA;iBACjB;gBAEK,KAAK,GAAG,IAAA,sBAAU,EAAC,IAAI,EAAE,WAAW,CAAC,CAAA;gBAC3C,IAAI,KAAK,KAAK,CAAC,CAAC,IAAI,KAAK,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;oBAChF,sBAAO,SAAS,EAAA;iBACjB;gBAED,sBAAO,KAAK,CAAC,CAAC,CAAC,EAAA;;;KAChB,CAAA;AAED,kBAAe,kBAAkB,CAAA"}

package/dist/webpack.d.ts

@@ -1,9 +1,9 @@
-import type { Config } from 'payload/config';
-import type { Configuration as WebpackConfig } from 'webpack';
-import type { PluginOptions } from './types';
-interface Args {
-    config: Config;
-    options: PluginOptions;
-}
-export declare const extendWebpackConfig: ({ config, options }: Args) => (webpackConfig: WebpackConfig) => WebpackConfig;
-export {};
+import type { Config } from 'payload/config';
+import type { Configuration as WebpackConfig } from 'webpack';
+import type { PluginOptions } from './types';
+interface Args {
+    config: Config;
+    options: PluginOptions;
+}
+export declare const extendWebpackConfig: ({ config, options }: Args) => (webpackConfig: WebpackConfig) => WebpackConfig;
+export {};

package/dist/webpack.js

@@ -1,40 +1,40 @@
-"use strict";
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.extendWebpackConfig = void 0;
-var extendWebpackConfig = function (_a) {
-    var config = _a.config, options = _a.options;
-    return function (webpackConfig) {
-        var _a, _b;
-        var existingWebpackConfig = typeof ((_a = config.admin) === null || _a === void 0 ? void 0 : _a.webpack) === 'function'
-            ? config.admin.webpack(webpackConfig)
-            : webpackConfig;
-        var newConfig = __assign(__assign({}, existingWebpackConfig), { resolve: __assign(__assign({}, (existingWebpackConfig.resolve || {})), { alias: __assign({}, (((_b = existingWebpackConfig.resolve) === null || _b === void 0 ? void 0 : _b.alias) ? existingWebpackConfig.resolve.alias : {})) }) });
-        return Object.entries(options.collections).reduce(function (resultingWebpackConfig, _a) {
-            var _b;
-            var slug = _a[0], collectionOptions = _a[1];
-            var matchedCollection = (_b = config.collections) === null || _b === void 0 ? void 0 : _b.find(function (coll) { return coll.slug === slug; });
-            if (matchedCollection && typeof collectionOptions.adapter === 'function') {
-                var adapter = collectionOptions.adapter({
-                    collection: matchedCollection,
-                });
-                if (adapter.webpack) {
-                    return adapter.webpack(resultingWebpackConfig);
-                }
-            }
-            return resultingWebpackConfig;
-        }, newConfig);
-    };
-};
-exports.extendWebpackConfig = extendWebpackConfig;
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extendWebpackConfig = void 0;
+var extendWebpackConfig = function (_a) {
+    var config = _a.config, options = _a.options;
+    return function (webpackConfig) {
+        var _a, _b;
+        var existingWebpackConfig = typeof ((_a = config.admin) === null || _a === void 0 ? void 0 : _a.webpack) === 'function'
+            ? config.admin.webpack(webpackConfig)
+            : webpackConfig;
+        var newConfig = __assign(__assign({}, existingWebpackConfig), { resolve: __assign(__assign({}, (existingWebpackConfig.resolve || {})), { alias: __assign({}, (((_b = existingWebpackConfig.resolve) === null || _b === void 0 ? void 0 : _b.alias) ? existingWebpackConfig.resolve.alias : {})) }) });
+        return Object.entries(options.collections).reduce(function (resultingWebpackConfig, _a) {
+            var _b;
+            var slug = _a[0], collectionOptions = _a[1];
+            var matchedCollection = (_b = config.collections) === null || _b === void 0 ? void 0 : _b.find(function (coll) { return coll.slug === slug; });
+            if (matchedCollection && typeof collectionOptions.adapter === 'function') {
+                var adapter = collectionOptions.adapter({
+                    collection: matchedCollection,
+                });
+                if (adapter.webpack) {
+                    return adapter.webpack(resultingWebpackConfig);
+                }
+            }
+            return resultingWebpackConfig;
+        }, newConfig);
+    };
+};
+exports.extendWebpackConfig = extendWebpackConfig;
 //# sourceMappingURL=webpack.js.map

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',
+  },
+}