@azure/notification-hubs 1.2.1-alpha.20240410.1 → 1.2.1-alpha.20240412.2

package/dist/react-native/models/installation.d.ts

@@ -0,0 +1,231 @@
+/**
+ * Represents an installation for a device for Notification Hubs.
+ */
+export interface InstallationCommon {
+    /**
+     * The ID for the installation.
+     */
+    installationId: string;
+    /**
+     * The User ID for the installation used for targeting.
+     */
+    userId?: string;
+    /**
+     * The installation expiration time.
+     */
+    readonly expirationTime?: string;
+    /**
+     * The last update date of the installation.
+     */
+    readonly lastUpdate?: string;
+    /**
+     * The tags used for targeting this installation.
+     */
+    tags?: string[];
+    /**
+     * The templates for the installation.
+     */
+    templates?: Record<string, InstallationTemplate>;
+}
+/**
+ * Represents an installation with a string based device token.
+ */
+export interface DeviceTokenInstallation extends InstallationCommon {
+    /**
+     * The push channel for a device.
+     */
+    pushChannel: string;
+}
+/**
+ * Represents an Apple APNs based installation.
+ */
+export interface AppleInstallation extends DeviceTokenInstallation {
+    /**
+     * The platform for the installation.
+     */
+    platform: "apns";
+}
+/**
+ * Creates an Apple based installation.
+ * @param installation - A partial installation used to create the Apple installation.
+ * @returns The newly created Apple installation.
+ */
+export declare function createAppleInstallation(installation: DeviceTokenInstallation): AppleInstallation;
+/**
+ * Represents an Amazon Device Messaging (ADM) based installation.
+ */
+export interface AdmInstallation extends DeviceTokenInstallation {
+    /**
+     * The platform for the installation.
+     */
+    platform: "adm";
+}
+/**
+ * Creates an Amazon Device Messaging (ADM) based installation.
+ * @param installation - A partial installation used to create the ADM installation.
+ * @returns The newly created ADM installation.
+ */
+export declare function createAdmInstallation(installation: DeviceTokenInstallation): AdmInstallation;
+/**
+ * Represents a Baidu based installation.
+ */
+export interface BaiduInstallation extends DeviceTokenInstallation {
+    /**
+     * The platform for the installation.
+     */
+    platform: "baidu";
+}
+/**
+ * Creates a Baidu based installation.
+ * @param installation - A partial installation used to create the Baidu installation.
+ * @returns The newly created Baidu installation.
+ */
+export declare function createBaiduInstallation(installation: DeviceTokenInstallation): BaiduInstallation;
+/**
+ * Represents a Firebase Legacy HTTP installation.
+ */
+export interface FcmLegacyInstallation extends DeviceTokenInstallation {
+    /**
+     * The platform for the installation.
+     */
+    platform: "gcm";
+}
+/**
+ * Creates a Firebase legacy HTTP based installation.
+ * @param installation - A partial installation used to create the Firebase Legacy HTTP installation.
+ * @returns The newly created Baidu installation.
+ */
+export declare function createFcmLegacyInstallation(installation: DeviceTokenInstallation): FcmLegacyInstallation;
+/**
+ * Represents an Firebase V1 Cloud Messaging based installation.
+ */
+export interface FcmV1Installation extends DeviceTokenInstallation {
+    /**
+     * The platform for the installation.
+     */
+    platform: "fcmv1";
+}
+/**
+ * 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 declare function createFcmV1Installation(installation: DeviceTokenInstallation): FcmV1Installation;
+/**
+ * Represents a Xiaomi based installation.
+ */
+export interface XiaomiInstallation extends DeviceTokenInstallation {
+    /**
+     * The platform for the installation.
+     */
+    platform: "xiaomi";
+}
+/**
+ * Creates a Xiaomi based installation.
+ * @param installation - A partial installation used to create the Xiaomi installation.
+ * @returns The newly created Xiaomi installation.
+ */
+export declare function createXiaomiInstallation(installation: DeviceTokenInstallation): XiaomiInstallation;
+/**
+ * Represents a Windows Notification Services (WNS) based installation.
+ */
+export interface WindowsInstallation extends DeviceTokenInstallation {
+    /**
+     * The platform for the installation.
+     */
+    platform: "wns";
+}
+/**
+ * Creates a Windows Notification Services (WNS) based installation.
+ * @param installation - A partial installation used to create the WNS installation.
+ * @returns The newly created WNS installation.
+ */
+export declare function createWindowsInstallation(installation: DeviceTokenInstallation): WindowsInstallation;
+/**
+ * Represents the push channel for a Browser Push installation.
+ */
+export interface BrowserPushChannel {
+    /**
+     * The P256DH for the browser push installation.
+     */
+    p256dh: string;
+    /**
+     * The auth secret for the browser push installation.
+     */
+    auth: string;
+    /**
+     * The endpoint URL for the browser push installation.
+     */
+    endpoint: string;
+}
+/**
+ * Represents a Browser/Web Push based installation.
+ */
+export interface BrowserInstallationCommon extends InstallationCommon {
+    /**
+     * The push channel for the Web Push API.
+     */
+    pushChannel: BrowserPushChannel;
+}
+/**
+ * Represents a Browser/Web Push based installation.
+ */
+export interface BrowserInstallation extends BrowserInstallationCommon {
+    /**
+     * The platform for the installation.
+     */
+    platform: "browser";
+}
+/**
+ * Creates a Web Push based installation.
+ * @param installation - A partial installation used to create the Web Push installation.
+ * @returns The newly created Web Push installation.
+ */
+export declare function createBrowserInstallation(installation: BrowserInstallationCommon): BrowserInstallation;
+/**
+ * Represents the types of installations available in Notification Hubs.
+ */
+export type Installation = AppleInstallation | AdmInstallation | BaiduInstallation | BrowserInstallation | FcmLegacyInstallation | FcmV1Installation | XiaomiInstallation | WindowsInstallation;
+/**
+ * Represents an installation template.
+ */
+export interface InstallationTemplate {
+    /**
+     * The body for the installation template.
+     */
+    body: string;
+    /**
+     * Headers to include for the template send.
+     */
+    headers: Record<string, string>;
+    /**
+     * The tags to include for the template.
+     */
+    tags?: string[];
+}
+/**
+ * Represents the JSON Patch types of add, remove and replace.
+ */
+export type JsonPatchOperation = "add" | "remove" | "replace";
+/**
+ * Represents a patch operation.
+ */
+export interface JsonPatch {
+    /**
+     * The patch operation.
+     */
+    op: JsonPatchOperation;
+    /**
+     * The path for the patch operation.
+     */
+    path: string;
+    /**
+     * The value to add or replace for the operation.
+     */
+    value?: string;
+}
+/**
+ * Represents the types of push channels available for Notification Hubs.
+ */
+export type PushHandle = BrowserPushChannel | string;
+//# sourceMappingURL=installation.d.ts.map

