@openfin/workspace-platform 22.0.7 → 22.1.1

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

@@ -8,7 +8,7 @@ export declare const navigateContentMenu: (id: string) => Promise<void>;
 export declare const launchDockEntry: (payload: LaunchDockEntryPayload) => Promise<void>;
 export declare const setDockFavoritesOrder: (favorites: DockEntry[]) => Promise<void>;
 export declare const setDefaultDockButtonsOrder: (defaultDockButtons: DockCompanionButton[]) => Promise<void>;
-export declare const getDockWorkspacesContextMenu: () => Promise<import("@client/index").BaseCustomDropdownItem[]>;
+export declare const getDockWorkspacesContextMenu: () => Promise<import("@client/index").BaseCustomDropdownItem<any>[]>;
 export declare const handleDockWorkspacesMenuResponse: (payload: any) => Promise<void>;
 export declare const removeFavoriteEntry: (entry: DockEntry) => Promise<void>;
 export declare const addFavoriteEntry: (entry: DockEntry) => Promise<void>;

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

@@ -1,11 +1,12 @@
-import type { ApplyWorkspacePayload, CreateSavedWorkspaceRequest, Workspace } from '../../../../client-api-platform/src/shapes';
+import type { ApplyWorkspacePayload, CreateSavedWorkspaceRequest, RestoreLastSavedWorkspacePayload, RestoreLastSavedWorkspaceResult, Workspace } from '../../../../client-api-platform/src/shapes';
 /**
  * Apply the given workspace and set it as active.
  * @param payload, the workspace to apply and the options to apply it with.
  *
  * @returns true if the workspace was applied, false if the user cancelled the switch or an error occurred.
  */
-export declare function applyWorkspace({ options, ...workspace }: ApplyWorkspacePayload): Promise<boolean>;
+export declare function applyWorkspace(payload: ApplyWorkspacePayload): Promise<boolean>;
+export declare function restoreLastSavedWorkspaceInternal(options?: RestoreLastSavedWorkspacePayload): Promise<RestoreLastSavedWorkspaceResult>;
 /**
  * Set the current active workspace.
  */

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

@@ -1,5 +1,8 @@
 import type OpenFin from '@openfin/core';
 import { AttachedPage, ExtendedPanelConfig, PanelConfig } from '../../../common/src/api/pages/shapes';
-export declare function convertPanelViewOpts(panels: PanelConfig[]): ExtendedPanelConfig[];
+export declare function convertPanelViewOpts(panels: PanelConfig[], updatePageRequest?: {
+    identity: OpenFin.Identity;
+    pageId: string;
+}): Promise<ExtendedPanelConfig[]>;
 export declare function createPanelViewsForPages(pages: AttachedPage[]): Promise<void>;
 export declare function createPanelViews(panels: PanelConfig[]): Promise<(void | OpenFin.View)[]>;

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

@@ -1521,6 +1521,13 @@ export interface WorkspacePlatformModule extends OpenFin.Platform {
      * ```
      */
     applyWorkspace(workspace: Workspace, options?: ApplyWorkspaceOptions): Promise<boolean>;
+    /**
+     * Applies last saved version of current workspace.
+     * @param options see {@link ApplyWorkspaceOptions}.
+     * @returns String indicating the outcome of the API call, one of: 'success', 'not-saved-workspace', 'user-declined'.
+     * See {@link RestoreLastSavedWorkspaceResult} for detailed description.
+     */
+    restoreLastSavedWorkspace(options?: ApplyWorkspaceOptions): Promise<RestoreLastSavedWorkspaceResult>;
     /**
      * Returns ISO language code of current set language
      *
@@ -1894,6 +1901,13 @@ export interface ApplySnapshotOptions extends OpenFin.ApplySnapshotOptions {
 export type ApplyWorkspacePayload = Workspace & {
     options?: ApplyWorkspaceOptions;
 };
+/**
+ * Variants of results returned by restoreLastSavedWorkspace method.
+ * * 'success' - workspace was successfully applied
+ * * 'not-saved-workspace' - currently active workspace has never been saved, hence no changes were applied
+ * * 'user-declined' - confirmation modal was shown and user declined to apply last saved workspace (only relevant when skipPrompt==false)
+ */
+export type RestoreLastSavedWorkspaceResult = 'success' | 'not-saved-workspace' | 'user-declined';
 /**
  * Defines custom action map where the key is the custom action ID and value is the action handler
  */

package/common/src/api/action.d.ts

@@ -19,12 +19,12 @@ export interface BaseCustomButtonConfig {
     iconUrl?: string;
     parentHover?: boolean;
 }
-export interface BaseCustomDropdownItem extends Omit<BaseCustomButtonConfig, 'tooltip'> {
+export interface BaseCustomDropdownItem<Action = any> extends Omit<BaseCustomButtonConfig, 'tooltip'> {
     tooltip?: string;
     /** Is this dropdown item checked? Any value other than undefined will decorate the dropdown option as a checkbox option. */
     checked?: boolean;
     /** icon URL for icon image */
-    action?: any;
+    action?: Action;
     options?: (BaseCustomDropdownItem | BaseCustomDropdownConfig)[];
     separator?: boolean;
 }

package/common/src/api/protocol/workspace-platform.d.ts

@@ -51,6 +51,7 @@ export declare enum WorkspacePlatformChannelAction {
     SaveWorkspace = "saveWorkspace",
     GetCurrentWorkspace = "getCurrentWorkspace",
     ApplyWorkspace = "applyWorkspace",
+    RestoreLastSavedWorkspaceInternal = "restoreLastSavedWorkspaceInternal",
     SetActiveWorkspace = "setActiveWorkspace",
     IsBrowserInitialized = "isBrowserInitialized",
     Analytics = "analyticsInternal",

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

@@ -35,6 +35,7 @@ export type LayoutDOMEvent = {
     type: Extract<LayoutDOMEventType, 'tabs-list-resized'>;
 };
 export type LayoutDOMEventListener = (ev: LayoutDOMEvent) => void;
+export declare const VIEW_NAME_PREFIX: "internal-generated-view-";
 export declare const getFirstActiveViewFromLayout: (identity: OpenFin.LayoutIdentity) => Promise<OpenFin.Identity>;
 /**
  * Recursively clones a layout object, calling a passed callback on each `componentState` in the tree.