# pushnotifications_aws_sns

> Send Push notifications using AWS SNS.

Latest version **1.0.4** (published 2019-02-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install pushnotifications_aws_sns
pnpm add pushnotifications_aws_sns
yarn add pushnotifications_aws_sns
bun add pushnotifications_aws_sns
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2019-02-04 |
| First published | 2019-02-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 11 |
| Unpacked size | 323.2 KB |
| Known vulnerabilities | 0 (+13 in 6 direct dependencies) |
| Install scripts | no |
| Maintainers | rakeshaset |

## Links

- npm: https://www.npmjs.com/package/pushnotifications_aws_sns
- npm.io page: https://npm.io/package/pushnotifications_aws_sns

## Dependencies (11)

- [rxjs](https://npm.io/package/rxjs.md) ^6.2.2
- [dotenv](https://npm.io/package/dotenv.md) ^6.2.0
- [rimraf](https://npm.io/package/rimraf.md) ^2.6.2
- [aws-sdk](https://npm.io/package/aws-sdk.md) ^2.375.0
- [mongoose](https://npm.io/package/mongoose.md) ^5.3.15
- [typescript](https://npm.io/package/typescript.md) ^3.0.1
- [@nestjs/core](https://npm.io/package/@nestjs/core.md) ^5.4.0
- [@nestjs/common](https://npm.io/package/@nestjs/common.md) ^5.4.0
- [class-validator](https://npm.io/package/class-validator.md) ^0.9.1
- [reflect-metadata](https://npm.io/package/reflect-metadata.md) ^0.1.12
- [class-transformer](https://npm.io/package/class-transformer.md) ^0.2.0

## Recent versions

- 1.0.4 (latest) — 2019-02-04
- 1.0.3 — 2019-02-04
- 1.0.2 — 2019-02-04
- 1.0.1 — 2019-02-04
- 1.0.0 — 2019-02-04

## README

# Send push notification using AWS SNS(Simple Notification Service)

This package is developed to send push notification to mobile devices android/ios using AWS SNS apis.

In this method we expect that your android/ios app is already set up to receive device token,=.

### Follow below mentioned links for setting up application to receive device token.

-For iOS application set up please follow intructions [Getting Started with Apple Push Notification Service](https://docs.aws.amazon.com/sns/latest/dg/mobile-push-apns.html#SNSMobilePushPrereqAPNS).

-For android application set up please follow intructions [Getting Started with Google Cloud Messaging for Android](https://docs.aws.amazon.com/sns/latest/dg/mobile-push-gcm.html).

There are two types of notification that can be sent using this API.
- Broadcast message - In this users device is subscribed to a topic. Notifications are sent to topics   and all the users who are subscribed to that topic received notifications.

- Device Specific message : In this notification are sent to particular devices using device token.


## Pacakge API details and usage

### Create Topic 

This method is used to create a topic in AWS sns. 

It requires AWS key information which we pass using below mentioned object. 
These are your app registration details with aws sns.

```
let awsHeaderInfo = {
    headers: {      
      "region": "",
      "accesskeyid": "",
      "secretaccesskey": ""
    }
  };
```

Than we intialize object to pass topic details.

```
 let topicDTO = {
    "topicName": "TestNewtopic"     
  };
```

In your project import this package.. Working on getting this to point directly to package.
Instead of the dist path which currently it points to.
```
const pushTest = require("pushnotifications_aws_sns/dist/main");

 pushTest.createTopic(topicDTO, awsHeaderInfo).subscribe(
         result => {
             console.log("result", result);
             res.status(200).send(result);
         },
         error => {
             res.status(500).send(error);
         }); 
```

## Register device.

This method is used to register you device to get the application ARN. Input to this method is your device token and application ARN.

It returns EndPoint ARN which is used to send notification to a particular device. Or subscribe that device to a topic.

Input :
```
let deviceInput = {
    "notificationToken": "",    
    "applicationARN": ""

};
```
```
pushTest.registerDevice(deviceInput, awsHeaderInfo).subscribe(
        result => {
            console.log("result", result);
            res.status(200).send(result.EndpointArn);
        },
        error=>
        {
            res.status(500).send(error);
        }
    )
```
## Subscribe to topic.

This method is used to subscribe device to a topic.

Input to this method is Device ARN , which we got in response when we registered as device as EndPointARN.
and Topic ARN , which we got in response when we created a topic. Or we can get Topic ARN from SNS console.
```
 let subscribeInput = {
    "endPointArn": "",
    "topicArn": ""

  };

```

```
pushTest.subscribetopic(subscribeInput, awsHeaderInfo).subscribe(
        result => {
            console.log("result", result);
            res.status(200).send(result);
        },
        error => {
            res.status(500).send(error);
        });
```
## Send notification.

This method is used to send notification to either a device ARN or to a Topic ARN.

Input to this method is Device ARN to Topic ARN.

```
  let sendNotificationInput = {
    "subject": "test",
    "topicARN": "",
    "notificationMessage": "My test message 5"

  };
```

```

pushTest.sendNotification(sendNotificationInput, awsHeaderInfo).subscribe(
        result => {
            console.log("result", result);
            res.status(200).send(result);
        },
        error => {
            res.status(500).send(error);
        });

```

---
_Source: https://npm.io/package/pushnotifications_aws_sns · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
