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

package/dist-esm/src/api/listRegistrations.js

@@ -0,0 +1,35 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+import { tracingClient } from "../utils/tracing.js";
+import { listRegistrationPagingPage, listRegistrationsAll } from "./internal/_listRegistrations.js";
+/**
+ * Gets all registrations for the notification hub with the given query options.
+ * @param context - The Notification Hubs client.
+ * @param options - The options for querying the registrations such as $top.
+ * @returns A paged async iterable containing all of the registrations for the notification hub.
+ */
+export function listRegistrations(context, options = {}) {
+    const { span, updatedOptions } = tracingClient.startSpan("NotificationHubsClientContext.listRegistrations", options);
+    try {
+        const iter = listRegistrationsAll(context, updatedOptions);
+        return {
+            next() {
+                return iter.next();
+            },
+            [Symbol.asyncIterator]() {
+                return this;
+            },
+            byPage: () => {
+                return listRegistrationPagingPage(context, updatedOptions);
+            },
+        };
+    }
+    catch (e) {
+        span.setStatus({ status: "error", error: e });
+        throw e;
+    }
+    finally {
+        span.end();
+    }
+}
+//# sourceMappingURL=listRegistrations.js.map

package/dist-esm/src/api/listRegistrations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"listRegistrations.js","sourceRoot":"","sources":["../../../src/api/listRegistrations.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAMlC,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,0BAA0B,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AAEpG;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAC/B,OAAsC,EACtC,UAAyC,EAAE;IAE3C,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,aAAa,CAAC,SAAS,CACtD,iDAAiD,EACjD,OAAO,CACR,CAAC;IACF,IAAI;QACF,MAAM,IAAI,GAAG,oBAAoB,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;QAC3D,OAAO;YACL,IAAI;gBACF,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;YACrB,CAAC;YACD,CAAC,MAAM,CAAC,aAAa,CAAC;gBACpB,OAAO,IAAI,CAAC;YACd,CAAC;YACD,MAAM,EAAE,GAAG,EAAE;gBACX,OAAO,0BAA0B,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;YAC7D,CAAC;SACF,CAAC;KACH;IAAC,OAAO,CAAM,EAAE;QACf,IAAI,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;QAC9C,MAAM,CAAC,CAAC;KACT;YAAS;QACR,IAAI,CAAC,GAAG,EAAE,CAAC;KACZ;AACH,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { NotificationHubsClientContext } from \"./index.js\";\nimport { PagedAsyncIterableIterator } from \"@azure/core-paging\";\nimport { RegistrationDescription } from \"../models/registration.js\";\nimport { RegistrationQueryLimitOptions } from \"../models/options.js\";\nimport { tracingClient } from \"../utils/tracing.js\";\nimport { listRegistrationPagingPage, listRegistrationsAll } from \"./internal/_listRegistrations.js\";\n\n/**\n * Gets all registrations for the notification hub with the given query options.\n * @param context - The Notification Hubs client.\n * @param options - The options for querying the registrations such as $top.\n * @returns A paged async iterable containing all of the registrations for the notification hub.\n */\nexport function listRegistrations(\n  context: NotificationHubsClientContext,\n  options: RegistrationQueryLimitOptions = {}\n): PagedAsyncIterableIterator<RegistrationDescription> {\n  const { span, updatedOptions } = tracingClient.startSpan(\n    \"NotificationHubsClientContext.listRegistrations\",\n    options\n  );\n  try {\n    const iter = listRegistrationsAll(context, updatedOptions);\n    return {\n      next() {\n        return iter.next();\n      },\n      [Symbol.asyncIterator]() {\n        return this;\n      },\n      byPage: () => {\n        return listRegistrationPagingPage(context, updatedOptions);\n      },\n    };\n  } catch (e: any) {\n    span.setStatus({ status: \"error\", error: e });\n    throw e;\n  } finally {\n    span.end();\n  }\n}\n"]}

package/dist-esm/src/api/listRegistrationsByChannel.js

@@ -0,0 +1,58 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+import { listRegistrationPagingPage, listRegistrationsAll } from "./internal/_listRegistrations.js";
+import { RestError } from "@azure/core-rest-pipeline";
+import { tracingClient } from "../utils/tracing.js";
+/**
+ * Gets all registrations for the notification hub with the given device information and options.
+ * @param context - The Notification Hubs client.
+ * @param channel - The Registration channel information to query per PNS type.
+ * @param options - The options for querying the registrations such as $top.
+ * @returns A paged async iterable containing all of the registrations for the notification hub.
+ */
+export function listRegistrationsByChannel(context, channel, options = {}) {
+    const newOptions = Object.assign(Object.assign({}, options), { filter: getFilterByChannel(channel) });
+    const { span, updatedOptions } = tracingClient.startSpan("NotificationHubsClientContext.listRegistrationsByDevice", newOptions);
+    try {
+        const iter = listRegistrationsAll(context, updatedOptions);
+        return {
+            next() {
+                return iter.next();
+            },
+            [Symbol.asyncIterator]() {
+                return this;
+            },
+            byPage: () => {
+                return listRegistrationPagingPage(context, updatedOptions);
+            },
+        };
+    }
+    catch (e) {
+        span.setStatus({ status: "error", error: e });
+        throw e;
+    }
+    finally {
+        span.end();
+    }
+}
+function getFilterByChannel(device) {
+    switch (device.kind) {
+        case "adm":
+            return `AdmRegistrationId eq '${device.admRegistrationId}'`;
+        case "apple":
+            return `DeviceToken eq '${device.deviceToken.toLocaleUpperCase()}'`;
+        case "baidu":
+            return `BaiduChannelId eq ${device.baiduChannelId}' and BaiduUserId eq '${device.baiduUserId}'`;
+        case "browser":
+            return `Endpoint eq '${encodeURIComponent(device.endpoint)}' and P256DH eq '${device.p256dh}' and Auth eq '${device.auth}'`;
+        case "gcm":
+            return `GcmRegistrationId eq '${device.gcmRegistrationId}'`;
+        case "windows":
+            return `ChannelUri eq '${encodeURIComponent(device.channelUri)}'`;
+        default:
+            throw new RestError(`Device type is unsupported`, {
+                statusCode: 400,
+            });
+    }
+}
+//# sourceMappingURL=listRegistrationsByChannel.js.map

package/dist-esm/src/api/listRegistrationsByChannel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"listRegistrationsByChannel.js","sourceRoot":"","sources":["../../../src/api/listRegistrationsByChannel.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,EAAE,0BAA0B,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AAGpG,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAEtD,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEpD;;;;;;GAMG;AACH,MAAM,UAAU,0BAA0B,CACxC,OAAsC,EACtC,OAA4B,EAC5B,UAAyC,EAAE;IAE3C,MAAM,UAAU,mCACX,OAAO,KACV,MAAM,EAAE,kBAAkB,CAAC,OAAO,CAAC,GACpC,CAAC;IACF,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,aAAa,CAAC,SAAS,CACtD,yDAAyD,EACzD,UAAU,CACX,CAAC;IACF,IAAI;QACF,MAAM,IAAI,GAAG,oBAAoB,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;QAC3D,OAAO;YACL,IAAI;gBACF,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;YACrB,CAAC;YACD,CAAC,MAAM,CAAC,aAAa,CAAC;gBACpB,OAAO,IAAI,CAAC;YACd,CAAC;YACD,MAAM,EAAE,GAAG,EAAE;gBACX,OAAO,0BAA0B,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;YAC7D,CAAC;SACF,CAAC;KACH;IAAC,OAAO,CAAM,EAAE;QACf,IAAI,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;QAC9C,MAAM,CAAC,CAAC;KACT;YAAS;QACR,IAAI,CAAC,GAAG,EAAE,CAAC;KACZ;AACH,CAAC;AAED,SAAS,kBAAkB,CAAC,MAA2B;IACrD,QAAQ,MAAM,CAAC,IAAI,EAAE;QACnB,KAAK,KAAK;YACR,OAAO,yBAAyB,MAAM,CAAC,iBAAiB,GAAG,CAAC;QAC9D,KAAK,OAAO;YACV,OAAO,mBAAmB,MAAM,CAAC,WAAW,CAAC,iBAAiB,EAAE,GAAG,CAAC;QACtE,KAAK,OAAO;YACV,OAAO,qBAAqB,MAAM,CAAC,cAAc,yBAAyB,MAAM,CAAC,WAAW,GAAG,CAAC;QAClG,KAAK,SAAS;YACZ,OAAO,gBAAgB,kBAAkB,CAAC,MAAM,CAAC,QAAQ,CAAC,oBACxD,MAAM,CAAC,MACT,kBAAkB,MAAM,CAAC,IAAI,GAAG,CAAC;QACnC,KAAK,KAAK;YACR,OAAO,yBAAyB,MAAM,CAAC,iBAAiB,GAAG,CAAC;QAC9D,KAAK,SAAS;YACZ,OAAO,kBAAkB,kBAAkB,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC;QACpE;YACE,MAAM,IAAI,SAAS,CAAC,4BAA4B,EAAE;gBAChD,UAAU,EAAE,GAAG;aAChB,CAAC,CAAC;KACN;AACH,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { RegistrationDescription, RegistrationChannel } from \"../models/registration.js\";\nimport { listRegistrationPagingPage, listRegistrationsAll } from \"./internal/_listRegistrations.js\";\nimport { NotificationHubsClientContext } from \"./index.js\";\nimport { PagedAsyncIterableIterator } from \"@azure/core-paging\";\nimport { RestError } from \"@azure/core-rest-pipeline\";\nimport { RegistrationQueryLimitOptions } from \"../models/options.js\";\nimport { tracingClient } from \"../utils/tracing.js\";\n\n/**\n * Gets all registrations for the notification hub with the given device information and options.\n * @param context - The Notification Hubs client.\n * @param channel - The Registration channel information to query per PNS type.\n * @param options - The options for querying the registrations such as $top.\n * @returns A paged async iterable containing all of the registrations for the notification hub.\n */\nexport function listRegistrationsByChannel(\n  context: NotificationHubsClientContext,\n  channel: RegistrationChannel,\n  options: RegistrationQueryLimitOptions = {}\n): PagedAsyncIterableIterator<RegistrationDescription> {\n  const newOptions = {\n    ...options,\n    filter: getFilterByChannel(channel),\n  };\n  const { span, updatedOptions } = tracingClient.startSpan(\n    \"NotificationHubsClientContext.listRegistrationsByDevice\",\n    newOptions\n  );\n  try {\n    const iter = listRegistrationsAll(context, updatedOptions);\n    return {\n      next() {\n        return iter.next();\n      },\n      [Symbol.asyncIterator]() {\n        return this;\n      },\n      byPage: () => {\n        return listRegistrationPagingPage(context, updatedOptions);\n      },\n    };\n  } catch (e: any) {\n    span.setStatus({ status: \"error\", error: e });\n    throw e;\n  } finally {\n    span.end();\n  }\n}\n\nfunction getFilterByChannel(device: RegistrationChannel): string {\n  switch (device.kind) {\n    case \"adm\":\n      return `AdmRegistrationId eq '${device.admRegistrationId}'`;\n    case \"apple\":\n      return `DeviceToken eq '${device.deviceToken.toLocaleUpperCase()}'`;\n    case \"baidu\":\n      return `BaiduChannelId eq ${device.baiduChannelId}' and BaiduUserId eq '${device.baiduUserId}'`;\n    case \"browser\":\n      return `Endpoint eq '${encodeURIComponent(device.endpoint)}' and P256DH eq '${\n        device.p256dh\n      }' and Auth eq '${device.auth}'`;\n    case \"gcm\":\n      return `GcmRegistrationId eq '${device.gcmRegistrationId}'`;\n    case \"windows\":\n      return `ChannelUri eq '${encodeURIComponent(device.channelUri)}'`;\n    default:\n      throw new RestError(`Device type is unsupported`, {\n        statusCode: 400,\n      });\n  }\n}\n"]}

package/dist-esm/src/{client → api}/listRegistrationsByTag.js

