@openfin/fdc3-api 42.100.90 → 42.100.93

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

@@ -5912,6 +5912,7 @@ declare interface FinApi<MeType extends OpenFin.EntityType> {
     readonly Platform: PlatformModule;
     readonly Interop: InteropModule;
     readonly SnapshotSource: SnapshotSourceModule;
+    readonly NotificationManager: NotificationManagerModule;
     /**
      * Provides access to the OpenFin representation of the current code context (usually an entity
      * such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
@@ -9534,6 +9535,7 @@ declare type MutableWindowOptions = {
     customData: any;
     /**
      * @defaultValue true
+     * @deprecated Will be removed in runtime version 45
      *
      * Show the window's frame.
      */
@@ -9800,6 +9802,29 @@ declare type NonPropagatedWindowEvent = never;
 
 /* Excluded from this release type: NotCloseRequested */
 
+declare type NotificationEvent = {
+    type: 'close' | 'click' | 'show';
+    notificationId: string;
+};
+
+declare class NotificationManagerInstance {
+    #private;
+    constructor(wire: Transport, id: string);
+    setNotificationHandler: (handler: NotificiationHandler) => Promise<void>;
+    destroy: () => Promise<void>;
+    dispatch: (event: NotificationEvent) => Promise<void>;
+}
+
+declare class NotificationManagerModule extends Base {
+    init: () => Promise<NotificationManagerInstance>;
+}
+
+declare type NotificationManagerPermissions = {
+    init: boolean;
+};
+
+declare type NotificiationHandler = (event: WebNotificationInfo) => void;
+
 /* Excluded from this release type: NotRequested */
 
 /**
@@ -9972,6 +9997,7 @@ declare namespace OpenFin {
         ApplicationPermissions,
         LaunchExternalProcessRule,
         SystemPermissions,
+        NotificationManagerPermissions,
         DevicePermissionName,
         WebPermissionName,
         WebPermission,
@@ -10208,6 +10234,11 @@ declare namespace OpenFin {
         RoutingInfo,
         DownloadShelfOptions,
         ViewShowAtOptions,
+        NotificationEvent,
+        NotificationManagerInstance,
+        NotificationManagerModule,
+        WebNotificationInfo,
+        WebNotificationProperties,
         ExtensionInfo,
         ServeRequest,
         AppAssetServeRequest,
@@ -10502,6 +10533,7 @@ declare type Permissions_2 = {
     Clipboard?: Partial<ClipboardApiPermissions>;
     webAPIs?: WebPermission[];
     devices?: DeviceInfo[];
+    NotificationManager?: Partial<NotificationManagerPermissions>;
 };
 
 declare type PermissionState_2 = 'granted' | 'denied' | 'unavailable';
@@ -12670,6 +12702,10 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
         transitions: OpenFin.Transition;
         options: OpenFin.TransitionOptions;
     }>;
+    'activate-window-and-focus': ApiCall<{
+        winIdentity: OpenFin.Identity;
+        focusIdentity: OpenFin.Identity;
+    }, boolean>;
     'get-all-frames': IdentityCall<{}, OpenFin.FrameInfo[]>;
     'get-window-bounds': IdentityCall<{
         options?: OpenFin.GetBoundsOptions;
@@ -13292,6 +13328,28 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
         };
         response: void;
     };
+    'dispatch-notification-event': {
+        request: {
+            notificationId: string;
+            type: 'close' | 'show' | 'click';
+        };
+        response: void;
+    };
+    'init-notification-manager': {
+        request: {};
+        response: {
+            managerId: string;
+        };
+        apiPath: '.init';
+        secure: true;
+        namespace: 'NotificationManager';
+    };
+    'destroy-notification-manager': {
+        request: {
+            managerId: string;
+        };
+        response: void;
+    };
 };
 
 declare type ProtocolOffer = ClassicProtocolOffer | RTCProtocolOffer;
@@ -18266,6 +18324,19 @@ declare namespace WebContentsEvents {
     }
 }
 
+declare type WebNotificationInfo = {
+    notificationId: string;
+    properties: WebNotificationProperties;
+    url: string;
+    images: {
+        icon?: string;
+        badge?: string;
+        image?: string;
+    };
+};
+
+declare type WebNotificationProperties = Pick<Notification, 'tag' | 'body' | 'data' | 'dir' | 'icon' | 'lang' | 'title'>;
+
 /**
  * Defines the type of requested web APIs permission.
  *
@@ -18408,6 +18479,30 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
      * ```
      */
     getAllFrames(): Promise<Array<OpenFin.FrameInfo>>;
+    /**
+     * Activates the current window and focuses the child entity if it exists. If this does
+     * not succeed - say the child does not belong to this window, or the identity does not exist -
+     * it will return false.
+     *
+     * @example
+     * ```js
+     * const win = fin.Window.wrapSync({ uuid: 'myApp', name: 'myOtherWindow' });
+     *
+     * win.getCurrentViews()
+     *   .then(([view1]) => {
+     *      return win.activateAndFocus(view1.identity);
+     *   })
+     *   .then(success => {
+     *     if (success) {
+     *        console.log('Window activated and child focused');
+     *     } else {
+     *        console.log('Window activation failed, focus state unchanged');
+     *     }
+     *   })
+     *   .catch(console.error);
+     * ```
+     */
+    activateAndFocus(childIdentityToFocus: OpenFin.Identity): Promise<boolean>;
     /**
      * Gets the current bounds (top, bottom, right, left, width, height) of the window.
      *

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

@@ -5912,6 +5912,7 @@ declare interface FinApi<MeType extends OpenFin.EntityType> {
     readonly Platform: PlatformModule;
     readonly Interop: InteropModule;
     readonly SnapshotSource: SnapshotSourceModule;
+    readonly NotificationManager: NotificationManagerModule;
     /**
      * Provides access to the OpenFin representation of the current code context (usually an entity
      * such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
@@ -9534,6 +9535,7 @@ declare type MutableWindowOptions = {
     customData: any;
     /**
      * @defaultValue true
+     * @deprecated Will be removed in runtime version 45
      *
      * Show the window's frame.
      */
@@ -9800,6 +9802,29 @@ declare type NonPropagatedWindowEvent = never;
 
 /* Excluded from this release type: NotCloseRequested */
 
+declare type NotificationEvent = {
+    type: 'close' | 'click' | 'show';
+    notificationId: string;
+};
+
+declare class NotificationManagerInstance {
+    #private;
+    constructor(wire: Transport, id: string);
+    setNotificationHandler: (handler: NotificiationHandler) => Promise<void>;
+    destroy: () => Promise<void>;
+    dispatch: (event: NotificationEvent) => Promise<void>;
+}
+
+declare class NotificationManagerModule extends Base {
+    init: () => Promise<NotificationManagerInstance>;
+}
+
+declare type NotificationManagerPermissions = {
+    init: boolean;
+};
+
+declare type NotificiationHandler = (event: WebNotificationInfo) => void;
+
 /* Excluded from this release type: NotRequested */
 
 /**
@@ -9972,6 +9997,7 @@ declare namespace OpenFin {
         ApplicationPermissions,
         LaunchExternalProcessRule,
         SystemPermissions,
+        NotificationManagerPermissions,
         DevicePermissionName,
         WebPermissionName,
         WebPermission,
@@ -10208,6 +10234,11 @@ declare namespace OpenFin {
         RoutingInfo,
         DownloadShelfOptions,
         ViewShowAtOptions,
+        NotificationEvent,
+        NotificationManagerInstance,
+        NotificationManagerModule,
+        WebNotificationInfo,
+        WebNotificationProperties,
         ExtensionInfo,
         ServeRequest,
         AppAssetServeRequest,
@@ -10502,6 +10533,7 @@ declare type Permissions_2 = {
     Clipboard?: Partial<ClipboardApiPermissions>;
     webAPIs?: WebPermission[];
     devices?: DeviceInfo[];
+    NotificationManager?: Partial<NotificationManagerPermissions>;
 };
 
 declare type PermissionState_2 = 'granted' | 'denied' | 'unavailable';
@@ -12670,6 +12702,10 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
         transitions: OpenFin.Transition;
         options: OpenFin.TransitionOptions;
     }>;
+    'activate-window-and-focus': ApiCall<{
+        winIdentity: OpenFin.Identity;
+        focusIdentity: OpenFin.Identity;
+    }, boolean>;
     'get-all-frames': IdentityCall<{}, OpenFin.FrameInfo[]>;
     'get-window-bounds': IdentityCall<{
         options?: OpenFin.GetBoundsOptions;
@@ -13292,6 +13328,28 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
         };
         response: void;
     };
+    'dispatch-notification-event': {
+        request: {
+            notificationId: string;
+            type: 'close' | 'show' | 'click';
+        };
+        response: void;
+    };
+    'init-notification-manager': {
+        request: {};
+        response: {
+            managerId: string;
+        };
+        apiPath: '.init';
+        secure: true;
+        namespace: 'NotificationManager';
+    };
+    'destroy-notification-manager': {
+        request: {
+            managerId: string;
+        };
+        response: void;
+    };
 };
 
 declare type ProtocolOffer = ClassicProtocolOffer | RTCProtocolOffer;
@@ -18266,6 +18324,19 @@ declare namespace WebContentsEvents {
     }
 }
 
+declare type WebNotificationInfo = {
+    notificationId: string;
+    properties: WebNotificationProperties;
+    url: string;
+    images: {
+        icon?: string;
+        badge?: string;
+        image?: string;
+    };
+};
+
+declare type WebNotificationProperties = Pick<Notification, 'tag' | 'body' | 'data' | 'dir' | 'icon' | 'lang' | 'title'>;
+
 /**
  * Defines the type of requested web APIs permission.
  *
@@ -18408,6 +18479,30 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
      * ```
      */
     getAllFrames(): Promise<Array<OpenFin.FrameInfo>>;
+    /**
+     * Activates the current window and focuses the child entity if it exists. If this does
+     * not succeed - say the child does not belong to this window, or the identity does not exist -
+     * it will return false.
+     *
+     * @example
+     * ```js
+     * const win = fin.Window.wrapSync({ uuid: 'myApp', name: 'myOtherWindow' });
+     *
+     * win.getCurrentViews()
+     *   .then(([view1]) => {
+     *      return win.activateAndFocus(view1.identity);
+     *   })
+     *   .then(success => {
+     *     if (success) {
+     *        console.log('Window activated and child focused');
+     *     } else {
+     *        console.log('Window activation failed, focus state unchanged');
+     *     }
+     *   })
+     *   .catch(console.error);
+     * ```
+     */
+    activateAndFocus(childIdentityToFocus: OpenFin.Identity): Promise<boolean>;
     /**
      * Gets the current bounds (top, bottom, right, left, width, height) of the window.
      *

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

@@ -5912,6 +5912,7 @@ declare interface FinApi<MeType extends OpenFin.EntityType> {
     readonly Platform: PlatformModule;
     readonly Interop: InteropModule;
     readonly SnapshotSource: SnapshotSourceModule;
+    readonly NotificationManager: NotificationManagerModule;
     /**
      * Provides access to the OpenFin representation of the current code context (usually an entity
      * such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
@@ -9534,6 +9535,7 @@ declare type MutableWindowOptions = {
     customData: any;
     /**
      * @defaultValue true
+     * @deprecated Will be removed in runtime version 45
      *
      * Show the window's frame.
      */
@@ -9800,6 +9802,29 @@ declare type NonPropagatedWindowEvent = never;
 
 /* Excluded from this release type: NotCloseRequested */
 
+declare type NotificationEvent = {
+    type: 'close' | 'click' | 'show';
+    notificationId: string;
+};
+
+declare class NotificationManagerInstance {
+    #private;
+    constructor(wire: Transport, id: string);
+    setNotificationHandler: (handler: NotificiationHandler) => Promise<void>;
+    destroy: () => Promise<void>;
+    dispatch: (event: NotificationEvent) => Promise<void>;
+}
+
+declare class NotificationManagerModule extends Base {
+    init: () => Promise<NotificationManagerInstance>;
+}
+
+declare type NotificationManagerPermissions = {
+    init: boolean;
+};
+
+declare type NotificiationHandler = (event: WebNotificationInfo) => void;
+
 /* Excluded from this release type: NotRequested */
 
 /**
@@ -9972,6 +9997,7 @@ declare namespace OpenFin {
         ApplicationPermissions,
         LaunchExternalProcessRule,
         SystemPermissions,
+        NotificationManagerPermissions,
         DevicePermissionName,
         WebPermissionName,
         WebPermission,
@@ -10208,6 +10234,11 @@ declare namespace OpenFin {
         RoutingInfo,
         DownloadShelfOptions,
         ViewShowAtOptions,
+        NotificationEvent,
+        NotificationManagerInstance,
+        NotificationManagerModule,
+        WebNotificationInfo,
+        WebNotificationProperties,
         ExtensionInfo,
         ServeRequest,
         AppAssetServeRequest,
@@ -10502,6 +10533,7 @@ declare type Permissions_2 = {
     Clipboard?: Partial<ClipboardApiPermissions>;
     webAPIs?: WebPermission[];
     devices?: DeviceInfo[];
+    NotificationManager?: Partial<NotificationManagerPermissions>;
 };
 
 declare type PermissionState_2 = 'granted' | 'denied' | 'unavailable';
@@ -12670,6 +12702,10 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
         transitions: OpenFin.Transition;
         options: OpenFin.TransitionOptions;
     }>;
+    'activate-window-and-focus': ApiCall<{
+        winIdentity: OpenFin.Identity;
+        focusIdentity: OpenFin.Identity;
+    }, boolean>;
     'get-all-frames': IdentityCall<{}, OpenFin.FrameInfo[]>;
     'get-window-bounds': IdentityCall<{
         options?: OpenFin.GetBoundsOptions;
@@ -13292,6 +13328,28 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
         };
         response: void;
     };
+    'dispatch-notification-event': {
+        request: {
+            notificationId: string;
+            type: 'close' | 'show' | 'click';
+        };
+        response: void;
+    };
+    'init-notification-manager': {
+        request: {};
+        response: {
+            managerId: string;
+        };
+        apiPath: '.init';
+        secure: true;
+        namespace: 'NotificationManager';
+    };
+    'destroy-notification-manager': {
+        request: {
+            managerId: string;
+        };
+        response: void;
+    };
 };
 
 declare type ProtocolOffer = ClassicProtocolOffer | RTCProtocolOffer;
@@ -18266,6 +18324,19 @@ declare namespace WebContentsEvents {
     }
 }
 
+declare type WebNotificationInfo = {
+    notificationId: string;
+    properties: WebNotificationProperties;
+    url: string;
+    images: {
+        icon?: string;
+        badge?: string;
+        image?: string;
+    };
+};
+
+declare type WebNotificationProperties = Pick<Notification, 'tag' | 'body' | 'data' | 'dir' | 'icon' | 'lang' | 'title'>;
+
 /**
  * Defines the type of requested web APIs permission.
  *
@@ -18408,6 +18479,30 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
      * ```
      */
     getAllFrames(): Promise<Array<OpenFin.FrameInfo>>;
+    /**
+     * Activates the current window and focuses the child entity if it exists. If this does
+     * not succeed - say the child does not belong to this window, or the identity does not exist -
+     * it will return false.
+     *
+     * @example
+     * ```js
+     * const win = fin.Window.wrapSync({ uuid: 'myApp', name: 'myOtherWindow' });
+     *
+     * win.getCurrentViews()
+     *   .then(([view1]) => {
+     *      return win.activateAndFocus(view1.identity);
+     *   })
+     *   .then(success => {
+     *     if (success) {
+     *        console.log('Window activated and child focused');
+     *     } else {
+     *        console.log('Window activation failed, focus state unchanged');
+     *     }
+     *   })
+     *   .catch(console.error);
+     * ```
+     */
+    activateAndFocus(childIdentityToFocus: OpenFin.Identity): Promise<boolean>;
     /**
      * Gets the current bounds (top, bottom, right, left, width, height) of the window.
      *

package/out/fdc3-api.d.ts

@@ -5997,6 +5997,7 @@ declare interface FinApi<MeType extends OpenFin.EntityType> {
     readonly Platform: PlatformModule;
     readonly Interop: InteropModule;
     readonly SnapshotSource: SnapshotSourceModule;
+    readonly NotificationManager: NotificationManagerModule;
     /**
      * Provides access to the OpenFin representation of the current code context (usually an entity
      * such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
@@ -9834,6 +9835,7 @@ declare type MutableWindowOptions = {
     customData: any;
     /**
      * @defaultValue true
+     * @deprecated Will be removed in runtime version 45
      *
      * Show the window's frame.
      */
@@ -10113,6 +10115,29 @@ declare type NonPropagatedWindowEvent = never;
  */
 declare type NotCloseRequested<EventType extends string> = Exclude<EventType, 'close-requested'>;
 
+declare type NotificationEvent = {
+    type: 'close' | 'click' | 'show';
+    notificationId: string;
+};
+
+declare class NotificationManagerInstance {
+    #private;
+    constructor(wire: Transport, id: string);
+    setNotificationHandler: (handler: NotificiationHandler) => Promise<void>;
+    destroy: () => Promise<void>;
+    dispatch: (event: NotificationEvent) => Promise<void>;
+}
+
+declare class NotificationManagerModule extends Base {
+    init: () => Promise<NotificationManagerInstance>;
+}
+
+declare type NotificationManagerPermissions = {
+    init: boolean;
+};
+
+declare type NotificiationHandler = (event: WebNotificationInfo) => void;
+
 /**
  * @internal
  *
@@ -10290,6 +10315,7 @@ declare namespace OpenFin {
         ApplicationPermissions,
         LaunchExternalProcessRule,
         SystemPermissions,
+        NotificationManagerPermissions,
         DevicePermissionName,
         WebPermissionName,
         WebPermission,
@@ -10526,6 +10552,11 @@ declare namespace OpenFin {
         RoutingInfo,
         DownloadShelfOptions,
         ViewShowAtOptions,
+        NotificationEvent,
+        NotificationManagerInstance,
+        NotificationManagerModule,
+        WebNotificationInfo,
+        WebNotificationProperties,
         ExtensionInfo,
         ServeRequest,
         AppAssetServeRequest,
@@ -10820,6 +10851,7 @@ declare type Permissions_2 = {
     Clipboard?: Partial<ClipboardApiPermissions>;
     webAPIs?: WebPermission[];
     devices?: DeviceInfo[];
+    NotificationManager?: Partial<NotificationManagerPermissions>;
 };
 
 declare type PermissionState_2 = 'granted' | 'denied' | 'unavailable';
@@ -13071,6 +13103,10 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
         transitions: OpenFin.Transition;
         options: OpenFin.TransitionOptions;
     }>;
+    'activate-window-and-focus': ApiCall<{
+        winIdentity: OpenFin.Identity;
+        focusIdentity: OpenFin.Identity;
+    }, boolean>;
     'get-all-frames': IdentityCall<{}, OpenFin.FrameInfo[]>;
     'get-window-bounds': IdentityCall<{
         options?: OpenFin.GetBoundsOptions;
@@ -13693,6 +13729,28 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
         };
         response: void;
     };
+    'dispatch-notification-event': {
+        request: {
+            notificationId: string;
+            type: 'close' | 'show' | 'click';
+        };
+        response: void;
+    };
+    'init-notification-manager': {
+        request: {};
+        response: {
+            managerId: string;
+        };
+        apiPath: '.init';
+        secure: true;
+        namespace: 'NotificationManager';
+    };
+    'destroy-notification-manager': {
+        request: {
+            managerId: string;
+        };
+        response: void;
+    };
 };
 
 declare type ProtocolOffer = ClassicProtocolOffer | RTCProtocolOffer;
@@ -18717,6 +18775,19 @@ declare namespace WebContentsEvents {
     }
 }
 
+declare type WebNotificationInfo = {
+    notificationId: string;
+    properties: WebNotificationProperties;
+    url: string;
+    images: {
+        icon?: string;
+        badge?: string;
+        image?: string;
+    };
+};
+
+declare type WebNotificationProperties = Pick<Notification, 'tag' | 'body' | 'data' | 'dir' | 'icon' | 'lang' | 'title'>;
+
 /**
  * Defines the type of requested web APIs permission.
  *
@@ -18862,6 +18933,30 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
      * ```
      */
     getAllFrames(): Promise<Array<OpenFin.FrameInfo>>;
+    /**
+     * Activates the current window and focuses the child entity if it exists. If this does
+     * not succeed - say the child does not belong to this window, or the identity does not exist -
+     * it will return false.
+     *
+     * @example
+     * ```js
+     * const win = fin.Window.wrapSync({ uuid: 'myApp', name: 'myOtherWindow' });
+     *
+     * win.getCurrentViews()
+     *   .then(([view1]) => {
+     *      return win.activateAndFocus(view1.identity);
+     *   })
+     *   .then(success => {
+     *     if (success) {
+     *        console.log('Window activated and child focused');
+     *     } else {
+     *        console.log('Window activation failed, focus state unchanged');
+     *     }
+     *   })
+     *   .catch(console.error);
+     * ```
+     */
+    activateAndFocus(childIdentityToFocus: OpenFin.Identity): Promise<boolean>;
     /**
      * Gets the current bounds (top, bottom, right, left, width, height) of the window.
      *

package/package.json

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