@azure/notification-hubs 1.0.0-beta.7 → 1.0.0

package/README.md

@@ -1,6 +1,6 @@
 # Azure Notification Hubs SDK for JavaScript
 
-Azure Notification Hubs provide a scaled-out push engine that enables you to send notifications to any platform (Apple, Amazon Kindle, Android, Baidu, Web, Windows, etc.) from any back-end (cloud or on-premises). Notification Hubs works well for both enterprise and consumer scenarios. Here are a few example scenarios:
+Azure Notification Hubs provide a scaled-out push engine that enables you to send notifications to any platform (Apple, Amazon Kindle, Android, Baidu, Xiaomi, Web, Windows, etc.) from any back-end (cloud or on-premises). Notification Hubs works well for both enterprise and consumer scenarios. Here are a few example scenarios:
 
 - Send breaking news notifications to millions with low latency.
 - Send location-based coupons to interested user segments.
@@ -53,7 +53,7 @@ This SDK for JavaScript offers two ways of interacting with Azure Notification H
 
 ```typescript
 import { 
-  NotificationHubsServiceClient
+  NotificationHubsClient,
   createAppleInstallation 
 } from "@azure/notification-hubs";
 
@@ -81,6 +81,7 @@ The above code snippet then becomes the following:
 
 ```typescript
 import { createClientContext, createOrUpdateInstallation } from "@azure/notification-hubs/api";
+import { createAppleInstallation } from "@azure/notification-hubs/models";
 
 const context = createClientContext("<connection string>", "<hub name>");
 
