@openfin/workspace-platform 11.0.1 → 11.0.4

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/custom-actions.d.ts

@@ -1,3 +1,3 @@
 import { CustomActionsMap, InvokeCustomActionRequest } from '..';
 export declare const initCustomActions: (actions: CustomActionsMap) => void;
-export declare const makeInvokeCustomActionInternal: (identity: OpenFin.ApplicationIdentity) => ({ actionId, payload }: InvokeCustomActionRequest) => Promise<any>;
+export declare const makeInvokeCustomActionInternal: ({ actionId, payload }: InvokeCustomActionRequest) => Promise<any>;

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

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

@@ -290,19 +290,6 @@ export interface CustomButtonActionPayload {
     /** Screen y-coordinate where custom button should be shown. */
     y: number;
 }
-/**
- * The shape that is used by {@link StoreCustomButtonActionPayload.updateButtonState} method payload parameter in  {@link StoreCustomButtonActionPayload}.
- */
-export interface UpdateStoreCustomButtonStateRequest {
-    /**
-     * New title for the primary button.
-     */
-    title: string;
-    /**
-     * New disabled state for the primary button.
-     */
-    disabled?: boolean;
-}
 /**
  * The shape of the payload that is sent by a store app primary button or secondary button click to a platform custom action handler
  */
@@ -311,34 +298,11 @@ export interface StoreCustomButtonActionPayload extends Omit<CustomButtonActionP
      * Invoking application id.
      */
     appId: string;
-    /**
-     * Callback that allows the update of app's primary button config properties, such as: title and disabled flag.
-     * Below of `updateButtonState` use in the context of platform custom actions.
-     *
-     * ```ts
-     * WorkspacePlatform.init({
-     *         customActions: {
-     *          'changeButtonState': async (payload: StoreCustomButtonActionPayload) => {
-     *                 await payload.updateButtonState({
-     *                     title: 'Disabled Primary Button For 2 Seconds',
-     *                     disabled: true
-     *                 });
-     *                 setTimeout(async () => {
-     *                     await payload.updateButtonState({
-     *                         disabled: false,
-     *                         title: 'Active Test Primary Button'
-     *                     });
-     *                 }, 2000);
-     *             }
-     *        }
-     * });
-     * ```
-     */
-    updateButtonState: (updateRequest: UpdateStoreCustomButtonStateRequest) => Promise<void>;
     /**
      * 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'>;

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

@@ -1,6 +1,5 @@
 import type OpenFin from '@openfin/core';
 import { App, StorefrontFooter, StorefrontLandingPage, StorefrontNavigationItemAppGrid, StorefrontNavigationSection, StorefrontProviderInfo } from '../../../client-api/src/shapes';
-import { UpdateStoreCustomButtonStateRequest } from '../../../client-api-platform/src/shapes';
 export interface StorefrontProviderInfoWithIdentity extends StorefrontProviderInfo {
     platformIdentity: OpenFin.Identity;
 }
@@ -32,20 +31,6 @@ export interface LaunchStorefrontProviderAppRequest extends StorefrontProviderId
  * @param req LaunchStorefrontProviderAppRequest request object.
  */
 export declare const launchStorefrontApp: (req: LaunchStorefrontProviderAppRequest) => Promise<void>;
-/**
- * A request to update store primary button state.
- */
-export interface UpdateStoreCustomButtonStateRequestWithProvider extends UpdateStoreCustomButtonStateRequest, StorefrontProviderIdentity {
-    /**
-     * App id.
-     */
-    appId: string;
-}
-/**
- * Updates primary button state.
- * @param req update request.
- */
-export declare const setStoreButtonState: (req: UpdateStoreCustomButtonStateRequestWithProvider) => Promise<void>;
 /**
  * Get a list of applications for Storefront.
  * @param identity of the platform to get the apps from.