@azure/notification-hubs 1.0.0-beta.1

package/types/src/models/installation.d.ts

@@ -0,0 +1,200 @@
+/**
+ * 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 platform for the installation.
+     */
+    platform: "apns" | "adm" | "baidu" | "browser" | "gcm" | "wns";
+    /**
+     * 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: Omit<AppleInstallation, "platform">): 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: Omit<AdmInstallation, "platform">): 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: Omit<BaiduInstallation, "platform">): BaiduInstallation;
+/**
+ * Represents a Firebase Legacy HTTP installation.
+ */
+export interface FirebaseLegacyInstallation 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 createFirebaseLegacyInstallation(installation: Omit<FirebaseLegacyInstallation, "platform">): FirebaseLegacyInstallation;
+/**
+ * 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: Omit<WindowsInstallation, "platform">): 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 BrowserInstallation extends InstallationCommon {
+    /**
+     * The push channel for the Web Push API.
+     */
+    pushChannel: BrowserPushChannel;
+    /**
+     * 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: Omit<BrowserInstallation, "platform">): BrowserInstallation;
+/**
+ * Represents the types of installations available in Notification Hubs.
+ */
+export declare type Installation = AppleInstallation | AdmInstallation | BaiduInstallation | BrowserInstallation | FirebaseLegacyInstallation | 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 declare 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 declare type PushHandle = BrowserPushChannel | string;
+//# sourceMappingURL=installation.d.ts.map

package/types/src/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,QAAQ,EAAE,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,SAAS,GAAG,KAAK,GAAG,KAAK,CAAC;IAE/D;;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,CACrC,YAAY,EAAE,IAAI,CAAC,iBAAiB,EAAE,UAAU,CAAC,GAChD,iBAAiB,CAKnB;AAED;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,uBAAuB;IAC9D;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC;CACjB;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CACnC,YAAY,EAAE,IAAI,CAAC,eAAe,EAAE,UAAU,CAAC,GAC9C,eAAe,CAKjB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,uBAAuB;IAChE;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CACrC,YAAY,EAAE,IAAI,CAAC,iBAAiB,EAAE,UAAU,CAAC,GAChD,iBAAiB,CAKnB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA2B,SAAQ,uBAAuB;IACzE;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC;CACjB;AAED;;;;GAIG;AACH,wBAAgB,gCAAgC,CAC9C,YAAY,EAAE,IAAI,CAAC,0BAA0B,EAAE,UAAU,CAAC,GACzD,0BAA0B,CAK5B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,uBAAuB;IAClE;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC;CACjB;AAED;;;;GAIG;AACH,wBAAgB,yBAAyB,CACvC,YAAY,EAAE,IAAI,CAAC,mBAAmB,EAAE,UAAU,CAAC,GAClD,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,mBAAoB,SAAQ,kBAAkB;IAC7D;;OAEG;IACH,WAAW,EAAE,kBAAkB,CAAC;IAEhC;;OAEG;IACH,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED;;;;GAIG;AACH,wBAAgB,yBAAyB,CACvC,YAAY,EAAE,IAAI,CAAC,mBAAmB,EAAE,UAAU,CAAC,GAClD,mBAAmB,CAKrB;AAED;;GAEG;AACH,oBAAY,YAAY,GACpB,iBAAiB,GACjB,eAAe,GACf,iBAAiB,GACjB,mBAAmB,GACnB,0BAA0B,GAC1B,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,oBAAY,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,oBAAY,UAAU,GAAG,kBAAkB,GAAG,MAAM,CAAC"}

package/types/src/models/notification.d.ts

