{"_id":"@benjamminj/react-aws-s3","_rev":"2-bab38b6754129e110ec07ed0e988f3ce","name":"@benjamminj/react-aws-s3","dist-tags":{"latest":"1.5.1"},"versions":{"1.5.0":{"name":"@benjamminj/react-aws-s3","version":"1.5.0","description":"Open Source Module to Upload your Media and files into AWS S3 Bucket directly from Front-end React.","author":{"name":"Amit Mishra"},"main":"dist/react-aws-s3.js","module":"dist/react-aws-s3.m.js","source":"src/react-aws-s3.ts","umd:main":"dist/react-aws-s3.umd.js","unpkg":"dist/react-aws-s3.js","scripts":{"build":"microbundle","clean":"rm -rf dist","dev":"microbundle --ts watch","tslint":"tslint -c tslint.json 'src/**/*.ts'","prepublish":"npm run clean && npm run build"},"keywords":["react-component","react","s3","upload","vanillajs","vue-aws3","vuejs","typescript","angular-aws3","angular","aws","file-upload","file","react-aws-s3"],"license":"MIT","dependencies":{"crypto-js":"^3.1.9-1","short-uuid":"^3.1.0"},"devDependencies":{"@types/crypto-js":"^3.1.43","microbundle":"^0.9.0","typescript":"^3.2.4"},"repository":{"type":"git","url":"git+https://github.com/Developer-Amit/react-aws-s3.git"},"bugs":{"url":"https://github.com/Developer-Amit/react-aws-s3/issues"},"homepage":"https://github.com/Developer-Amit/react-aws-s3#readme","gitHead":"1733124037905e3911b4c325df9505dffa32fd7d","_id":"@benjamminj/react-aws-s3@1.5.0","_nodeVersion":"15.1.0","_npmVersion":"7.0.8","dist":{"integrity":"sha512-pbunRFdHIZvFzCmrddkhqLXBZR6jjG7C5QRnqMlap6pkhvSRci150/MxcXSbSHGcPZ9z7iReQJ+BgSdVifCNNA==","shasum":"7a771c05e99221c1e688939214a4f53c6f99bb0e","tarball":"https://registry.npmjs.org/@benjamminj/react-aws-s3/-/react-aws-s3-1.5.0.tgz","fileCount":5,"unpackedSize":8044,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgcHWiCRA9TVsSAnZWagAA/xsQAJ/k1a2DSlaApaBfRvdd\nEC+yRx+fC0F9iiRObOo2Sps+PIN/oFGWm/CZs/qSwrCGJ/SJKA15bhj+ZXOW\n5hKRz9uh18HSIn0Z3v3/VC9cJGtERaPKZHS816daOFXaXqJL6FLLeFBmOC1k\neiPdirufwNCyQMzydOr16ot2fjqjYIWE9O04AOGvV0wEyjhCbSdqjxvJbFoK\nzXGEwFDmib9jvsAGWS42Cen7qpKmJwoHDJPsn33GksT7aTqJk6fR+KMYgutS\naM+PYNdzIGJ8fPzbA4y3mRdzCTiXBxPqlbo/+k9Duz492ik4f1j4ehL4W08j\nRBrK9dfMp+e+DTAxs37LQt8VzffCU1640FCtl0ub4YDMRvgUyRvjWgAJNigy\nEeUo9mCVqVdPhh45KhwCEcw31w6aTbQMdPPqaAULW8rPMRTbmpVsvTPhwYpo\n3mRtEQ4t8bDz7RLnkWbbP1OZ1TdyZuCo3CTP3XqC4OqtcgTeaIMHVN8cixEy\nNcFLLLIh9BQuKcauvdzSFwkJwN7SIIDz7Y0iRjz47k+ohJse6mmjNlcan+N3\nCftwCTMx2EeuNITdym2pe6cOLvYmPZ7+RsJQQRrI2uLnfaYG8y6dIa+Wz7aj\nJfCBvZEwEeykO0tP2b6LpZMQA2r6FesAMSUvBSdgnlQDiaizmD4iIah3g0Ps\naoPy\r\n=OKMK\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCID2oFW5EF7saS3BRNs6DrS+ksRV/x93k9qEfiQnReLIsAiEAntgAfabTM/X0g1BqwZg68z5TiHSNXB8ookyeZin593Q="}]},"_npmUser":{"name":"benjamminj","email":"benjamindavjohnson@gmail.com"},"directories":{},"maintainers":[{"name":"benjamminj","email":"benjamindavjohnson@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/react-aws-s3_1.5.0_1617982882064_0.6769278696898395"},"_hasShrinkwrap":false},"1.5.1":{"name":"@benjamminj/react-aws-s3","version":"1.5.1","description":"Open Source Module to Upload your Media and files into AWS S3 Bucket directly from Front-end React.","author":{"name":"Amit Mishra"},"main":"dist/react-aws-s3.js","module":"dist/react-aws-s3.m.js","source":"src/react-aws-s3.ts","umd:main":"dist/react-aws-s3.umd.js","unpkg":"dist/react-aws-s3.js","scripts":{"build":"microbundle","clean":"rm -rf dist","dev":"microbundle --ts watch","tslint":"tslint -c tslint.json 'src/**/*.ts'","prepublish":"npm run clean && npm run build"},"keywords":["react-component","react","s3","upload","vanillajs","vue-aws3","vuejs","typescript","angular-aws3","angular","aws","file-upload","file","react-aws-s3"],"license":"MIT","dependencies":{"crypto-js":"^3.1.9-1","short-uuid":"^3.1.0"},"devDependencies":{"@types/crypto-js":"^3.1.43","microbundle":"^0.9.0","typescript":"^3.2.4"},"repository":{"type":"git","url":"git+https://github.com/Developer-Amit/react-aws-s3.git"},"bugs":{"url":"https://github.com/Developer-Amit/react-aws-s3/issues"},"homepage":"https://github.com/Developer-Amit/react-aws-s3#readme","gitHead":"f62a419726332daf72838e34e542c7b9a9053690","_id":"@benjamminj/react-aws-s3@1.5.1","_nodeVersion":"15.1.0","_npmVersion":"7.0.8","dist":{"integrity":"sha512-ptdXsdUE0n3U3Jdb/++q8ddCuKcL/vj8rFeEx0nOuuZ/a2T53g83Oq4BV0saSqKQDVoHck2btY6ppYAfDW3DwQ==","shasum":"0e984efd508a080a07a2108892a16e729a114dc7","tarball":"https://registry.npmjs.org/@benjamminj/react-aws-s3/-/react-aws-s3-1.5.1.tgz","fileCount":5,"unpackedSize":8044,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgcHWzCRA9TVsSAnZWagAARXAQAIiKjZRLXK/lnJKpMvs4\nG5EKzhyHo9wFw8fVhI+lKtMdLUeOXmuHnK6bq6xZ63+6XbjXhNtcsbOheZDO\nK/ia85W3nomZ2pCUbVSVETj2QfVXeIm4z95Gbb/7tzhMUEBWUpBirSAg4TZr\njzWdWU/ryYU80heKrCwxP1oa+w9QwtbBacvdI52hH2CgxnTaM2EoU0E9JGdQ\n/+iRN0ga7ao6fuchUadatxw6jyDdFJjITUpRyEwfzY27pTvle6bzzxts+VAD\n+PHmWfl9glmdo60p4J/66gojY39uv8IfUD+Isq801BSjdJ4etNywfEGqYUXB\nVOn12yTI9FR/8YZyTQcJTIyat4QXm7wGGh2l4BaDINjgqdobEUkUGJmeHJ3L\nmcCUW+Bqm8oEWFr4QN6CxJDQ3fO/Vt3rbiBLyDlAoV/AsyKbZ1eyiKAz+it+\n0q6uBHDVPOWnaJo7SysGXO1u6E9tXifP5hoSVuraYyDHvsPRM7rQ1ohVjhal\noDPZ8F/dz8vvIPLJIIBxgIop/hCVn2PizzmK6/4I5lP1Dn7iMvRpAIDUYzNA\nH53loRAKcBenoxFqLdzq/eP0tK8NkqaLHHpf+edgCydWMJR9H6UFl6ac2ZWa\nZkQWd3r21SvG8sT6PHBExJEnSde5xf0Ic4o4tUV+MFYBrVHOB1T9oS/LfS9a\ne0/i\r\n=qQvI\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCsTsvwk7kP/i0L0VC4C+vaSzHOYMhE4XEIiicTtKyIngIgXB2QvTNChFXd7KrlIo8qjss2/Su0Y3nIMZ/LE3gihcY="}]},"_npmUser":{"name":"benjamminj","email":"benjamindavjohnson@gmail.com"},"directories":{},"maintainers":[{"name":"benjamminj","email":"benjamindavjohnson@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/react-aws-s3_1.5.1_1617982899438_0.7315486810017973"},"_hasShrinkwrap":false}},"time":{"created":"2021-04-09T15:41:22.009Z","1.5.0":"2021-04-09T15:41:22.197Z","modified":"2022-04-04T18:22:55.014Z","1.5.1":"2021-04-09T15:41:39.589Z"},"maintainers":[{"name":"benjamminj","email":"benjamindavjohnson@gmail.com"}],"description":"Open Source Module to Upload your Media and files into AWS S3 Bucket directly from Front-end React.","homepage":"https://github.com/Developer-Amit/react-aws-s3#readme","keywords":["react-component","react","s3","upload","vanillajs","vue-aws3","vuejs","typescript","angular-aws3","angular","aws","file-upload","file","react-aws-s3"],"repository":{"type":"git","url":"git+https://github.com/Developer-Amit/react-aws-s3.git"},"author":{"name":"Amit Mishra"},"bugs":{"url":"https://github.com/Developer-Amit/react-aws-s3/issues"},"license":"MIT","readme":"# react-aws-s3\nOpen Source Module to Upload your Media and files into AWS S3 Bucket directly from Front-end React.\n\n### Help the Module developer (Amit Mishra) by donating a few dollars, for saving your many hrs.\n<p>\n  <a href=\"https://paypal.me/devamitmishra?locale.x=en_GB\">\n      <img src=\"https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif\" alt=\"paypal\">\n  </a>\n</p>\n\n### https://www.npmjs.com/package/react-aws-s3\n# S3Client AWS-S3\n\nS3Client - A Javascript Library for AWS S3 File Upload\n\nUsing NPM\n\n```\nnpm install --save react-aws-s3\n```\nUsing Yarn \n\n```\nyarn add react-aws-s3\n```\n\n\n\n# Examples Uploading An Image\n\n## ***Uploading to S3***\n\n```js\nimport S3 from 'react-aws-s3';\n\nconst config = {\n    bucketName: 'myBucket',\n    dirName: 'media', /* optional */\n    region: 'eu-west-1',\n    accessKeyId: 'JAJHAFJFHJDFJSDHFSDHFJKDSF',\n    secretAccessKey: 'jhsdf99845fd98qwed42ebdyeqwd-3r98f373f=qwrq3rfr3rf',\n    s3Url: 'https:/your-custom-s3-url.com/', /* optional */\n}\n\nconst ReactS3Client = new S3(config);\n/*  Notice that if you don't provide a dirName, the file will be automatically uploaded to the root of your bucket */\n\n/* This is optional */\nconst newFileName = 'test-file';\n\nReactS3Client\n    .uploadFile(file, newFileName)\n    .then(data => console.log(data))\n    .catch(err => console.error(err))\n\n  /**\n   * {\n   *   Response: {\n   *     bucket: \"myBucket\",\n   *     key: \"image/test-image.jpg\",\n   *     location: \"https://myBucket.s3.amazonaws.com/media/test-file.jpg\"\n   *   }\n   * }\n   */\n});\n```\n\n## ***Deleting an existing file in your bucket***\n\nIn this case the file that we want to delete is in the folder 'photos'\n\n```js\nimport S3 from 'react-aws-s3';\n\n\nconst config = {\n    bucketName: 'myBucket',\n    dirName: 'media', /* optional */\n    region: 'eu-west-1',\n    accessKeyId: 'JAJHAFJFHJDFJSDHFSDHFJKDSF',\n    secretAccessKey: 'jhsdf99845fd98qwed42ebdyeqwd-3r98f373f=qwrq3rfr3rf',\n    s3Url: 'https:/your-custom-s3-url.com/', /* optional */\n}\n\nconst ReactS3Client = new S3(config);\n\nconst filename = 'hello-world.docx';\n\n/* If the file that you want to delete it's in your bucket's root folder, don't provide any dirName in the config object */\n\n//In this case the file that we want to delete is in the folder 'photos' that we referred in the config object as the dirName\n\nReactS3Client\n    .deleteFile(filename)\n    .then(response => console.log(response))\n    .catch(err => console.error(err))\n\n  /**\n   * {\n   *   Response: {\n   *      ok: true,\n          status: 204,\n          message: 'File deleted',\n          fileName: 'hello-world.docx'\n   *   }\n   * }\n   */\n});\n```\n\nDefaults your bucket to `public-read` : http://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html\n\n`config`\n  * `bucketName` **required** - Your S3 bucket\n  * `dirName` **required** - Your S3 folderName/dirName\n  * `region` **required** - Your S3 bucket's region\n  * `accessKeyId` **required** - Your S3 `AccessKeyId`\n  * `secretAccessKey` **required** - Your S3 `SecretAccessKey`\n  * `s3Url` **optional** - Your S3 URL\n\n## License\n\n\n## ***S3 Bucket Policy***\n\nDoc: http://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html\n\n\nMIT\n","readmeFilename":"README.md"}