@openfin/core 43.100.62 → 43.100.64

package/out/mock-alpha.d.ts

@@ -9557,15 +9557,96 @@ declare type NotificationEvent = {
     notificationId: string;
 };
 
+declare type NotificationHandler = (notification: WebNotificationInfo) => void;
+
+/**
+ * NotificationManagers allow all {@link https://developer.mozilla.org/en-US/docs/Web/API/Notifications_API | HTML5 notifications} created in the application to be intercepted and dispatched.
+ *
+ * Please note, currently Notifications will only be intercepted if the following conditions are met:
+ *  - The source WebContents has the `notification` webAPI permission.
+ *  - The source WebContents is not a service worker.
+ *
+ * Service worker and push notifications are currently not supported.
+ *
+ * **See also** -  {@link https://developer.mozilla.org/en-US/docs/Web/API/Notifications_API | Notification API (MDN)}
+ *
+ * @experimental This API is subject to change in future releases.
+ *
+ */
 declare class NotificationManagerInstance {
     #private;
-    constructor(wire: Transport, id: string);
-    setNotificationHandler: (handler: NotificiationHandler) => Promise<void>;
+    /* Excluded from this release type: __constructor */
+    /**
+     * Sets the current handler for notifications. The provided function will be invoked whenever a WebContents successfully raises a notification.
+     *
+     * **Note**, only one handler can be used at a time, calling `setNotificationHandler` will replace any existing registered handler.
+     *
+     * @param handler  The notification handler callback which will be invoked whenever a notification is created.
+     *
+     * @example
+     *
+     * ```typescript
+     * const notificationManager = await fin.NotificationManager.init();
+     * const handler = (notification) => {
+     *   console.log("Received the following notification", info);
+     * }
+     * await notificationManager.setNotificationHandler(handler);
+     * ```
+     */
+    setNotificationHandler: (handler: OpenFin_2.NotificationHandler) => Promise<void>;
+    /**
+     * Destroys the current NotificationManagerInstance.
+     *
+     * @example
+     * ```typescript
+     * await notificationManager.destroy();
+     * ```
+     */
     destroy: () => Promise<void>;
-    dispatch: (event: NotificationEvent) => Promise<void>;
+    /**
+     * Dispatches a Notification lifecycle event ('close' | 'click' | 'show').
+     *
+     * @param event Identifies the type of event to emit, and which `notificationId` to emit it for.
+     *
+     * @example
+     * ```typescript
+     * notificationManager.setNotificationHandler((notification) => {
+     *  await mockNotificationUi.showNotification(notification);
+     *  await notificationManager.dispatchNotificationEvent({
+     *      notificationId: notification.notificationId,
+     *      type: 'show
+     *  })
+     * })
+     * ```
+     *
+     * **See Also** - {@link https://developer.mozilla.org/en-US/docs/Web/API/Notification/click_event | Notification Click Event (MDN)}
+     *
+     * **See Also** - {@link https://developer.mozilla.org/en-US/docs/Web/API/Notification/close_event | Notification Close Event (MDN)}
+     *
+     * **See Also** - {@link https://developer.mozilla.org/en-US/docs/Web/API/Notification/show_event | Notification Show Event (MDN)}
+     */
+    dispatch: (event: OpenFin_2.NotificationEvent) => Promise<void>;
 }
 
 declare class NotificationManagerModule extends Base {
+    /**
+     * Initializes a NotificationManager for the current application, which allows interception of HTML5 web notifications.
+     *
+     * Secured by default, must be called from a WebContents with the NotificationManager.init permission.
+     *
+     * Only one NotificationManager can be active at a time, calls to `init` will fail otherwise.
+     *
+     * If a WebContents with the NotificationManager active reloads or is closed, it will be possible to create a new one.
+     *
+     * @example
+     *
+     * ```js
+     * // From Provider context
+     * const notificationManager = await fin.NotificationManager.init();
+     * // NotificationManager is now active and will intercept all incoming notifications.
+     * ```
+     * @experimental
+     */
     init: () => Promise<NotificationManagerInstance>;
 }
 
@@ -9573,8 +9654,6 @@ declare type NotificationManagerPermissions = {
     init: boolean;
 };
 