@@ -0,0 +1,166 @@
+/**
+ * Represents a notification hub.
+ */
+export interface NotificationCommon {
+    /**
+     * The body for the push notification.
+     */
+    body: string;
+    /**
+     * The headers to include for the push notification.
+     */
+    headers?: Record<string, string>;
+    /**
+     * The platform for the push notification.
+     */
+    platform: string;
+    /**
+     * The content type for the push notification.
+     */
+    contentType: string;
+}
+/**
+ * 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";
+}
+/**
+ * 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: Omit<AppleNotification, "platform" | "contentType">): AppleNotification;
+/**
+ * Represents an Amazon Device Messaging (ADM) push notification.
+ */
+export interface AdmNotification extends JsonNotification {
+    /**
+     * The platform for the push notification.
+     */
+    platform: "adm";
+}
+/**
+ * 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: Omit<AdmNotification, "platform" | "contentType">): 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: Omit<BaiduNotification, "platform" | "contentType">): 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: Omit<BrowserNotification, "platform" | "contentType">): BrowserNotification;
+/**
+ * Represents a Firebase legacy HTTP push notification.
+ */
+export interface FirebaseLegacyNotification extends JsonNotification {
+    /**
+     * The platform for the push notification.
+     */
+    platform: "gcm";
+}
+/**
+ * Creates a notification to send to Firebase.
+ * @param notification - A partial message used to create a message for Firebase.
+ * @returns A newly created Firebase.
+ */
+export declare function createFirebaseLegacyNotification(notification: Omit<FirebaseLegacyNotification, "platform" | "contentType">): FirebaseLegacyNotification;
+/**
+ * Represents a template based push notification.
+ */
+export interface TemplateNotification extends JsonNotification {
+    /**
+     * The platform for the push notification.
+     */
+    platform: "template";
+}
+/**
+ * Creates a notification to send to Firebase.
+ * @param notification - A partial message used to create a message for Firebase.
+ * @returns A newly created Firebase.
+ */
+export declare function createTemplateNotification(notification: Omit<TemplateNotification, "platform" | "contentType">): TemplateNotification;
+/**
+ * Represents the possible WNS content-types.
+ */
+export declare 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: "wns";
+    /**
+     * The content type for the push notification.
+     */
+    contentType: WindowsContentType;
+}
+/**
+ * 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: Omit<WindowsNotification, "platform" | "contentType">): 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: Omit<WindowsNotification, "platform" | "contentType">): 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: Omit<WindowsNotification, "platform" | "contentType">): 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: Omit<WindowsNotification, "platform" | "contentType">): WindowsNotification;
+/**
+ * Represents the possible push notification messages types.
+ */
+export declare type Notification = AppleNotification | AdmNotification | BaiduNotification | BrowserNotification | FirebaseLegacyNotification | WindowsNotification | TemplateNotification;
+//# sourceMappingURL=notification.d.ts.map

package/types/src/models/notification.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"notification.d.ts","sourceRoot":"","sources":["../../../src/models/notification.ts"],"names":[],"mappings":"AAKA;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEjC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;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;;;;GAIG;AACH,wBAAgB,uBAAuB,CACrC,YAAY,EAAE,IAAI,CAAC,iBAAiB,EAAE,UAAU,GAAG,aAAa,CAAC,GAChE,iBAAiB,CAMnB;AAED;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,gBAAgB;IACvD;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC;CACjB;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CACnC,YAAY,EAAE,IAAI,CAAC,eAAe,EAAE,UAAU,GAAG,aAAa,CAAC,GAC9D,eAAe,CAMjB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CACrC,YAAY,EAAE,IAAI,CAAC,iBAAiB,EAAE,UAAU,GAAG,aAAa,CAAC,GAChE,iBAAiB,CAMnB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC3D;;OAEG;IACH,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED;;;;GAIG;AACH,wBAAgB,yBAAyB,CACvC,YAAY,EAAE,IAAI,CAAC,mBAAmB,EAAE,UAAU,GAAG,aAAa,CAAC,GAClE,mBAAmB,CAMrB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA2B,SAAQ,gBAAgB;IAClE;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC;CACjB;AAED;;;;GAIG;AACH,wBAAgB,gCAAgC,CAC9C,YAAY,EAAE,IAAI,CAAC,0BAA0B,EAAE,UAAU,GAAG,aAAa,CAAC,GACzE,0BAA0B,CAM5B;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC5D;;OAEG;IACH,QAAQ,EAAE,UAAU,CAAC;CACtB;AAED;;;;GAIG;AACH,wBAAgB,0BAA0B,CACxC,YAAY,EAAE,IAAI,CAAC,oBAAoB,EAAE,UAAU,GAAG,aAAa,CAAC,GACnE,oBAAoB,CAMtB;AAED;;GAEG;AACH,oBAAY,kBAAkB,GAAG,iBAAiB,GAAG,0BAA0B,CAAC;AAEhF;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,kBAAkB;IAC7D;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC;IAEhB;;OAEG;IACH,WAAW,EAAE,kBAAkB,CAAC;CACjC;AAED;;;;GAIG;AACH,wBAAgB,8BAA8B,CAC5C,YAAY,EAAE,IAAI,CAAC,mBAAmB,EAAE,UAAU,GAAG,aAAa,CAAC,GAClE,mBAAmB,CAcrB;AAED;;;;GAIG;AACH,wBAAgB,6BAA6B,CAC3C,YAAY,EAAE,IAAI,CAAC,mBAAmB,EAAE,UAAU,GAAG,aAAa,CAAC,GAClE,mBAAmB,CAcrB;AAED;;;;GAIG;AACH,wBAAgB,8BAA8B,CAC5C,YAAY,EAAE,IAAI,CAAC,mBAAmB,EAAE,UAAU,GAAG,aAAa,CAAC,GAClE,mBAAmB,CAcrB;AAED;;;;GAIG;AACH,wBAAgB,4BAA4B,CAC1C,YAAY,EAAE,IAAI,CAAC,mBAAmB,EAAE,UAAU,GAAG,aAAa,CAAC,GAClE,mBAAmB,CAcrB;AAED;;GAEG;AACH,oBAAY,YAAY,GACpB,iBAAiB,GACjB,eAAe,GACf,iBAAiB,GACjB,mBAAmB,GACnB,0BAA0B,GAC1B,mBAAmB,GACnB,oBAAoB,CAAC"}