@openfin/workspace-platform 12.1.3 → 12.4.0

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

@@ -1,6 +1,5 @@
 export type { Action, DispatchedAction, DispatchedSearchResult, SearchListenerRequest, SearchListenerResponse, SearchProviderInfo, SearchResult, ScoreOrder, SearchTag, SearchProvider, UserInputListener, ResultDispatchListener, SearchResponse } from '../../../search-api/src/index';
 export type { Workspace } from '../../../common/src/api/workspaces';
-export type { LayoutExtended, LayoutContentExtended, LayoutSettingsExtended, LayoutContentItemExtended, LayoutComponentExtended, LayoutComponentStateExtended, LayoutStack } from '../../../common/src/utils/layout';
 export type { Page, PageLayout, PageLayoutDetails, PanelConfig, PanelConfigHorizontal, PanelConfigVertical, PanelPosition } from '../../../common/src/api/pages/shapes';
 export { SearchTagBackground, ActionTrigger } from '../../../search-api/src/shapes';
 export type { ProviderInfo } from './provider';
@@ -8,10 +7,8 @@ export type { BaseCustomButtonConfig, BaseCustomDropdownConfig, BaseCustomDropdo
 /**
  * return by component.register function
  */
-export interface RegisterMetaInfo {
-    workspaceVersion: string;
-}
 export interface RegistrationMetaInfo {
     clientAPIVersion: string;
     workspaceVersion: string;
 }
+export declare type RegisterMetaInfoInternal = Pick<RegistrationMetaInfo, 'workspaceVersion'>;

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

@@ -237,17 +237,54 @@ export interface StoreRegistration extends RegistrationMetaInfo {
      * used to update button configuration returned by provider for an app.
      *
      * ```ts
-     *  registration = await Store.register(provider);
-     *  registration.updateAppCardButtons({
-     *    appId: request.payload.appId,
-     *    primaryButton: {
-     *        ...request.payload.sourcePrimaryButton,
-     *        title: "Primary button is now disabled",
-     *        disabled: true
-     *    },
-     *    secondaryButtons: request.payload.sourceSecondaryButtons
+     *  let storeRegistration: StoreRegistration | undefined;
+     *
+     *  await WorkspacePlatform.init({
+     *      customActions: {
+     *          storeButtonCustomActionHandler: async (payload: StoreCustomButtonActionPayload) => {
+     *              if (storeRegistration) {
+     *                  await storeRegistration.updateAppCardButtons({
+     *                      appId: payload.appId,
+     *                          primaryButton: {
+     *                              ...payload.primaryButton,
+     *                              title: 'Disabled Button',
+     *                              disabled: true,
+     *                          },
+     *                       secondaryButtons: payload.secondaryButtons
+     *                  });
+     *              }
+     *          }
+     *      }
      *  });
-     * ```
+     *
+     *  const sampleApp: App = {
+     *      title: 'Sample Application',
+     *      addId: 'sampleAppId',
+     *      icons: [],
+     *      publisher: 'Sample',
+     *      primaryButton: {
+     *          title: 'Sample Button',
+     *          action: {
+     *          id: 'storeButtonCustomActionHandler',
+     *          }
+     *       }
+     *  },
+     *
+     *  const storefrontProvider: StorefrontProvider = {
+     *      title: 'Sample Store',
+     *      id: 'sampleStoreId',
+     *      icon: {...},
+     *      getApps: () => Promise.resolve([sampleApp]),
+     *      getLandingPage: {...},
+     *      getNavigation: {...},
+     *      getFooter: {...},
+     *      launchApp: (app: App) => WR.getCurrentSync().launchApp({app})
+     * };
+     *
+     *  storeRegistration = await Store.register(storefrontProvider);
+     *  await Store.show();
+     *
+     *  ```
      */
     updateAppCardButtons: (request: UpdateButtonConfigRequest) => Promise<void>;
 }

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

@@ -1,8 +1,11 @@
-import type { CreateSavedWorkspaceRequest, Workspace } from '../../../../client-api-platform/src/shapes';
+import type { ApplyWorkspacePayload, CreateSavedWorkspaceRequest, 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(workspace: Workspace): Promise<void>;
+export declare function applyWorkspace({ options, ...workspace }: ApplyWorkspacePayload): Promise<boolean>;
 /**
  * Set the current active workspace.
  */

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

@@ -0,0 +1 @@
+export {};

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

@@ -1094,6 +1094,8 @@ export interface WorkspacePlatformModule extends OpenFin.Platform {
     /**
      * Launch an application.
      *
+     * @deprecated This method is deprecated. It is recommended to use [createView](https://developers.openfin.co/of-docs/docs/platform-getting-started#add-a-view-to-an-existing-window) or [createWindow](https://developers.openfin.co/of-docs/docs/platform-getting-started#create-a-platform-window) instead.
+     *
      * ```ts
      * import * as WorkspacePlatform from '@openfin/workspace-platform';
      *
@@ -1132,8 +1134,11 @@ export interface WorkspacePlatformModule extends OpenFin.Platform {
      * Closes content from the current workspace and applies the given workspace to the user's desktop.  Makes that
      * workspace the active workspace.
      * @param workspace the workspace to apply to the desktop and set as the current active workspace.
+     * @param options see {@link ApplyWorkspaceOptions}.
+     *
+     * @returns true if the workspace was applied, false if the workspace was not applied.
      */
-    applyWorkspace(workspace: Workspace): Promise<void>;
+    applyWorkspace(workspace: Workspace, options?: ApplyWorkspaceOptions): Promise<boolean>;
     /**
      * The browser window factory for the Workspace Platform.
      */
@@ -1199,6 +1204,13 @@ export interface WorkspacePlatformProvider extends OpenFin.PlatformProvider {
      * @param id of the id of the workspace to delete.
      */
     deleteSavedWorkspace(id: string): Promise<void>;
+    /**
+     * Applies a workspace to the user's desktop.  Makes that workspace the active workspace.
+     * @param applyWorkspacePayload {@link ApplyWorkspacePayload}
+     *
+     * @returns true if the workspace was applied, false if the workspace was not applied.
+     */
+    applyWorkspace(payload: ApplyWorkspacePayload): Promise<boolean>;
     /**
      * Implementation for showing a global context menu given a menu template,
      * handler callback, and screen coordinates. For an example of overriding, see {@link WorkspacePlatformOverrideCallback}.
@@ -1261,6 +1273,40 @@ export declare enum CustomActionCallerType {
 export declare type CustomActionPayload = {
     callerType: CustomActionCallerType.API;
 } | CustomButtonActionPayload | StoreCustomButtonActionPayload | CustomDropdownItemActionPayload | GlobalContextMenuOptionActionPayload | ViewTabCustomActionPayload | PageTabContextMenuOptionActionPayload | OpenSaveContextMenuOptionActionPayload;
+/**
+ * Options for the {@link WorkspacePlatformModule.applyWorkspace applyWorkspace} method.
+ *
+ */
+export interface ApplyWorkspaceOptions {
+    /**
+     * If true, the workspace will be applied without prompting the user to confirm.
+     * If false, the user will be prompted to confirm the workspace application.
+     * @default false
+     */
+    skipPrompt?: boolean;
+    /**
+     * The window to use as the parent for the workspace switch confirmation dialog.
+     */
+    promptContainerWindowIdentity?: OpenFin.Identity;
+    /**
+     * @inheritdoc OpenFin.ApplySnapshotOptions
+     */
+    applySnapshotOptions?: OpenFin.ApplySnapshotOptions & {
+        /**
+         * When true, applyWorkspace will close all existing windows,
+         * replacing current Platform state with the given snapshot.
+         *
+         * @default true
+         */
+        closeExistingWindows?: boolean;
+    };
+}
+/**
+ * Payload received by applyWorkspace platform provider method
+ */
+export declare type ApplyWorkspacePayload = Workspace & {
+    options?: ApplyWorkspaceOptions;
+};
 /**
  * Defines custom action map where the key is the custom action ID and value is the action handler
  */
@@ -1271,7 +1317,7 @@ export interface AnalyticsConfig {
     /**
      * Enable sending of Analytics data to OpenFin
      */
-    enableOpenFinAnalytics: boolean;
+    sendToOpenFin: boolean;
 }
 /**
  * Configuration for initializing a Workspace platform.
@@ -1336,6 +1382,10 @@ export interface WorkspacePlatformInitConfig {
      * https://cdn.openfin.co/docs/javascript/stable/InteropBroker.html
      */
     interopOverride?: OpenFin.OverrideCallback<OpenFin.InteropBroker, OpenFin.InteropBroker>;
+    /**
+     * Config for Workspace Platform analytics
+     */
+    analytics?: AnalyticsConfig;
 }
 /**
  * Extend or replace default functionality in order to customize behavior of a Workspace Platform Provider.

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

@@ -14,7 +14,7 @@ export interface Overrides {
         [key: string]: boolean;
     };
     disableRuntimeValidation: boolean;
-    enableOpenFinAnalytics: boolean;
+    disableOpenFinAnalytics: boolean;
 }
 export declare function getOverrides(): Promise<Partial<Overrides>>;
 export declare const useOverrides: () => Partial<Overrides>;

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

@@ -1,4 +1,4 @@
-import { LayoutExtended } from '../../../../common/src/utils/layout';
+import type OpenFin from '@openfin/core';
 import type { AttachedPage, Page, PageLayout, PageWithUpdatableRuntimeAttribs } from './shapes';
 export declare function getLegacyPages(): Promise<Page[]>;
 export declare function cleanPage<T extends AttachedPage | Page>(page: T): T;
@@ -13,7 +13,7 @@ export declare const getPageLayout: (layout: PageLayout) => Promise<PageLayout>;
  * @param title the title for the page.
  * @param layout the layout for the page.
  */
-export declare const makePage: (title: string, layout: LayoutExtended) => Promise<PageWithUpdatableRuntimeAttribs>;
+export declare const makePage: (title: string, layout: OpenFin.LayoutOptions) => Promise<PageWithUpdatableRuntimeAttribs>;
 /**
  * Clone a page.
  * @param page the page to clone.

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

@@ -1,14 +1,44 @@
 import type OpenFin from '@openfin/core';
-import type { LayoutExtended } from '../../utils/layout';
 export interface PageLayoutDetails {
-    /** The id of the machine that created the page. */
+    /**
+     * The id of the machine that created the page.
+     */
     machineId: string;
-    /** The name of the machine that created the page. */
+    /**
+     *  The name of the machine that created the page.
+     */
     machineName?: string;
 }
-export declare type PageLayout = LayoutExtended & {
+export declare type PageLayout = OpenFin.LayoutOptions & {
     layoutDetails?: PageLayoutDetails;
 };
+/**
+ * Provides configuration options for a set of Workspace Views. An array of Page objects is a required option of the {@link workspacePlatform}
+ * property of the {@link BrowserCreateWindowRequest} interface.
+ *```ts
+ *  const page: Page = {
+ *      title: 'myPageTitle',
+ *      pageId: 'myPageID',
+ *      layout: {
+ *          content: [
+ *              {
+ *                  type: 'stack',
+ *                  content: [
+ *                      {
+ *                          type: 'component',
+ *                          componentName: 'view',
+ *                          componentState: {
+ *                              name: 'myViewName',
+ *                              url: 'http://google.com'
+ *                          }
+ *                      }
+ *                  ]
+ *              }
+ *          ]
+ *      }
+ * };
+ * ```
+ */
 export interface Page {
     /** A UI friendly title for the page. */
     title: string;

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

@@ -1,26 +1,6 @@
 import type OpenFin from '@openfin/core';
 import { AttachedPage, PageLayout } from '../../../client-api-platform/src/shapes';
 import { WindowIdentity } from './window';
-export declare type LayoutComponentStateExtended = OpenFin.LayoutComponent['componentState'] & {
-    name: string;
-    uuid: string;
-};
-export declare type LayoutComponentExtended = Omit<OpenFin.LayoutComponent, 'componentState'> & {
-    componentState: LayoutComponentStateExtended;
-};
-export declare type LayoutStack = {
-    type: 'stack';
-    content: OpenFin.LayoutContent;
-};
-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;
-};
-export declare type LayoutExtended = {
-    settings?: LayoutSettingsExtended;
-    content: LayoutContentExtended;
-};
 export declare enum LayoutDOMEventType {
     TabCreated = "tab-created",
     ContainerCreated = "container-created",
@@ -66,11 +46,11 @@ export declare const cloneViewComponentWithoutName: (componentState: any) => any
  * @returns A copy of the layout with names removed
  */
 export declare const cloneLayoutAndRemoveNames: (layout: PageLayout) => any;
-export declare const mapContentComponentState: (content: OpenFin.LayoutContent | LayoutContentExtended) => LayoutComponentStateExtended[];
+export declare const mapContentComponentState: (content: OpenFin.LayoutContent) => OpenFin.LayoutComponent['componentState'][];
 export declare const getLayoutWithSingleView: (title: string, url: string, winIdentity?: OpenFin.Identity) => Promise<any>;
 export declare const isLayoutTabActive: (tabSelector: string) => boolean;
 export declare const containerId = "layout_container";
-export declare const getViewComponents: () => LayoutContentExtended;
+export declare const getViewComponents: () => OpenFin.LayoutContent;
 export declare const removeLayoutView: (name: string) => Promise<void>;
 export declare const addLayoutEventListener: (event: LayoutDOMEventType, listener: LayoutDOMEventListener) => void;
 /**

package/common/src/utils/menu-window-provider.d.ts

@@ -23,7 +23,7 @@ declare type WindowOptionsWithBounds = OptionalExceptFor<OpenFin.WindowOptions,
     top: number;
     left: number;
 };
-export declare function createChildWindow(opts: OptionalExceptFor<OpenFin.WindowOptions, 'name' | 'url'>, route?: string, bounds?: OpenFin.Bounds): Promise<OpenFin.Window | null>;
+export declare function createChildWindow(opts: OptionalExceptFor<OpenFin.WindowOptions, 'name' | 'url'>, route?: string, bounds?: Partial<OpenFin.Bounds>): Promise<OpenFin.Window>;
 export interface ShowChildOptions {
     options: WindowOptionsWithBounds;
     parameters?: URLSearchParams;

package/common/src/utils/modal-bounds.d.ts

@@ -5,7 +5,7 @@ import { ResponseModalConfig } from './menu-config';
  * this will return the correct bounds regardless of whether the window is maximized
  *
  * @param modalOptions window options including height/width so that we can calculate the correct bounds
- * @param parentWindowIdentity the window to get the bounds from
+ * @param parentWindowIdentity the window to get the bounds from. If this is undefined, the primary monitor will be used
  * @param centerOnMonitor whether the modal should be centered on the monitor
  * @returns a point (top/left) as to where the window should be placed
  */

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

@@ -27,10 +27,18 @@ interface Size {
 }
 /**
  * Gets the center point of a window given its bounds
- * @param bounds OpenFin bounds - left, top, height, width
- * @returns coords representing the center - left, top
+ *
+ * @param bounds OpenFin WindowBounds - left, top, height, width
+ * @returns A {@link OpenFin.Point} representing the center of the monitor
  */
 export declare const getCenterFromBounds: (bounds: OpenFin.WindowBounds) => Point;
+/**
+ * Gets the center point of a monitor given its bounds
+ *
+ * @param bounds RectangleByEdgePositions - left, top, right, bottom. The bounds of the monitor
+ * @returns A {@link OpenFin.Point} representing the center of the monitor
+ */
+export declare const getCenterFromMonitorBounds: (bounds: OpenFin.RectangleByEdgePositions) => Point;
 /**
  * Gets the top and left coords of a window given its size and center point
  * @param center point representing the desired center coords

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

@@ -1,7 +1,7 @@
 import type OpenFin from '@openfin/core';
 import { ResponseModalConfig } from '../../../common/src/utils/menu-config';
 export declare const restoreChangesMenu: (windowIdentity: OpenFin.Identity) => Promise<ResponseModalConfig>;
-export declare const showSwitchWorkspaceModal: (windowIdentity: OpenFin.Identity, workspaceTitle: string) => Promise<boolean>;
+export declare const showSwitchWorkspaceModal: (targetWindowIdentity: OpenFin.Identity | undefined, workspaceTitle: string) => Promise<boolean>;
 export declare const showDeleteWorkspaceModal: (windowIdentity: OpenFin.Identity, workspaceTitle: string) => Promise<boolean>;
 /**
  *