package/dist/react-native/models/installation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"installation.d.ts","sourceRoot":"","sources":["../../../src/models/installation.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;CAClD;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,kBAAkB;IACjE;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,uBAAuB;IAChE;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,YAAY,EAAE,uBAAuB,GAAG,iBAAiB,CAKhG;AAED;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,uBAAuB;IAC9D;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC;CACjB;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,YAAY,EAAE,uBAAuB,GAAG,eAAe,CAK5F;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,uBAAuB;IAChE;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,YAAY,EAAE,uBAAuB,GAAG,iBAAiB,CAKhG;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,uBAAuB;IACpE;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC;CACjB;AAED;;;;GAIG;AACH,wBAAgB,2BAA2B,CACzC,YAAY,EAAE,uBAAuB,GACpC,qBAAqB,CAKvB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,uBAAuB;IAChE;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,YAAY,EAAE,uBAAuB,GAAG,iBAAiB,CAKhG;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,uBAAuB;IACjE;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC;CACpB;AAED;;;;GAIG;AACH,wBAAgB,wBAAwB,CACtC,YAAY,EAAE,uBAAuB,GACpC,kBAAkB,CAKpB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,uBAAuB;IAClE;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC;CACjB;AAED;;;;GAIG;AACH,wBAAgB,yBAAyB,CACvC,YAAY,EAAE,uBAAuB,GACpC,mBAAmB,CAKrB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,kBAAkB;IACnE;;OAEG;IACH,WAAW,EAAE,kBAAkB,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,yBAAyB;IACpE;;OAEG;IACH,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED;;;;GAIG;AACH,wBAAgB,yBAAyB,CACvC,YAAY,EAAE,yBAAyB,GACtC,mBAAmB,CAKrB;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GACpB,iBAAiB,GACjB,eAAe,GACf,iBAAiB,GACjB,mBAAmB,GACnB,qBAAqB,GACrB,iBAAiB,GACjB,kBAAkB,GAClB,mBAAmB,CAAC;AAExB;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEhC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,KAAK,GAAG,QAAQ,GAAG,SAAS,CAAC;AAE9D;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,EAAE,EAAE,kBAAkB,CAAC;IAEvB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,kBAAkB,GAAG,MAAM,CAAC"}

