@openfin/workspace-platform 9.1.22 → 9.2.1

package/client-api-platform/src/api/browser/browser-module.d.ts

@@ -1,21 +1,2 @@
-import type { AttachedPage, Page, PageWithUpdatableRuntimeAttribs } from '../../../../common/src/api/pages/shapes';
-import { OpenPageTabContextMenuRequest } from '../../../../client-api-platform/src/index';
-import { OpenGlobalContextMenuRequest, OpenSaveButtonContextMenuRequest, OpenSaveMenuRequest, OpenViewTabContextMenuRequest, ToolbarOptions, WindowStateButtonOptions } from '../../../../client-api-platform/src/shapes';
-export declare const getBrowserModule: (identity: OpenFin.Identity) => {
-    identity: OpenFin.Identity;
-    openfinWindow: import("@openfin/core/src/api/window")._Window;
-    getPages: () => Promise<AttachedPage[]>;
-    getPage: (pageId: string) => Promise<AttachedPage>;
-    addPage: (page: PageWithUpdatableRuntimeAttribs) => Promise<void>;
-    removePage: (id: Page['pageId']) => Promise<void>;
-    setActivePage: (id: Page['pageId']) => Promise<void>;
-    updatePage: (req: any) => Promise<any>;
-    reorderPages: (req: any) => Promise<any>;
-    _openGlobalContextMenu: (req: OpenGlobalContextMenuRequest) => Promise<any>;
-    replaceToolbarOptions: (options: ToolbarOptions) => Promise<void>;
-    replaceWindowStateButtonOptions: (options: WindowStateButtonOptions) => Promise<void>;
-    _openViewTabContextMenu: (req: OpenViewTabContextMenuRequest) => Promise<any>;
-    _openPageTabContextMenu: (req: OpenPageTabContextMenuRequest) => Promise<any>;
-    _openSaveModal: (req: OpenSaveMenuRequest) => Promise<any>;
-    _openSaveButtonContextMenu: (req: OpenSaveButtonContextMenuRequest) => Promise<any>;
-};
+import { BrowserWindowModule } from '../../../../client-api-platform/src/shapes';
+export declare const getBrowserModule: (identity: OpenFin.Identity) => BrowserWindowModule;

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