-declare type NotificiationHandler = (event: WebNotificationInfo) => void;
-
 /* Excluded from this release type: NotRequested */
 
 /**
@@ -9987,11 +10066,12 @@ declare namespace OpenFin_2 {
         RoutingInfo,
         DownloadShelfOptions,
         ViewShowAtOptions,
+        WebNotificationProperties,
+        WebNotificationInfo,
         NotificationEvent,
+        NotificationHandler,
         NotificationManagerInstance,
         NotificationManagerModule,
-        WebNotificationInfo,
-        WebNotificationProperties,
         ExtensionInfo,
         ServeRequest,
         AppAssetServeRequest,

package/out/mock-beta.d.ts

@@ -9557,15 +9557,96 @@ declare type NotificationEvent = {
     notificationId: string;
 };
 
+declare type NotificationHandler = (notification: WebNotificationInfo) => void;
+
+/**
+ * NotificationManagers allow all {@link https://developer.mozilla.org/en-US/docs/Web/API/Notifications_API | HTML5 notifications} created in the application to be intercepted and dispatched.
+ *
+ * Please note, currently Notifications will only be intercepted if the following conditions are met:
+ *  - The source WebContents has the `notification` webAPI permission.
+ *  - The source WebContents is not a service worker.
+ *
+ * Service worker and push notifications are currently not supported.
+ *
+ * **See also** -  {@link https://developer.mozilla.org/en-US/docs/Web/API/Notifications_API | Notification API (MDN)}
+ *
+ * @experimental This API is subject to change in future releases.
+ *
+ */
 declare class NotificationManagerInstance {
     #private;
-    constructor(wire: Transport, id: string);
-    setNotificationHandler: (handler: NotificiationHandler) => Promise<void>;
+    /* Excluded from this release type: __constructor */
+    /**
+     * Sets the current handler for notifications. The provided function will be invoked whenever a WebContents successfully raises a notification.
+     *
+     * **Note**, only one handler can be used at a time, calling `setNotificationHandler` will replace any existing registered handler.
+     *
+     * @param handler  The notification handler callback which will be invoked whenever a notification is created.
+     *
+     * @example
+     *
+     * ```typescript
+     * const notificationManager = await fin.NotificationManager.init();
+     * const handler = (notification) => {
+     *   console.log("Received the following notification", info);
+     * }
+     * await notificationManager.setNotificationHandler(handler);
+     * ```
+     */
+    setNotificationHandler: (handler: OpenFin_2.NotificationHandler) => Promise<void>;
+    /**
+     * Destroys the current NotificationManagerInstance.
+     *
+     * @example
+     * ```typescript
+     * await notificationManager.destroy();
+     * ```
+     */
     destroy: () => Promise<void>;
-    dispatch: (event: NotificationEvent) => Promise<void>;
+    /**
+     * Dispatches a Notification lifecycle event ('close' | 'click' | 'show').
+     *
+     * @param event Identifies the type of event to emit, and which `notificationId` to emit it for.
+     *
+     * @example
+     * ```typescript
+     * notificationManager.setNotificationHandler((notification) => {
+     *  await mockNotificationUi.showNotification(notification);
+     *  await notificationManager.dispatchNotificationEvent({
+     *      notificationId: notification.notificationId,
+     *      type: 'show
+     *  })
+     * })
+     * ```
+     *
+     * **See Also** - {@link https://developer.mozilla.org/en-US/docs/Web/API/Notification/click_event | Notification Click Event (MDN)}
+     *
+     * **See Also** - {@link https://developer.mozilla.org/en-US/docs/Web/API/Notification/close_event | Notification Close Event (MDN)}
+     *
+     * **See Also** - {@link https://developer.mozilla.org/en-US/docs/Web/API/Notification/show_event | Notification Show Event (MDN)}
+     */
+    dispatch: (event: OpenFin_2.NotificationEvent) => Promise<void>;
 }
 
 declare class NotificationManagerModule extends Base {
+    /**
+     * Initializes a NotificationManager for the current application, which allows interception of HTML5 web notifications.
+     *
+     * Secured by default, must be called from a WebContents with the NotificationManager.init permission.
+     *
+     * Only one NotificationManager can be active at a time, calls to `init` will fail otherwise.
+     *
+     * If a WebContents with the NotificationManager active reloads or is closed, it will be possible to create a new one.
+     *
+     * @example
+     *
+     * ```js
+     * // From Provider context
+     * const notificationManager = await fin.NotificationManager.init();
+     * // NotificationManager is now active and will intercept all incoming notifications.
+     * ```
+     * @experimental
+     */
     init: () => Promise<NotificationManagerInstance>;
 }
 
