@payloadcms/plugin-cloud-storage 1.0.17-beta.1 → 1.0.18

package/README.md

@@ -122,7 +122,8 @@ const adapter = s3Adapter({
     credentials: {
       accessKeyId: process.env.S3_ACCESS_KEY_ID,
       secretAccessKey: process.env.S3_SECRET_ACCESS_KEY,
-    }
+    },
+    region: process.env.S3_REGION,
     // ... Other S3 configuration
   },
   bucket: process.env.S3_BUCKET,
@@ -130,6 +131,7 @@ const adapter = s3Adapter({
 
 // Now you can pass this adapter to the plugin
 ```
+Note that the credentials option does not have to be used when you are using PayloadCMS on an EC2 instance that has been configured with an IAM Role with necessary permissions.
 
 Other S3 Client configuration is documented [here](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-s3/interfaces/s3clientconfig.html).
 
@@ -165,7 +167,7 @@ const adapter = gcsAdapter({
     // 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
+    credentials: JSON.parse(process.env.GCS_CREDENTIALS || "{}") // this env variable will have stringify version of your credentials.json file
   },
   bucket: process.env.GCS_BUCKET,
 })
@@ -189,7 +191,7 @@ For instructions regarding how to develop with this plugin locally, [click here]
 
 ## Questions
 
-Please contact [Payload](dev@payloadcms.com) with any questions about using this plugin.
+Please contact [Payload](mailto:dev@payloadcms.com) with any questions about using this plugin.
 
 ## Credit
 

package/dist/adapters/s3/index.d.ts

@@ -1,7 +1,17 @@
 import * as AWS from '@aws-sdk/client-s3';
 import type { Adapter } from '../../types';
 export interface Args {
+    /**
+     * AWS S3 client configuration. Highly dependent on your AWS setup.
+     *
+     * [AWS.S3ClientConfig Docs](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-s3/interfaces/s3clientconfig.html)
+     */
     config: AWS.S3ClientConfig;
+    /**
+     * Bucket name to upload files to.
+     *
+     * Must follow [AWS S3 bucket naming conventions](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html).
+     */
     bucket: string;
     acl?: 'private' | 'public-read';
 }

package/dist/adapters/s3/index.js

@@ -31,7 +31,7 @@ var handleDelete_1 = require("./handleDelete");
 var handleUpload_1 = require("./handleUpload");
 var webpack_1 = require("./webpack");
 var s3Adapter = function (_a) {
-    var config = _a.config, bucket = _a.bucket, acl = _a.acl;
+    var _b = _a.config, config = _b === void 0 ? {} : _b, bucket = _a.bucket, acl = _a.acl;
     return function (_a) {
         var collection = _a.collection, prefix = _a.prefix;
         var storageClient = null;

package/dist/adapters/s3/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/adapters/s3/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sDAAyC;AAEzC,6CAA8C;AAC9C,iDAA4C;AAC5C,+CAAgD;AAChD,+CAAgD;AAChD,qCAA+C;AAQxC,IAAM,SAAS,GACpB,UAAC,EAA6B;QAA3B,MAAM,YAAA,EAAE,MAAM,YAAA,EAAE,GAAG,SAAA;IACtB,OAAA,UAAC,EAAsB;YAApB,UAAU,gBAAA,EAAE,MAAM,YAAA;QACnB,IAAI,aAAa,GAAkB,IAAI,CAAA;QACvC,IAAM,gBAAgB,GAAiB;YACrC,IAAI,aAAa;gBAAE,OAAO,aAAa,CAAA;YACvC,aAAa,GAAG,IAAI,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,CAAA;YAClC,OAAO,aAAa,CAAA;QACtB,CAAC,CAAA;QAED,OAAO;YACL,YAAY,EAAE,IAAA,8BAAe,EAAC;gBAC5B,UAAU,YAAA;gBACV,gBAAgB,kBAAA;gBAChB,MAAM,QAAA;gBACN,GAAG,KAAA;gBACH,MAAM,QAAA;aACP,CAAC;YACF,YAAY,EAAE,IAAA,8BAAe,EAAC,EAAE,gBAAgB,kBAAA,EAAE,MAAM,QAAA,EAAE,CAAC;YAC3D,WAAW,EAAE,IAAA,4BAAc,EAAC,EAAE,MAAM,QAAA,EAAE,MAAM,QAAA,EAAE,CAAC;YAC/C,aAAa,EAAE,IAAA,0BAAU,EAAC,EAAE,MAAM,QAAA,EAAE,gBAAgB,kBAAA,EAAE,UAAU,YAAA,EAAE,CAAC;YACnE,OAAO,EAAE,6BAAmB;SAC7B,CAAA;IACH,CAAC;AArBD,CAqBC,CAAA;AAvBU,QAAA,SAAS,aAuBnB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/adapters/s3/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sDAAyC;AAEzC,6CAA8C;AAC9C,iDAA4C;AAC5C,+CAAgD;AAChD,+CAAgD;AAChD,qCAA+C;AAkBxC,IAAM,SAAS,GACpB,UAAC,EAAkC;QAAhC,cAAW,EAAX,MAAM,mBAAG,EAAE,KAAA,EAAE,MAAM,YAAA,EAAE,GAAG,SAAA;IAC3B,OAAA,UAAC,EAAsB;YAApB,UAAU,gBAAA,EAAE,MAAM,YAAA;QACnB,IAAI,aAAa,GAAkB,IAAI,CAAA;QACvC,IAAM,gBAAgB,GAAiB;YACrC,IAAI,aAAa;gBAAE,OAAO,aAAa,CAAA;YACvC,aAAa,GAAG,IAAI,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,CAAA;YAClC,OAAO,aAAa,CAAA;QACtB,CAAC,CAAA;QAED,OAAO;YACL,YAAY,EAAE,IAAA,8BAAe,EAAC;gBAC5B,UAAU,YAAA;gBACV,gBAAgB,kBAAA;gBAChB,MAAM,QAAA;gBACN,GAAG,KAAA;gBACH,MAAM,QAAA;aACP,CAAC;YACF,YAAY,EAAE,IAAA,8BAAe,EAAC,EAAE,gBAAgB,kBAAA,EAAE,MAAM,QAAA,EAAE,CAAC;YAC3D,WAAW,EAAE,IAAA,4BAAc,EAAC,EAAE,MAAM,QAAA,EAAE,MAAM,QAAA,EAAE,CAAC;YAC/C,aAAa,EAAE,IAAA,0BAAU,EAAC,EAAE,MAAM,QAAA,EAAE,gBAAgB,kBAAA,EAAE,UAAU,YAAA,EAAE,CAAC;YACnE,OAAO,EAAE,6BAAmB;SAC7B,CAAA;IACH,CAAC;AArBD,CAqBC,CAAA;AAvBU,QAAA,SAAS,aAuBnB"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@payloadcms/plugin-cloud-storage",
   "description": "The official cloud storage plugin for Payload CMS",
-  "version": "1.0.17-beta.1",
+  "version": "1.0.18",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "license": "MIT",

package/.editorconfig

@@ -1,10 +0,0 @@
-root = true
-
-[*]
-indent_style = space
-indent_size = 2
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true
-end_of_line = lf
-max_line_length = null

package/.gitignore

@@ -1,248 +0,0 @@
-dev/tmp
-dev/yarn.lock
-
-# Created by https://www.gitignore.io/api/node,macos,windows,webstorm,sublimetext,visualstudiocode
-
-### macOS ###
-*.DS_Store
-.AppleDouble
-.LSOverride
-
-# Thumbnails
-._*
-
-# Files that might appear in the root of a volume
-.DocumentRevisions-V100
-.fseventsd
-.Spotlight-V100
-.TemporaryItems
-.Trashes
-.VolumeIcon.icns
-.com.apple.timemachine.donotpresent
-
-# Directories potentially created on remote AFP share
-.AppleDB
-.AppleDesktop
-Network Trash Folder
-Temporary Items
-.apdisk
-
-### Node ###
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-
-# Runtime data
-pids
-*.pid
-*.seed
-*.pid.lock
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-
-# nyc test coverage
-.nyc_output
-
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Bower dependency directory (https://bower.io/)
-bower_components
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (http://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directories
-node_modules/
-jspm_packages/
-
-# Typescript v1 declaration files
-typings/
-
-# Optional npm cache directory
-.npm
-
-# Optional eslint cache
-.eslintcache
-
-# Optional REPL history
-.node_repl_history
-
-# Output of 'npm pack'
-*.tgz
-
-# Yarn Integrity file
-.yarn-integrity
-
-# Yarn Berry
-.yarn/*
-!.yarn/patches
-!.yarn/plugins
-!.yarn/releases
-!.yarn/sdks
-!.yarn/versions
-.pnp.*
-
-# dotenv environment variables file
-.env
-
-
-### SublimeText ###
-# cache files for sublime text
-*.tmlanguage.cache
-*.tmPreferences.cache
-*.stTheme.cache
-
-# workspace files are user-specific
-*.sublime-workspace
-
-# project files should be checked into the repository, unless a significant
-# proportion of contributors will probably not be using SublimeText
-# *.sublime-project
-
-# sftp configuration file
-sftp-config.json
-
-# Package control specific files
-Package Control.last-run
-Package Control.ca-list
-Package Control.ca-bundle
-Package Control.system-ca-bundle
-Package Control.cache/
-Package Control.ca-certs/
-Package Control.merged-ca-bundle
-Package Control.user-ca-bundle
-oscrypto-ca-bundle.crt
-bh_unicode_properties.cache
-
-# Sublime-github package stores a github token in this file
-# https://packagecontrol.io/packages/sublime-github
-GitHub.sublime-settings
-
-### VisualStudioCode ###
-.vscode/*
-!.vscode/tasks.json
-!.vscode/launch.json
-!.vscode/extensions.json
-.history
-
-### WebStorm ###
-# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
-# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
-
-.idea/*
-# User-specific stuff:
-.idea/**/workspace.xml
-.idea/**/tasks.xml
-.idea/dictionaries
-
-# Sensitive or high-churn files:
-.idea/**/dataSources/
-.idea/**/dataSources.ids
-.idea/**/dataSources.xml
-.idea/**/dataSources.local.xml
-.idea/**/sqlDataSources.xml
-.idea/**/dynamic.xml
-.idea/**/uiDesigner.xml
-
-# Gradle:
-.idea/**/gradle.xml
-.idea/**/libraries
-
-# CMake
-cmake-build-debug/
-
-# Mongo Explorer plugin:
-.idea/**/mongoSettings.xml
-
-## File-based project format:
-*.iws
-
-## Plugin-specific files:
-
-# IntelliJ
-/out/
-
-# mpeltonen/sbt-idea plugin
-.idea_modules/
-
-# JIRA plugin
-atlassian-ide-plugin.xml
-
-# Cursive Clojure plugin
-.idea/replstate.xml
-
-# Ruby plugin and RubyMine
-/.rakeTasks
-
-# Crashlytics plugin (for Android Studio and IntelliJ)
-com_crashlytics_export_strings.xml
-crashlytics.properties
-crashlytics-build.properties
-fabric.properties
-
-### WebStorm Patch ###
-# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721
-
-# *.iml
-# modules.xml
-# .idea/misc.xml
-# *.ipr
-
-# Sonarlint plugin
-.idea/sonarlint
-
-### Windows ###
-# Windows thumbnail cache files
-Thumbs.db
-ehthumbs.db
-ehthumbs_vista.db
-
-# Folder config file
-Desktop.ini
-
-# Recycle Bin used on file shares
-$RECYCLE.BIN/
-
-# Windows Installer files
-*.cab
-*.msi
-*.msm
-*.msp
-
-# Windows shortcuts
-*.lnk
-
-# End of https://www.gitignore.io/api/node,macos,windows,webstorm,sublimetext,visualstudiocode
-
-# Ignore all uploads
-demo/upload
-demo/media
-demo/files
-
-# Ignore build folder
-build
-
-# Ignore built components
-components/index.js
-components/styles.css
-
-# Ignore generated
-demo/generated-types.ts
-demo/generated-schema.graphql
-
-# Ignore dist, no need for git
-dist
-
-# Ignore emulator volumes
-src/adapters/s3/emulator/.localstack/

package/.prettierignore

@@ -1 +0,0 @@
-eslint-config

package/.prettierrc.js

@@ -1,8 +0,0 @@
-module.exports = {
-  printWidth: 100,
-  parser: "typescript",
-  semi: false,
-  singleQuote: true,
-  trailingComma: "all",
-  arrowParens: "avoid",
-};

package/.vscode/launch.json

@@ -1,40 +0,0 @@
-{
-  // Use IntelliSense to learn about possible attributes.
-  // Hover to view descriptions of existing attributes.
-  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-  "version": "0.2.0",
-  "configurations": [
-    {
-      "type": "node",
-      "request": "launch",
-      "cwd": "${workspaceFolder}/dev",
-      "runtimeArgs": [
-        "-r",
-        "./node_modules/ts-node/register"
-      ],
-      "name": "Debug Cloud Storage - S3",
-      "program": "${workspaceFolder}/dev/src/server.ts",
-      "outputCapture": "std",
-      "env": {
-        "PAYLOAD_PUBLIC_CLOUD_STORAGE_ADAPTER": "s3",
-        "PAYLOAD_CONFIG_PATH": "${workspaceFolder}/dev/src/payload.config.ts"
-      }
-    },
-    {
-      "type": "node",
-      "request": "launch",
-      "cwd": "${workspaceFolder}/dev",
-      "runtimeArgs": [
-        "-r",
-        "./node_modules/ts-node/register"
-      ],
-      "name": "Debug Cloud Storage - Azure",
-      "program": "${workspaceFolder}/dev/src/server.ts",
-      "outputCapture": "std",
-      "env": {
-        "PAYLOAD_PUBLIC_CLOUD_STORAGE_ADAPTER": "azure",
-        "PAYLOAD_CONFIG_PATH": "${workspaceFolder}/dev/src/payload.config.ts"
-      }
-    },
-  ]
-}

package/.vscode/settings.json

@@ -1,9 +0,0 @@
-{
-  "[typescript]": {
-    "editor.defaultFormatter": "esbenp.prettier-vscode",
-    "editor.codeActionsOnSave": {
-      "source.fixAll": true,
-    },
-    "editor.formatOnSave": true,
-  },
-}

package/dev/.env

@@ -1,21 +0,0 @@
-MONGODB_URI=mongodb://localhost/payload-plugin-cloud-storage
-PAYLOAD_PUBLIC_SERVER_URL=http://localhost:3000
-PAYLOAD_SECRET=45ligj345ligj4wl5igj4lw5igj45ligj45wlijl
-PAYLOAD_CONFIG_PATH=src/payload.config.ts
-
-AZURE_STORAGE_CONNECTION_STRING=DefaultEndpointsProtocol=http;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;BlobEndpoint=http://localhost:10000/devstoreaccount1;QueueEndpoint=http://localhost:10001/devstoreaccount1;
-AZURE_STORAGE_CONTAINER_NAME=az-media
-AZURE_STORAGE_ALLOW_CONTAINER_CREATE=true
-AZURE_STORAGE_ACCOUNT_BASEURL=http://localhost:10000/devstoreaccount1
-
-S3_ENDPOINT=http://localhost:4566
-S3_ACCESS_KEY_ID=payloadAccessKey
-S3_SECRET_ACCESS_KEY=alwiejglaiwhewlihgawe
-S3_BUCKET=payload-bucket
-S3_FORCE_PATH_STYLE=true
-
-GCS_ENDPOINT=http://localhost:4443
-GCS_PROJECT_ID=test
-GCS_BUCKET=payload-bucket
-
-PAYLOAD_DROP_DATABASE=true

package/dev/.env.example

@@ -1,21 +0,0 @@
-MONGODB_URI=mongodb://localhost/payload-plugin-cloud-storage
-PAYLOAD_PUBLIC_SERVER_URL=http://localhost:3000
-PAYLOAD_SECRET=45ligj345ligj4wl5igj4lw5igj45ligj45wlijl
-PAYLOAD_CONFIG_PATH=src/payload.config.ts
-
-AZURE_STORAGE_CONNECTION_STRING=DefaultEndpointsProtocol=http;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;BlobEndpoint=http://localhost:10000/devstoreaccount1;QueueEndpoint=http://localhost:10001/devstoreaccount1;
-AZURE_STORAGE_CONTAINER_NAME=az-media
-AZURE_STORAGE_ALLOW_CONTAINER_CREATE=true
-AZURE_STORAGE_ACCOUNT_BASEURL=http://localhost:10000/devstoreaccount1
-
-S3_ENDPOINT=http://localhost:4566
-S3_ACCESS_KEY_ID=payloadAccessKey
-S3_SECRET_ACCESS_KEY=alwiejglaiwhewlihgawe
-S3_BUCKET=payload-bucket
-S3_FORCE_PATH_STYLE=true
-
-GCS_ENDPOINT=http://localhost:4443
-GCS_PROJECT_ID=test
-GCS_BUCKET=payload-bucket
-
-PAYLOAD_DROP_DATABASE=true

package/dev/dist/dev/src/collections/Media.js

@@ -1,56 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Media = void 0;
-var urlField = {
-    name: 'url',
-    type: 'text',
-    hooks: {
-        afterRead: [
-            function (_a) {
-                var value = _a.value;
-                console.log('hello from hook');
-                return value;
-            },
-        ],
-    },
-};
-exports.Media = {
-    slug: 'media',
-    upload: {
-        imageSizes: [
-            {
-                height: 400,
-                width: 400,
-                crop: 'center',
-                name: 'square',
-            },
-            {
-                width: 900,
-                height: 450,
-                crop: 'center',
-                name: 'sixteenByNineMedium',
-            },
-        ],
-    },
-    fields: [
-        {
-            name: 'alt',
-            label: 'Alt Text',
-            type: 'text',
-        },
-        // The following fields should be able to be merged in to default upload fields
-        urlField,
-        {
-            name: 'sizes',
-            type: 'group',
-            fields: [
-                {
-                    name: 'square',
-                    type: 'group',
-                    fields: [urlField],
-                },
-            ],
-        },
-    ],
-};
-//# sourceMappingURL=Media.js.map

package/dev/dist/dev/src/collections/Media.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Media.js","sourceRoot":"","sources":["../../../../src/collections/Media.ts"],"names":[],"mappings":";;;AAGA,IAAM,QAAQ,GAAU;IACtB,IAAI,EAAE,KAAK;IACX,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE;QACL,SAAS,EAAE;YACT,UAAC,EAAS;oBAAP,KAAK,WAAA;gBACN,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAA;gBAC9B,OAAO,KAAK,CAAA;YACd,CAAC;SACF;KACF;CACF,CAAA;AAEY,QAAA,KAAK,GAAqB;IACrC,IAAI,EAAE,OAAO;IACb,MAAM,EAAE;QACN,UAAU,EAAE;YACV;gBACE,MAAM,EAAE,GAAG;gBACX,KAAK,EAAE,GAAG;gBACV,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,QAAQ;aACf;YACD;gBACE,KAAK,EAAE,GAAG;gBACV,MAAM,EAAE,GAAG;gBACX,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,qBAAqB;aAC5B;SACF;KACF;IACD,MAAM,EAAE;QACN;YACE,IAAI,EAAE,KAAK;YACX,KAAK,EAAE,UAAU;YACjB,IAAI,EAAE,MAAM;SACb;QAED,+EAA+E;QAC/E,QAAQ;QACR;YACE,IAAI,EAAE,OAAO;YACb,IAAI,EAAE,OAAO;YACb,MAAM,EAAE;gBACN;oBACE,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,OAAO;oBACb,MAAM,EAAE,CAAC,QAAQ,CAAC;iBACnB;aACF;SACF;KACF;CACF,CAAA"}

package/dev/dist/dev/src/collections/Users.js

@@ -1,23 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var Users = {
-    slug: 'users',
-    auth: true,
-    access: {
-        read: function () { return true; },
-    },
-    fields: [
-        {
-            name: 'avatar',
-            type: 'upload',
-            relationTo: 'media',
-        },
-        {
-            name: 'background',
-            type: 'upload',
-            relationTo: 'media',
-        },
-    ],
-};
-exports.default = Users;
-//# sourceMappingURL=Users.js.map

package/dev/dist/dev/src/collections/Users.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Users.js","sourceRoot":"","sources":["../../../../src/collections/Users.ts"],"names":[],"mappings":";;AAEA,IAAM,KAAK,GAAqB;IAC9B,IAAI,EAAE,OAAO;IACb,IAAI,EAAE,IAAI;IACV,MAAM,EAAE;QACN,IAAI,EAAE,cAAM,OAAA,IAAI,EAAJ,CAAI;KACjB;IACD,MAAM,EAAE;QACN;YACE,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE,OAAO;SACpB;QACD;YACE,IAAI,EAAE,YAAY;YAClB,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE,OAAO;SACpB;KACF;CACF,CAAA;AAED,kBAAe,KAAK,CAAA"}