@openfin/workspace-platform 10.4.0 → 11.0.0

package/client-api-platform/src/api/app-directory.d.ts

@@ -5,4 +5,4 @@ import type { LaunchAppRequest } from '../shapes';
  * @param app the app directory entry.
  * @param opts launch options.
  */
-export declare function launchApp({ app, target }: LaunchAppRequest): Promise<void | import("@openfin/core/src/api/view").View | OpenFin.Identity | import("@openfin/core/src/api/platform").Platform | import("@openfin/core/src/api/application").Application>;
+export declare function launchApp({ app, target }: LaunchAppRequest): Promise<void | import("@openfin/core/src/api/application").Application | OpenFin.Identity | import("@openfin/core/src/api/view").View | import("@openfin/core/src/api/platform").Platform>;

package/client-api-platform/src/api/pages/index.d.ts

@@ -1,5 +1,5 @@
 import type OpenFin from '@openfin/core';
-import type { AttachedPage, AttachPagesToWindowPayload, DetachPagesFromWindowPayload, ReorderPagesForWindowPayload, SetActivePageForWindowPayload, UpdatePageForWindowPayload } from '../../../../common/src/api/pages/shapes';
+import type { AttachedPage, DetachPagesFromWindowPayload, ExtendedAttachPagesToWindowPayload, ReorderPagesForWindowPayload, SetActivePageForWindowPayload, UpdatePageForWindowPayload } from '../../../../common/src/api/pages/shapes';
 import type { CreateSavedPageRequest, Page, UpdateSavedPageRequest } from '../../../../client-api-platform/src/shapes';
 /**
  * Get all open pages in which are attached to a window.
@@ -10,7 +10,7 @@ export declare const createSavedPageInternal: ({ page }: CreateSavedPageRequest)
 export declare const deleteSavedPageInternal: (id: string) => Promise<void>;
 export declare const updateSavedPageInternal: ({ pageId, page }: UpdateSavedPageRequest) => Promise<any>;
 export declare const savePage: (page: Page) => Promise<any>;
-export declare const attachPagesToWindow: (payload: AttachPagesToWindowPayload) => Promise<void>;
+export declare const attachPagesToWindow: (payload: ExtendedAttachPagesToWindowPayload) => Promise<void>;
 export declare const updatePageForWindow: (payload: UpdatePageForWindowPayload) => Promise<void>;
 export declare const detachPagesFromWindow: (payload: DetachPagesFromWindowPayload) => Promise<void>;
 export declare const setActivePage: (payload: SetActivePageForWindowPayload) => Promise<void>;

package/client-api-platform/src/init/panels.d.ts

@@ -0,0 +1,4 @@
+import { AttachedPage, ExtendedPanelConfig, PanelConfig } from '../../../common/src/api/pages/shapes';
+export declare function convertPanelViewOpts(panels: PanelConfig[]): ExtendedPanelConfig[];
+export declare function createPanelViewsForPages(pages: AttachedPage[]): Promise<import("@openfin/core/src/api/view").View[][]>;
+export declare function createPanelViews(panels: PanelConfig[]): Promise<import("@openfin/core/src/api/view").View[]>;

package/client-api-platform/src/init/utils.d.ts

@@ -1,5 +1,5 @@
 import type OpenFin from '@openfin/core';
-import type { Page } from '../../../common/src/api/pages/shapes';
+import type { AttachedPage, Page } from '../../../common/src/api/pages/shapes';
 import type { CustomThemeOptions, CustomThemeOptionsWithScheme } from '../../../common/src/api/theming';
 import type { BrowserInitConfig, BrowserSnapshot } from '..';
 export declare function overrideViewOptions(options: Partial<OpenFin.ViewOptions>, initOptions: OpenFin.ViewOptions): any;
@@ -28,21 +28,7 @@ declare type LegacyWindowOptions = Omit<OpenFin.PlatformWindowCreationOptions, '
     workstacks?: Page[];
 };
 export declare const initWorkspacePlatformOptions: (options: LegacyWindowOptions | OpenFin.PlatformWindowCreationOptions) => OpenFin.PlatformWindowCreationOptions;
-export declare const applyPageDefaults: (pages: Page[], defaultPageOptions?: BrowserInitConfig['defaultPageOptions']) => Promise<{
-    title: string;
-    layout: any;
-    pageId: string;
-    description?: string;
-    tooltip?: string;
-    isReadOnly?: boolean;
-    unsavedIconUrl?: string;
-    iconUrl?: string;
-    isLocked?: boolean;
-    closeButton?: {
-        hidden?: boolean;
-        disabled?: boolean;
-    };
-}[]>;
+export declare const applyPageDefaults: (pages: Page[], defaultPageOptions?: BrowserInitConfig['defaultPageOptions']) => Promise<AttachedPage[]>;
 export declare const applyBrowserDefaults: (options: OpenFin.PlatformWindowCreationOptions, initOptions: Pick<BrowserInitConfig, 'title' | 'defaultWindowOptions' | 'defaultPageOptions'>, theme: CustomThemeOptions | CustomThemeOptionsWithScheme) => Promise<OpenFin.PlatformWindowCreationOptions>;
 export declare enum WindowType {
     Browser = "browser",

package/client-api-platform/src/shapes.d.ts

@@ -8,7 +8,8 @@ import type { App } from '../../client-api/src/shapes';
 export { AppManifestType } from '../../client-api/src/shapes';
 export type { App, AppIntent, Image } from '../../client-api/src/shapes';
 export type { CustomActionSpecifier, CustomButtonConfig } from '../../common/src/api/action';
-export type { AttachedPage, Page, PageLayout, PageLayoutDetails, PageWithUpdatableRuntimeAttribs } from '../../common/src/api/pages/shapes';
+export type { AttachedPage, Page, PageLayout, PageLayoutDetails, PageWithUpdatableRuntimeAttribs, PanelConfigHorizontal, PanelConfigVertical, PanelConfig, ExtendedPanelConfig } from '../../common/src/api/pages/shapes';
+export { PanelPosition } from '../../common/src/api/pages/shapes';
 export type { CustomThemes, CustomThemeOptions, CustomThemeOptionsWithScheme, CustomPaletteSet } from '../../common/src/api/theming';
 export type { AnalyticsEvent } from '../../common/src/utils/usage-register';
 /**

package/common/src/api/pages/attached.d.ts

@@ -1,5 +1,5 @@
 import type OpenFin from '@openfin/core';
-import type { AttachedPage, AttachPagesToWindowPayload, DetachPagesFromWindowPayload, ReorderPagesForWindowPayload, SetActivePageForWindowPayload, UpdatePageForWindowPayload } from './shapes';
+import type { AttachedPage, DetachPagesFromWindowPayload, ExtendedAttachPagesToWindowPayload, ExtendedUpdatePageForWindowPayload, ReorderPagesForWindowPayload, SetActivePageForWindowPayload } from './shapes';
 /**
  * Get the pages attached to a window.
  * @param identity the identity of the window to get the attached pages of.
@@ -23,7 +23,7 @@ export declare const setActivePageForWindow: (payload: SetActivePageForWindowPay
  *
  * @param payload the attach pages to window payload.
  */
