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

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

@@ -1,6 +1,6 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
-import { AbortController } from "@azure/abort-controller";
+import { delay } from "@azure/core-util";
 import { getNotificationHubJob } from "./getNotificationHubJob.js";
 import { submitNotificationHubJob } from "./submitNotificationHubJob.js";
 /**
@@ -47,33 +47,39 @@ export async function beginSubmitNotificationHubJob(context, notificationHubJob,
         pollUntilDone(pollOptions) {
             return (resultPromise !== null && resultPromise !== void 0 ? resultPromise : (resultPromise = (async () => {
                 const { abortSignal: inputAbortSignal } = pollOptions || {};
-                const { signal: abortSignal } = inputAbortSignal
-                    ? new AbortController([inputAbortSignal, abortController.signal])
-                    : abortController;
-                if (!poller.isDone()) {
-                    await poller.poll({ abortSignal });
-                    while (!poller.isDone()) {
-                        const delay = sleep(currentPollIntervalInMs, abortSignal);
-                        cancelJob = () => abortController.abort();
-                        await delay;
+                // In the future we can use AbortSignal.any() instead
+                function abortListener() {
+                    abortController.abort();
+                }
+                const abortSignal = abortController.signal;
+                if (inputAbortSignal === null || inputAbortSignal === void 0 ? void 0 : inputAbortSignal.aborted) {
+                    abortController.abort();
+                }
+                else if (!abortSignal.aborted) {
+                    inputAbortSignal === null || inputAbortSignal === void 0 ? void 0 : inputAbortSignal.addEventListener("abort", abortListener, { once: true });
+                }
+                try {
+                    if (!poller.isDone()) {
                         await poller.poll({ abortSignal });
+                        while (!poller.isDone()) {
+                            await delay(currentPollIntervalInMs, { abortSignal });
+                            await poller.poll({ abortSignal });
+                        }
                     }
                 }
+                finally {
+                    inputAbortSignal === null || inputAbortSignal === void 0 ? void 0 : inputAbortSignal.removeEventListener("abort", abortListener);
+                }
                 switch (state.status) {
-                    case "succeeded": {
+                    case "succeeded":
                         return poller.getResult();
-                    }
-                    case "canceled": {
+                    case "canceled":
                         throw new Error("Operation was canceled");
-                    }
-                    case "failed": {
+                    case "failed":
                         throw state.error;
-                    }
                     case "notStarted":
-                    case "running": {
-                        // Unreachable
-                        throw new Error(`polling completed without succeeding or failing`);
-                    }
+                    case "running":
+                        throw new Error(`Polling completed without succeeding or failing`);
                 }
             })().finally(() => {
                 resultPromise = undefined;
@@ -106,26 +112,4 @@ export async function beginSubmitNotificationHubJob(context, notificationHubJob,
     };
     return poller;
 }
-const REJECTED_ERR = new Error("The operation has been aborted");
-function sleep(ms, signal) {
-    return new Promise((resolve, reject) => {
-        if (signal.aborted) {
-            reject(REJECTED_ERR);
-            return;
-        }
-        const id = setTimeout(() => {
-            signal.removeEventListener("abort", onAbort);
-            if (signal.aborted) {
-                reject(REJECTED_ERR);
-                return;
-            }
-            resolve();
-        }, ms);
-        signal.addEventListener("abort", onAbort, { once: true });
-        function onAbort() {
-            clearTimeout(id);
-            reject(REJECTED_ERR);
-        }
-    });
-}
 //# sourceMappingURL=beginSubmitNotificationHubJob.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"beginSubmitNotificationHubJob.js","sourceRoot":"","sources":["../../../src/api/beginSubmitNotificationHubJob.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,eAAe,EAAmB,MAAM,yBAAyB,CAAC;AAK3E,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AAEzE;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,6BAA6B,CACjD,OAAsC,EACtC,kBAAsC,EACtC,yBAAiD,EAAE;;IAEnD,IAAI,YAAY,GAAG,MAAM,wBAAwB,CAC/C,OAAO,EACP,kBAAkB,EAClB,sBAAsB,CACvB,CAAC;IAIF,MAAM,KAAK,GAAuC;QAChD,MAAM,EAAE,YAAY;KACrB,CAAC;IAEF,MAAM,iBAAiB,GAAG,IAAI,GAAG,EAAmB,CAAC;IACrD,MAAM,wBAAwB,GAAG,KAAK,IAAmB,EAAE,CACzD,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7C,IAAI,aAAsD,CAAC;IAC3D,IAAI,SAAmC,CAAC;IACxC,MAAM,eAAe,GAAG,IAAI,eAAe,EAAE,CAAC;IAC9C,MAAM,uBAAuB,GAAG,MAAA,sBAAsB,CAAC,kBAAkB,mCAAI,IAAI,CAAC;IAElF,MAAM,MAAM,GAA6E;QACvF,KAAK,CAAC,IAAI,CAAC,OAA2C;YACpD,YAAY,GAAG,MAAM,qBAAqB,CAAC,OAAO,EAAE,YAAY,CAAC,KAAM,EAAE,OAAO,CAAC,CAAC;YAClF,IAAI,YAAY,CAAC,MAAM,KAAK,SAAS,IAAI,YAAY,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;gBAC3E,KAAK,CAAC,MAAM,GAAG,SAAS,CAAC;YAC3B,CAAC;YAED,IAAI,YAAY,CAAC,MAAM,KAAK,WAAW,EAAE,CAAC;gBACxC,KAAK,CAAC,MAAM,GAAG,WAAW,CAAC;gBAC3B,KAAK,CAAC,MAAM,GAAG,YAAY,CAAC;YAC9B,CAAC;YAED,IAAI,YAAY,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;gBACrC,KAAK,CAAC,MAAM,GAAG,QAAQ,CAAC;gBACxB,KAAK,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;YAChD,CAAC;YAED,MAAM,wBAAwB,EAAE,CAAC;YAEjC,IAAI,KAAK,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;gBAChC,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;YAC5C,CAAC;YACD,IAAI,KAAK,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;gBAC9B,MAAM,KAAK,CAAC,KAAK,CAAC;YACpB,CAAC;QACH,CAAC;QAED,aAAa,CAAC,WAA+C;YAC3D,OAAO,CAAC,aAAa,aAAb,aAAa,cAAb,aAAa,IAAb,aAAa,GAAK,CAAC,KAAK,IAAI,EAAE;gBACpC,MAAM,EAAE,WAAW,EAAE,gBAAgB,EAAE,GAAG,WAAW,IAAI,EAAE,CAAC;gBAC5D,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,gBAAgB;oBAC9C,CAAC,CAAC,IAAI,eAAe,CAAC,CAAC,gBAAgB,EAAE,eAAe,CAAC,MAAM,CAAC,CAAC;oBACjE,CAAC,CAAC,eAAe,CAAC;gBACpB,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC;oBACrB,MAAM,MAAM,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC;oBACnC,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC;wBACxB,MAAM,KAAK,GAAG,KAAK,CAAC,uBAAuB,EAAE,WAAW,CAAC,CAAC;wBAC1D,SAAS,GAAG,GAAG,EAAE,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;wBAC1C,MAAM,KAAK,CAAC;wBACZ,MAAM,MAAM,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC;oBACrC,CAAC;gBACH,CAAC;gBACD,QAAQ,KAAK,CAAC,MAAM,EAAE,CAAC;oBACrB,KAAK,WAAW,CAAC,CAAC,CAAC;wBACjB,OAAO,MAAM,CAAC,SAAS,EAAwB,CAAC;oBAClD,CAAC;oBACD,KAAK,UAAU,CAAC,CAAC,CAAC;wBAChB,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;oBAC5C,CAAC;oBACD,KAAK,QAAQ,CAAC,CAAC,CAAC;wBACd,MAAM,KAAK,CAAC,KAAK,CAAC;oBACpB,CAAC;oBACD,KAAK,YAAY,CAAC;oBAClB,KAAK,SAAS,CAAC,CAAC,CAAC;wBACf,cAAc;wBACd,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;oBACrE,CAAC;gBACH,CAAC;YACH,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE;gBAChB,aAAa,GAAG,SAAS,CAAC;YAC5B,CAAC,CAAC,EAAC,CAAC;QACN,CAAC;QAED,UAAU,CAAC,QAA6D;YACtE,MAAM,CAAC,GAAG,MAAM,EAAE,CAAC;YACnB,iBAAiB,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;YAEnC,OAAO,GAAG,EAAE,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAC3C,CAAC;QAED,MAAM;YACJ,OAAO,CAAC,WAAW,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACpE,CAAC;QAED,WAAW;YACT,eAAe,CAAC,KAAK,EAAE,CAAC;YACxB,SAAS,aAAT,SAAS,uBAAT,SAAS,EAAI,CAAC;QAChB,CAAC;QAED,SAAS;YACP,OAAO,aAAa,KAAK,SAAS,CAAC;QACrC,CAAC;QAED,iBAAiB;YACf,OAAO,KAAK,CAAC;QACf,CAAC;QAED,SAAS;YACP,OAAO,KAAK,CAAC,MAAM,CAAC;QACtB,CAAC;QAED,QAAQ;YACN,OAAO,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;QACnC,CAAC;KACF,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,YAAY,GAAG,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;AAEjE,SAAS,KAAK,CAAC,EAAU,EAAE,MAAuB;IAChD,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC3C,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACnB,MAAM,CAAC,YAAY,CAAC,CAAC;YACrB,OAAO;QACT,CAAC;QAED,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE;YACzB,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAE7C,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;gBACnB,MAAM,CAAC,YAAY,CAAC,CAAC;gBACrB,OAAO;YACT,CAAC;YAED,OAAO,EAAE,CAAC;QACZ,CAAC,EAAE,EAAE,CAAC,CAAC;QAEP,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QAE1D,SAAS,OAAO;YACd,YAAY,CAAC,EAAE,CAAC,CAAC;YACjB,MAAM,CAAC,YAAY,CAAC,CAAC;QACvB,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { AbortController, AbortSignalLike } from \"@azure/abort-controller\";\nimport { CancelOnProgress, OperationState, SimplePollerLike } from \"@azure/core-lro\";\nimport { NotificationHubJob, NotificationHubJobPoller } from \"../models/notificationHubJob.js\";\nimport { NotificationHubsClientContext } from \"./index.js\";\nimport { PolledOperationOptions } from \"../models/options.js\";\nimport { getNotificationHubJob } from \"./getNotificationHubJob.js\";\nimport { submitNotificationHubJob } from \"./submitNotificationHubJob.js\";\n\n/**\n * Submits a Notification Hub job and creates a poller to poll for results.\n * @param context - The Notification Hubs client.\n * @param notificationHubJob - The Notification Hub import/export job to start.\n * @param options - The operation options.\n * @returns A poller which can be called to poll until completion of the job.\n */\nexport async function beginSubmitNotificationHubJob(\n  context: NotificationHubsClientContext,\n  notificationHubJob: NotificationHubJob,\n  polledOperationOptions: PolledOperationOptions = {},\n): Promise<NotificationHubJobPoller> {\n  let submittedJob = await submitNotificationHubJob(\n    context,\n    notificationHubJob,\n    polledOperationOptions,\n  );\n\n  type Handler = (state: OperationState<NotificationHubJob>) => void;\n\n  const state: OperationState<NotificationHubJob> = {\n    status: \"notStarted\",\n  };\n\n  const progressCallbacks = new Map<symbol, Handler>();\n  const processProgressCallbacks = async (): Promise<void> =>\n    progressCallbacks.forEach((h) => h(state));\n  let resultPromise: Promise<NotificationHubJob> | undefined;\n  let cancelJob: (() => void) | undefined;\n  const abortController = new AbortController();\n  const currentPollIntervalInMs = polledOperationOptions.updateIntervalInMs ?? 2000;\n\n  const poller: SimplePollerLike<OperationState<NotificationHubJob>, NotificationHubJob> = {\n    async poll(options?: { abortSignal?: AbortSignalLike }): Promise<void> {\n      submittedJob = await getNotificationHubJob(context, submittedJob.jobId!, options);\n      if (submittedJob.status === \"Running\" || submittedJob.status === \"Started\") {\n        state.status = \"running\";\n      }\n\n      if (submittedJob.status === \"Completed\") {\n        state.status = \"succeeded\";\n        state.result = submittedJob;\n      }\n\n      if (submittedJob.status === \"Failed\") {\n        state.status = \"failed\";\n        state.error = new Error(submittedJob.failure);\n      }\n\n      await processProgressCallbacks();\n\n      if (state.status === \"canceled\") {\n        throw new Error(\"Operation was canceled\");\n      }\n      if (state.status === \"failed\") {\n        throw state.error;\n      }\n    },\n\n    pollUntilDone(pollOptions?: { abortSignal?: AbortSignalLike }): Promise<NotificationHubJob> {\n      return (resultPromise ??= (async () => {\n        const { abortSignal: inputAbortSignal } = pollOptions || {};\n        const { signal: abortSignal } = inputAbortSignal\n          ? new AbortController([inputAbortSignal, abortController.signal])\n          : abortController;\n        if (!poller.isDone()) {\n          await poller.poll({ abortSignal });\n          while (!poller.isDone()) {\n            const delay = sleep(currentPollIntervalInMs, abortSignal);\n            cancelJob = () => abortController.abort();\n            await delay;\n            await poller.poll({ abortSignal });\n          }\n        }\n        switch (state.status) {\n          case \"succeeded\": {\n            return poller.getResult() as NotificationHubJob;\n          }\n          case \"canceled\": {\n            throw new Error(\"Operation was canceled\");\n          }\n          case \"failed\": {\n            throw state.error;\n          }\n          case \"notStarted\":\n          case \"running\": {\n            // Unreachable\n            throw new Error(`polling completed without succeeding or failing`);\n          }\n        }\n      })().finally(() => {\n        resultPromise = undefined;\n      }));\n    },\n\n    onProgress(callback: (state: OperationState<NotificationHubJob>) => void): CancelOnProgress {\n      const s = Symbol();\n      progressCallbacks.set(s, callback);\n\n      return () => progressCallbacks.delete(s);\n    },\n\n    isDone(): boolean {\n      return [\"succeeded\", \"failed\", \"canceled\"].includes(state.status);\n    },\n\n    stopPolling(): void {\n      abortController.abort();\n      cancelJob?.();\n    },\n\n    isStopped(): boolean {\n      return resultPromise === undefined;\n    },\n\n    getOperationState(): OperationState<NotificationHubJob> {\n      return state;\n    },\n\n    getResult(): NotificationHubJob | undefined {\n      return state.result;\n    },\n\n    toString() {\n      return JSON.stringify({ state });\n    },\n  };\n\n  return poller;\n}\n\nconst REJECTED_ERR = new Error(\"The operation has been aborted\");\n\nfunction sleep(ms: number, signal: AbortSignalLike): Promise<void> {\n  return new Promise<void>((resolve, reject) => {\n    if (signal.aborted) {\n      reject(REJECTED_ERR);\n      return;\n    }\n\n    const id = setTimeout(() => {\n      signal.removeEventListener(\"abort\", onAbort);\n\n      if (signal.aborted) {\n        reject(REJECTED_ERR);\n        return;\n      }\n\n      resolve();\n    }, ms);\n\n    signal.addEventListener(\"abort\", onAbort, { once: true });\n\n    function onAbort(): void {\n      clearTimeout(id);\n      reject(REJECTED_ERR);\n    }\n  });\n}\n"]}