package/dist/react-native/models/installation.js

@@ -0,0 +1,67 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+/**
+ * Creates an Apple based installation.
+ * @param installation - A partial installation used to create the Apple installation.
+ * @returns The newly created Apple installation.
+ */
+export function createAppleInstallation(installation) {
+    return Object.assign(Object.assign({}, installation), { platform: "apns" });
+}
+/**
+ * Creates an Amazon Device Messaging (ADM) based installation.
+ * @param installation - A partial installation used to create the ADM installation.
+ * @returns The newly created ADM installation.
+ */
+export function createAdmInstallation(installation) {
+    return Object.assign(Object.assign({}, installation), { platform: "adm" });
+}
+/**
+ * Creates a Baidu based installation.
+ * @param installation - A partial installation used to create the Baidu installation.
+ * @returns The newly created Baidu installation.
+ */
+export function createBaiduInstallation(installation) {
+    return Object.assign(Object.assign({}, installation), { platform: "baidu" });
+}
+/**
+ * Creates a Firebase legacy HTTP based installation.
+ * @param installation - A partial installation used to create the Firebase Legacy HTTP installation.
+ * @returns The newly created Baidu 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.
+ * @returns The newly created Xiaomi installation.
+ */
+export function createXiaomiInstallation(installation) {
+    return Object.assign(Object.assign({}, installation), { platform: "xiaomi" });
+}
+/**
+ * Creates a Windows Notification Services (WNS) based installation.
+ * @param installation - A partial installation used to create the WNS installation.
+ * @returns The newly created WNS installation.
+ */
+export function createWindowsInstallation(installation) {
+    return Object.assign(Object.assign({}, installation), { platform: "wns" });
+}
+/**
+ * Creates a Web Push based installation.
+ * @param installation - A partial installation used to create the Web Push installation.
+ * @returns The newly created Web Push installation.
+ */
+export function createBrowserInstallation(installation) {
+    return Object.assign(Object.assign({}, installation), { platform: "browser" });
+}
+//# sourceMappingURL=installation.js.map

package/dist/react-native/models/installation.js.map

@@ -0,0 +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,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/react-native/models/notification.d.ts

