@azure/notification-hubs 1.0.0-beta.6 → 1.0.0-beta.8

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/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"]}

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

@@ -1 +1 @@
-{"version":3,"file":"options.js","sourceRoot":"","sources":["../../../src/models/options.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { CommonClientOptions, OperationOptions } from \"@azure/core-client\";\nimport { BrowserPushChannel } from \"./installation.js\";\n\n/**\n * Describes the options that can be provided while creating the NotificationHubsClientContext.\n */\nexport interface NotificationHubsClientOptions extends CommonClientOptions {}\n\n/**\n * Options for polled operations including the polling interval cycle.\n */\nexport interface PolledOperationOptions extends OperationOptions {\n  /**\n   * Time delay between poll requests, in milliseconds.\n   */\n  updateIntervalInMs?: number;\n}\n\n/**\n * Options for sending notifications for both tag based send and broadcast scheduled send.\n */\nexport interface ScheduleNotificationOptions extends OperationOptions {\n  /**\n   * The tags used to target the device for push notifications in either an array as \"an || condition\" or tag expression.\n   * If not set, this results in a broadcast notification to be scheduled.\n   */\n  tags?: string | string[];\n}\n\n/**\n * Options for sending notifications for both tag based send and broadcast send.\n */\nexport interface SendNotificationOptions extends OperationOptions {\n  /**\n   * The tags used to target the device for push notifications in either an array as \"an || condition\" or tag expression.\n   * If not set, this results in a broadcast notification to be sent.\n   */\n  tags?: string | string[];\n  /**\n   * Set to true to enable test send.\n   */\n  enableTestSend?: boolean;\n}\n\n/**\n * Options for sending notifications to individual devices.\n */\nexport interface DirectSendNotificationOptions extends OperationOptions {\n  /**\n   * The device handle to send the notification. If an array is provided, this uses batch direct send which is only available in Standard SKU and above.\n   */\n  deviceHandle: string | BrowserPushChannel | string[];\n}\n\n/**\n * Represents entity update operation options that can be set.\n */\nexport interface EntityOperationOptions extends OperationOptions {\n  /**\n   * ETag as returned by creation, update, and retrieval, or ‘*’ (overwrite).\n   */\n  etag?: string;\n}\n\n/**\n * Represents query options to include $top support.\n */\nexport interface RegistrationQueryLimitOptions extends OperationOptions {\n  /**\n   * The $top query member to get a number of records.\n   */\n  top?: number;\n}\n\n/**\n * Represents query options to include both $top and $filter.\n */\nexport interface RegistrationQueryOptions extends RegistrationQueryLimitOptions {\n  /**\n   * The OData $filter operator query string.\n   */\n  filter?: string;\n}\n"]}
+{"version":3,"file":"options.js","sourceRoot":"","sources":["../../../src/models/options.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { CommonClientOptions, OperationOptions } from \"@azure/core-client\";\nimport { BrowserPushChannel } from \"./installation.js\";\n\n/**\n * Describes the options that can be provided while creating the NotificationHubsClientContext.\n */\nexport interface NotificationHubsClientOptions extends CommonClientOptions {}\n\n/**\n * Options for polled operations including the polling interval cycle.\n */\nexport interface PolledOperationOptions extends OperationOptions {\n  /**\n   * Time delay between poll requests, in milliseconds.\n   */\n  updateIntervalInMs?: number;\n}\n\n/**\n * Options for sending notifications for both tag based send and broadcast scheduled send.\n */\nexport interface ScheduleNotificationOptions extends OperationOptions {\n  /**\n   * A tag expression used to target devices. Use the `createTagExpression` function to create a tag expression from an array of tags.\n   * If not set, this results in a broadcast notification to be scheduled.\n   */\n  tagExpression?: string;\n}\n\n/**\n * Options for sending notifications for both tag based send and broadcast send.\n */\nexport interface SendNotificationOptions extends OperationOptions {\n  /**\n   * A tag expression used to target devices. Use the `createTagExpression` function to create a tag expression from an array of tags.\n   * If not set, this results in a broadcast notification to be sent.\n   */\n  tagExpression?: string;\n  /**\n   * Set to true to enable test send.\n   */\n  enableTestSend?: boolean;\n}\n\n/**\n * Options for sending notifications to individual devices.\n */\nexport interface DirectSendNotificationOptions extends OperationOptions {\n  /**\n   * The device handle to send the notification. If an array is provided, this uses batch direct send which is only available in Standard SKU and above.\n   */\n  deviceHandle: string | BrowserPushChannel | string[];\n}\n\n/**\n * Represents entity update operation options that can be set.\n */\nexport interface EntityOperationOptions extends OperationOptions {\n  /**\n   * ETag as returned by creation, update, and retrieval, or ‘*’ (overwrite).\n   */\n  etag?: string;\n}\n\n/**\n * Represents query options to include $top support.\n */\nexport interface RegistrationQueryLimitOptions extends OperationOptions {\n  /**\n   * The $top query member to get a number of records.\n   */\n  top?: number;\n}\n\n/**\n * Represents query options to include both $top and $filter.\n */\nexport interface RegistrationQueryOptions extends RegistrationQueryLimitOptions {\n  /**\n   * The OData $filter operator query string.\n   */\n  filter?: string;\n}\n"]}

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