@@ -9573,8 +9654,6 @@ declare type NotificationManagerPermissions = {
     init: boolean;
 };
 
-declare type NotificiationHandler = (event: WebNotificationInfo) => void;
-
 /* Excluded from this release type: NotRequested */
 
 /**
@@ -9987,11 +10066,12 @@ declare namespace OpenFin_2 {
         RoutingInfo,
         DownloadShelfOptions,
         ViewShowAtOptions,
+        WebNotificationProperties,
+        WebNotificationInfo,
         NotificationEvent,
+        NotificationHandler,
         NotificationManagerInstance,
         NotificationManagerModule,
-        WebNotificationInfo,
-        WebNotificationProperties,
         ExtensionInfo,
         ServeRequest,
         AppAssetServeRequest,

package/out/mock-public.d.ts

@@ -9557,15 +9557,96 @@ declare type NotificationEvent = {
     notificationId: string;
 };
 
+declare type NotificationHandler = (notification: WebNotificationInfo) => void;
+
+/**
+ * NotificationManagers allow all {@link https://developer.mozilla.org/en-US/docs/Web/API/Notifications_API | HTML5 notifications} created in the application to be intercepted and dispatched.
+ *
+ * Please note, currently Notifications will only be intercepted if the following conditions are met:
+ *  - The source WebContents has the `notification` webAPI permission.
+ *  - The source WebContents is not a service worker.
+ *
+ * Service worker and push notifications are currently not supported.
+ *
+ * **See also** -  {@link https://developer.mozilla.org/en-US/docs/Web/API/Notifications_API | Notification API (MDN)}
+ *
+ * @experimental This API is subject to change in future releases.
+ *
+ */
 declare class NotificationManagerInstance {
     #private;
-    constructor(wire: Transport, id: string);
-    setNotificationHandler: (handler: NotificiationHandler) => Promise<void>;
+    /* Excluded from this release type: __constructor */
+    /**
+     * Sets the current handler for notifications. The provided function will be invoked whenever a WebContents successfully raises a notification.
+     *
+     * **Note**, only one handler can be used at a time, calling `setNotificationHandler` will replace any existing registered handler.
+     *
+     * @param handler  The notification handler callback which will be invoked whenever a notification is created.
+     *
+     * @example
+     *
+     * ```typescript
+     * const notificationManager = await fin.NotificationManager.init();
+     * const handler = (notification) => {
+     *   console.log("Received the following notification", info);
+     * }
+     * await notificationManager.setNotificationHandler(handler);
+     * ```
+     */
+    setNotificationHandler: (handler: OpenFin_2.NotificationHandler) => Promise<void>;
+    /**
+     * Destroys the current NotificationManagerInstance.
+     *
+     * @example
+     * ```typescript
+     * await notificationManager.destroy();
+     * ```
+     */
     destroy: () => Promise<void>;
-    dispatch: (event: NotificationEvent) => Promise<void>;
+    /**
+     * Dispatches a Notification lifecycle event ('close' | 'click' | 'show').
+     *
+     * @param event Identifies the type of event to emit, and which `notificationId` to emit it for.
+     *
+     * @example
+     * ```typescript
+     * notificationManager.setNotificationHandler((notification) => {
+     *  await mockNotificationUi.showNotification(notification);
+     *  await notificationManager.dispatchNotificationEvent({
+     *      notificationId: notification.notificationId,
+     *      type: 'show
+     *  })
+     * })
+     * ```
+     *
+     * **See Also** - {@link https://developer.mozilla.org/en-US/docs/Web/API/Notification/click_event | Notification Click Event (MDN)}
+     *
+     * **See Also** - {@link https://developer.mozilla.org/en-US/docs/Web/API/Notification/close_event | Notification Close Event (MDN)}
+     *
+     * **See Also** - {@link https://developer.mozilla.org/en-US/docs/Web/API/Notification/show_event | Notification Show Event (MDN)}
+     */
+    dispatch: (event: OpenFin_2.NotificationEvent) => Promise<void>;
 }
 
 declare class NotificationManagerModule extends Base {
+    /**
+     * Initializes a NotificationManager for the current application, which allows interception of HTML5 web notifications.
+     *
+     * Secured by default, must be called from a WebContents with the NotificationManager.init permission.
+     *
+     * Only one NotificationManager can be active at a time, calls to `init` will fail otherwise.
+     *
+     * If a WebContents with the NotificationManager active reloads or is closed, it will be possible to create a new one.
+     *
+     * @example
+     *
+     * ```js
+     * // From Provider context
+     * const notificationManager = await fin.NotificationManager.init();
+     * // NotificationManager is now active and will intercept all incoming notifications.
+     * ```
+     * @experimental
+     */
     init: () => Promise<NotificationManagerInstance>;
 }
 
