@openfin/remote-adapter 42.100.102 → 42.100.105

package/out/remote-adapter.js

@@ -17514,7 +17514,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);
@@ -17544,13 +17561,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(this, _NotificationManagerInstance_isReceivingNotifications, "f").getValue();
             __classPrivateFieldSet(this, _NotificationManagerInstance_handler, handler, "f");
         };
+        /**
+         * Destroys the current NotificationManagerInstance.
+         *
+         * @example
+         * ```typescript
+         * await notificationManager.destroy();
+         * ```
+         */
         this.destroy = async () => {
             await __classPrivateFieldGet(this, _NotificationManagerInstance_wire, "f").sendAction('destroy-notification-manager', { managerId: __classPrivateFieldGet(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(this, _NotificationManagerInstance_wire, "f").sendAction('dispatch-notification-event', {
@@ -17572,6 +17636,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);
@@ -17597,6 +17679,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/remote-adapter",
-    "version": "42.100.102",
+    "version": "42.100.105",
     "description": "Establish intermachine runtime connections using webRTC.",
     "license": "SEE LICENSE IN LICENSE.md",
     "private": false,
@@ -20,6 +20,6 @@
     "author": "OpenFin",
     "dependencies": {
         "lodash": "^4.17.21",
-        "@openfin/core": "42.100.102"
+        "@openfin/core": "42.100.105"
     }
 }