@@ -6,7 +6,7 @@
  * @returns A created ADM registration description.
  */
 export function createAdmRegistrationDescription(description) {
-    return Object.assign(Object.assign({}, description), { type: "Adm" });
+    return Object.assign(Object.assign({}, description), { kind: "Adm" });
 }
 /**
  * Creates an ADM template registration description.
@@ -14,7 +14,7 @@ export function createAdmRegistrationDescription(description) {
  * @returns A created ADM template registration description.
  */
 export function createAdmTemplateRegistrationDescription(description) {
-    return Object.assign(Object.assign({}, description), { type: "AdmTemplate" });
+    return Object.assign(Object.assign({}, description), { kind: "AdmTemplate" });
 }
 /**
  * Creates an Apple registration description.
@@ -22,7 +22,7 @@ export function createAdmTemplateRegistrationDescription(description) {
  * @returns A created Apple registration description.
  */
 export function createAppleRegistrationDescription(description) {
-    return Object.assign(Object.assign({}, description), { type: "Apple" });
+    return Object.assign(Object.assign({}, description), { kind: "Apple" });
 }
 /**
  * Creates an Apple template registration description.
@@ -30,7 +30,7 @@ export function createAppleRegistrationDescription(description) {
  * @returns A created Apple template registration description.
  */
 export function createAppleTemplateRegistrationDescription(description) {
-    return Object.assign(Object.assign({}, description), { type: "AppleTemplate" });
+    return Object.assign(Object.assign({}, description), { kind: "AppleTemplate" });
 }
 /**
  * Creates a Baidu registration description.
@@ -38,7 +38,7 @@ export function createAppleTemplateRegistrationDescription(description) {
  * @returns A created Baidu registration description.
  */
 export function createBaiduRegistrationDescription(description) {
-    return Object.assign(Object.assign({}, description), { type: "Baidu" });
+    return Object.assign(Object.assign({}, description), { kind: "Baidu" });
 }
 /**
  * Creates a Baidu template registration description.
@@ -46,7 +46,7 @@ export function createBaiduRegistrationDescription(description) {
  * @returns A created Baidu template registration description.
  */
 export function createBaiduTemplateRegistrationDescription(description) {
-    return Object.assign(Object.assign({}, description), { type: "BaiduTemplate" });
+    return Object.assign(Object.assign({}, description), { kind: "BaiduTemplate" });
 }
 /**
  * Creates a Web Push registration description.
@@ -54,7 +54,7 @@ export function createBaiduTemplateRegistrationDescription(description) {
  * @returns A created Web Push registration description.
  */
 export function createBrowserRegistrationDescription(description) {
-    return Object.assign(Object.assign({}, description), { type: "Browser" });
+    return Object.assign(Object.assign({}, description), { kind: "Browser" });
 }
 /**
  * Creates a Web Push registration description.
@@ -62,7 +62,7 @@ export function createBrowserRegistrationDescription(description) {
  * @returns A created Web Push template registration description.
  */
 export function createBrowserTemplateRegistrationDescription(description) {
-    return Object.assign(Object.assign({}, description), { type: "BrowserTemplate" });
+    return Object.assign(Object.assign({}, description), { kind: "BrowserTemplate" });
 }
 /**
  * Creates a Firebase Legacy registration description.
@@ -70,7 +70,7 @@ export function createBrowserTemplateRegistrationDescription(description) {
  * @returns A created GCM registration description.
  */
 export function createFcmLegacyRegistrationDescription(description) {
-    return Object.assign(Object.assign({}, description), { type: "Gcm" });
+    return Object.assign(Object.assign({}, description), { kind: "Gcm" });
 }
 /**
  * Creates a GCM template registration description.
@@ -78,7 +78,7 @@ export function createFcmLegacyRegistrationDescription(description) {
  * @returns A created GCM template registration description.
  */
 export function createFcmLegacyTemplateRegistrationDescription(description) {
-    return Object.assign(Object.assign({}, description), { type: "GcmTemplate" });
+    return Object.assign(Object.assign({}, description), { kind: "GcmTemplate" });
 }
 /**
  * Creates a Windows registration description.
@@ -86,7 +86,7 @@ export function createFcmLegacyTemplateRegistrationDescription(description) {
  * @returns A created Windows registration description.
  */
 export function createWindowsRegistrationDescription(description) {
-    return Object.assign(Object.assign({}, description), { type: "Windows" });
+    return Object.assign(Object.assign({}, description), { kind: "Windows" });
 }
 /**
  * Creates a Windows template registration description.
@@ -94,6 +94,6 @@ export function createWindowsRegistrationDescription(description) {
  * @returns A created Windows template registration description.
  */
 export function createWindowsTemplateRegistrationDescription(description) {
-    return Object.assign(Object.assign({}, description), { type: "WindowsTemplate" });
+    return Object.assign(Object.assign({}, description), { kind: "WindowsTemplate" });
 }
 //# sourceMappingURL=registration.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"registration.js","sourceRoot":"","sources":["../../../src/models/registration.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAsFlC;;;;GAIG;AACH,MAAM,UAAU,gCAAgC,CAC9C,WAAqD;IAErD,uCACK,WAAW,KACd,IAAI,EAAE,KAAK,IACX;AACJ,CAAC;AAcD;;;;GAIG;AACH,MAAM,UAAU,wCAAwC,CACtD,WAA6D;IAE7D,uCACK,WAAW,KACd,IAAI,EAAE,aAAa,IACnB;AACJ,CAAC;AAiBD;;;;GAIG;AACH,MAAM,UAAU,kCAAkC,CAChD,WAAuD;IAEvD,uCACK,WAAW,KACd,IAAI,EAAE,OAAO,IACb;AACJ,CAAC;AAkCD;;;;GAIG;AACH,MAAM,UAAU,0CAA0C,CACxD,WAA+D;IAE/D,uCACK,WAAW,KACd,IAAI,EAAE,eAAe,IACrB;AACJ,CAAC;AAsBD;;;;GAIG;AACH,MAAM,UAAU,kCAAkC,CAChD,WAAuD;IAEvD,uCACK,WAAW,KACd,IAAI,EAAE,OAAO,IACb;AACJ,CAAC;AAcD;;;;GAIG;AACH,MAAM,UAAU,0CAA0C,CACxD,WAA+D;IAE/D,uCACK,WAAW,KACd,IAAI,EAAE,eAAe,IACrB;AACJ,CAAC;AA2BD;;;;GAIG;AACH,MAAM,UAAU,oCAAoC,CAClD,WAAyD;IAEzD,uCACK,WAAW,KACd,IAAI,EAAE,SAAS,IACf;AACJ,CAAC;AAcD;;;;GAIG;AACH,MAAM,UAAU,4CAA4C,CAC1D,WAAiE;IAEjE,uCACK,WAAW,KACd,IAAI,EAAE,iBAAiB,IACvB;AACJ,CAAC;AAiBD;;;;GAIG;AACH,MAAM,UAAU,sCAAsC,CACpD,WAAqD;IAErD,uCACK,WAAW,KACd,IAAI,EAAE,KAAK,IACX;AACJ,CAAC;AAcD;;;;GAIG;AACH,MAAM,UAAU,8CAA8C,CAC5D,WAA6D;IAE7D,uCACK,WAAW,KACd,IAAI,EAAE,aAAa,IACnB;AACJ,CAAC;AAmDD;;;;GAIG;AACH,MAAM,UAAU,oCAAoC,CAClD,WAAyD;IAEzD,uCACK,WAAW,KACd,IAAI,EAAE,SAAS,IACf;AACJ,CAAC;AAmBD;;;;GAIG;AACH,MAAM,UAAU,4CAA4C,CAC1D,WAAiE;IAEjE,uCACK,WAAW,KACd,IAAI,EAAE,iBAAiB,IACvB;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\n/**\n * Represents the types of registration descriptions.\n */\nexport type RegistrationType =\n  | \"Adm\"\n  | \"AdmTemplate\"\n  | \"Apple\"\n  | \"AppleTemplate\"\n  | \"Baidu\"\n  | \"BaiduTemplate\"\n  | \"Browser\"\n  | \"BrowserTemplate\"\n  | \"Gcm\"\n  | \"GcmTemplate\"\n  | \"Mpns\"\n  | \"MpnsTemplate\"\n  | \"Windows\"\n  | \"WindowsTemplate\";\n\n/**\n * Represents a registration description.\n */\nexport interface RegistrationDescriptionCommon {\n  /**\n   * The registration ID.\n   */\n  registrationId?: string;\n\n  /**\n   * The expiration time of the registration.\n   */\n  expirationTime?: Date;\n\n  /**\n   * The ETag associated with this description.\n   */\n  etag?: string;\n\n  /**\n   * The tags associated with the registration.\n   */\n  tags?: string[];\n\n  /**\n   * A dictionary of push variables associated with property bag.\n   */\n  pushVariables?: Record<string, string>;\n\n  /**\n   * The type of the registration.\n   */\n  type: RegistrationType;\n}\n\n/**\n * Represents the description of a template registration.\n */\nexport interface TemplateRegistrationDescription {\n  /**\n   * The body template.\n   */\n  bodyTemplate: string;\n\n  /**\n   * The name of the template.\n   */\n  templateName?: string;\n}\n\n/**\n * Represents the description of the Amazon Device Messaging (ADM) registration.\n */\nexport interface AdmRegistrationDescription extends RegistrationDescriptionCommon {\n  /**\n   * The Amazon Device Messaging registration identifier.\n   */\n  admRegistrationId: string;\n\n  /**\n   * The type of the registration.\n   */\n  type: \"Adm\";\n}\n\n/**\n * Creates an ADM registration description.\n * @param description - A partial ADM registration description.\n * @returns A created ADM registration description.\n */\nexport function createAdmRegistrationDescription(\n  description: Omit<AdmRegistrationDescription, \"type\">\n): AdmRegistrationDescription {\n  return {\n    ...description,\n    type: \"Adm\",\n  };\n}\n\n/**\n * Represents the description of the Amazon Device Messaging (ADM) template registration.\n */\nexport interface AdmTemplateRegistrationDescription\n  extends Omit<AdmRegistrationDescription, \"type\">,\n    TemplateRegistrationDescription {\n  /**\n   * The type of the registration.\n   */\n  type: \"AdmTemplate\";\n}\n\n/**\n * Creates an ADM template registration description.\n * @param description - A partial ADM template registration description.\n * @returns A created ADM template registration description.\n */\nexport function createAdmTemplateRegistrationDescription(\n  description: Omit<AdmTemplateRegistrationDescription, \"type\">\n): AdmTemplateRegistrationDescription {\n  return {\n    ...description,\n    type: \"AdmTemplate\",\n  };\n}\n\n/**\n * Represents the description of apple registration.\n */\nexport interface AppleRegistrationDescription extends RegistrationDescriptionCommon {\n  /**\n   * The APNs device token.\n   */\n  deviceToken: string;\n\n  /**\n   * The type of the registration.\n   */\n  type: \"Apple\";\n}\n\n/**\n * Creates an Apple registration description.\n * @param description - A partial Apple registration description.\n * @returns A created Apple registration description.\n */\nexport function createAppleRegistrationDescription(\n  description: Omit<AppleRegistrationDescription, \"type\">\n): AppleRegistrationDescription {\n  return {\n    ...description,\n    type: \"Apple\",\n  };\n}\n\n/**\n * The priority of the Apple push notification.\n */\nexport type ApplePriority = \"10\" | \"5\";\n\n/**\n * Represents the description of the Apple template registration.\n */\nexport interface AppleTemplateRegistrationDescription\n  extends Omit<AppleRegistrationDescription, \"type\">,\n    TemplateRegistrationDescription {\n  /**\n   * The expiry date.\n   */\n  expiry?: Date;\n\n  /**\n   * The notification priority.\n   */\n  priority?: ApplePriority;\n\n  /**\n   * The APNS headers.\n   */\n  apnsHeaders?: Record<string, string>;\n\n  /**\n   * The type of the registration.\n   */\n  type: \"AppleTemplate\";\n}\n\n/**\n * Creates an Apple template registration description.\n * @param description - A partial Apple template registration description.\n * @returns A created Apple template registration description.\n */\nexport function createAppleTemplateRegistrationDescription(\n  description: Omit<AppleTemplateRegistrationDescription, \"type\">\n): AppleTemplateRegistrationDescription {\n  return {\n    ...description,\n    type: \"AppleTemplate\",\n  };\n}\n\n/**\n * Represents a Baidu registration description.\n */\nexport interface BaiduRegistrationDescription extends RegistrationDescriptionCommon {\n  /**\n   * The Baidu user identifier.\n   */\n  baiduUserId: string;\n\n  /**\n   * The Baidu channel identifier.\n   */\n  baiduChannelId: string;\n\n  /**\n   * The type of the registration.\n   */\n  type: \"Baidu\";\n}\n\n/**\n * Creates a Baidu registration description.\n * @param description - A partial Baidu registration description.\n * @returns A created Baidu registration description.\n */\nexport function createBaiduRegistrationDescription(\n  description: Omit<BaiduRegistrationDescription, \"type\">\n): BaiduRegistrationDescription {\n  return {\n    ...description,\n    type: \"Baidu\",\n  };\n}\n\n/**\n * Represents a Baidu template registration description.\n */\nexport interface BaiduTemplateRegistrationDescription\n  extends Omit<BaiduRegistrationDescription, \"type\">,\n    TemplateRegistrationDescription {\n  /**\n   * The type of the registration.\n   */\n  type: \"BaiduTemplate\";\n}\n\n/**\n * Creates a Baidu template registration description.\n * @param description - A partial Baidu template registration description.\n * @returns A created Baidu template registration description.\n */\nexport function createBaiduTemplateRegistrationDescription(\n  description: Omit<BaiduTemplateRegistrationDescription, \"type\">\n): BaiduTemplateRegistrationDescription {\n  return {\n    ...description,\n    type: \"BaiduTemplate\",\n  };\n}\n\n/**\n * Represents a Browser Push registration description.\n */\nexport interface BrowserRegistrationDescription extends RegistrationDescriptionCommon {\n  /**\n   * The Browser push endpoint.\n   */\n  endpoint: string;\n\n  /**\n   * The Browser push P256DH.\n   */\n  p256dh: string;\n\n  /**\n   * The Browser push auth secret.\n   */\n  auth: string;\n\n  /**\n   * The type of the registration.\n   */\n  type: \"Browser\";\n}\n\n/**\n * Creates a Web Push registration description.\n * @param description - A partial Web Push registration description.\n * @returns A created Web Push registration description.\n */\nexport function createBrowserRegistrationDescription(\n  description: Omit<BrowserRegistrationDescription, \"type\">\n): BrowserRegistrationDescription {\n  return {\n    ...description,\n    type: \"Browser\",\n  };\n}\n\n/**\n * Represents a Browser Push remplate registration description.\n */\nexport interface BrowserTemplateRegistrationDescription\n  extends Omit<BrowserRegistrationDescription, \"type\">,\n    TemplateRegistrationDescription {\n  /**\n   * The type of the registration.\n   */\n  type: \"BrowserTemplate\";\n}\n\n/**\n * Creates a Web Push registration description.\n * @param description - A partial Web Push template registration description.\n * @returns A created Web Push template registration description.\n */\nexport function createBrowserTemplateRegistrationDescription(\n  description: Omit<BrowserTemplateRegistrationDescription, \"type\">\n): BrowserTemplateRegistrationDescription {\n  return {\n    ...description,\n    type: \"BrowserTemplate\",\n  };\n}\n\n/**\n * Represents Notification Hub registration description for Google Cloud Messaging.\n */\nexport interface GcmRegistrationDescription extends RegistrationDescriptionCommon {\n  /**\n   * Registration id obtained from the Google Cloud Messaging service.\n   */\n  gcmRegistrationId: string;\n\n  /**\n   * The type of the registration.\n   */\n  type: \"Gcm\";\n}\n\n/**\n * Creates a Firebase Legacy registration description.\n * @param description - A partial GCM registration description.\n * @returns A created GCM registration description.\n */\nexport function createFcmLegacyRegistrationDescription(\n  description: Omit<GcmRegistrationDescription, \"type\">\n): GcmRegistrationDescription {\n  return {\n    ...description,\n    type: \"Gcm\",\n  };\n}\n\n/**\n * Represents Notification Hub template registration description for Firebase Legacy Cloud Messaging.\n */\nexport interface GcmTemplateRegistrationDescription\n  extends Omit<GcmRegistrationDescription, \"type\">,\n    TemplateRegistrationDescription {\n  /**\n   * The type of the registration.\n   */\n  type: \"GcmTemplate\";\n}\n\n/**\n * Creates a GCM template registration description.\n * @param description - A partial GCM template registration description.\n * @returns A created GCM template registration description.\n */\nexport function createFcmLegacyTemplateRegistrationDescription(\n  description: Omit<GcmTemplateRegistrationDescription, \"type\">\n): GcmTemplateRegistrationDescription {\n  return {\n    ...description,\n    type: \"GcmTemplate\",\n  };\n}\n\n/**\n * Represents a Windows Phone Notification Services registration description.\n * @deprecated Windows Phone is no longer supported.\n */\nexport interface MpnsRegistrationDescription extends RegistrationDescriptionCommon {\n  /**\n   * The channel URI.\n   */\n  channelUri: string;\n\n  /**\n   * The type of the registration.\n   */\n  type: \"Mpns\";\n}\n\n/**\n * Represents a Windows Phone Notification Services template registration.\n * @deprecated Windows Phone is no longer supported.\n */\nexport interface MpnsTemplateRegistrationDescription\n  extends Omit<MpnsRegistrationDescription, \"type\">,\n    TemplateRegistrationDescription {\n  /**\n   * The WNS headers.\n   */\n  mpnsHeaders?: Record<string, string>;\n\n  /**\n   * The type of the registration.\n   */\n  type: \"MpnsTemplate\";\n}\n\n/**\n * Represents a Windows Notification Services (WNS) registration description.\n */\nexport interface WindowsRegistrationDescription extends RegistrationDescriptionCommon {\n  /**\n   * The channel URI.\n   */\n  channelUri: string;\n\n  /**\n   * The type of the registration.\n   */\n  type: \"Windows\";\n}\n\n/**\n * Creates a Windows registration description.\n * @param description - A partial Windows registration description.\n * @returns A created Windows registration description.\n */\nexport function createWindowsRegistrationDescription(\n  description: Omit<WindowsRegistrationDescription, \"type\">\n): WindowsRegistrationDescription {\n  return {\n    ...description,\n    type: \"Windows\",\n  };\n}\n\n/**\n * Represents a Windows Notification Services (WNS) template registration.\n */\nexport interface WindowsTemplateRegistrationDescription\n  extends Omit<WindowsRegistrationDescription, \"type\">,\n    TemplateRegistrationDescription {\n  /**\n   * The WNS headers.\n   */\n  wnsHeaders?: Record<string, string>;\n\n  /**\n   * The type of the registration.\n   */\n  type: \"WindowsTemplate\";\n}\n\n/**\n * Creates a Windows template registration description.\n * @param description - A partial Windows template registration description.\n * @returns A created Windows template registration description.\n */\nexport function createWindowsTemplateRegistrationDescription(\n  description: Omit<WindowsTemplateRegistrationDescription, \"type\">\n): WindowsTemplateRegistrationDescription {\n  return {\n    ...description,\n    type: \"WindowsTemplate\",\n  };\n}\n\n/**\n * Describes the types of registration descriptions.\n */\nexport type RegistrationDescription =\n  | AdmRegistrationDescription\n  | AdmTemplateRegistrationDescription\n  | AppleRegistrationDescription\n  | AppleTemplateRegistrationDescription\n  | BaiduRegistrationDescription\n  | BaiduTemplateRegistrationDescription\n  | BrowserRegistrationDescription\n  | BrowserTemplateRegistrationDescription\n  | GcmRegistrationDescription\n  | GcmTemplateRegistrationDescription\n  | MpnsRegistrationDescription\n  | MpnsTemplateRegistrationDescription\n  | WindowsRegistrationDescription\n  | WindowsTemplateRegistrationDescription;\n"]}