@@ -0,0 +1,274 @@
+import { AdmNativeMessage, AppleNativeMessage, FirebaseLegacyNativeMessage, FirebaseV1NativeMessage } from "./notificationBodyBuilder.js";
+import { AppleHeaders, WindowsHeaders } from "./notificationHeaderBuilder.js";
+/**
+ * Represents a notification that can be sent to a device.
+ */
+export interface NotificationCommon {
+    /**
+     * The body for the push notification.
+     */
+    body: string;
+    /**
+     * The headers to include for the push notification.
+     */
+    headers?: Record<string, unknown>;
+}
+/**
+ * The common notification parameters to accept a string body or JSON body.
+ */
+export interface NotificationCommonParams {
+    /**
+     * The body for the push notification.
+     */
+    body: string | unknown;
+    /**
+     * The headers to include for the push notification.
+     */
+    headers?: Record<string, unknown>;
+}
+/**
+ * Represents a JSON notification hub.
+ */
+export interface JsonNotification extends NotificationCommon {
+    /**
+     * The content type for the push notification.
+     */
+    contentType: "application/json;charset=utf-8";
+}
+/**
+ * Represents an Apple APNs push notification.
+ */
+export interface AppleNotification extends JsonNotification {
+    /**
+     * The platform for the push notification.
+     */
+    platform: "apple";
+}
+/**
+ * Represents an Apple notification that can be sent to a device.
+ */
+export interface AppleNotificationParams {
+    /**
+     * The body for the push notification.
+     */
+    body: string | AppleNativeMessage;
+    /**
+     * The headers to include for the push notification.
+     */
+    headers?: AppleHeaders;
+}
+/**
+ * Creates a notification to send to an Apple device.
+ * @param notification - A partial message used to create a message for Apple.
+ * @returns A newly created Apple.
+ */
+export declare function createAppleNotification(notification: AppleNotificationParams): AppleNotification;
+/**
+ * Represents an Amazon Device Messaging (ADM) push notification.
+ */
+export interface AdmNotification extends JsonNotification {
+    /**
+     * The platform for the push notification.
+     */
+    platform: "adm";
+}
+/**
+ * Represents an ADM notification that can be sent to a device.
+ */
+export interface AdmNotificationParams {
+    /**
+     * The body for the push notification.
+     */
+    body: string | AdmNativeMessage;
+    /**
+     * The headers to include for the push notification.
+     */
+    headers?: Record<string, string>;
+}
+/**
+ * Creates a notification to send to an Amazon Device Messaging device.
+ * @param notification - A partial message used to create a message for Amazon Device Messaging.
+ * @returns A newly created Amazon Device Messaging.
+ */
+export declare function createAdmNotification(notification: AdmNotificationParams): AdmNotification;
+/**
+ * Represents a Baidu push notification.
+ */
+export interface BaiduNotification extends JsonNotification {
+    /**
+     * The platform for the push notification.
+     */
+    platform: "baidu";
+}
+/**
+ * Creates a notification to send to a Baidu registered device.
+ * @param notification - A partial message used to create a message for Baidu.
+ * @returns A newly created Baidu.
+ */
+export declare function createBaiduNotification(notification: NotificationCommonParams): BaiduNotification;
+/**
+ * Represents a Browser push notification.
+ */
+export interface BrowserNotification extends JsonNotification {
+    /**
+     * The platform for the push notification.
+     */
+    platform: "browser";
+}
+/**
+ * Creates a notification to send to a browser.
+ * @param notification - A partial message used to create a message for a browser.
+ * @returns A newly created Web Push browser.
+ */
+export declare function createBrowserNotification(notification: NotificationCommonParams): BrowserNotification;
+/**
+ * Represents a Firebase legacy HTTP push notification.
+ */
+export interface FcmLegacyNotification extends JsonNotification {
+    /**
+     * The platform for the push notification.
+     */
+    platform: "gcm";
+}
+/**
+ * Represents an Firebase Legacy notification that can be sent to a device.
+ */
+export interface FcmLegacyNotificationParams {
+    /**
+     * The body for the push notification.
+     */
+    body: string | FirebaseLegacyNativeMessage;
+    /**
+     * The headers to include for the push notification.
+     */
+    headers?: Record<string, string>;
+}
+/**
+ * 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 declare function createFcmLegacyNotification(notification: FcmLegacyNotificationParams): FcmLegacyNotification;
+/**
+ * Represents an Firebase V1 API notification that can be sent to a device.
+ */
+export interface FcmV1Notification extends JsonNotification {
+    /**
+     * The platform for the push notification.
+     */
+    platform: "fcmv1";
+}
+/**
+ * Represents an Firebase V1 notification that can be sent to a device.
+ */
+export interface FcmV1NotificationParams {
+    /**
+     * The body for the push notification.
+     */
+    body: string | FirebaseV1NativeMessage;
+    /**
+     * The headers to include for the push notification.
+     */
+    headers?: Record<string, string>;
+}
+/**
+ * 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 declare function createFcmV1Notification(notification: FcmV1NotificationParams): FcmV1Notification;
+/**
+ * Represents a Xiaomi push notification.
+ */
+export interface XiaomiNotification extends JsonNotification {
+    /**
+     * The platform for the push notification.
+     */
+    platform: "xiaomi";
+}
+/**
+ * Creates a notification to send to Xiaomi.
+ * @param notification - A partial message used to create a message for Xiaomi.
+ * @returns A newly created Xiaomi notification.
+ */
+export declare function createXiaomiNotification(notification: NotificationCommonParams): XiaomiNotification;
+/**
+ * Represents a template based push notification.
+ */
+export interface TemplateNotification extends JsonNotification {
+    /**
+     * The platform for the push notification.
+     */
+    platform: "template";
+}
+/**
+ * Creates a template notification.
+ * @param notification - A partial message used to be used for a template notification.
+ * @returns A newly created Firebase.
+ */
+export declare function createTemplateNotification(notification: NotificationCommonParams): TemplateNotification;
+/**
+ * Represents the possible WNS content-types.
+ */
+export type WindowsContentType = "application/xml" | "application/octet-stream";
+/**
+ * Represents a Windows Notification Services (WNS) push notification.
+ */
+export interface WindowsNotification extends NotificationCommon {
+    /**
+     * The platform for the push notification.
+     */
+    platform: "windows";
+    /**
+     * The content type for the push notification.
+     */
+    contentType: WindowsContentType;
+}
+/**
+ * Represents a WNS notification that can be sent to a device.
+ */
+export interface WnsNotificationParams {
+    /**
+     * The body for the push notification.
+     */
+    body: string;
+    /**
+     * The headers to include for the push notification.
+     */
+    headers?: WindowsHeaders;
+}
+/**
+ * Creates a notification to send to WNS.
+ * @param notification - The WNS notification to send.
+ * @returns A newly created WNS message.
+ */
+export declare function createWindowsNotification(notification: WnsNotificationParams): WindowsNotification;
+/**
+ * Creates a badge message to send to WNS.
+ * @param notification - A partial message used to create a badge message for WNS.
+ * @returns A newly created WNS badge.
+ */
+export declare function createWindowsBadgeNotification(notification: WnsNotificationParams): WindowsNotification;
+/**
+ * Creates a tile message to send to WNS.
+ * @param notification - A partial message used to create a tile message for WNS.
+ * @returns A newly created WNS tile.
+ */
+export declare function createWindowsTileNotification(notification: WnsNotificationParams): WindowsNotification;
+/**
+ * Creates a toast message to send to WNS.
+ * @param notification - A partial message used to create a toast message for WNS.
+ * @returns A newly created WNS toast.
+ */
+export declare function createWindowsToastNotification(notification: WnsNotificationParams): WindowsNotification;
+/**
+ * Creates a notification to send to WNS in wns/raw format..
+ * @param notification - A partial message used to create a message for WNS in XML format.
+ * @returns A newly created WNS message using XML.
+ */
+export declare function createWindowsRawNotification(notification: WnsNotificationParams): WindowsNotification;
+/**
+ * Represents the possible push notification messages types.
+ */
+export type Notification = AppleNotification | AdmNotification | BaiduNotification | BrowserNotification | FcmLegacyNotification | FcmV1Notification | XiaomiNotification | WindowsNotification | TemplateNotification;
+//# sourceMappingURL=notification.d.ts.map

