Merge upstream

README.md

@@ -30,11 +30,11 @@ $ npm install node-gcm --save
 
 ## Requirements
 
-This library provides the server-side implementation of GCM.
-You need to generate an [API Key](https://developers.google.com/cloud-messaging/gcm#apikey).
+This library provides the server-side implementation of FCM.
+You need to generate an [API Key](https://console.firebase.google.com/u/0/) (Click the gear next to FCM project name) > Project Settings > Cloud Messaging -> **Server Key**).
 
-GCM notifications can be sent to both [Android](https://developers.google.com/cloud-messaging/android/start) and [iOS](https://developers.google.com/cloud-messaging/ios/start).
-If you are new to GCM you should probably look into the [documentation](https://developers.google.com/cloud-messaging/gcm).
+FCM notifications can be sent to both [Android](https://firebase.google.com/docs/cloud-messaging/android/client) and [iOS](https://firebase.google.com/docs/cloud-messaging/ios/client).
+If you are new to FCM you should probably look into the [documentation](https://firebase.google.com/docs/cloud-messaging).
 
 ## Example application
 
@@ -128,14 +128,11 @@ sender.send(message, { registrationTokens: registrationTokens }, 10, function (e
   else    console.log(response);
 });
 
-// Q: I need to remove all "bad" token from my database, how do I do that? 
+// Q: I need to remove all "bad" token from my database, how do I do that?
 //    The results-array does not contain any tokens!
 // A: The array of tokens used for sending will match the array of results, so you can cross-check them.
-sender.send(message, { registrationTokens: registrationTokens }, function (err, response) {  
-  var failed_tokens = response.results                           // Array with result for each token we messaged
-    .map((res, i) => res.error ? registrationTokens[i] : null)   // If there's any kind of error, 
-                                                                 // pick _the token_ from the _other_ array
-    .filter(token => token);                                     // Remove all the null values
+sender.send(message, { registrationTokens: registrationTokens }, function (err, response) {
+  var failed_tokens = registrationTokens.filter((token, i) => response[i].error != null);
   console.log('These tokens are no longer ok:', failed_tokens);
 });
 ```
@@ -146,7 +143,7 @@ You can send push notifications to various recipient types by providing one of t
 
 |Key|Type|Description|
 |---|---|---|
-|to|String|A single [registration token](https://developers.google.com/cloud-messaging/android/client#sample-register), [notification key](https://developers.google.com/cloud-messaging/notifications), or [topic](https://developers.google.com/cloud-messaging/topic-messaging).
+|to|String|A single [registration token](https://firebase.google.com/docs/cloud-messaging/android/client#sample-register), [notification key](https://firebase.google.com/docs/cloud-messaging/android/device-group), or [topic](https://firebase.google.com/docs/cloud-messaging/android/topic-messaging).
 |topic|String|A single publish/subscribe topic.
 |condition|String|Multiple topics using the [condition](https://firebase.google.com/docs/cloud-messaging/topic-messaging) parameter.
 |notificationKey|String|Deprecated. A key that groups multiple registration tokens linked to the same user.
@@ -156,7 +153,7 @@ You can send push notifications to various recipient types by providing one of t
 If you provide an incorrect recipient key or object type, an `Error` object will be returned to your callback.
 
 Notice that [you can *at most* send notifications to 1000 registration tokens at a time](https://github.com/ToothlessGear/node-gcm/issues/42).
-This is due to [a restriction](http://developer.android.com/training/cloudsync/gcm.html) on the side of the GCM API.
+This is due to [a restriction](https://firebase.google.com/docs/cloud-messaging/http-server-ref#downstream-http-messages-json) on the side of the FCM API.
 
 
 ### Additional message options
@@ -166,11 +163,13 @@ This is due to [a restriction](http://developer.android.com/training/cloudsync/g
 |collapseKey|Optional, string|This parameter identifies a group of messages that can be collapsed, so that only the last message gets sent when delivery can be resumed.|
 |priority|Optional, string|Sets the priority of the message. Valid values are "normal" and "high."|
 |contentAvailable|Optional, JSON boolean|On iOS, when a notification or message is sent and this is set to true, an inactive client app is awoken.|
-|timeToLive|Optional, JSON number|This parameter specifies how long (in seconds) the message should be kept in GCM storage if the device is offline. The maximum time to live supported is 4 weeks, and the default value is 4 weeks.|
+|mutableContent|Optional, JSON boolean|On iOS, Currently for iOS 10+ devices only. On iOS, use this field to represent mutable-content in the APNs payload. When a notification is sent and this is set to true, the content of the notification can be modified before it is displayed, using a Notification Service app extension.|
+|timeToLive|Optional, JSON number|This parameter specifies how long (in seconds) the message should be kept in FCM storage if the device is offline. The maximum time to live supported is 4 weeks, and the default value is 4 weeks.|
 |restrictedPackageName|Optional, string|This parameter specifies the package name of the application where the registration tokens must match in order to receive the message.|
 |dryRun|Optional, JSON boolean|This parameter, when set to true, allows developers to test a request without actually sending a message.|
 |data|Optional, JSON object|This parameter specifies the custom key-value pairs of the message's payload.|
 |notification|Optional, JSON object|This parameter specifies the predefined, user-visible key-value pairs of the notification payload. See "Notification payload option table" below for more details.|
+|fcm_options|Optional, JSON object|This parameter is used to pass FCM specific options, as outlined [here](https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#FcmOptions).
 
 ## Notification usage
 
@@ -211,11 +210,11 @@ message.addNotification({
 |title_loc_args|iOS|Optional, JSON array as string|Indicates the string value to replace format specifiers in title string for localization. On iOS, this corresponds to "title-loc-args" in APNS payload.|
 |title_loc_key|iOS|Optional, string|Indicates the key to the title string for localization. On iOS, this corresponds to "title-loc-key" in APNS payload.|
 
-Notice notification payload defined in [GCM Connection Server Reference](https://developers.google.com/cloud-messaging/server-ref#table1)
+Notice notification payload defined in [FCM Connection Server Reference](https://firebase.google.com/docs/cloud-messaging/http-server-ref#downstream-http-messages-json)
 
 ## Custom HTTP request options
 
-You can provide custom `request` options such as `proxy` and `timeout` for the HTTP request to the GCM API. For more information, refer to [the complete list of request options](https://github.com/request/request#requestoptions-callback). Note that the following options cannot be overriden: `method`, `uri`, `body`, as well as the following headers: `Authorization`, `Content-Type`, and `Content-Length`.
+You can provide custom `request` options such as `proxy` and `timeout` for the HTTP request to the FCM API. For more information, refer to [the complete list of request options](https://github.com/request/request#requestoptions-callback). Note that the following options cannot be overriden: `method`, `uri`, `body`, as well as the following headers: `Authorization`, `Content-Type`, and `Content-Length`.
 
 ```js
 // Set custom request options
@@ -236,9 +235,9 @@ sender.send(message, { registrationTokens: regTokens }, function (err, response)
 });
 ```
 
-## GCM client compatibility
+## FCM client compatibility
 
-As of January 9th, 2016, there are a few known compatibility issues with 3rd-party GCM client libraries:
+As of January 9th, 2016, there are a few known compatibility issues with 3rd-party FCM client libraries:
 
 ### phonegap-plugin-push
 
@@ -250,7 +249,7 @@ These issues are out of this project's context and can only be fixed by the resp
 
 ## Debug
 
-To enable debug mode (print requests and responses to and from GCM),
+To enable debug mode (print requests and responses to and from FCM),
 set the `DEBUG` environment flag when running your app (assuming you use `node app.js` to run your app):
 
 ```bash

lib/message-options.js

@@ -1,13 +1,13 @@
 /**
  * This module defines all the arguments that may be passed to a message.
- * 
+ *
  * Each argument may contain a field `__argName`, if the name of the field
  * should be different when sent to the server.
- * 
+ *
  * The argument may also contain a field `__argType`, if the given
  * argument must be of that type. The types are the strings resulting from
  * calling `typeof <arg>` where `<arg>` is the argument.
- * 
+ *
  * Other than that, the arguments are expected to follow the indicated
  * structure.
  */
@@ -51,5 +51,8 @@ module.exports = {
         __argType: "object"
         //TODO: There are a lot of very specific arguments that could
         //      be indicated here.
+    },
+    fcm_options: {
+        __argType: "object"
     }
 };

lib/sender.js

@@ -148,9 +148,9 @@ Sender.prototype.sendNoRetry = function(message, recipient, callback) {
             headers: {
                 'Authorization': 'key=' + this.key
             },
-            uri: Constants.GCM_SEND_URI,
             json: body
         }, this.options, {
+            uri: Constants.GCM_SEND_URI,
             timeout: Constants.SOCKET_TIMEOUT
         });