@@ -2,24 +2,7 @@
 import type { AttachedPage } from '../../../../common/src/api/pages/shapes';
 import type { BrowserCreateWindowRequest, BrowserWindowModule } from '../../shapes';
 export declare const getBrowserApi: (identity: OpenFin.ApplicationIdentity) => {
-    wrapSync: (windowIdentity: OpenFin.Identity) => {
-        identity: OpenFin.Identity;
-        openfinWindow: import("@openfin/core/src/api/window")._Window;
-        getPages: () => Promise<AttachedPage[]>;
-        getPage: (pageId: string) => Promise<AttachedPage>;
-        addPage: (page: import("@common/api/pages/shapes").PageWithUpdatableRuntimeAttribs) => Promise<void>;
-        removePage: (id: string) => Promise<void>;
-        setActivePage: (id: string) => Promise<void>;
-        updatePage: (req: any) => Promise<any>;
-        reorderPages: (req: any) => Promise<any>;
-        _openGlobalContextMenu: (req: import("../../shapes").OpenGlobalContextMenuRequest) => Promise<any>;
-        replaceToolbarOptions: (options: import("../../shapes").ToolbarOptions) => Promise<void>;
-        replaceWindowStateButtonOptions: (options: import("../../shapes").WindowStateButtonOptions) => Promise<void>;
-        _openViewTabContextMenu: (req: import("../../shapes").OpenViewTabContextMenuRequest) => Promise<any>;
-        _openPageTabContextMenu: (req: import("../../shapes").OpenPageTabContextMenuRequest) => Promise<any>;
-        _openSaveModal: (req: import("../../shapes").OpenSaveMenuRequest) => Promise<any>;
-        _openSaveButtonContextMenu: (req: import("../../shapes").OpenSaveButtonContextMenuRequest) => Promise<any>;
-    };
+    wrapSync: (windowIdentity: OpenFin.Identity) => BrowserWindowModule;
     createWindow: (options: BrowserCreateWindowRequest) => Promise<BrowserWindowModule>;
     getAllAttachedPages: () => Promise<AttachedPage[]>;
     getAllWindows: () => Promise<BrowserWindowModule[]>;

package/client-api-platform/src/api/context-menu/index.d.ts

@@ -2,14 +2,14 @@
 import { OpenGlobalContextMenuPayload, OpenGlobalContextMenuRequest, OpenPageTabContextMenuPayload, OpenPageTabContextMenuRequest, OpenSaveButtonContextMenuPayload, OpenSaveButtonContextMenuRequest, OpenViewTabContextMenuPayload, OpenViewTabContextMenuRequest } from '../../../../client-api-platform/src/shapes';
 export declare function openGlobalContextMenuInternal(payload: OpenGlobalContextMenuRequest & {
     identity: OpenFin.Identity;
-}, callerIdentity: any): Promise<void>;
-export declare const openCommonContextMenu: (payload: OpenGlobalContextMenuPayload | OpenViewTabContextMenuPayload | OpenPageTabContextMenuPayload | OpenSaveButtonContextMenuPayload, callerIdentity: any) => Promise<void>;
+}, callerIdentity: OpenFin.Identity): Promise<void>;
+export declare const openCommonContextMenu: (payload: OpenGlobalContextMenuPayload | OpenViewTabContextMenuPayload | OpenPageTabContextMenuPayload | OpenSaveButtonContextMenuPayload, callerIdentity: OpenFin.Identity) => Promise<void>;
 export declare function openViewTabContextMenuInternal(payload: OpenViewTabContextMenuRequest & {
     identity: OpenFin.Identity;
-}, callerIdentity: any): Promise<void>;
+}, callerIdentity: OpenFin.Identity): Promise<void>;
 export declare function openPageTabContextMenuInternal(payload: OpenPageTabContextMenuRequest & {
     identity: OpenFin.Identity;
-}, callerIdentity: any): Promise<void>;
+}, callerIdentity: OpenFin.Identity): Promise<void>;
 export declare function openSaveButtonContextMenuInternal(payload: OpenSaveButtonContextMenuRequest & {
     identity: OpenFin.Identity;
-}, callerIdentity: any): Promise<void>;
+}, callerIdentity: OpenFin.Identity): Promise<void>;

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

@@ -1,26 +1,26 @@
 /// <reference types="@openfin/core" />