-export declare const attachPagesToWindow: (payload: AttachPagesToWindowPayload) => Promise<void>;
+export declare const attachPagesToWindow: (payload: ExtendedAttachPagesToWindowPayload) => Promise<void>;
 /**
  * Detach pages from the window they are currently attached to.
  * A detached page will not have its views cleaned up.
@@ -55,7 +55,7 @@ export declare const reorderPagesForWindow: (payload: ReorderPagesForWindowPaylo
  * Update a page attached to a window.
  * @param payload the update page for window payload.
  */
-export declare const updatePageForWindow: (payload: UpdatePageForWindowPayload) => Promise<void>;
+export declare const updatePageForWindow: (payload: ExtendedUpdatePageForWindowPayload) => Promise<void>;
 /**
  * Forces a window to save its attached page state to window options.
  * @param identity the identity of the window to save the pages of in window options.

package/common/src/api/pages/index.d.ts

@@ -1,7 +1,7 @@
 import { LayoutExtended } from '../../../../common/src/utils/layout';
 import type { AttachedPage, Page, PageLayout, PageWithUpdatableRuntimeAttribs } from './shapes';
 export declare function getLegacyPages(): Promise<Page[]>;
-export declare function cleanPage(page: AttachedPage): Page;
+export declare function cleanPage<T extends AttachedPage | Page>(page: T): T;
 /**
  * Get a page layout.
  * @param layout the layout to add details to.
@@ -19,4 +19,4 @@ export declare const makePage: (title: string, layout: LayoutExtended) => Promis
  * @param page the page to clone.
  * @returns a clone of the given page.
  */
