pushy 2.0.14 → 3.0.2

package/README.md

@@ -42,14 +42,14 @@ var options = {
 };
 
 // Send push notification using the Send Notifications API
-pushy.sendPushNotification(data, to, options, function (err, id) {
+pushy.sendPushNotification(data, to, options, function (err, result) {
     // Log errors to console
     if (err) {
         return console.error(err);
     }
     
     // Log success
-    console.log('Push sent successfully! (ID: ' + id + ')');
+    console.log('Push sent successfully! (ID: ' + result.id + ')');
 });
 ```
 
@@ -61,9 +61,9 @@ The library also supports using promise syntax instead of callbacks for all API
 
 ```js
 pushy.sendPushNotification(data, tokens, options)
-    .then(function (id) {
+    .then(function (result) {
         // Log success
-        console.log('Push sent successfully! (ID: ' + id + ')');
+        console.log('Push sent successfully! (ID: ' + result.id + ')');
     }).catch(function (err) {
         // Log errors to console
         return console.error(err);
@@ -79,14 +79,14 @@ pushy.sendPushNotification(data, tokens, options)
 Instantly send push notifications to your users using the [Send Notifications API](https://pushy.me/docs/api/send-notifications) (see example above):
 
 ```js
-pushy.sendPushNotification(data, to, options, function (err, id) {
+pushy.sendPushNotification(data, to, options, function (err, result) {
     // Log errors to console
     if (err) {
         return console.error(err);
     }
     
     // Log success
-    console.log('Push sent successfully! (ID: ' + id + ')');
+    console.log('Push sent successfully! (ID: ' + result.id + ')');
 });
 ```
 

package/api/device/info.js

@@ -1,5 +1,4 @@
-var request = require('request');
-var Promise = require('bluebird');
+var axios = require('axios');
 
 // Device Info API
 module.exports = function (deviceToken, callback) {
@@ -20,17 +19,14 @@ module.exports = function (deviceToken, callback) {
         }
 
         // Make a request to the Device Info API
-        request(
+        axios(
             Object.assign({
-                uri: that.getApiEndpoint() + '/devices/' + deviceToken + '?api_key=' + that.apiKey,
+                url: that.getApiEndpoint() + '/devices/' + deviceToken + '?api_key=' + that.apiKey,
                 method: 'GET',
                 json: true
-            }, that.extraRequestOptions || {}), function (err, res, body) {
-                // Request error?
-                if (err) {
-                    // Send to callback
-                    return reject(err);
-                }
+            }, that.extraRequestOptions || {})).then(function (res) {
+                // API response
+                var body = res.data;
 
                 // Missing body?
                 if (!body) {
@@ -43,7 +39,7 @@ module.exports = function (deviceToken, callback) {
                 }
 
                 // Check for 200 OK
-                if (res.statusCode != 200) {
+                if (res.status != 200) {
                     return reject(new Error('An invalid response code was received from the Pushy API.'));
                 }
 
@@ -59,6 +55,14 @@ module.exports = function (deviceToken, callback) {
                     // Resolve the promise
                     resolve(deviceInfo);
                 }
+            }).catch(function (err) {
+                // Invoke callback/reject promise with Pushy error
+                if (err.response && err.response.data) {
+                    reject(err.response.data);
+                }
+                else {
+                    reject(err);
+                }
             });
     });
 }

package/api/device/presence.js

@@ -1,5 +1,4 @@
-var request = require('request');
-var Promise = require('bluebird');
+var axios = require('axios');
 
 // Device Presence API
 module.exports = function (deviceTokens, callback) {
@@ -40,17 +39,14 @@ module.exports = function (deviceTokens, callback) {
         postData.tokens = deviceTokens;
 
         // Make a request to the Device Presence API
-        request(
+        axios(
             Object.assign({
-                uri: that.getApiEndpoint() + '/devices/presence' + '?api_key=' + that.apiKey,
+                url: that.getApiEndpoint() + '/devices/presence' + '?api_key=' + that.apiKey,
                 method: 'POST',
-                json: postData
-            }, that.extraRequestOptions || {}), function (err, res, body) {
-                // Request error?
-                if (err) {
-                    // Send to callback
-                    return reject(err);
-                }
+                data: postData
+            }, that.extraRequestOptions || {})).then(function (res) {
+                // API response
+                var body = res.data;
 
                 // Missing body?
                 if (!body) {
@@ -63,7 +59,7 @@ module.exports = function (deviceTokens, callback) {
                 }
 
                 // Check for 200 OK
-                if (res.statusCode != 200) {
+                if (res.status != 200) {
                     return reject(new Error('An invalid response code was received from the Pushy API.'));
                 }
 
@@ -79,6 +75,14 @@ module.exports = function (deviceTokens, callback) {
                     // Resolve the promise
                     resolve(devicePresence);
                 }
+            }).catch(function (err) {
+                // Invoke callback/reject promise with Pushy error
+                if (err.response && err.response.data) {
+                    reject(err.response.data);
+                }
+                else {
+                    reject(err);
+                }
             });
     });
 }

package/api/pubsub/subscribe.js

@@ -1,5 +1,4 @@
-var request = require('request');
-var Promise = require('bluebird');
+var axios = require('axios');
 
 // Pub/Sub Subscribe API
 module.exports = function (topics, deviceToken, callback) {
@@ -34,17 +33,14 @@ module.exports = function (topics, deviceToken, callback) {
         postData.topics = Array.isArray(topics) ? topics : [topics];
 
         // Make a request to the Pub/Sub Subscribe API
-        request(
+        axios(
             Object.assign({
-                uri: that.getApiEndpoint() + '/topics/subscribe/' + '?api_key=' + that.apiKey,
+                url: that.getApiEndpoint() + '/topics/subscribe/' + '?api_key=' + that.apiKey,
                 method: 'POST',
-                json: postData
-            }, that.extraRequestOptions || {}), function (err, res, body) {
-                // Request error?
-                if (err) {
-                    // Send to callback
-                    return reject(err);
-                }
+                data: postData
+            }, that.extraRequestOptions || {})).then(function (res) {
+                // API response
+                var body = res.data;
 
                 // Missing body?
                 if (!body) {
@@ -57,7 +53,7 @@ module.exports = function (topics, deviceToken, callback) {
                 }
 
                 // Check for 200 OK
-                if (res.statusCode != 200) {
+                if (res.status != 200) {
                     return reject(new Error('An invalid response code was received from the Pushy API.'));
                 }
 
@@ -70,6 +66,14 @@ module.exports = function (topics, deviceToken, callback) {
                     // Resolve the promise successfully
                     resolve();
                 }
+            }).catch(function (err) {
+                // Invoke callback/reject promise with Pushy error
+                if (err.response && err.response.data) {
+                    reject(err.response.data);
+                }
+                else {
+                    reject(err);
+                }
             });
     });
 }

package/api/pubsub/subscribers.js

@@ -1,5 +1,4 @@
-var request = require('request');
-var Promise = require('bluebird');
+var axios = require('axios');
 
 // Pub/Sub Subscribers API
 module.exports = function (topic, callback) {
@@ -20,17 +19,14 @@ module.exports = function (topic, callback) {
         }
 
         // Make a request to the Pub/Sub Subscribers API
-        request(
+        axios(
             Object.assign({
-                uri: that.getApiEndpoint() + '/topics/' + topic + '?api_key=' + that.apiKey,
+                url: that.getApiEndpoint() + '/topics/' + topic + '?api_key=' + that.apiKey,
                 method: 'GET',
                 json: true
-            }, that.extraRequestOptions || {}), function (err, res, body) {
-                // Request error?
-                if (err) {
-                    // Send to callback
-                    return reject(err);
-                }
+            }, that.extraRequestOptions || {})).then(function (res) {
+                // API response
+                var body = res.data;
 
                 // Missing body?
                 if (!body) {
@@ -43,7 +39,7 @@ module.exports = function (topic, callback) {
                 }
 
                 // Check for 200 OK
-                if (res.statusCode != 200) {
+                if (res.status != 200) {
                     return reject(new Error('An invalid response code was received from the Pushy API.'));
                 }
 
@@ -59,6 +55,14 @@ module.exports = function (topic, callback) {
                     // Resolve the promise
                     resolve(body);
                 }
+            }).catch(function (err) {
+                // Invoke callback/reject promise with Pushy error
+                if (err.response && err.response.data) {
+                    reject(err.response.data);
+                }
+                else {
+                    reject(err);
+                }
             });
     });
 }

package/api/pubsub/topics.js

@@ -1,5 +1,4 @@
-var request = require('request');
-var Promise = require('bluebird');
+var axios = require('axios');
 
 // Pub/Sub Topics API
 module.exports = function (callback) {
@@ -15,17 +14,14 @@ module.exports = function (callback) {
         }
 
         // Make a request to the Pub/Sub Topics API
-        request(
+        axios(
             Object.assign({
-                uri: that.getApiEndpoint() + '/topics/' + '?api_key=' + that.apiKey,
+                url: that.getApiEndpoint() + '/topics/' + '?api_key=' + that.apiKey,
                 method: 'GET',
                 json: true
-            }, that.extraRequestOptions || {}), function (err, res, body) {
-                // Request error?
-                if (err) {
-                    // Send to callback
-                    return reject(err);
-                }
+            }, that.extraRequestOptions || {})).then(function (res) {
+                // API response
+                var body = res.data;
 
                 // Missing body?
                 if (!body) {
@@ -38,7 +34,7 @@ module.exports = function (callback) {
                 }
 
                 // Check for 200 OK
-                if (res.statusCode != 200) {
+                if (res.status != 200) {
                     return reject(new Error('An invalid response code was received from the Pushy API.'));
                 }
 
@@ -54,6 +50,14 @@ module.exports = function (callback) {
                     // Resolve the promise
                     resolve(body);
                 }
+            }).catch(function (err) {
+                // Invoke callback/reject promise with Pushy error
+                if (err.response && err.response.data) {
+                    reject(err.response.data);
+                }
+                else {
+                    reject(err);
+                }
             });
     });
 }

package/api/pubsub/unsubscribe.js

@@ -1,5 +1,4 @@
-var request = require('request');
-var Promise = require('bluebird');
+var axios = require('axios');
 
 // Pub/Sub Unsubscribe API
 module.exports = function (topics, deviceToken, callback) {
@@ -34,17 +33,14 @@ module.exports = function (topics, deviceToken, callback) {
         postData.topics = Array.isArray(topics) ? topics : [topics];
 
         // Make a request to the Pub/Sub Unsubscribe API
-        request(
+        axios(
             Object.assign({
-                uri: that.getApiEndpoint() + '/topics/unsubscribe/' + '?api_key=' + that.apiKey,
+                url: that.getApiEndpoint() + '/topics/unsubscribe/' + '?api_key=' + that.apiKey,
                 method: 'POST',
-                json: postData
-            }, that.extraRequestOptions || {}), function (err, res, body) {
-                // Request error?
-                if (err) {
-                    // Send to callback
-                    return reject(err);
-                }
+                data: postData
+            }, that.extraRequestOptions || {})).then(function (res) {
+                // API response
+                var body = res.data;
 
                 // Missing body?
                 if (!body) {
@@ -57,7 +53,7 @@ module.exports = function (topics, deviceToken, callback) {
                 }
 
                 // Check for 200 OK
-                if (res.statusCode != 200) {
+                if (res.status != 200) {
                     return reject(new Error('An invalid response code was received from the Pushy API.'));
                 }
 
@@ -70,6 +66,14 @@ module.exports = function (topics, deviceToken, callback) {
                     // Resolve the promise successfully
                     resolve();
                 }
+            }).catch(function (err) {
+                // Invoke callback/reject promise with Pushy error
+                if (err.response && err.response.data) {
+                    reject(err.response.data);
+                }
+                else {
+                    reject(err);
+                }
             });
     });
 }

package/api/push/delete.js

@@ -1,5 +1,4 @@
-var request = require('request');
-var Promise = require('bluebird')
+var axios = require('axios');
 
 // Notification Deletion API
 module.exports = function (pushId, callback) {
@@ -30,17 +29,14 @@ module.exports = function (pushId, callback) {
         }
 
         // Make a request to the Notification Deletion API
-        request(
+        axios(
             Object.assign({
-                uri: that.getApiEndpoint() + '/pushes/' + pushId + '?api_key=' + that.apiKey,
+                url: that.getApiEndpoint() + '/pushes/' + pushId + '?api_key=' + that.apiKey,
                 method: 'DELETE',
                 json: true
-            }, that.extraRequestOptions || {}), function (err, res, body) {
-                // Request error?
-                if (err) {
-                    // Send to callback
-                    return reject(err);
-                }
+            }, that.extraRequestOptions || {})).then(function (res) {
+                // API response
+                var body = res.data;
 
                 // Missing body?
                 if (!body) {
@@ -53,7 +49,7 @@ module.exports = function (pushId, callback) {
                 }
 
                 // Check for 200 OK
-                if (res.statusCode != 200) {
+                if (res.status != 200) {
                     return reject(new Error('An invalid response code was received from the Pushy API.'));
                 }
 
@@ -66,6 +62,14 @@ module.exports = function (pushId, callback) {
                     // Resolve the promise
                     resolve();
                 }
+            }).catch(function (err) {
+                // Invoke callback/reject promise with Pushy error
+                if (err.response && err.response.data) {
+                    reject(err.response.data);
+                }
+                else {
+                    reject(err);
+                }
             });
     });
 };

package/api/push/send.js

@@ -1,5 +1,4 @@
-var request = require('request');
-var Promise = require('bluebird');
+var axios = require('axios');
 
 // Send Notifications API
 module.exports = function (data, recipient, options, callback) {
@@ -59,17 +58,14 @@ module.exports = function (data, recipient, options, callback) {
         }
 
         // Make a request to the Send Notifications API
-        request(
+        axios(
             Object.assign({
-                uri: that.getApiEndpoint() + '/push?api_key=' + that.apiKey,
+                url: that.getApiEndpoint() + '/push?api_key=' + that.apiKey,
                 method: 'POST',
-                json: postData
-            }, that.extraRequestOptions || {}), function (err, res, body) {
-                // Request error?
-                if (err) {
-                    // Send to callback
-                    return reject(err);
-                }
+                data: postData
+            }, that.extraRequestOptions || {})).then(function (res) {
+                // API response
+                var body = res.data;
 
                 // Missing body?
                 if (!body) {
@@ -82,21 +78,26 @@ module.exports = function (data, recipient, options, callback) {
                 }
 
                 // Check for 200 OK
-                if (res.statusCode != 200) {
+                if (res.status != 200) {
                     return reject(new Error('An invalid response code was received from the Pushy API.'));
                 }
 
-                // Fetch push notification ID
-                var pushId = body.id;
-
                 // Callback?
                 if (callback) {
-                    // Pass push ID to callback with a null error
-                    callback(null, pushId);
+                    // Pass response body to callback with a null error
+                    callback(null, body);
+                }
+                else {
+                    // Resolve the promise with response body
+                    resolve(body);
+                }
+            }).catch(function (err) {
+                // Invoke callback/reject promise with Pushy error
+                if (err.response && err.response.data) {
+                    reject(err.response.data);
                 }
                 else {
-                    // Resolve the promise
-                    resolve(pushId);
+                    reject(err);
                 }
             });
     });

package/api/push/status.js

@@ -1,5 +1,4 @@
-var request = require('request');
-var Promise = require('bluebird');
+var axios = require('axios');
 
 // Notification Status API
 module.exports = function (pushId, callback) {
@@ -20,17 +19,14 @@ module.exports = function (pushId, callback) {
         }
 
         // Make a request to the Notification Status API
-        request(
+        axios(
             Object.assign({
-                uri: that.getApiEndpoint() + '/pushes/' + pushId + '?api_key=' + that.apiKey,
+                url: that.getApiEndpoint() + '/pushes/' + pushId + '?api_key=' + that.apiKey,
                 method: 'GET',
                 json: true
-            }, that.extraRequestOptions || {}), function (err, res, body) {
-                // Request error?
-                if (err) {
-                    // Send to callback
-                    return reject(err);
-                }
+            }, that.extraRequestOptions || {})).then(function (res) {
+                // API response
+                var body = res.data;
 
                 // Missing body?
                 if (!body) {
@@ -43,7 +39,7 @@ module.exports = function (pushId, callback) {
                 }
 
                 // Check for 200 OK
-                if (res.statusCode != 200) {
+                if (res.status != 200) {
                     return reject(new Error('An invalid response code was received from the Pushy API.'));
                 }
 
@@ -59,6 +55,14 @@ module.exports = function (pushId, callback) {
                     // Resolve the promise
                     resolve(status);
                 }
+            }).catch(function (err) {
+                // Invoke callback/reject promise with Pushy error
+                if (err.response && err.response.data) {
+                    reject(err.response.data);
+                }
+                else {
+                    reject(err);
+                }
             });
     });
 }

package/examples/push.js

@@ -23,14 +23,14 @@ var options = {
 };
 
 // Send push notification using the Send Notifications API
-pushy.sendPushNotification(data, to, options, function (err, id) {
+pushy.sendPushNotification(data, to, options, function (err, result) {
     // Log errors to console
     if (err) {
         return console.error(err);
     }
 
     // Log success
-    console.log('Push sent successfully! (ID: ' + id + ')');
+    console.log('Push sent successfully! (ID: ' + result.id + ')');
 });
 
 // Check the delivery status of your push notifications using the Notification Status API

package/index.d.ts

@@ -110,6 +110,33 @@ declare module 'pushy' {
         };
     }
 
+    interface SendPushNotificationResult {
+        /** Returned if the API request was successful.	 */
+        success: boolean;
+
+        /**
+         * The push notification unique ID.
+         *
+         * Use it to check delivery status using the Notification Status API.
+         */
+        id: string;
+
+        /**
+         * Contains additional information about the notification, for debugging purposes.
+         */
+        info: {
+            /**
+             * The number of devices that will potentially receive the notification.
+             */
+            devices: number;
+
+            /**
+             * An array of invalid device tokens passed in which could not be found in our
+             * database registered under the app with the Secret API Key used to authenticate this request.
+             */
+            failed: Array<string>;
+        };
+    }
     interface NotificationStatus {
         /** The creation date of the push notification (unix timestamp). */
         date: number;
@@ -242,9 +269,9 @@ declare module 'pushy' {
         sendPushNotification(
             data: unknown,
             recipient: string | Array<string>,
-            options?: SendPushNotificationOptions,
-            callback?: (error: Error | null, pushId: string) => void
-        ): Promise<string>;
+            options?: Partial<SendPushNotificationOptions>,
+            callback?: (error: Error | null, result: SendPushNotificationResult) => void
+        ): Promise<SendPushNotificationResult>;
 
         /**
          * Check the delivery status of your push notifications to Android / Electron recipients.
@@ -252,7 +279,10 @@ declare module 'pushy' {
          *
          * @param pushId
          */
-        getNotificationStatus(pushId: string): Promise<NotificationStatus>;
+        getNotificationStatus(
+            pushId: string,
+            callback?: (error: Error | null, status: NotificationStatus) => void
+        ): Promise<NotificationStatus>;
 
         /**
          * Permanently delete a pending notification.
@@ -260,7 +290,7 @@ declare module 'pushy' {
          *
          * @param pushId
          */
-        deletePushNotification(pushId: string): Promise<void>;
+        deletePushNotification(pushId: string, callback?: (error: Error | null) => void): Promise<void>;
 
         /**
          * Check the presence and connectivity status of multiple devices.
@@ -268,7 +298,10 @@ declare module 'pushy' {
          *
          * @param deviceTokens
          */
-        getDevicePresence(deviceTokens: string | Array<string>): Promise<Array<DevicePresenceInfo>>;
+        getDevicePresence(
+            deviceTokens: string | Array<string>,
+            callback?: (error: Error | null, presence: Array<DevicePresenceInfo>) => void
+        ): Promise<Array<DevicePresenceInfo>>;
 
         /**
          * Fetch device info, presence, undelivered notifications, and more by device token.
@@ -277,7 +310,10 @@ declare module 'pushy' {
          *
          * @param deviceToken
          */
-        getDeviceInfo(deviceToken: string): Promise<DeviceInfo>;
+        getDeviceInfo(
+            deviceToken: string,
+            callback?: (error: Error | null, device: DeviceInfo) => void
+        ): Promise<DeviceInfo>;
 
         /**
          * Subscribe a device to one or more topics.
@@ -286,7 +322,11 @@ declare module 'pushy' {
          * @param topics
          * @param deviceToken
          */
-        subscribe(topics: string | Array<string>, deviceToken: string): Promise<void>;
+        subscribe(
+            topics: string | Array<string>,
+            deviceToken: string,
+            callback?: (error: Error | null) => void
+        ): Promise<void>;
 
         /**
          * Unsubscribe a device from one or more topics.
@@ -295,7 +335,11 @@ declare module 'pushy' {
          * @param topics
          * @param deviceToken
          */
-        unsubscribe(topics: string | Array<string>, deviceToken: string): Promise<void>;
+        unsubscribe(
+            topics: string | Array<string>,
+            deviceToken: string,
+            callback?: (error: Error | null) => void
+        ): Promise<void>;
 
         /**
          * Retrieve a list of your app's topics and subscribers count.
@@ -309,6 +353,9 @@ declare module 'pushy' {
          *
          * @param topic The Pub/Sub topic to retrieve subscribers for. Topics are case-sensitive and must match the following regular expression: [a-zA-Z0-9-_.]+.
          */
-        getSubscribers(topic: string): Promise<TopicSuscribers>;
+        getSubscribers(
+            topic: string,
+            callback?: (error: Error | null, subscribers: TopicSuscribers) => void
+        ): Promise<TopicSuscribers>;
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pushy",
-  "version": "2.0.14",
+  "version": "3.0.2",
   "description": "The official Node.js package for sending push notifications with Pushy.",
   "main": "index.js",
   "scripts": {
@@ -17,7 +17,6 @@
   },
   "homepage": "https://github.com/pushy/pushy-node#readme",
   "dependencies": {
-    "bluebird": "^3.4.1",
-    "request": "^2.72.0"
+    "axios": "^0.27.2"
   }
 }