-import type { AttachPagesToWindowPayload } from '../../../../common/src/api/pages/shapes';
+import type { AttachedPage, AttachPagesToWindowPayload, DetachPagesFromWindowPayload, 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.
  * @returns the list of attached pages.
  */
-export declare const getAllAttachedPages: () => Promise<any>;
+export declare const getAllAttachedPages: () => Promise<AttachedPage[]>;
 export declare const createSavedPageInternal: ({ page }: CreateSavedPageRequest) => Promise<void>;
 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 updatePageForWindow: (payload: any) => Promise<void>;
-export declare const detachPagesFromWindow: (payload: any) => Promise<void>;
-export declare const setActivePage: (payload: any) => Promise<void>;
-export declare const getPagesForWindow: (identity: OpenFin.Identity) => Promise<import("@client-platform/shapes").AttachedPage[]>;
+export declare const updatePageForWindow: (payload: UpdatePageForWindowPayload) => Promise<void>;
+export declare const detachPagesFromWindow: (payload: DetachPagesFromWindowPayload) => Promise<void>;
+export declare const setActivePage: (payload: SetActivePageForWindowPayload) => Promise<void>;
+export declare const getPagesForWindow: (identity: OpenFin.Identity) => Promise<AttachedPage[]>;
 export declare const getPageForWindow: ({ identity, pageId }: {
-    identity: any;
-    pageId: any;
-}) => Promise<import("@client-platform/shapes").AttachedPage>;
-export declare const reorderPagesForWindow: (payload: any) => Promise<void>;
-export declare const getActivePageIdForWindow: (identity: any) => Promise<string>;
+    identity: OpenFin.Identity;
+    pageId: string;
+}) => Promise<AttachedPage>;
+export declare const reorderPagesForWindow: (payload: ReorderPagesForWindowPayload) => Promise<void>;
+export declare const getActivePageIdForWindow: (identity: OpenFin.Identity) => Promise<string>;
 /**
  * Checks if a given page name is unique
  * If not, add a progressive number to it

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

@@ -1,6 +1,7 @@
+/// <reference types="@openfin/core" />
 import { Page } from '../../../common/src/api/pages/shapes';
 import type { CreateSavedPageRequest, CreateSavedWorkspaceRequest, UpdateSavedPageRequest, UpdateSavedWorkspaceRequest, Workspace } from '../shapes';
-export declare const getStorageApi: (identity: any) => {
+export declare const getStorageApi: (identity: OpenFin.ApplicationIdentity) => {
     createPage: (req: CreateSavedPageRequest) => Promise<any>;
     deletePage: (id: string) => Promise<any>;
     updatePage: (req: UpdateSavedPageRequest) => Promise<any>;

package/client-api-platform/src/api/workspaces/idb.d.ts

@@ -3,10 +3,10 @@ export declare const store: import("idb-keyval").UseStore;
 export declare function getWorkspace(id: string): Promise<Workspace>;
 export declare function getWorkspaceList(filter?: string): Promise<Workspace[]>;
 export declare function createWorkspace({ workspace }: {
-    workspace: any;
+    workspace: Workspace;
 }): Promise<void>;
 export declare function deleteWorkspace(id: string): Promise<void>;
 export declare function updateWorkspace({ workspaceId, workspace }: {
-    workspaceId: any;
-    workspace: any;
+    workspaceId: string;
+    workspace: Workspace;
 }): Promise<void>;

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

@@ -22,7 +22,6 @@ export declare const createWorkspaceInStorage: (req: CreateSavedWorkspaceRequest
 export declare const getWorkspacesInStorage: () => Promise<Workspace[]>;
 export declare const getWorkspaceInStorage: (id: string) => Promise<Workspace>;
 export declare const deleteWorkspaceInStorage: (id: string) => Promise<any>;
-export declare const updateWorkspaceInStorage: (req: any) => Promise<any>;
 export declare const saveWorkspace: (workspace: Workspace) => Promise<any>;
 /**
  * Checks if a given workspace name is unique

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

@@ -3,8 +3,8 @@ import type { Page } from '../../../common/src/api/pages/shapes';
 import type { CustomThemeOptions } from '../../../common/src/api/theming';
 import type { BrowserInitConfig, BrowserSnapshot } from '..';
 export declare function overrideViewOptions(options: Partial<OpenFin.ViewOptions>, initOptions: OpenFin.ViewOptions): any;
-export declare function preserveInteropIfManifestConflict(opts: Partial<OpenFin.ViewOptions>, fetchManifest: ({ manifestUrl: string }: {
-    manifestUrl: any;
+export declare function preserveInteropIfManifestConflict(opts: Partial<OpenFin.ViewOptions>, fetchManifest: ({ manifestUrl }: {
+    manifestUrl: string;
 }, callerIdentity: OpenFin.Identity) => any, callerIdentity: OpenFin.Identity): Promise<any>;
 export declare const filterSnapshotWindows: (win: OpenFin.WindowOptions) => boolean;
 /**
@@ -22,7 +22,7 @@ export declare const filterSnapshotWindows: (win: OpenFin.WindowOptions) => bool
  * @param options - Object passed into createWindow -> contains height and width
  * @returns unprocessed or processed options object
  */
