Node Push Notifications
WARNING! This is only for Node 8.8.1+! Do not attempt to use this library with a lower version, as it will break.
A node.js module for interfacing with Apple Push Notification, Google Cloud Messaging, Windows Push Notification and Amazon Device Messaging services.
Installation
npm install node-pushnotifications-http2 --save
Requirements
Node version >= 6.x.x
Features
- Powerful and intuitive.
- Multi platform push notifications.
- Automatically detects destination device type.
- Unified error handling.
- Written in ES6, compatible with ES5 through babel transpilation.
Usage
1. Import and setup push module
Include the settings for each device type. You should only include the settings for the devices that you expect to have. I.e. if your app is only available for android or for ios, you should only include gcm
or apn
respectively.
; const settings = gcm: id: null phonegap: false // phonegap compatibility mode, see below (defaults to false) ... apn: token: key: './certs/key.p8' // optionally: fs.readFileSync('./certs/key.p8') keyId: 'ABCD' teamId: 'EFGH' production: false // true for APN production environment, false for APN sandbox environment, ... adm: client_id: null client_secret: null ... wns: client_id: null client_secret: null notificationMethod: 'sendTileSquareBlock' ... web: vapidDetails: subject: '< \'mailto\' Address or URL >' publicKey: '< URL Safe Base64 Encoded Public Key >' privateKey: '< URL Safe Base64 Encoded Private Key >' gcmAPIKey: 'gcmkey' TTL: 2419200 contentEncoding: 'aes128gcm' headers: {} isAlwaysUseFCM: false // true all messages will be sent through node-gcm (which actually uses FCM);const push = settings;
- GCM options: see node-gcm
- APN options: see node-apn
- ADM options: see node-adm
- WNS options: see wns
- Web-push options: see web-push
isAlwaysUseFCM
: use node-gcm to send notifications to GCM (by default), iOS, ADM and WNS.
iOS: It is recommended to use provider authentication tokens. You need the .p8 certificate that you can obtain in your account membership. You should ask for an Apple Push Notification Authentication Key (Sandbox & Production) or Apple Push Notification service SSL (Sandbox & Production). However, you can also use certificates. See node-apn to see how to prepare cert.pem and key.pem.
2. Define destination device ID
You can send to multiple devices, independently of platform, creating an array with different destination device IDs.
// Single destinationconst registrationIds = 'INSERT_YOUR_DEVICE_ID'; // Multiple destinationsconst registrationIds = ;registrationIds;registrationIds;
Android: If you provide more than 1.000 registration tokens, they will automatically be splitted in 1.000 chunks (see this issue in gcm repo)
3. Send the notification
Create a JSON object with a title and message and send the notification.
const data = title: 'New push notification' // REQUIRED for Android topic: 'topic' // REQUIRED for iOS (apn and gcm) /* The topic of the notification. When using token-based authentication, specify the bundle ID of the app. * When using certificate-based authentication, the topic is usually your app's bundle ID. * More details can be found under https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/sending_notification_requests_to_apns */ body: 'Powered by AppFeel' custom: sender: 'AppFeel' priority: 'high' // gcm, apn. Supported values are 'high' or 'normal' (gcm). Will be translated to 10 and 5 for apn. Defaults to 'high' collapseKey: '' // gcm for android, used as collapseId in apn contentAvailable: true // gcm, apn. node-apn will translate true to 1 as required by apn. delayWhileIdle: true // gcm for android restrictedPackageName: '' // gcm for android dryRun: false // gcm for android icon: '' // gcm for android tag: '' // gcm for android color: '' // gcm for android clickAction: '' // gcm for android. In ios, category will be used if not supplied locKey: '' // gcm, apn locArgs: '' // gcm, apn titleLocKey: '' // gcm, apn titleLocArgs: '' // gcm, apn retries: 1 // gcm, apn encoding: '' // apn badge: 2 // gcm for ios, apn sound: 'ping.aiff' // gcm, apn alert: // apn, will take precedence over title and body title: 'title' body: 'body' // details: https://github.com/node-apn/node-apn/blob/master/doc/notification.markdown#convenience-setters /* * A string is also accepted as a payload for alert * Your notification won't appear on ios if alert is empty object * If alert is an empty string the regular 'title' and 'body' will show in Notification */ // alert: '', launchImage: '' // apn and gcm for ios action: '' // apn and gcm for ios category: '' // apn and gcm for ios // mdm: '', // apn and gcm for ios. Use this to send Mobile Device Management commands. // https://developer.apple.com/library/content/documentation/Miscellaneous/Reference/MobileDeviceManagementProtocolRef/3-MDM_Protocol/MDM_Protocol.html urlArgs: '' // apn and gcm for ios truncateAtWordEnd: true // apn and gcm for ios mutableContent: 0 // apn threadId: '' // apn expiry: Math + 28 * 86400 // seconds timeToLive: 28 * 86400 // if both expiry and timeToLive are given, expiry will take precedency headers: // wns launch: '' // wns duration: '' // wns consolidationKey: 'my notification' // ADM; // You can use it in node callback stylepush; // Or you could use it as a promise:push ;
err
will be null if all went fine, otherwise will return the error from the respective provider module.result
will contain an array with the following objects (one object for each device type found in device registration id's):
method: 'gcm' // The method used send notifications and which this info is related to multicastId: // (only Android) Array with unique ID (number) identifying the multicast message, one identifier for each chunk of 1.000 notifications) success: 0 // Number of notifications that have been successfully sent. It does not mean that the notification has been deliveried. failure: 0 // Number of notifications that have been failed to be send. message: messageId: '' // (only for android) String specifying a unique ID for each successfully processed message or undefined if error regId: value // The current registrationId (device token id). Beware: For Android this may change if Google invalidates the previous device token. Use "originalRegId" if you are interested in when this changed occurs. originalRegId: value // (only for android) The registrationId that was sent to the push.send() method. Compare this with field "regId" in order to know when the original registrationId (device token id) gets changed. error: 'unknown' // If any, there will be an Error object here for depuration purposes (when possible it will come form source libraries aka apn, node-gcm) errorMsg: 'some error' // If any, will include the error message from the respective provider module method: 'apn' ... // Same structure here, except for message.orignalRegId method: 'wns' ... // Same structure here, except for message.orignalRegId method: 'adm' ... // Same structure here, except for message.orignalRegId method: 'webPush' ... // Same structure here, except for message.orignalRegId
GCM
NOTE: If you provide more than 1.000 registration tokens, they will automatically be splitted in 1.000 chunks (see this issue in gcm repo)
The following parameters are used to create a GCM message. See https://developers.google.com/cloud-messaging/http-server-ref#table5 for more info:
// Set default custom data from data let custom; if typeof datacustom === 'string' custom = message: datacustom ; else if typeof datacustom === 'object' custom = Object; else custom = data: datacustom ; customtitle = customtitle || datatitle; custommessage = custommessage || databody; customsound = customsound || datasound; customicon = customicon || dataicon; custommsgcnt = custommsgcnt || databadge; if optsphonegap === true && datacontentAvailable custom'content-available' = 1; const message = // See https://developers.google.com/cloud-messaging/http-server-ref#table5 collapseKey: datacollapseKey priority: datapriority === 'normal' ? datapriority : 'high' contentAvailable: datacontentAvailable || false delayWhileIdle: datadelayWhileIdle || false // Deprecated from Nov 15th 2016 (will be ignored) timeToLive: dataexpiry - Math || datatimeToLive || 28 * 86400 restrictedPackageName: datarestrictedPackageName dryRun: datadryRun || false data: datacustom notification: title: datatitle // Android, iOS (Watch) body: databody // Android, iOS icon: dataicon // Android sound: datasound // Android, iOS badge: databadge // iOS tag: datatag // Android color: datacolor // Android click_action: dataclickAction || datacategory // Android, iOS body_loc_key: datalocKey // Android, iOS body_loc_args: datalocArgs // Android, iOS title_loc_key: datatitleLocKey // Android, iOS title_loc_args: datatitleLocArgs // Android, iOS
data is the parameter in push.send(registrationIds, data)
Note: parameters are duplicated in data and in notification, so in fact they are being send as:
data: title: 'title' message: 'body' sound: 'mySound.aiff' icon: undefined msgcnt: undefined // Any custom data sender: 'appfeel-test' notification: title: 'title' body: 'body' icon: undefined sound: 'mySound.aiff' badge: undefined tag: undefined color: undefined click_action: undefined body_loc_key: undefined body_loc_args: undefined title_loc_key: undefined title_loc_args: undefined
In that way, they can be accessed in android in the following two ways:
String title = extras.; title = title != null ? title : extras.;
PhoneGap compatibility mode
In case your app is written with Cordova / Ionic and you are using the PhoneGap PushPlugin,
you can use the phonegap
setting in order to adapt to the recommended behaviour described in
https://github.com/phonegap/phonegap-plugin-push/blob/master/docs/PAYLOAD.md#android-behaviour.
const settings = gcm: id: '<yourId>' phonegap: true
APN
The following parameters are used to create an APN message:
retryLimit: dataretries || -1 expiry: dataexpiry || datatimeToLive || 28 * 86400 + Math priority: datapriority === 'normal' ? 5 : 10 encoding: dataencoding payload: datacustom || {} badge: databadge sound: datasound alert: dataalert || title: datatitle body: databody 'title-loc-key': datatitleLocKey 'title-loc-args': datatitleLocArgs 'loc-key': datalocKey 'loc-args': datalocArgs 'launch-image': datalaunchImage action: dataaction topic: datatopic // Required category: datacategory || dataclickAction contentAvailable: datacontentAvailable mdm: datamdm urlArgs: dataurlArgs truncateAtWordEnd: datatruncateAtWordEnd collapseId: datacollapseKey mutableContent: datamutableContent || 0
data is the parameter in push.send(registrationIds, data)
- See node-apn fields
- Please note that
topic
is required (see node-apn docs). When using token-based authentication, specify the bundle ID of the app. When using certificate-based authentication, the topic is usually your app's bundle ID. More details can be found under https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/sending_notification_requests_to_apns
Silent push notifications
iOS supports silent push notifications which are not displayed to the user but only used to transmit data.
You can send silent push notifications by sending a push notification with normal priority and no sound, badge or alert.
const silentPushData = topic: 'yourTopic' contentAvailable: true priority: 'normal' payload: yourKey: 'yourValue' ...
WNS
The following fields are used to create a WNS message:
const notificationMethod = settingswnsnotificationMethod;const opts = Object;optsheaders = dataheaders || optsheaders;optslaunch = datalaunch || optslaunch;optsduration = dataduration || optsduration; delete optsnotificationMethod;delete dataheaders;delete datalaunch;delete dataduration; wnsnotificationMethodregId data opts { ... };
data is the parameter in push.send(registrationIds, data)
Note: Please keep in mind that if data.accessToken
is supplied, each push notification will be sent after the previous one has been responded. This is because Microsoft may send a new accessToken
in the response and it should be used in successive requests. This can slow down the whole process depending on the number of devices to send.
ADM
The following parameters are used to create an ADM message:
const data = Object; // _data is the data passed as method parameterconst consolidationKey = dataconsolidationKey;const expiry = dataexpiry;const timeToLive = datatimeToLive; delete dataconsolidationKey;delete dataexpiry;delete datatimeToLive; const ADMmesssage = expiresAfter: expiry - Math || timeToLive || 28 * 86400 consolidationKey data;
data is the parameter in push.send(registrationIds, data)
Web-Push
Data can be passed as a simple string payload. If you do not pass a string, the parameter value will be stringified beforehand.
Settings are directly forwarded to webPush.sendNotification
.
const payload = typeof data === 'string' ? data : JSON;webPush;
A working server example implementation can be found at https://github.com/alex-friedl/webpush-example/blob/master/server/index.js
Resources
- Crossplatform integration example using this library and a React Native app
- Web-Push client/server example
- Node Push Notify from alexlds
LICENSE
The MIT License (MIT)
Copyright (c) 2016 AppFeel
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.