@@ -13,7 +13,7 @@ const OPERATION_NAME = "listRegistrationsByTag";
  * @returns A paged async iterable containing the matching registrations for the notification hub.
  */
 export function listRegistrationsByTag(context, tag, options = {}) {
-    const { span, updatedOptions } = tracingClient.startSpan(`NotificationHubsClientContext-${OPERATION_NAME}`, options);
+    const { span, updatedOptions } = tracingClient.startSpan(`NotificationHubsClientContext.${OPERATION_NAME}`, options);
     try {
         const iter = listRegistrationsByTagAll(context, tag, updatedOptions);
         return {

package/dist-esm/src/api/listRegistrationsByTag.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"listRegistrationsByTag.js","sourceRoot":"","sources":["../../../src/api/listRegistrationsByTag.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;;AAElC,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAMnE,OAAO,EAAE,6BAA6B,EAAE,MAAM,0CAA0C,CAAC;AACzF,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEpD,MAAM,cAAc,GAAG,wBAAwB,CAAC;AAEhD;;;;;;GAMG;AACH,MAAM,UAAU,sBAAsB,CACpC,OAAsC,EACtC,GAAW,EACX,UAAyC,EAAE;IAE3C,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,aAAa,CAAC,SAAS,CACtD,iCAAiC,cAAc,EAAE,EACjD,OAAO,CACR,CAAC;IACF,IAAI;QACF,MAAM,IAAI,GAAG,yBAAyB,CAAC,OAAO,EAAE,GAAG,EAAE,cAAc,CAAC,CAAC;QACrE,OAAO;YACL,IAAI;gBACF,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;YACrB,CAAC;YACD,CAAC,MAAM,CAAC,aAAa,CAAC;gBACpB,OAAO,IAAI,CAAC;YACd,CAAC;YACD,MAAM,EAAE,GAAG,EAAE;gBACX,OAAO,gCAAgC,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;YACjE,CAAC;SACF,CAAC;KACH;IAAC,OAAO,CAAM,EAAE;QACf,IAAI,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;QAC9C,MAAM,CAAC,CAAC;KACT;YAAS;QACR,IAAI,CAAC,GAAG,EAAE,CAAC;KACZ;AACH,CAAC;AAED,SAAgB,yBAAyB,CACvC,OAAsC,EACtC,GAAW,EACX,OAAsC;;;;YAEtC,KAAyB,IAAA,KAAA,cAAA,gCAAgC,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,CAAC,CAAA,IAAA;gBAArE,MAAM,IAAI,WAAA,CAAA;gBACnB,cAAA,KAAK,CAAC,CAAC,iBAAA,cAAA,IAAI,CAAA,CAAA,CAAA,CAAC;aACb;;;;;;;;;IACH,CAAC;CAAA;AAED,SAAgB,gCAAgC,CAC9C,OAAsC,EACtC,GAAW,EACX,OAAsC;;QAEtC,IAAI,MAAM,GAAG,cAAM,uBAAuB,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,CAAC,CAAA,CAAC;QAClE,oBAAM,MAAM,CAAC,aAAa,IAAI,EAAE,CAAA,CAAC;QACjC,IAAI,iBAAiB,GAAG,MAAM,CAAC,iBAAiB,CAAC;QACjD,OAAO,iBAAiB,EAAE;YACxB,MAAM,GAAG,cAAM,uBAAuB,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,iBAAiB,CAAC,CAAA,CAAC;YACjF,iBAAiB,GAAG,MAAM,CAAC,iBAAiB,CAAC;YAC7C,oBAAM,MAAM,CAAC,aAAa,IAAI,EAAE,CAAA,CAAC;SAClC;IACH,CAAC;CAAA;AAED,KAAK,UAAU,uBAAuB,CACpC,OAAsC,EACtC,GAAW,EACX,OAAsC,EACtC,iBAA0B;IAE1B,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IACtC,QAAQ,CAAC,QAAQ,IAAI,SAAS,GAAG,gBAAgB,CAAC;IAClD,IAAI,OAAO,CAAC,GAAG,KAAK,SAAS,EAAE;QAC7B,QAAQ,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;KACrD;IAED,IAAI,iBAAiB,KAAK,SAAS,EAAE;QACnC,QAAQ,CAAC,YAAY,CAAC,GAAG,CAAC,mBAAmB,EAAE,iBAAiB,CAAC,CAAC;KACnE;IAED,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;IAC5D,MAAM,OAAO,GAAG,aAAa,CAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IACjE,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC;IAE1D,MAAM,aAAa,GAAG,MAAM,6BAA6B,CAAC,qBAAqB,CAC7E,QAAQ,CAAC,UAAW,CACrB,CAAC;IACF,MAAM,SAAS,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC;IACjE,OAAO;QACL,aAAa;QACb,iBAAiB,EAAE,SAAS;KAC7B,CAAC;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { createRequest, sendRequest } from \"./internal/_client.js\";\nimport { NotificationHubsClientContext } from \"./index.js\";\nimport { PagedAsyncIterableIterator } from \"@azure/core-paging\";\nimport { RegistrationDescription } from \"../models/registration.js\";\nimport { RegistrationQueryLimitOptions } from \"../models/options.js\";\nimport { RegistrationQueryResponse } from \"../models/response.js\";\nimport { registrationDescriptionParser } from \"../serializers/registrationSerializer.js\";\nimport { tracingClient } from \"../utils/tracing.js\";\n\nconst OPERATION_NAME = \"listRegistrationsByTag\";\n\n/**\n * Lists all registrations with the matching tag.\n * @param context - The Notification Hubs client.\n * @param tag - The tag to query for matching registrations.\n * @param options - The query options such as $top.\n * @returns A paged async iterable containing the matching registrations for the notification hub.\n */\nexport function listRegistrationsByTag(\n  context: NotificationHubsClientContext,\n  tag: string,\n  options: RegistrationQueryLimitOptions = {}\n): PagedAsyncIterableIterator<RegistrationDescription> {\n  const { span, updatedOptions } = tracingClient.startSpan(\n    `NotificationHubsClientContext.${OPERATION_NAME}`,\n    options\n  );\n  try {\n    const iter = listRegistrationsByTagAll(context, tag, updatedOptions);\n    return {\n      next() {\n        return iter.next();\n      },\n      [Symbol.asyncIterator]() {\n        return this;\n      },\n      byPage: () => {\n        return listRegistrationsByTagPagingPage(context, tag, options);\n      },\n    };\n  } catch (e: any) {\n    span.setStatus({ status: \"error\", error: e });\n    throw e;\n  } finally {\n    span.end();\n  }\n}\n\nasync function* listRegistrationsByTagAll(\n  context: NotificationHubsClientContext,\n  tag: string,\n  options: RegistrationQueryLimitOptions\n): AsyncIterableIterator<RegistrationDescription> {\n  for await (const page of listRegistrationsByTagPagingPage(context, tag, options)) {\n    yield* page;\n  }\n}\n\nasync function* listRegistrationsByTagPagingPage(\n  context: NotificationHubsClientContext,\n  tag: string,\n  options: RegistrationQueryLimitOptions\n): AsyncIterableIterator<RegistrationDescription[]> {\n  let result = await _listRegistrationsByTag(context, tag, options);\n  yield result.registrations || [];\n  let continuationToken = result.continuationToken;\n  while (continuationToken) {\n    result = await _listRegistrationsByTag(context, tag, options, continuationToken);\n    continuationToken = result.continuationToken;\n    yield result.registrations || [];\n  }\n}\n\nasync function _listRegistrationsByTag(\n  context: NotificationHubsClientContext,\n  tag: string,\n  options: RegistrationQueryLimitOptions,\n  continuationToken?: string\n): Promise<RegistrationQueryResponse> {\n  const endpoint = context.requestUrl();\n  endpoint.pathname += `/tags/${tag}/registrations`;\n  if (options.top !== undefined) {\n    endpoint.searchParams.set(\"$top\", `${options.top}`);\n  }\n\n  if (continuationToken !== undefined) {\n    endpoint.searchParams.set(\"continuationtoken\", continuationToken);\n  }\n\n  const headers = await context.createHeaders(OPERATION_NAME);\n  const request = createRequest(endpoint, \"GET\", headers, options);\n  const response = await sendRequest(context, request, 200);\n\n  const registrations = await registrationDescriptionParser.parseRegistrationFeed(\n    response.bodyAsText!\n  );\n  const nextToken = response.headers.get(\"x-ms-continuationtoken\");\n  return {\n    registrations,\n    continuationToken: nextToken,\n  };\n}\n"]}

package/dist-esm/src/api/scheduleNotification.js

@@ -0,0 +1,31 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+import { createRequest, parseNotificationSendResponse, sendRequest } from "./internal/_client.js";
+import { tracingClient } from "../utils/tracing.js";
+/**
+ * Schedules a push notification to devices that match the given tags or tag expression at the specified time.
+ * NOTE: This is only available in Standard SKU Azure Notification Hubs.
+ * @param context - The Notification Hubs client.
+ * @param scheduledTime - The Date to send the push notification.
+ * @param notification - The notification to send to the matching devices.
+ * @param options - Options which include tags used to target the device for push notifications in either an array or tag expression.
+ * @returns A NotificationHubResponse with the tracking ID, correlation ID and location.
+ */
+export function scheduleNotification(context, scheduledTime, notification, options = {}) {
+    return tracingClient.withSpan(`NotificationHubsClientContext.scheduleNotification`, options, async (updatedOptions) => {
+        const endpoint = context.requestUrl();
+        endpoint.pathname += "/schedulednotifications/";
+        const headers = await context.createHeaders("scheduleNotification", notification.headers);
+        headers.set("ServiceBusNotification-ScheduleTime", scheduledTime.toISOString());
+        headers.set("Content-Type", notification.contentType);
+        headers.set("ServiceBusNotification-Format", notification.platform);
+        if (options.tagExpression) {
+            headers.set("ServiceBusNotification-Tags", options.tagExpression);
+        }
+        const request = createRequest(endpoint, "POST", headers, updatedOptions);
+        request.body = notification.body;
+        const response = await sendRequest(context, request, 201);
+        return parseNotificationSendResponse(response);
+    });
+}
+//# sourceMappingURL=scheduleNotification.js.map

package/dist-esm/src/api/scheduleNotification.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scheduleNotification.js","sourceRoot":"","sources":["../../../src/api/scheduleNotification.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,aAAa,EAAE,6BAA6B,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAKlG,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEpD;;;;;;;;GAQG;AACH,MAAM,UAAU,oBAAoB,CAClC,OAAsC,EACtC,aAAmB,EACnB,YAA0B,EAC1B,UAAuC,EAAE;IAEzC,OAAO,aAAa,CAAC,QAAQ,CAC3B,oDAAoD,EACpD,OAAO,EACP,KAAK,EAAE,cAAc,EAAE,EAAE;QACvB,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;QACtC,QAAQ,CAAC,QAAQ,IAAI,0BAA0B,CAAC;QAEhD,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,aAAa,CAAC,sBAAsB,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC;QAC1F,OAAO,CAAC,GAAG,CAAC,qCAAqC,EAAE,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC;QAChF,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,YAAY,CAAC,WAAW,CAAC,CAAC;QACtD,OAAO,CAAC,GAAG,CAAC,+BAA+B,EAAE,YAAY,CAAC,QAAQ,CAAC,CAAC;QAEpE,IAAI,OAAO,CAAC,aAAa,EAAE;YACzB,OAAO,CAAC,GAAG,CAAC,6BAA6B,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;SACnE;QAED,MAAM,OAAO,GAAG,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc,CAAC,CAAC;QACzE,OAAO,CAAC,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC;QAEjC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC;QAE1D,OAAO,6BAA6B,CAAC,QAAQ,CAAC,CAAC;IACjD,CAAC,CACF,CAAC;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { createRequest, parseNotificationSendResponse, sendRequest } from \"./internal/_client.js\";\nimport { Notification } from \"../models/notification.js\";\nimport { NotificationHubsClientContext } from \"./index.js\";\nimport { NotificationHubsMessageResponse } from \"../models/notificationDetails.js\";\nimport { ScheduleNotificationOptions } from \"../models/options.js\";\nimport { tracingClient } from \"../utils/tracing.js\";\n\n/**\n * Schedules a push notification to devices that match the given tags or tag expression at the specified time.\n * NOTE: This is only available in Standard SKU Azure Notification Hubs.\n * @param context - The Notification Hubs client.\n * @param scheduledTime - The Date to send the push notification.\n * @param notification - The notification to send to the matching devices.\n * @param options - Options which include tags used to target the device for push notifications in either an array or tag expression.\n * @returns A NotificationHubResponse with the tracking ID, correlation ID and location.\n */\nexport function scheduleNotification(\n  context: NotificationHubsClientContext,\n  scheduledTime: Date,\n  notification: Notification,\n  options: ScheduleNotificationOptions = {}\n): Promise<NotificationHubsMessageResponse> {\n  return tracingClient.withSpan(\n    `NotificationHubsClientContext.scheduleNotification`,\n    options,\n    async (updatedOptions) => {\n      const endpoint = context.requestUrl();\n      endpoint.pathname += \"/schedulednotifications/\";\n\n      const headers = await context.createHeaders(\"scheduleNotification\", notification.headers);\n      headers.set(\"ServiceBusNotification-ScheduleTime\", scheduledTime.toISOString());\n      headers.set(\"Content-Type\", notification.contentType);\n      headers.set(\"ServiceBusNotification-Format\", notification.platform);\n\n      if (options.tagExpression) {\n        headers.set(\"ServiceBusNotification-Tags\", options.tagExpression);\n      }\n\n      const request = createRequest(endpoint, \"POST\", headers, updatedOptions);\n      request.body = notification.body;\n\n      const response = await sendRequest(context, request, 201);\n\n      return parseNotificationSendResponse(response);\n    }\n  );\n}\n"]}

package/dist-esm/src/api/sendNotification.js

@@ -0,0 +1,63 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+import { createRequest, parseNotificationSendResponse, sendRequest } from "./internal/_client.js";
+import { isDirectSendNotificationOptions, isSendNotificationOptions, } from "../utils/optionUtils.js";
+import { createMultipartDirectNotification } from "../utils/notificationUtils.js";
+import { tracingClient } from "../utils/tracing.js";
+import { v4 as uuid } from "uuid";
+/**
+ * Sends push notifications to devices that match the given tags or tag expression.
+ * @param context - The Notification Hubs client.
+ * @param notification - The notification to send to the matching devices.
+ * @param options - Options for the notification including tags, device handles and whether to enable test send.
+ * @returns A NotificationHubResponse with the tracking ID, correlation ID and location.
+ */
+export function sendNotification(context, notification, options = { enableTestSend: false }) {
+    return tracingClient.withSpan(`NotificationHubsClientContext.sendNotification`, options, async (updatedOptions) => {
+        const endpoint = context.requestUrl();
+        endpoint.pathname += "/messages/";
+        // Check if batch direct send
+        if (isDirectSendNotificationOptions(options) && Array.isArray(options.deviceHandle)) {
+            endpoint.pathname += "$batch";
+        }
+        // Check for test send
+        if (isSendNotificationOptions(options) && options.enableTestSend) {
+            endpoint.searchParams.append("test", "true");
+        }
+        const headers = await context.createHeaders("sendNotification", notification.headers);
+        headers.set("ServiceBusNotification-Format", notification.platform);
+        let body = notification.body;
+        let contentType = notification.contentType;
+        // Check for direct batch send
+        if (isDirectSendNotificationOptions(options) && Array.isArray(options.deviceHandle)) {
+            endpoint.searchParams.append("direct", "true");
+            const boundary = `nh-boundary-${uuid()}`;
+            contentType = `multipart/mixed; boundary = "${boundary}"`;
+            body = createMultipartDirectNotification(boundary, notification, options.deviceHandle);
+        }
+        else if (isDirectSendNotificationOptions(options)) {
+            endpoint.searchParams.append("direct", "true");
+            if (notification.platform === "browser") {
+                const browserHandle = options.deviceHandle;
+                headers.set("ServiceBusNotification-DeviceHandle", browserHandle.endpoint);
+                headers.set("Auth", browserHandle.auth);
+                headers.set("P256DH", browserHandle.p256dh);
+            }
+            else {
+                headers.set("ServiceBusNotification-DeviceHandle", options.deviceHandle);
+            }
+        }
+        else if (isSendNotificationOptions(options)) {
+            if (options.tagExpression) {
+                headers.set("ServiceBusNotification-Tags", options.tagExpression);
+            }
+        }
+        headers.set("Content-Type", contentType);
+        headers.set("ServiceBusNotification-Format", notification.platform);
+        const request = createRequest(endpoint, "POST", headers, updatedOptions);
+        request.body = body;
+        const response = await sendRequest(context, request, 201);
+        return parseNotificationSendResponse(response);
+    });
+}
+//# sourceMappingURL=sendNotification.js.map

