@openfin/node-adapter 34.78.43 → 34.78.45

package/out/node-adapter.d.ts

@@ -43,6 +43,23 @@ declare type Accelerator = {
     zoom: boolean;
 };
 
+/**
+ * @interface
+ */
+declare type AddLayoutInstanceOptions = {
+    container: HTMLDivElement;
+    layoutName: string;
+    layout: LayoutOptions;
+};
+
+/**
+ * @interface
+ */
+declare type AddViewOptions = CreateViewTarget & {
+    options: ViewState;
+    targetView?: Identity_5;
+};
+
 /**
  * @interface
  */
@@ -4375,6 +4392,18 @@ declare type CreatedEvent = BaseViewEvent & {
     type: 'created';
 };
 
+/**
+ * @interface
+ */
+declare type CreateLayoutOptions = {
+    /**
+     * @experimental
+     *
+     * @returns
+     */
+    layoutManagerOverride: () => any;
+};
+
 /**
  * @interface
  */
@@ -4493,6 +4522,13 @@ declare type DestroyedEvent = BaseViewEvent & {
     type: 'destroyed';
 };
 
+/**
+ * @interface
+ */
+declare type DestroyLayoutOptions = {
+    layoutName: string;
+};
+
 /**
  * Generated when a page's theme color changes. This is usually due to encountering a meta tag.
  * @interface
@@ -8560,10 +8596,10 @@ declare type LayoutEntitiesClient = ApiClient<LayoutEntitiesController>;
  * to an instance of layout manager in a structured manner.
  */
 declare class LayoutEntitiesController {
-    private layoutManager;
+    private layoutInstance;
     private layoutContentCache;
     private wire;
-    constructor(layoutManager: LayoutManager, layoutContentCache: LayoutContentCache);
+    constructor(layoutInstance: OpenFinLayout, layoutContentCache: LayoutContentCache);
     private analytics;
     /**
      * @internal
@@ -8680,6 +8716,17 @@ declare type LayoutEntityDefinition<TLayoutEntityType extends LayoutEntityTypes
 
 declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'root'>;
 
+/**
+ * @interface
+ */
+declare type LayoutIdentity = Identity_5 & {
+    /**
+     * The name of the layout an action should be targeted to. When not provided,
+     * OpenFin attempts to resolve the instance via visibility checks.
+     */
+    layoutName?: string;
+};
+
 /**
  * Generated when a window and all of its layout's views have either finished or failed navigation.
  * @interface
@@ -8691,6 +8738,25 @@ declare type LayoutInitializedEvent = BaseWindowEvent & {
     })[];
 };
 
+/**
+ * @interface @experimental
+ *
+ * Responsible for handling all layout management and renderering
+ */
+declare type LayoutInstance = {
+    getFrameSnapshot: () => Promise<LayoutOptions>;
+    addView: (payload: AddViewOptions) => Promise<View_2>;
+    closeView: (viewIdentity: Identity_5) => Promise<void>;
+    removeView: (viewConfig: Identity_5 | ViewState) => Promise<View_2>;
+    replaceView: (payload: ReplaceViewOptions) => Promise<View_2>;
+    getViews: () => LayoutComponent[];
+    getCurrentViews: () => Identity_5[];
+    startReplaceLayout: (payload: ReplaceLayoutOptions) => Promise<void>;
+    applyPreset: (payload: PresetLayoutOptions_3) => void;
+    isVisible: () => boolean;
+    destroy: () => void;
+};
+
 /**
  * Represents the arrangement of Views within a Platform window's Layout. We do not recommend trying
  * to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot} or our
@@ -8714,99 +8780,64 @@ declare type LayoutItemConfig = {
     title?: string;
 };
 
-declare class LayoutManager {
-    #private;
-    private readonly splitterController;
-    private readonly tabDragController;
-    private readonly layoutContentCache;
-    private client;
-    private container;
-    private containerResizeObserver;
-    private viewsResizeObserver;
-    private dragProxy;
-    private isDragging;
-    private resizing;
-    layout: GoldenLayout.GoldenLayout;
-    private layoutConfigToRestore?;
-    readonly ofWindow: OpenFin.Window;
-    readonly platform: Platform_2;
-    private showBackgroundImages;
-    private showFavicons;
-    private defaultFaviconUrl;
-    private showViewsOnWindowResize?;
-    private showViewsOnSplitterDrag?;
-    private showViewsOnTabDrag?;
-    private dropzonePreview?;
-    private lastItemDestroyed?;
-    private viewsSubscribedTo;
-    constructor(splitterController: SplitterController, tabDragController: TabDragController, layoutContentCache: LayoutContentCache);
+/**
+ * @interface @experimental
+ */
+declare interface LayoutManager<T extends LayoutSnapshot = LayoutSnapshot> {
     /**
-     * @internal
-     * Needed by init-layout util to wire up {@link LayoutEntitiesController}
+     * @experimental
+     *
+     * Must be overridden when working with multiple layouts
+     *
+     * Hook called during fin.Platform.Layout.init() call, to inform derived classes
+     * when a snapshot is being applied to launch a platform window. Use this hook to set the
+     * local state and ensure you call fin.Platform.Layout.create() on every layout in snapshot.layouts
+     *
+     * When using custom data to the app manifest snapshot.windows.layoutSnapshot key, this data will
+     * be included in the snapshot type T and should align with your component state T.
+     *
+     * TODO: detect if layoutManager override was set and this was not overridden somehow to warn?
+     * @param snapshot
+     * @returns
      */
-    static getClient: (instance: LayoutManager) => OpenFin.ChannelClient;
-    initManager: () => Promise<void>;
-    createLayout: (layout: GoldenLayout.Config, container: HTMLElement) => Promise<void>;
-    private setContainer;
-    private setupDragDropRegions;
-    private replaceLayout;
-    private onViewDetached;
-    private setupLayoutListeners;
-    private onLayoutInit;
-    private registerViewComponent;
-    private setupWindowListeners;
-    private setupResizeObservers;
+    applyLayoutSnapshot: (snapshot: T) => Promise<void>;
     /**
-     * Shows/hides a view depending on use case (used by browser)
-     * @ignore
+     * @experimental
+     *
+     * Must be overridden when working with multiple layouts
+     *
+     * Hook for allowing OpenFin to show a given layout. It's recommended to enumerate your layout containers
+     * and find the one matching layoutIdentity.layoutName and show that container and hide the others.
+     * @param layoutIdentity
+     * @returns
      */
-    private updateViewVisibility;
-    private onStackCreated;
-    private onTabCreated;
-    private onTabMouseUp;
-    private replaceCloseTabButton;
-    onCloseTabButtonClick: (tab: GoldenLayout.Tab) => Promise<void>;
-    addFaviconToTab: (tab: GoldenLayout.Tab, eventIcons: string[]) => void;
-    onPopoutClick: (stack: GoldenLayout.ContentItem) => void;
-    onStackCloseClick: (stack: GoldenLayout.ContentItem) => void;
-    private updateButtonDisplay;
-    private onItemCreated;
-    private observeSplitters;
-    handleOutOfWindowDrop: (e: {
-        screenY: number;
-        screenX: number;
-    }, parentTab: GoldenLayout.Tab, dimensions: {
-        width: any;
-        height: any;
-    }) => Promise<void>;
-    private onTabDragStart;
-    private setBackgroundImage;
-    private setBackgroundImages;
-    private getFrameSnapshot;
-    private getCurrentViews;
-    private addView;
-    private replaceView;
-    private removeView;
-    private closeView;
-    private createChannelConnections;
-    getViewComponent: (identity: {
-        uuid?: string;
-        name: string;
-    }) => ViewComponent | undefined;
-    getViewComponents: () => ViewComponent[];
-    private hideHighlight;
-    getOfViewFromComponentState: (componentState: {
-        name: any;
-    }) => View_4;
-    private hideAllViews;
-    private showViews;
-    private initializeLayoutViews;
-    private createResizableView;
-    private attachView;
-    private createAndAttachView;
-    private setupViewEvents;
-    private dispatchLayoutEvent;
-    private setComponentState;
+    showLayout: ({ layoutName }: LayoutIdentity) => Promise<void>;
+    /**
+     * @experimental
+     *
+     * @returns T
+     */
+    getLayoutSnapshot: () => Promise<T>;
+    /**
+     * @experimental
+     *
+     * @param param0
+     * @returns
+     */
+    resolveLayout: ({ layoutName }: LayoutIdentity) => LayoutInstance;
+    /**
+     * @experimental
+     *
+     * Returns a LayoutInstance if one exists with the name layoutIdentity.layoutName.
+     * Throws if it does not exist.
+     * @param layoutIdentity
+     * @returns
+     */
+    getLayoutByName: (layoutName: string) => LayoutInstance;
+    /**
+     * @experimental
+     */
+    getLayouts(): Record<string, LayoutInstance>;
 }
 
 /**
@@ -9197,6 +9228,13 @@ declare type LayoutRow = LayoutItemConfig & {
     type: 'row';
 };
 
+/**
+ * @interface
+ */
+declare type LayoutSnapshot = {
+    layouts: Record<string, LayoutOptions>;
+};
+
 /**
  * @interface
  */
@@ -10086,11 +10124,14 @@ declare namespace OpenFin {
         AddViewToStackOptions,
         CreateViewTarget,
         CreateViewPayload,
+        AddViewOptions,
         ReplaceViewPayload,
+        ReplaceViewOptions,
         CloseViewPayload,
         FetchManifestPayload,
         ReplaceLayoutOpts,
         ReplaceLayoutPayload,
+        ReplaceLayoutOptions,
         SetWindowContextPayload,
         LaunchIntoPlatformPayload,
         GetWindowContextPayload,
@@ -10247,8 +10288,15 @@ declare namespace OpenFin {
         ApplicationWindowInfo_2 as ApplicationWindowInfo,
         WindowDetail,
         LayoutPresetType,
+        LayoutIdentity,
+        LayoutSnapshot,
         InitLayoutOptions_3 as InitLayoutOptions,
-        PresetLayoutOptions_2 as PresetLayoutOptions,
+        LayoutInstance,
+        LayoutManager,
+        AddLayoutInstanceOptions,
+        CreateLayoutOptions,
+        DestroyLayoutOptions,
+        PresetLayoutOptions_3 as PresetLayoutOptions,
         ResultBehavior,
         PopupBaseBehavior,
         PopupResultBehavior,
@@ -10302,6 +10350,107 @@ declare namespace OpenFin {
 }
 export default OpenFin;
 
+declare class OpenFinLayout implements OpenFin.LayoutInstance {
+    #private;
+    private readonly splitterController;
+    private readonly tabDragController;
+    private readonly layoutContentCache;
+    private client;
+    private container;
+    private containerResizeObserver;
+    private viewsResizeObserver;
+    private dragProxy;
+    private isDragging;
+    private resizing;
+    layout: GoldenLayout.GoldenLayout;
+    private layoutConfigToRestore?;
+    readonly ofWindow: OpenFin.Window;
+    readonly platform: Platform_2;
+    private showBackgroundImages;
+    private showFavicons;
+    private defaultFaviconUrl;
+    private showViewsOnWindowResize?;
+    private showViewsOnSplitterDrag?;
+    private showViewsOnTabDrag?;
+    private dropzonePreview?;
+    private lastItemDestroyed?;
+    private viewsSubscribedTo;
+    constructor(splitterController: SplitterController, tabDragController: TabDragController, layoutContentCache: LayoutContentCache);
+    getViews: () => OpenFin.LayoutComponent[];
+    startReplaceLayout: ({ layout }: {
+        layout: GoldenLayout.Config;
+    }) => Promise<void>;
+    applyPreset: (payload: PresetLayoutOptions_2) => void;
+    isVisible: () => boolean;
+    destroy: () => void;
+    /**
+     * @internal
+     * Needed by init-layout util to wire up {@link LayoutEntitiesController}
+     */
+    static getClient: (instance: OpenFinLayout) => OpenFin.ChannelClient;
+    initManager: () => Promise<void>;
+    createLayout: (layout: GoldenLayout.Config, container: HTMLElement) => Promise<void>;
+    private setContainer;
+    private setupDragDropRegions;
+    private replaceLayout;
+    private onViewDetached;
+    private setupLayoutListeners;
+    private onLayoutInit;
+    private registerViewComponent;
+    private setupWindowListeners;
+    private setupResizeObservers;
+    /**
+     * Shows/hides a view depending on use case (used by browser)
+     * @ignore
+     */
+    private updateViewVisibility;
+    private onStackCreated;
+    private onTabCreated;
+    private onTabMouseUp;
+    private replaceCloseTabButton;
+    onCloseTabButtonClick: (tab: GoldenLayout.Tab) => Promise<void>;
+    addFaviconToTab: (tab: GoldenLayout.Tab, eventIcons: string[]) => void;
+    onPopoutClick: (stack: GoldenLayout.ContentItem) => void;
+    onStackCloseClick: (stack: GoldenLayout.ContentItem) => void;
+    private updateButtonDisplay;
+    private onItemCreated;
+    private observeSplitters;
+    handleOutOfWindowDrop: (e: {
+        screenY: number;
+        screenX: number;
+    }, parentTab: GoldenLayout.Tab, dimensions: {
+        width: any;
+        height: any;
+    }) => Promise<void>;
+    private onTabDragStart;
+    private setBackgroundImage;
+    private setBackgroundImages;
+    getFrameSnapshot: () => Promise<GoldenLayout.Config>;
+    getCurrentViews: () => OpenFin.Identity[];
+    addView: ({ options: viewConfig, targetView, location }: OpenFin.AddViewOptions) => Promise<View_4>;
+    replaceView: ({ viewToReplace, newView }: OpenFin.ReplaceViewOptions) => Promise<View_4>;
+    removeView: (viewConfig: OpenFin.Identity | OpenFin.ViewState) => Promise<View_4>;
+    closeView: (viewIdentity: OpenFin.Identity) => Promise<void>;
+    private createChannelConnections;
+    getViewComponent: ({ name }: {
+        name: string;
+    }) => ViewComponent | undefined;
+    getViewComponents: () => ViewComponent[];
+    private hideHighlight;
+    getOfViewFromComponentState: ({ name }: {
+        name: string;
+    }) => View_4;
+    private hideAllViews;
+    private showViews;
+    private initializeLayoutViews;
+    private createResizableView;
+    private attachView;
+    private createAndAttachView;
+    private setupViewEvents;
+    private dispatchLayoutEvent;
+    private setComponentState;
+}
+
 declare type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
 
 declare type OverlapsOnlyIfMatching<T, U> = {
@@ -12099,10 +12248,12 @@ declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent &
 
 declare type PresetLayoutOptions = OpenFin.PresetLayoutOptions;
 
+declare type PresetLayoutOptions_2 = OpenFin.PresetLayoutOptions;
+
 /**
  * @interface
  */
-declare type PresetLayoutOptions_2 = {
+declare type PresetLayoutOptions_3 = {
     /**
      * Which preset layout arrangement to use.
      * The preset options are `columns`, `grid`, `rows`, and `tabs`.
@@ -12770,6 +12921,13 @@ declare interface RemoteConfig extends ExistingConnectConfig {
 /**
  * @interface
  */
+declare type ReplaceLayoutOptions = ReplaceLayoutOpts;
+
+/**
+ * @interface
+ *
+ * @deprecated use ReplaceLayoutOptions instead
+ */
 declare type ReplaceLayoutOpts = {
     /**
      * Layout config to be applied.
@@ -12784,13 +12942,21 @@ declare type ReplaceLayoutPayload = {
     /**
      * Object containing the layout to be applied.
      */
-    opts: ReplaceLayoutOpts;
+    opts: ReplaceLayoutOptions;
     /**
      * Identity of the window whose layout will be replace.
      */
     target: Identity_5;
 };
 
+/**
+ * @interface
+ */
+declare type ReplaceViewOptions = {
+    viewToReplace: Identity_5;
+    newView: ViewState;
+};
+
 /**
  * @interface
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/node-adapter",
-    "version": "34.78.43",
+    "version": "34.78.45",
     "description": "See README.md",
     "main": "out/node-adapter.js",
     "types": "out/node-adapter.d.ts",