@@ -9573,8 +9654,6 @@ declare type NotificationManagerPermissions = {
     init: boolean;
 };
 
-declare type NotificiationHandler = (event: WebNotificationInfo) => void;
-
 /* Excluded from this release type: NotRequested */
 
 /**
@@ -9987,11 +10066,12 @@ declare namespace OpenFin_2 {
         RoutingInfo,
         DownloadShelfOptions,
         ViewShowAtOptions,
+        WebNotificationProperties,
+        WebNotificationInfo,
         NotificationEvent,
+        NotificationHandler,
         NotificationManagerInstance,
         NotificationManagerModule,
-        WebNotificationInfo,
-        WebNotificationProperties,
         ExtensionInfo,
         ServeRequest,
         AppAssetServeRequest,

package/out/stub.d.ts

@@ -9883,15 +9883,99 @@ declare type NotificationEvent = {
     notificationId: string;
 };
 
+declare type NotificationHandler = (notification: WebNotificationInfo) => void;
+
+/**
+ * NotificationManagers allow all {@link https://developer.mozilla.org/en-US/docs/Web/API/Notifications_API | HTML5 notifications} created in the application to be intercepted and dispatched.
+ *
+ * Please note, currently Notifications will only be intercepted if the following conditions are met:
+ *  - The source WebContents has the `notification` webAPI permission.
+ *  - The source WebContents is not a service worker.
+ *
+ * Service worker and push notifications are currently not supported.
+ *
+ * **See also** -  {@link https://developer.mozilla.org/en-US/docs/Web/API/Notifications_API | Notification API (MDN)}
+ *
+ * @experimental This API is subject to change in future releases.
+ *
+ */
 declare class NotificationManagerInstance {
     #private;
+    /**
+     * @internal
+     */
     constructor(wire: Transport, id: string);
-    setNotificationHandler: (handler: NotificiationHandler) => Promise<void>;
+    /**
+     * Sets the current handler for notifications. The provided function will be invoked whenever a WebContents successfully raises a notification.
+     *
+     * **Note**, only one handler can be used at a time, calling `setNotificationHandler` will replace any existing registered handler.
+     *
+     * @param handler  The notification handler callback which will be invoked whenever a notification is created.
+     *
+     * @example
+     *
+     * ```typescript
+     * const notificationManager = await fin.NotificationManager.init();
+     * const handler = (notification) => {
+     *   console.log("Received the following notification", info);
+     * }
+     * await notificationManager.setNotificationHandler(handler);
+     * ```
+     */
+    setNotificationHandler: (handler: OpenFin_2.NotificationHandler) => Promise<void>;
+    /**
+     * Destroys the current NotificationManagerInstance.
+     *
+     * @example
+     * ```typescript
+     * await notificationManager.destroy();
+     * ```
+     */
     destroy: () => Promise<void>;
-    dispatch: (event: NotificationEvent) => Promise<void>;
+    /**
+     * Dispatches a Notification lifecycle event ('close' | 'click' | 'show').
+     *
+     * @param event Identifies the type of event to emit, and which `notificationId` to emit it for.
+     *
+     * @example
+     * ```typescript
+     * notificationManager.setNotificationHandler((notification) => {
+     *  await mockNotificationUi.showNotification(notification);
+     *  await notificationManager.dispatchNotificationEvent({
+     *      notificationId: notification.notificationId,
+     *      type: 'show
+     *  })
+     * })
+     * ```
+     *
+     * **See Also** - {@link https://developer.mozilla.org/en-US/docs/Web/API/Notification/click_event | Notification Click Event (MDN)}
+     *
+     * **See Also** - {@link https://developer.mozilla.org/en-US/docs/Web/API/Notification/close_event | Notification Close Event (MDN)}
+     *
+     * **See Also** - {@link https://developer.mozilla.org/en-US/docs/Web/API/Notification/show_event | Notification Show Event (MDN)}
+     */
+    dispatch: (event: OpenFin_2.NotificationEvent) => Promise<void>;
 }
 
 declare class NotificationManagerModule extends Base {
+    /**
+     * Initializes a NotificationManager for the current application, which allows interception of HTML5 web notifications.
+     *
+     * Secured by default, must be called from a WebContents with the NotificationManager.init permission.
+     *
+     * Only one NotificationManager can be active at a time, calls to `init` will fail otherwise.
+     *
+     * If a WebContents with the NotificationManager active reloads or is closed, it will be possible to create a new one.
+     *
+     * @example
+     *
+     * ```js
+     * // From Provider context
+     * const notificationManager = await fin.NotificationManager.init();
+     * // NotificationManager is now active and will intercept all incoming notifications.
+     * ```
+     * @experimental
+     */
     init: () => Promise<NotificationManagerInstance>;
 }
 
