@openfin/workspace-platform 15.0.4 → 16.0.0

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

@@ -59,6 +59,12 @@ export interface App {
      * A UI friendly title for the application.
      */
     title: string;
+    /**
+     * Custom tooltip on the Store App Card Container.
+     *
+     * @default - title of App Card
+     */
+    tooltip?: string;
     /**
      * URL to application manifest.
      */
@@ -214,6 +220,7 @@ export interface StorefrontNavigationItemDetails {
     description: string;
     image: Image;
     buttonTitle?: string;
+    tooltip?: string;
 }
 /**
  * Template for rendering a navigation item that renders a app grid when clicked.
@@ -346,6 +353,18 @@ export type StorefrontDetailedNavigationItem = StorefrontNavigationItem & Storef
  * ```
  */
 export interface StorefrontProvider extends ProviderInfo {
+    /**
+     * Store button visibility status
+     *
+     * @default 'visible'
+     */
+    buttonVisibility?: 'hidden' | 'visible';
+    /**
+     * Behavior of app card when it is clicked
+     *
+     * @default 'show-app-details'
+     */
+    cardClickBehavior?: 'show-app-details' | 'perform-primary-button-action';
     /**
      * Get a list of apps to populate the platform's Storefront with.
      *

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

@@ -3,7 +3,7 @@ import { OpenGlobalContextMenuPayload, OpenGlobalContextMenuRequest, OpenPageTab
 export declare function openGlobalContextMenuInternal(this: WorkspacePlatformProvider, payload: OpenGlobalContextMenuRequest & {
     identity: OpenFin.Identity;
 }, callerIdentity: OpenFin.Identity): Promise<void>;
-export declare const openCommonContextMenu: (payload: OpenGlobalContextMenuPayload | OpenViewTabContextMenuPayload | OpenPageTabContextMenuPayload | OpenSaveButtonContextMenuPayload, callerIdentity: OpenFin.Identity) => Promise<void>;
+export declare const openCommonContextMenu: (payload: OpenGlobalContextMenuPayload | OpenViewTabContextMenuPayload | OpenPageTabContextMenuPayload | OpenSaveButtonContextMenuPayload, _callerIdentity: OpenFin.Identity) => Promise<void>;
 export declare function openViewTabContextMenuInternal(this: WorkspacePlatformProvider, payload: OpenViewTabContextMenuRequest & {
     identity: OpenFin.Identity;
 }, callerIdentity: OpenFin.Identity): Promise<void>;

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

@@ -24,7 +24,7 @@ import { WorkspacePlatformModule } from '../shapes';
  *                  componentName: 'Example View',
  *                  componentState: {
  *                      name: 'example_view_1'
- *                      url: 'https://cdn.openfin.co/docs/javascript/canary/Platform.html'
+ *                      url: 'https://developer.openfin.co/docs/javascript/stable/index.html'
  *                  }
  *              }
  *          ]

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

@@ -107,9 +107,7 @@ export interface AppearanceContextMenuItemData extends GlobalContextMenuItemData
     scheme: ColorSchemeOptionType;
 }
 /**Configuration of an option in the global context menu */
-export interface GlobalContextMenuItemTemplate extends Exclude<OpenFin.MenuItemTemplate, 'data'> {
-    data?: GlobalContextMenuItemData;
-}
+export type GlobalContextMenuItemTemplate = OpenFin.MenuItemTemplate<GlobalContextMenuItemData>;
 /**Shape of the data property of a page tab context menu template item */
 export interface PageTabContextMenuItemData extends ContextMenuItemData {
     type: PageTabContextMenuOptionType;
@@ -147,9 +145,7 @@ export type OpenGlobalContextMenuPayload = OpenGlobalContextMenuRequest & {
     /** Default function that handles stock context menu options. */
     callback: (data: GlobalContextMenuItemData, payload: OpenGlobalContextMenuPayload) => any;
 };
-export interface ViewTabContextMenuTemplate extends OpenFin.MenuItemTemplate {
-    data?: ViewTabMenuData;
-}
+export type ViewTabContextMenuTemplate = OpenFin.MenuItemTemplate<ViewTabMenuData>;
 /**
  * Request for opening a view tab context menu in Browser.
  */
@@ -1511,7 +1507,7 @@ export interface WorkspacePlatformInitConfig {
     overrideCallback?: WorkspacePlatformOverrideCallback;
     /**
      * Override workspace platform interop behavior
-     * https://cdn.openfin.co/docs/javascript/stable/InteropBroker.html
+     * https://developer.openfin.co/docs/javascript/stable/classes/OpenFin.InteropBroker.html
      */
     interopOverride?: OpenFin.OverrideCallback<OpenFin.InteropBroker, OpenFin.InteropBroker>;
     /**
@@ -1697,14 +1693,16 @@ export interface BrowserInitConfig {
      */
     title?: string;
     /**
-     * @deprecated
      * Override workspace platform behavior
+     *
+     * @deprecated Please use the `overrideCallback` property of {@link WorkspacePlatformInitConfig}
      */
     overrideCallback?: BrowserOverrideCallback;
     /**
      * @deprecated
      * Override workspace platform interop behavior
-     * https://cdn.openfin.co/docs/javascript/stable/OpenFin.InteropBroker.html
+     *
+     * https://developer.openfin.co/docs/javascript/stable/classes/OpenFin.InteropBroker.html
      */
     interopOverride?: OpenFin.OverrideCallback<OpenFin.InteropBroker, OpenFin.InteropBroker>;
 }

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

@@ -48,7 +48,11 @@ export interface Page {
     description?: string;
     /** A optional UI friendly tooltip for the page. */
     tooltip?: string;
-    /** True if the page is read only. In this state, the page is locked and cannot be unlocked. */
+    /**
+     * True if the page is read only. In this state, the page is locked and cannot be unlocked.
+     *
+     * @deprecated This property is deprecated and will be removed in a future release. Setting it has no effect. To _"lock"_ a page, and prevent the ability to close pages, drag pages within the window and drag pages into/out of the window, use the `isLocked` property.
+     */
     isReadOnly?: boolean;
     /** Icon that appears on a page tab if there are unsaved changes (dirty state). If 'undefined', default icon will appear. */
     unsavedIconUrl?: string;

package/common/src/utils/context-menu.d.ts

@@ -10,6 +10,7 @@ export type ShowContextMenuResponse = OpenFin.MenuResult & {
 };
 export default function showContextMenu(opts: OpenFin.ShowPopupMenuOptions, win?: OpenFin.Window): Promise<ShowContextMenuResponse>;
 export declare const Separator: OpenFin.MenuItemTemplate;
+export declare const EmptyContextMenuItem: OpenFin.MenuItemTemplate;
 export declare const DefaultSaveMenuBounds: {
     width: number;
     height: number;

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

@@ -11,7 +11,7 @@ export declare const isDocumentDefined: boolean;
 export declare const isWindowDefinedWithIndexDB: boolean;
 export declare const finUUID: string;
 export declare const finName: string;
-export declare const finEntityType: "" | "window" | "view" | "iframe" | "external connection" | "unknown";
+export declare const finEntityType: "" | "window" | "view";
 export declare const isEnvLocal: boolean;
 export declare const isEnvDev: boolean;
 export declare const isEnvStaging: boolean;