-export declare const clonePage: (page: Page) => Promise<PageWithUpdatableRuntimeAttribs>;
+export declare const clonePage: <T extends Page | AttachedPage>(page: T) => Promise<T>;

package/common/src/api/pages/shapes.d.ts

@@ -35,6 +35,8 @@ export interface Page {
         hidden?: boolean;
         disabled?: boolean;
     };
+    /** Used to configure fixed views on the edges of the browser window. Only one panel per side is supported. */
+    panels?: PanelConfig[];
 }
 declare type AttachedPageMetadata = {
     /** The window the page is currently attached to. */
@@ -43,6 +45,8 @@ declare type AttachedPageMetadata = {
     isActive?: boolean;
     /** True if the page has unsaved changes. */
     hasUnsavedChanges?: boolean;
+    /** Panel config with all view identities in place */
+    panels?: ExtendedPanelConfig[];
 };
 export declare type AttachedPage = Page & AttachedPageMetadata;
 export declare type PageWithUpdatableRuntimeAttribs = Page & Pick<AttachedPage, 'hasUnsavedChanges'>;
@@ -75,16 +79,55 @@ export interface UpdatePageForWindowPayload {
     /** The partial updated state of the page. */
     page: Partial<PageWithUpdatableRuntimeAttribs>;
 }
+export interface ExtendedUpdatePageForWindowPayload extends UpdatePageForWindowPayload {
+    /** The partial updated state of the page. */
+    page: Partial<AttachedPage>;
+}
 export interface AttachPagesToWindowPayload {
     /** The OF window identity to attach the pages to. */
     identity: OpenFin.Identity;
     /** The pages to attach. */
     pages: PageWithUpdatableRuntimeAttribs[];
 }
+export interface ExtendedAttachPagesToWindowPayload extends AttachPagesToWindowPayload {
+    /** The pages to attach. */
+    pages: AttachedPage[];
+}
 export interface GetSavedPageMetadataPayload {
     /** The OF window identity to attach the pages to. */
     identity: OpenFin.Identity;
     /** The id of the page to get the save state of. */
     pageId: string;
 }
+export declare enum PanelPosition {
+    Left = "Left",
+    Right = "Right",
+    Top = "Top",
+    Bottom = "Bottom"
+}
+export interface PanelConfigHorizontal {
+    /** Position of the panel in the page. */
+    position: PanelPosition.Top | PanelPosition.Bottom;
+    /** Size of the top/bottom panel, formatted as CSS property value with units. E.g. "0px", "10%", "3rem". */
+    height: string;
+}
+export interface PanelConfigVertical {
+    /** Position of the panel in the page. */
+    position: PanelPosition.Left | PanelPosition.Right;
+    /** Size of the left/right panel, formatted as CSS property value with units. E.g. "0px", "10%", "3rem". */
+    width: string;
+    /** When true, the left/right panel extends all the way to the top of the window,
+     * thus taking priority over the top panel.*/
+    extendToTop?: boolean;
+    /** When true, the left/right panel extends all the way to the bottom of the window,
+     * thus taking priority over the bottom panel.*/
+    extendToBottom?: boolean;
+}
+export declare type PanelConfig = (PanelConfigHorizontal | PanelConfigVertical) & {
+    /** The options with which to initialize the panel view.*/
+    viewOptions: Omit<OpenFin.PlatformViewCreationOptions, 'bounds' | 'target'>;
+};
+export declare type ExtendedPanelConfig = PanelConfig & {
+    viewOptions: PanelConfig['viewOptions'] & OpenFin.Identity;
+};
 export {};

package/common/src/utils/layout.d.ts

@@ -12,7 +12,7 @@ export declare type LayoutStack = {
     type: 'stack';
     content: OpenFin.LayoutContent;
 };
-export declare type LayoutContentItemExtended = OpenFin.LayoutRow | OpenFin.LayoutColumn | LayoutComponentExtended | LayoutStack;
+export declare type LayoutContentItemExtended = OpenFin.LayoutRow | OpenFin.LayoutColumn | LayoutStack | LayoutComponentExtended | OpenFin.LayoutItemConfig;
 export declare type LayoutContentExtended = LayoutContentItemExtended[];
 export declare type LayoutSettingsExtended = OpenFin.LayoutOptions['settings'] & {
     reorderEnabled?: boolean;
@@ -43,12 +43,23 @@ export declare const getFirstViewFromLayout: (identity?: WindowIdentity) => Prom
     name: any;
     uuid: any;
 }>;
+/**
+ * Copies the componentState and generates a name if it's not there
+ * @param componentState view's componentState in the layout object, corresponds to View options
+ * @returns A copy of the componentState with name filled in
+ */
+export declare const generateViewNameIfNotExists: <T extends {
+    name?: string;
+}>(componentState: T) => T & {
+    name: string;
+};
 /**
  * Deep clones a layout and adds view names if they don't exist.
  * @param layout The Layout to be cloned
  * @returns A copy of the layout with names added where necessary
  */
 export declare const cloneLayoutAndFillInViewNames: (layout: PageLayout) => any;
+export declare const cloneViewComponentWithoutName: (componentState: any) => any;
 /**
  * Deep clones a layout and removes view names.
  * @param layout The Layout to be cloned
@@ -56,7 +67,37 @@ export declare const cloneLayoutAndFillInViewNames: (layout: PageLayout) => any;
  */
 export declare const cloneLayoutAndRemoveNames: (layout: PageLayout) => any;
 export declare const mapContentComponentState: (content: OpenFin.LayoutContent | LayoutContentExtended) => LayoutComponentStateExtended[];
-export declare const getLayoutWithSingleView: (title: string, url: string, winIdentity?: OpenFin.Identity) => Promise<any>;
+export declare const getLayoutWithSingleView: (title: string, url: string, winIdentity?: OpenFin.Identity) => Promise<{
+    content: {
+        type: string;
+        content: {
+            type: string;
+            componentName: string;
+            componentState: {
+                title: string;
+                url: string;
+            };
+        }[];
+    }[];
+    settings?: {
+        popoutWholeStack?: boolean;
+        constrainDragToContainer?: boolean;
+        showPopoutIcon?: boolean;
+        showMaximiseIcon?: boolean;
+        showCloseIcon?: boolean;
+        constrainDragToHeaders?: boolean;
+        hasHeaders?: boolean;
+        reorderEnabled?: boolean;
+        preventDragOut?: boolean;
+        preventDragIn?: boolean;
+    };
+    dimensions?: {
+        borderWidth?: number;
+        minItemHeight?: number;
+        minItemWidth?: number;
+        headerHeight?: number;
+    };
+}>;
 export declare const isLayoutTabActive: (tabSelector: string) => boolean;
 export declare const containerId = "layout_container";
 export declare const getViewComponents: () => LayoutContentExtended;