@openfin/core 30.73.11 → 30.73.13

package/OpenFin.d.ts

@@ -284,7 +284,7 @@ declare namespace OpenFin {
         defaultTop: number;
         defaultWidth: number;
         height: number;
-        layout: any;
+        layout: LayoutOptions;
         modalParentIdentity: Identity;
         name: string;
         permissions: Partial<Permissions>;
@@ -725,35 +725,50 @@ declare namespace OpenFin {
         };
     };
 
+    export type LayoutContent = (LayoutItemConfig | LayoutRow | LayoutColumn | LayoutComponent)[];
+
+    export type LayoutItemConfig = {
+        type: string;
+        content?: LayoutContent;
+        width?: number;
+        height?: number;
+        id?: string | string[];
+        isClosable?: boolean;
+        title?: string;
+    };
+
+    export interface LayoutRow extends LayoutItemConfig {
+        type: 'row';
+    }
+
+    export interface LayoutColumn extends LayoutItemConfig {
+        type: 'column';
+    }
+
+    export interface LayoutComponent extends LayoutItemConfig {
+        componentName: 'view';
+        componentState?: Partial<ViewCreationOptions>;
+    }
+
     export type LayoutOptions = {
-        settings: {
+        settings?: {
             popoutWholeStack?: boolean;
             constrainDragToContainer?: boolean;
             showPopoutIcon?: boolean;
             showMaximiseIcon?: boolean;
             showCloseIcon?: boolean;
             constrainDragToHeaders?: boolean;
+            hasHeaders?: boolean;
+            reorderEnabled?: boolean;
+            preventDragOut?: boolean;
+            preventDragIn?: boolean;
         };
-        content: LayoutContent;
-    };
-
-    export type LayoutContent = (LayoutRow | LayoutColumn | LayoutComponent)[];
-
-    export type LayoutRow = {
-        type: 'row';
-        content: LayoutContent;
-    };
-    export type LayoutColumn = {
-        type: 'column';
-        content: LayoutContent;
-    };
-    export type LayoutComponent = {
-        type: 'component';
-        componentName: 'view';
-        componentState: {
-            name: string;
-            url: string;
-            title?: string;
+        content?: LayoutContent;
+        dimensions?: {
+            borderWidth?: number;
+            minItemHeight?: number;
+            minItemWidth?: number;
+            headerHeight?: number;
         };
     };
 
@@ -1553,7 +1568,7 @@ declare namespace OpenFin {
         topic: string,
         payload: unknown,
         senderIdentity: ProviderIdentity | OpenFin.ClientIdentity
-    ) => Promise<unknown> |unknown;
+    ) => Promise<unknown> | unknown;
 
     export type ErrorMiddleware = (
         topic: string,

package/package.json

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

package/src/api/platform/layout/Instance.d.ts

@@ -26,7 +26,7 @@ export declare class Layout extends Base {
      * @return { Promise<void> }
      * @tutorial Layout.replace
      */
-    replace: (layout: any) => Promise<void>;
+    replace: (layout: OpenFin.LayoutOptions) => Promise<void>;
     /**
      * Replaces the specified view with a view with the provided configuration.
      * The old view is stripped of its listeners and either closed or attached to the provider window

package/src/shapes/protocol.d.ts

@@ -15,18 +15,27 @@ export interface ProtocolMap extends ProtocolMapBase {
         } & OpenFin.ApplicationIdentity;
         response: void;
     };
-    'get-view-window': {
-        request: OpenFin.Identity;
-        response: OpenFin.Identity;
-    };
-    'window-get-views': {
-        request: OpenFin.Identity;
-        response: OpenFin.Identity[];
-    };
-    'hide-view': {
-        request: OpenFin.Identity;
-        response: void;
-    };
+    'get-view-window': IdentityCall<{}, OpenFin.Identity>;
+    'create-view': IdentityCall<OpenFin.ViewCreationOptions & {
+        uuid: string;
+    }>;
+    'destroy-view': IdentityCall;
+    'attach-view': IdentityCall<{
+        target: OpenFin.Identity;
+    }>;
+    'set-view-bounds': IdentityCall<{
+        bounds: OpenFin.Bounds;
+    }>;
+    'get-view-bounds': IdentityCall<{}, OpenFin.Bounds>;
+    'get-view-info': IdentityCall<{}, OpenFin.ViewInfo>;
+    'get-view-options': IdentityCall<{}, OpenFin.ViewOptions>;
+    'hide-view': IdentityCall;
+    'show-view': IdentityCall;
+    'update-view-options': IdentityCall<{
+        options: OpenFin.UpdatableViewOptions;
+    }>;
+    'trigger-before-unload': IdentityCall<{}, boolean>;
+    'window-get-views': IdentityCall<{}, OpenFin.Identity[]>;
     'launch-manifest': {
         request: {
             manifestUrl: string;
@@ -64,10 +73,7 @@ export interface ProtocolMap extends ProtocolMapBase {
         };
         response: void;
     };
-    'close-popup-menu': {
-        request: OpenFin.Identity;
-        response: void;
-    };
+    'close-popup-menu': IdentityCall;
     'fdc3-add-context-listener': VoidCall;
     'fdc3-broadcast': VoidCall;
     'fdc3-get-system-channels': VoidCall;
@@ -113,12 +119,9 @@ export interface ProtocolMap extends ProtocolMapBase {
         };
         response: OpenFin.PopupResult;
     };
-    'dispatch-popup-result': {
-        request: OpenFin.Identity & {
-            data: any;
-        };
-        response: void;
-    };
+    'dispatch-popup-result': IdentityCall<{
+        data: any;
+    }>;
     'render-overlay': {
         request: {
             bounds: OpenFin.Bounds;
@@ -143,10 +146,12 @@ export interface ProtocolMap extends ProtocolMapBase {
         response: OpenFin.PrinterInfo[];
     };
 }
-declare type VoidCall = {
-    request: void;
-    response: void;
+declare type ApiCall<Request, Response> = {
+    request: Request;
+    response: Response;
 };
+declare type VoidCall = ApiCall<void, void>;
+declare type IdentityCall<AdditionalPayload = {}, Response = void> = ApiCall<AdditionalPayload & OpenFin.Identity, Response>;
 interface ProtocolMapBase {
     [action: string]: {
         request: any;