@azure/notification-hubs 1.0.0-alpha.20230206.1 → 1.0.0-alpha.20230309.2

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.

package/dist/index.cjs

@@ -46,12 +46,6 @@ function createSasTokenProvider(data) {
  * @internal
  */
 class SasTokenProviderImpl {
-    /**
-     * Property used to distinguish TokenProvider from TokenCredential.
-     */
-    get isSasTokenProvider() {
-        return true;
-    }
     /**
      * Initializes a new instance of SasTokenProvider
      * @param credential - The source `NamedKeyCredential` or `SASCredential`.
@@ -59,6 +53,12 @@ class SasTokenProviderImpl {
     constructor(credential) {
         this._credential = credential;
     }
+    /**
+     * Property used to distinguish TokenProvider from TokenCredential.
+     */
+    get isSasTokenProvider() {
+        return true;
+    }
     /**
      * Gets the sas token for the specified audience
      * @param audience - The audience for which the token is desired.
@@ -891,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.
@@ -1061,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.
@@ -1314,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"]);
@@ -1332,6 +1364,7 @@ async function parseNotificationDetails(bodyText) {
         admOutcomeCounts,
         baiduOutcomeCounts,
         fcmOutcomeCounts,
+        xiaomiOutcomeCounts,
         wnsOutcomeCounts,
     };
 }
@@ -1409,24 +1442,17 @@ function listNotificationHubJobs(context, options = {}) {
 // Copyright (c) Microsoft Corporation.
 function listRegistrationsAll(context, options) {
     return tslib.__asyncGenerator(this, arguments, function* listRegistrationsAll_1() {
-        var _a, e_1, _b, _c;
+        var e_1, _a;
         try {
-            for (var _d = true, _e = tslib.__asyncValues(listRegistrationPagingPage(context, options)), _f; _f = yield tslib.__await(_e.next()), _a = _f.done, !_a;) {
-                _c = _f.value;
-                _d = false;
-                try {
-                    const page = _c;
-                    yield tslib.__await(yield* tslib.__asyncDelegator(tslib.__asyncValues(page)));
-                }
-                finally {
-                    _d = true;
-                }
+            for (var _b = tslib.__asyncValues(listRegistrationPagingPage(context, options)), _c; _c = yield tslib.__await(_b.next()), !_c.done;) {
+                const page = _c.value;
+                yield tslib.__await(yield* tslib.__asyncDelegator(tslib.__asyncValues(page)));
             }
         }
         catch (e_1_1) { e_1 = { error: e_1_1 }; }
         finally {
             try {
-                if (!_d && !_a && (_b = _e.return)) yield tslib.__await(_b.call(_e));
+                if (_c && !_c.done && (_a = _b.return)) yield tslib.__await(_a.call(_b));
             }
             finally { if (e_1) throw e_1.error; }
         }
@@ -1588,24 +1614,17 @@ function listRegistrationsByTag(context, tag, options = {}) {
 }
 function listRegistrationsByTagAll(context, tag, options) {
     return tslib.__asyncGenerator(this, arguments, function* listRegistrationsByTagAll_1() {
-        var _a, e_1, _b, _c;
+        var e_1, _a;
         try {
-            for (var _d = true, _e = tslib.__asyncValues(listRegistrationsByTagPagingPage(context, tag, options)), _f; _f = yield tslib.__await(_e.next()), _a = _f.done, !_a;) {
-                _c = _f.value;
-                _d = false;
-                try {
-                    const page = _c;
-                    yield tslib.__await(yield* tslib.__asyncDelegator(tslib.__asyncValues(page)));
-                }
-                finally {
-                    _d = true;
-                }
+            for (var _b = tslib.__asyncValues(listRegistrationsByTagPagingPage(context, tag, options)), _c; _c = yield tslib.__await(_b.next()), !_c.done;) {
+                const page = _c.value;
+                yield tslib.__await(yield* tslib.__asyncDelegator(tslib.__asyncValues(page)));
             }
         }
         catch (e_1_1) { e_1 = { error: e_1_1 }; }
         finally {
             try {
-                if (!_d && !_a && (_b = _e.return)) yield tslib.__await(_b.call(_e));
+                if (_c && !_c.done && (_a = _b.return)) yield tslib.__await(_a.call(_b));
             }
             finally { if (e_1) throw e_1.error; }
         }
@@ -2100,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.
@@ -2153,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.
@@ -2363,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.
@@ -2410,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