@openfin/workspace-platform 11.0.1 → 11.0.3

package/README.md

@@ -2,8 +2,6 @@
 
 The Workspace Platform Client APIs allow integrators to create their own Workspace platforms.
 
-**This API is [experimental](https://developers.openfin.co/of-docs/docs/experimental-apis).**
-
 ## Installation
 
 Run `npm i -E @openfin/workspace-platform`.

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

@@ -1,7 +1,7 @@
 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 } from '../../../common/src/api/pages/shapes';
+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';
 export type { BaseCustomButtonConfig, BaseCustomDropdownConfig, BaseCustomDropdownItem, BaseCustomDropdownItems, CustomActionSpecifier, CustomButtonConfig, CustomDropdownConfig } from '../../../common/src/api/action';

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

@@ -1,4 +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 createPanelViewsForPages(pages: AttachedPage[]): Promise<void>;
 export declare function createPanelViews(panels: PanelConfig[]): Promise<import("@openfin/core/src/api/view").View[]>;

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

@@ -339,6 +339,7 @@ export interface StoreCustomButtonActionPayload extends Omit<CustomButtonActionP
      * callerType - StoreCustomButton type.
      */
     callerType: CustomActionCallerType.StoreCustomButton;
+    storeFrontProviderId: string;
 }
 /**
  * The shape of the payload sent by a custom dropdown menu item to a custom action handler

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

@@ -99,18 +99,27 @@ export interface GetSavedPageMetadataPayload {
     /** The id of the page to get the save state of. */
     pageId: string;
 }
+/**
+ * Possible positions than a fixed view panel can take.
+ */
 export declare enum PanelPosition {
     Left = "Left",
     Right = "Right",
     Top = "Top",
     Bottom = "Bottom"
 }
+/**
+ * Properties specific to a horizontal fixed view panel (top or 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;
 }
+/**
+ * Properties specific to a vertical fixed view panel (left or right)
+ */
 export interface PanelConfigVertical {
     /** Position of the panel in the page. */
     position: PanelPosition.Left | PanelPosition.Right;
@@ -123,6 +132,18 @@ export interface PanelConfigVertical {
      * thus taking priority over the bottom panel.*/
     extendToBottom?: boolean;
 }
+/**
+ * Configuration of an individual fixed view panel
+ *
+ * Example:
+ * ```ts
+ * {
+ *    position: PanelPosition.Left,
+ *    width: '140px',
+ *    viewOptions: { url: 'https://example.com'}
+ * }
+ * ```
+ */
 export declare type PanelConfig = (PanelConfigHorizontal | PanelConfigVertical) & {
     /** The options with which to initialize the panel view.*/
     viewOptions: Omit<OpenFin.PlatformViewCreationOptions, 'bounds' | 'target'>;