@openfin/fdc3-api 43.100.62 → 43.100.64

package/out/fdc3-api-alpha.d.ts

@@ -9899,15 +9899,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.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.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>;
 }
 
@@ -9915,8 +9996,6 @@ declare type NotificationManagerPermissions = {
     init: boolean;
 };
 
-declare type NotificiationHandler = (event: WebNotificationInfo) => void;
-
 /* Excluded from this release type: NotRequested */
 
 /**
@@ -10329,11 +10408,12 @@ declare namespace OpenFin {
         RoutingInfo,
         DownloadShelfOptions,
         ViewShowAtOptions,
+        WebNotificationProperties,
+        WebNotificationInfo,
         NotificationEvent,
+        NotificationHandler,
         NotificationManagerInstance,
         NotificationManagerModule,
-        WebNotificationInfo,
-        WebNotificationProperties,
         ExtensionInfo,
         ServeRequest,
         AppAssetServeRequest,

package/out/fdc3-api-beta.d.ts

@@ -9899,15 +9899,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.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.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>;
 }
 
@@ -9915,8 +9996,6 @@ declare type NotificationManagerPermissions = {
     init: boolean;
 };
 
-declare type NotificiationHandler = (event: WebNotificationInfo) => void;
-
 /* Excluded from this release type: NotRequested */
 
 /**
@@ -10329,11 +10408,12 @@ declare namespace OpenFin {
         RoutingInfo,
         DownloadShelfOptions,
         ViewShowAtOptions,
+        WebNotificationProperties,
+        WebNotificationInfo,
         NotificationEvent,
+        NotificationHandler,
         NotificationManagerInstance,
         NotificationManagerModule,
-        WebNotificationInfo,
-        WebNotificationProperties,
         ExtensionInfo,
         ServeRequest,
         AppAssetServeRequest,

package/out/fdc3-api-public.d.ts

@@ -9899,15 +9899,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.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.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>;
 }
 
@@ -9915,8 +9996,6 @@ declare type NotificationManagerPermissions = {
     init: boolean;
 };
 
-declare type NotificiationHandler = (event: WebNotificationInfo) => void;
-
 /* Excluded from this release type: NotRequested */
 
 /**
@@ -10329,11 +10408,12 @@ declare namespace OpenFin {
         RoutingInfo,
         DownloadShelfOptions,
         ViewShowAtOptions,
+        WebNotificationProperties,
+        WebNotificationInfo,
         NotificationEvent,
+        NotificationHandler,
         NotificationManagerInstance,
         NotificationManagerModule,
-        WebNotificationInfo,
-        WebNotificationProperties,
         ExtensionInfo,
         ServeRequest,
         AppAssetServeRequest,

package/out/fdc3-api.d.ts

@@ -10225,15 +10225,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.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.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>;
 }
 
@@ -10241,8 +10325,6 @@ declare type NotificationManagerPermissions = {
     init: boolean;
 };
 
-declare type NotificiationHandler = (event: WebNotificationInfo) => void;
-
 /**
  * @internal
  *
@@ -10660,11 +10742,12 @@ declare namespace OpenFin {
         RoutingInfo,
         DownloadShelfOptions,
         ViewShowAtOptions,
+        WebNotificationProperties,
+        WebNotificationInfo,
         NotificationEvent,
+        NotificationHandler,
         NotificationManagerInstance,
         NotificationManagerModule,
-        WebNotificationInfo,
-        WebNotificationProperties,
         ExtensionInfo,
         ServeRequest,
         AppAssetServeRequest,

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/fdc3-api",
-    "version": "43.100.62",
+    "version": "43.100.64",
     "description": "OpenFin fdc3 module utilities and types.",
     "license": "SEE LICENSE IN LICENSE.md",
     "private": false,