+{"version":3,"file":"registration.js","sourceRoot":"","sources":["../../../src/models/registration.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAsFlC;;;;GAIG;AACH,MAAM,UAAU,gCAAgC,CAC9C,WAA6C;IAE7C,uCACK,WAAW,KACd,IAAI,EAAE,KAAK,IACX;AACJ,CAAC;AAoBD;;;;GAIG;AACH,MAAM,UAAU,wCAAwC,CACtD,WAAqD;IAErD,uCACK,WAAW,KACd,IAAI,EAAE,aAAa,IACnB;AACJ,CAAC;AAsBD;;;;GAIG;AACH,MAAM,UAAU,kCAAkC,CAChD,WAA+C;IAE/C,uCACK,WAAW,KACd,IAAI,EAAE,OAAO,IACb;AACJ,CAAC;AAmCD;;;;GAIG;AACH,MAAM,UAAU,0CAA0C,CACxD,WAAuD;IAEvD,uCACK,WAAW,KACd,IAAI,EAAE,eAAe,IACrB;AACJ,CAAC;AAwBD;;;;GAIG;AACH,MAAM,UAAU,kCAAkC,CAChD,WAA+C;IAE/C,uCACK,WAAW,KACd,IAAI,EAAE,OAAO,IACb;AACJ,CAAC;AAoBD;;;;GAIG;AACH,MAAM,UAAU,0CAA0C,CACxD,WAAuD;IAEvD,uCACK,WAAW,KACd,IAAI,EAAE,eAAe,IACrB;AACJ,CAAC;AAgCD;;;;GAIG;AACH,MAAM,UAAU,oCAAoC,CAClD,WAAiD;IAEjD,uCACK,WAAW,KACd,IAAI,EAAE,SAAS,IACf;AACJ,CAAC;AAoBD;;;;GAIG;AACH,MAAM,UAAU,4CAA4C,CAC1D,WAAyD;IAEzD,uCACK,WAAW,KACd,IAAI,EAAE,iBAAiB,IACvB;AACJ,CAAC;AAsBD;;;;GAIG;AACH,MAAM,UAAU,sCAAsC,CACpD,WAA6C;IAE7C,uCACK,WAAW,KACd,IAAI,EAAE,KAAK,IACX;AACJ,CAAC;AAoBD;;;;GAIG;AACH,MAAM,UAAU,8CAA8C,CAC5D,WAAqD;IAErD,uCACK,WAAW,KACd,IAAI,EAAE,aAAa,IACnB;AACJ,CAAC;AAuFD;;;;GAIG;AACH,MAAM,UAAU,oCAAoC,CAClD,WAAiD;IAEjD,uCACK,WAAW,KACd,IAAI,EAAE,SAAS,IACf;AACJ,CAAC;AAyBD;;;;GAIG;AACH,MAAM,UAAU,4CAA4C,CAC1D,WAAyD;IAEzD,uCACK,WAAW,KACd,IAAI,EAAE,iBAAiB,IACvB;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\n/**\n * Represents the types of registration descriptions.\n */\nexport type RegistrationType =\n  | \"Adm\"\n  | \"AdmTemplate\"\n  | \"Apple\"\n  | \"AppleTemplate\"\n  | \"Baidu\"\n  | \"BaiduTemplate\"\n  | \"Browser\"\n  | \"BrowserTemplate\"\n  | \"Gcm\"\n  | \"GcmTemplate\"\n  | \"Mpns\"\n  | \"MpnsTemplate\"\n  | \"Windows\"\n  | \"WindowsTemplate\";\n\n/**\n * Represents a registration description.\n */\nexport interface RegistrationDescriptionCommon {\n  /**\n   * The registration ID.\n   */\n  registrationId?: string;\n\n  /**\n   * The expiration time of the registration.\n   */\n  expirationTime?: Date;\n\n  /**\n   * The ETag associated with this description.\n   */\n  etag?: string;\n\n  /**\n   * The tags associated with the registration.\n   */\n  tags?: string[];\n\n  /**\n   * A dictionary of push variables associated with property bag.\n   */\n  pushVariables?: Record<string, string>;\n}\n\n/**\n * Represents the description of a template registration.\n */\nexport interface TemplateRegistrationDescription {\n  /**\n   * The body template.\n   */\n  bodyTemplate: string;\n\n  /**\n   * The name of the template.\n   */\n  templateName?: string;\n\n  /**\n   * Represents the description of the Amazon Device Messaging (ADM) registration.\n   */\n}\nexport interface AdmRegistrationDescriptionCommon extends RegistrationDescriptionCommon {\n  /**\n   * The Amazon Device Messaging registration identifier.\n   */\n  admRegistrationId: string;\n}\n\n/**\n * Represents the description of the Amazon Device Messaging (ADM) registration.\n */\nexport interface AdmRegistrationDescription extends AdmRegistrationDescriptionCommon {\n  /**\n   * The kind of the registration.\n   */\n  kind: \"Adm\";\n}\n\n/**\n * Creates an ADM registration description.\n * @param description - A partial ADM registration description.\n * @returns A created ADM registration description.\n */\nexport function createAdmRegistrationDescription(\n  description: AdmRegistrationDescriptionCommon\n): AdmRegistrationDescription {\n  return {\n    ...description,\n    kind: \"Adm\",\n  };\n}\n\n/**\n * Represents the description of the Amazon Device Messaging (ADM) template registration.\n */\nexport interface AdmTemplateRegistrationDescriptionCommon\n  extends AdmRegistrationDescriptionCommon,\n    TemplateRegistrationDescription {}\n\n/**\n * Represents the description of the Amazon Device Messaging (ADM) template registration.\n */\nexport interface AdmTemplateRegistrationDescription\n  extends AdmTemplateRegistrationDescriptionCommon {\n  /**\n   * The kind of the registration.\n   */\n  kind: \"AdmTemplate\";\n}\n\n/**\n * Creates an ADM template registration description.\n * @param description - A partial ADM template registration description.\n * @returns A created ADM template registration description.\n */\nexport function createAdmTemplateRegistrationDescription(\n  description: AdmTemplateRegistrationDescriptionCommon\n): AdmTemplateRegistrationDescription {\n  return {\n    ...description,\n    kind: \"AdmTemplate\",\n  };\n}\n\n/**\n * Represents the description of apple registration.\n */\nexport interface AppleRegistrationDescriptionCommon extends RegistrationDescriptionCommon {\n  /**\n   * The APNs device token.\n   */\n  deviceToken: string;\n}\n\n/**\n * Represents the description of apple registration.\n */\nexport interface AppleRegistrationDescription extends AppleRegistrationDescriptionCommon {\n  /**\n   * The kind of the registration.\n   */\n  kind: \"Apple\";\n}\n\n/**\n * Creates an Apple registration description.\n * @param description - A partial Apple registration description.\n * @returns A created Apple registration description.\n */\nexport function createAppleRegistrationDescription(\n  description: AppleRegistrationDescriptionCommon\n): AppleRegistrationDescription {\n  return {\n    ...description,\n    kind: \"Apple\",\n  };\n}\n\n/**\n * Represents the description of the Apple template registration.\n */\nexport interface AppleTemplateRegistrationDescriptionCommon\n  extends AppleRegistrationDescriptionCommon,\n    TemplateRegistrationDescription {\n  /**\n   * The expiry date.\n   */\n  expiry?: Date;\n\n  /**\n   * The notification priority.\n   */\n  priority?: \"10\" | \"5\";\n\n  /**\n   * The APNS headers.\n   */\n  apnsHeaders?: Record<string, string>;\n}\n\n/**\n * Represents the description of the Apple template registration.\n */\nexport interface AppleTemplateRegistrationDescription\n  extends AppleTemplateRegistrationDescriptionCommon {\n  /**\n   * The kind of the registration.\n   */\n  kind: \"AppleTemplate\";\n}\n\n/**\n * Creates an Apple template registration description.\n * @param description - A partial Apple template registration description.\n * @returns A created Apple template registration description.\n */\nexport function createAppleTemplateRegistrationDescription(\n  description: AppleTemplateRegistrationDescriptionCommon\n): AppleTemplateRegistrationDescription {\n  return {\n    ...description,\n    kind: \"AppleTemplate\",\n  };\n}\n\nexport interface BaiduRegistrationDescriptionCommon extends RegistrationDescriptionCommon {\n  /**\n   * The Baidu user identifier.\n   */\n  baiduUserId: string;\n\n  /**\n   * The Baidu channel identifier.\n   */\n  baiduChannelId: string;\n}\n\n/**\n * Represents a Baidu registration description.\n */\nexport interface BaiduRegistrationDescription extends BaiduRegistrationDescriptionCommon {\n  /**\n   * The kind of the registration.\n   */\n  kind: \"Baidu\";\n}\n\n/**\n * Creates a Baidu registration description.\n * @param description - A partial Baidu registration description.\n * @returns A created Baidu registration description.\n */\nexport function createBaiduRegistrationDescription(\n  description: BaiduRegistrationDescriptionCommon\n): BaiduRegistrationDescription {\n  return {\n    ...description,\n    kind: \"Baidu\",\n  };\n}\n\n/**\n * Represents a Baidu template registration description.\n */\nexport interface BaiduTemplateRegistrationDescriptionCommon\n  extends BaiduRegistrationDescriptionCommon,\n    TemplateRegistrationDescription {}\n\n/**\n * Represents a Baidu template registration description.\n */\nexport interface BaiduTemplateRegistrationDescription\n  extends BaiduTemplateRegistrationDescriptionCommon {\n  /**\n   * The kind of the registration.\n   */\n  kind: \"BaiduTemplate\";\n}\n\n/**\n * Creates a Baidu template registration description.\n * @param description - A partial Baidu template registration description.\n * @returns A created Baidu template registration description.\n */\nexport function createBaiduTemplateRegistrationDescription(\n  description: BaiduTemplateRegistrationDescriptionCommon\n): BaiduTemplateRegistrationDescription {\n  return {\n    ...description,\n    kind: \"BaiduTemplate\",\n  };\n}\n\n/**\n * Represents a Browser Push registration description.\n */\nexport interface BrowserRegistrationDescriptionCommon extends RegistrationDescriptionCommon {\n  /**\n   * The Browser push endpoint.\n   */\n  endpoint: string;\n\n  /**\n   * The Browser push P256DH.\n   */\n  p256dh: string;\n\n  /**\n   * The Browser push auth secret.\n   */\n  auth: string;\n}\n\n/**\n * Represents a Browser Push registration description.\n */\nexport interface BrowserRegistrationDescription extends BrowserRegistrationDescriptionCommon {\n  /**\n   * The kind of the registration.\n   */\n  kind: \"Browser\";\n}\n\n/**\n * Creates a Web Push registration description.\n * @param description - A partial Web Push registration description.\n * @returns A created Web Push registration description.\n */\nexport function createBrowserRegistrationDescription(\n  description: BrowserRegistrationDescriptionCommon\n): BrowserRegistrationDescription {\n  return {\n    ...description,\n    kind: \"Browser\",\n  };\n}\n\n/**\n * Represents a Browser Push remplate registration description.\n */\nexport interface BrowserTemplateRegistrationDescriptionCommon\n  extends BrowserRegistrationDescriptionCommon,\n    TemplateRegistrationDescription {}\n\n/**\n * Represents a Browser Push remplate registration description.\n */\nexport interface BrowserTemplateRegistrationDescription\n  extends BrowserTemplateRegistrationDescriptionCommon {\n  /**\n   * The kind of the registration.\n   */\n  kind: \"BrowserTemplate\";\n}\n\n/**\n * Creates a Web Push registration description.\n * @param description - A partial Web Push template registration description.\n * @returns A created Web Push template registration description.\n */\nexport function createBrowserTemplateRegistrationDescription(\n  description: BrowserTemplateRegistrationDescriptionCommon\n): BrowserTemplateRegistrationDescription {\n  return {\n    ...description,\n    kind: \"BrowserTemplate\",\n  };\n}\n\n/**\n * Represents Notification Hub registration description for Google Cloud Messaging.\n */\nexport interface GcmRegistrationDescriptionCommon extends RegistrationDescriptionCommon {\n  /**\n   * Registration id obtained from the Google Cloud Messaging service.\n   */\n  gcmRegistrationId: string;\n}\n\n/**\n * Represents Notification Hub registration description for Google Cloud Messaging.\n */\nexport interface GcmRegistrationDescription extends GcmRegistrationDescriptionCommon {\n  /**\n   * The kind of the registration.\n   */\n  kind: \"Gcm\";\n}\n\n/**\n * Creates a Firebase Legacy registration description.\n * @param description - A partial GCM registration description.\n * @returns A created GCM registration description.\n */\nexport function createFcmLegacyRegistrationDescription(\n  description: GcmRegistrationDescriptionCommon\n): GcmRegistrationDescription {\n  return {\n    ...description,\n    kind: \"Gcm\",\n  };\n}\n\n/**\n * Represents Notification Hub template registration description for Firebase Legacy Cloud Messaging.\n */\nexport interface GcmTemplateRegistrationDescriptionCommon\n  extends GcmRegistrationDescriptionCommon,\n    TemplateRegistrationDescription {}\n\n/**\n * Represents Notification Hub template registration description for Firebase Legacy Cloud Messaging.\n */\nexport interface GcmTemplateRegistrationDescription\n  extends GcmTemplateRegistrationDescriptionCommon {\n  /**\n   * The kind of the registration.\n   */\n  kind: \"GcmTemplate\";\n}\n\n/**\n * Creates a GCM template registration description.\n * @param description - A partial GCM template registration description.\n * @returns A created GCM template registration description.\n */\nexport function createFcmLegacyTemplateRegistrationDescription(\n  description: GcmTemplateRegistrationDescriptionCommon\n): GcmTemplateRegistrationDescription {\n  return {\n    ...description,\n    kind: \"GcmTemplate\",\n  };\n}\n\n/**\n * Represents a Windows Phone Notification Services registration description.\n * @deprecated Windows Phone is no longer supported.\n */\nexport interface MpnsRegistrationDescriptionCommon extends RegistrationDescriptionCommon {\n  /**\n   * The channel URI.\n   */\n  channelUri: string;\n}\n\n/**\n * Represents a Windows Phone Notification Services registration description.\n * @deprecated Windows Phone is no longer supported.\n */\nexport interface MpnsRegistrationDescription extends MpnsRegistrationDescriptionCommon {\n  /**\n   * The kind of the registration.\n   */\n  kind: \"Mpns\";\n}\n\n/**\n * Represents a Windows Phone Notification Services template registration.\n * @deprecated Windows Phone is no longer supported.\n */\nexport interface MpnsTemplateRegistrationDescription\n  extends MpnsRegistrationDescriptionCommon,\n    TemplateRegistrationDescription {\n  /**\n   * The WNS headers.\n   */\n  mpnsHeaders?: Record<string, string>;\n\n  /**\n   * The kind of the registration.\n   */\n  kind: \"MpnsTemplate\";\n}\n\n/**\n * Represents a Windows Phone Notification Services template registration.\n * @deprecated Windows Phone is no longer supported.\n */\nexport interface MpnsTemplateRegistrationDescriptionCommon\n  extends MpnsRegistrationDescriptionCommon,\n    TemplateRegistrationDescription {\n  /**\n   * The WNS headers.\n   */\n  mpnsHeaders?: Record<string, string>;\n}\n\n/**\n * Represents a Windows Phone Notification Services template registration.\n * @deprecated Windows Phone is no longer supported.\n */\nexport interface MpnsTemplateRegistrationDescription\n  extends MpnsTemplateRegistrationDescriptionCommon {\n  /**\n   * The kind of the registration.\n   */\n  kind: \"MpnsTemplate\";\n}\n\n/**\n * Represents a Windows Notification Services (WNS) registration description.\n */\nexport interface WindowsRegistrationDescriptionCommon extends RegistrationDescriptionCommon {\n  /**\n   * The channel URI.\n   */\n  channelUri: string;\n}\n\n/**\n * Represents a Windows Notification Services (WNS) registration description.\n */\nexport interface WindowsRegistrationDescription extends WindowsRegistrationDescriptionCommon {\n  /**\n   * The kind of the registration.\n   */\n  kind: \"Windows\";\n}\n\n/**\n * Creates a Windows registration description.\n * @param description - A partial Windows registration description.\n * @returns A created Windows registration description.\n */\nexport function createWindowsRegistrationDescription(\n  description: WindowsRegistrationDescriptionCommon\n): WindowsRegistrationDescription {\n  return {\n    ...description,\n    kind: \"Windows\",\n  };\n}\n\n/**\n * Represents a Windows Notification Services (WNS) template registration.\n */\nexport interface WindowsTemplateRegistrationDescriptionCommon\n  extends WindowsRegistrationDescriptionCommon,\n    TemplateRegistrationDescription {\n  /**\n   * The WNS headers.\n   */\n  wnsHeaders?: Record<string, string>;\n}\n\n/**\n * Represents a Windows Notification Services (WNS) template registration.\n */\nexport interface WindowsTemplateRegistrationDescription\n  extends WindowsTemplateRegistrationDescriptionCommon {\n  /**\n   * The kind of the registration.\n   */\n  kind: \"WindowsTemplate\";\n}\n\n/**\n * Creates a Windows template registration description.\n * @param description - A partial Windows template registration description.\n * @returns A created Windows template registration description.\n */\nexport function createWindowsTemplateRegistrationDescription(\n  description: WindowsTemplateRegistrationDescriptionCommon\n): WindowsTemplateRegistrationDescription {\n  return {\n    ...description,\n    kind: \"WindowsTemplate\",\n  };\n}\n\n/**\n * Describes the types of registration descriptions.\n */\nexport type RegistrationDescription =\n  | AdmRegistrationDescription\n  | AdmTemplateRegistrationDescription\n  | AppleRegistrationDescription\n  | AppleTemplateRegistrationDescription\n  | BaiduRegistrationDescription\n  | BaiduTemplateRegistrationDescription\n  | BrowserRegistrationDescription\n  | BrowserTemplateRegistrationDescription\n  | GcmRegistrationDescription\n  | GcmTemplateRegistrationDescription\n  | MpnsRegistrationDescription\n  | MpnsTemplateRegistrationDescription\n  | WindowsRegistrationDescription\n  | WindowsTemplateRegistrationDescription;\n\n/**\n * Describes an ADM Registration channel query.\n */\nexport interface AdmRegistrationChannel {\n  /**\n   * The ADM Registration ID.\n   */\n  admRegistrationId: string;\n  /**\n   * The kind of the registration channel.\n   */\n  kind: \"adm\";\n}\n\n/**\n * Describes an Apple Registration channel query.\n */\nexport interface AppleRegistrationChannel {\n  /**\n   * The APNs device token.\n   */\n  deviceToken: string;\n  /**\n   * The kind of the registration channel.\n   */\n  kind: \"apple\";\n}\n\n/**\n * Describes an Baidu Registration channel query.\n */\nexport interface BaiduRegistrationChannel {\n  /**\n   * The Baidu Channel ID.\n   */\n  baiduChannelId: string;\n  /**\n   * The Baidu User ID.\n   */\n  baiduUserId: string;\n  /**\n   * The kind of the registration channel.\n   */\n  kind: \"baidu\";\n}\n\n/**\n * Describes an Browser Registration channel query.\n */\nexport interface BrowserRegistrationChannel {\n  /**\n   * The Web Push endpoint URL.\n   */\n  endpoint: string;\n  /**\n   * The Web Push subscription P256DH.\n   */\n  p256dh: string;\n  /**\n   * The Web Push subscription auth secret.\n   */\n  auth: string;\n  /**\n   * The kind of the registration channel.\n   */\n  kind: \"browser\";\n}\n\n/**\n * Describes an Firebase Legacy Registration channel query.\n */\nexport interface FirebaseLegacyRegistrationChannel {\n  /**\n   * The FCM Legacy registration ID.\n   */\n  gcmRegistrationId: string;\n  /**\n   * The kind of the registration channel.\n   */\n  kind: \"gcm\";\n}\n\n/**\n * Describes an Windows Notification Services Registration channel query.\n */\nexport interface WindowsRegistrationChannel {\n  /**\n   * The WNS Channel URI.\n   */\n  channelUri: string;\n  /**\n   * The kind of the registration channel.\n   */\n  kind: \"windows\";\n}\n\n/**\n * Describes a Registration query.\n */\nexport type RegistrationChannel =\n  | AdmRegistrationChannel\n  | AppleRegistrationChannel\n  | BaiduRegistrationChannel\n  | BrowserRegistrationChannel\n  | FirebaseLegacyRegistrationChannel\n  | WindowsRegistrationChannel;\n"]}

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