@@ -193,7 +194,7 @@ Using the modular approach, the code would be as follows:
 
 ```typescript
 import { createClientContext, updateInstallation } from "@azure/notification-hubs/api";
-import { JsonPatch, createAppleInstallation } from "@azure/notification-hubs/models";
+import { JsonPatch } from "@azure/notification-hubs/models";
 
 const context = createClientContext("<connection string>", "<hub name>");
 

package/dist/index.cjs

@@ -14,7 +14,7 @@ var uuid = require('uuid');
 
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
-const SDK_VERSION = "1.0.0-beta.7";
+const SDK_VERSION = "1.0.0";
 const JSON_CONTENT_TYPE = "application/json;charset=utf-8";
 const XML_CONTENT_TYPE = "application/xml";
 const STREAM_CONTENT_TYPE = "application/octet-stream";
@@ -771,6 +771,7 @@ const registrationDescriptionParser = {
      */
     async parseRegistrationEntry(bodyText) {
         const xml = await coreXml.parseXML(bodyText, { includeRoot: true });
+        delete xml.entry.content["$"];
         const keyName = Object.keys(xml.entry.content)[0];
         const content = xml.entry.content[keyName];
         const methodName = `create${keyName}`;
@@ -890,6 +891,20 @@ const registrationDescriptionParser = {
         var _a;
         return Object.assign(Object.assign(Object.assign({ mpnsHeaders: getHeadersOrUndefined((_a = rawRegistrationDescription["MpnsHeaders"]) === null || _a === void 0 ? void 0 : _a["MpnsHeader"]) }, this.createWindowsRegistrationDescription(rawRegistrationDescription)), createTemplateRegistrationDescription(rawRegistrationDescription)), { kind: "MpnsTemplate" });
     },
+    /**
+     * @internal
+     * Creates a Xiaomi registration description from incoming XML property bag.
+     */
+    createXiaomiRegistrationDescription(rawRegistrationDescription) {
+        return Object.assign(Object.assign({ xiaomiRegistrationId: getString(rawRegistrationDescription["XiaomiRegistrationId"], "xiaomiRegistrationId") }, createRegistrationDescription(rawRegistrationDescription)), { kind: "Xiaomi" });
+    },
+    /**
+     * @internal
+     * Creates a Xiaomi template registration description from incoming XML property bag.
+     */
+    createXiaomiTemplateRegistrationDescription(rawRegistrationDescription) {
+        return Object.assign(Object.assign(Object.assign({}, this.createXiaomiRegistrationDescription(rawRegistrationDescription)), createTemplateRegistrationDescription(rawRegistrationDescription)), { kind: "XiaomiTemplate" });
+    },
     /**
      * @internal
      * Creates a Windows registration description from incoming XML property bag.
@@ -1060,6 +1075,20 @@ const registrationDescriptionSerializer = {
         }
         return Object.assign(Object.assign(Object.assign({}, this.serializeMpnsRegistrationDescription(description)), serializeTemplateRegistrationDescription(description)), { MpnsHeaders: mpnsHeaders });
     },
+    /**
+     * @internal
+     * Serializes an existing Xiaomi registration description to an object for serialization.
+     */
+    serializeXiaomiRegistrationDescription(description) {
+        return Object.assign(Object.assign({}, serializeRegistrationDescription(description)), { XiaomiRegistrationId: getString(description.xiaomiRegistrationId, "xiaomiRegistrationId") });
+    },
+    /**
+     * @internal
+     * Serializes an existing Xiaomi template registration description to an object for serialization.
+     */
+    serializeXiaomiTemplateRegistrationDescription(description) {
+        return Object.assign(Object.assign({}, this.serializeXiaomiRegistrationDescription(description)), serializeTemplateRegistrationDescription(description));
+    },
     /**
      * @internal
      * Serializes an existing Windows registration description to an object for serialization.
@@ -1190,6 +1219,13 @@ function createRegistrationId(context, options = {}) {
         const response = await sendRequest(context, request, 201);
         // In the form: https://{namespace}.servicebus.windows.net/{NotificationHub}/registrations/<registrationId>
         const locationHeader = response.headers.get("Location");
+        if (!locationHeader || !locationHeader.startsWith("https://")) {
+            throw new coreRestPipeline.RestError(`Location header ${locationHeader} is an invalid URL`, {
+                statusCode: 500,
+                request,
+                response,
+            });
+        }
         const locationUrl = new URL(locationHeader);
         const registrationId = locationUrl.pathname.split("/")[3];
         return registrationId;
@@ -1288,7 +1324,6 @@ function getInstallation(context, installationId, options = {}) {
 async function parseNotificationDetails(bodyText) {
     const xml = await coreXml.parseXML(bodyText, {
         includeRoot: true,
-        stopNodes: ["NotificationDetails.NotificationBody"],
     });
     const notificationDetails = xml["NotificationDetails"];
     let apnsOutcomeCounts;
@@ -1307,6 +1342,10 @@ async function parseNotificationDetails(bodyText) {
     if (isDefined(notificationDetails["GcmOutcomeCounts"])) {
         fcmOutcomeCounts = parseOutcomeCounts(notificationDetails["GcmOutcomeCounts"]["Outcome"]);
     }
+    let xiaomiOutcomeCounts;
+    if (isDefined(notificationDetails["XiaomiOutcomeCounts"])) {
+        xiaomiOutcomeCounts = parseOutcomeCounts(notificationDetails["XiaomiOutcomeCounts"]["Outcome"]);
+    }
     let wnsOutcomeCounts;
     if (isDefined(notificationDetails["WnsOutcomeCounts"])) {
         wnsOutcomeCounts = parseOutcomeCounts(notificationDetails["WnsOutcomeCounts"]["Outcome"]);
@@ -1320,10 +1359,12 @@ async function parseNotificationDetails(bodyText) {
         endTime: getDateOrUndefined(notificationDetails["EndTime"]),
         pnsErrorDetailsUrl: getStringOrUndefined(notificationDetails["PnsErrorDetailsUri"]),
         targetPlatforms: getStringOrUndefined(notificationDetails["TargetPlatforms"]),
+        notificationBody: getStringOrUndefined(notificationDetails["NotificationBody"]),
         apnsOutcomeCounts,
         admOutcomeCounts,
         baiduOutcomeCounts,
         fcmOutcomeCounts,
+        xiaomiOutcomeCounts,
         wnsOutcomeCounts,
     };
 }
@@ -2078,6 +2119,14 @@ function createBaiduInstallation(installation) {
 function createFcmLegacyInstallation(installation) {
     return Object.assign(Object.assign({}, installation), { platform: "gcm" });
 }
+/**
+ * Creates a Xiaomi based installation.
+ * @param installation - A partial installation used to create the Xiaomi installation.
+ * @returns The newly created Xiaomi installation.
+ */
+function createXiaomiInstallation(installation) {
+    return Object.assign(Object.assign({}, installation), { platform: "xiaomi" });
+}
 /**
  * Creates a Windows Notification Services (WNS) based installation.
  * @param installation - A partial installation used to create the WNS installation.
@@ -2131,11 +2180,19 @@ function createBrowserNotification(notification) {
 /**
  * Creates a notification to send to Firebase.
  * @param notification - A partial message used to create a message for Firebase.
- * @returns A newly created Firebase.
+ * @returns A newly created Firebase notification.
  */
 function createFcmLegacyNotification(notification) {
     return Object.assign(Object.assign({}, notification), { platform: "gcm", contentType: JSON_CONTENT_TYPE });
 }
+/**
+ * Creates a notification to send to Xiaomi.
+ * @param notification - A partial message used to create a message for Xiaomi.
+ * @returns A newly created Xiaomi notification.
+ */
+function createXiaomiNotification(notification) {
+    return Object.assign(Object.assign({}, notification), { platform: "xiaomi", contentType: JSON_CONTENT_TYPE });
+}
 /**
  * Creates a notification to send to Firebase.
  * @param notification - A partial message used to create a message for Firebase.
@@ -2341,6 +2398,22 @@ function createWindowsRegistrationDescription(description) {
 function createWindowsTemplateRegistrationDescription(description) {
     return Object.assign(Object.assign({}, description), { kind: "WindowsTemplate" });
 }
+/**
+ * Creates a Xiaomi registration description.
+ * @param description - A partial Xiaomi registration description.
+ * @returns A created Xiaomi registration description.
+ */
+function createXiaomiRegistrationDescription(description) {
+    return Object.assign(Object.assign({}, description), { kind: "Xiaomi" });
+}
+/**
+ * Creates a Xiaomi template registration description.
+ * @param description - A partial Xiaomi template registration description.
+ * @returns A created Xiaomi template registration description.
+ */
+function createXiaomiTemplateRegistrationDescription(description) {
+    return Object.assign(Object.assign({}, description), { kind: "XiaomiTemplate" });
+}
 
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
@@ -2388,4 +2461,8 @@ exports.createWindowsRegistrationDescription = createWindowsRegistrationDescript
 exports.createWindowsTemplateRegistrationDescription = createWindowsTemplateRegistrationDescription;
 exports.createWindowsTileNotification = createWindowsTileNotification;
 exports.createWindowsToastNotification = createWindowsToastNotification;
+exports.createXiaomiInstallation = createXiaomiInstallation;
+exports.createXiaomiNotification = createXiaomiNotification;
+exports.createXiaomiRegistrationDescription = createXiaomiRegistrationDescription;
+exports.createXiaomiTemplateRegistrationDescription = createXiaomiTemplateRegistrationDescription;
 //# sourceMappingURL=index.js.map