package/dist-esm/src/api/sendNotification.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sendNotification.js","sourceRoot":"","sources":["../../../src/api/sendNotification.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,EAAE,aAAa,EAAE,6BAA6B,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAClG,OAAO,EACL,+BAA+B,EAC/B,yBAAyB,GAC1B,MAAM,yBAAyB,CAAC;AAKjC,OAAO,EAAE,iCAAiC,EAAE,MAAM,+BAA+B,CAAC;AAClF,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,EAAE,IAAI,IAAI,EAAE,MAAM,MAAM,CAAC;AAElC;;;;;;GAMG;AACH,MAAM,UAAU,gBAAgB,CAC9B,OAAsC,EACtC,YAA0B,EAC1B,UAAmE,EAAE,cAAc,EAAE,KAAK,EAAE;IAE5F,OAAO,aAAa,CAAC,QAAQ,CAC3B,gDAAgD,EAChD,OAAO,EACP,KAAK,EAAE,cAAc,EAAE,EAAE;QACvB,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;QACtC,QAAQ,CAAC,QAAQ,IAAI,YAAY,CAAC;QAElC,6BAA6B;QAC7B,IAAI,+BAA+B,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE;YACnF,QAAQ,CAAC,QAAQ,IAAI,QAAQ,CAAC;SAC/B;QAED,sBAAsB;QACtB,IAAI,yBAAyB,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,cAAc,EAAE;YAChE,QAAQ,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;SAC9C;QAED,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,aAAa,CAAC,kBAAkB,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC;QACtF,OAAO,CAAC,GAAG,CAAC,+BAA+B,EAAE,YAAY,CAAC,QAAQ,CAAC,CAAC;QAEpE,IAAI,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC;QAC7B,IAAI,WAAW,GAAW,YAAY,CAAC,WAAW,CAAC;QAEnD,8BAA8B;QAC9B,IAAI,+BAA+B,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE;YACnF,QAAQ,CAAC,YAAY,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YAC/C,MAAM,QAAQ,GAAG,eAAe,IAAI,EAAE,EAAE,CAAC;YACzC,WAAW,GAAG,gCAAgC,QAAQ,GAAG,CAAC;YAC1D,IAAI,GAAG,iCAAiC,CAAC,QAAQ,EAAE,YAAY,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;SACxF;aAAM,IAAI,+BAA+B,CAAC,OAAO,CAAC,EAAE;YACnD,QAAQ,CAAC,YAAY,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YAE/C,IAAI,YAAY,CAAC,QAAQ,KAAK,SAAS,EAAE;gBACvC,MAAM,aAAa,GAAG,OAAO,CAAC,YAAkC,CAAC;gBACjE,OAAO,CAAC,GAAG,CAAC,qCAAqC,EAAE,aAAa,CAAC,QAAQ,CAAC,CAAC;gBAC3E,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC;gBACxC,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;aAC7C;iBAAM;gBACL,OAAO,CAAC,GAAG,CAAC,qCAAqC,EAAE,OAAO,CAAC,YAAsB,CAAC,CAAC;aACpF;SACF;aAAM,IAAI,yBAAyB,CAAC,OAAO,CAAC,EAAE;YAC7C,IAAI,OAAO,CAAC,aAAa,EAAE;gBACzB,OAAO,CAAC,GAAG,CAAC,6BAA6B,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;aACnE;SACF;QAED,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC;QACzC,OAAO,CAAC,GAAG,CAAC,+BAA+B,EAAE,YAAY,CAAC,QAAQ,CAAC,CAAC;QAEpE,MAAM,OAAO,GAAG,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc,CAAC,CAAC;QACzE,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;QAEpB,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC;QAE1D,OAAO,6BAA6B,CAAC,QAAQ,CAAC,CAAC;IACjD,CAAC,CACF,CAAC;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { DirectSendNotificationOptions, SendNotificationOptions } from \"../models/options.js\";\nimport { createRequest, parseNotificationSendResponse, sendRequest } from \"./internal/_client.js\";\nimport {\n  isDirectSendNotificationOptions,\n  isSendNotificationOptions,\n} from \"../utils/optionUtils.js\";\nimport { BrowserPushChannel } from \"../models/installation.js\";\nimport { Notification } from \"../models/notification.js\";\nimport { NotificationHubsClientContext } from \"./index.js\";\nimport { NotificationHubsMessageResponse } from \"../models/notificationDetails.js\";\nimport { createMultipartDirectNotification } from \"../utils/notificationUtils.js\";\nimport { tracingClient } from \"../utils/tracing.js\";\nimport { v4 as uuid } from \"uuid\";\n\n/**\n * Sends push notifications to devices that match the given tags or tag expression.\n * @param context - The Notification Hubs client.\n * @param notification - The notification to send to the matching devices.\n * @param options - Options for the notification including tags, device handles and whether to enable test send.\n * @returns A NotificationHubResponse with the tracking ID, correlation ID and location.\n */\nexport function sendNotification(\n  context: NotificationHubsClientContext,\n  notification: Notification,\n  options: DirectSendNotificationOptions | SendNotificationOptions = { enableTestSend: false }\n): Promise<NotificationHubsMessageResponse> {\n  return tracingClient.withSpan(\n    `NotificationHubsClientContext.sendNotification`,\n    options,\n    async (updatedOptions) => {\n      const endpoint = context.requestUrl();\n      endpoint.pathname += \"/messages/\";\n\n      // Check if batch direct send\n      if (isDirectSendNotificationOptions(options) && Array.isArray(options.deviceHandle)) {\n        endpoint.pathname += \"$batch\";\n      }\n\n      // Check for test send\n      if (isSendNotificationOptions(options) && options.enableTestSend) {\n        endpoint.searchParams.append(\"test\", \"true\");\n      }\n\n      const headers = await context.createHeaders(\"sendNotification\", notification.headers);\n      headers.set(\"ServiceBusNotification-Format\", notification.platform);\n\n      let body = notification.body;\n      let contentType: string = notification.contentType;\n\n      // Check for direct batch send\n      if (isDirectSendNotificationOptions(options) && Array.isArray(options.deviceHandle)) {\n        endpoint.searchParams.append(\"direct\", \"true\");\n        const boundary = `nh-boundary-${uuid()}`;\n        contentType = `multipart/mixed; boundary = \"${boundary}\"`;\n        body = createMultipartDirectNotification(boundary, notification, options.deviceHandle);\n      } else if (isDirectSendNotificationOptions(options)) {\n        endpoint.searchParams.append(\"direct\", \"true\");\n\n        if (notification.platform === \"browser\") {\n          const browserHandle = options.deviceHandle as BrowserPushChannel;\n          headers.set(\"ServiceBusNotification-DeviceHandle\", browserHandle.endpoint);\n          headers.set(\"Auth\", browserHandle.auth);\n          headers.set(\"P256DH\", browserHandle.p256dh);\n        } else {\n          headers.set(\"ServiceBusNotification-DeviceHandle\", options.deviceHandle as string);\n        }\n      } else if (isSendNotificationOptions(options)) {\n        if (options.tagExpression) {\n          headers.set(\"ServiceBusNotification-Tags\", options.tagExpression);\n        }\n      }\n\n      headers.set(\"Content-Type\", contentType);\n      headers.set(\"ServiceBusNotification-Format\", notification.platform);\n\n      const request = createRequest(endpoint, \"POST\", headers, updatedOptions);\n      request.body = body;\n\n      const response = await sendRequest(context, request, 201);\n\n      return parseNotificationSendResponse(response);\n    }\n  );\n}\n"]}

package/dist-esm/src/{client → api}/submitNotificationHubJob.js

