@azure/notification-hubs 1.0.4-alpha.20240213.1 → 1.1.0-alpha.20240220.1

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, 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:
+Azure Notification Hubs provide a scaled-out push engine that enables you to send notifications to any platform (Apple, Amazon Kindle, Firebase, 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.
@@ -735,7 +735,7 @@ This module's tests are a mixture of live and unit tests, which require you to h
    `NOTIFICATIONHUBS_CONNECTION_STRING=connection string for your Notification Hubs instance`
    `NOTIFICATION_HUB_NAME=Notification Hub name`
 4. `cd sdk\notificationhubs\notification-hubs`
-5. `npm run test`.
+5. `rushx test`.
 
 View our [tests](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/notificationhubs/notification-hubs/test)
 folder for more details.

package/dist/index.cjs

@@ -5,11 +5,10 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var coreRestPipeline = require('@azure/core-rest-pipeline');
 var crypto = require('crypto');
 var coreClient = require('@azure-rest/core-client');
-var abortController = require('@azure/abort-controller');
+var coreUtil = require('@azure/core-util');
 var coreXml = require('@azure/core-xml');
 var coreTracing = require('@azure/core-tracing');
 var tslib = require('tslib');
-var coreUtil = require('@azure/core-util');
 
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
@@ -658,8 +657,7 @@ async function beginSubmitNotificationHubJob(context, notificationHubJob, polled
     const progressCallbacks = new Map();
     const processProgressCallbacks = async () => progressCallbacks.forEach((h) => h(state));
     let resultPromise;
-    let cancelJob;
-    const abortController$1 = new abortController.AbortController();
+    const abortController = new AbortController();
     const currentPollIntervalInMs = (_a = polledOperationOptions.updateIntervalInMs) !== null && _a !== void 0 ? _a : 2000;
     const poller = {
         async poll(options) {
@@ -686,33 +684,39 @@ async function beginSubmitNotificationHubJob(context, notificationHubJob, polled
         pollUntilDone(pollOptions) {
             return (resultPromise !== null && resultPromise !== void 0 ? resultPromise : (resultPromise = (async () => {
                 const { abortSignal: inputAbortSignal } = pollOptions || {};
-                const { signal: abortSignal } = inputAbortSignal
-                    ? new abortController.AbortController([inputAbortSignal, abortController$1.signal])
-                    : abortController$1;
-                if (!poller.isDone()) {
-                    await poller.poll({ abortSignal });
-                    while (!poller.isDone()) {
-                        const delay = sleep(currentPollIntervalInMs, abortSignal);
-                        cancelJob = () => abortController$1.abort();
-                        await delay;
+                // In the future we can use AbortSignal.any() instead
+                function abortListener() {
+                    abortController.abort();
+                }
+                const abortSignal = abortController.signal;
+                if (inputAbortSignal === null || inputAbortSignal === void 0 ? void 0 : inputAbortSignal.aborted) {
+                    abortController.abort();
+                }
+                else if (!abortSignal.aborted) {
+                    inputAbortSignal === null || inputAbortSignal === void 0 ? void 0 : inputAbortSignal.addEventListener("abort", abortListener, { once: true });
+                }
+                try {
+                    if (!poller.isDone()) {
                         await poller.poll({ abortSignal });
+                        while (!poller.isDone()) {
+                            await coreUtil.delay(currentPollIntervalInMs, { abortSignal });
+                            await poller.poll({ abortSignal });
+                        }
                     }
                 }
+                finally {
+                    inputAbortSignal === null || inputAbortSignal === void 0 ? void 0 : inputAbortSignal.removeEventListener("abort", abortListener);
+                }
                 switch (state.status) {
-                    case "succeeded": {
+                    case "succeeded":
                         return poller.getResult();
-                    }
-                    case "canceled": {
+                    case "canceled":
                         throw new Error("Operation was canceled");
-                    }
-                    case "failed": {
+                    case "failed":
                         throw state.error;
-                    }
                     case "notStarted":
-                    case "running": {
-                        // Unreachable
-                        throw new Error(`polling completed without succeeding or failing`);
-                    }
+                    case "running":
+                        throw new Error(`Polling completed without succeeding or failing`);
                 }
             })().finally(() => {
                 resultPromise = undefined;
@@ -727,8 +731,7 @@ async function beginSubmitNotificationHubJob(context, notificationHubJob, polled
             return ["succeeded", "failed", "canceled"].includes(state.status);
         },
         stopPolling() {
-            abortController$1.abort();
-            cancelJob === null || cancelJob === void 0 ? void 0 : cancelJob();
+            abortController.abort();
         },
         isStopped() {
             return resultPromise === undefined;
@@ -745,28 +748,6 @@ async function beginSubmitNotificationHubJob(context, notificationHubJob, polled
     };
     return poller;
 }
-const REJECTED_ERR = new Error("The operation has been aborted");
-function sleep(ms, signal) {
-    return new Promise((resolve, reject) => {
-        if (signal.aborted) {
-            reject(REJECTED_ERR);
-            return;
-        }
-        const id = setTimeout(() => {
-            signal.removeEventListener("abort", onAbort);
-            if (signal.aborted) {
-                reject(REJECTED_ERR);
-                return;
-            }
-            resolve();
-        }, ms);
-        signal.addEventListener("abort", onAbort, { once: true });
-        function onAbort() {
-            clearTimeout(id);
-            reject(REJECTED_ERR);
-        }
-    });
-}
 
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
@@ -913,6 +894,20 @@ const registrationDescriptionParser = {
     createBrowserTemplateRegistrationDescription(rawRegistrationDescription) {
         return Object.assign(Object.assign(Object.assign({}, this.createBrowserRegistrationDescription(rawRegistrationDescription)), createTemplateRegistrationDescription(rawRegistrationDescription)), { kind: "BrowserTemplate" });
     },
+    /**
+     * @internal
+     * Creates an GCM registration description from incoming XML property bag.
+     */
+    createFcmV1RegistrationDescription(rawRegistrationDescription) {
+        return Object.assign(Object.assign({ fcmV1RegistrationId: getString(rawRegistrationDescription["FcmV1RegistrationId"], "fcmV1RegistrationId") }, createRegistrationDescription(rawRegistrationDescription)), { kind: "FcmV1" });
+    },
+    /**
+     * @internal
+     * Creates an FCM template registration description from incoming XML property bag.
+     */
+    createFcmV1TemplateRegistrationDescription(rawRegistrationDescription) {
+        return Object.assign(Object.assign(Object.assign({}, this.createFcmV1RegistrationDescription(rawRegistrationDescription)), createTemplateRegistrationDescription(rawRegistrationDescription)), { kind: "FcmV1Template" });
+    },
     /**
      * @internal
      * Creates an GCM registration description from incoming XML property bag.
@@ -1084,7 +1079,20 @@ const registrationDescriptionSerializer = {
     },
     /**
      * @internal
-     * @deprecated Should use FCM registrations instead of GCM.
+     * Serializes an existing FCM V1 registration description to an object for serialization.
+     */
+    serializeFcmV1RegistrationDescription(description) {
+        return Object.assign(Object.assign({}, serializeRegistrationDescription(description)), { FcmV1RegistrationId: getString(description.fcmV1RegistrationId, "fcmRegistrationId") });
+    },
+    /**
+     * @internal
+     * Serializes an existing FCM V1 template registration description to an object for serialization.
+     */
+    serializeFcmV1TemplateRegistrationDescription(description) {
+        return Object.assign(Object.assign({}, this.serializeFcmV1RegistrationDescription(description)), serializeTemplateRegistrationDescription(description));
+    },
+    /**
+     * @internal
      * Serializes an existing GCM registration description to an object for serialization.
      */
     serializeGcmRegistrationDescription(description) {
@@ -1092,7 +1100,6 @@ const registrationDescriptionSerializer = {
     },
     /**
      * @internal
-     * @deprecated Should use FCM template registrations instead of GCM.
      * Serializes an existing GCM template registration description to an object for serialization.
      */
     serializeGcmTemplateRegistrationDescription(description) {
@@ -2154,6 +2161,14 @@ function createBaiduInstallation(installation) {
 function createFcmLegacyInstallation(installation) {
     return Object.assign(Object.assign({}, installation), { platform: "gcm" });
 }
+/**
+ * Creates an Firebase V1 Cloud Messaging based installation.
+ * @param installation - A partial installation used to create the Firebase V1 Cloud Messaging installation.
+ * @returns The newly created Firebase V1 Cloud Messaging installation.
+ */
+function createFcmV1Installation(installation) {
+    return Object.assign(Object.assign({}, installation), { platform: "fcmv1" });
+}
 /**
  * Creates a Xiaomi based installation.
  * @param installation - A partial installation used to create the Xiaomi installation.
@@ -2227,6 +2242,15 @@ function createFcmLegacyNotification(notification) {
     const body = isString(notification.body) ? notification.body : JSON.stringify(notification.body);
     return Object.assign(Object.assign({}, notification), { body, platform: "gcm", contentType: JSON_CONTENT_TYPE });
 }
+/**
+ * Creates a notification to send to Firebase.
+ * @param notification - A partial message used to create a message for Firebase.
+ * @returns A newly created Firebase notification.
+ */
+function createFcmV1Notification(notification) {
+    const body = isString(notification.body) ? notification.body : JSON.stringify(notification.body);
+    return Object.assign(Object.assign({}, notification), { body, platform: "fcmv1", contentType: JSON_CONTENT_TYPE });
+}
 /**
  * Creates a notification to send to Xiaomi.
  * @param notification - A partial message used to create a message for Xiaomi.
@@ -2348,6 +2372,14 @@ function createAppleNotificationBody(nativeMessage) {
 function createFirebaseLegacyNotificationBody(nativeMessage) {
     return JSON.stringify(nativeMessage);
 }
+/**
+ * Creates a FcmV1Notification from a native Firebase payload.
+ * @param nativeMessage - The native message payload to send to Notification Hubs.
+ * @returns The JSON body to send to Notification Hubs.
+ */
+function createFirebaseV1NotificationBody(nativeMessage) {
+    return JSON.stringify(nativeMessage);
+}
 /**
  * Creates a AdmNotification from a native ADM payload.
  * @param nativeMessage - The native message payload to send to Notification Hubs.
@@ -2458,6 +2490,22 @@ function createFcmLegacyRegistrationDescription(description) {
 function createFcmLegacyTemplateRegistrationDescription(description) {
     return Object.assign(Object.assign({}, description), { kind: "GcmTemplate" });
 }
+/**
+ * Creates a Firebase V1 registration description.
+ * @param description - A partial FCM V1 registration description.
+ * @returns A created FCM V1 registration description.
+ */
+function createFcmV1RegistrationDescription(description) {
+    return Object.assign(Object.assign({}, description), { kind: "FcmV1" });
+}
+/**
+ * Creates a FCM V1 template registration description.
+ * @param description - A partial FCM V1 template registration description.
+ * @returns A created FCM V1 template registration description.
+ */
+function createFcmV1TemplateRegistrationDescription(description) {
+    return Object.assign(Object.assign({}, description), { kind: "FcmV1Template" });
+}
 /**
  * Creates a Windows registration description.
  * @param description - A partial Windows registration description.
@@ -2526,7 +2574,12 @@ exports.createFcmLegacyInstallation = createFcmLegacyInstallation;
 exports.createFcmLegacyNotification = createFcmLegacyNotification;
 exports.createFcmLegacyRegistrationDescription = createFcmLegacyRegistrationDescription;
 exports.createFcmLegacyTemplateRegistrationDescription = createFcmLegacyTemplateRegistrationDescription;
+exports.createFcmV1Installation = createFcmV1Installation;
+exports.createFcmV1Notification = createFcmV1Notification;
+exports.createFcmV1RegistrationDescription = createFcmV1RegistrationDescription;
+exports.createFcmV1TemplateRegistrationDescription = createFcmV1TemplateRegistrationDescription;
 exports.createFirebaseLegacyNotificationBody = createFirebaseLegacyNotificationBody;
+exports.createFirebaseV1NotificationBody = createFirebaseV1NotificationBody;
 exports.createTagExpression = createTagExpression;
 exports.createTemplateNotification = createTemplateNotification;
 exports.createWindowsBadgeNotification = createWindowsBadgeNotification;