@payloadcms/plugin-cloud-storage 1.0.15 → 1.0.16

package/dev/src/payload.config.ts

@@ -1,111 +0,0 @@
-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
-    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',
-        },
-      })
-    }
-  },
-})

package/dev/src/server.ts

@@ -1,26 +0,0 @@
-import express from 'express'
-import payload from 'payload'
-
-// eslint-disable-next-line @typescript-eslint/no-require-imports
-require('dotenv').config()
-
-const app = express()
-
-// Redirect root to Admin panel
-app.get('/', (_, res) => {
-  res.redirect('/admin')
-})
-
-// Initialize Payload
-payload.init({
-  secret: process.env.PAYLOAD_SECRET,
-  mongoURL: process.env.MONGODB_URI,
-  express: app,
-  onInit: () => {
-    payload.logger.info(`Payload Admin URL: ${payload.getAdminURL()}`)
-  },
-})
-
-// Add your own express routes here
-
-app.listen(3000)

package/dev/tsconfig.json

@@ -1,20 +0,0 @@
-{
-  "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/docs/local-dev.md

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

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

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

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

package/eslint-config/rules/style.js

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