+{"version":3,"file":"beginSubmitNotificationHubJob.js","sourceRoot":"","sources":["../../../src/api/beginSubmitNotificationHubJob.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAOlC,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AAEzE;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,6BAA6B,CACjD,OAAsC,EACtC,kBAAsC,EACtC,yBAAiD,EAAE;;IAEnD,IAAI,YAAY,GAAG,MAAM,wBAAwB,CAC/C,OAAO,EACP,kBAAkB,EAClB,sBAAsB,CACvB,CAAC;IAIF,MAAM,KAAK,GAAuC;QAChD,MAAM,EAAE,YAAY;KACrB,CAAC;IAEF,MAAM,iBAAiB,GAAG,IAAI,GAAG,EAAmB,CAAC;IACrD,MAAM,wBAAwB,GAAG,KAAK,IAAmB,EAAE,CACzD,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7C,IAAI,aAAsD,CAAC;IAC3D,IAAI,SAAmC,CAAC;IACxC,MAAM,eAAe,GAAG,IAAI,eAAe,EAAE,CAAC;IAC9C,MAAM,uBAAuB,GAAG,MAAA,sBAAsB,CAAC,kBAAkB,mCAAI,IAAI,CAAC;IAElF,MAAM,MAAM,GAA6E;QACvF,KAAK,CAAC,IAAI,CAAC,OAA2C;YACpD,YAAY,GAAG,MAAM,qBAAqB,CAAC,OAAO,EAAE,YAAY,CAAC,KAAM,EAAE,OAAO,CAAC,CAAC;YAClF,IAAI,YAAY,CAAC,MAAM,KAAK,SAAS,IAAI,YAAY,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;gBAC3E,KAAK,CAAC,MAAM,GAAG,SAAS,CAAC;YAC3B,CAAC;YAED,IAAI,YAAY,CAAC,MAAM,KAAK,WAAW,EAAE,CAAC;gBACxC,KAAK,CAAC,MAAM,GAAG,WAAW,CAAC;gBAC3B,KAAK,CAAC,MAAM,GAAG,YAAY,CAAC;YAC9B,CAAC;YAED,IAAI,YAAY,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;gBACrC,KAAK,CAAC,MAAM,GAAG,QAAQ,CAAC;gBACxB,KAAK,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;YAChD,CAAC;YAED,MAAM,wBAAwB,EAAE,CAAC;YAEjC,IAAI,KAAK,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;gBAChC,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;YAC5C,CAAC;YACD,IAAI,KAAK,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;gBAC9B,MAAM,KAAK,CAAC,KAAK,CAAC;YACpB,CAAC;QACH,CAAC;QAED,aAAa,CAAC,WAA+C;YAC3D,OAAO,CAAC,aAAa,aAAb,aAAa,cAAb,aAAa,IAAb,aAAa,GAAK,CAAC,KAAK,IAAI,EAAE;gBACpC,MAAM,EAAE,WAAW,EAAE,gBAAgB,EAAE,GAAG,WAAW,IAAI,EAAE,CAAC;gBAC5D,qDAAqD;gBACrD,SAAS,aAAa;oBACpB,eAAe,CAAC,KAAK,EAAE,CAAC;gBAC1B,CAAC;gBACD,MAAM,WAAW,GAAG,eAAe,CAAC,MAAM,CAAC;gBAC3C,IAAI,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,OAAO,EAAE,CAAC;oBAC9B,eAAe,CAAC,KAAK,EAAE,CAAC;gBAC1B,CAAC;qBAAM,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;oBAChC,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,gBAAgB,CAAC,OAAO,EAAE,aAAa,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;gBAC7E,CAAC;gBAED,IAAI,CAAC;oBACH,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC;wBACrB,MAAM,MAAM,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC;wBACnC,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC;4BACxB,MAAM,KAAK,CAAC,uBAAuB,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;4BACtD,MAAM,MAAM,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC;wBACrC,CAAC;oBACH,CAAC;gBACH,CAAC;wBAAS,CAAC;oBACT,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,mBAAmB,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;gBAChE,CAAC;gBACD,QAAQ,KAAK,CAAC,MAAM,EAAE,CAAC;oBACrB,KAAK,WAAW;wBACd,OAAO,MAAM,CAAC,SAAS,EAAwB,CAAC;oBAClD,KAAK,UAAU;wBACb,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;oBAC5C,KAAK,QAAQ;wBACX,MAAM,KAAK,CAAC,KAAK,CAAC;oBACpB,KAAK,YAAY,CAAC;oBAClB,KAAK,SAAS;wBACZ,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;gBACvE,CAAC;YACH,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE;gBAChB,aAAa,GAAG,SAAS,CAAC;YAC5B,CAAC,CAAC,EAAC,CAAC;QACN,CAAC;QAED,UAAU,CAAC,QAA6D;YACtE,MAAM,CAAC,GAAG,MAAM,EAAE,CAAC;YACnB,iBAAiB,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;YAEnC,OAAO,GAAG,EAAE,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAC3C,CAAC;QAED,MAAM;YACJ,OAAO,CAAC,WAAW,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACpE,CAAC;QAED,WAAW;YACT,eAAe,CAAC,KAAK,EAAE,CAAC;YACxB,SAAS,aAAT,SAAS,uBAAT,SAAS,EAAI,CAAC;QAChB,CAAC;QAED,SAAS;YACP,OAAO,aAAa,KAAK,SAAS,CAAC;QACrC,CAAC;QAED,iBAAiB;YACf,OAAO,KAAK,CAAC;QACf,CAAC;QAED,SAAS;YACP,OAAO,KAAK,CAAC,MAAM,CAAC;QACtB,CAAC;QAED,QAAQ;YACN,OAAO,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;QACnC,CAAC;KACF,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { AbortSignalLike } from \"@azure/abort-controller\";\nimport { CancelOnProgress, OperationState, SimplePollerLike } from \"@azure/core-lro\";\nimport { NotificationHubJob, NotificationHubJobPoller } from \"../models/notificationHubJob.js\";\nimport { NotificationHubsClientContext } from \"./index.js\";\nimport { PolledOperationOptions } from \"../models/options.js\";\nimport { delay } from \"@azure/core-util\";\nimport { getNotificationHubJob } from \"./getNotificationHubJob.js\";\nimport { submitNotificationHubJob } from \"./submitNotificationHubJob.js\";\n\n/**\n * Submits a Notification Hub job and creates a poller to poll for results.\n * @param context - The Notification Hubs client.\n * @param notificationHubJob - The Notification Hub import/export job to start.\n * @param options - The operation options.\n * @returns A poller which can be called to poll until completion of the job.\n */\nexport async function beginSubmitNotificationHubJob(\n  context: NotificationHubsClientContext,\n  notificationHubJob: NotificationHubJob,\n  polledOperationOptions: PolledOperationOptions = {},\n): Promise<NotificationHubJobPoller> {\n  let submittedJob = await submitNotificationHubJob(\n    context,\n    notificationHubJob,\n    polledOperationOptions,\n  );\n\n  type Handler = (state: OperationState<NotificationHubJob>) => void;\n\n  const state: OperationState<NotificationHubJob> = {\n    status: \"notStarted\",\n  };\n\n  const progressCallbacks = new Map<symbol, Handler>();\n  const processProgressCallbacks = async (): Promise<void> =>\n    progressCallbacks.forEach((h) => h(state));\n  let resultPromise: Promise<NotificationHubJob> | undefined;\n  let cancelJob: (() => void) | undefined;\n  const abortController = new AbortController();\n  const currentPollIntervalInMs = polledOperationOptions.updateIntervalInMs ?? 2000;\n\n  const poller: SimplePollerLike<OperationState<NotificationHubJob>, NotificationHubJob> = {\n    async poll(options?: { abortSignal?: AbortSignalLike }): Promise<void> {\n      submittedJob = await getNotificationHubJob(context, submittedJob.jobId!, options);\n      if (submittedJob.status === \"Running\" || submittedJob.status === \"Started\") {\n        state.status = \"running\";\n      }\n\n      if (submittedJob.status === \"Completed\") {\n        state.status = \"succeeded\";\n        state.result = submittedJob;\n      }\n\n      if (submittedJob.status === \"Failed\") {\n        state.status = \"failed\";\n        state.error = new Error(submittedJob.failure);\n      }\n\n      await processProgressCallbacks();\n\n      if (state.status === \"canceled\") {\n        throw new Error(\"Operation was canceled\");\n      }\n      if (state.status === \"failed\") {\n        throw state.error;\n      }\n    },\n\n    pollUntilDone(pollOptions?: { abortSignal?: AbortSignalLike }): Promise<NotificationHubJob> {\n      return (resultPromise ??= (async () => {\n        const { abortSignal: inputAbortSignal } = pollOptions || {};\n        // In the future we can use AbortSignal.any() instead\n        function abortListener(): void {\n          abortController.abort();\n        }\n        const abortSignal = abortController.signal;\n        if (inputAbortSignal?.aborted) {\n          abortController.abort();\n        } else if (!abortSignal.aborted) {\n          inputAbortSignal?.addEventListener(\"abort\", abortListener, { once: true });\n        }\n\n        try {\n          if (!poller.isDone()) {\n            await poller.poll({ abortSignal });\n            while (!poller.isDone()) {\n              await delay(currentPollIntervalInMs, { abortSignal });\n              await poller.poll({ abortSignal });\n            }\n          }\n        } finally {\n          inputAbortSignal?.removeEventListener(\"abort\", abortListener);\n        }\n        switch (state.status) {\n          case \"succeeded\":\n            return poller.getResult() as NotificationHubJob;\n          case \"canceled\":\n            throw new Error(\"Operation was canceled\");\n          case \"failed\":\n            throw state.error;\n          case \"notStarted\":\n          case \"running\":\n            throw new Error(`Polling completed without succeeding or failing`);\n        }\n      })().finally(() => {\n        resultPromise = undefined;\n      }));\n    },\n\n    onProgress(callback: (state: OperationState<NotificationHubJob>) => void): CancelOnProgress {\n      const s = Symbol();\n      progressCallbacks.set(s, callback);\n\n      return () => progressCallbacks.delete(s);\n    },\n\n    isDone(): boolean {\n      return [\"succeeded\", \"failed\", \"canceled\"].includes(state.status);\n    },\n\n    stopPolling(): void {\n      abortController.abort();\n      cancelJob?.();\n    },\n\n    isStopped(): boolean {\n      return resultPromise === undefined;\n    },\n\n    getOperationState(): OperationState<NotificationHubJob> {\n      return state;\n    },\n\n    getResult(): NotificationHubJob | undefined {\n      return state.result;\n    },\n\n    toString() {\n      return JSON.stringify({ state });\n    },\n  };\n\n  return poller;\n}\n"]}

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

