@payloadcms/plugin-cloud-storage 1.0.13 → 1.0.15-0

package/.editorconfig

@@ -0,0 +1,10 @@
+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

@@ -0,0 +1,248 @@
+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

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

package/.prettierrc.js

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

package/.vscode/launch.json

@@ -0,0 +1,40 @@
+{
+  // 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

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

package/LICENSE.md

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2018-2022 Payload CMS, LLC <info@payloadcms.com>
+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

package/README.md

@@ -12,7 +12,11 @@ This repository contains the officially supported Payload Cloud Storage plugin.
 
 ## Usage
 
-Install this plugin within your Payload as follows:
+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';
@@ -33,6 +37,23 @@ export default buildConfig({
 });
 ```
 
+### Conditionally Enabling/Disabling
+
+The proper way to conditionally enable/disable this plugin is to use the `enabled` property.
+
+```ts
+cloudStorage({
+  enabled: process.env.MY_CONDITION === 'true',
+  collections: {
+    'my-collection-slug': {
+      adapter: theAdapterToUse, // see docs for the adapter you want to use
+    },
+  },
+}),
+```
+
+If the code is included *in any way in your config* but conditionally disabled in another fashion, you may run into issues such as `Webpack Build Error: Can't Resolve 'fs' and 'stream'` or similar because the plugin must be run at all times in order to properly extend the webpack config.
+
 ## Features
 
 **Adapter-based Implementation**
@@ -54,6 +75,7 @@ This plugin is configurable to work across many different Payload collections. A
 | 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. |
+| `enabled`               |                                         | `boolean` to conditionally enable/disable plugin. Default: true. |
 
 **Collection-specific options:**
 
@@ -153,9 +175,9 @@ const adapter = gcsAdapter({
 
 ### 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.
+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.
+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.
 

package/dev/.env

@@ -0,0 +1,21 @@
+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

@@ -0,0 +1,21 @@
+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/nodemon.json

@@ -0,0 +1,8 @@
+{
+  "ext": "ts",
+  "exec": "node  --trace-warnings -r ts-node/register -r ./src/server.ts",
+  "watch": [
+    "src/**/*.ts",
+    "../src/**/*.ts"
+  ]
+}

package/dev/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "payload-plugin-cloud-storage-demo",
+  "version": "1.0.0",
+  "main": "dist/server.js",
+  "license": "MIT",
+  "private": true,
+  "scripts": {
+    "dev:azure": "cross-env PAYLOAD_CONFIG_PATH=src/payload.config.ts PAYLOAD_PUBLIC_CLOUD_STORAGE_ADAPTER=azure nodemon",
+    "dev:s3": "cross-env PAYLOAD_CONFIG_PATH=src/payload.config.ts PAYLOAD_PUBLIC_CLOUD_STORAGE_ADAPTER=s3 nodemon",
+    "dev:gcs": "cross-env PAYLOAD_CONFIG_PATH=src/payload.config.ts PAYLOAD_PUBLIC_CLOUD_STORAGE_ADAPTER=gcs nodemon",
+    "build:payload": "cross-env PAYLOAD_CONFIG_PATH=src/payload.config.ts payload build",
+    "build:server": "tsc",
+    "build": "yarn build:payload && yarn build:server",
+    "serve": "cross-env PAYLOAD_CONFIG_PATH=dist/payload.config.js NODE_ENV=production node dist/server.js",
+    "generate:types": "cross-env PAYLOAD_CONFIG_PATH=src/payload.config.ts payload generate:types"
+  },
+  "dependencies": {
+    "@aws-sdk/client-s3": "^3.142.0",
+    "@azure/storage-blob": "^12.11.0",
+    "@google-cloud/storage": "^6.4.2",
+    "dotenv": "^8.2.0",
+    "express": "^4.17.1",
+    "image-size": "^1.0.2",
+    "payload": "^1.7.2",
+    "probe-image-size": "^7.2.3"
+  },
+  "devDependencies": {
+    "@types/express": "^4.17.9",
+    "cross-env": "^7.0.3",
+    "nodemon": "^2.0.6",
+    "ts-node": "^9.1.1",
+    "typescript": "^4.1.3"
+  }
+}

package/dev/src/collections/Media.ts

@@ -0,0 +1,56 @@
+/* eslint-disable no-console */
+import type { CollectionConfig, Field } from 'payload/types'
+
+const urlField: Field = {
+  name: 'url',
+  type: 'text',
+  hooks: {
+    afterRead: [
+      ({ value }) => {
+        console.log('hello from hook')
+        return value
+      },
+    ],
+  },
+}
+
+export const Media: CollectionConfig = {
+  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],
+        },
+      ],
+    },
+  ],
+}