@@ -0,0 +1,11 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+/**
+ * Creates a tag expression from a list of tags as a || expression.
+ * @param tags - The tags to create the || expression
+ * @returns The tag expression made from the array of strings into an || expression.
+ */
+export function createTagExpression(tags) {
+    return tags.join("||");
+}
+//# sourceMappingURL=tagExpressionBuilder.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"tagExpressionBuilder.js","sourceRoot":"","sources":["../../../src/models/tagExpressionBuilder.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CAAC,IAAc;IAChD,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACzB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\n/**\n * Creates a tag expression from a list of tags as a || expression.\n * @param tags - The tags to create the || expression\n * @returns The tag expression made from the array of strings into an || expression.\n */\nexport function createTagExpression(tags: string[]): string {\n  return tags.join(\"||\");\n}\n"]}

package/dist-esm/src/notificationHubsClient.js

@@ -1,32 +1,33 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
-import { createClientContext } from "./client/index.js";
-import { beginSubmitNotificationHubJob as beginSubmitNotificationHubJobMethod } from "./client/beginSubmitNotificationHubJob.js";
-import { cancelScheduledNotification as cancelScheduledNotificationMethod } from "./client/cancelScheduledNotification.js";
-import { createOrUpdateInstallation as createOrUpdateInstallationMethod } from "./client/createOrUpdateInstallation.js";
-import { createOrUpdateRegistration as createOrUpdateRegistrationMethod } from "./client/createOrUpdateRegistration.js";
-import { createRegistrationId as createRegistrationIdMethod } from "./client/createRegistrationId.js";
-import { createRegistration as createRegistrationMethod } from "./client/createRegistration.js";
-import { deleteInstallation as deleteInstallationMethod } from "./client/deleteInstallation.js";
-import { deleteRegistration } from "./client/deleteRegistration.js";
-import { getFeedbackContainerUrl as getFeedbackContainerUrlMethod } from "./client/getFeedbackContainerUrl.js";
-import { getInstallation as getInstallationMethod } from "./client/getInstallation.js";
-import { getNotificationHubJob as getNotificationHubJobMethod } from "./client/getNotificationHubJob.js";
-import { getNotificationOutcomeDetails as getNotificationOutcomeDetailsMethod } from "./client/getNotificationOutcomeDetails.js";
-import { getRegistration as getRegistrationMethod } from "./client/getRegistration.js";
-import { listNotificationHubJobs as listNotificationHubJobsMethod } from "./client/listNotificationHubJobs.js";
-import { listRegistrationsByTag as listRegistrationsByTagMethod } from "./client/listRegistrationsByTag.js";
-import { listRegistrations as listRegistrationsMethod } from "./client/listRegistrations.js";
-import { scheduleNotification as scheduleNotificationMethod } from "./client/scheduleNotification.js";
-import { sendNotification as sendNotificationMethod } from "./client/sendNotification.js";
-import { submitNotificationHubJob as submitNotificationHubJobMethod } from "./client/submitNotificationHubJob.js";
-import { updateInstallation as updateInstallationMethod } from "./client/updateInstallation.js";
-import { updateRegistration as updateRegistrationMethod } from "./client/updateRegistration.js";
+import { createClientContext } from "./api/index.js";
+import { beginSubmitNotificationHubJob as beginSubmitNotificationHubJobMethod } from "./api/beginSubmitNotificationHubJob.js";
+import { cancelScheduledNotification as cancelScheduledNotificationMethod } from "./api/cancelScheduledNotification.js";
+import { createOrUpdateInstallation as createOrUpdateInstallationMethod } from "./api/createOrUpdateInstallation.js";
+import { createOrUpdateRegistration as createOrUpdateRegistrationMethod } from "./api/createOrUpdateRegistration.js";
+import { createRegistrationId as createRegistrationIdMethod } from "./api/createRegistrationId.js";
+import { createRegistration as createRegistrationMethod } from "./api/createRegistration.js";
+import { deleteInstallation as deleteInstallationMethod } from "./api/deleteInstallation.js";
+import { deleteRegistration } from "./api/deleteRegistration.js";
+import { getFeedbackContainerUrl as getFeedbackContainerUrlMethod } from "./api/getFeedbackContainerUrl.js";
+import { getInstallation as getInstallationMethod } from "./api/getInstallation.js";
+import { getNotificationHubJob as getNotificationHubJobMethod } from "./api/getNotificationHubJob.js";
+import { getNotificationOutcomeDetails as getNotificationOutcomeDetailsMethod } from "./api/getNotificationOutcomeDetails.js";
+import { getRegistration as getRegistrationMethod } from "./api/getRegistration.js";
+import { listNotificationHubJobs as listNotificationHubJobsMethod } from "./api/listNotificationHubJobs.js";
+import { listRegistrationsByChannel as listRegistrationsByChannelMethod } from "./api/listRegistrationsByChannel.js";
+import { listRegistrationsByTag as listRegistrationsByTagMethod } from "./api/listRegistrationsByTag.js";
+import { listRegistrations as listRegistrationsMethod } from "./api/listRegistrations.js";
+import { scheduleNotification as scheduleNotificationMethod } from "./api/scheduleNotification.js";
+import { sendNotification as sendNotificationMethod } from "./api/sendNotification.js";
+import { submitNotificationHubJob as submitNotificationHubJobMethod } from "./api/submitNotificationHubJob.js";
+import { updateInstallation as updateInstallationMethod } from "./api/updateInstallation.js";
+import { updateRegistration as updateRegistrationMethod } from "./api/updateRegistration.js";
 /**
  * This represents a client for Azure Notification Hubs to manage installations and send
  * messages to devices.
  */
-export class NotificationHubsServiceClient {
+export class NotificationHubsClient {
     /**
      * Creates a new instance of the NotificationClient with a connection string, hub name and options.
      * @param connectionString - The Notification Hub Access Policy connection string.
@@ -130,12 +131,21 @@ export class NotificationHubsServiceClient {
     }
     /**
      * Gets all registrations for the notification hub with the given query options.
-     * @param options - The options for querying the registrations such as $top and $filter.
+     * @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.
      */
     listRegistrations(options = {}) {
         return listRegistrationsMethod(this._client, options);
     }
+    /**
+     * Gets all registrations for the notification hub with the given device information and options.
+     * @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.
+     */
+    listRegistrationsByChannel(channel, options = {}) {
+        return listRegistrationsByChannelMethod(this._client, channel, options);
+    }
     /**
      * Lists all registrations with the matching tag.
      * @param tag - The tag to query for matching registrations.