@azure/notification-hubs 1.0.0-alpha.20220906.2 → 1.0.0-alpha.20220909.5

package/README.md

@@ -9,8 +9,12 @@ Azure Notification Hubs provide a scaled-out push engine that enables you to sen
 - Notify users of enterprise events such as new messages and work items.
 - Send codes for multi-factor authentication.
 
-[Source code](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/notificationhubs/notification-hubs/) |
-[Product documentation](https://docs.microsoft.com/azure/notification-hubs/)
+Key links:
+
+- [Source code](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/notificationhubs/notification-hubs/)
+- [Package (npm)](https://www.npmjs.com/package/@azure/notification-hubs)
+- [Product documentation](https://docs.microsoft.com/azure/notification-hubs/)
+- [Samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/notificationhubs/notification-hubs/samples-dev)
 
 ## Getting started
 
@@ -134,7 +138,7 @@ Device management is a core concept to Notification Hubs to be able to store the
 Installations are a newer and native JSON approach to device management that contains additional properties such as an installation ID and user ID which can be used for sending to audiences.  The installations API has a few advantages over the existing Registration APIs in the following ways:
 
 - Fully idempotent API so calling create on the installation, so an operation can be retried without worries about duplications.
-- Support for `userId` and `installationId` properties which can be then used in tag expressions such as `$InstallationId:myInstallId` and `$UserId:bob@contoso.com`.
+- Support for `userId` and `installationId` properties which can be then used in tag expressions such as `$InstallationId:{myInstallId}` and `$UserId:{bob@contoso.com}`.
 - Templates are now part of the installation instead of a separate registration and can be reference by name as a tag for sending.
 - Partial updates are supported through the [JSON Patch Standard](https://tools.ietf.org/html/rfc6902), which allows to add tags and change other data without having to first query the installation.
 
@@ -355,7 +359,7 @@ for await (const pages of registrations.byPage()) {
 
 Notification Hubs supports sending notifications to devices either directly using the unique PNS provided identifier, using tags for audience send, or a general broadcast to all devices.  Using the Standard SKU and above, [scheduled send](https://docs.microsoft.com/azure/notification-hubs/notification-hubs-send-push-notifications-scheduled) allows the user to schedule notifications up to seven days in advance.  All send operations return a Tracking ID and Correlation ID which can be used for Notification Hubs support cases.  With the Standard SKU and above, a Notification ID is also returned which can be used to get notification telemetry via the `getNotificationOutcomeDetails` method.
 
-For debugging purposes, the `enableTestSend` options can be set to `true` which gets immediate feedback from the PNS on the `send*` methods, however, is not supported in production scenarios.  This is not supported on the scheduled send methods.
+For debugging purposes, the `enableTestSend` options can be set to `true` which gets immediate feedback from the PNS on the `sendNotification` or `sendBroadcastNotification` methods, however, is not supported in production scenarios.  This is not supported on the scheduled send methods.
 
 Raw JSON or XML strings can be sent to the send or scheduled send methods, or the notification builders can be used which helps construct messages per PNS such as APNs, Firebase, Baidu, ADM and WNS.  These builders will build the native message format and fill in associated HTTP headers so there is no guessing about which fields are available for each PNS.
 
@@ -366,6 +370,7 @@ import { buildAppleNativeMessage } from "@azure/notification-hubs";
 // Using the modular approach
 import { buildAppleNativeMessage } from "@azure/notification-hubs/models/notificationBuilder";
 
+
 const apnsMessage = buildAppleNativeMessage({
   alert: {
     title: "Notification Title",
@@ -377,6 +382,7 @@ const apnsMessage = buildAppleNativeMessage({
 });
 
 // Send the message using the modular approach
+
 const result = await sendBroadcastNotification(context, apnsMessage);
 ```
 
@@ -473,9 +479,7 @@ const message = createAppleNotification({
   },
 });
 
-// Not required but can set test send to true for debugging purposes.
-const sendOptions: SendOperationOptions = { enableTestSend: false };
-const result = await client.sendDirectNotification(devicetoken, message, sendOptions);
+const result = await client.sendDirectNotification(devicetoken, message);
 
 console.log(`Tracking ID: ${result.trackingId}`);
 console.log(`Correlation ID: ${result.correlationId}`);
@@ -507,8 +511,6 @@ const message = createAppleNotification({
   },
 });
 
-// Not required but can set test send to true for debugging purposes.
-const sendOptions: SendOperationOptions = { enableTestSend: false };
 const result = await sendDirectNotification(context, devicetoken, message, sendOptions);
 
 console.log(`Tracking ID: ${result.trackingId}`);
@@ -620,9 +622,7 @@ const message = createAppleNotification({
   },
 });
 
-// Not required but can set test send to true for debugging purposes.
-const sendOptions: SendOperationOptions = { enableTestSend: false };
-const result = await client.scheduleNotification(scheduledTime, tagExpression, message, sendOptions);
+const result = await client.scheduleNotification(scheduledTime, tagExpression, message);
 
 console.log(`Tracking ID: ${result.trackingId}`);
 console.log(`Correlation ID: ${result.correlationId}`);
@@ -655,9 +655,7 @@ const message = createAppleNotification({
   },
 });
 
-// Not required but can set test send to true for debugging purposes.
-const sendOptions: SendOperationOptions = { enableTestSend: false };
-const result = await scheduleNotification(context, scheduledTime, tagExpression, message, sendOptions);
+const result = await scheduleNotification(context, scheduledTime, tagExpression, message);
 
 console.log(`Tracking ID: ${result.trackingId}`);
 console.log(`Correlation ID: ${result.correlationId}`);
@@ -672,11 +670,11 @@ console.log(`Notification ID: ${result.notificationId}`);
 
 Azure Notification Hubs has a complete guide to troubleshooting problems with dropped notifications in the [Diagnose dropped notifications in Azure Notification Hubs Guide](https://docs.microsoft.com/azure/notification-hubs/notification-hubs-push-notification-fixer).  
 
-[Test send](https://docs.microsoft.com/azure/notification-hubs/notification-hubs-push-notification-fixer#enabletestsend-property) is supported supported in the send methods with the `enableTestSend` option:
+[Test send](https://docs.microsoft.com/azure/notification-hubs/notification-hubs-push-notification-fixer#enabletestsend-property) is supported supported in the `sendNotification` method with the `enableTestSend` option:
 
 ```typescript
 const sendOptions: SendOperationOptions = { enableTestSend: true };
-const result = await client.sendDirectNotification(devicetoken, message, sendOptions);
+const result = await client.sendNotification(tags, message, sendOptions);
 ```
 
 ### Logging
@@ -744,6 +742,3 @@ folder for more details.
 - [Azure Notification Hubs](https://docs.microsoft.com/azure/notification-hubs/notification-hubs-push-notification-overview)
 
 ![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%notificationhubs%2Fnotification-hubs%2FREADME.png)
-
-[azure_cli]: https://docs.microsoft.com/cli/azure
-[azure_sub]: https://azure.microsoft.com/free/

package/dist/index.cjs

@@ -3,8 +3,6 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var coreRestPipeline = require('@azure/core-rest-pipeline');
-var coreAuth = require('@azure/core-auth');
-var coreUtil = require('@azure/core-util');
 var crypto = require('crypto');
 var coreXml = require('@azure/core-xml');
 var coreClient = require('@azure/core-client');
@@ -13,7 +11,7 @@ var tslib = require('tslib');
 
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
-const SDK_VERSION = "1.0.0-beta.4";
+const SDK_VERSION = "1.0.0-beta.5";
 const JSON_CONTENT_TYPE = "application/json;charset=utf-8";
 const XML_CONTENT_TYPE = "application/xml";
 const STREAM_CONTENT_TYPE = "application/octet-stream";
@@ -36,18 +34,7 @@ async function signString(key, toSign) {
  * @hidden
  */
 function createSasTokenProvider(data) {
-    if (coreAuth.isNamedKeyCredential(data) || coreAuth.isSASCredential(data)) {
-        return new SasTokenProviderImpl(data);
-    }
-    else if (coreUtil.isObjectWithProperties(data, ["sharedAccessKeyName", "sharedAccessKey"])) {
-        return new SasTokenProviderImpl({
-            name: data.sharedAccessKeyName,
-            key: data.sharedAccessKey,
-        });
-    }
-    else {
-        return new SasTokenProviderImpl({ signature: data.sharedAccessSignature });
-    }
+    return new SasTokenProviderImpl(data);
 }
 /**
  * A TokenProvider that generates a Sas token:
@@ -74,15 +61,7 @@ class SasTokenProviderImpl {
      * @param audience - The audience for which the token is desired.
      */
     async getToken(audience) {
-        if (coreAuth.isNamedKeyCredential(this._credential)) {
-            return createToken(this._credential.name, this._credential.key, Math.floor(Date.now() / 1000) + 3600, audience);
-        }
-        else {
-            return {
-                token: this._credential.signature,
-                expiresOnTimestamp: 0,
-            };
-        }
+        return createToken(this._credential.sharedAccessKeyName, this._credential.sharedAccessKey, Math.floor(Date.now() / 1000) + 3600, audience);
     }
 }
 /**
@@ -324,6 +303,34 @@ function getTagsOrUndefined(value) {
     return result.split(",");
 }
 
+// Copyright (c) Microsoft Corporation.
+async function parseNotificationOutcome(bodyText) {
+    const xml = await coreXml.parseXML(bodyText, { includeRoot: true });
+    const outcome = xml.NotificationOutcome;
+    return {
+        success: getInteger(outcome.Success, "Success"),
+        failure: getInteger(outcome.Failure, "Failure"),
+        results: parseRegistrationResults(outcome.Results.RegistrationResult),
+        state: "DetailedStateAvailable",
+    };
+}
+function parseRegistrationResults(results) {
+    const registrationResults = [];
+    if (!isDefined(results)) {
+        return registrationResults;
+    }
+    const resultsArray = Array.isArray(results) ? results : [results];
+    for (const result of resultsArray) {
+        registrationResults.push({
+            applicationPlatform: getString(result.ApplicationPlatform, "ApplicationPlatform"),
+            registrationId: getString(result.RegistrationId, "RegistrationId"),
+            outcome: getString(result.Outcome, "Outcome"),
+            pnsHandle: getString(result.PnsHandle, "PnsHandle"),
+        });
+    }
+    return registrationResults;
+}
+
 // Copyright (c) Microsoft Corporation.
 /**
  * Marker for atom metadata.
@@ -417,15 +424,14 @@ async function parseXMLError(bodyText) {
 }
 
 // Copyright (c) Microsoft Corporation.
-/**
- * @internal
- */
 function createRequest(endpoint, method, headers, options) {
     return coreRestPipeline.createPipelineRequest(Object.assign(Object.assign(Object.assign({}, options.tracingOptions), options.requestOptions), { url: endpoint.toString(), abortSignal: options.abortSignal, method,
         headers }));
 }
 /**
- * @internal
+ * Parses the HTTP response and creates a NotificationHubsResponse with header information from the operation.
+ * @param response - The HTTP response used to populate the result.
+ * @returns A NotificationHubsResponse with header information from the operation.
  */
 function parseNotificationResponse(response) {
     const correlationId = response.headers.get("x-ms-correlation-request-id");
@@ -438,16 +444,32 @@ function parseNotificationResponse(response) {
     };
 }
 /**
- * @internal
+ * Parses the HTTP response and creates a NotificationHubsMessageResponse with results from the notification.
+ * @param response - The HTTP response used to populate the result.
+ * @returns A NotificationHubsMessageResponse with results from the notification.
  */
-function parseNotificationSendResponse(response) {
+async function parseNotificationSendResponse(response) {
     const result = parseNotificationResponse(response);
     let notificationId;
     if (result.location) {
         const locationUrl = new URL(result.location);
         notificationId = locationUrl.pathname.split("/")[3];
     }
-    return Object.assign(Object.assign({}, result), { notificationId });
+    const requestUrl = new URL(response.request.url);
+    const isTestSend = requestUrl.searchParams.has("test");
+    const isDirectSend = requestUrl.searchParams.has("direct");
+    // Only broadcast/tag based sends are supported for test send
+    const responseBody = response.bodyAsText;
+    if (isTestSend && !isDirectSend && isDefined(responseBody)) {
+        const outcome = await parseNotificationOutcome(responseBody);
+        return Object.assign(Object.assign(Object.assign({}, result), outcome), { notificationId });
+    }
+    else {
+        return createDefaultResponse(result, notificationId);
+    }
+}
+function createDefaultResponse(response, notificationId) {
+    return Object.assign(Object.assign({}, response), { notificationId, success: 0, failure: 0, results: [], state: "Enqueued" });
 }
 /**
  * Sends a request through the client context.
@@ -652,20 +674,6 @@ const registrationDescriptionParser = {
     createGcmTemplateRegistrationDescription(rawRegistrationDescription) {
         return Object.assign(Object.assign(Object.assign({}, this.createGcmRegistrationDescription(rawRegistrationDescription)), createTemplateRegistrationDescription(rawRegistrationDescription)), { type: "GcmTemplate" });
     },
-    /**
-     * @internal
-     * Creates an FCM registration description from incoming XML property bag.
-     */
-    createFcmRegistrationDescription(rawRegistrationDescription) {
-        return Object.assign(Object.assign({ fcmRegistrationId: getString(rawRegistrationDescription["FcmRegistrationId"], "fcmRegistrationId") }, createRegistrationDescription(rawRegistrationDescription)), { type: "Fcm" });
-    },
-    /**
-     * @internal
-     * Creates an FCM template registration description from incoming XML property bag.
-     */
-    createFcmTemplateRegistrationDescription(rawRegistrationDescription) {
-        return Object.assign(Object.assign(Object.assign({}, this.createFcmRegistrationDescription(rawRegistrationDescription)), createTemplateRegistrationDescription(rawRegistrationDescription)), { type: "FcmTemplate" });
-    },
     /**
      * @internal
      * Creates a Windows Phone registration description from incoming XML property bag.
@@ -823,20 +831,6 @@ const registrationDescriptionSerializer = {
     serializeGcmTemplateRegistrationDescription(description) {
         return Object.assign(Object.assign({}, this.serializeGcmRegistrationDescription(description)), serializeTemplateRegistrationDescription(description));
     },
-    /**
-     * @internal
-     * Serializes an existing FCM registration description to an object for serialization.
-     */
-    serializeFcmRegistrationDescription(description) {
-        return Object.assign(Object.assign({}, serializeRegistrationDescription(description)), { FcmRegistrationId: description.fcmRegistrationId });
-    },
-    /**
-     * @internal
-     * Serializes an existing FCM template registration description to an object for serialization.
-     */
-    serializeFcmTemplateRegistrationDescription(description) {
-        return Object.assign(Object.assign({}, this.serializeFcmRegistrationDescription(description)), serializeTemplateRegistrationDescription(description));
-    },
     /**
      * @internal
      * @deprecated Windows Phone is no longer supported.
@@ -1097,6 +1091,9 @@ async function parseNotificationHubJobEntry(bodyText) {
 async function parseNotificationHubJobFeed(bodyText) {
     const xml = await coreXml.parseXML(bodyText, { includeRoot: true });
     const results = [];
+    if (!isDefined(xml.feed.entry)) {
+        return results;
+    }
     for (const item of xml.feed.entry) {
         results.push(createNotificationHubJob(item.content.NotificationHubJob));
     }
@@ -1514,7 +1511,7 @@ function sendNotificationPayload(context, notification, method, pushHandle, tags
         const endpoint = context.requestUrl();
         endpoint.pathname += "/messages/";
         if (options.enableTestSend) {
-            endpoint.searchParams.append("debug", "true");
+            endpoint.searchParams.append("test", "true");
         }
         const headers = await context.createHeaders(method);
         if (notification.headers) {
@@ -1572,8 +1569,7 @@ function sendBroadcastNotification(context, notification, options = {}) {
  * @param context - The Notification Hubs client.
  * @param pushHandle - The push handle which is the unique identifier for the device.
  * @param notification - The notification to send to the device.
- * @param options - Configuration options for the direct send operation which can contain custom headers
- * which may include APNs specific such as apns-topic or for WNS, X-WNS-TYPE.
+ * @param options - The options for sending a direct notification.
  * @returns A NotificationHubResponse with the tracking ID, correlation ID and location.
  */
 function sendDirectNotification(context, pushHandle, notification, options = {}) {
@@ -1776,8 +1772,7 @@ class NotificationHubsServiceClient {
      * Sends a direct push notification to a device with the given push handle.
      * @param pushHandle - The push handle which is the unique identifier for the device.
      * @param notification - The notification to send to the device.
-     * @param options - Configuration options for the direct send operation which can contain custom headers
-     * which may include APNs specific such as apns-topic or for WNS, X-WNS-TYPE.
+     * @param options - The options for sending a direct notification.
      * @returns A NotificationHubResponse with the tracking ID, correlation ID and location.
      */
     sendDirectNotification(pushHandle, notification, options = {}) {
@@ -1916,7 +1911,7 @@ function createBaiduInstallation(installation) {
  * @param installation - A partial installation used to create the Firebase Legacy HTTP installation.
  * @returns The newly created Baidu installation.
  */
-function createFirebaseLegacyInstallation(installation) {
+function createFcmLegacyInstallation(installation) {
     return Object.assign(Object.assign({}, installation), { platform: "gcm" });
 }
 /**
@@ -1974,7 +1969,7 @@ function createBrowserNotification(notification) {
  * @param notification - A partial message used to create a message for Firebase.
  * @returns A newly created Firebase.
  */
-function createFirebaseLegacyNotification(notification) {
+function createFcmLegacyNotification(notification) {
     return Object.assign(Object.assign({}, notification), { platform: "gcm", contentType: JSON_CONTENT_TYPE });
 }
 /**
@@ -2088,7 +2083,7 @@ function buildAppleNativeMessage(nativeMessage, additionalProperties) {
         headers: headers,
     });
 }
-function buildFirebaseLegacyNativePayload(nativeNotification) {
+function buildFcmLegacyNativePayload(nativeNotification) {
     if (!isDefined(nativeNotification)) {
         return undefined;
     }
@@ -2115,9 +2110,9 @@ function buildFirebaseLegacyNativePayload(nativeNotification) {
     return notification;
 }
 /**
- * Creates a FirebaseLegacyNotification from a native Firebase payload.
+ * Creates a FcmLegacyNotification from a native Firebase payload.
  * @param nativeMessage - The native message payload to send to Notification Hubs.
- * @returns The FirebaseLegacyNotification to send to Notification Hubs.
+ * @returns The FcmLegacyNotification to send to Notification Hubs.
  */
 function buildFirebaseLegacyNativeMessage(nativeMessage) {
     const jsonMessage = {
@@ -2132,9 +2127,9 @@ function buildFirebaseLegacyNativeMessage(nativeMessage) {
         restricted_package_name: nativeMessage.restrictedPackageName,
         dry_run: nativeMessage.dryRun,
         data: nativeMessage.data,
-        notification: buildFirebaseLegacyNativePayload(nativeMessage.notification),
+        notification: buildFcmLegacyNativePayload(nativeMessage.notification),
     };
-    return createFirebaseLegacyNotification({
+    return createFcmLegacyNotification({
         body: JSON.stringify(jsonMessage),
     });
 }
@@ -2270,57 +2265,21 @@ function createBrowserTemplateRegistrationDescription(description) {
     return Object.assign(Object.assign({}, description), { type: "BrowserTemplate" });
 }
 /**
- * @deprecated Use createFcmRegistrationDescription instead.
- * Creates a GCM registration description.
+ * Creates a Firebase Legacy registration description.
  * @param description - A partial GCM registration description.
  * @returns A created GCM registration description.
  */
-function createGcmRegistrationDescription(description) {
+function createFcmLegacyRegistrationDescription(description) {
     return Object.assign(Object.assign({}, description), { type: "Gcm" });
 }
 /**
- * @deprecated Use createFcmTemplateRegistrationDescription instead.
  * Creates a GCM template registration description.
  * @param description - A partial GCM template registration description.
  * @returns A created GCM template registration description.
  */
-function createGcmTemplateRegistrationDescription(description) {
+function createFcmLegacyTemplateRegistrationDescription(description) {
     return Object.assign(Object.assign({}, description), { type: "GcmTemplate" });
 }
-/**
- * Creates an FCM registration description.
- * @param description - A partial FCM registration description.
- * @returns A created FCM registration description.
- */
-function createFcmRegistrationDescription(description) {
-    return Object.assign(Object.assign({}, description), { type: "Fcm" });
-}
-/**
- * Creates an FCM template registration description.
- * @param description - A partial FCM template registration description.
- * @returns A created FCM template registration description.
- */
-function createFcmTemplateRegistrationDescription(description) {
-    return Object.assign(Object.assign({}, description), { type: "FcmTemplate" });
-}
-/**
- * @deprecated Windows Phone is no longer supported.
- * Creates an MPNS registration description.
- * @param description - A partial MPNS registration description.
- * @returns A created MPNS registration description.
- */
-function createMpnsRegistrationDescription(description) {
-    return Object.assign(Object.assign({}, description), { type: "Mpns" });
-}
-/**
- * @deprecated Windows Phone is no longer supported.
- * Creates an MPNS template registration description.
- * @param description - A partial MPNS template registration description.
- * @returns A created MPNS template registration description.
- */
-function createMpnsTemplateRegistrationDescription(description) {
-    return Object.assign(Object.assign({}, description), { type: "MpnsTemplate" });
-}
 /**
  * Creates a Windows registration description.
  * @param description - A partial Windows registration description.
@@ -2360,14 +2319,10 @@ exports.createBrowserInstallation = createBrowserInstallation;
 exports.createBrowserNotification = createBrowserNotification;
 exports.createBrowserRegistrationDescription = createBrowserRegistrationDescription;
 exports.createBrowserTemplateRegistrationDescription = createBrowserTemplateRegistrationDescription;
-exports.createFcmRegistrationDescription = createFcmRegistrationDescription;
-exports.createFcmTemplateRegistrationDescription = createFcmTemplateRegistrationDescription;
-exports.createFirebaseLegacyInstallation = createFirebaseLegacyInstallation;
-exports.createFirebaseLegacyNotification = createFirebaseLegacyNotification;
-exports.createGcmRegistrationDescription = createGcmRegistrationDescription;
-exports.createGcmTemplateRegistrationDescription = createGcmTemplateRegistrationDescription;
-exports.createMpnsRegistrationDescription = createMpnsRegistrationDescription;
-exports.createMpnsTemplateRegistrationDescription = createMpnsTemplateRegistrationDescription;
+exports.createFcmLegacyInstallation = createFcmLegacyInstallation;
+exports.createFcmLegacyNotification = createFcmLegacyNotification;
+exports.createFcmLegacyRegistrationDescription = createFcmLegacyRegistrationDescription;
+exports.createFcmLegacyTemplateRegistrationDescription = createFcmLegacyTemplateRegistrationDescription;
 exports.createTemplateNotification = createTemplateNotification;
 exports.createWindowsBadgeNotification = createWindowsBadgeNotification;
 exports.createWindowsInstallation = createWindowsInstallation;