@parse/push-adapter 6.1.0 → 6.2.0

package/README.md

@@ -20,6 +20,7 @@ The official Push Notification adapter for Parse Server. See [Parse Server Push
 - [Using a Custom Version on Parse Server](#using-a-custom-version-on-parse-server)
   - [Install Push Adapter](#install-push-adapter)
   - [Configure Parse Server](#configure-parse-server)
+    - [Expo Push Options](#expo-push-options)
 
 # Silent Notifications
 
@@ -57,16 +58,32 @@ const parseServerOptions = {
   push: {
     adapter: new PushAdapter({
       ios: {
-        /* Apple push notification options */
+        /* Apple push options */
       },
       android: {
         /* Android push options */
-      }
+      },
       web: {
         /* Web push options */
-      }
-    })
+      },
+      expo: {
+        /* Expo push options */
+      },
+    }),
   },
   /* Other Parse Server options */
 }
 ```
+
+### Expo Push Options
+
+Example options:
+
+```js
+expo: {
+  accessToken: '<EXPO_ACCESS_TOKEN>',
+},
+```
+
+For more information see the [Expo docs](https://docs.expo.dev/push-notifications/overview/).
+         

package/lib/EXPO.js

@@ -0,0 +1,204 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.EXPO = undefined;
+
+var _typeof = typeof Symbol === "function" && typeof Symbol.iterator === "symbol" ? function (obj) { return typeof obj; } : function (obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; };
+
+var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
+
+var _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; };
+
+var _parse = require('parse');
+
+var _parse2 = _interopRequireDefault(_parse);
+
+var _npmlog = require('npmlog');
+
+var _npmlog2 = _interopRequireDefault(_npmlog);
+
+var _expoServerSdk = require('expo-server-sdk');
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function _objectWithoutProperties(obj, keys) { var target = {}; for (var i in obj) { if (keys.indexOf(i) >= 0) continue; if (!Object.prototype.hasOwnProperty.call(obj, i)) continue; target[i] = obj[i]; } return target; }
+
+function _asyncToGenerator(fn) { return function () { var gen = fn.apply(this, arguments); return new Promise(function (resolve, reject) { function step(key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { return Promise.resolve(value).then(function (value) { step("next", value); }, function (err) { step("throw", err); }); } } return step("next"); }); }; }
+
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+
+var LOG_PREFIX = 'parse-server-push-adapter EXPO';
+
+function expoResultToParseResponse(result) {
+  if (result.status === 'ok') {
+    return result;
+  } else {
+    // ParseServer looks for "error", and supports ceratin codes like 'NotRegistered' for
+    // cleanup. Expo returns slighyly different ones so changing to match what is expected
+    // This can be taken out if the responsibility gets moved to the adapter itself.
+    var error = result.message === 'DeviceNotRegistered' ? 'NotRegistered' : result.message;
+    return _extends({
+      error: error
+    }, result);
+  }
+}
+
+var EXPO = exports.EXPO = function () {
+  /**
+   * Create a new EXPO push adapter. Based on Web Adapter.
+   *
+   * @param {Object} args https://github.com/expo/expo-server-sdk-node / https://docs.expo.dev/push-notifications/sending-notifications/
+   */
+  function EXPO(args) {
+    _classCallCheck(this, EXPO);
+
+    this.expo = undefined;
+
+    if ((typeof args === 'undefined' ? 'undefined' : _typeof(args)) !== 'object') {
+      throw new _parse2.default.Error(_parse2.default.Error.PUSH_MISCONFIGURED, 'EXPO Push Configuration is invalid');
+    }
+
+    this.expo = new _expoServerSdk.Expo(args);
+    this.options = args;
+  }
+
+  /**
+   * Send Expo push notification request.
+   *
+   * @param {Object} data The data we need to send, the format is the same with api request body
+   * @param {Array} devices An array of devices
+   * @returns {Object} A promise which is resolved immediately
+   */
+
+
+  _createClass(EXPO, [{
+    key: 'send',
+    value: function () {
+      var _ref = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee(data, devices) {
+        var coreData, devicesMap, deviceTokens, resolvers, promises, length, response;
+        return regeneratorRuntime.wrap(function _callee$(_context) {
+          while (1) {
+            switch (_context.prev = _context.next) {
+              case 0:
+                coreData = data && data.data;
+
+                if (!(!coreData || !devices || !Array.isArray(devices))) {
+                  _context.next = 4;
+                  break;
+                }
+
+                _npmlog2.default.warn(LOG_PREFIX, 'invalid push payload');
+                return _context.abrupt('return');
+
+              case 4:
+                devicesMap = devices.reduce(function (memo, device) {
+                  memo[device.deviceToken] = device;
+                  return memo;
+                }, {});
+                deviceTokens = Object.keys(devicesMap);
+                resolvers = [];
+                promises = deviceTokens.map(function () {
+                  return new Promise(function (resolve) {
+                    return resolvers.push(resolve);
+                  });
+                });
+                length = deviceTokens.length;
+
+
+                _npmlog2.default.verbose(LOG_PREFIX, 'sending to ' + length + ' ' + (length > 1 ? 'devices' : 'device'));
+
+                _context.next = 12;
+                return this.sendNotifications(coreData, deviceTokens);
+
+              case 12:
+                response = _context.sent;
+
+
+                _npmlog2.default.verbose(LOG_PREFIX, 'EXPO Response: %d sent', response.length);
+
+                deviceTokens.forEach(function (token, index) {
+                  var resolve = resolvers[index];
+                  var result = response[index];
+                  var device = devicesMap[token];
+                  var resolution = {
+                    transmitted: result.status === 'ok',
+                    device: _extends({}, device, {
+                      pushType: 'expo'
+                    }),
+                    response: expoResultToParseResponse(result)
+                  };
+                  resolve(resolution);
+                });
+                return _context.abrupt('return', Promise.all(promises));
+
+              case 16:
+              case 'end':
+                return _context.stop();
+            }
+          }
+        }, _callee, this);
+      }));
+
+      function send(_x, _x2) {
+        return _ref.apply(this, arguments);
+      }
+
+      return send;
+    }()
+
+    /**
+     * Send multiple Expo push notification request.
+     *
+     * @param {Object} payload The data we need to send, the format is the same with api request body
+     * @param {Array} deviceTokens An array of devicesTokens
+     * @param {Object} options The options for the request
+     * @returns {Object} A promise which is resolved immediately
+     */
+
+  }, {
+    key: 'sendNotifications',
+    value: function () {
+      var _ref2 = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee2(_ref3, deviceTokens) {
+        var alert = _ref3.alert,
+            body = _ref3.body,
+            payload = _objectWithoutProperties(_ref3, ['alert', 'body']);
+
+        var messages;
+        return regeneratorRuntime.wrap(function _callee2$(_context2) {
+          while (1) {
+            switch (_context2.prev = _context2.next) {
+              case 0:
+                messages = deviceTokens.map(function (token) {
+                  return _extends({
+                    to: token,
+                    body: body || alert
+                  }, payload);
+                });
+                _context2.next = 3;
+                return this.expo.sendPushNotificationsAsync(messages);
+
+              case 3:
+                return _context2.abrupt('return', _context2.sent);
+
+              case 4:
+              case 'end':
+                return _context2.stop();
+            }
+          }
+        }, _callee2, this);
+      }));
+
+      function sendNotifications(_x3, _x4) {
+        return _ref2.apply(this, arguments);
+      }
+
+      return sendNotifications;
+    }()
+  }]);
+
+  return EXPO;
+}();
+
+exports.default = EXPO;

package/lib/FCM.js

@@ -162,15 +162,20 @@ function _APNSToFCMPayload(requestData) {
         apnsPayload['apns']['payload']['aps'] = coreData.aps;
         break;
       case 'alert':
-        if (!apnsPayload['apns']['payload']['aps'].hasOwnProperty('alert')) {
+        if (_typeof(coreData.alert) == 'object') {
+          // When we receive a dictionary, use as is to remain
+          // compatible with how the APNS.js + node-apn work
+          apnsPayload['apns']['payload']['aps']['alert'] = coreData.alert;
+        } else {
+          // When we receive a value, prepare `alert` dictionary
+          // and set its `body` property
           apnsPayload['apns']['payload']['aps']['alert'] = {};
+          apnsPayload['apns']['payload']['aps']['alert']['body'] = coreData.alert;
         }
-        // In APNS.js we set a body with the same value as alert in requestData.
-        // See L200 in APNS.spec.js
-        apnsPayload['apns']['payload']['aps']['alert']['body'] = coreData.alert;
         break;
       case 'title':
         // Ensure the alert object exists before trying to assign the title
+        // title always goes into the nested `alert` dictionary
         if (!apnsPayload['apns']['payload']['aps'].hasOwnProperty('alert')) {
           apnsPayload['apns']['payload']['aps']['alert'] = {};
         }
@@ -217,7 +222,8 @@ function _APNSToFCMPayload(requestData) {
   return apnsPayload;
 }
 
-function _GCMToFCMPayload(requestData, timeStamp) {
+function _GCMToFCMPayload(requestData, pushId, timeStamp) {
+
   var androidPayload = {
     android: {
       priority: 'high'
@@ -257,7 +263,11 @@ function _GCMToFCMPayload(requestData, timeStamp) {
       }
     }
 
-    androidPayload.android.data = requestData.data;
+    androidPayload.android.data = {
+      push_id: pushId,
+      time: new Date(timeStamp).toISOString(),
+      data: JSON.stringify(requestData.data)
+    };
   }
 
   if (requestData['expiration_time']) {
@@ -283,10 +293,11 @@ function _GCMToFCMPayload(requestData, timeStamp) {
  * If the key rawPayload is present in the requestData, a raw payload will be used. Otherwise, conversion is done.
  * @param {Object} requestData The request body
  * @param {String} pushType Either apple or android.
- * @param {Number} timeStamp Used during GCM payload conversion for ttl
+ * @param {String} pushId Used during GCM payload conversion, required by Parse Android SDK.
+ * @param {Number} timeStamp Used during GCM payload conversion for ttl, required by Parse Android SDK.
  * @returns {Object} A FCMv1-compatible payload.
  */
-function payloadConverter(requestData, pushType, timeStamp) {
+function payloadConverter(requestData, pushType, pushId, timeStamp) {
   if (requestData.hasOwnProperty('rawPayload')) {
     return requestData.rawPayload;
   }
@@ -294,7 +305,7 @@ function payloadConverter(requestData, pushType, timeStamp) {
   if (pushType === 'apple') {
     return _APNSToFCMPayload(requestData);
   } else if (pushType === 'android') {
-    return _GCMToFCMPayload(requestData, timeStamp);
+    return _GCMToFCMPayload(requestData, pushId, timeStamp);
   } else {
     throw new _parse2.default.Error(_parse2.default.Error.PUSH_MISCONFIGURED, 'Unsupported push type, apple or android only.');
   }
@@ -313,12 +324,10 @@ function generateFCMPayload(requestData, pushId, timeStamp, deviceTokens, pushTy
   delete requestData['where'];
 
   var payloadToUse = {
-    data: {},
-    push_id: pushId,
-    time: new Date(timeStamp).toISOString()
+    data: {}
   };
 
-  var fcmPayload = payloadConverter(requestData, pushType, timeStamp);
+  var fcmPayload = payloadConverter(requestData, pushType, pushId, timeStamp);
   payloadToUse.data = _extends({}, fcmPayload, {
     tokens: deviceTokens
   });

package/lib/ParsePushAdapter.js

@@ -30,6 +30,10 @@ var _WEB = require('./WEB');
 
 var _WEB2 = _interopRequireDefault(_WEB);
 
+var _EXPO = require('./EXPO');
+
+var _EXPO2 = _interopRequireDefault(_EXPO);
+
 var _PushAdapterUtils = require('./PushAdapterUtils');
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
@@ -46,7 +50,7 @@ var ParsePushAdapter = function () {
 
     this.supportsPushTracking = true;
 
-    this.validPushTypes = ['ios', 'osx', 'tvos', 'android', 'fcm', 'web'];
+    this.validPushTypes = ['ios', 'osx', 'tvos', 'android', 'fcm', 'web', 'expo'];
     this.senderMap = {};
     // used in PushController for Dashboard Features
     this.feature = {
@@ -79,6 +83,9 @@ var ParsePushAdapter = function () {
           case 'web':
             this.senderMap[pushType] = new _WEB2.default(pushConfig[pushType]);
             break;
+          case 'expo':
+            this.senderMap[pushType] = new _EXPO2.default(pushConfig[pushType]);
+            break;
           case 'android':
           case 'fcm':
             if (pushConfig[pushType].hasOwnProperty('firebaseServiceAccount')) {

package/lib/index.js

@@ -6,7 +6,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.utils = exports.WEB = exports.GCM = exports.APNS = exports.ParsePushAdapter = undefined;
+exports.utils = exports.EXPO = exports.WEB = exports.GCM = exports.APNS = exports.ParsePushAdapter = undefined;
 
 var _npmlog = require('npmlog');
 
@@ -28,6 +28,10 @@ var _WEB = require('./WEB');
 
 var _WEB2 = _interopRequireDefault(_WEB);
 
+var _EXPO = require('./EXPO');
+
+var _EXPO2 = _interopRequireDefault(_EXPO);
+
 var _PushAdapterUtils = require('./PushAdapterUtils');
 
 var utils = _interopRequireWildcard(_PushAdapterUtils);
@@ -44,4 +48,5 @@ exports.ParsePushAdapter = _ParsePushAdapter2.default;
 exports.APNS = _APNS2.default;
 exports.GCM = _GCM2.default;
 exports.WEB = _WEB2.default;
+exports.EXPO = _EXPO2.default;
 exports.utils = utils;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@parse/push-adapter",
-  "version": "6.1.0",
+  "version": "6.2.0",
   "description": "Base parse-server-push-adapter",
   "main": "lib/index.js",
   "files": [
@@ -25,7 +25,8 @@
   "dependencies": {
     "@parse/node-apn": "6.0.1",
     "@parse/node-gcm": "1.0.2",
-    "firebase-admin": "12.0.0",
+    "expo-server-sdk": "3.10.0",
+    "firebase-admin": "12.1.0",
     "npmlog": "7.0.1",
     "parse": "5.0.0",
     "web-push": "3.6.7"