-export declare const fitToMonitor: (options: any) => Promise<any>;
+export declare const fitToMonitor: (options: OpenFin.PlatformWindowCreationOptions) => Promise<OpenFin.PlatformWindowCreationOptions>;
 declare type LegacyWindowOptions = Omit<OpenFin.PlatformWindowCreationOptions, 'workspacePlatform'> & {
     pages?: Page[];
     workstacks?: Page[];

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

@@ -84,7 +84,7 @@ export interface WorkspaceContextMenuItemData extends GlobalContextMenuItemData
     workspaceId: string;
 }
 /**Configuration of an option in the global context menu */
-export interface GlobalContextMenuItemTemplate extends OpenFin.MenuItemTemplate {
+export interface GlobalContextMenuItemTemplate extends Exclude<OpenFin.MenuItemTemplate, 'data'> {
     data: GlobalContextMenuItemData;
 }
 /**Shape of the data property of a page tab context menu template item */
@@ -1133,28 +1133,28 @@ export interface WorkspacePlatformProvider extends OpenFin.PlatformProvider {
      * @param req the payload received by the provider call
      * @param callerIdentity OF identity of the entity from which the request originated
      */
-    openGlobalContextMenu(req: OpenGlobalContextMenuPayload, callerIdentity: OpenFin.Identity): any;
+    openGlobalContextMenu(req: OpenGlobalContextMenuPayload, callerIdentity: OpenFin.Identity): Promise<void>;
     /**
      * Implementation for showing a view tab context menu given a menu template,
      * handler callback, and screen coordinates. For an example of overriding, see {@link WorkspacePlatformOverrideCallback}.
      * @param req the payload received by the provider call
      * @param callerIdentity OF identity of the entity from which the request originated
      */
-    openViewTabContextMenu(req: OpenViewTabContextMenuPayload, callerIdentity: OpenFin.Identity): any;
+    openViewTabContextMenu(req: OpenViewTabContextMenuPayload, callerIdentity: OpenFin.Identity): Promise<void>;
     /**
      * Implementation for showing a page tab context menu given a menu template,
      * handler callback, and screen coordinates. For an example of overriding, see {@link WorkspacePlatformOverrideCallback}.
      * @param req the payload received by the provider call
      * @param callerIdentity OF identity of the entity from which the request originated
      */
-    openPageTabContextMenu(req: OpenPageTabContextMenuPayload, callerIdentity: OpenFin.Identity): any;
+    openPageTabContextMenu(req: OpenPageTabContextMenuPayload, callerIdentity: OpenFin.Identity): Promise<void>;
     /**
      * Implementation for showing a context menu for save button given a menu template,
      * handler callback, and screen coordinates. For an example of overriding, see {@link WorkspacePlatformOverrideCallback}.
      * @param req the payload received by the provider call
      * @param callerIdentity OF identity of the entity from which the request originated
      */
-    openSaveButtonContextMenu(req: OpenSaveButtonContextMenuPayload, callerIdentity: OpenFin.Identity): any;
+    openSaveButtonContextMenu(req: OpenSaveButtonContextMenuPayload, callerIdentity: OpenFin.Identity): Promise<void>;
 }
 /**
  * The origins from which a custom action can be invoked

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

@@ -3,10 +3,10 @@ export declare const store: import("idb-keyval").UseStore;
 export declare function getPage(id: string): Promise<Page>;
 export declare function getPageList(filter?: string): Promise<Page[]>;
 export declare function createPage({ page }: {
-    page: any;
+    page: Page;
 }): Promise<void>;
 export declare function deletePage(id: string): Promise<void>;
 export declare function updatePage({ pageId, page }: {
-    pageId: any;
-    page: any;
+    page: Page;
+    pageId: string;
 }): Promise<void>;

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

@@ -7,7 +7,7 @@ export declare function cleanPage(page: AttachedPage): Page;
  * @param layout the layout to add details to.
  * @returns the layout with extra details.
  */
-export declare const getPageLayout: (layout: any) => Promise<PageLayout>;
+export declare const getPageLayout: (layout: PageLayout) => Promise<PageLayout>;
 /**
  * Generates a Page object which represents a page.
  * @param title the title for the page.

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

@@ -48,13 +48,13 @@ export declare const getFirstViewFromLayout: (identity?: WindowIdentity) => Prom
  * @param layout The Layout to be cloned
  * @returns A copy of the layout with names added where necessary
  */
-export declare const cloneLayoutAndFillInViewNames: (layout: any) => any;
+export declare const cloneLayoutAndFillInViewNames: (layout: PageLayout) => any;
 /**
  * Deep clones a layout and removes view names.
  * @param layout The Layout to be cloned
  * @returns A copy of the layout with names removed
  */
-export declare const cloneLayoutAndRemoveNames: (layout: any) => 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 isLayoutTabActive: (tabSelector: string) => boolean;
@@ -71,7 +71,7 @@ export declare const initLayout: () => Promise<void>;
  * @param layout The Layout to be locked
  * @returns A restricted copy of the layout
  */
-export declare const getLockedPageLayout: (layout: any) => any;
+export declare const getLockedPageLayout: (layout: PageLayout) => any;
 /**
  * Accepts a locked layout and an unlocked layout as a reference.
  * Takes the layout settings of the reference layout and merges them into the locked layout, thereby unlocking it.
@@ -79,7 +79,7 @@ export declare const getLockedPageLayout: (layout: any) => any;
  * @param referenceUnlockedLayout The Layout to serve as a reference of an unlocked layout
  * @returns An unlocked version of the target layout
  */
-export declare const getUnlockedLayout: (lockedLayout: any, referenceUnlockedLayout: any) => any;
+export declare const getUnlockedLayout: (lockedLayout: PageLayout, referenceUnlockedLayout: PageLayout) => any;
 /**
  * Replaces the layout of the window with the provided layout and adjusts it based on provided page's options
  * @param layout Layout with which to replace current window's layout

package/common/src/utils/unique-toolbar-options.d.ts

@@ -1 +1,2 @@
-export declare const checkUniqueToolbarOptions: (toolbarOptions: any) => void;
+import { ToolbarButton } from '../../../client-api-platform/src/shapes';
+export declare const checkUniqueToolbarOptions: (toolbarOptions: ToolbarButton[]) => void;

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

@@ -105,7 +105,7 @@ export declare function showAndFocus(identity: WindowIdentity): Promise<void>;
  * This method ensures the window is hidden and blurred.
  * @param identity the identity of the window to hide.
  */
-export declare function hideAndBlur(identity: WindowIdentity): Promise<void>;
+export declare function hide(identity: WindowIdentity): Promise<void>;
 /**
  * Helper for showing / hiding a window.
  * This method calls showAndFocus / hideAndBlur

package/common/src/utils/workspace-modals.d.ts

@@ -1,5 +1,5 @@
 import { ResponseModalConfig } from '../../../common/src/utils/menu-config';
-export declare const restoreChangesMenu: (windowIdentity: any) => Promise<ResponseModalConfig>;
+export declare const restoreChangesMenu: (windowIdentity: OpenFin.Identity) => Promise<ResponseModalConfig>;
 export declare const showSwitchWorkspaceModal: (windowIdentity: OpenFin.Identity, workspaceTitle: string) => Promise<boolean>;
 export declare const showDeleteWorkspaceModal: (windowIdentity: OpenFin.Identity, workspaceTitle: string) => Promise<boolean>;
 /**
@@ -9,5 +9,5 @@ export declare const showDeleteWorkspaceModal: (windowIdentity: OpenFin.Identity
  * @returns Boolean - Affirmative or Negative response from user
  */
 export declare const showPlatformQuitModal: (windowIdentity: OpenFin.Identity, workspaceTitle: string, shouldCenterOnMonitor?: boolean) => Promise<boolean>;
-export declare const showRestoreChangesModal: (windowIdentity: any) => Promise<boolean>;
+export declare const showRestoreChangesModal: (windowIdentity: OpenFin.Identity) => Promise<boolean>;
 export declare const getOverwriteWorkspaceMenu: (workspaceTitle: string) => Promise<ResponseModalConfig>;