@openfin/core 25.70.4 → 25.70.7

package/OpenFin.d.ts

@@ -1443,7 +1443,7 @@ declare namespace OpenFin {
         topic: string,
         payload: unknown,
         senderIdentity: ProviderIdentity | OpenFin.ClientIdentity
-    ) => unknown;
+    ) => Promise<unknown> |unknown;
 
     export type ErrorMiddleware = (
         topic: string,
@@ -1536,6 +1536,27 @@ declare namespace OpenFin {
         presetType: LayoutPresetType;
     };
 
+
+    /**
+     * Leveraged by the following windowing apis to influence side effects of the positioning.
+     * - {@link  OpenFin.Window.moveBy} 
+     * - {@link  OpenFin.Window.moveTo} 
+     * - {@link  OpenFin.Window.setBounds} 
+     * - {@link  OpenFin.Window.resizeBy} 
+     * - {@link  OpenFin.Window.resizeTo} 
+     * @example ```js
+       fin.me.setBounds({top: 50, left: 50, width: 200, height: 200}, {skipRestore: true})
+     ```
+     */
+    export interface PositioningOptions {
+        /**
+         * Windows Only.
+         * If set to true, will not restore a maximized window before setting the bounds.
+         * This will have the effect of the maximized window staying maximized and not immediately taking this new position.
+         */
+        skipRestore?: boolean;
+    }
+
     export type SystemEvents = import('./src/api/events/system').SystemEvents;
 
     export type ApplicationEvents = import('./src/api/events/application').ApplicationEvents;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/core",
-    "version": "25.70.4",
+    "version": "25.70.7",
     "license": "Apache-2.0",
     "main": "./src/mock.js",
     "types": "./src/mock.d.ts",

package/src/api/interappbus/channel/channel.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ChannelBase = exports.ProtectedItems = void 0;
-const resultOrPayload = (func) => (topic, payload, senderIdentity) => {
-    const res = func(topic, payload, senderIdentity);
+const resultOrPayload = (func) => async (topic, payload, senderIdentity) => {
+    const res = await func(topic, payload, senderIdentity);
     return res === undefined ? payload : res;
 };
 class ProtectedItems {

package/src/api/interappbus/channel/provider.d.ts

@@ -3,7 +3,7 @@ import Transport from '../../../transport/transport';
 import { AnyStrategy } from './protocols/strategy-types';
 import ProviderIdentity = OpenFin.ProviderIdentity;
 import ClientIdentity = OpenFin.ClientIdentity;
-export declare type ConnectionListener = (identity: ClientIdentity, connectionMessage?: any) => any;
+export declare type ConnectionListener = (identity: ClientIdentity, connectionMessage?: any) => Promise<any> | any;
 export declare type DisconnectionListener = (identity: ClientIdentity) => any;
 export declare class ChannelProvider extends ChannelBase {
     #private;

package/src/api/interop/InteropBroker.d.ts

@@ -351,7 +351,7 @@ export declare class InteropBroker extends Base {
      * @param _id the identity tryinc to connect
      * @param _connectionPayload optional payload to use in custom implementations, will be undefined by default
      */
-    isConnectionAuthorized(_id: Identity, _connectionPayload?: any): Promise<boolean>;
+    isConnectionAuthorized(_id: Identity, _connectionPayload?: any): Promise<boolean> | boolean;
     /**
      * Called before every action to check if this entity should be allowed to take the action.
      * Return false to prevent the action
@@ -359,5 +359,5 @@ export declare class InteropBroker extends Base {
      * @param _payload the data being sent for this action
      * @param _identity the connection attempting to dispatch this action
      */
-    isActionAuthorized(_action: string, _payload: any, _identity: OpenFin.ClientIdentity): Promise<boolean>;
+    isActionAuthorized(_action: string, _payload: any, _identity: OpenFin.ClientIdentity): Promise<boolean> | boolean;
 }

package/src/api/interop/InteropBroker.js

@@ -828,8 +828,8 @@ class InteropBroker extends base_1.Base {
     }
     // Setup Channel Connection Logic
     wireChannel(channel) {
-        channel.onConnection((clientIdentity, payload) => {
-            if (!this.isConnectionAuthorized(clientIdentity, payload)) {
+        channel.onConnection(async (clientIdentity, payload) => {
+            if (!(await this.isConnectionAuthorized(clientIdentity, payload))) {
                 throw new Error(`Connection not authorized for ${clientIdentity.uuid}, ${clientIdentity.name}`);
             }
             if (!clientIdentity.endpointId) {
@@ -860,8 +860,8 @@ class InteropBroker extends base_1.Base {
         });
         // eslint-disable-next-line @typescript-eslint/ban-ts-ignore
         // @ts-ignore
-        channel.beforeAction((action, payload, clientIdentity) => {
-            if (!this.isActionAuthorized(action, payload, clientIdentity)) {
+        channel.beforeAction(async (action, payload, clientIdentity) => {
+            if (!(await this.isActionAuthorized(action, payload, clientIdentity))) {
                 throw new Error(`Action (${action}) not authorized for ${clientIdentity.uuid}, ${clientIdentity.name}`);
             }
             console.log(action, payload, clientIdentity);
@@ -891,11 +891,11 @@ class InteropBroker extends base_1.Base {
      * @param _id the identity tryinc to connect
      * @param _connectionPayload optional payload to use in custom implementations, will be undefined by default
      */
-    async isConnectionAuthorized(_id, _connectionPayload) {
+    isConnectionAuthorized(_id, _connectionPayload) {
         this.wire.sendAction('interop-broker-is-connection-authorized').catch((e) => {
             // don't expose, analytics-only call
         });
-        return true;
+        return Promise.resolve(true);
     }
     /**
      * Called before every action to check if this entity should be allowed to take the action.
@@ -904,11 +904,11 @@ class InteropBroker extends base_1.Base {
      * @param _payload the data being sent for this action
      * @param _identity the connection attempting to dispatch this action
      */
-    async isActionAuthorized(_action, _payload, _identity) {
+    isActionAuthorized(_action, _payload, _identity) {
         this.wire.sendAction('interop-broker-is-action-authorized').catch((e) => {
             // don't expose, analytics-only call
         });
-        return true;
+        return Promise.resolve(true);
     }
 }
 exports.InteropBroker = InteropBroker;

package/src/api/window/Instance.d.ts

@@ -840,7 +840,7 @@ export declare class _Window extends WebContents<WindowEvents> {
      * @return {Promise.<void>}
      * @tutorial Window.moveBy
      */
-    moveBy(deltaLeft: number, deltaTop: number): Promise<void>;
+    moveBy(deltaLeft: number, deltaTop: number, positioningOptions?: OpenFin.PositioningOptions): Promise<void>;
     /**
      * Moves the window to a specified location.
      * @param { number } left The left position of the window
@@ -848,7 +848,7 @@ export declare class _Window extends WebContents<WindowEvents> {
      * @return {Promise.<void>}
      * @tutorial Window.moveTo
      */
-    moveTo(left: number, top: number): Promise<void>;
+    moveTo(left: number, top: number, positioningOptions?: OpenFin.PositioningOptions): Promise<void>;
     /**
      * Resizes the window by a specified amount.
      * @param { number } deltaWidth The change in the width of the window
@@ -859,7 +859,7 @@ export declare class _Window extends WebContents<WindowEvents> {
      * @return {Promise.<void>}
      * @tutorial Window.resizeBy
      */
-    resizeBy(deltaWidth: number, deltaHeight: number, anchor: OpenFin.AnchorType): Promise<void>;
+    resizeBy(deltaWidth: number, deltaHeight: number, anchor: OpenFin.AnchorType, positioningOptions?: OpenFin.PositioningOptions): Promise<void>;
     /**
      * Resizes the window to the specified dimensions.
      * @param { number } width The change in the width of the window
@@ -870,7 +870,7 @@ export declare class _Window extends WebContents<WindowEvents> {
      * @return {Promise.<void>}
      * @tutorial Window.resizeTo
      */
-    resizeTo(width: number, height: number, anchor: OpenFin.AnchorType): Promise<void>;
+    resizeTo(width: number, height: number, anchor: OpenFin.AnchorType, positioningOptions?: OpenFin.PositioningOptions): Promise<void>;
     /**
      * Restores the window to its normal state (i.e., unminimized, unmaximized).
      * @return {Promise.<void>}
@@ -889,7 +889,7 @@ export declare class _Window extends WebContents<WindowEvents> {
      * @return {Promise.<void>}
      * @tutorial Window.setBounds
      */
-    setBounds(bounds: Partial<OpenFin.Bounds>): Promise<void>;
+    setBounds(bounds: Partial<OpenFin.Bounds>, positioningOptions?: OpenFin.PositioningOptions): Promise<void>;
     /**
      * Shows the window if it is hidden.
      * @param { boolean } [force = false] Show will be prevented from showing when force is false and

package/src/api/window/Instance.js

@@ -1014,11 +1014,12 @@ class _Window extends main_1.WebContents {
      * @return {Promise.<void>}
      * @tutorial Window.moveBy
      */
-    moveBy(deltaLeft, deltaTop) {
+    moveBy(deltaLeft, deltaTop, positioningOptions) {
         return this.wire
             .sendAction('move-window-by', {
             deltaLeft,
             deltaTop,
+            positioningOptions,
             ...this.identity
         })
             .then(() => undefined);
@@ -1030,11 +1031,12 @@ class _Window extends main_1.WebContents {
      * @return {Promise.<void>}
      * @tutorial Window.moveTo
      */
-    moveTo(left, top) {
+    moveTo(left, top, positioningOptions) {
         return this.wire
             .sendAction('move-window', {
             left,
             top,
+            positioningOptions,
             ...this.identity
         })
             .then(() => undefined);
@@ -1049,12 +1051,13 @@ class _Window extends main_1.WebContents {
      * @return {Promise.<void>}
      * @tutorial Window.resizeBy
      */
-    resizeBy(deltaWidth, deltaHeight, anchor) {
+    resizeBy(deltaWidth, deltaHeight, anchor, positioningOptions) {
         return this.wire
             .sendAction('resize-window-by', {
             deltaWidth: Math.floor(deltaWidth),
             deltaHeight: Math.floor(deltaHeight),
             anchor,
+            positioningOptions,
             ...this.identity
         })
             .then(() => undefined);
@@ -1069,12 +1072,13 @@ class _Window extends main_1.WebContents {
      * @return {Promise.<void>}
      * @tutorial Window.resizeTo
      */
-    resizeTo(width, height, anchor) {
+    resizeTo(width, height, anchor, positioningOptions) {
         return this.wire
             .sendAction('resize-window', {
             width: Math.floor(width),
             height: Math.floor(height),
             anchor,
+            positioningOptions,
             ...this.identity
         })
             .then(() => undefined);
@@ -1101,8 +1105,10 @@ class _Window extends main_1.WebContents {
      * @return {Promise.<void>}
      * @tutorial Window.setBounds
      */
-    setBounds(bounds) {
-        return this.wire.sendAction('set-window-bounds', { ...bounds, ...this.identity }).then(() => undefined);
+    setBounds(bounds, positioningOptions) {
+        return this.wire
+            .sendAction('set-window-bounds', { ...bounds, ...this.identity, positioningOptions })
+            .then(() => undefined);
     }
     /**
      * Shows the window if it is hidden.

package/src/shapes/protocol.d.ts

@@ -167,7 +167,36 @@ export interface ProtocolMap extends ProtocolMapBase {
         };
         response: OpenFin.QueryPermissionResult;
     };
+    'move-window-by': IdentityCall<WithPositioningOptions<{
+        deltaLeft: number;
+        deltaTop: number;
+    }>>;
+    'move-window': IdentityCall<WithPositioningOptions<{
+        left: number;
+        top: number;
+    }>>;
+    'resize-window-by': IdentityCall<WithPositioningOptions<{
+        deltaWidth: number;
+        deltaHeight: number;
+        anchor: OpenFin.AnchorType;
+    }>>;
+    'resize-window': IdentityCall<WithPositioningOptions<{
+        width: number;
+        height: number;
+        anchor: OpenFin.AnchorType;
+    }>>;
+    'set-window-bounds': IdentityCall<WithPositioningOptions<Partial<OpenFin.Bounds>>>;
 }
+export declare type ApiCall<Request, Response> = {
+    request: Request;
+    response: Response;
+};
+export declare type VoidCall = ApiCall<void, void>;
+export declare type GetterCall<T> = ApiCall<void, T>;
+export declare type WithPositioningOptions<AdditionalPayload = {}> = AdditionalPayload & {
+    positioningOptions: OpenFin.PositioningOptions;
+};
+export declare type IdentityCall<AdditionalPayload = {}, Response = void> = ApiCall<AdditionalPayload & OpenFin.Identity, Response>;
 interface ProtocolMapBase {
     [action: string]: {
         request: any;