@payloadcms/plugin-cloud-storage 1.0.15 → 1.0.16

package/.eslintrc.js

@@ -1,14 +1,14 @@
-module.exports = {
-  root: true,
-  extends: ['./eslint-config'],
-  overrides: [
-    // Temporary overrides. Re-enable once platform is more mature
-    {
-      files: ['dev/**/*.ts'],
-      rules: {
-        'import/no-relative-packages': 'off',
-        'no-process-env': 'off',
-      },
-    },
-  ],
-}
+module.exports = {
+  root: true,
+  extends: ['./eslint-config'],
+  overrides: [
+    // Temporary overrides. Re-enable once platform is more mature
+    {
+      files: ['dev/**/*.ts'],
+      rules: {
+        'import/no-relative-packages': 'off',
+        'no-process-env': 'off',
+      },
+    },
+  ],
+}

package/LICENSE.md

@@ -1,22 +1,22 @@
-(The MIT License)
-
-Copyright (c) 2018-20223 Payload CMS, INC <info@payloadcms.com>
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+(The MIT License)
+
+Copyright (c) 2018-20223 Payload CMS, INC <info@payloadcms.com>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,178 +1,178 @@
-# Payload Cloud Storage Plugin
-
-This repository contains the officially supported Payload Cloud Storage plugin. It extends Payload to allow you to store all uploaded media in third-party permanent storage.
-
-#### Requirements
-
-- Payload version `1.0.19` or higher is required
-
-## Installation
-
-`yarn add @payloadcms/plugin-cloud-storage` or `npm install @payloadcms/plugin-cloud-storage`
-
-## Usage
-
-Add this package into your dependencies executing this code in your command line:
-
-`yarn add @payloadcms/plugin-cloud-storage`
-
-Now install this plugin within your Payload as follows:
-
-```ts
-import { buildConfig } from 'payload/config';
-import path from 'path';
-import { cloudStorage } from '@payloadcms/plugin-cloud-storage';
-
-export default buildConfig({
-  plugins: [
-    cloudStorage({
-      collections: {
-        'my-collection-slug': {
-          adapter: theAdapterToUse, // see docs for the adapter you want to use
-        },
-      },
-    }),
-  ],
-  // The rest of your config goes here
-});
-```
-
-## Features
-
-**Adapter-based Implementation**
-
-This plugin supports the following adapters:
-
-- [Azure Blob Storage](#azure-blob-storage-adapter)
-- [AWS S3-style Storage](#s3-adapter)
-- [Google Cloud Storage](#gcs-adapter)
-
-However, you can create your own adapter for any third-party service you would like to use.
-
-All adapters are implemented `dev` directory's [Payload Config](https://github.com/payloadcms/plugin-cloud-storage/blob/master/dev/src/payload.config.ts). See this file for examples.
-
-## Plugin options
-
-This plugin is configurable to work across many different Payload collections. A `*` denotes that the property is required.
-
-| Option                  | Type                                    | Description |
-|-------------------------|-----------------------------------------| ----------- |
-| `collections` *         | Record<string, [CollectionOptions](https://github.com/payloadcms/plugin-cloud-storage/blob/c4a492a62abc2f21b4cd6a7c97778acd8e831212/src/types.ts#L48)> | Object with keys set to the slug of collections you want to enable the plugin for, and values set to collection-specific options. |
-
-**Collection-specific options:**
-
-| Option                        | Type                                                                                               | Description                                                                        |
-|-------------------------------|----------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------|
-| `adapter` *                   | [Adapter](https://github.com/payloadcms/plugin-cloud-storage/blob/master/src/types.ts#L51)         | Pass in the adapter that you'd like to use for this collection. You can also set this field to `null` for local development if you'd like to bypass cloud storage in certain scenarios and use local storage. |
-| `disableLocalStorage`         | `boolean`                                                                                          | Choose to disable local storage on this collection. Defaults to `true`. |
-| `disablePayloadAccessControl` | `true`                                                                                             | Set to `true` to disable Payload's access control. [More](#payload-access-control) |
-| `prefix`                      | `string`                                                                                           | Set to `media/images` to upload files inside `media/images` folder in the bucket. |
-| `generateFileURL`             | [GenerateFileURL](https://github.com/payloadcms/plugin-cloud-storage/blob/master/src/types.ts#L53) | Override the generated file URL with one that you create. |
-
-### Azure Blob Storage Adapter
-
-To use the Azure Blob Storage adapter, you need to have `@azure/storage-blob` installed in your project dependencies. To do so, run `yarn add @azure/storage-blob`.
-
-From there, create the adapter, passing in all of its required properties:
-
-```js
-import { azureBlobStorageAdapter } from '@payloadcms/plugin-cloud-storage/azure';
-
-const adapter = azureBlobStorageAdapter({
-  connectionString: process.env.AZURE_STORAGE_CONNECTION_STRING,
-  containerName: process.env.AZURE_STORAGE_CONTAINER_NAME,
-  allowContainerCreate: process.env.AZURE_STORAGE_ALLOW_CONTAINER_CREATE === 'true',
-  baseURL: process.env.AZURE_STORAGE_ACCOUNT_BASEURL,
-})
-
-// Now you can pass this adapter to the plugin
-```
-
-### S3 Adapter
-
-To use the S3 adapter, some peer dependencies need to be installed:
-
-`yarn add @aws-sdk/client-s3 @aws-sdk/lib-storage`.
-
-From there, create the adapter, passing in all of its required properties:
-
-```js
-import { s3Adapter } from '@payloadcms/plugin-cloud-storage/s3';
-
-const adapter = s3Adapter({
-  config: {
-    credentials: {
-      accessKeyId: process.env.S3_ACCESS_KEY_ID,
-      secretAccessKey: process.env.S3_SECRET_ACCESS_KEY,
-    }
-    // ... Other S3 configuration
-  },
-  bucket: process.env.S3_BUCKET,
-})
-
-// Now you can pass this adapter to the plugin
-```
-
-Other S3 Client configuration is documented [here](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-s3/interfaces/s3clientconfig.html).
-
-Any upload over 50MB will automatically be uploaded using S3's multi-part upload.
-
-#### Other S3-Compatible Storage
-
-If you're running an S3-compatible object storage such as MinIO or Digital Ocean Spaces, you'll have to set the `endpoint` appropriately for the provider.
-
-```js
-import { s3Adapter } from '@payloadcms/plugin-cloud-storage/s3';
-
-const adapter = s3Adapter({
-  config: {
-    endpoint: process.env.S3_ENDPOINT, // Configure for your provider
-    // ...
-  },
-  // ...
-})
-```
-
-### GCS Adapter
-
-To use the GCS adapter, you need to have `@google-cloud/storage` installed in your project dependencies. To do so, run `yarn add @google-cloud/storage`.
-
-From there, create the adapter, passing in all of its required properties:
-
-```js
-import { gcsAdapter } from '@payloadcms/plugin-cloud-storage/gcs';
-
-const adapter = gcsAdapter({
-  options: {
-    // you can choose any method for authentication, and authorization which is being provided by `@google-cloud/storage`
-    keyFilename: './gcs-credentials.json',
-    //OR
-    credentials: JSON.parse(process.env.GCS_CREDENTIALS) // this env variable will have stringify version of your credentials.json file
-  },
-  bucket: process.env.GCS_BUCKET,
-})
-
-// Now you can pass this adapter to the plugin
-```
-
-### Payload Access Control
-
-Payload ships with access control that runs _even on statically served files_. The same `read` access control property on your `upload`-enabled collections is used, and it allows you to restrict who can request your uploaded files.
-
-To preserve this feature, by default, this plugin _keeps all file URLs exactly the same_. Your file URLs won't be updated to point directly to your cloud storage source, as in that case, Payload's access control will be completely bypassed and you would need public readability on your cloud-hosted files.
-
-Instead, all uploads will still be reached from the default `/collectionSlug/staticURL/filename` path. This plugin will "pass through" all files that are hosted on your third-party cloud service—with the added benefit of keeping your existing access control in place.
-
-If this does not apply to you (your upload collection has `read: () => true` or similar) you can disable this functionality by setting `disablePayloadAccessControl` to `true`. When this setting is in place, this plugin will update your file URLs to point directly to your cloud host.
-
-## Local development
-
-For instructions regarding how to develop with this plugin locally, [click here](https://github.com/payloadcms/plugin-cloud-storage/blob/master/docs/local-dev.md).
-
-## Questions
-
-Please contact [Payload](dev@payloadcms.com) with any questions about using this plugin.
-
-## Credit
-
-This plugin was created with significant help, and code, from [Alex Bechmann](https://github.com/alexbechmann) and [Richard VanBergen](https://github.com/richardvanbergen). Thank you!!
+# Payload Cloud Storage Plugin
+
+This repository contains the officially supported Payload Cloud Storage plugin. It extends Payload to allow you to store all uploaded media in third-party permanent storage.
+
+#### Requirements
+
+- Payload version `1.0.19` or higher is required
+
+## Installation
+
+`yarn add @payloadcms/plugin-cloud-storage` or `npm install @payloadcms/plugin-cloud-storage`
+
+## Usage
+
+Add this package into your dependencies executing this code in your command line:
+
+`yarn add @payloadcms/plugin-cloud-storage`
+
+Now install this plugin within your Payload as follows:
+
+```ts
+import { buildConfig } from 'payload/config';
+import path from 'path';
+import { cloudStorage } from '@payloadcms/plugin-cloud-storage';
+
+export default buildConfig({
+  plugins: [
+    cloudStorage({
+      collections: {
+        'my-collection-slug': {
+          adapter: theAdapterToUse, // see docs for the adapter you want to use
+        },
+      },
+    }),
+  ],
+  // The rest of your config goes here
+});
+```
+
+## Features
+
+**Adapter-based Implementation**
+
+This plugin supports the following adapters:
+
+- [Azure Blob Storage](#azure-blob-storage-adapter)
+- [AWS S3-style Storage](#s3-adapter)
+- [Google Cloud Storage](#gcs-adapter)
+
+However, you can create your own adapter for any third-party service you would like to use.
+
+All adapters are implemented `dev` directory's [Payload Config](https://github.com/payloadcms/plugin-cloud-storage/blob/master/dev/src/payload.config.ts). See this file for examples.
+
+## Plugin options
+
+This plugin is configurable to work across many different Payload collections. A `*` denotes that the property is required.
+
+| Option                  | Type                                    | Description |
+|-------------------------|-----------------------------------------| ----------- |
+| `collections` *         | Record<string, [CollectionOptions](https://github.com/payloadcms/plugin-cloud-storage/blob/c4a492a62abc2f21b4cd6a7c97778acd8e831212/src/types.ts#L48)> | Object with keys set to the slug of collections you want to enable the plugin for, and values set to collection-specific options. |
+
+**Collection-specific options:**
+
+| Option                        | Type                                                                                               | Description                                                                        |
+|-------------------------------|----------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------|
+| `adapter` *                   | [Adapter](https://github.com/payloadcms/plugin-cloud-storage/blob/master/src/types.ts#L51)         | Pass in the adapter that you'd like to use for this collection. You can also set this field to `null` for local development if you'd like to bypass cloud storage in certain scenarios and use local storage. |
+| `disableLocalStorage`         | `boolean`                                                                                          | Choose to disable local storage on this collection. Defaults to `true`. |
+| `disablePayloadAccessControl` | `true`                                                                                             | Set to `true` to disable Payload's access control. [More](#payload-access-control) |
+| `prefix`                      | `string`                                                                                           | Set to `media/images` to upload files inside `media/images` folder in the bucket. |
+| `generateFileURL`             | [GenerateFileURL](https://github.com/payloadcms/plugin-cloud-storage/blob/master/src/types.ts#L53) | Override the generated file URL with one that you create. |
+
+### Azure Blob Storage Adapter
+
+To use the Azure Blob Storage adapter, you need to have `@azure/storage-blob` installed in your project dependencies. To do so, run `yarn add @azure/storage-blob`.
+
+From there, create the adapter, passing in all of its required properties:
+
+```js
+import { azureBlobStorageAdapter } from '@payloadcms/plugin-cloud-storage/azure';
+
+const adapter = azureBlobStorageAdapter({
+  connectionString: process.env.AZURE_STORAGE_CONNECTION_STRING,
+  containerName: process.env.AZURE_STORAGE_CONTAINER_NAME,
+  allowContainerCreate: process.env.AZURE_STORAGE_ALLOW_CONTAINER_CREATE === 'true',
+  baseURL: process.env.AZURE_STORAGE_ACCOUNT_BASEURL,
+})
+
+// Now you can pass this adapter to the plugin
+```
+
+### S3 Adapter
+
+To use the S3 adapter, some peer dependencies need to be installed:
+
+`yarn add @aws-sdk/client-s3 @aws-sdk/lib-storage`.
+
+From there, create the adapter, passing in all of its required properties:
+
+```js
+import { s3Adapter } from '@payloadcms/plugin-cloud-storage/s3';
+
+const adapter = s3Adapter({
+  config: {
+    credentials: {
+      accessKeyId: process.env.S3_ACCESS_KEY_ID,
+      secretAccessKey: process.env.S3_SECRET_ACCESS_KEY,
+    }
+    // ... Other S3 configuration
+  },
+  bucket: process.env.S3_BUCKET,
+})
+
+// Now you can pass this adapter to the plugin
+```
+
+Other S3 Client configuration is documented [here](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-s3/interfaces/s3clientconfig.html).
+
+Any upload over 50MB will automatically be uploaded using S3's multi-part upload.
+
+#### Other S3-Compatible Storage
+
+If you're running an S3-compatible object storage such as MinIO or Digital Ocean Spaces, you'll have to set the `endpoint` appropriately for the provider.
+
+```js
+import { s3Adapter } from '@payloadcms/plugin-cloud-storage/s3';
+
+const adapter = s3Adapter({
+  config: {
+    endpoint: process.env.S3_ENDPOINT, // Configure for your provider
+    // ...
+  },
+  // ...
+})
+```
+
+### GCS Adapter
+
+To use the GCS adapter, you need to have `@google-cloud/storage` installed in your project dependencies. To do so, run `yarn add @google-cloud/storage`.
+
+From there, create the adapter, passing in all of its required properties:
+
+```js
+import { gcsAdapter } from '@payloadcms/plugin-cloud-storage/gcs';
+
+const adapter = gcsAdapter({
+  options: {
+    // you can choose any method for authentication, and authorization which is being provided by `@google-cloud/storage`
+    keyFilename: './gcs-credentials.json',
+    //OR
+    credentials: JSON.parse(process.env.GCS_CREDENTIALS) // this env variable will have stringify version of your credentials.json file
+  },
+  bucket: process.env.GCS_BUCKET,
+})
+
+// Now you can pass this adapter to the plugin
+```
+
+### Payload Access Control
+
+Payload ships with access control that runs _even on statically served files_. The same `read` access control property on your `upload`-enabled collections is used, and it allows you to restrict who can request your uploaded files.
+
+To preserve this feature, by default, this plugin _keeps all file URLs exactly the same_. Your file URLs won't be updated to point directly to your cloud storage source, as in that case, Payload's access control will be completely bypassed and you would need public readability on your cloud-hosted files.
+
+Instead, all uploads will still be reached from the default `/collectionSlug/staticURL/filename` path. This plugin will "pass through" all files that are hosted on your third-party cloud service—with the added benefit of keeping your existing access control in place.
+
+If this does not apply to you (your upload collection has `read: () => true` or similar) you can disable this functionality by setting `disablePayloadAccessControl` to `true`. When this setting is in place, this plugin will update your file URLs to point directly to your cloud host.
+
+## Local development
+
+For instructions regarding how to develop with this plugin locally, [click here](https://github.com/payloadcms/plugin-cloud-storage/blob/master/docs/local-dev.md).
+
+## Questions
+
+Please contact [Payload](dev@payloadcms.com) with any questions about using this plugin.
+
+## Credit
+
+This plugin was created with significant help, and code, from [Alex Bechmann](https://github.com/alexbechmann) and [Richard VanBergen](https://github.com/richardvanbergen). Thank you!!

package/azure.d.ts

@@ -1 +1 @@
-export * from './dist/adapters/azure'
+export * from './dist/adapters/azure'

package/azure.js

@@ -1 +1 @@
-exports.azureBlobStorageAdapter = require('./dist/adapters/azure').azureBlobStorageAdapter
+exports.azureBlobStorageAdapter = require('./dist/adapters/azure').azureBlobStorageAdapter

package/dist/adapters/azure/fileStub.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "file-stub";
-export default _default;
+declare const _default: "file-stub";
+export default _default;

package/dist/adapters/azure/fileStub.js

@@ -1,4 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = 'file-stub';
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = 'file-stub';
 //# sourceMappingURL=fileStub.js.map

package/dist/adapters/azure/generateURL.d.ts

@@ -1,7 +1,7 @@
-import type { GenerateURL } from '../../types';
-interface Args {
-    containerName: string;
-    baseURL: string;
-}
-export declare const getGenerateURL: ({ containerName, baseURL }: Args) => GenerateURL;
-export {};
+import type { GenerateURL } from '../../types';
+interface Args {
+    containerName: string;
+    baseURL: string;
+}
+export declare const getGenerateURL: ({ containerName, baseURL }: Args) => GenerateURL;
+export {};

package/dist/adapters/azure/generateURL.js

@@ -1,16 +1,16 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getGenerateURL = void 0;
-var path_1 = __importDefault(require("path"));
-var getGenerateURL = function (_a) {
-    var containerName = _a.containerName, baseURL = _a.baseURL;
-    return function (_a) {
-        var filename = _a.filename, _b = _a.prefix, prefix = _b === void 0 ? '' : _b;
-        return "".concat(baseURL, "/").concat(containerName, "/").concat(path_1.default.posix.join(prefix, filename));
-    };
-};
-exports.getGenerateURL = getGenerateURL;
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getGenerateURL = void 0;
+var path_1 = __importDefault(require("path"));
+var getGenerateURL = function (_a) {
+    var containerName = _a.containerName, baseURL = _a.baseURL;
+    return function (_a) {
+        var filename = _a.filename, _b = _a.prefix, prefix = _b === void 0 ? '' : _b;
+        return "".concat(baseURL, "/").concat(containerName, "/").concat(path_1.default.posix.join(prefix, filename));
+    };
+};
+exports.getGenerateURL = getGenerateURL;
 //# sourceMappingURL=generateURL.js.map

package/dist/adapters/azure/handleDelete.d.ts

@@ -1,9 +1,9 @@
-import type { CollectionConfig } from 'payload/types';
-import type { ContainerClient } from '@azure/storage-blob';
-import type { HandleDelete } from '../../types';
-interface Args {
-    collection: CollectionConfig;
-    getStorageClient: () => ContainerClient;
-}
-export declare const getHandleDelete: ({ getStorageClient }: Args) => HandleDelete;
-export {};
+import type { CollectionConfig } from 'payload/types';
+import type { ContainerClient } from '@azure/storage-blob';
+import type { HandleDelete } from '../../types';
+interface Args {
+    collection: CollectionConfig;
+    getStorageClient: () => ContainerClient;
+}
+export declare const getHandleDelete: ({ getStorageClient }: Args) => HandleDelete;
+export {};