package/dev/src/collections/Users.ts

@@ -0,0 +1,23 @@
+import type { CollectionConfig } from 'payload/types'
+
+const Users: CollectionConfig = {
+  slug: 'users',
+  auth: true,
+  access: {
+    read: () => true,
+  },
+  fields: [
+    {
+      name: 'avatar',
+      type: 'upload',
+      relationTo: 'media',
+    },
+    {
+      name: 'background',
+      type: 'upload',
+      relationTo: 'media',
+    },
+  ],
+}
+
+export default Users

package/dev/src/mocks/fsMock.js

@@ -0,0 +1 @@
+module.exports = { fs: { createReadStream: () => null } }

package/dev/src/mocks/promisifyMock.js

@@ -0,0 +1 @@
+export const promisify = () => {}

package/dev/src/payload.config.ts

@@ -0,0 +1,111 @@
+import { buildConfig } from 'payload/config'
+import path from 'path'
+import Users from './collections/Users'
+import { cloudStorage } from '../../src'
+import { s3Adapter } from '../../src/adapters/s3'
+import { gcsAdapter } from '../../src/adapters/gcs'
+import { azureBlobStorageAdapter } from '../../src/adapters/azure'
+import type { Adapter } from '../../src/types'
+import { Media } from './collections/Media'
+
+let adapter: Adapter
+let uploadOptions
+
+if (process.env.PAYLOAD_PUBLIC_CLOUD_STORAGE_ADAPTER === 'azure') {
+  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,
+  })
+  // uploadOptions = {
+  //   useTempFiles: true,
+  // }
+}
+
+if (process.env.PAYLOAD_PUBLIC_CLOUD_STORAGE_ADAPTER === 's3') {
+  // The s3 adapter supports using temp files for uploads
+  uploadOptions = {
+    useTempFiles: true,
+  }
+
+  adapter = s3Adapter({
+    config: {
+      endpoint: process.env.S3_ENDPOINT,
+      forcePathStyle: process.env.S3_FORCE_PATH_STYLE === 'true',
+      region: process.env.S3_REGION,
+      credentials: {
+        accessKeyId: process.env.S3_ACCESS_KEY_ID,
+        secretAccessKey: process.env.S3_SECRET_ACCESS_KEY,
+      },
+    },
+    bucket: process.env.S3_BUCKET,
+  })
+}
+
+if (process.env.PAYLOAD_PUBLIC_CLOUD_STORAGE_ADAPTER === 'gcs') {
+  adapter = gcsAdapter({
+    options: {
+      apiEndpoint: process.env.GCS_ENDPOINT,
+      projectId: process.env.GCS_PROJECT_ID,
+    },
+    bucket: process.env.GCS_BUCKET,
+  })
+}
+
+export default buildConfig({
+  serverURL: 'http://localhost:3000',
+  collections: [Media, Users],
+  upload: uploadOptions,
+  admin: {
+    // NOTE - these webpack extensions are only required
+    // for development of this plugin.
+    // No need to use these aliases within your own projects.
+    webpack: config => {
+      const newConfig = {
+        ...config,
+        resolve: {
+          ...(config.resolve || {}),
+          alias: {
+            ...(config.resolve.alias || {}),
+            react: path.resolve(__dirname, '../node_modules/react'),
+            '@azure/storage-blob': path.resolve(__dirname, '../../src/adapters/azure/mock.js'),
+            '@aws-sdk/client-s3': path.resolve(__dirname, '../../src/adapters/s3/mock.js'),
+            '@google-cloud/storage': path.resolve(__dirname, '../../src/adapters/gcs/mock.js'),
+            fs: path.resolve(__dirname, './mocks/fsMock.js'),
+          },
+        },
+      }
+      return newConfig
+    },
+  },
+  typescript: {
+    outputFile: path.resolve(__dirname, 'payload-types.ts'),
+  },
+  plugins: [
+    // @ts-expect-error Conflicting types for relative package
+    cloudStorage({
+      collections: {
+        media: {
+          adapter,
+        },
+      },
+    }),
+  ],
+  onInit: async payload => {
+    const users = await payload.find({
+      collection: 'users',
+      limit: 1,
+    })
+
+    if (!users.docs.length) {
+      await payload.create({
+        collection: 'users',
+        data: {
+          email: 'dev@payloadcms.com',
+          password: 'test',
+        },
+      })
+    }
+  },
+})