@openfin/core 32.76.10 → 32.76.17

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/core",
-    "version": "32.76.10",
+    "version": "32.76.17",
     "license": "SEE LICENSE IN LICENSE.MD",
     "main": "./src/mock.js",
     "types": "./src/mock.d.ts",

package/src/OpenFin.d.ts

@@ -3033,3 +3033,22 @@ export interface CapturePageOptions {
      */
     quality?: number;
 }
+/**
+ * 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;
+}

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

@@ -912,7 +912,7 @@ export declare class _Window extends WebContents<OpenFin.WindowEvent> {
      * @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
@@ -920,7 +920,7 @@ export declare class _Window extends WebContents<OpenFin.WindowEvent> {
      * @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
@@ -931,7 +931,7 @@ export declare class _Window extends WebContents<OpenFin.WindowEvent> {
      * @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
@@ -942,7 +942,7 @@ export declare class _Window extends WebContents<OpenFin.WindowEvent> {
      * @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>}
@@ -961,7 +961,7 @@ export declare class _Window extends WebContents<OpenFin.WindowEvent> {
      * @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

@@ -1091,11 +1091,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);
@@ -1107,11 +1108,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);
@@ -1126,12 +1128,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);
@@ -1146,12 +1149,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);
@@ -1178,8 +1182,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

@@ -164,7 +164,29 @@ export interface ProtocolMap extends ProtocolMapBase {
     };
     'system-get-printers': GetterCall<OpenFin.PrinterInfo[]>;
     'system-register-shutdown-handler': VoidCall;
+    '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>>>;
 }
+type WithPositioningOptions<T extends {} = {}> = T & {
+    positioningOptions?: OpenFin.PositioningOptions;
+};
 type ApiCall<Request, Response> = {
     request: Request;
     response: Response;