@@ -32,6 +32,14 @@ export function createBaiduInstallation(installation) {
 export function createFcmLegacyInstallation(installation) {
     return Object.assign(Object.assign({}, installation), { platform: "gcm" });
 }
+/**
+ * Creates an Firebase V1 Cloud Messaging based installation.
+ * @param installation - A partial installation used to create the Firebase V1 Cloud Messaging installation.
+ * @returns The newly created Firebase V1 Cloud Messaging installation.
+ */
+export function createFcmV1Installation(installation) {
+    return Object.assign(Object.assign({}, installation), { platform: "fcmv1" });
+}
 /**
  * Creates a Xiaomi based installation.
  * @param installation - A partial installation used to create the Xiaomi installation.

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;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,wBAAwB,CACtC,YAAqC;IAErC,uCACK,YAAY,KACf,QAAQ,EAAE,QAAQ,IAClB;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 Xiaomi based installation.\n */\nexport interface XiaomiInstallation extends DeviceTokenInstallation {\n  /**\n   * The platform for the installation.\n   */\n  platform: \"xiaomi\";\n}\n\n/**\n * Creates a Xiaomi based installation.\n * @param installation - A partial installation used to create the Xiaomi installation.\n * @returns The newly created Xiaomi installation.\n */\nexport function createXiaomiInstallation(\n  installation: DeviceTokenInstallation,\n): XiaomiInstallation {\n  return {\n    ...installation,\n    platform: \"xiaomi\",\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  | XiaomiInstallation\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,uBAAuB,CAAC,YAAqC;IAC3E,uCACK,YAAY,KACf,QAAQ,EAAE,OAAO,IACjB;AACJ,CAAC;AAYD;;;;GAIG;AACH,MAAM,UAAU,wBAAwB,CACtC,YAAqC;IAErC,uCACK,YAAY,KACf,QAAQ,EAAE,QAAQ,IAClB;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 an Firebase V1 Cloud Messaging based installation.\n */\nexport interface FcmV1Installation extends DeviceTokenInstallation {\n  /**\n   * The platform for the installation.\n   */\n  platform: \"fcmv1\";\n}\n\n/**\n * Creates an Firebase V1 Cloud Messaging based installation.\n * @param installation - A partial installation used to create the Firebase V1 Cloud Messaging installation.\n * @returns The newly created Firebase V1 Cloud Messaging installation.\n */\nexport function createFcmV1Installation(installation: DeviceTokenInstallation): FcmV1Installation {\n  return {\n    ...installation,\n    platform: \"fcmv1\",\n  };\n}\n\n/**\n * Represents a Xiaomi based installation.\n */\nexport interface XiaomiInstallation extends DeviceTokenInstallation {\n  /**\n   * The platform for the installation.\n   */\n  platform: \"xiaomi\";\n}\n\n/**\n * Creates a Xiaomi based installation.\n * @param installation - A partial installation used to create the Xiaomi installation.\n * @returns The newly created Xiaomi installation.\n */\nexport function createXiaomiInstallation(\n  installation: DeviceTokenInstallation,\n): XiaomiInstallation {\n  return {\n    ...installation,\n    platform: \"xiaomi\",\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  | FcmV1Installation\n  | XiaomiInstallation\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

@@ -47,6 +47,15 @@ export function createFcmLegacyNotification(notification) {
     const body = isString(notification.body) ? notification.body : JSON.stringify(notification.body);
     return Object.assign(Object.assign({}, notification), { body, platform: "gcm", contentType: Constants.JSON_CONTENT_TYPE });
 }
+/**
+ * Creates a notification to send to Firebase.
+ * @param notification - A partial message used to create a message for Firebase.
+ * @returns A newly created Firebase notification.
+ */
+export function createFcmV1Notification(notification) {
+    const body = isString(notification.body) ? notification.body : JSON.stringify(notification.body);
+    return Object.assign(Object.assign({}, notification), { body, platform: "fcmv1", contentType: Constants.JSON_CONTENT_TYPE });
+}
 /**
  * Creates a notification to send to Xiaomi.
  * @param notification - A partial message used to create a message for Xiaomi.

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;AAQnD,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,YAAY,MAAM,CAAC;AAC9D,CAAC;AAoDD;;;;GAIG;AACH,MAAM,UAAU,uBAAuB,CAAC,YAAqC;IAC3E,MAAM,IAAI,GAAG,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAEjG,uCACK,YAAY,KACf,IAAI,EACJ,QAAQ,EAAE,OAAO,EACjB,WAAW,EAAE,SAAS,CAAC,iBAAiB,IACxC;AACJ,CAAC;AA2BD;;;;GAIG;AACH,MAAM,UAAU,qBAAqB,CAAC,YAAmC;IACvE,MAAM,IAAI,GAAG,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAEjG,uCACK,YAAY,KACf,IAAI,EACJ,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;AA2BD;;;;GAIG;AACH,MAAM,UAAU,2BAA2B,CACzC,YAAyC;IAEzC,MAAM,IAAI,GAAG,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAEjG,uCACK,YAAY,KACf,IAAI,EACJ,QAAQ,EAAE,KAAK,EACf,WAAW,EAAE,SAAS,CAAC,iBAAiB,IACxC;AACJ,CAAC;AAYD;;;;GAIG;AACH,MAAM,UAAU,wBAAwB,CAAC,YAAgC;IACvE,uCACK,YAAY,KACf,QAAQ,EAAE,QAAQ,EAClB,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;AAqCD;;;;GAIG;AACH,MAAM,UAAU,yBAAyB,CACvC,YAAmC;IAEnC,IAAI,CAAA,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,OAAO,KAAI,YAAY,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;QAChE,MAAM,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QACnD,QAAQ,OAAO,EAAE,CAAC;YAChB,KAAK,SAAS,CAAC,SAAS;gBACtB,OAAO,8BAA8B,CAAC,YAAY,CAAC,CAAC;YACtD,KAAK,SAAS,CAAC,SAAS;gBACtB,OAAO,6BAA6B,CAAC,YAAY,CAAC,CAAC;YACrD,KAAK,SAAS,CAAC,SAAS;gBACtB,OAAO,8BAA8B,CAAC,YAAY,CAAC,CAAC;YACtD,KAAK,SAAS,CAAC,OAAO;gBACpB,OAAO,4BAA4B,CAAC,YAAY,CAAC,CAAC;YACpD;gBACE,MAAM,IAAI,KAAK,CAAC,qBAAqB,OAAO,EAAE,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;IACjD,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,8BAA8B,CAC5C,YAAmC;IAEnC,MAAM,MAAM,mCACP,YAAY,KACf,QAAQ,EAAE,SAAS,EACnB,WAAW,EAAE,SAAS,CAAC,gBAAgB,GACxC,CAAC;IAEF,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,CAAC,OAAO,GAAG,EAAE,CAAC;IACtB,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,CAAC;QAC7C,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,GAAG,SAAS,CAAC,SAAS,CAAC;IAChE,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,6BAA6B,CAC3C,YAAmC;IAEnC,MAAM,MAAM,mCACP,YAAY,KACf,QAAQ,EAAE,SAAS,EACnB,WAAW,EAAE,SAAS,CAAC,gBAAgB,GACxC,CAAC;IAEF,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,CAAC,OAAO,GAAG,EAAE,CAAC;IACtB,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,CAAC;QAC7C,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,GAAG,SAAS,CAAC,SAAS,CAAC;IAChE,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,8BAA8B,CAC5C,YAAmC;IAEnC,MAAM,MAAM,mCACP,YAAY,KACf,QAAQ,EAAE,SAAS,EACnB,WAAW,EAAE,SAAS,CAAC,gBAAgB,GACxC,CAAC;IAEF,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,CAAC,OAAO,GAAG,EAAE,CAAC;IACtB,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,CAAC;QAC7C,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,GAAG,SAAS,CAAC,SAAS,CAAC;IAChE,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,4BAA4B,CAC1C,YAAmC;IAEnC,MAAM,MAAM,mCACP,YAAY,KACf,QAAQ,EAAE,SAAS,EACnB,WAAW,EAAE,SAAS,CAAC,mBAAmB,GAC3C,CAAC;IAEF,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,CAAC,OAAO,GAAG,EAAE,CAAC;IACtB,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,CAAC;QAC7C,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;IAC9D,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport * as Constants from \"../utils/constants.js\";\nimport {\n  AdmNativeMessage,\n  AppleNativeMessage,\n  FirebaseLegacyNativeMessage,\n} from \"./notificationBodyBuilder.js\";\nimport { AppleHeaders, WindowsHeaders } from \"./notificationHeaderBuilder.js\";\n\nfunction isString(value: unknown): value is string {\n  return typeof value === \"string\" || value instanceof String;\n}\n\n/**\n * Represents a notification that can be sent to a device.\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 | undefined>;\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 * Represents an Apple notification that can be sent to a device.\n */\nexport interface AppleNotificationParams {\n  /**\n   * The body for the push notification.\n   */\n  body: string | AppleNativeMessage;\n\n  /**\n   * The headers to include for the push notification.\n   */\n  headers?: AppleHeaders;\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: AppleNotificationParams): AppleNotification {\n  const body = isString(notification.body) ? notification.body : JSON.stringify(notification.body);\n\n  return {\n    ...notification,\n    body,\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 * Represents an ADM notification that can be sent to a device.\n */\nexport interface AdmNotificationParams {\n  /**\n   * The body for the push notification.\n   */\n  body: string | AdmNativeMessage;\n\n  /**\n   * The headers to include for the push notification.\n   */\n  headers?: Record<string, string | undefined>;\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: AdmNotificationParams): AdmNotification {\n  const body = isString(notification.body) ? notification.body : JSON.stringify(notification.body);\n\n  return {\n    ...notification,\n    body,\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 * Represents an Firebase Legacy notification that can be sent to a device.\n */\nexport interface FcmLegacyNotificationParams {\n  /**\n   * The body for the push notification.\n   */\n  body: string | FirebaseLegacyNativeMessage;\n\n  /**\n   * The headers to include for the push notification.\n   */\n  headers?: Record<string, string | undefined>;\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 notification.\n */\nexport function createFcmLegacyNotification(\n  notification: FcmLegacyNotificationParams,\n): FcmLegacyNotification {\n  const body = isString(notification.body) ? notification.body : JSON.stringify(notification.body);\n\n  return {\n    ...notification,\n    body,\n    platform: \"gcm\",\n    contentType: Constants.JSON_CONTENT_TYPE,\n  };\n}\n\n/**\n * Represents a Xiaomi push notification.\n */\nexport interface XiaomiNotification extends JsonNotification {\n  /**\n   * The platform for the push notification.\n   */\n  platform: \"xiaomi\";\n}\n\n/**\n * Creates a notification to send to Xiaomi.\n * @param notification - A partial message used to create a message for Xiaomi.\n * @returns A newly created Xiaomi notification.\n */\nexport function createXiaomiNotification(notification: NotificationCommon): XiaomiNotification {\n  return {\n    ...notification,\n    platform: \"xiaomi\",\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: \"windows\";\n\n  /**\n   * The content type for the push notification.\n   */\n  contentType: WindowsContentType;\n}\n\n/**\n * Represents a WNS notification that can be sent to a device.\n */\nexport interface WnsNotificationParams {\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?: WindowsHeaders;\n}\n\n/**\n * Creates a notification to send to WNS.\n * @param notification - The WNS notification to send.\n * @returns A newly created WNS message.\n */\nexport function createWindowsNotification(\n  notification: WnsNotificationParams,\n): WindowsNotification {\n  if (notification?.headers && notification.headers[\"X-WNS-Type\"]) {\n    const wnsType = notification.headers[\"X-WNS-Type\"];\n    switch (wnsType) {\n      case Constants.WNS_TOAST:\n        return createWindowsToastNotification(notification);\n      case Constants.WNS_TITLE:\n        return createWindowsTileNotification(notification);\n      case Constants.WNS_BADGE:\n        return createWindowsBadgeNotification(notification);\n      case Constants.WNS_RAW:\n        return createWindowsRawNotification(notification);\n      default:\n        throw new Error(`Invalid WNS type: ${wnsType}`);\n    }\n  } else {\n    throw new Error(`Missing WNS type in headers`);\n  }\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: WnsNotificationParams,\n): WindowsNotification {\n  const result: WindowsNotification = {\n    ...notification,\n    platform: \"windows\",\n    contentType: Constants.XML_CONTENT_TYPE,\n  };\n\n  if (!result.headers) {\n    result.headers = {};\n  }\n\n  if (!result.headers[Constants.WNS_TYPE_NAME]) {\n    result.headers[Constants.WNS_TYPE_NAME] = Constants.WNS_BADGE;\n  }\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: WnsNotificationParams,\n): WindowsNotification {\n  const result: WindowsNotification = {\n    ...notification,\n    platform: \"windows\",\n    contentType: Constants.XML_CONTENT_TYPE,\n  };\n\n  if (!result.headers) {\n    result.headers = {};\n  }\n\n  if (!result.headers[Constants.WNS_TYPE_NAME]) {\n    result.headers[Constants.WNS_TYPE_NAME] = Constants.WNS_TITLE;\n  }\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: WnsNotificationParams,\n): WindowsNotification {\n  const result: WindowsNotification = {\n    ...notification,\n    platform: \"windows\",\n    contentType: Constants.XML_CONTENT_TYPE,\n  };\n\n  if (!result.headers) {\n    result.headers = {};\n  }\n\n  if (!result.headers[Constants.WNS_TYPE_NAME]) {\n    result.headers[Constants.WNS_TYPE_NAME] = Constants.WNS_TOAST;\n  }\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: WnsNotificationParams,\n): WindowsNotification {\n  const result: WindowsNotification = {\n    ...notification,\n    platform: \"windows\",\n    contentType: Constants.STREAM_CONTENT_TYPE,\n  };\n\n  if (!result.headers) {\n    result.headers = {};\n  }\n\n  if (!result.headers[Constants.WNS_TYPE_NAME]) {\n    result.headers[Constants.WNS_TYPE_NAME] = Constants.WNS_RAW;\n  }\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  | XiaomiNotification\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;AASnD,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,YAAY,MAAM,CAAC;AAC9D,CAAC;AAoDD;;;;GAIG;AACH,MAAM,UAAU,uBAAuB,CAAC,YAAqC;IAC3E,MAAM,IAAI,GAAG,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAEjG,uCACK,YAAY,KACf,IAAI,EACJ,QAAQ,EAAE,OAAO,EACjB,WAAW,EAAE,SAAS,CAAC,iBAAiB,IACxC;AACJ,CAAC;AA2BD;;;;GAIG;AACH,MAAM,UAAU,qBAAqB,CAAC,YAAmC;IACvE,MAAM,IAAI,GAAG,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAEjG,uCACK,YAAY,KACf,IAAI,EACJ,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;AA2BD;;;;GAIG;AACH,MAAM,UAAU,2BAA2B,CACzC,YAAyC;IAEzC,MAAM,IAAI,GAAG,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAEjG,uCACK,YAAY,KACf,IAAI,EACJ,QAAQ,EAAE,KAAK,EACf,WAAW,EAAE,SAAS,CAAC,iBAAiB,IACxC;AACJ,CAAC;AA2BD;;;;GAIG;AACH,MAAM,UAAU,uBAAuB,CAAC,YAAqC;IAC3E,MAAM,IAAI,GAAG,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAEjG,uCACK,YAAY,KACf,IAAI,EACJ,QAAQ,EAAE,OAAO,EACjB,WAAW,EAAE,SAAS,CAAC,iBAAiB,IACxC;AACJ,CAAC;AAYD;;;;GAIG;AACH,MAAM,UAAU,wBAAwB,CAAC,YAAgC;IACvE,uCACK,YAAY,KACf,QAAQ,EAAE,QAAQ,EAClB,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;AAqCD;;;;GAIG;AACH,MAAM,UAAU,yBAAyB,CACvC,YAAmC;IAEnC,IAAI,CAAA,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,OAAO,KAAI,YAAY,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;QAChE,MAAM,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QACnD,QAAQ,OAAO,EAAE,CAAC;YAChB,KAAK,SAAS,CAAC,SAAS;gBACtB,OAAO,8BAA8B,CAAC,YAAY,CAAC,CAAC;YACtD,KAAK,SAAS,CAAC,SAAS;gBACtB,OAAO,6BAA6B,CAAC,YAAY,CAAC,CAAC;YACrD,KAAK,SAAS,CAAC,SAAS;gBACtB,OAAO,8BAA8B,CAAC,YAAY,CAAC,CAAC;YACtD,KAAK,SAAS,CAAC,OAAO;gBACpB,OAAO,4BAA4B,CAAC,YAAY,CAAC,CAAC;YACpD;gBACE,MAAM,IAAI,KAAK,CAAC,qBAAqB,OAAO,EAAE,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;IACjD,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,8BAA8B,CAC5C,YAAmC;IAEnC,MAAM,MAAM,mCACP,YAAY,KACf,QAAQ,EAAE,SAAS,EACnB,WAAW,EAAE,SAAS,CAAC,gBAAgB,GACxC,CAAC;IAEF,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,CAAC,OAAO,GAAG,EAAE,CAAC;IACtB,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,CAAC;QAC7C,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,GAAG,SAAS,CAAC,SAAS,CAAC;IAChE,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,6BAA6B,CAC3C,YAAmC;IAEnC,MAAM,MAAM,mCACP,YAAY,KACf,QAAQ,EAAE,SAAS,EACnB,WAAW,EAAE,SAAS,CAAC,gBAAgB,GACxC,CAAC;IAEF,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,CAAC,OAAO,GAAG,EAAE,CAAC;IACtB,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,CAAC;QAC7C,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,GAAG,SAAS,CAAC,SAAS,CAAC;IAChE,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,8BAA8B,CAC5C,YAAmC;IAEnC,MAAM,MAAM,mCACP,YAAY,KACf,QAAQ,EAAE,SAAS,EACnB,WAAW,EAAE,SAAS,CAAC,gBAAgB,GACxC,CAAC;IAEF,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,CAAC,OAAO,GAAG,EAAE,CAAC;IACtB,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,CAAC;QAC7C,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,GAAG,SAAS,CAAC,SAAS,CAAC;IAChE,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,4BAA4B,CAC1C,YAAmC;IAEnC,MAAM,MAAM,mCACP,YAAY,KACf,QAAQ,EAAE,SAAS,EACnB,WAAW,EAAE,SAAS,CAAC,mBAAmB,GAC3C,CAAC;IAEF,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,CAAC,OAAO,GAAG,EAAE,CAAC;IACtB,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,CAAC;QAC7C,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;IAC9D,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport * as Constants from \"../utils/constants.js\";\nimport {\n  AdmNativeMessage,\n  AppleNativeMessage,\n  FirebaseLegacyNativeMessage,\n  FirebaseV1NativeMessage,\n} from \"./notificationBodyBuilder.js\";\nimport { AppleHeaders, WindowsHeaders } from \"./notificationHeaderBuilder.js\";\n\nfunction isString(value: unknown): value is string {\n  return typeof value === \"string\" || value instanceof String;\n}\n\n/**\n * Represents a notification that can be sent to a device.\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 | undefined>;\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 * Represents an Apple notification that can be sent to a device.\n */\nexport interface AppleNotificationParams {\n  /**\n   * The body for the push notification.\n   */\n  body: string | AppleNativeMessage;\n\n  /**\n   * The headers to include for the push notification.\n   */\n  headers?: AppleHeaders;\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: AppleNotificationParams): AppleNotification {\n  const body = isString(notification.body) ? notification.body : JSON.stringify(notification.body);\n\n  return {\n    ...notification,\n    body,\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 * Represents an ADM notification that can be sent to a device.\n */\nexport interface AdmNotificationParams {\n  /**\n   * The body for the push notification.\n   */\n  body: string | AdmNativeMessage;\n\n  /**\n   * The headers to include for the push notification.\n   */\n  headers?: Record<string, string | undefined>;\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: AdmNotificationParams): AdmNotification {\n  const body = isString(notification.body) ? notification.body : JSON.stringify(notification.body);\n\n  return {\n    ...notification,\n    body,\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 * Represents an Firebase Legacy notification that can be sent to a device.\n */\nexport interface FcmLegacyNotificationParams {\n  /**\n   * The body for the push notification.\n   */\n  body: string | FirebaseLegacyNativeMessage;\n\n  /**\n   * The headers to include for the push notification.\n   */\n  headers?: Record<string, string | undefined>;\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 notification.\n */\nexport function createFcmLegacyNotification(\n  notification: FcmLegacyNotificationParams,\n): FcmLegacyNotification {\n  const body = isString(notification.body) ? notification.body : JSON.stringify(notification.body);\n\n  return {\n    ...notification,\n    body,\n    platform: \"gcm\",\n    contentType: Constants.JSON_CONTENT_TYPE,\n  };\n}\n\n/**\n * Represents an Firebase V1 API notification that can be sent to a device.\n */\nexport interface FcmV1Notification extends JsonNotification {\n  /**\n   * The platform for the push notification.\n   */\n  platform: \"fcmv1\";\n}\n\n/**\n * Represents an Firebase Legacy notification that can be sent to a device.\n */\nexport interface FcmV1NotificationParams {\n  /**\n   * The body for the push notification.\n   */\n  body: string | FirebaseV1NativeMessage;\n\n  /**\n   * The headers to include for the push notification.\n   */\n  headers?: Record<string, string | undefined>;\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 notification.\n */\nexport function createFcmV1Notification(notification: FcmV1NotificationParams): FcmV1Notification {\n  const body = isString(notification.body) ? notification.body : JSON.stringify(notification.body);\n\n  return {\n    ...notification,\n    body,\n    platform: \"fcmv1\",\n    contentType: Constants.JSON_CONTENT_TYPE,\n  };\n}\n\n/**\n * Represents a Xiaomi push notification.\n */\nexport interface XiaomiNotification extends JsonNotification {\n  /**\n   * The platform for the push notification.\n   */\n  platform: \"xiaomi\";\n}\n\n/**\n * Creates a notification to send to Xiaomi.\n * @param notification - A partial message used to create a message for Xiaomi.\n * @returns A newly created Xiaomi notification.\n */\nexport function createXiaomiNotification(notification: NotificationCommon): XiaomiNotification {\n  return {\n    ...notification,\n    platform: \"xiaomi\",\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: \"windows\";\n\n  /**\n   * The content type for the push notification.\n   */\n  contentType: WindowsContentType;\n}\n\n/**\n * Represents a WNS notification that can be sent to a device.\n */\nexport interface WnsNotificationParams {\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?: WindowsHeaders;\n}\n\n/**\n * Creates a notification to send to WNS.\n * @param notification - The WNS notification to send.\n * @returns A newly created WNS message.\n */\nexport function createWindowsNotification(\n  notification: WnsNotificationParams,\n): WindowsNotification {\n  if (notification?.headers && notification.headers[\"X-WNS-Type\"]) {\n    const wnsType = notification.headers[\"X-WNS-Type\"];\n    switch (wnsType) {\n      case Constants.WNS_TOAST:\n        return createWindowsToastNotification(notification);\n      case Constants.WNS_TITLE:\n        return createWindowsTileNotification(notification);\n      case Constants.WNS_BADGE:\n        return createWindowsBadgeNotification(notification);\n      case Constants.WNS_RAW:\n        return createWindowsRawNotification(notification);\n      default:\n        throw new Error(`Invalid WNS type: ${wnsType}`);\n    }\n  } else {\n    throw new Error(`Missing WNS type in headers`);\n  }\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: WnsNotificationParams,\n): WindowsNotification {\n  const result: WindowsNotification = {\n    ...notification,\n    platform: \"windows\",\n    contentType: Constants.XML_CONTENT_TYPE,\n  };\n\n  if (!result.headers) {\n    result.headers = {};\n  }\n\n  if (!result.headers[Constants.WNS_TYPE_NAME]) {\n    result.headers[Constants.WNS_TYPE_NAME] = Constants.WNS_BADGE;\n  }\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: WnsNotificationParams,\n): WindowsNotification {\n  const result: WindowsNotification = {\n    ...notification,\n    platform: \"windows\",\n    contentType: Constants.XML_CONTENT_TYPE,\n  };\n\n  if (!result.headers) {\n    result.headers = {};\n  }\n\n  if (!result.headers[Constants.WNS_TYPE_NAME]) {\n    result.headers[Constants.WNS_TYPE_NAME] = Constants.WNS_TITLE;\n  }\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: WnsNotificationParams,\n): WindowsNotification {\n  const result: WindowsNotification = {\n    ...notification,\n    platform: \"windows\",\n    contentType: Constants.XML_CONTENT_TYPE,\n  };\n\n  if (!result.headers) {\n    result.headers = {};\n  }\n\n  if (!result.headers[Constants.WNS_TYPE_NAME]) {\n    result.headers[Constants.WNS_TYPE_NAME] = Constants.WNS_TOAST;\n  }\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: WnsNotificationParams,\n): WindowsNotification {\n  const result: WindowsNotification = {\n    ...notification,\n    platform: \"windows\",\n    contentType: Constants.STREAM_CONTENT_TYPE,\n  };\n\n  if (!result.headers) {\n    result.headers = {};\n  }\n\n  if (!result.headers[Constants.WNS_TYPE_NAME]) {\n    result.headers[Constants.WNS_TYPE_NAME] = Constants.WNS_RAW;\n  }\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  | XiaomiNotification\n  | WindowsNotification\n  | TemplateNotification;\n"]}

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

@@ -18,6 +18,14 @@ export function createAppleNotificationBody(nativeMessage) {
 export function createFirebaseLegacyNotificationBody(nativeMessage) {
     return JSON.stringify(nativeMessage);
 }
+/**
+ * Creates a FcmV1Notification from a native Firebase payload.
+ * @param nativeMessage - The native message payload to send to Notification Hubs.
+ * @returns The JSON body to send to Notification Hubs.
+ */
+export function createFirebaseV1NotificationBody(nativeMessage) {
+    return JSON.stringify(nativeMessage);
+}
 /**
  * Creates a AdmNotification from a native ADM payload.
  * @param nativeMessage - The native message payload to send to Notification Hubs.

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

@@ -1 +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;AAmM/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 Apple specific push notification information.\n   */\n  aps?: AppleApsNativeMessage;\n}\n\n/**\n * Represents a native APNs APS message.\n */\nexport interface AppleApsNativeMessage 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   * The UNIX timestamp that represents the date at which a Live Activity becomes stale, or out of date.\n   */\n  \"stale-date\"?: number;\n\n  /**\n   * The updated or final content for a Live Activity.\n   */\n  \"content-state\"?: Record<string, any>;\n\n  /**\n   * The UNIX timestamp that marks the time when you send the remote notification that updates or ends a Live Activity.\n   */\n  timestamp?: number;\n\n  /**\n   * The string that describes whether you update or end an ongoing Live Activity with the remote push notification. To update the Live Activity, use update. To end the Live Activity, use end.\n   */\n  events?: string;\n\n  /**\n   * The UNIX timestamp that represents the date at which the system ends a Live Activity and removes it from the Dynamic Island and the Lock Screen.\n   */\n  \"dismissal-date\"?: number;\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"]}
+{"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;AAmM/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;AAgbD;;;;GAIG;AACH,MAAM,UAAU,gCAAgC,CAAC,aAAsC;IACrF,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 Apple specific push notification information.\n   */\n  aps?: AppleApsNativeMessage;\n}\n\n/**\n * Represents a native APNs APS message.\n */\nexport interface AppleApsNativeMessage 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   * The UNIX timestamp that represents the date at which a Live Activity becomes stale, or out of date.\n   */\n  \"stale-date\"?: number;\n\n  /**\n   * The updated or final content for a Live Activity.\n   */\n  \"content-state\"?: Record<string, any>;\n\n  /**\n   * The UNIX timestamp that marks the time when you send the remote notification that updates or ends a Live Activity.\n   */\n  timestamp?: number;\n\n  /**\n   * The string that describes whether you update or end an ongoing Live Activity with the remote push notification. To update the Live Activity, use update. To end the Live Activity, use end.\n   */\n  events?: string;\n\n  /**\n   * The UNIX timestamp that represents the date at which the system ends a Live Activity and removes it from the Dynamic Island and the Lock Screen.\n   */\n  \"dismissal-date\"?: number;\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 * Represents the targets, options, and payload for HTTP JSON messages for the Firebase V1 interface.\n */\nexport interface FirebaseV1NativeMessage {\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?: FirebaseV1NativeNotification;\n\n  /**\n   * Android specific options for messages sent through FCM connection server.\n   */\n  android?: FirebaseV1AndroidConfig;\n\n  /**\n   * Webpush protocol options.\n   */\n  webpush?: FirebaseV1WebPushConfig;\n\n  /**\n   * APNs specific options.\n   */\n  apns?: FirebaseV1ApnsConfig;\n\n  /**\n   * FCM options.\n   */\n  fcm_options?: FirebaseV1FcmOptions;\n\n  /**\n   * Registration token to send a message to.\n   */\n  token?: string;\n\n  /**\n   * Topic name to send a message to, e.g. \"weather\".\n   */\n  topic?: string;\n\n  /**\n   * Condition to send a message to, e.g. \"'foo' in topics && 'bar' in topics\".\n   */\n  condition?: string;\n}\n\n/**\n * Represents a native FCM V1 notification message payload.\n */\nexport interface FirebaseV1NativeNotification {\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   * Contains the URL of an image that is going to be downloaded on the device and displayed in a notification.\n   */\n  image?: string;\n}\n\n/**\n * Android specific options for messages sent through FCM connection server.\n */\nexport interface FirebaseV1AndroidConfig {\n  /**\n   * An identifier of a group of messages that can be collapsed, so that only the last message gets sent when delivery can be resumed.\n   */\n  collapse_key?: string;\n\n  /**\n   * Message priority. Can take \"normal\" and \"high\" values.\n   */\n  priority: \"normal\" | \"high\";\n\n  /**\n   * How long (in seconds) the message should be kept in FCM storage if the device is offline.\n   */\n  ttl?: string;\n\n  /**\n   * Package name of the application where the registration token must match in order to receive the message.\n   */\n  restricted_package_name?: string;\n\n  /**\n   * Custom key-value pairs of the message's payload.\n   */\n  data?: Record<string, any>;\n\n  /**\n   * Notification to send to android devices.\n   */\n  notification?: FirebaseV1AndroidNotification;\n\n  /**\n   * Options for features provided by the FCM SDK for Android.\n   */\n  fcm_options?: FirebaseV1AndroidFcmOptions;\n\n  /**\n   * If set to true, messages will be allowed to be delivered to the app while the device is in direct boot mode.\n   */\n  direct_boot_ok?: boolean;\n}\n\n/**\n * Notification to send to android devices.\n */\nexport interface FirebaseV1AndroidNotification {\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.\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 (new in Android O).\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.\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  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   * If set to true, use the Android framework's default vibrate pattern for the notification.\n   */\n  default_vibrate_timings?: boolean;\n\n  /**\n   * If set to true, use the Android framework's default light settings for the notification.\n   */\n  default_light_settings?: boolean;\n\n  /**\n   * Set the vibration pattern to use.\n   */\n  vibrate_timings?: string[];\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   * Settings to control the notification's LED blinking rate and color if LED is available on the device.\n   */\n  light_settings?: {\n    color: {\n      red: number;\n      green: number;\n      blue: number;\n      alpha: number;\n    };\n    light_on_duration: string;\n    light_off_duration: string;\n  };\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 * Options for features provided by the FCM SDK for Android.\n */\nexport interface FirebaseV1AndroidFcmOptions {\n  /**\n   * The label associated with the message's analytics data.\n   */\n  analytics_label?: string;\n}\n\nexport interface FirebaseV1WebPushConfig {\n  /**\n   * A collection of WebPush protocol options.\n   */\n  headers?: Record<string, string>;\n\n  /**\n   * A collection of WebPush protocol options.\n   */\n  data?: Record<string, string>;\n\n  /**\n   * Web Notification options as a JSON object.\n   */\n  notification?: FirebaseV1WebPushNotification;\n\n  /**\n   * A collection of WebPush protocol options.\n   */\n  fcm_options?: FirebaseV1WebPushFcmOptions;\n}\n\n/**\n * Represents a Web Push notification payload.\n */\nexport interface FirebaseV1WebPushNotification {\n  /**\n   * An array of actions to display in the notification.\n   */\n  actions?: {\n    action: string;\n    title: string;\n    icon: string;\n  }[];\n\n  /**\n   * Defines a title for the notification.\n   */\n  title?: string;\n\n  /**\n   * The body string of the notification\n   */\n  body?: string;\n\n  /**\n   * A string containing the URL of an icon to be displayed in the notification.\n   */\n  icon?: string;\n\n  /**\n   * A string containing the URL of an image to represent the notification when there is not enough space to display the notification itself such as for example, the Android Notification Bar.\n   */\n  badge?: string;\n\n  /**\n   * The notification's data.\n   */\n  data?: Record<string, any>;\n\n  /**\n   * The direction in which to display the notification.\n   */\n  dir?: \"auto\" | \"ltr\" | \"rtl\";\n\n  /**\n   * A string containing the URL of an image to be displayed in the notification.\n   */\n  image?: string;\n\n  /**\n   * The notification's language.\n   */\n  lang?: string;\n\n  /**\n   * A boolean value specifying whether the user should be notified after a new notification replaces an old one.\n   */\n  renotify?: boolean;\n\n  /**\n   * Indicates that a notification should remain active until the user clicks or dismisses it, rather than closing automatically.\n   */\n  requireInteraction?: boolean;\n\n  /**\n   * A boolean value specifying whether the notification is silent\n   */\n  silent?: boolean;\n\n  /**\n   * A string representing an identifying tag for the notification.\n   */\n  tag?: string;\n\n  /**\n   * A number representing the time at which a notification is created or applicable\n   */\n  timestamp?: number;\n\n  /**\n   * A vibration pattern for the device's vibration hardware to emit with the notification.\n   */\n  vibrate?: number[];\n}\n\n/**\n * Options for features provided by the FCM SDK for Web.\n */\nexport interface FirebaseV1WebPushFcmOptions {\n  /**\n   * The link to open when the user clicks on the notification.\n   */\n  link?: string;\n\n  /**\n   * Label associated with the message's analytics data.\n   */\n  analytics_label?: string;\n}\n\n/**\n * Apple Push Notification Service specific options.\n */\nexport interface FirebaseV1ApnsConfig {\n  /**\n   * A collection of APNs headers.\n   */\n  headers?: Record<string, string>;\n\n  /**\n   * A collection of APNs headers.\n   */\n  payload?: AppleNativeMessage;\n\n  /**\n   * A collection of APNs headers.\n   */\n  fcm_options?: FirebaseV1ApnsFcmOptions;\n}\n\n/**\n * Options for features provided by the FCM SDK for iOS.\n */\nexport interface FirebaseV1ApnsFcmOptions {\n  /**\n   * Label associated with the message's analytics data.\n   */\n  analytics_label: string;\n\n  /**\n   * Contains the URL of an image that is going to be displayed in a notification.\n   */\n  image: string;\n}\n\nexport interface FirebaseV1FcmOptions {\n  /**\n   * Label associated with the message's analytics data.\n   */\n  analytics_label: string;\n}\n\n/**\n * Creates a FcmV1Notification 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 createFirebaseV1NotificationBody(nativeMessage: FirebaseV1NativeMessage): 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/registration.js

@@ -80,6 +80,22 @@ export function createFcmLegacyRegistrationDescription(description) {
 export function createFcmLegacyTemplateRegistrationDescription(description) {
     return Object.assign(Object.assign({}, description), { kind: "GcmTemplate" });
 }
+/**
+ * Creates a Firebase V1 registration description.
+ * @param description - A partial FCM V1 registration description.
+ * @returns A created FCM V1 registration description.
+ */
+export function createFcmV1RegistrationDescription(description) {
+    return Object.assign(Object.assign({}, description), { kind: "FcmV1" });
+}
+/**
+ * Creates a FCM V1 template registration description.
+ * @param description - A partial FCM V1 template registration description.
+ * @returns A created FCM V1 template registration description.
+ */
+export function createFcmV1TemplateRegistrationDescription(description) {
+    return Object.assign(Object.assign({}, description), { kind: "FcmV1Template" });
+}
 /**
  * Creates a Windows registration description.
  * @param description - A partial Windows registration description.

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;AAwFlC;;;;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;AAsBD;;;;GAIG;AACH,MAAM,UAAU,mCAAmC,CACjD,WAAgD;IAEhD,uCACK,WAAW,KACd,IAAI,EAAE,QAAQ,IACd;AACJ,CAAC;AAoBD;;;;GAIG;AACH,MAAM,UAAU,2CAA2C,CACzD,WAAwD;IAExD,uCACK,WAAW,KACd,IAAI,EAAE,gBAAgB,IACtB;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  | \"Xiaomi\"\n  | \"XiaomiTemplate\"\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 * Represents a Xiaomi registration description.\n */\nexport interface XiaomiRegistrationDescriptionCommon extends RegistrationDescriptionCommon {\n  /**\n   * The Xiaomi registration ID.\n   */\n  xiaomiRegistrationId: string;\n}\n\n/**\n * Represents a Xiaomi registration description.\n */\nexport interface XiaomiRegistrationDescription extends XiaomiRegistrationDescriptionCommon {\n  /**\n   * The kind of the registration.\n   */\n  kind: \"Xiaomi\";\n}\n\n/**\n * Creates a Xiaomi registration description.\n * @param description - A partial Xiaomi registration description.\n * @returns A created Xiaomi registration description.\n */\nexport function createXiaomiRegistrationDescription(\n  description: XiaomiRegistrationDescriptionCommon,\n): XiaomiRegistrationDescription {\n  return {\n    ...description,\n    kind: \"Xiaomi\",\n  };\n}\n\n/**\n * Represents a Xiaomi template registration.\n */\nexport interface XiaomiTemplateRegistrationDescriptionCommon\n  extends XiaomiRegistrationDescriptionCommon,\n    TemplateRegistrationDescription {}\n\n/**\n * Represents a Windows Notification Services (WNS) template registration.\n */\nexport interface XiaomiTemplateRegistrationDescription\n  extends XiaomiTemplateRegistrationDescriptionCommon {\n  /**\n   * The kind of the registration.\n   */\n  kind: \"XiaomiTemplate\";\n}\n\n/**\n * Creates a Xiaomi template registration description.\n * @param description - A partial Xiaomi template registration description.\n * @returns A created Xiaomi template registration description.\n */\nexport function createXiaomiTemplateRegistrationDescription(\n  description: XiaomiTemplateRegistrationDescriptionCommon,\n): XiaomiTemplateRegistrationDescription {\n  return {\n    ...description,\n    kind: \"XiaomiTemplate\",\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  | XiaomiRegistrationDescription\n  | XiaomiTemplateRegistrationDescription\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 an Xiaomi Registration channel query.\n */\nexport interface XiaomiRegistrationChannel {\n  /**\n   * The Xiaomi registration ID.\n   */\n  xiaomiRegistrationId: string;\n  /**\n   * The kind of the registration channel.\n   */\n  kind: \"xiaomi\";\n}\n\n/**\n * Describes a Registration query.\n */\nexport type RegistrationChannel =\n  | AdmRegistrationChannel\n  | AppleRegistrationChannel\n  | BaiduRegistrationChannel\n  | BrowserRegistrationChannel\n  | FirebaseLegacyRegistrationChannel\n  | XiaomiRegistrationChannel\n  | WindowsRegistrationChannel;\n"]}
+{"version":3,"file":"registration.js","sourceRoot":"","sources":["../../../src/models/registration.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AA0FlC;;;;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;AAsBD;;;;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;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;AAsBD;;;;GAIG;AACH,MAAM,UAAU,mCAAmC,CACjD,WAAgD;IAEhD,uCACK,WAAW,KACd,IAAI,EAAE,QAAQ,IACd;AACJ,CAAC;AAoBD;;;;GAIG;AACH,MAAM,UAAU,2CAA2C,CACzD,WAAwD;IAExD,uCACK,WAAW,KACd,IAAI,EAAE,gBAAgB,IACtB;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  | \"FcmV1\"\n  | \"FcmV1Template\"\n  | \"Mpns\"\n  | \"MpnsTemplate\"\n  | \"Xiaomi\"\n  | \"XiaomiTemplate\"\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 Notification Hub registration description for Google Cloud Messaging.\n */\nexport interface FcmV1RegistrationDescriptionCommon extends RegistrationDescriptionCommon {\n  /**\n   * Registration id obtained from the Firebase Cloud Messaging service.\n   */\n  fcmV1RegistrationId: string;\n}\n\n/**\n * Represents Notification Hub registration description for Google Cloud Messaging.\n */\nexport interface FcmV1RegistrationDescription extends FcmV1RegistrationDescriptionCommon {\n  /**\n   * The kind of the registration.\n   */\n  kind: \"FcmV1\";\n}\n\n/**\n * Creates a Firebase V1 registration description.\n * @param description - A partial FCM V1 registration description.\n * @returns A created FCM V1 registration description.\n */\nexport function createFcmV1RegistrationDescription(\n  description: FcmV1RegistrationDescriptionCommon,\n): FcmV1RegistrationDescription {\n  return {\n    ...description,\n    kind: \"FcmV1\",\n  };\n}\n\n/**\n * Represents Notification Hub template registration description for Firebase V1 Cloud Messaging.\n */\nexport interface FcmV1TemplateRegistrationDescriptionCommon\n  extends FcmV1RegistrationDescriptionCommon,\n    TemplateRegistrationDescription {}\n\n/**\n * Represents Notification Hub template registration description for Firebase V1 Cloud Messaging.\n */\nexport interface FcmV1TemplateRegistrationDescription\n  extends FcmV1TemplateRegistrationDescriptionCommon {\n  /**\n   * The kind of the registration.\n   */\n  kind: \"FcmV1Template\";\n}\n\n/**\n * Creates a FCM V1 template registration description.\n * @param description - A partial FCM V1 template registration description.\n * @returns A created FCM V1 template registration description.\n */\nexport function createFcmV1TemplateRegistrationDescription(\n  description: FcmV1TemplateRegistrationDescriptionCommon,\n): FcmV1TemplateRegistrationDescription {\n  return {\n    ...description,\n    kind: \"FcmV1Template\",\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 * Represents a Xiaomi registration description.\n */\nexport interface XiaomiRegistrationDescriptionCommon extends RegistrationDescriptionCommon {\n  /**\n   * The Xiaomi registration ID.\n   */\n  xiaomiRegistrationId: string;\n}\n\n/**\n * Represents a Xiaomi registration description.\n */\nexport interface XiaomiRegistrationDescription extends XiaomiRegistrationDescriptionCommon {\n  /**\n   * The kind of the registration.\n   */\n  kind: \"Xiaomi\";\n}\n\n/**\n * Creates a Xiaomi registration description.\n * @param description - A partial Xiaomi registration description.\n * @returns A created Xiaomi registration description.\n */\nexport function createXiaomiRegistrationDescription(\n  description: XiaomiRegistrationDescriptionCommon,\n): XiaomiRegistrationDescription {\n  return {\n    ...description,\n    kind: \"Xiaomi\",\n  };\n}\n\n/**\n * Represents a Xiaomi template registration.\n */\nexport interface XiaomiTemplateRegistrationDescriptionCommon\n  extends XiaomiRegistrationDescriptionCommon,\n    TemplateRegistrationDescription {}\n\n/**\n * Represents a Windows Notification Services (WNS) template registration.\n */\nexport interface XiaomiTemplateRegistrationDescription\n  extends XiaomiTemplateRegistrationDescriptionCommon {\n  /**\n   * The kind of the registration.\n   */\n  kind: \"XiaomiTemplate\";\n}\n\n/**\n * Creates a Xiaomi template registration description.\n * @param description - A partial Xiaomi template registration description.\n * @returns A created Xiaomi template registration description.\n */\nexport function createXiaomiTemplateRegistrationDescription(\n  description: XiaomiTemplateRegistrationDescriptionCommon,\n): XiaomiTemplateRegistrationDescription {\n  return {\n    ...description,\n    kind: \"XiaomiTemplate\",\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  | FcmV1RegistrationDescription\n  | FcmV1TemplateRegistrationDescription\n  | MpnsRegistrationDescription\n  | MpnsTemplateRegistrationDescription\n  | XiaomiRegistrationDescription\n  | XiaomiTemplateRegistrationDescription\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 Firebase Legacy Registration channel query.\n */\nexport interface FirebaseV1RegistrationChannel {\n  /**\n   * The FCM V1 registration ID.\n   */\n  fcmV1RegistrationId: string;\n  /**\n   * The kind of the registration channel.\n   */\n  kind: \"fcmv1\";\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 an Xiaomi Registration channel query.\n */\nexport interface XiaomiRegistrationChannel {\n  /**\n   * The Xiaomi registration ID.\n   */\n  xiaomiRegistrationId: string;\n  /**\n   * The kind of the registration channel.\n   */\n  kind: \"xiaomi\";\n}\n\n/**\n * Describes a Registration query.\n */\nexport type RegistrationChannel =\n  | AdmRegistrationChannel\n  | AppleRegistrationChannel\n  | BaiduRegistrationChannel\n  | BrowserRegistrationChannel\n  | FirebaseLegacyRegistrationChannel\n  | FirebaseV1RegistrationChannel\n  | XiaomiRegistrationChannel\n  | WindowsRegistrationChannel;\n"]}