@@ -9899,8 +9983,6 @@ declare type NotificationManagerPermissions = {
     init: boolean;
 };
 
-declare type NotificiationHandler = (event: WebNotificationInfo) => void;
-
 /**
  * @internal
  *
@@ -10318,11 +10400,12 @@ declare namespace OpenFin_2 {
         RoutingInfo,
         DownloadShelfOptions,
         ViewShowAtOptions,
+        WebNotificationProperties,
+        WebNotificationInfo,
         NotificationEvent,
+        NotificationHandler,
         NotificationManagerInstance,
         NotificationManagerModule,
-        WebNotificationInfo,
-        WebNotificationProperties,
         ExtensionInfo,
         ServeRequest,
         AppAssetServeRequest,

package/out/stub.js

@@ -17302,7 +17302,24 @@ var _NotificationManagerInstance_wire, _NotificationManagerInstance_handler, _No
 Object.defineProperty(instance, "__esModule", { value: true });
 instance.NotificationManagerInstance = void 0;
 const lazy_1 = lazy;
+/**
+ * NotificationManagers allow all {@link https://developer.mozilla.org/en-US/docs/Web/API/Notifications_API | HTML5 notifications} created in the application to be intercepted and dispatched.
+ *
+ * Please note, currently Notifications will only be intercepted if the following conditions are met:
+ *  - The source WebContents has the `notification` webAPI permission.
+ *  - The source WebContents is not a service worker.
+ *
+ * Service worker and push notifications are currently not supported.
+ *
+ * **See also** -  {@link https://developer.mozilla.org/en-US/docs/Web/API/Notifications_API | Notification API (MDN)}
+ *
+ * @experimental This API is subject to change in future releases.
+ *
+ */
 class NotificationManagerInstance {
+    /**
+     * @internal
+     */
     constructor(wire, id) {
         _NotificationManagerInstance_wire.set(this, void 0);
         _NotificationManagerInstance_handler.set(this, void 0);
@@ -17332,13 +17349,60 @@ class NotificationManagerInstance {
             });
             return true;
         }));