@@ -13,7 +13,7 @@ const OPERATION_NAME = "submitNotificationHubJob";
  * @returns The notification hub job details including job ID and status.
  */
 export function submitNotificationHubJob(context, job, options = {}) {
-    return tracingClient.withSpan(`NotificationHubsClientContext-${OPERATION_NAME}`, options, async (updatedOptions) => {
+    return tracingClient.withSpan(`NotificationHubsClientContext.${OPERATION_NAME}`, options, async (updatedOptions) => {
         const endpoint = context.requestUrl();
         endpoint.pathname += "/jobs";
         const headers = await context.createHeaders(OPERATION_NAME);

package/dist-esm/src/api/submitNotificationHubJob.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"submitNotificationHubJob.js","sourceRoot":"","sources":["../../../src/api/submitNotificationHubJob.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACnE,OAAO,EACL,4BAA4B,EAC5B,gCAAgC,GACjC,MAAM,gDAAgD,CAAC;AAIxD,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEpD,MAAM,cAAc,GAAG,0BAA0B,CAAC;AAElD;;;;;;;GAOG;AACH,MAAM,UAAU,wBAAwB,CACtC,OAAsC,EACtC,GAAuB,EACvB,UAA4B,EAAE;IAE9B,OAAO,aAAa,CAAC,QAAQ,CAC3B,iCAAiC,cAAc,EAAE,EACjD,OAAO,EACP,KAAK,EAAE,cAAc,EAAE,EAAE;QACvB,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;QACtC,QAAQ,CAAC,QAAQ,IAAI,OAAO,CAAC;QAE7B,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;QAC5D,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,+CAA+C,CAAC,CAAC;QAE7E,MAAM,OAAO,GAAG,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc,CAAC,CAAC;QACzE,OAAO,CAAC,IAAI,GAAG,gCAAgC,CAAC,GAAG,CAAC,CAAC;QACrD,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC;QAE1D,OAAO,4BAA4B,CAAC,QAAQ,CAAC,UAAW,CAAC,CAAC;IAC5D,CAAC,CACF,CAAC;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { createRequest, sendRequest } from \"./internal/_client.js\";\nimport {\n  parseNotificationHubJobEntry,\n  serializeNotificationHubJobEntry,\n} from \"../serializers/notificationHubJobSerializer.js\";\nimport { NotificationHubJob } from \"../models/notificationHubJob.js\";\nimport { NotificationHubsClientContext } from \"./index.js\";\nimport { OperationOptions } from \"@azure/core-client\";\nimport { tracingClient } from \"../utils/tracing.js\";\n\nconst OPERATION_NAME = \"submitNotificationHubJob\";\n\n/**\n * Submits a Notification Hub Job.\n * Note: this is available to Standard SKU namespace and above.\n * @param context - The Notification Hubs client.\n * @param job - The notification hub job to submit.\n * @param options - The operation options.\n * @returns The notification hub job details including job ID and status.\n */\nexport function submitNotificationHubJob(\n  context: NotificationHubsClientContext,\n  job: NotificationHubJob,\n  options: OperationOptions = {}\n): Promise<NotificationHubJob> {\n  return tracingClient.withSpan(\n    `NotificationHubsClientContext.${OPERATION_NAME}`,\n    options,\n    async (updatedOptions) => {\n      const endpoint = context.requestUrl();\n      endpoint.pathname += \"/jobs\";\n\n      const headers = await context.createHeaders(OPERATION_NAME);\n      headers.set(\"Content-Type\", \"application/atom+xml;type=entry;charset=utf-8\");\n\n      const request = createRequest(endpoint, \"POST\", headers, updatedOptions);\n      request.body = serializeNotificationHubJobEntry(job);\n      const response = await sendRequest(context, request, 201);\n\n      return parseNotificationHubJobEntry(response.bodyAsText!);\n    }\n  );\n}\n"]}

package/dist-esm/src/{client → api}/updateInstallation.js

@@ -12,7 +12,7 @@ const OPERATION_NAME = "updateInstallation";
  * @returns A NotificationHubResponse with the tracking ID, correlation ID and location.
  */
 export function updateInstallation(context, installationId, installationPatches, options = {}) {
-    return tracingClient.withSpan(`NotificationHubsClientContext-${OPERATION_NAME}`, options, async (updatedOptions) => {
+    return tracingClient.withSpan(`NotificationHubsClientContext.${OPERATION_NAME}`, options, async (updatedOptions) => {
         const endpoint = context.requestUrl();
         endpoint.pathname += `/installations/${installationId}`;
         const headers = await context.createHeaders(OPERATION_NAME);

package/dist-esm/src/api/updateInstallation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"updateInstallation.js","sourceRoot":"","sources":["../../../src/api/updateInstallation.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,aAAa,EAAE,yBAAyB,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAK9F,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEpD,MAAM,cAAc,GAAG,oBAAoB,CAAC;AAE5C;;;;;;;GAOG;AACH,MAAM,UAAU,kBAAkB,CAChC,OAAsC,EACtC,cAAsB,EACtB,mBAAgC,EAChC,UAA4B,EAAE;IAE9B,OAAO,aAAa,CAAC,QAAQ,CAC3B,iCAAiC,cAAc,EAAE,EACjD,OAAO,EACP,KAAK,EAAE,cAAc,EAAE,EAAE;QACvB,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;QACtC,QAAQ,CAAC,QAAQ,IAAI,kBAAkB,cAAc,EAAE,CAAC;QAExD,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;QAC5D,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QAEhD,MAAM,OAAO,GAAG,aAAa,CAAC,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,cAAc,CAAC,CAAC;QAC1E,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC;QACnD,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC;QAE1D,OAAO,yBAAyB,CAAC,QAAQ,CAAC,CAAC;IAC7C,CAAC,CACF,CAAC;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { createRequest, parseNotificationResponse, sendRequest } from \"./internal/_client.js\";\nimport { JsonPatch } from \"../models/installation.js\";\nimport { NotificationHubsClientContext } from \"./index.js\";\nimport { NotificationHubsResponse } from \"../models/notificationDetails.js\";\nimport { OperationOptions } from \"@azure/core-client\";\nimport { tracingClient } from \"../utils/tracing.js\";\n\nconst OPERATION_NAME = \"updateInstallation\";\n\n/**\n * Updates an installation using the JSON-Patch standard in RFC6902.\n * @param context - The Notification Hubs client.\n * @param installationId - The ID of the installation to update.\n * @param installationPatches - An array of patches following the JSON-Patch standard.\n * @param options - Configuration options for the patch installation operation.\n * @returns A NotificationHubResponse with the tracking ID, correlation ID and location.\n */\nexport function updateInstallation(\n  context: NotificationHubsClientContext,\n  installationId: string,\n  installationPatches: JsonPatch[],\n  options: OperationOptions = {}\n): Promise<NotificationHubsResponse> {\n  return tracingClient.withSpan(\n    `NotificationHubsClientContext.${OPERATION_NAME}`,\n    options,\n    async (updatedOptions) => {\n      const endpoint = context.requestUrl();\n      endpoint.pathname += `/installations/${installationId}`;\n\n      const headers = await context.createHeaders(OPERATION_NAME);\n      headers.set(\"Content-Type\", \"application/json\");\n\n      const request = createRequest(endpoint, \"PATCH\", headers, updatedOptions);\n      request.body = JSON.stringify(installationPatches);\n      const response = await sendRequest(context, request, 200);\n\n      return parseNotificationResponse(response);\n    }\n  );\n}\n"]}

package/dist-esm/src/{client → api}/updateRegistration.js

@@ -12,7 +12,7 @@ const OPERATION_NAME = "updateRegistration";
  * @returns The updated registration description.
  */
 export function updateRegistration(context, registration, options = {}) {
-    return tracingClient.withSpan(`NotificationHubsClientContext-${OPERATION_NAME}`, options, async (updatedOptions) => {
+    return tracingClient.withSpan(`NotificationHubsClientContext.${OPERATION_NAME}`, options, async (updatedOptions) => {
         if (!registration.etag) {
             throw new RestError("ETag is required for registration update", { statusCode: 400 });
         }

package/dist-esm/src/api/updateRegistration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"updateRegistration.js","sourceRoot":"","sources":["../../../src/api/updateRegistration.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAKlC,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACtD,OAAO,EAAE,qCAAqC,EAAE,MAAM,sDAAsD,CAAC;AAC7G,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEpD,MAAM,cAAc,GAAG,oBAAoB,CAAC;AAE5C;;;;;;GAMG;AACH,MAAM,UAAU,kBAAkB,CAChC,OAAsC,EACtC,YAAqC,EACrC,UAA4B,EAAE;IAE9B,OAAO,aAAa,CAAC,QAAQ,CAC3B,iCAAiC,cAAc,EAAE,EACjD,OAAO,EACP,KAAK,EAAE,cAAc,EAAE,EAAE;QACvB,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE;YACtB,MAAM,IAAI,SAAS,CAAC,0CAA0C,EAAE,EAAE,UAAU,EAAE,GAAG,EAAE,CAAC,CAAC;SACtF;QACD,OAAO,qCAAqC,CAAC,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,cAAc,CAAC,CAAC;IAChG,CAAC,CACF,CAAC;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { NotificationHubsClientContext } from \"./index.js\";\nimport { OperationOptions } from \"@azure/core-client\";\nimport { RegistrationDescription } from \"../models/registration.js\";\nimport { RestError } from \"@azure/core-rest-pipeline\";\nimport { createOrUpdateRegistrationDescription } from \"./internal/_createOrUpdateRegistrationDescription.js\";\nimport { tracingClient } from \"../utils/tracing.js\";\n\nconst OPERATION_NAME = \"updateRegistration\";\n\n/**\n * Updates an existing registration.\n * @param context - The Notification Hubs client.\n * @param registration - The registration to update.\n * @param options - The operation options.\n * @returns The updated registration description.\n */\nexport function updateRegistration(\n  context: NotificationHubsClientContext,\n  registration: RegistrationDescription,\n  options: OperationOptions = {}\n): Promise<RegistrationDescription> {\n  return tracingClient.withSpan(\n    `NotificationHubsClientContext.${OPERATION_NAME}`,\n    options,\n    async (updatedOptions) => {\n      if (!registration.etag) {\n        throw new RestError(\"ETag is required for registration update\", { statusCode: 400 });\n      }\n      return createOrUpdateRegistrationDescription(context, registration, \"update\", updatedOptions);\n    }\n  );\n}\n"]}

package/dist-esm/src/index.js

@@ -1,12 +1,13 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
-export { NotificationHubsServiceClient } from "./notificationHubsClient.js";
+export { NotificationHubsClient } from "./notificationHubsClient.js";
 export * from "./models/installation.js";
 export * from "./models/notification.js";
-export * from "./models/notificationBuilder.js";
+export * from "./models/notificationBodyBuilder.js";
 export * from "./models/notificationDetails.js";
 export * from "./models/notificationHubJob.js";
 export * from "./models/options.js";
 export * from "./models/registration.js";
 export * from "./models/response.js";
+export * from "./models/tagExpressionBuilder.js";
 //# sourceMappingURL=index.js.map

package/dist-esm/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,6BAA6B,EAAE,MAAM,6BAA6B,CAAC;AAC5E,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,cAAc,iCAAiC,CAAC;AAChD,cAAc,iCAAiC,CAAC;AAChD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC;AACzC,cAAc,sBAAsB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nexport { NotificationHubsServiceClient } from \"./notificationHubsClient.js\";\nexport * from \"./models/installation.js\";\nexport * from \"./models/notification.js\";\nexport * from \"./models/notificationBuilder.js\";\nexport * from \"./models/notificationDetails.js\";\nexport * from \"./models/notificationHubJob.js\";\nexport * from \"./models/options.js\";\nexport * from \"./models/registration.js\";\nexport * from \"./models/response.js\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AACrE,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,cAAc,qCAAqC,CAAC;AACpD,cAAc,iCAAiC,CAAC;AAChD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC;AACzC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kCAAkC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nexport { NotificationHubsClient } from \"./notificationHubsClient.js\";\nexport * from \"./models/installation.js\";\nexport * from \"./models/notification.js\";\nexport * from \"./models/notificationBodyBuilder.js\";\nexport * from \"./models/notificationDetails.js\";\nexport * from \"./models/notificationHubJob.js\";\nexport * from \"./models/options.js\";\nexport * from \"./models/registration.js\";\nexport * from \"./models/response.js\";\nexport * from \"./models/tagExpressionBuilder.js\";\n"]}

package/dist-esm/src/models/index.js

@@ -0,0 +1,12 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+export * from "./installation.js";
+export * from "./notification.js";
+export * from "./notificationBodyBuilder.js";
+export * from "./notificationDetails.js";
+export * from "./notificationHubJob.js";
+export * from "./options.js";
+export * from "./registration.js";
+export * from "./response.js";
+export * from "./tagExpressionBuilder.js";
+//# sourceMappingURL=index.js.map

package/dist-esm/src/models/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/models/index.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,0BAA0B,CAAC;AACzC,cAAc,yBAAyB,CAAC;AACxC,cAAc,cAAc,CAAC;AAC7B,cAAc,mBAAmB,CAAC;AAClC,cAAc,eAAe,CAAC;AAC9B,cAAc,2BAA2B,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nexport * from \"./installation.js\";\nexport * from \"./notification.js\";\nexport * from \"./notificationBodyBuilder.js\";\nexport * from \"./notificationDetails.js\";\nexport * from \"./notificationHubJob.js\";\nexport * from \"./options.js\";\nexport * from \"./registration.js\";\nexport * from \"./response.js\";\nexport * from \"./tagExpressionBuilder.js\";\n"]}

package/dist-esm/src/models/installation.js.map

@@ -1 +1 @@
-{"version":3,"file":"installation.js","sourceRoot":"","sources":["../../../src/models/installation.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AA8DlC;;;;GAIG;AACH,MAAM,UAAU,uBAAuB,CACrC,YAAiD;IAEjD,uCACK,YAAY,KACf,QAAQ,EAAE,MAAM,IAChB;AACJ,CAAC;AAYD;;;;GAIG;AACH,MAAM,UAAU,qBAAqB,CACnC,YAA+C;IAE/C,uCACK,YAAY,KACf,QAAQ,EAAE,KAAK,IACf;AACJ,CAAC;AAYD;;;;GAIG;AACH,MAAM,UAAU,uBAAuB,CACrC,YAAiD;IAEjD,uCACK,YAAY,KACf,QAAQ,EAAE,OAAO,IACjB;AACJ,CAAC;AAYD;;;;GAIG;AACH,MAAM,UAAU,2BAA2B,CACzC,YAAqD;IAErD,uCACK,YAAY,KACf,QAAQ,EAAE,KAAK,IACf;AACJ,CAAC;AAYD;;;;GAIG;AACH,MAAM,UAAU,yBAAyB,CACvC,YAAmD;IAEnD,uCACK,YAAY,KACf,QAAQ,EAAE,KAAK,IACf;AACJ,CAAC;AAqCD;;;;GAIG;AACH,MAAM,UAAU,yBAAyB,CACvC,YAAmD;IAEnD,uCACK,YAAY,KACf,QAAQ,EAAE,SAAS,IACnB;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\n/**\n * Represents an installation for a device for Notification Hubs.\n */\nexport interface InstallationCommon {\n  /**\n   * The ID for the installation.\n   */\n  installationId: string;\n\n  /**\n   * The User ID for the installation used for targeting.\n   */\n  userId?: string;\n\n  /**\n   * The installation expiration time.\n   */\n  readonly expirationTime?: string;\n\n  /**\n   * The last update date of the installation.\n   */\n  readonly lastUpdate?: string;\n\n  /**\n   * The platform for the installation.\n   */\n  platform: \"apns\" | \"adm\" | \"baidu\" | \"browser\" | \"gcm\" | \"wns\";\n\n  /**\n   * The tags used for targeting this installation.\n   */\n  tags?: string[];\n\n  /**\n   * The templates for the installation.\n   */\n  templates?: Record<string, InstallationTemplate>;\n}\n\n/**\n * Represents an installation with a string based device token.\n */\nexport interface DeviceTokenInstallation extends InstallationCommon {\n  /**\n   * The push channel for a device.\n   */\n  pushChannel: string;\n}\n\n/**\n * Represents an Apple APNs based installation.\n */\nexport interface AppleInstallation extends DeviceTokenInstallation {\n  /**\n   * The platform for the installation.\n   */\n  platform: \"apns\";\n}\n\n/**\n * Creates an Apple based installation.\n * @param installation - A partial installation used to create the Apple installation.\n * @returns The newly created Apple installation.\n */\nexport function createAppleInstallation(\n  installation: Omit<AppleInstallation, \"platform\">\n): AppleInstallation {\n  return {\n    ...installation,\n    platform: \"apns\",\n  };\n}\n\n/**\n * Represents an Amazon Device Messaging (ADM) based installation.\n */\nexport interface AdmInstallation extends DeviceTokenInstallation {\n  /**\n   * The platform for the installation.\n   */\n  platform: \"adm\";\n}\n\n/**\n * Creates an Amazon Device Messaging (ADM) based installation.\n * @param installation - A partial installation used to create the ADM installation.\n * @returns The newly created ADM installation.\n */\nexport function createAdmInstallation(\n  installation: Omit<AdmInstallation, \"platform\">\n): AdmInstallation {\n  return {\n    ...installation,\n    platform: \"adm\",\n  };\n}\n\n/**\n * Represents a Baidu based installation.\n */\nexport interface BaiduInstallation extends DeviceTokenInstallation {\n  /**\n   * The platform for the installation.\n   */\n  platform: \"baidu\";\n}\n\n/**\n * Creates a Baidu based installation.\n * @param installation - A partial installation used to create the Baidu installation.\n * @returns The newly created Baidu installation.\n */\nexport function createBaiduInstallation(\n  installation: Omit<BaiduInstallation, \"platform\">\n): BaiduInstallation {\n  return {\n    ...installation,\n    platform: \"baidu\",\n  };\n}\n\n/**\n * Represents a Firebase Legacy HTTP installation.\n */\nexport interface FcmLegacyInstallation extends DeviceTokenInstallation {\n  /**\n   * The platform for the installation.\n   */\n  platform: \"gcm\";\n}\n\n/**\n * Creates a Firebase legacy HTTP based installation.\n * @param installation - A partial installation used to create the Firebase Legacy HTTP installation.\n * @returns The newly created Baidu installation.\n */\nexport function createFcmLegacyInstallation(\n  installation: Omit<FcmLegacyInstallation, \"platform\">\n): FcmLegacyInstallation {\n  return {\n    ...installation,\n    platform: \"gcm\",\n  };\n}\n\n/**\n * Represents a Windows Notification Services (WNS) based installation.\n */\nexport interface WindowsInstallation extends DeviceTokenInstallation {\n  /**\n   * The platform for the installation.\n   */\n  platform: \"wns\";\n}\n\n/**\n * Creates a Windows Notification Services (WNS) based installation.\n * @param installation - A partial installation used to create the WNS installation.\n * @returns The newly created WNS installation.\n */\nexport function createWindowsInstallation(\n  installation: Omit<WindowsInstallation, \"platform\">\n): WindowsInstallation {\n  return {\n    ...installation,\n    platform: \"wns\",\n  };\n}\n\n/**\n * Represents the push channel for a Browser Push installation.\n */\nexport interface BrowserPushChannel {\n  /**\n   * The P256DH for the browser push installation.\n   */\n  p256dh: string;\n\n  /**\n   * The auth secret for the browser push installation.\n   */\n  auth: string;\n\n  /**\n   * The endpoint URL for the browser push installation.\n   */\n  endpoint: string;\n}\n\n/**\n * Represents a Browser/Web Push based installation.\n */\nexport interface BrowserInstallation extends InstallationCommon {\n  /**\n   * The push channel for the Web Push API.\n   */\n  pushChannel: BrowserPushChannel;\n\n  /**\n   * The platform for the installation.\n   */\n  platform: \"browser\";\n}\n\n/**\n * Creates a Web Push based installation.\n * @param installation - A partial installation used to create the Web Push installation.\n * @returns The newly created Web Push installation.\n */\nexport function createBrowserInstallation(\n  installation: Omit<BrowserInstallation, \"platform\">\n): BrowserInstallation {\n  return {\n    ...installation,\n    platform: \"browser\",\n  };\n}\n\n/**\n * Represents the types of installations available in Notification Hubs.\n */\nexport type Installation =\n  | AppleInstallation\n  | AdmInstallation\n  | BaiduInstallation\n  | BrowserInstallation\n  | FcmLegacyInstallation\n  | WindowsInstallation;\n\n/**\n * Represents an installation template.\n */\nexport interface InstallationTemplate {\n  /**\n   * The body for the installation template.\n   */\n  body: string;\n\n  /**\n   * Headers to include for the template send.\n   */\n  headers: Record<string, string>;\n\n  /**\n   * The tags to include for the template.\n   */\n  tags?: string[];\n}\n\n/**\n * Represents the JSON Patch types of add, remove and replace.\n */\nexport type JsonPatchOperation = \"add\" | \"remove\" | \"replace\";\n\n/**\n * Represents a patch operation.\n */\nexport interface JsonPatch {\n  /**\n   * The patch operation.\n   */\n  op: JsonPatchOperation;\n\n  /**\n   * The path for the patch operation.\n   */\n  path: string;\n\n  /**\n   * The value to add or replace for the operation.\n   */\n  value?: string;\n}\n\n/**\n * Represents the types of push channels available for Notification Hubs.\n */\nexport type PushHandle = BrowserPushChannel | string;\n"]}
+{"version":3,"file":"installation.js","sourceRoot":"","sources":["../../../src/models/installation.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAyDlC;;;;GAIG;AACH,MAAM,UAAU,uBAAuB,CAAC,YAAqC;IAC3E,uCACK,YAAY,KACf,QAAQ,EAAE,MAAM,IAChB;AACJ,CAAC;AAYD;;;;GAIG;AACH,MAAM,UAAU,qBAAqB,CAAC,YAAqC;IACzE,uCACK,YAAY,KACf,QAAQ,EAAE,KAAK,IACf;AACJ,CAAC;AAYD;;;;GAIG;AACH,MAAM,UAAU,uBAAuB,CAAC,YAAqC;IAC3E,uCACK,YAAY,KACf,QAAQ,EAAE,OAAO,IACjB;AACJ,CAAC;AAYD;;;;GAIG;AACH,MAAM,UAAU,2BAA2B,CACzC,YAAqC;IAErC,uCACK,YAAY,KACf,QAAQ,EAAE,KAAK,IACf;AACJ,CAAC;AAYD;;;;GAIG;AACH,MAAM,UAAU,yBAAyB,CACvC,YAAqC;IAErC,uCACK,YAAY,KACf,QAAQ,EAAE,KAAK,IACf;AACJ,CAAC;AA0CD;;;;GAIG;AACH,MAAM,UAAU,yBAAyB,CACvC,YAAuC;IAEvC,uCACK,YAAY,KACf,QAAQ,EAAE,SAAS,IACnB;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\n/**\n * Represents an installation for a device for Notification Hubs.\n */\nexport interface InstallationCommon {\n  /**\n   * The ID for the installation.\n   */\n  installationId: string;\n\n  /**\n   * The User ID for the installation used for targeting.\n   */\n  userId?: string;\n\n  /**\n   * The installation expiration time.\n   */\n  readonly expirationTime?: string;\n\n  /**\n   * The last update date of the installation.\n   */\n  readonly lastUpdate?: string;\n\n  /**\n   * The tags used for targeting this installation.\n   */\n  tags?: string[];\n\n  /**\n   * The templates for the installation.\n   */\n  templates?: Record<string, InstallationTemplate>;\n}\n\n/**\n * Represents an installation with a string based device token.\n */\nexport interface DeviceTokenInstallation extends InstallationCommon {\n  /**\n   * The push channel for a device.\n   */\n  pushChannel: string;\n}\n\n/**\n * Represents an Apple APNs based installation.\n */\nexport interface AppleInstallation extends DeviceTokenInstallation {\n  /**\n   * The platform for the installation.\n   */\n  platform: \"apns\";\n}\n\n/**\n * Creates an Apple based installation.\n * @param installation - A partial installation used to create the Apple installation.\n * @returns The newly created Apple installation.\n */\nexport function createAppleInstallation(installation: DeviceTokenInstallation): AppleInstallation {\n  return {\n    ...installation,\n    platform: \"apns\",\n  };\n}\n\n/**\n * Represents an Amazon Device Messaging (ADM) based installation.\n */\nexport interface AdmInstallation extends DeviceTokenInstallation {\n  /**\n   * The platform for the installation.\n   */\n  platform: \"adm\";\n}\n\n/**\n * Creates an Amazon Device Messaging (ADM) based installation.\n * @param installation - A partial installation used to create the ADM installation.\n * @returns The newly created ADM installation.\n */\nexport function createAdmInstallation(installation: DeviceTokenInstallation): AdmInstallation {\n  return {\n    ...installation,\n    platform: \"adm\",\n  };\n}\n\n/**\n * Represents a Baidu based installation.\n */\nexport interface BaiduInstallation extends DeviceTokenInstallation {\n  /**\n   * The platform for the installation.\n   */\n  platform: \"baidu\";\n}\n\n/**\n * Creates a Baidu based installation.\n * @param installation - A partial installation used to create the Baidu installation.\n * @returns The newly created Baidu installation.\n */\nexport function createBaiduInstallation(installation: DeviceTokenInstallation): BaiduInstallation {\n  return {\n    ...installation,\n    platform: \"baidu\",\n  };\n}\n\n/**\n * Represents a Firebase Legacy HTTP installation.\n */\nexport interface FcmLegacyInstallation extends DeviceTokenInstallation {\n  /**\n   * The platform for the installation.\n   */\n  platform: \"gcm\";\n}\n\n/**\n * Creates a Firebase legacy HTTP based installation.\n * @param installation - A partial installation used to create the Firebase Legacy HTTP installation.\n * @returns The newly created Baidu installation.\n */\nexport function createFcmLegacyInstallation(\n  installation: DeviceTokenInstallation\n): FcmLegacyInstallation {\n  return {\n    ...installation,\n    platform: \"gcm\",\n  };\n}\n\n/**\n * Represents a Windows Notification Services (WNS) based installation.\n */\nexport interface WindowsInstallation extends DeviceTokenInstallation {\n  /**\n   * The platform for the installation.\n   */\n  platform: \"wns\";\n}\n\n/**\n * Creates a Windows Notification Services (WNS) based installation.\n * @param installation - A partial installation used to create the WNS installation.\n * @returns The newly created WNS installation.\n */\nexport function createWindowsInstallation(\n  installation: DeviceTokenInstallation\n): WindowsInstallation {\n  return {\n    ...installation,\n    platform: \"wns\",\n  };\n}\n\n/**\n * Represents the push channel for a Browser Push installation.\n */\nexport interface BrowserPushChannel {\n  /**\n   * The P256DH for the browser push installation.\n   */\n  p256dh: string;\n\n  /**\n   * The auth secret for the browser push installation.\n   */\n  auth: string;\n\n  /**\n   * The endpoint URL for the browser push installation.\n   */\n  endpoint: string;\n}\n\n/**\n * Represents a Browser/Web Push based installation.\n */\nexport interface BrowserInstallationCommon extends InstallationCommon {\n  /**\n   * The push channel for the Web Push API.\n   */\n  pushChannel: BrowserPushChannel;\n}\n\n/**\n * Represents a Browser/Web Push based installation.\n */\nexport interface BrowserInstallation extends BrowserInstallationCommon {\n  /**\n   * The platform for the installation.\n   */\n  platform: \"browser\";\n}\n\n/**\n * Creates a Web Push based installation.\n * @param installation - A partial installation used to create the Web Push installation.\n * @returns The newly created Web Push installation.\n */\nexport function createBrowserInstallation(\n  installation: BrowserInstallationCommon\n): BrowserInstallation {\n  return {\n    ...installation,\n    platform: \"browser\",\n  };\n}\n\n/**\n * Represents the types of installations available in Notification Hubs.\n */\nexport type Installation =\n  | AppleInstallation\n  | AdmInstallation\n  | BaiduInstallation\n  | BrowserInstallation\n  | FcmLegacyInstallation\n  | WindowsInstallation;\n\n/**\n * Represents an installation template.\n */\nexport interface InstallationTemplate {\n  /**\n   * The body for the installation template.\n   */\n  body: string;\n\n  /**\n   * Headers to include for the template send.\n   */\n  headers: Record<string, string>;\n\n  /**\n   * The tags to include for the template.\n   */\n  tags?: string[];\n}\n\n/**\n * Represents the JSON Patch types of add, remove and replace.\n */\nexport type JsonPatchOperation = \"add\" | \"remove\" | \"replace\";\n\n/**\n * Represents a patch operation.\n */\nexport interface JsonPatch {\n  /**\n   * The patch operation.\n   */\n  op: JsonPatchOperation;\n\n  /**\n   * The path for the patch operation.\n   */\n  path: string;\n\n  /**\n   * The value to add or replace for the operation.\n   */\n  value?: string;\n}\n\n/**\n * Represents the types of push channels available for Notification Hubs.\n */\nexport type PushHandle = BrowserPushChannel | string;\n"]}

package/dist-esm/src/models/notification.js.map

@@ -1 +1 @@
-{"version":3,"file":"notification.js","sourceRoot":"","sources":["../../../src/models/notification.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,KAAK,SAAS,MAAM,uBAAuB,CAAC;AA+CnD;;;;GAIG;AACH,MAAM,UAAU,uBAAuB,CACrC,YAAiE;IAEjE,uCACK,YAAY,KACf,QAAQ,EAAE,OAAO,EACjB,WAAW,EAAE,SAAS,CAAC,iBAAiB,IACxC;AACJ,CAAC;AAYD;;;;GAIG;AACH,MAAM,UAAU,qBAAqB,CACnC,YAA+D;IAE/D,uCACK,YAAY,KACf,QAAQ,EAAE,KAAK,EACf,WAAW,EAAE,SAAS,CAAC,iBAAiB,IACxC;AACJ,CAAC;AAYD;;;;GAIG;AACH,MAAM,UAAU,uBAAuB,CACrC,YAAiE;IAEjE,uCACK,YAAY,KACf,QAAQ,EAAE,OAAO,EACjB,WAAW,EAAE,SAAS,CAAC,iBAAiB,IACxC;AACJ,CAAC;AAYD;;;;GAIG;AACH,MAAM,UAAU,yBAAyB,CACvC,YAAmE;IAEnE,uCACK,YAAY,KACf,QAAQ,EAAE,SAAS,EACnB,WAAW,EAAE,SAAS,CAAC,iBAAiB,IACxC;AACJ,CAAC;AAYD;;;;GAIG;AACH,MAAM,UAAU,2BAA2B,CACzC,YAAqE;IAErE,uCACK,YAAY,KACf,QAAQ,EAAE,KAAK,EACf,WAAW,EAAE,SAAS,CAAC,iBAAiB,IACxC;AACJ,CAAC;AAYD;;;;GAIG;AACH,MAAM,UAAU,0BAA0B,CACxC,YAAoE;IAEpE,uCACK,YAAY,KACf,QAAQ,EAAE,UAAU,EACpB,WAAW,EAAE,SAAS,CAAC,iBAAiB,IACxC;AACJ,CAAC;AAsBD;;;;GAIG;AACH,MAAM,UAAU,8BAA8B,CAC5C,YAAmE;IAEnE,MAAM,MAAM,mCACP,YAAY,KACf,QAAQ,EAAE,KAAK,EACf,WAAW,EAAE,SAAS,CAAC,gBAAgB,GACxC,CAAC;IAEF,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE;QACnB,MAAM,CAAC,OAAO,GAAG,EAAE,CAAC;KACrB;IAED,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,GAAG,SAAS,CAAC,SAAS,CAAC;IAE9D,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,6BAA6B,CAC3C,YAAmE;IAEnE,MAAM,MAAM,mCACP,YAAY,KACf,QAAQ,EAAE,KAAK,EACf,WAAW,EAAE,SAAS,CAAC,gBAAgB,GACxC,CAAC;IAEF,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE;QACnB,MAAM,CAAC,OAAO,GAAG,EAAE,CAAC;KACrB;IAED,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,GAAG,SAAS,CAAC,SAAS,CAAC;IAE9D,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,8BAA8B,CAC5C,YAAmE;IAEnE,MAAM,MAAM,mCACP,YAAY,KACf,QAAQ,EAAE,KAAK,EACf,WAAW,EAAE,SAAS,CAAC,gBAAgB,GACxC,CAAC;IAEF,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE;QACnB,MAAM,CAAC,OAAO,GAAG,EAAE,CAAC;KACrB;IAED,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,GAAG,SAAS,CAAC,SAAS,CAAC;IAE9D,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,4BAA4B,CAC1C,YAAmE;IAEnE,MAAM,MAAM,mCACP,YAAY,KACf,QAAQ,EAAE,KAAK,EACf,WAAW,EAAE,SAAS,CAAC,mBAAmB,GAC3C,CAAC;IAEF,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE;QACnB,MAAM,CAAC,OAAO,GAAG,EAAE,CAAC;KACrB;IAED,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;IAE5D,OAAO,MAAM,CAAC;AAChB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport * as Constants from \"../utils/constants.js\";\n\n/**\n * Represents a notification hub.\n */\nexport interface NotificationCommon {\n  /**\n   * The body for the push notification.\n   */\n  body: string;\n\n  /**\n   * The headers to include for the push notification.\n   */\n  headers?: Record<string, string>;\n\n  /**\n   * The platform for the push notification.\n   */\n  platform: string;\n\n  /**\n   * The content type for the push notification.\n   */\n  contentType: string;\n}\n\n/**\n * Represents a JSON notification hub.\n */\nexport interface JsonNotification extends NotificationCommon {\n  /**\n   * The content type for the push notification.\n   */\n  contentType: \"application/json;charset=utf-8\";\n}\n\n/**\n * Represents an Apple APNs push notification.\n */\nexport interface AppleNotification extends JsonNotification {\n  /**\n   * The platform for the push notification.\n   */\n  platform: \"apple\";\n}\n\n/**\n * Creates a notification to send to an Apple device.\n * @param notification - A partial message used to create a message for Apple.\n * @returns A newly created Apple.\n */\nexport function createAppleNotification(\n  notification: Omit<AppleNotification, \"platform\" | \"contentType\">\n): AppleNotification {\n  return {\n    ...notification,\n    platform: \"apple\",\n    contentType: Constants.JSON_CONTENT_TYPE,\n  };\n}\n\n/**\n * Represents an Amazon Device Messaging (ADM) push notification.\n */\nexport interface AdmNotification extends JsonNotification {\n  /**\n   * The platform for the push notification.\n   */\n  platform: \"adm\";\n}\n\n/**\n * Creates a notification to send to an Amazon Device Messaging device.\n * @param notification - A partial message used to create a message for Amazon Device Messaging.\n * @returns A newly created Amazon Device Messaging.\n */\nexport function createAdmNotification(\n  notification: Omit<AdmNotification, \"platform\" | \"contentType\">\n): AdmNotification {\n  return {\n    ...notification,\n    platform: \"adm\",\n    contentType: Constants.JSON_CONTENT_TYPE,\n  };\n}\n\n/**\n * Represents a Baidu push notification.\n */\nexport interface BaiduNotification extends JsonNotification {\n  /**\n   * The platform for the push notification.\n   */\n  platform: \"baidu\";\n}\n\n/**\n * Creates a notification to send to a Baidu registered device.\n * @param notification - A partial message used to create a message for Baidu.\n * @returns A newly created Baidu.\n */\nexport function createBaiduNotification(\n  notification: Omit<BaiduNotification, \"platform\" | \"contentType\">\n): BaiduNotification {\n  return {\n    ...notification,\n    platform: \"baidu\",\n    contentType: Constants.JSON_CONTENT_TYPE,\n  };\n}\n\n/**\n * Represents a Browser push notification.\n */\nexport interface BrowserNotification extends JsonNotification {\n  /**\n   * The platform for the push notification.\n   */\n  platform: \"browser\";\n}\n\n/**\n * Creates a notification to send to a browser.\n * @param notification - A partial message used to create a message for a browser.\n * @returns A newly created Web Push browser.\n */\nexport function createBrowserNotification(\n  notification: Omit<BrowserNotification, \"platform\" | \"contentType\">\n): BrowserNotification {\n  return {\n    ...notification,\n    platform: \"browser\",\n    contentType: Constants.JSON_CONTENT_TYPE,\n  };\n}\n\n/**\n * Represents a Firebase legacy HTTP push notification.\n */\nexport interface FcmLegacyNotification extends JsonNotification {\n  /**\n   * The platform for the push notification.\n   */\n  platform: \"gcm\";\n}\n\n/**\n * Creates a notification to send to Firebase.\n * @param notification - A partial message used to create a message for Firebase.\n * @returns A newly created Firebase.\n */\nexport function createFcmLegacyNotification(\n  notification: Omit<FcmLegacyNotification, \"platform\" | \"contentType\">\n): FcmLegacyNotification {\n  return {\n    ...notification,\n    platform: \"gcm\",\n    contentType: Constants.JSON_CONTENT_TYPE,\n  };\n}\n\n/**\n * Represents a template based push notification.\n */\nexport interface TemplateNotification extends JsonNotification {\n  /**\n   * The platform for the push notification.\n   */\n  platform: \"template\";\n}\n\n/**\n * Creates a notification to send to Firebase.\n * @param notification - A partial message used to create a message for Firebase.\n * @returns A newly created Firebase.\n */\nexport function createTemplateNotification(\n  notification: Omit<TemplateNotification, \"platform\" | \"contentType\">\n): TemplateNotification {\n  return {\n    ...notification,\n    platform: \"template\",\n    contentType: Constants.JSON_CONTENT_TYPE,\n  };\n}\n\n/**\n * Represents the possible WNS content-types.\n */\nexport type WindowsContentType = \"application/xml\" | \"application/octet-stream\";\n\n/**\n * Represents a Windows Notification Services (WNS) push notification.\n */\nexport interface WindowsNotification extends NotificationCommon {\n  /**\n   * The platform for the push notification.\n   */\n  platform: \"wns\";\n\n  /**\n   * The content type for the push notification.\n   */\n  contentType: WindowsContentType;\n}\n\n/**\n * Creates a badge message to send to WNS.\n * @param notification - A partial message used to create a badge message for WNS.\n * @returns A newly created WNS badge.\n */\nexport function createWindowsBadgeNotification(\n  notification: Omit<WindowsNotification, \"platform\" | \"contentType\">\n): WindowsNotification {\n  const result: WindowsNotification = {\n    ...notification,\n    platform: \"wns\",\n    contentType: Constants.XML_CONTENT_TYPE,\n  };\n\n  if (!result.headers) {\n    result.headers = {};\n  }\n\n  result.headers[Constants.WNS_TYPE_NAME] = Constants.WNS_BADGE;\n\n  return result;\n}\n\n/**\n * Creates a tile message to send to WNS.\n * @param notification - A partial message used to create a tile message for WNS.\n * @returns A newly created WNS tile.\n */\nexport function createWindowsTileNotification(\n  notification: Omit<WindowsNotification, \"platform\" | \"contentType\">\n): WindowsNotification {\n  const result: WindowsNotification = {\n    ...notification,\n    platform: \"wns\",\n    contentType: Constants.XML_CONTENT_TYPE,\n  };\n\n  if (!result.headers) {\n    result.headers = {};\n  }\n\n  result.headers[Constants.WNS_TYPE_NAME] = Constants.WNS_TITLE;\n\n  return result;\n}\n\n/**\n * Creates a toast message to send to WNS.\n * @param notification - A partial message used to create a toast message for WNS.\n * @returns A newly created WNS toast.\n */\nexport function createWindowsToastNotification(\n  notification: Omit<WindowsNotification, \"platform\" | \"contentType\">\n): WindowsNotification {\n  const result: WindowsNotification = {\n    ...notification,\n    platform: \"wns\",\n    contentType: Constants.XML_CONTENT_TYPE,\n  };\n\n  if (!result.headers) {\n    result.headers = {};\n  }\n\n  result.headers[Constants.WNS_TYPE_NAME] = Constants.WNS_TOAST;\n\n  return result;\n}\n\n/**\n * Creates a notification to send to WNS in wns/raw format..\n * @param notification - A partial message used to create a message for WNS in XML format.\n * @returns A newly created WNS message using XML.\n */\nexport function createWindowsRawNotification(\n  notification: Omit<WindowsNotification, \"platform\" | \"contentType\">\n): WindowsNotification {\n  const result: WindowsNotification = {\n    ...notification,\n    platform: \"wns\",\n    contentType: Constants.STREAM_CONTENT_TYPE,\n  };\n\n  if (!result.headers) {\n    result.headers = {};\n  }\n\n  result.headers[Constants.WNS_TYPE_NAME] = Constants.WNS_RAW;\n\n  return result;\n}\n\n/**\n * Represents the possible push notification messages types.\n */\nexport type Notification =\n  | AppleNotification\n  | AdmNotification\n  | BaiduNotification\n  | BrowserNotification\n  | FcmLegacyNotification\n  | WindowsNotification\n  | TemplateNotification;\n"]}
+{"version":3,"file":"notification.js","sourceRoot":"","sources":["../../../src/models/notification.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,KAAK,SAAS,MAAM,uBAAuB,CAAC;AAqCnD;;;;GAIG;AACH,MAAM,UAAU,uBAAuB,CAAC,YAAgC;IACtE,uCACK,YAAY,KACf,QAAQ,EAAE,OAAO,EACjB,WAAW,EAAE,SAAS,CAAC,iBAAiB,IACxC;AACJ,CAAC;AAYD;;;;GAIG;AACH,MAAM,UAAU,qBAAqB,CAAC,YAAgC;IACpE,uCACK,YAAY,KACf,QAAQ,EAAE,KAAK,EACf,WAAW,EAAE,SAAS,CAAC,iBAAiB,IACxC;AACJ,CAAC;AAYD;;;;GAIG;AACH,MAAM,UAAU,uBAAuB,CAAC,YAAgC;IACtE,uCACK,YAAY,KACf,QAAQ,EAAE,OAAO,EACjB,WAAW,EAAE,SAAS,CAAC,iBAAiB,IACxC;AACJ,CAAC;AAYD;;;;GAIG;AACH,MAAM,UAAU,yBAAyB,CAAC,YAAgC;IACxE,uCACK,YAAY,KACf,QAAQ,EAAE,SAAS,EACnB,WAAW,EAAE,SAAS,CAAC,iBAAiB,IACxC;AACJ,CAAC;AAYD;;;;GAIG;AACH,MAAM,UAAU,2BAA2B,CACzC,YAAgC;IAEhC,uCACK,YAAY,KACf,QAAQ,EAAE,KAAK,EACf,WAAW,EAAE,SAAS,CAAC,iBAAiB,IACxC;AACJ,CAAC;AAYD;;;;GAIG;AACH,MAAM,UAAU,0BAA0B,CAAC,YAAgC;IACzE,uCACK,YAAY,KACf,QAAQ,EAAE,UAAU,EACpB,WAAW,EAAE,SAAS,CAAC,iBAAiB,IACxC;AACJ,CAAC;AAsBD;;;;GAIG;AACH,MAAM,UAAU,8BAA8B,CAC5C,YAAgC;IAEhC,MAAM,MAAM,mCACP,YAAY,KACf,QAAQ,EAAE,KAAK,EACf,WAAW,EAAE,SAAS,CAAC,gBAAgB,GACxC,CAAC;IAEF,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE;QACnB,MAAM,CAAC,OAAO,GAAG,EAAE,CAAC;KACrB;IAED,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,GAAG,SAAS,CAAC,SAAS,CAAC;IAE9D,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,6BAA6B,CAC3C,YAAgC;IAEhC,MAAM,MAAM,mCACP,YAAY,KACf,QAAQ,EAAE,KAAK,EACf,WAAW,EAAE,SAAS,CAAC,gBAAgB,GACxC,CAAC;IAEF,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE;QACnB,MAAM,CAAC,OAAO,GAAG,EAAE,CAAC;KACrB;IAED,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,GAAG,SAAS,CAAC,SAAS,CAAC;IAE9D,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,8BAA8B,CAC5C,YAAgC;IAEhC,MAAM,MAAM,mCACP,YAAY,KACf,QAAQ,EAAE,KAAK,EACf,WAAW,EAAE,SAAS,CAAC,gBAAgB,GACxC,CAAC;IAEF,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE;QACnB,MAAM,CAAC,OAAO,GAAG,EAAE,CAAC;KACrB;IAED,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,GAAG,SAAS,CAAC,SAAS,CAAC;IAE9D,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,4BAA4B,CAC1C,YAAgC;IAEhC,MAAM,MAAM,mCACP,YAAY,KACf,QAAQ,EAAE,KAAK,EACf,WAAW,EAAE,SAAS,CAAC,mBAAmB,GAC3C,CAAC;IAEF,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE;QACnB,MAAM,CAAC,OAAO,GAAG,EAAE,CAAC;KACrB;IAED,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;IAE5D,OAAO,MAAM,CAAC;AAChB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport * as Constants from \"../utils/constants.js\";\n\n/**\n * Represents a notification hub.\n */\nexport interface NotificationCommon {\n  /**\n   * The body for the push notification.\n   */\n  body: string;\n\n  /**\n   * The headers to include for the push notification.\n   */\n  headers?: Record<string, string>;\n}\n\n/**\n * Represents a JSON notification hub.\n */\nexport interface JsonNotification extends NotificationCommon {\n  /**\n   * The content type for the push notification.\n   */\n  contentType: \"application/json;charset=utf-8\";\n}\n\n/**\n * Represents an Apple APNs push notification.\n */\nexport interface AppleNotification extends JsonNotification {\n  /**\n   * The platform for the push notification.\n   */\n  platform: \"apple\";\n}\n\n/**\n * Creates a notification to send to an Apple device.\n * @param notification - A partial message used to create a message for Apple.\n * @returns A newly created Apple.\n */\nexport function createAppleNotification(notification: NotificationCommon): AppleNotification {\n  return {\n    ...notification,\n    platform: \"apple\",\n    contentType: Constants.JSON_CONTENT_TYPE,\n  };\n}\n\n/**\n * Represents an Amazon Device Messaging (ADM) push notification.\n */\nexport interface AdmNotification extends JsonNotification {\n  /**\n   * The platform for the push notification.\n   */\n  platform: \"adm\";\n}\n\n/**\n * Creates a notification to send to an Amazon Device Messaging device.\n * @param notification - A partial message used to create a message for Amazon Device Messaging.\n * @returns A newly created Amazon Device Messaging.\n */\nexport function createAdmNotification(notification: NotificationCommon): AdmNotification {\n  return {\n    ...notification,\n    platform: \"adm\",\n    contentType: Constants.JSON_CONTENT_TYPE,\n  };\n}\n\n/**\n * Represents a Baidu push notification.\n */\nexport interface BaiduNotification extends JsonNotification {\n  /**\n   * The platform for the push notification.\n   */\n  platform: \"baidu\";\n}\n\n/**\n * Creates a notification to send to a Baidu registered device.\n * @param notification - A partial message used to create a message for Baidu.\n * @returns A newly created Baidu.\n */\nexport function createBaiduNotification(notification: NotificationCommon): BaiduNotification {\n  return {\n    ...notification,\n    platform: \"baidu\",\n    contentType: Constants.JSON_CONTENT_TYPE,\n  };\n}\n\n/**\n * Represents a Browser push notification.\n */\nexport interface BrowserNotification extends JsonNotification {\n  /**\n   * The platform for the push notification.\n   */\n  platform: \"browser\";\n}\n\n/**\n * Creates a notification to send to a browser.\n * @param notification - A partial message used to create a message for a browser.\n * @returns A newly created Web Push browser.\n */\nexport function createBrowserNotification(notification: NotificationCommon): BrowserNotification {\n  return {\n    ...notification,\n    platform: \"browser\",\n    contentType: Constants.JSON_CONTENT_TYPE,\n  };\n}\n\n/**\n * Represents a Firebase legacy HTTP push notification.\n */\nexport interface FcmLegacyNotification extends JsonNotification {\n  /**\n   * The platform for the push notification.\n   */\n  platform: \"gcm\";\n}\n\n/**\n * Creates a notification to send to Firebase.\n * @param notification - A partial message used to create a message for Firebase.\n * @returns A newly created Firebase.\n */\nexport function createFcmLegacyNotification(\n  notification: NotificationCommon\n): FcmLegacyNotification {\n  return {\n    ...notification,\n    platform: \"gcm\",\n    contentType: Constants.JSON_CONTENT_TYPE,\n  };\n}\n\n/**\n * Represents a template based push notification.\n */\nexport interface TemplateNotification extends JsonNotification {\n  /**\n   * The platform for the push notification.\n   */\n  platform: \"template\";\n}\n\n/**\n * Creates a notification to send to Firebase.\n * @param notification - A partial message used to create a message for Firebase.\n * @returns A newly created Firebase.\n */\nexport function createTemplateNotification(notification: NotificationCommon): TemplateNotification {\n  return {\n    ...notification,\n    platform: \"template\",\n    contentType: Constants.JSON_CONTENT_TYPE,\n  };\n}\n\n/**\n * Represents the possible WNS content-types.\n */\nexport type WindowsContentType = \"application/xml\" | \"application/octet-stream\";\n\n/**\n * Represents a Windows Notification Services (WNS) push notification.\n */\nexport interface WindowsNotification extends NotificationCommon {\n  /**\n   * The platform for the push notification.\n   */\n  platform: \"wns\";\n\n  /**\n   * The content type for the push notification.\n   */\n  contentType: WindowsContentType;\n}\n\n/**\n * Creates a badge message to send to WNS.\n * @param notification - A partial message used to create a badge message for WNS.\n * @returns A newly created WNS badge.\n */\nexport function createWindowsBadgeNotification(\n  notification: NotificationCommon\n): WindowsNotification {\n  const result: WindowsNotification = {\n    ...notification,\n    platform: \"wns\",\n    contentType: Constants.XML_CONTENT_TYPE,\n  };\n\n  if (!result.headers) {\n    result.headers = {};\n  }\n\n  result.headers[Constants.WNS_TYPE_NAME] = Constants.WNS_BADGE;\n\n  return result;\n}\n\n/**\n * Creates a tile message to send to WNS.\n * @param notification - A partial message used to create a tile message for WNS.\n * @returns A newly created WNS tile.\n */\nexport function createWindowsTileNotification(\n  notification: NotificationCommon\n): WindowsNotification {\n  const result: WindowsNotification = {\n    ...notification,\n    platform: \"wns\",\n    contentType: Constants.XML_CONTENT_TYPE,\n  };\n\n  if (!result.headers) {\n    result.headers = {};\n  }\n\n  result.headers[Constants.WNS_TYPE_NAME] = Constants.WNS_TITLE;\n\n  return result;\n}\n\n/**\n * Creates a toast message to send to WNS.\n * @param notification - A partial message used to create a toast message for WNS.\n * @returns A newly created WNS toast.\n */\nexport function createWindowsToastNotification(\n  notification: NotificationCommon\n): WindowsNotification {\n  const result: WindowsNotification = {\n    ...notification,\n    platform: \"wns\",\n    contentType: Constants.XML_CONTENT_TYPE,\n  };\n\n  if (!result.headers) {\n    result.headers = {};\n  }\n\n  result.headers[Constants.WNS_TYPE_NAME] = Constants.WNS_TOAST;\n\n  return result;\n}\n\n/**\n * Creates a notification to send to WNS in wns/raw format..\n * @param notification - A partial message used to create a message for WNS in XML format.\n * @returns A newly created WNS message using XML.\n */\nexport function createWindowsRawNotification(\n  notification: NotificationCommon\n): WindowsNotification {\n  const result: WindowsNotification = {\n    ...notification,\n    platform: \"wns\",\n    contentType: Constants.STREAM_CONTENT_TYPE,\n  };\n\n  if (!result.headers) {\n    result.headers = {};\n  }\n\n  result.headers[Constants.WNS_TYPE_NAME] = Constants.WNS_RAW;\n\n  return result;\n}\n\n/**\n * Represents the possible push notification messages types.\n */\nexport type Notification =\n  | AppleNotification\n  | AdmNotification\n  | BaiduNotification\n  | BrowserNotification\n  | FcmLegacyNotification\n  | WindowsNotification\n  | TemplateNotification;\n"]}

package/dist-esm/src/models/notificationBodyBuilder.js

@@ -0,0 +1,48 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+import { stringifyXML } from "@azure/core-xml";
+/**
+ * Creates an APNs native message to send to Notification Hubs.
+ * @param nativeMessage - The Apple native message properties to set.
+ * @param additionalProperties - Additional properties for Apple messages.
+ * @returns An AppleNotification to send to Notification Hubs.
+ */
+export function createAppleNotificationBody(nativeMessage) {
+    return JSON.stringify(nativeMessage);
+}
+/**
+ * Creates a FcmLegacyNotification 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.
+ */
+export function createFirebaseLegacyNotificationBody(nativeMessage) {
+    return JSON.stringify(nativeMessage);
+}
+/**
+ * Creates a AdmNotification from a native ADM payload.
+ * @param nativeMessage - The native message payload to send to Notification Hubs.
+ * @returns The AdmNotification to send to Notification Hubs.
+ */
+export function createAdmNotificationBody(nativeMessage) {
+    return JSON.stringify(nativeMessage);
+}
+/**
+ * Creates a BaiduNotification from a native Baidu payload.
+ * @param nativeMessage - The native message payload to send to Notification Hubs.
+ * @returns The JSON body to send to Notification Hubs.
+ */
+export function createBaiduNotificationBody(nativeMessage) {
+    return JSON.stringify(nativeMessage);
+}
+/**
+ * Builds a WindowsNotification from a Windows Badge.
+ * @param nativeMessage - The Windows Badge Message to build.
+ * @returns The WNS XML created with the badge information.
+ */
+export function createWindowsBadgeNotificationBody(nativeMessage) {
+    const badge = {
+        $: { value: nativeMessage.value },
+    };
+    return stringifyXML(badge, { rootName: "badge" });
+}
+//# sourceMappingURL=notificationBodyBuilder.js.map

package/dist-esm/src/models/notificationBodyBuilder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"notificationBodyBuilder.js","sourceRoot":"","sources":["../../../src/models/notificationBodyBuilder.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAgK/C;;;;;GAKG;AACH,MAAM,UAAU,2BAA2B,CAAC,aAAiC;IAC3E,OAAO,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;AACvC,CAAC;AAyND;;;;GAIG;AACH,MAAM,UAAU,oCAAoC,CAClD,aAA0C;IAE1C,OAAO,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;AACvC,CAAC;AA0JD;;;;GAIG;AACH,MAAM,UAAU,yBAAyB,CAAC,aAA+B;IACvE,OAAO,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;AACvC,CAAC;AAyFD;;;;GAIG;AACH,MAAM,UAAU,2BAA2B,CAAC,aAAiC;IAC3E,OAAO,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;AACvC,CAAC;AA8BD;;;;GAIG;AACH,MAAM,UAAU,kCAAkC,CAChD,aAAwC;IAExC,MAAM,KAAK,GAAG;QACZ,CAAC,EAAE,EAAE,KAAK,EAAE,aAAa,CAAC,KAAK,EAAE;KAClC,CAAC;IAEF,OAAO,YAAY,CAAC,KAAK,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;AACpD,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { stringifyXML } from \"@azure/core-xml\";\n\n/**\n * Represents what is in the APNs alert body.\n */\nexport interface AppleAlert {\n  /**\n   * The title of the notification. Apple Watch displays this string in the short look notification\n   * interface. Specify a string that’s quickly understood by the user.\n   */\n  title?: string;\n\n  /**\n   * Additional information that explains the purpose of the notification.\n   */\n  subtitle?: string;\n\n  /**\n   * The content of the alert message.\n   */\n  body?: string;\n\n  /**\n   * The name of the launch image file to display. If the user chooses to launch your app,\n   * the contents of the specified image or storyboard file are displayed instead of your app’s normal launch image.\n   */\n  \"launch-image\"?: string;\n\n  /**\n   * The key for a localized title string. Specify this key instead of the title key to retrieve\n   * the title from your app’s Localizable.strings files. The value must contain the name of a key in your strings file.\n   */\n  \"title-loc-key\"?: string;\n\n  /**\n   * An array of strings containing replacement values for variables in your title string.\n   * Each %\\@ character in the string specified by the title-loc-key is replaced by a value\n   * from this array. The first item in the array replaces the first instance\n   * of the %\\@ character in the string, the second item replaces the second instance, and so on.\n   */\n  \"title-loc-args\"?: string[];\n\n  /**\n   * The key for a localized subtitle string. Use this key, instead of the subtitle key, to\n   * retrieve the subtitle from your app’s Localizable.strings file.\n   * The value must contain the name of a key in your strings file.\n   */\n  \"subtitle-loc-key\"?: string;\n\n  /**\n   * An array of strings containing replacement values for variables in your title string.\n   * Each %\\@ character in the string specified by subtitle-loc-key is replaced by a value\n   * from this array. The first item in the array replaces the first instance of the\n   * %\\@ character in the string, the second item replaces the second instance, and so on.\n   */\n  \"subtitle-loc-args\"?: string[];\n\n  /**\n   * The key for a localized message string. Use this key, instead of the body key, to\n   * retrieve the message text from your app’s Localizable.strings file. The value must contain\n   * the name of a key in your strings file.\n   */\n  \"loc-key\"?: string;\n\n  /**\n   * An array of strings containing replacement values for variables in your message text.\n   * Each %\\@ character in the string specified by loc-key is replaced by a value from\n   * this array. The first item in the array replaces the first instance of the %\\@ character\n   * in the string, the second item replaces the second instance, and so on.\n   */\n  \"loc-args\"?: string[];\n}\n\n/**\n * Represents an APNs critical sound\n */\nexport interface AppleCriticalSound {\n  /**\n   * The critical alert flag. Set to 1 to enable the critical alert.\n   */\n  critical: number;\n\n  /**\n   * The name of a sound file in your app’s main bundle or in the Library/Sounds folder\n   * of your app’s container directory. Specify the string “default” to play the system sound.\n   */\n  name: string;\n\n  /**\n   * The volume for the critical alert’s sound. Set this to a value between 0 (silent) and 1 (full volume).\n   */\n  volume: number;\n}\n\n/**\n * Represents a native APNs message.\n */\nexport interface AppleNativeMessage extends Record<string, any> {\n  /**\n   * The information for displaying an alert.\n   */\n  alert?: string | AppleAlert;\n\n  /**\n   * The number to display in a badge on your app’s icon.\n   */\n  badge?: number;\n\n  /**\n   * The name of a sound file in your app’s main bundle or in the Library/Sounds\n   * folder of your app’s container directory. Specify the string “default” to\n   * play the system sound. Use this key for regular notifications.\n   * For critical alerts, use the sound dictionary instead.\n   */\n  sound?: string | AppleCriticalSound;\n\n  /**\n   * An app-specific identifier for grouping related notifications.\n   */\n  \"thread-id\"?: string;\n\n  /**\n   * The notification’s type.\n   */\n  category?: string;\n\n  /**\n   * The background notification flag. To perform a silent background update,\n   * specify the value 1 and don’t include the alert, badge, or sound keys in your payload.\n   */\n  \"content-available\"?: number;\n\n  /**\n   * The notification service app extension flag. If the value is 1, the system passes\n   * the notification to your notification service app extension before delivery.\n   */\n  \"mutable-content\"?: number;\n\n  /**\n   * The identifier of the window brought forward.\n   */\n  \"target-content-id\"?: string;\n\n  /**\n   * The importance and delivery timing of a notification.\n   */\n  \"interruption-level\"?: \"passive\" | \"active\" | \"time-sensitive\" | \"critical\";\n\n  /**\n   * The relevance score, a number between 0 and 1, that the system uses to sort the\n   * notifications from your app. The highest score gets featured in the notification summary.\n   */\n  \"relevance-score\"?: number;\n\n  /**\n   * The criteria the system evaluates to determine if it displays the notification in the current Focus.\n   */\n  \"filter-criteria\"?: string;\n}\n\n/**\n * Creates an APNs native message to send to Notification Hubs.\n * @param nativeMessage - The Apple native message properties to set.\n * @param additionalProperties - Additional properties for Apple messages.\n * @returns An AppleNotification to send to Notification Hubs.\n */\nexport function createAppleNotificationBody(nativeMessage: AppleNativeMessage): string {\n  return JSON.stringify(nativeMessage);\n}\n\n/**\n * Represents the targets, options, and payload for HTTP JSON messages for the Firebase Legacy HTTP interface.\n */\nexport interface FirebaseLegacyNativeMessage {\n  /**\n   * The recipient of a message.\n   */\n  to?: string;\n\n  /**\n   * The recipient of a multicast message, a message sent to more than one registration token.\n   */\n  registration_ids?: string[];\n\n  /**\n   * A logical expression of conditions that determine the message target.\n   */\n  condition?: string;\n\n  /**\n   * Used to identify a group of messages.\n   */\n  collapse_key?: string;\n\n  /**\n   * The priority of the message.\n   */\n  priority?: \"normal\" | \"high\";\n\n  /**\n   * The background notification flag. To perform a silent background update,\n   * specify the value 1 and don’t include the alert, badge, or sound keys in your payload.\n   */\n  content_available?: boolean;\n\n  /**\n   * The notification service app extension flag. If the value is 1, the system passes\n   * the notification to your notification service app extension before delivery.\n   */\n  mutable_content?: number;\n\n  /**\n   * Specifies how long (in seconds) the message should be kept in FCM storage if the device is offline\n   */\n  time_to_live?: number;\n\n  /**\n   * The package name of the application where the registration tokens must match in order to receive the message.\n   */\n  restricted_package_name?: string;\n\n  /**\n   * When set to true, allows developers to test a request without actually sending a message.\n   */\n  dry_run?: boolean;\n\n  /**\n   * Custom key-value pairs of the message's payload.\n   */\n  data?: Record<string, any>;\n\n  /**\n   * The predefined, user-visible key-value pairs of the notification payload.\n   */\n  notification?:\n    | FirebaseLegacyAppleNativePayload\n    | FirebaseLegacyAndroidNativePayload\n    | FirebaseLegacyWebNativePayload;\n}\n\n/**\n * Represents an APNs native payload for the Firebase Legacy HTTP interface.\n */\nexport interface FirebaseLegacyAppleNativePayload {\n  /**\n   * The notification's title.\n   */\n  title?: string;\n\n  /**\n   * The notification's body text.\n   */\n  body?: string;\n\n  /**\n   * The sound to play when the device receives the notification.\n   */\n  sound?: string;\n\n  /**\n   * The value of the badge on the home screen app icon.\n   */\n  badge?: string;\n\n  /**\n   * The action associated with a user click on the notification which corresponds to the APNs category.\n   */\n  click_action?: string;\n\n  /**\n   * The notification's subtitle.\n   */\n  subtitle?: string;\n\n  /**\n   * The key to the body string in the app's string resources to use to localize the body text to the user's current localization.\n   */\n  body_loc_key?: string;\n\n  /**\n   * Variable string values to be used in place of the format specifiers in body_loc_key to use to localize the body text to the user's current localization.\n   */\n  body_loc_args?: string[];\n\n  /**\n   * The key to the title string in the app's string resources to use to localize the title text to the user's current localization.\n   */\n  title_loc_key?: string;\n\n  /**\n   * Variable string values to be used in place of the format specifiers in title_loc_key to use to localize the title text to the user's current localization.\n   */\n  title_loc_args?: string[];\n}\n\n/**\n * Represents an Android native payload for the Firebase Legacy HTTP interface.\n */\nexport interface FirebaseLegacyAndroidNativePayload {\n  /**\n   * The notification's title.\n   */\n  title?: string;\n\n  /**\n   * The notification's body text.\n   */\n  body?: string;\n\n  /**\n   * The notification's channel ID.\n   */\n  android_channel_id?: string;\n\n  /**\n   * The notification's icon.\n   */\n  icon?: string;\n\n  /**\n   * The sound to play when the device receives the notification.\n   */\n  sound?: string;\n\n  /**\n   * Identifier used to replace existing notifications in the notification drawer.\n   */\n  tag?: string;\n\n  /**\n   * The notification's icon color, expressed in #rrggbb format.\n   */\n  color?: string;\n\n  /**\n   * The action associated with a user click on the notification.\n   */\n  click_action?: string;\n\n  /**\n   * The key to the body string in the app's string resources to use to localize the body text to the user's current localization.\n   */\n  body_loc_key?: string;\n\n  /**\n   * Variable string values to be used in place of the format specifiers in body_loc_key to use to localize the body text to the user's current localization.\n   */\n  body_loc_args?: string[];\n\n  /**\n   * The key to the title string in the app's string resources to use to localize the title text to the user's current localization.\n   */\n  title_loc_key?: string;\n\n  /**\n   * Variable string values to be used in place of the format specifiers in title_loc_key to use to localize the title text to the user's current localization.\n   */\n  title_loc_args?: string[];\n}\n\n/**\n * Represents an Web Push native payload for the Firebase Legacy HTTP interface.\n */\nexport interface FirebaseLegacyWebNativePayload {\n  /**\n   * The notification's title.\n   */\n  title?: string;\n\n  /**\n   * The notification's body text.\n   */\n  body?: string;\n\n  /**\n   * The URL to use for the notification's icon.\n   */\n  icon?: string;\n\n  /**\n   * The action associated with a user click on the notification.\n   */\n  click_action?: string;\n}\n\n/**\n * Creates a FcmLegacyNotification from a native Firebase payload.\n * @param nativeMessage - The native message payload to send to Notification Hubs.\n * @returns The JSON body to send to Notification Hubs.\n */\nexport function createFirebaseLegacyNotificationBody(\n  nativeMessage: FirebaseLegacyNativeMessage\n): string {\n  return JSON.stringify(nativeMessage);\n}\n\n/**\n * Describes ADM notification messages.\n */\nexport interface AdmNativeNotification {\n  /**\n   * The notification's title.\n   */\n  title?: string;\n\n  /**\n   * The notification's body text.\n   */\n  body?: string;\n\n  /**\n   * The notification's icon.\n   */\n  icon?: string;\n\n  /**\n   * The notification's icon color, expressed in #rrggbb format.\n   */\n  color?: string;\n\n  /**\n   * The sound to play when the device receives the notification. Supports \"default\" or the filename of a sound resource bundled in the app.\n   */\n  sound?: string;\n\n  /**\n   * Identifier used to replace existing notifications in the notification drawer.\n   */\n  tag?: string;\n\n  /**\n   * The action associated with a user click on the notification.\n   */\n  click_action?: string;\n\n  /**\n   * The key to the body string in the app's string resources to use to localize the body text to the user's current localization.\n   */\n  body_loc_key?: string;\n\n  /**\n   * Variable string values to be used in place of the format specifiers in body_loc_key to use to localize the body text to the user's current localization.\n   */\n  body_loc_args?: string[];\n\n  /**\n   * The key to the title string in the app's string resources to use to localize the title text to the user's current localization.\n   */\n  title_loc_key?: string;\n\n  /**\n   * Variable string values to be used in place of the format specifiers in title_loc_key to use to localize the title text to the user's current localization.\n   */\n  title_loc_args?: string[];\n\n  /**\n   * The notification's channel id.\n   */\n  channel_id?: string;\n\n  /**\n   * Sets the \"ticker\" text, which is sent to accessibility services.\n   */\n  ticker?: string;\n\n  /**\n   * When set to false or unset, the notification is automatically dismissed when the user clicks it in the panel.\n   */\n  sticky?: boolean;\n\n  /**\n   * Set the time that the event in the notification occurred. Must be a timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. Example: \"2014-10-02T15:01:23.045123456Z\".\n   */\n  event_time?: string;\n\n  /**\n   * Set whether or not this notification is relevant only to the current device.\n   */\n  local_only?: boolean;\n\n  /**\n   * Set the relative priority for this notification.\n   */\n  notification_priority?:\n    | \"PRIORITY_UNSPECIFIED\"\n    | \"PRIORITY_MIN\"\n    | \"PRIORITY_LOW\"\n    | \"PRIORITY_DEFAULT\"\n    | \"PRIORITY_HIGH\"\n    | \"PRIORITY_MAX\";\n\n  /**\n   * If set to true, use the Android framework's default sound for the notification.\n   */\n  default_sound?: boolean;\n\n  /**\n   * Set the Notification.visibility of the notification.\n   */\n  visibility?: \"VISIBILITY_UNSPECIFIED\" | \"PRIVATE\" | \"PUBLIC\" | \"SECRET\";\n\n  /**\n   * Sets the number of items this notification represents.\n   */\n  notification_count?: number;\n\n  /**\n   * Contains the URL of an image that is going to be displayed in a notification.\n   */\n  image?: string;\n}\n\n/**\n * Represents a native ADM notification message payload.\n */\nexport interface AdmNativeMessage {\n  /**\n   * The notification payload to send with the message.\n   */\n  notification?: AdmNativeNotification;\n\n  /**\n   * The payload data to send with the message.\n   */\n  data?: Record<string, string>;\n\n  /**\n   * The priority of the msssage.\n   */\n  priority?: \"normal\" | \"high\";\n\n  /**\n   * This is an arbitrary string used to indicate that multiple messages are logically the same\n   * and that ADM is allowed to drop previously enqueued messages in favor of this new one.\n   */\n  consolidationKey?: string;\n\n  /**\n   * The number of seconds that ADM should retain the message if the device is offline.\n   */\n  expiresAfter?: number;\n\n  /**\n   * This is a base-64-encoded MD5 checksum of the data parameter.\n   */\n  md5?: string;\n}\n\n/**\n * Creates a AdmNotification from a native ADM payload.\n * @param nativeMessage - The native message payload to send to Notification Hubs.\n * @returns The AdmNotification to send to Notification Hubs.\n */\nexport function createAdmNotificationBody(nativeMessage: AdmNativeMessage): string {\n  return JSON.stringify(nativeMessage);\n}\n\n/**\n * Represents the Baidu Apple native payload.\n */\nexport interface BaiduAppleNativePayload {\n  /**\n   * The alert string.\n   */\n  alert?: string;\n\n  /**\n   * The APNs sound to play.\n   */\n  sound?: string;\n\n  /**\n   * The APNs badge count.\n   */\n  badge?: number;\n}\n\n/**\n * Baidu Native Format:\n * https://stackoverflow.com/questions/42591815/customize-baidu-push-json-payload\n * http://www.tuicool.com/articles/ZnmANn\n */\nexport interface BaiduNativeMessage extends Record<string, any> {\n  /**\n   * Notification title for Android.\n   */\n  title?: string;\n\n  /**\n   * Baidu Notification description for Android.\n   */\n  description?: string;\n\n  /**\n   * Baidu Notification builder ID.\n   */\n  notification_builder_id?: number;\n\n  /**\n   * Baidu Notification Android basic style.\n   */\n  notification_basic_style?: number;\n\n  /**\n   * Baidu Android open type.\n   */\n  open_type?: number;\n\n  /**\n   * Baidu Android net support option.\n   */\n  net_support?: number;\n\n  /**\n   * Baidu Android user confirm.\n   */\n  user_confirm?: number;\n\n  /**\n   * Baidu Android URL.\n   */\n  url?: string;\n\n  /**\n   * Baidu Android package content.\n   */\n  pkg_content?: string;\n\n  /**\n   * Baidu Android package version.\n   */\n  pkg_version?: string;\n\n  /**\n   * Baidu Android custom content dictionary.\n   */\n  custom_content?: Record<string, any>;\n\n  /**\n   * Baidu APNs support.\n   */\n  aps?: BaiduAppleNativePayload;\n}\n\n/**\n * Creates a BaiduNotification from a native Baidu payload.\n * @param nativeMessage - The native message payload to send to Notification Hubs.\n * @returns The JSON body to send to Notification Hubs.\n */\nexport function createBaiduNotificationBody(nativeMessage: BaiduNativeMessage): string {\n  return JSON.stringify(nativeMessage);\n}\n\n/**\n * Represents the types of Windows Badge Glyphs\n */\nexport type WindowsBadgeGlyphType =\n  | \"none\"\n  | \"activity\"\n  | \"alarm\"\n  | \"alert\"\n  | \"attention\"\n  | \"available\"\n  | \"away\"\n  | \"busy\"\n  | \"error\"\n  | \"newMessage\"\n  | \"paused\"\n  | \"playing\"\n  | \"unavailable\";\n\n/**\n * Represents the Windows Badge Message\n */\nexport interface WindowsBadgeNativeMessage {\n  /**\n   * Either a numeric value or a string value that specifies a predefined badge glyph.\n   */\n  value: WindowsBadgeGlyphType | number;\n}\n\n/**\n * Builds a WindowsNotification from a Windows Badge.\n * @param nativeMessage - The Windows Badge Message to build.\n * @returns The WNS XML created with the badge information.\n */\nexport function createWindowsBadgeNotificationBody(\n  nativeMessage: WindowsBadgeNativeMessage\n): string {\n  const badge = {\n    $: { value: nativeMessage.value },\n  };\n\n  return stringifyXML(badge, { rootName: \"badge\" });\n}\n"]}

package/dist-esm/src/models/notificationDetails.js.map

@@ -1 +1 @@
-{"version":3,"file":"notificationDetails.js","sourceRoot":"","sources":["../../../src/models/notificationDetails.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\n/**\n * Represents the notification outcome states.\n */\nexport type NotificationOutcomeState =\n  | \"Enqueued\"\n  | \"DetailedStateAvailable\"\n  | \"Processing\"\n  | \"Completed\"\n  | \"Abandoned\"\n  | \"Unknown\"\n  | \"NoTargetFound\"\n  | \"Cancelled\";\n\n/**\n * The per platform count per state.\n */\nexport interface NotificationOutcomeCollectionItem {\n  /**\n   * The state of the notification.\n   */\n  state: string;\n\n  /**\n   * The count of notifications per state.\n   */\n  count: number;\n}\n\n/**\n * Represents Notification details.\n */\nexport interface NotificationDetails {\n  /**\n   * The unique notification identifier.\n   */\n  notificationId?: string;\n\n  /**\n   * The notification location.\n   */\n  location?: string;\n\n  /**\n   * The notification state.\n   */\n  state?: NotificationOutcomeState;\n\n  /**\n   * The enqueue time of the notification.\n   */\n  enqueueTime?: Date;\n\n  /**\n   * The notification send start time.\n   */\n  startTime?: Date;\n\n  /**\n   * The notification send end time.\n   */\n  endTime?: Date;\n\n  /**\n   * The notification body.\n   */\n  notificationBody?: string;\n\n  /**\n   * The notification tags.\n   */\n  tags?: string;\n\n  /**\n   * The notification platforms targeted.\n   */\n  targetPlatforms?: string;\n\n  /**\n   * The URL for the platform notification services errors.\n   */\n  pnsErrorDetailsUrl?: string;\n\n  /**\n   * APNs outcomes counts per state.\n   */\n  apnsOutcomeCounts?: NotificationOutcomeCollectionItem[];\n\n  /**\n   * WNS outcomes counts per state.\n   */\n  wnsOutcomeCounts?: NotificationOutcomeCollectionItem[];\n\n  /**\n   * FCM outcome counts per state.\n   */\n  fcmOutcomeCounts?: NotificationOutcomeCollectionItem[];\n\n  /**\n   * ADM outcome counts per state.\n   */\n  admOutcomeCounts?: NotificationOutcomeCollectionItem[];\n\n  /**\n   * Baidu outcome counts per state.\n   */\n  baiduOutcomeCounts?: NotificationOutcomeCollectionItem[];\n\n  /**\n   * Web Push outcome counts per state.\n   */\n  browserOutcomeCounts?: NotificationOutcomeCollectionItem[];\n}\n\n/**\n * Describes a response from the Notification Hubs which includes a tracking ID, correlation ID and location.\n */\nexport interface NotificationHubsResponse {\n  /**\n   * The Tracking ID of the operation.\n   */\n  trackingId?: string;\n\n  /**\n   * The correlation ID of the operation.\n   */\n  correlationId?: string;\n\n  /**\n   * The location of the operation.\n   */\n  location?: string;\n}\n\n/**\n * Represents the result of the registration.\n */\nexport interface RegistrationResult {\n  /**\n   * The application platform.\n   */\n  applicationPlatform: string;\n\n  /**\n   * The PNS handle.\n   */\n  pnsHandle: string;\n\n  /**\n   * The registration ID.\n   */\n  registrationId: string;\n\n  /**\n   * The outcome of the registration.\n   */\n  outcome: string;\n}\n\n/**\n * Describes a response from the Notification Hubs service for send operations.\n */\nexport interface NotificationHubsMessageResponse extends NotificationHubsResponse {\n  /**\n   * The notification ID from the operation.  Note this is only available in Standard SKU and above.\n   */\n  notificationId?: string;\n\n  /**\n   * The number of devices that successfully received the notification.\n   */\n  success: number;\n\n  /**\n   * The number of devices that failed to receive a notification.\n   */\n  failure: number;\n\n  /**\n   * The list of notification outcome results for each device registered with the hub, to which this notification was sent.\n   */\n  results: RegistrationResult[];\n\n  /**\n   * The state of this notification outcome.\n   */\n  state: NotificationOutcomeState;\n}\n"]}
+{"version":3,"file":"notificationDetails.js","sourceRoot":"","sources":["../../../src/models/notificationDetails.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\n/**\n * Represents the notification outcome states.\n */\nexport type NotificationOutcomeState =\n  | \"Enqueued\"\n  | \"DetailedStateAvailable\"\n  | \"Processing\"\n  | \"Completed\"\n  | \"Abandoned\"\n  | \"Unknown\"\n  | \"NoTargetFound\"\n  | \"Cancelled\";\n\n/**\n * The per platform count per state.\n */\nexport interface NotificationOutcome {\n  /**\n   * The state of the notification.\n   */\n  state: string;\n\n  /**\n   * The count of notifications per state.\n   */\n  count: number;\n}\n\n/**\n * Represents Notification details.\n */\nexport interface NotificationDetails {\n  /**\n   * The unique notification identifier.\n   */\n  notificationId?: string;\n\n  /**\n   * The notification location.\n   */\n  location?: string;\n\n  /**\n   * The notification state.\n   */\n  state?: NotificationOutcomeState;\n\n  /**\n   * The enqueue time of the notification.\n   */\n  enqueueTime?: Date;\n\n  /**\n   * The notification send start time.\n   */\n  startTime?: Date;\n\n  /**\n   * The notification send end time.\n   */\n  endTime?: Date;\n\n  /**\n   * The notification body.\n   */\n  notificationBody?: string;\n\n  /**\n   * The notification tags.\n   */\n  tags?: string;\n\n  /**\n   * The notification platforms targeted.\n   */\n  targetPlatforms?: string;\n\n  /**\n   * The URL for the platform notification services errors.\n   */\n  pnsErrorDetailsUrl?: string;\n\n  /**\n   * APNs outcomes counts per state.\n   */\n  apnsOutcomeCounts?: NotificationOutcome[];\n\n  /**\n   * WNS outcomes counts per state.\n   */\n  wnsOutcomeCounts?: NotificationOutcome[];\n\n  /**\n   * FCM outcome counts per state.\n   */\n  fcmOutcomeCounts?: NotificationOutcome[];\n\n  /**\n   * ADM outcome counts per state.\n   */\n  admOutcomeCounts?: NotificationOutcome[];\n\n  /**\n   * Baidu outcome counts per state.\n   */\n  baiduOutcomeCounts?: NotificationOutcome[];\n\n  /**\n   * Web Push outcome counts per state.\n   */\n  browserOutcomeCounts?: NotificationOutcome[];\n}\n\n/**\n * Describes a response from the Notification Hubs which includes a tracking ID, correlation ID and location.\n */\nexport interface NotificationHubsResponse {\n  /**\n   * The Tracking ID of the operation.\n   */\n  trackingId?: string;\n\n  /**\n   * The correlation ID of the operation.\n   */\n  correlationId?: string;\n\n  /**\n   * The location of the operation.\n   */\n  location?: string;\n}\n\n/**\n * Represents the result of the registration.\n */\nexport interface RegistrationResult {\n  /**\n   * The application platform.\n   */\n  applicationPlatform: string;\n\n  /**\n   * The PNS handle.\n   */\n  pnsHandle: string;\n\n  /**\n   * The registration ID.\n   */\n  registrationId: string;\n\n  /**\n   * The outcome of the registration.\n   */\n  outcome: string;\n}\n\n/**\n * Describes a response from the Notification Hubs service for send operations.\n */\nexport interface NotificationHubsMessageResponse extends NotificationHubsResponse {\n  /**\n   * The notification ID from the operation.  Note this is only available in Standard SKU and above.\n   */\n  notificationId?: string;\n\n  /**\n   * The number of devices that successfully received the notification.\n   */\n  successCount: number;\n\n  /**\n   * The number of devices that failed to receive a notification.\n   */\n  failureCount: number;\n\n  /**\n   * The list of notification outcome results for each device registered with the hub, to which this notification was sent.\n   */\n  results: RegistrationResult[];\n\n  /**\n   * The state of this notification outcome.\n   */\n  state: NotificationOutcomeState;\n}\n"]}