package/dist/react-native/models/notification.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"notification.d.ts","sourceRoot":"","sources":["../../../src/models/notification.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,2BAA2B,EAC3B,uBAAuB,EACxB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AAM9E;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,kBAAkB;IAC1D;;OAEG;IACH,WAAW,EAAE,gCAAgC,CAAC;CAC/C;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,kBAAkB,CAAC;IAElC;;OAEG;IACH,OAAO,CAAC,EAAE,YAAY,CAAC;CACxB;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,YAAY,EAAE,uBAAuB,GAAG,iBAAiB,CAShG;AAED;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,gBAAgB;IACvD;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,gBAAgB,CAAC;IAEhC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,YAAY,EAAE,qBAAqB,GAAG,eAAe,CAS1F;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,YAAY,EAAE,wBAAwB,GAAG,iBAAiB,CASjG;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC3D;;OAEG;IACH,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED;;;;GAIG;AACH,wBAAgB,yBAAyB,CACvC,YAAY,EAAE,wBAAwB,GACrC,mBAAmB,CASrB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB;IAC7D;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,2BAA2B,CAAC;IAE3C;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC;AAED;;;;GAIG;AACH,wBAAgB,2BAA2B,CACzC,YAAY,EAAE,2BAA2B,GACxC,qBAAqB,CASvB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,uBAAuB,CAAC;IAEvC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,YAAY,EAAE,uBAAuB,GAAG,iBAAiB,CAShG;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;IAC1D;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC;CACpB;AAED;;;;GAIG;AACH,wBAAgB,wBAAwB,CACtC,YAAY,EAAE,wBAAwB,GACrC,kBAAkB,CASpB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC5D;;OAEG;IACH,QAAQ,EAAE,UAAU,CAAC;CACtB;AAED;;;;GAIG;AACH,wBAAgB,0BAA0B,CACxC,YAAY,EAAE,wBAAwB,GACrC,oBAAoB,CAStB;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,iBAAiB,GAAG,0BAA0B,CAAC;AAEhF;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,kBAAkB;IAC7D;;OAEG;IACH,QAAQ,EAAE,SAAS,CAAC;IAEpB;;OAEG;IACH,WAAW,EAAE,kBAAkB,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,CAAC,EAAE,cAAc,CAAC;CAC1B;AAED;;;;GAIG;AACH,wBAAgB,yBAAyB,CACvC,YAAY,EAAE,qBAAqB,GAClC,mBAAmB,CAkBrB;AAED;;;;GAIG;AACH,wBAAgB,8BAA8B,CAC5C,YAAY,EAAE,qBAAqB,GAClC,mBAAmB,CAgBrB;AAED;;;;GAIG;AACH,wBAAgB,6BAA6B,CAC3C,YAAY,EAAE,qBAAqB,GAClC,mBAAmB,CAgBrB;AAED;;;;GAIG;AACH,wBAAgB,8BAA8B,CAC5C,YAAY,EAAE,qBAAqB,GAClC,mBAAmB,CAgBrB;AAED;;;;GAIG;AACH,wBAAgB,4BAA4B,CAC1C,YAAY,EAAE,qBAAqB,GAClC,mBAAmB,CAgBrB;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GACpB,iBAAiB,GACjB,eAAe,GACf,iBAAiB,GACjB,mBAAmB,GACnB,qBAAqB,GACrB,iBAAiB,GACjB,kBAAkB,GAClB,mBAAmB,GACnB,oBAAoB,CAAC"}