@azure/notification-hubs 2.0.0-alpha.20240919.1 → 2.0.0-alpha.20240920.2

package/README.md

@@ -53,20 +53,15 @@ Once created, the Notification Hub can be configured using the [Azure Portal or
 
 This SDK for JavaScript offers two ways of interacting with Azure Notification Hubs, either through the class-based approach, or with a modular design approach.  The class-based approach is consistent across all packages to create a client and then interact with the methods on the client.
 
-```typescript
-import {
-  NotificationHubsClient,
-  createAppleInstallation
-} from "@azure/notification-hubs";
+```ts snippet:importing_classical
+import { NotificationHubsClient, createAppleInstallation } from "@azure/notification-hubs";
 
 const client = new NotificationHubsClient("<connection string>", "<hub name>");
-
 const installation = createAppleInstallation({
   installationId: "<installation-id>",
   pushChannel: "<push-channel>",
   tags: ["likes_javascript"],
 });
-
 const result = await client.createOrUpdateInstallation(installation);
 ```
 
@@ -81,18 +76,16 @@ The following subpaths are exposed:
 
 The above code snippet then becomes the following:
 
-```typescript
+```ts snippet:importing_modular
 import { createClientContext, createOrUpdateInstallation } from "@azure/notification-hubs/api";
-import { createAppleInstallation } from "@azure/notification-hubs/models";
+import { createAppleInstallation } from "@azure/notification-hubs";
 
 const context = createClientContext("<connection string>", "<hub name>");
-
 const installation = createAppleInstallation({
   installationId: "<installation-id>",
   pushChannel: "<push-channel>",
   tags: ["likes_javascript"],
 });
-
 const result = await createOrUpdateInstallation(context, installation);
 ```
 
@@ -104,7 +97,7 @@ Listen allows for a client to register itself via the Registration and Installat
 
 A new `NotificationHubsClient` client can be created using the constructor with the connection string and Notification Hub name.
 
-```typescript
+```ts snippet:authenticating_classical
 import { NotificationHubsClient } from "@azure/notification-hubs";
 
 const client = new NotificationHubsClient("<connection string>", "<hub name>");
@@ -112,7 +105,7 @@ const client = new NotificationHubsClient("<connection string>", "<hub name>");
 
 Using the modular approach, the `createClientContext` can be imported via the `"@azure/notification-hubs/api"` subpath.
 
-```typescript
+```ts snippet:authenticating_modular
 import { createClientContext } from "@azure/notification-hubs/api";
 
 const context = createClientContext("<connection string>", "<hub name>");
@@ -140,97 +133,81 @@ Installations are a newer and native JSON approach to device management that con
 
 Installations can be created through the `createOrUpdateInstallation` method such as the following:
 
-```typescript
+```ts snippet:createOrUpdateInstallation_classical
 import { NotificationHubsClient, createAppleInstallation } from "@azure/notification-hubs";
-import { v4 as uuid } from "uuid";
 
 const client = new NotificationHubsClient("<connection string>", "<hub name>");
-
 // Create an installation for APNs
-let installation = createAppleInstallation({
-  installationId: uuid(), // Must be unique
+const installation = createAppleInstallation({
+  installationId: "0d8ab095-c449-493f-9195-17e4917806c4", // Must be unique
   pushChannel: "00fc13adff785122b4ad28809a3420982341241421348097878e577c991de8f0", // PNS specific handle
   tags: ["likes_hockey", "likes_football"],
 });
-
-installation = await client.createOrUpdateInstallation(installation);
+const response = await client.createOrUpdateInstallation(installation);
 ```
 
 Using the modular approach, the code would be as follows:
 
-```typescript
+```ts snippet:createOrUpdateInstallation_modular
 import { createClientContext, createOrUpdateInstallation } from "@azure/notification-hubs/api";
-import { createAppleInstallation } from "@azure/notification-hubs/models";
-import { v4 as uuid } from "uuid";
+import { createAppleInstallation } from "@azure/notification-hubs";
 
 const context = createClientContext("<connection string>", "<hub name>");
-
 // Create an installation for APNs
-let installation = createAppleInstallation({
-  installationId: uuid(), // Must be unique
+const installation = createAppleInstallation({
+  installationId: "0d8ab095-c449-493f-9195-17e4917806c4", // Must be unique
   pushChannel: "00fc13adff785122b4ad28809a3420982341241421348097878e577c991de8f0", // PNS specific handle
   tags: ["likes_hockey", "likes_football"],
 });
-
-installation = await createOrUpdateInstallation(context, installation);
+const response = await createOrUpdateInstallation(context, installation);
 ```
 
 An update to an installation can be made through the JSON Patch schema such as adding a tag and a user ID using the `updateInstallation` method.
 
-```typescript
+```ts snippet:updateInstallation_classical
 import { NotificationHubsClient, JsonPatch } from "@azure/notification-hubs";
 
 const client = new NotificationHubsClient("<connection string>", "<hub name>");
-
 const installationId = "<unique installation ID>";
-
 const updates: JsonPatch[] = [
   { op: "add", path: "/tags", value: "likes_baseball" },
   { op: "add", path: "/userId", value: "bob@contoso.com" },
 ];
-
 const installation = await client.updateInstallation(installationId, updates);
 ```
 
 Using the modular approach, the code would be as follows:
 
-```typescript
+```ts snippet:updateInstallation_modular
 import { createClientContext, updateInstallation } from "@azure/notification-hubs/api";
-import { JsonPatch } from "@azure/notification-hubs/models";
+import { JsonPatch } from "@azure/notification-hubs";
 
 const context = createClientContext("<connection string>", "<hub name>");
-
 const installationId = "<unique installation ID>";
-
 const updates: JsonPatch[] = [
   { op: "add", path: "/tags", value: "likes_baseball" },
   { op: "add", path: "/userId", value: "bob@contoso.com" },
 ];
-
 const installation = await updateInstallation(context, installationId, updates);
 ```
 
 To retrieve an existing installation, use the `getInstallation` method with your existing unique installation ID.
 
-```typescript
+```ts snippet:getInstallation_classical
 import { NotificationHubsClient } from "@azure/notification-hubs";
 
 const client = new NotificationHubsClient("<connection string>", "<hub name>");
-
 const installationId = "<unique installation ID>";
-
 const installation = client.getInstallation(installationId);
 ```
 
 Using the modular approach, the code would be as follows:
 
-```typescript
+```ts snippet:getInstallation_modular
 import { createClientContext, getInstallation } from "@azure/notification-hubs/api";
 
 const context = createClientContext("<connection string>", "<hub name>");
-
 const installationId = "<unique installation ID>";
-
 const installation = getInstallation(context, installationId);
 ```
 
@@ -240,87 +217,77 @@ A registration is associated with a PNS just as the installation above, with the
 
 An installation may be created in one of two ways, first by getting a registration ID from the server using `getInstallationId` and then `createOrUpdateRegistration` or via the `createRegistration` method.
 
-```typescript
+```ts snippet:createRegistration_classical
 import {
   NotificationHubsClient,
   createAppleRegistrationDescription,
 } from "@azure/notification-hubs";
 
 const client = new NotificationHubsClient("<connection string>", "<hub name>");
-
-let registration = createAppleRegistrationDescription({
+const registration = createAppleRegistrationDescription({
   deviceToken: "00fc13adff785122b4ad28809a3420982341241421348097878e577c991de8f0",
   tags: ["likes_hockey", "likes_football"],
 });
-
-registration = await client.createRegistration(registration);
-
-console.log(`New Registration ID: ${registration.registrationId}`);
+const updatedRegistration = await client.createRegistration(registration);
 ```
 
 Using the modular approach, the code would be as follows:
 
-```typescript
+```ts snippet:createRegistration_modular
 import { createClientContext, createRegistration } from "@azure/notification-hubs/api";
-import { createAppleRegistrationDescription } from "@azure/notification-hubs/models";
+import { createAppleRegistrationDescription } from "@azure/notification-hubs";
 
 const context = createClientContext("<connection string>", "<hub name>");
-
-let registration = createAppleRegistrationDescription({
+const registration = createAppleRegistrationDescription({
   deviceToken: "00fc13adff785122b4ad28809a3420982341241421348097878e577c991de8f0",
   tags: ["likes_hockey", "likes_football"],
 });
-
-registration = await createRegistration(context, registration);
-
-console.log(`New Registration ID: ${registration.registrationId}`);
+const updatedRegistration = await createRegistration(context, registration);
 ```
 
 Updates can be done via the `updateRegistration` method but unlike installations, does not support incremental updates.  Querying for an existing registration can be done with the `getRegistration` method.
 
-```typescript
+```ts snippet:updateRegistration_classical
 import { NotificationHubsClient } from "@azure/notification-hubs";
 
 const client = new NotificationHubsClient("<connection string>", "<hub name>");
-
 const registrationId = "<unique Registration ID>";
-
-let registration = await client.getRegistration(registrationId);
-
-registration.tags.push("likes_sports");
-
-registration = await client.updateRegistration(registration);
+const registration = await client.getRegistration(registrationId);
+if (registration.tags) {
+  registration.tags.push("likes_sports");
+} else {
+  registration.tags = ["likes_sports"];
+}
+const updatedRegistration = await client.updateRegistration(registration);
 ```
 
 Using the modular approach, the code would be as follows:
 
-```typescript
+```ts snippet:updateRegistration_modular
 import {
   createClientContext,
   getRegistration,
-  updateRegistration
+  updateRegistration,
 } from "@azure/notification-hubs/api";
 
 const context = createClientContext("<connection string>", "<hub name>");
-
 const registrationId = "<unique Registration ID>";
-
-let registration = await getRegistration(context, registrationId);
-
-registration.tags.push("likes_sports");
-
-registration = await updateRegistration(context, registration);
+const registration = await getRegistration(context, registrationId);
+if (registration.tags) {
+  registration.tags.push("likes_sports");
+} else {
+  registration.tags = ["likes_sports"];
+}
+const updatedRegistration = await updateRegistration(context, registration);
 ```
 
 Registrations, unlike installations, can be queried to get all registrations, matching registrations to a condition, or by tags.  Registrations can be queried using the `listRegistrations`, `listRegistrationsByChannel` and `listRegistrationsByTag` method.  All methods support limiting via the `top` option and support asynchronous paging.
 
-```typescript
-import { NotificationHubsClient } from "@azure/notification-hubs/api";
+```ts snippet:listRegistrationsByTag_classical
+import { NotificationHubsClient } from "@azure/notification-hubs";
 
 const client = new NotificationHubsClient("<connection string>", "<hub name>");
-
-const registrations = await client.listRegistrationsByTag("likes_hockey");
-
+const registrations = client.listRegistrationsByTag("likes_hockey");
 let page = 0;
 for await (const pages of registrations.byPage()) {
   console.log(`Page number ${page++}`);
@@ -332,13 +299,11 @@ for await (const pages of registrations.byPage()) {
 
 Using the modular approach, the code would be as follows:
 
-```typescript
+```ts snippet:listRegistrationsByTag_modular
 import { createClientContext, listRegistrationsByTag } from "@azure/notification-hubs/api";
 
 const context = createClientContext("<connection string>", "<hub name>");
-
 const registrations = await listRegistrationsByTag(context, "likes_hockey");
-
 let page = 0;
 for await (const pages of registrations.byPage()) {
   console.log(`Page number ${page++}`);
@@ -356,12 +321,8 @@ For debugging purposes, the `enableTestSend` options can be set to `true` which
 
 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 so there is no guessing about which fields are available for each PNS.
 
-```typescript
-// Using the class-based approach
-import { createAppleNotificationBody } from "@azure/notification-hubs";
-
-// Using the modular approach
-import { createAppleNotification, createAppleNotificationBody } from "@azure/notification-hubs/models";
+```ts snippet:createAppleNotificationBody
+import { createAppleNotificationBody, createAppleNotification } from "@azure/notification-hubs";
 
 const apnsBody = createAppleNotificationBody({
   alert: {
@@ -372,29 +333,21 @@ const apnsBody = createAppleNotificationBody({
   sound: "default",
   interruptionLevel: "time-sensitive",
 });
-
 // Send the message using the modular approach
 const notification = createAppleNotification({
-  body: apnsBody
-})
-
-const result = await sendNotification(context, notification);
+  body: apnsBody,
+});
 ```
 
 #### Broadcast Send
 
 Notification Hubs can be used to send notifications to all registered devices per platform using broadcast send through the `sendBroadcastNotification` method.
 
-```typescript
-import {
-  NotificationHubsClient,
-  createAppleNotification,
-} from "@azure/notification-hubs/api";
-
-const context = createClientContext(connectionString, hubName);
+```ts snippet:sendBroadcastNotification_classical
+import { NotificationHubsClient, createAppleNotification } from "@azure/notification-hubs";
 
+const client = new NotificationHubsClient("<connection string>", "<hub name>");
 const messageBody = `{ "aps" : { "alert" : "Hello" } }`;
-
 const message = createAppleNotification({
   body: messageBody,
   headers: {
@@ -402,12 +355,9 @@ const message = createAppleNotification({
     "apns-push-type": "alert",
   },
 });
-
 const result = await client.sendBroadcastNotification(message);
-
 console.log(`Tracking ID: ${result.trackingId}`);
 console.log(`Correlation ID: ${result.correlationId}`);
-
 // Only available in Standard SKU and above
 if (result.notificationId) {
   console.log(`Notification ID: ${result.notificationId}`);
@@ -416,14 +366,12 @@ if (result.notificationId) {
 
 Using the modular approach, the code would be as follows:
 
-```typescript
+```ts snippet:sendBroadcastNotification_modular
 import { createClientContext, sendBroadcastNotification } from "@azure/notification-hubs/api";
-import { createAppleNotification } from "@azure/notification-hubs/models";
-
-const context = createClientContext(connectionString, hubName);
+import { createAppleNotification } from "@azure/notification-hubs";
 
+const context = createClientContext("<connection string>", "<hub name>");
 const messageBody = `{ "aps" : { "alert" : "Hello" } }`;
-
 const message = createAppleNotification({
   body: messageBody,
   headers: {
@@ -431,12 +379,9 @@ const message = createAppleNotification({
     "apns-push-type": "alert",
   },
 });
-
 const result = await sendBroadcastNotification(context, message);
-
 console.log(`Tracking ID: ${result.trackingId}`);
 console.log(`Correlation ID: ${result.correlationId}`);
-
 // Only available in Standard SKU and above
 if (result.notificationId) {
   console.log(`Notification ID: ${result.notificationId}`);
@@ -447,17 +392,12 @@ if (result.notificationId) {
 
 To send directly a device, the user can send using the platform provided unique identifier such as APNs device token by calling the `sendNotification` method with a `deviceHandle` parameter.
 
-```typescript
-import {
-  NotificationHubsClient,
-  createAppleNotification,
-} from "@azure/notification-hubs";
-
-const client = new NotificationHubsClient(connectionString, hubName);
+```ts snippet:directSend_classical
+import { NotificationHubsClient, createAppleNotification } from "@azure/notification-hubs";
 
+const client = new NotificationHubsClient("<connection string>", "<hub name>");
 const deviceHandle = "00fc13adff785122b4ad28809a3420982341241421348097878e577c991de8f0";
 const messageBody = `{ "aps" : { "alert" : "Hello" } }`;
-
 const message = createAppleNotification({
   body: messageBody,
   headers: {
@@ -465,12 +405,9 @@ const message = createAppleNotification({
     "apns-push-type": "alert",
   },
 });
-
 const result = await client.sendNotification(message, { deviceHandle });
-
 console.log(`Tracking ID: ${result.trackingId}`);
 console.log(`Correlation ID: ${result.correlationId}`);
-
 // Only available in Standard SKU and above
 if (result.notificationId) {
   console.log(`Notification ID: ${result.notificationId}`);
@@ -479,15 +416,13 @@ if (result.notificationId) {
 
 Using the modular approach, the code would be as follows:
 
-```typescript
-import { createClientContext, sendDirectNotification } from "@azure/notification-hubs/api";
-import { createAppleNotification } from "@azure/notification-hubs/models";
-
-const context = createClientContext(connectionString, hubName);
+```ts snippet:directSend_modular
+import { createClientContext, sendNotification } from "@azure/notification-hubs/api";
+import { createAppleNotification } from "@azure/notification-hubs";
 
+const context = createClientContext("<connection string>", "<hub name>");
 const deviceHandle = "00fc13adff785122b4ad28809a3420982341241421348097878e577c991de8f0";
 const messageBody = `{ "aps" : { "alert" : "Hello" } }`;
-
 const message = createAppleNotification({
   body: messageBody,
   headers: {
@@ -495,12 +430,9 @@ const message = createAppleNotification({
     "apns-push-type": "alert",
   },
 });
-
 const result = await sendNotification(context, message, { deviceHandle });
-
 console.log(`Tracking ID: ${result.trackingId}`);
 console.log(`Correlation ID: ${result.correlationId}`);
-
 // Only available in Standard SKU and above
 if (result.notificationId) {
   console.log(`Notification ID: ${result.notificationId}`);
@@ -513,33 +445,22 @@ In addition to targeting a single device, a user can target multiple devices usi
 
 If you wish to create a tag expression from an array of tags, there is a Tag Expression Builder available with the `createTagExpression` method which is exposed at the top level import or `@azure/notification-hubs/models/tagExpressionBuilder` modular import which creates an "or tag expression" from the tags.
 
-```typescript
-// Top level import
+```ts snippet:createTagExpression
 import { createTagExpression } from "@azure/notification-hubs";
 
-// Modular import
-import { createTagExpression } from "@azure/notification-hubs/models";
-
 const tags = ["likes_football", "likes_hockey"];
 const tagExpression = createTagExpression(tags);
-
 console.log(tagExpression);
-// likes_football||likes_hockey
 ```
 
 Tag expression messages can be sent using the following code:
 
-```typescript
-import {
-  NotificationHubsClient,
-  createAppleNotification,
-} from "@azure/notification-hubs";
+```ts snippet:sendNotification_classical
+import { NotificationHubsClient, createAppleNotification } from "@azure/notification-hubs";
 
 const client = new NotificationHubsClient("<connection string>", "<hub name>");
-
 const tagExpression = "likes_hockey && likes_football";
 const messageBody = `{ "aps" : { "alert" : "Hello" } }`;
-
 const notification = createAppleNotification({
   body: messageBody,
   headers: {
@@ -547,12 +468,9 @@ const notification = createAppleNotification({
     "apns-push-type": "alert",
   },
 });
-
 const result = await client.sendNotification(notification, { tagExpression });
-
 console.log(`Tracking ID: ${result.trackingId}`);
 console.log(`Correlation ID: ${result.correlationId}`);
-
 // Only available in Standard SKU and above
 if (result.notificationId) {
   console.log(`Notification ID: ${result.notificationId}`);
@@ -561,15 +479,13 @@ if (result.notificationId) {
 
 Using the modular approach, the code would be as follows:
 
-```typescript
+```ts snippet:sendNotification_modular
 import { createClientContext, sendNotification } from "@azure/notification-hubs/api";
-import { createAppleNotification } from "@azure/notification-hubs/models";
+import { createAppleNotification } from "@azure/notification-hubs";
 
 const context = createClientContext("<connection string>", "<hub name>");
-
 const tagExpression = "likes_hockey && likes_football";
 const messageBody = `{ "aps" : { "alert" : "Hello" } }`;
-
 const notification = createAppleNotification({
   body: messageBody,
   headers: {
@@ -577,12 +493,9 @@ const notification = createAppleNotification({
     "apns-push-type": "alert",
   },
 });
-
 const result = await sendNotification(context, notification, { tagExpression });
-
 console.log(`Tracking ID: ${result.trackingId}`);
 console.log(`Correlation ID: ${result.correlationId}`);
-
 // Only available in Standard SKU and above
 if (result.notificationId) {
   console.log(`Notification ID: ${result.notificationId}`);
@@ -593,20 +506,14 @@ if (result.notificationId) {
 
 Push notifications can be scheduled up to seven days in advance with Standard SKU namespaces and above using the `scheduleNotification` method to send to devices with tags or a general broadcast with `scheduleBroadcastNotification`.  This returns a notification ID which can be then used to cancel if necessary via the `cancelScheduledNotification` method.
 
-```typescript
-import {
-  NotificationHubsClient,
-  createAppleNotification,
-} from "@azure/notification-hubs";
+```ts snippet:scheduledSendNotification_classical
+import { NotificationHubsClient, createAppleNotification } from "@azure/notification-hubs";
 
 const client = new NotificationHubsClient("<connection string>", "<hub name>");
-
 const tagExpression = "likes_hockey && likes_football";
 const messageBody = `{ "aps" : { "alert" : "Hello" } }`;
-
 // Schedule 8 hours from now
-const scheduledTime = new Date(Date.now() + (8 * 60 * 60 * 1000));
-
+const scheduledTime = new Date(Date.now() + 8 * 60 * 60 * 1000);
 const message = createAppleNotification({
   body: messageBody,
   headers: {
@@ -614,30 +521,24 @@ const message = createAppleNotification({
     "apns-push-type": "alert",
   },
 });
-
 const result = await client.scheduleNotification(scheduledTime, message, { tagExpression });
-
 console.log(`Tracking ID: ${result.trackingId}`);
 console.log(`Correlation ID: ${result.correlationId}`);
-
 // Can be used to cancel via the cancelScheduledSend method
 console.log(`Notification ID: ${result.notificationId}`);
 ```
 
 Using the modular approach, the code would be as follows:
 
-```typescript
+```ts snippet:scheduledSendNotification_modular
 import { createClientContext, scheduleNotification } from "@azure/notification-hubs/api";
-import { createAppleNotification } from "@azure/notification-hubs/models";
+import { createAppleNotification } from "@azure/notification-hubs";
 
 const context = createClientContext("<connection string>", "<hub name>");
-
 const tagExpression = "likes_hockey && likes_football";
 const messageBody = `{ "aps" : { "alert" : "Hello" } }`;
-
 // Schedule 8 hours from now
-const scheduledTime = new Date(Date.now() + (8 * 60 * 60 * 1000));
-
+const scheduledTime = new Date(Date.now() + 8 * 60 * 60 * 1000);
 const message = createAppleNotification({
   body: messageBody,
   headers: {
@@ -645,12 +546,9 @@ const message = createAppleNotification({
     "apns-push-type": "alert",
   },
 });
-
 const result = await scheduleNotification(context, scheduledTime, message, { tagExpression });
-
 console.log(`Tracking ID: ${result.trackingId}`);
 console.log(`Correlation ID: ${result.correlationId}`);
-
 // Can be used to cancel via the cancelScheduledSend method
 console.log(`Notification ID: ${result.notificationId}`);
 ```
@@ -661,10 +559,6 @@ console.log(`Notification ID: ${result.notificationId}`);
 
 React Native currently does not have support for [`URLSearchParams`] which is used by the Azure Notification Hubs SDK.  In order to use the SDK in React Native, you will need to install the [`url-search-params-polyfill`](https://www.npmjs.com/package/url-search-params-polyfill) package and import it before using the SDK.
 
-```typescript
-import 'url-search-params-polyfill';
-```
-
 We also need to provide polyfill for `TextEncoder` API and async iterator API. Please see our [React Native sample with Expo](https://github.com/Azure/azure-sdk-for-js/blob/main/samples/frameworks/react-native/appconfigBasic/README.md#add-polyfills) for more details.
 
 ### Diagnose Dropped Notifications
@@ -673,20 +567,51 @@ Azure Notification Hubs has a complete guide to troubleshooting problems with dr
 
 [Test send](https://docs.microsoft.com/azure/notification-hubs/notification-hubs-push-notification-fixer#enabletestsend-property) is supported supported in the `sendNotification` and `sendBroadcastNotification` methods with the `enableTestSend` option:
 
-```typescript
-// Using the client
-const result = await client.sendNotification(notification, { tags, enableTestSend: true });
+```ts snippet:testSend_classical
+import { NotificationHubsClient, createAppleNotification } from "@azure/notification-hubs";
+
+const client = new NotificationHubsClient("<connection string>", "<hub name>");
+const tagExpression = "likes_hockey && likes_football";
+const messageBody = `{ "aps" : { "alert" : "Hello" } }`;
+const notification = createAppleNotification({
+  body: messageBody,
+  headers: {
+    "apns-priority": "10",
+    "apns-push-type": "alert",
+  },
+});
+const result = await client.sendNotification(notification, {
+  tagExpression,
+  enableTestSend: true,
+});
+```
+
+```ts snippet:testSend_modular
+import { createClientContext, sendNotification } from "@azure/notification-hubs/api";
+import { createAppleNotification } from "@azure/notification-hubs";
 
-// Using the modular approach
-const result = await sendNotification(context, notification, { tags, enableTestSend: true });
+const context = createClientContext("<connection string>", "<hub name>");
+const tagExpression = "likes_hockey && likes_football";
+const messageBody = `{ "aps" : { "alert" : "Hello" } }`;
+const notification = createAppleNotification({
+  body: messageBody,
+  headers: {
+    "apns-priority": "10",
+    "apns-push-type": "alert",
+  },
+});
+const result = await sendNotification(context, notification, {
+  tagExpression,
+  enableTestSend: true,
+});
 ```
 
 ### Logging
 
 Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment variable to `info`. Alternatively, logging can be enabled at runtime by calling `setLogLevel` in the `@azure/logger`:
 
-```javascript
-const { setLogLevel } = require("@azure/logger");
+```ts snippet:logging
+import { setLogLevel } from "@azure/logger";
 
 setLogLevel("info");
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure/notification-hubs",
-  "version": "2.0.0-alpha.20240919.1",
+  "version": "2.0.0-alpha.20240920.2",
   "description": "Azure Notification Hubs SDK for JavaScript",
   "sdk-type": "client",
   "main": "./dist/commonjs/index.js",
@@ -37,7 +37,8 @@
     "test": "npm run clean && tshy && npm run unit-test:node && npm run build:test && npm run unit-test:browser && npm run integration-test",
     "unit-test:browser": "npm run build:test && dev-tool run test:vitest --no-test-proxy --browser -- -c vitest.browser.unit.config.ts",
     "unit-test:node": "dev-tool run test:vitest --no-test-proxy -- -c vitest.unit.config.ts",
-    "unit-test": "npm run unit-test:node && npm run unit-test:browser"
+    "unit-test": "npm run unit-test:node && npm run unit-test:browser",
+    "update-snippets": "tshy && dev-tool run update-snippets"
   },
   "files": [
     "dist/",
@@ -75,7 +76,7 @@
     "rimraf": "^5.0.5",
     "tshy": "^2.0.0",
     "tsx": "^4.19.1",
-    "typescript": "~5.6.2",
+    "typescript": "~5.5.3",
     "vitest": "^2.0.5"
   },
   "dependencies": {