+        /**
+         * Sets the current handler for notifications. The provided function will be invoked whenever a WebContents successfully raises a notification.
+         *
+         * **Note**, only one handler can be used at a time, calling `setNotificationHandler` will replace any existing registered handler.
+         *
+         * @param handler  The notification handler callback which will be invoked whenever a notification is created.
+         *
+         * @example
+         *
+         * ```typescript
+         * const notificationManager = await fin.NotificationManager.init();
+         * const handler = (notification) => {
+         *   console.log("Received the following notification", info);
+         * }
+         * await notificationManager.setNotificationHandler(handler);
+         * ```
+         */
         this.setNotificationHandler = async (handler) => {
             await __classPrivateFieldGet$1(this, _NotificationManagerInstance_isReceivingNotifications, "f").getValue();
             __classPrivateFieldSet$1(this, _NotificationManagerInstance_handler, handler, "f");
         };
+        /**
+         * Destroys the current NotificationManagerInstance.
+         *
+         * @example
+         * ```typescript
+         * await notificationManager.destroy();
+         * ```
+         */
         this.destroy = async () => {
             await __classPrivateFieldGet$1(this, _NotificationManagerInstance_wire, "f").sendAction('destroy-notification-manager', { managerId: __classPrivateFieldGet$1(this, _NotificationManagerInstance_id, "f") });
         };
+        /**
+         * Dispatches a Notification lifecycle event ('close' | 'click' | 'show').
+         *
+         * @param event Identifies the type of event to emit, and which `notificationId` to emit it for.
+         *
+         * @example
+         * ```typescript
+         * notificationManager.setNotificationHandler((notification) => {
+         *  await mockNotificationUi.showNotification(notification);
+         *  await notificationManager.dispatchNotificationEvent({
+         *      notificationId: notification.notificationId,
+         *      type: 'show
+         *  })
+         * })
+         * ```
+         *
+         * **See Also** - {@link https://developer.mozilla.org/en-US/docs/Web/API/Notification/click_event | Notification Click Event (MDN)}
+         *
+         * **See Also** - {@link https://developer.mozilla.org/en-US/docs/Web/API/Notification/close_event | Notification Close Event (MDN)}
+         *
+         * **See Also** - {@link https://developer.mozilla.org/en-US/docs/Web/API/Notification/show_event | Notification Show Event (MDN)}
+         */
         this.dispatch = async (event) => {
             const { notificationId, type } = event;
             await __classPrivateFieldGet$1(this, _NotificationManagerInstance_wire, "f").sendAction('dispatch-notification-event', {
@@ -17360,6 +17424,24 @@ const instance_1 = instance;
 class NotificationManagerModule extends base_1.Base {
     constructor() {
         super(...arguments);
+        /**
+         * Initializes a NotificationManager for the current application, which allows interception of HTML5 web notifications.
+         *
+         * Secured by default, must be called from a WebContents with the NotificationManager.init permission.
+         *
+         * Only one NotificationManager can be active at a time, calls to `init` will fail otherwise.
+         *
+         * If a WebContents with the NotificationManager active reloads or is closed, it will be possible to create a new one.
+         *
+         * @example
+         *
+         * ```js
+         * // From Provider context
+         * const notificationManager = await fin.NotificationManager.init();
+         * // NotificationManager is now active and will intercept all incoming notifications.
+         * ```
+         * @experimental
+         */
         this.init = async () => {
             const { payload: { data: { managerId } } } = await this.wire.sendAction('init-notification-manager');
             const manager = new instance_1.NotificationManagerInstance(this.wire, managerId);
@@ -17385,6 +17467,13 @@ factory.NotificationManagerModule = NotificationManagerModule;
 	    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 	};
 	Object.defineProperty(exports, "__esModule", { value: true });
+	/**
+	 * Entry point for the OpenFin `NotificationManager` API (`fin.NotificationManager`).
+	 *
+	 * * {@link NotificationManagerModule} contains static initialisation apis to create a {@link NotificationManagerInstance} instance.
+	 *
+	 * @packageDocumentation
+	 */
 	__exportStar(factory, exports);
 	__exportStar(instance, exports); 
 } (notificationManager));

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/core",
-    "version": "43.100.62",
+    "version": "43.100.64",
     "description": "The core renderer entry point of OpenFin",
     "license": "SEE LICENSE IN LICENSE.md",
     "main": "out/stub.js",