react-aws-s3-typescript - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
     "name": "react-aws-s3-typescript",
-    "version": "1.0.0",
+    "version": "1.0.1",
     "description": "Open source npm package to upload your files into AWS S3 Bucket directly using react(typescript template)",
@@ -33,3 +33,2 @@ "main": "dist/index.js",
         "react-aws-s3-typescript"
-
     ],
@@ -60,2 +59,2 @@ "author": "Nimper",
     ]
-}
+}

README.md

 # react-aws-s3-typescript
 
-Open source npm package to upload your files into AWS S3 Bucket directly using react(typescript template)
+Open source npm package to upload your files into AWS S3 Bucket directly using react(typescript template)
+
+## Table of Contents
+
+- [Introduction](#introduction)
+- [Features](#features)
+- [Installing](#installing)
+- [Example](#example)
+    - [Upload a file to AWS S3 Bucket](#upload-a-file-to-aws-s3-bucket)
+    - [Delete a file from AWS S3 Bucket](#delete-a-file-from-aws-s3-bucket)
+- [S3 Config](#s3-config)
+- [Credits](#credits)
+- [License](#license)
+
+
+## Introduction
+
+Open source npm package to upload your media and other types of files directly into AWS S3 Bucket using react typescript template. You can upload and retrive the public url for the file and delete the files if needed.
+
+You need to have an AWS account to use AWS S3 Bucket. If you already do not have an account, create an account [here](https://console.aws.amazon.com).
+
+Readmore about AWS S3 buket: [https://docs.aws.amazon.com/s3/index.html](https://docs.aws.amazon.com/s3/index.html)
+
+## Features
+
+- Upload files to S3 bucket and retrive the public url
+- Delete files from S3 bucket
+
+## Installing
+
+Using npm
+
+```bash
+$ npm install react-aws-s3-typescript
+```
+
+## Example
+
+### Upload a file to AWS S3 Bucket
+
+You can define a default directory for uploads using the s3Config object
+
+```typescript
+    /* AWS S3 config options */
+    /* Highly recommended to declare the config object in an external file import it when needed */
+
+    /* s3Config.ts */
+
+    export const s3Config = {
+        bucketName:  'bucket-name',
+        dirName: 'directory-name',      /* Optional */
+        region: 'ap-south-1',
+        accessKeyId:'ABCD12EFGH3IJ4KLMNO5',
+        secretAccessKey: 'a12bCde3f4+5GhIjKLm6nOpqr7stuVwxy8ZA9bC0',
+        s3Url: 'https:/your-aws-s3-bucket-url/'     /* Optional */
+    }
+
+    /* End of s3Config.ts */
+```
+
+```typescript
+    /* AWS S3 Client */
+    /* uploadFile.ts */
+    import S3 from 'react-aws-s3-typescript';
+    import { s3Config } from './s3Config.ts';
+
+    /* Import s3 config object and call the constrcutor */
+    const s3 = new S3(s3Config);
+
+    /* You can use the default directory defined in s3Config object
+     * Or you can a define custom directory to upload when calling the
+     * constructor using js/ts object destructuring.
+     * 
+     * const s3 = new S3({
+     *      ...s3Config,
+     *      dirName: 'custom-directory'
+     * });
+     * 
+     */
+
+    const filename = 'filename-to-be-uploaded';     /* Optional */
+
+    /* If you do not specify a file name, file will be uploaded using uuid generated 
+     * by short-UUID (https://www.npmjs.com/package/short-uuid)
+     */
+
+
+    s3.uploadFile(file, filename).then((res) => {
+        console.log(res);
+        /*
+         * {
+         *   Response: {
+         *     bucket: "bucket-name",
+         *     key: "directory-name/filename-to-be-uploaded",
+         *     location: "https:/your-aws-s3-bucket-url/directory-name/filename-to-be-uploaded"
+         *   }
+         * }
+         */
+    }).catch((err) => {
+        console.log(err);
+    })
+
+    /* End of uploadFile.ts */
+```
+
+### Delete a file from AWS S3 Bucket
+
+```typescript
+    /* AWS S3 Client */
+    /* deleteFile.ts */
+    import S3 from 'react-aws-s3-typescript';
+    import { s3Config } from './s3Config.ts';
+
+    /* Import s3 config object and call the constrcutor */
+    const s3 = new S3(s3Config);
+
+    /* Define the filepath from the root of the bucket to the file to be deleted */
+    const filepath = 'directory-name/filename-to-be-deleted';
+
+    await s3.deleteFile(filepath).then((res) => {
+        console.log('File deleted');
+    }).catch((err) => {
+        console.log(err);
+    })
+
+    /* End of deleteFile.ts */
+```
+
+__Important :__ Add `public-read` Canned ACL to the bucket to grant the public read access for files.
+
+Read more: [https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl)
+
+## S3 Config
+
+These are the available config options for calling the S3 constructor `bucketName`, `region`, `accessKeyId` and `secretAccessKey` are required. Upload will default to __root path__, if `dirName` is not specified.
+
+## Credits
+
+This `react-aws-s3-typescript` package is heavily inspired by the [`react-aws-s3`](https://www.npmjs.com/package/react-aws-s3) package provided by [developer-amit](https://www.npmjs.com/~developer-amit).
+
+## License
+
+Released under [__MIT license__](https://opensource.org/licenses/MIT).
+
+[Back to top](#table-of-contents)
+
+

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

20206

increased by29.01%

Number of lines in readme file

150

increased by4900%

No dependency changes