{"_id":"@bigegg/s3-files-adapter","_rev":"3-bb656f840c181107267ffc08082d245e","name":"@bigegg/s3-files-adapter","dist-tags":{"latest":"1.2.2"},"versions":{"1.2.1":{"name":"@bigegg/s3-files-adapter","version":"1.2.1","description":"AWS S3 adapter for parse-server","main":"index.js","scripts":{"pretest":"npm run lint","test":"NODE_ENV=test NODE_CONFIG_DIR=./spec/config istanbul cover -x **/spec/** jasmine --captureExceptions","lint":"eslint --cache ./"},"repository":{"type":"git","url":"git+https://github.com/bigegg/parse-server-s3-adapter.git"},"keywords":["parse-server","AWS","S3"],"author":{"name":"Parse"},"license":"ISC","bugs":{"url":"https://github.com/bigegg/parse-server-s3-adapter/issues"},"homepage":"https://github.com/bigegg/parse-server-s3-adapter#readme","dependencies":{"aws-sdk":"^2.59.0"},"devDependencies":{"codecov":"^3.0.0","config":"^1.24.0","eslint":"^4.1.0","istanbul":"^0.4.2","jasmine":"^2.4.1","parse-server-conformance-tests":"^1.0.0"},"gitHead":"08ec52a908694c6b38b19874bf7cb3ae8bfd64b9","_id":"@bigegg/s3-files-adapter@1.2.1","_npmVersion":"6.4.1","_nodeVersion":"10.5.0","_npmUser":{"name":"jones0036","email":"jones0036@gmail.com"},"dist":{"integrity":"sha512-xI/un+iVpuRtPuWXBO/e6TFZSRfLxsqEhebkJf2bzECwAJiY0jUP5wrNaRaEm1gdjCALTkK5tls7S174sp+GdQ==","shasum":"4ab8e9227535aa0944981f1d67f8f85f889f0bdc","tarball":"https://registry.npmjs.org/@bigegg/s3-files-adapter/-/s3-files-adapter-1.2.1.tgz","fileCount":12,"unpackedSize":33276,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJccRDHCRA9TVsSAnZWagAAh+oP/0w9PXR5tLBRBt5h690A\nktTn0Y7FJ4tWY1hkzxLYrlzchnpo4D3wiECrw5h+AHdYPCgAJG7/99OzmakF\nH4na4lnn64RbTYCdvTHTjxDSnxKNQ3/BeuUoLSn4cEgLHs4RcWZdxDKAgkvZ\nGeob9mem6+JOcq50tqdeONo3XX+8sK4DbQQ/aJfd7HtJmD6f0p+ZF9DEs/Vh\nVzNY5fJGkikZW1Mrzb7VsqBZq+9V4wUmwqQyXocG/3CJ3JLxDBFWzuPsTvy+\nUz/3GHOAZWThfYCGer6UBWRZboNwflaZhbGA9D+AEoJLKQkvIyyDNYRIEYRo\nSw8MfVhkrFZbUvkzqT/yncIzYuxA6PqNWrCuarwOrfZMYfvdCZuwcNkbiLdI\n7cgacOaFjOVAxcSG2DTIn7otaIiFf2lfkO7Seap0QruvD03IHM0U9scEn22a\nYFKtkx1QKSg2K96SYfBVGg2sP5cNgacqQMOc0eDdcjziVl7/hnwHJki+xojX\nrzhq/sp48QbHGHr3sLzvyelWh/hYVr/R8imeS5dE6zTaLnXEmAALV4UhwVaz\neT1VLk2jwsapgLQ/K0bxaD0G++60r58kxv7PuHHOEmgMODVNIW3O0hfKDNIV\nzlywrKaw3YOAeXA7NIPdmtSFi296M4BPZrn5Pr+E4H2a+ZoP2wdf28vbLJSO\nAdJK\r\n=m62E\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGyx+NOVWmHjR9IJ5TWF3RgwB56mjDhR2PlRQl8JBom1AiEA96/wyURN0LDlZA03mtLD9tq8eCJ2HuANyXTaKKZZWXg="}]},"maintainers":[{"name":"jones0036","email":"jones0036@gmail.com"},{"name":"fxp007","email":"fxp007@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/s3-files-adapter_1.2.1_1550913735364_0.7983369307434112"},"_hasShrinkwrap":false},"1.2.2":{"name":"@bigegg/s3-files-adapter","version":"1.2.2","description":"AWS S3 adapter for parse-server","main":"index.js","scripts":{"pretest":"npm run lint","test":"NODE_ENV=test NODE_CONFIG_DIR=./spec/config istanbul cover -x **/spec/** jasmine --captureExceptions","lint":"eslint --cache ./"},"repository":{"type":"git","url":"git+https://github.com/bigegg/parse-server-s3-adapter.git"},"keywords":["parse-server","AWS","S3"],"author":{"name":"Parse"},"license":"ISC","bugs":{"url":"https://github.com/bigegg/parse-server-s3-adapter/issues"},"homepage":"https://github.com/bigegg/parse-server-s3-adapter#readme","dependencies":{"aws-sdk":"^2.59.0"},"devDependencies":{"codecov":"^3.0.0","config":"^1.24.0","eslint":"^4.1.0","istanbul":"^0.4.2","jasmine":"^2.4.1","parse-server-conformance-tests":"^1.0.0"},"gitHead":"d4d9c4da12164ba8b2e16a9e5664070fb83d66f7","_id":"@bigegg/s3-files-adapter@1.2.2","_npmVersion":"6.4.1","_nodeVersion":"10.5.0","_npmUser":{"name":"jones0036","email":"jones0036@gmail.com"},"dist":{"integrity":"sha512-3A9uLQaEjrqLcBx0tEfPIaUTH6DJc2XvuW8nzg9pHzzm951DRiEbcB0r0dKBhsWUz5fPDdsgZc1dgUa/aJqS9w==","shasum":"b05d1be0593d758c3768f963669358eb1f533306","tarball":"https://registry.npmjs.org/@bigegg/s3-files-adapter/-/s3-files-adapter-1.2.2.tgz","fileCount":12,"unpackedSize":33811,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJccSDGCRA9TVsSAnZWagAApzQP+wYCmyOAbj0+GGxQM6Rf\nkNfIAByWROLQRGRmP+XhgEkvgDw5mPvI7iQ8dqumCldKPLWQzu4CSRDCnRM4\n7NQdwhC5oSSc4s0nvJUmxPBPhTYO+CBWhp46hfISz17E6Zsht7/az/oQn4Ac\n91U116azM5uOcUID5hFeTiK4FHbDzIg58FeSfe+9r55N1i07p0lErSPxtMqW\nwXl5ccFYsqRf/XlcaekrV6a2aB/Uf/AZReL5zGjiGfGZkWL94dtd3o7453zp\n/850uwdeVDrhvz7768+QqotPRN4TCbySKui6U6c3t/rajeQgLYDgSX4t2+1X\nlznAKqNAONHjBcaQb1dZXrWmdc8rrVB50tVsMrzZTjmHtH4wZaD0yXNFRb4B\nNFNJTTTo2usyMFfn43hOJ1Z0mQaipFVfbZKvHHzhzh7x26TFdb6AUrEuFVqa\nOiuASt6BPUgU9b4KWPpSjPkCAlU6GGNgznaq9vUvGAWYdNK0D1fUSXDI8aSo\nvwrlzbU8XhJnJSz1qAffDlBod9JSI3vv3NahZKYQyWKxWQwFvWwmg8vdfDm3\n+PnsZwhZuAQL5bakrBbkaLax64x0xV7D7qf+E09+vnrHPtU4VvYxd9G2EXoV\nCAwg2xuIlbzQQLUljJSBIj3Q0WQMTwktjsumv36WVY0edgMfhKWoSW4hvNW3\nd44l\r\n=MDwS\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDQBWWtPvLxXhx0bmyoJEIh5UC24n0Jf30iVs+hnwI/BgIhAOwuJ2exHvv8BXvzqumWbORp8McYVcNKtjn2Q9sjarWB"}]},"maintainers":[{"name":"fxp007","email":"fxp007@gmail.com"},{"name":"jones0036","email":"jones0036@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/s3-files-adapter_1.2.2_1550917829560_0.48548005751960743"},"_hasShrinkwrap":false}},"time":{"created":"2019-02-23T09:22:15.176Z","1.2.1":"2019-02-23T09:22:15.568Z","modified":"2022-04-04T18:46:06.421Z","1.2.2":"2019-02-23T10:30:29.724Z"},"maintainers":[{"email":"liguangsong123@gmail.com","name":"lgnf"},{"email":"jones0036@gmail.com","name":"jones0036"},{"email":"fxp007@gmail.com","name":"fxp007"}],"description":"AWS S3 adapter for parse-server","homepage":"https://github.com/bigegg/parse-server-s3-adapter#readme","keywords":["parse-server","AWS","S3"],"repository":{"type":"git","url":"git+https://github.com/bigegg/parse-server-s3-adapter.git"},"author":{"name":"Parse"},"bugs":{"url":"https://github.com/bigegg/parse-server-s3-adapter/issues"},"license":"ISC","readme":"# parse-server-s3-adapter\n\nparse-server adapter for AWS S3\n\n**added assumeBucketIsPublicRead config**\n\nSome cloud vender has acl policy number limit(eg. qcloud). By setting assumeBucketIsPublicRead to true, this adapter will not issue 'public-read' acl header when creating new file, even when directAccess is true. (also available via env variable S3_ASSUME_BUCKET_IS_PUBLIC_READ)\n\n# installation\n\n`npm install --save @bigegg/s3-files-adapter`\n\n# AWS Credentials\n\n## Deprecation Notice -- AWS Credentials\n *the ability to explicitly pass credentials to this adapter is deprecated and will be removed in a future release.*\n\nYou may already be compatible with this change.  If you have not explicitly set an `accessKey` and `secretKey` and you have configured the environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`, then you're all set and this will continue to work as is.\n\nIf you explicitly configured the environment variables `S3_ACCESS_KEY`\n`S3_SECRET_KEY`\n\n*OR*\n\nIf you explicitly configured the `accessKey` and `secretKey` in your adapter configuration, then you'll need to...\n\nFor non AWS hosts:\n\n*  Run `aws configure` in a terminal which will step you through configuring credentials for the AWS SDK and CLI\n\nFor an AWS host:\n\n*  Ensure that the role that your host is running as has permissions for your s3 bucket\n\n*Then*\n\n*  remove the `accessKey` and `secretKey` from your configuration\n\nIf for some reason you really need to be able to set the key and secret explicitly, you can still do it using `s3overrides` as described below and setting `accessKeyId` and `secretAccessKey` in the `s3Overrides` object.\n\n# Deprecated Configuration\nAlthough it is not recommended, AWS credentials can be explicitly configured through an options\nobject, constructor string arguments or environment variables ([see below](#using-a-config-file)).\nThis option is provided for backward compatibility and will be removed in the forthcoming version 2.0 of this adapter.\n\nThe preferred method is to use the default AWS credentials pattern.  If no AWS credentials are explicitly configured, the AWS SDK will look for credentials in the standard locations used by all AWS SDKs and the AWS CLI. More info can be found in [the docs](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html#config-settings-and-precedence).  For more information on AWS best practices, see [IAM Best Practices User Guide](http://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html).\n\n# usage with parse-server\n\n### using a config file\n\n```\n{\n  \"appId\": 'my_app_id',\n  \"masterKey\": 'my_master_key',\n  // other options\n  \"filesAdapter\": {\n    \"module\": \"@bigegg/s3-files-adapter\",\n    \"options\": {\n      \"bucket\": \"my_bucket\",\n      // optional:\n      \"region\": 'us-east-1', // default value\n      \"bucketPrefix\": '', // default value\n      \"directAccess\": false, // default value\n      \"baseUrl\": null, // default value\n      \"baseUrlDirect\": false, // default value\n      \"signatureVersion\": 'v4', // default value\n      \"globalCacheControl\": null, // default value. Or 'public, max-age=86400' for 24 hrs Cache-Control\n      \"ServerSideEncryption\": 'AES256|aws:kms' //AES256 or aws:kms, or if you do not pass this, encryption won't be done\n    }\n  }\n}\n```\n\n### using environment variables\n\nSet your environment variables:\n\n```\nS3_BUCKET=bucketName\n```\n\nthe following optional configuration can be set by environment variable too:\n\n```\nS3_SIGNATURE_VERSION=v4\n```\n\nAnd update your config / options\n\n```\n{\n  \"appId\": 'my_app_id',\n  \"masterKey\": 'my_master_key',\n  // other options\n  \"filesAdapter\": \"@bigegg/s3-files-adapter\"\n}\n```\n\n\n### passing as an instance\n```\nvar S3Adapter = require('@bigegg/s3-files-adapter');\n\nvar s3Adapter = new S3Adapter('accessKey',\n                  'secretKey', bucket, {\n                    region: 'us-east-1'\n                    bucketPrefix: '',\n                    directAccess: false,\n                    baseUrl: 'http://images.example.com',\n                    signatureVersion: 'v4',\n                    globalCacheControl: 'public, max-age=86400'  // 24 hrs Cache-Control.\n                  });\n\nvar api = new ParseServer({\n\tappId: 'my_app',\n\tmasterKey: 'master_key',\n\tfilesAdapter: s3adapter\n})\n```\n**Note:** there are a few ways you can pass arguments:\n\n```\nS3Adapter(\"bucket\")\nS3Adapter(\"bucket\", options)\nS3Adapter(\"key\", \"secret\", \"bucket\") -- Deprecated, see notice above\nS3Adapter(\"key\", \"secret\", \"bucket\", options) -- Deprecated, see notice above\nS3Adapter(options) // where options must contain bucket.\nS3Adapter(options, s3overrides)\n```\nIf you use the last form, `s3overrides` are the parameters passed to [AWS.S3](http://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#constructor-property).\n\nIn this form if you set `s3overrides.params`, you must set at least `s3overrides.params.Bucket`\n\nor with an options hash\n\n```\nvar S3Adapter = require('@bigegg/s3-files-adapter');\n\nvar s3Options = {\n  \"bucket\": \"my_bucket\",\n  // optional:\n  \"region\": 'us-east-1', // default value\n  \"bucketPrefix\": '', // default value\n  \"directAccess\": false, // default value\n  \"baseUrl\": null // default value\n  \"signatureVersion\": 'v4', // default value\n  \"globalCacheControl\": null // default value. Or 'public, max-age=86400' for 24 hrs Cache-Control\n}\n\nvar s3Adapter = new S3Adapter(s3Options);\n\nvar api = new ParseServer({\n  appId: 'my_app',\n  masterKey: 'master_key',\n  filesAdapter: s3Adapter\n})\n```\n### Usage with Digital Ocean Spaces \n\n```\nvar S3Adapter = require(\"@bigegg/s3-files-adapter\");\nvar AWS = require(\"aws-sdk\");\n\n//Configure Digital Ocean Spaces EndPoint\nconst spacesEndpoint = new AWS.Endpoint(process.env.SPACES_ENDPOINT);\nvar s3Options = {\n  bucket: process.env.SPACES_BUCKET_NAME,\n  baseUrl: process.env.SPACES_BASE_URL, \n  region: process.env.SPACES_REGION,\n  directAccess: true,\n  globalCacheControl: \"public, max-age=31536000\", \n  bucketPrefix: process.env.SPACES_BUCKET_PREFIX,\n  s3overrides: {\n    accessKeyId: process.env.SPACES_ACCESS_KEY,\n    secretAccessKey: process.env.SPACES_SECRET_KEY,\n    endpoint: spacesEndpoint\n  }\n};\n\nvar s3Adapter = new S3Adapter(s3Options);\n\nvar api = new ParseServer({\n  databaseURI: process.env.DATABASE_URI || \"mongodb://localhost:27017/dev\",\n  cloud: process.env.CLOUD_CODE_MAIN || __dirname + \"/cloud/main.js\",\n  appId: process.env.APP_ID || \"myAppId\",\n  masterKey: process.env.MASTER_KEY || \"\", \n  serverURL: process.env.SERVER_URL || \"http://localhost:1337/parse\", \n  logLevel: process.env.LOG_LEVEL || \"info\",\n  allowClientClassCreation: false,\n  filesAdapter: s3Adapter,\n  }\n});\n```\n","readmeFilename":"README.md"}