@openfin/core 42.100.91 → 42.100.94

package/out/mock-public.d.ts

@@ -5570,6 +5570,7 @@ declare interface FinApi<MeType extends OpenFin_2.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.
@@ -8661,19 +8662,74 @@ declare type LogInfo = {
  */
 declare type LogLevel = 'verbose' | 'info' | 'warning' | 'error' | 'fatal';
 
+/**
+ * Options for the Log Uploader.
+ */
+declare type LogUploaderOptions = LogUploadOptions & {
+    ui?: LogUploaderUIOptions & {
+        /**
+         * Whether the Log Uploader UI should be shown.
+         * @defaultValue true
+         */
+        show?: boolean;
+    };
+};
+
+/**
+ * Options for the Log Uploader UI.
+ * @interface
+ */
 declare type LogUploaderUIOptions = {
+    /**
+     * Title for the Log Uploader window.
+     * @defaultValue 'Here Log Uploader'
+     */
     title?: string;
+    /**
+     * URL of an icon to use for the Log Uploader tool. The default is the Here logo.
+     */
     icon?: string;
+    /**
+     * Name of the organization displayed in the Uploader window.
+     * @defaultValue 'Here'
+     */
     header?: string;
+    /**
+     * An explanation for the user of the purpose of the tool.
+     * @defaultValue 'The following logs are being requested'
+     */
     description?: string;
+    /**
+     * An email address that the user can contact with questions.
+     * @defaultValue 'support@here.io'
+     */
     email?: string;
+    /**
+     * URL of a webpage where the user can find more information about log uploading.
+     * @defaultValue 'https://resources.here.io/docs/core/manage/security/'
+     */
     website?: string;
+    /**
+     * Description of the webpage where the user can find more information.
+     * @defaultValue 'Here Security'
+     */
     websiteDescription?: string;
 };
 
 declare type LogUploadOptions = {
+    /**
+     * The URL where log files are to be uploaded.
+     */
     endpoint: string;
+    /**
+     * An array of URL match patterns to define the manifests of the programs that the Log Uploader should upload logs for.
+     * @defaultValue []
+     */
     manifests?: string[];
+    /**
+     * An array of strings that specifies which logs should be uploaded.
+     * @defaultValue ['app', 'rvm', 'debug']
+     */
     logs?: string[];
     ui?: LogUploaderUIOptions;
 };
@@ -9459,6 +9515,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 */
 
 /**
@@ -9631,6 +9710,7 @@ declare namespace OpenFin_2 {
         ApplicationPermissions,
         LaunchExternalProcessRule,
         SystemPermissions,
+        NotificationManagerPermissions,
         DevicePermissionName,
         WebPermissionName,
         WebPermission,
@@ -9644,6 +9724,7 @@ declare namespace OpenFin_2 {
         PlatformViewCreationOptions,
         ProcessAffinityStrategy,
         PlatformOptions,
+        LogUploaderOptions,
         LogUploaderUIOptions,
         LogUploadOptions,
         Manifest,
@@ -9867,6 +9948,11 @@ declare namespace OpenFin_2 {
         RoutingInfo,
         DownloadShelfOptions,
         ViewShowAtOptions,
+        NotificationEvent,
+        NotificationManagerInstance,
+        NotificationManagerModule,
+        WebNotificationInfo,
+        WebNotificationProperties,
         ExtensionInfo,
         ServeRequest,
         AppAssetServeRequest,
@@ -10163,6 +10249,7 @@ declare type Permissions_2 = {
     Clipboard?: Partial<ClipboardApiPermissions>;
     webAPIs?: WebPermission[];
     devices?: DeviceInfo[];
+    NotificationManager?: Partial<NotificationManagerPermissions>;
 };
 
 declare type PermissionState_2 = 'granted' | 'denied' | 'unavailable';
@@ -12331,6 +12418,10 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
         transitions: OpenFin_2.Transition;
         options: OpenFin_2.TransitionOptions;
     }>;
+    'activate-window-and-focus': ApiCall<{
+        winIdentity: OpenFin_2.Identity;
+        focusIdentity: OpenFin_2.Identity;
+    }, boolean>;
     'get-all-frames': IdentityCall<{}, OpenFin_2.FrameInfo[]>;
     'get-window-bounds': IdentityCall<{
         options?: OpenFin_2.GetBoundsOptions;
@@ -12953,6 +13044,34 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
         };
         response: void;
     };
+    'launch-log-uploader': ApiCall<{
+        options: OpenFin_2.LogUploaderOptions;
+    }, void> & {
+        apiPath: '.launchLogUploader';
+        namespace: 'System';
+    };
+    '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;
@@ -15477,6 +15596,10 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
      * Not indended for general use, will be used by the `@openfin/workspace-platform` package.
      */
     serveAsset(options: OpenFin_2.ServeAssetOptions): Promise<OpenFin_2.ServedAssetInfo>;
+    /**
+     * Launches the Log Uploader. Full documentation can be found [here](https://resources.here.io/docs/core/develop/debug/log-uploader/).
+     */
+    launchLogUploader(options: OpenFin_2.LogUploaderOptions): Promise<void>;
 }
 
 /**
@@ -17821,6 +17944,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.
  *
@@ -17963,6 +18099,30 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
      * ```
      */
     getAllFrames(): Promise<Array<OpenFin_2.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_2.Identity): Promise<boolean>;
     /**
      * Gets the current bounds (top, bottom, right, left, width, height) of the window.
      *

package/out/stub.d.ts

@@ -5655,6 +5655,7 @@ declare interface FinApi<MeType extends OpenFin_2.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.
@@ -8957,19 +8958,74 @@ declare type LogInfo = {
  */
 declare type LogLevel = 'verbose' | 'info' | 'warning' | 'error' | 'fatal';
 
+/**
+ * Options for the Log Uploader.
+ */
+declare type LogUploaderOptions = LogUploadOptions & {
+    ui?: LogUploaderUIOptions & {
+        /**
+         * Whether the Log Uploader UI should be shown.
+         * @defaultValue true
+         */
+        show?: boolean;
+    };
+};
+
+/**
+ * Options for the Log Uploader UI.
+ * @interface
+ */
 declare type LogUploaderUIOptions = {
+    /**
+     * Title for the Log Uploader window.
+     * @defaultValue 'Here Log Uploader'
+     */
     title?: string;
+    /**
+     * URL of an icon to use for the Log Uploader tool. The default is the Here logo.
+     */
     icon?: string;
+    /**
+     * Name of the organization displayed in the Uploader window.
+     * @defaultValue 'Here'
+     */
     header?: string;
+    /**
+     * An explanation for the user of the purpose of the tool.
+     * @defaultValue 'The following logs are being requested'
+     */
     description?: string;
+    /**
+     * An email address that the user can contact with questions.
+     * @defaultValue 'support@here.io'
+     */
     email?: string;
+    /**
+     * URL of a webpage where the user can find more information about log uploading.
+     * @defaultValue 'https://resources.here.io/docs/core/manage/security/'
+     */
     website?: string;
+    /**
+     * Description of the webpage where the user can find more information.
+     * @defaultValue 'Here Security'
+     */
     websiteDescription?: string;
 };
 
 declare type LogUploadOptions = {
+    /**
+     * The URL where log files are to be uploaded.
+     */
     endpoint: string;
+    /**
+     * An array of URL match patterns to define the manifests of the programs that the Log Uploader should upload logs for.
+     * @defaultValue []
+     */
     manifests?: string[];
+    /**
+     * An array of strings that specifies which logs should be uploaded.
+     * @defaultValue ['app', 'rvm', 'debug']
+     */
     logs?: string[];
     ui?: LogUploaderUIOptions;
 };
@@ -9772,6 +9828,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
  *
@@ -9949,6 +10028,7 @@ declare namespace OpenFin_2 {
         ApplicationPermissions,
         LaunchExternalProcessRule,
         SystemPermissions,
+        NotificationManagerPermissions,
         DevicePermissionName,
         WebPermissionName,
         WebPermission,
@@ -9962,6 +10042,7 @@ declare namespace OpenFin_2 {
         PlatformViewCreationOptions,
         ProcessAffinityStrategy,
         PlatformOptions,
+        LogUploaderOptions,
         LogUploaderUIOptions,
         LogUploadOptions,
         Manifest,
@@ -10185,6 +10266,11 @@ declare namespace OpenFin_2 {
         RoutingInfo,
         DownloadShelfOptions,
         ViewShowAtOptions,
+        NotificationEvent,
+        NotificationManagerInstance,
+        NotificationManagerModule,
+        WebNotificationInfo,
+        WebNotificationProperties,
         ExtensionInfo,
         ServeRequest,
         AppAssetServeRequest,
@@ -10481,6 +10567,7 @@ declare type Permissions_2 = {
     Clipboard?: Partial<ClipboardApiPermissions>;
     webAPIs?: WebPermission[];
     devices?: DeviceInfo[];
+    NotificationManager?: Partial<NotificationManagerPermissions>;
 };
 
 declare type PermissionState_2 = 'granted' | 'denied' | 'unavailable';
@@ -12732,6 +12819,10 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
         transitions: OpenFin_2.Transition;
         options: OpenFin_2.TransitionOptions;
     }>;
+    'activate-window-and-focus': ApiCall<{
+        winIdentity: OpenFin_2.Identity;
+        focusIdentity: OpenFin_2.Identity;
+    }, boolean>;
     'get-all-frames': IdentityCall<{}, OpenFin_2.FrameInfo[]>;
     'get-window-bounds': IdentityCall<{
         options?: OpenFin_2.GetBoundsOptions;
@@ -13354,6 +13445,34 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
         };
         response: void;
     };
+    'launch-log-uploader': ApiCall<{
+        options: OpenFin_2.LogUploaderOptions;
+    }, void> & {
+        apiPath: '.launchLogUploader';
+        namespace: 'System';
+    };
+    '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;
@@ -15884,6 +16003,10 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
      * Not indended for general use, will be used by the `@openfin/workspace-platform` package.
      */
     serveAsset(options: OpenFin_2.ServeAssetOptions): Promise<OpenFin_2.ServedAssetInfo>;
+    /**
+     * Launches the Log Uploader. Full documentation can be found [here](https://resources.here.io/docs/core/develop/debug/log-uploader/).
+     */
+    launchLogUploader(options: OpenFin_2.LogUploaderOptions): Promise<void>;
 }
 
 /**
@@ -18272,6 +18395,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.
  *
@@ -18417,6 +18553,30 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
      * ```
      */
     getAllFrames(): Promise<Array<OpenFin_2.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_2.Identity): Promise<boolean>;
     /**
      * Gets the current bounds (top, bottom, right, left, width, height) of the window.
      *