@openfin/workspace-platform 5.6.2 → 6.0.0

package/README.md

@@ -11,7 +11,7 @@ Run `npm i -E @openfin/workspace-platform`.
 ## Workspace Platform API documentation
 
 -   [Overview](https://developers.openfin.co/of-docs/docs/workspace-sdk)
--   [API Reference](https://cdn.openfin.co/workspace/api/platform/docs/latest/index.html)
+-   [API Reference](https://cdn.openfin.co/workspace/docs/platform/latest/index.html)
 -   [Example projects using Workspace Platform](https://github.com/built-on-openfin/workspace-starter)
 
 ## Code examples

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

@@ -6,6 +6,8 @@
 import type { Page } from '../../common/src/api/pages/shapes';
 import type { Workspace } from '../../common/src/api/workspaces';
 import type { Action, DispatchedSearchResult, SearchListenerRequest, SearchListenerResponse, SearchProvider, SearchResult } from '../../search-api/src/index';
+import { CustomTemplate, ListPairs } from './templates';
+export * from './templates';
 export type { Action, 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';
@@ -573,6 +575,10 @@ export declare enum CLITemplate {
      * Contact Information Template
      */
     Contact = "Contact",
+    /**
+     * Custom Template
+     */
+    Custom = "Custom",
     /**
      * Definition List Template
      */
@@ -593,7 +599,6 @@ export interface CLISearchResultWithTemplate<T extends keyof typeof CLITemplate,
     template: T;
     templateContent: C;
 }
-export declare type ListPairs = [string, string][];
 /**
  * Contact Data.
  */
@@ -624,6 +629,11 @@ export interface ContactInfo {
  */
 export interface CLISearchResultContact<A extends Action = Action> extends CLISearchResultWithTemplate<CLITemplate.Contact, ContactInfo, A> {
 }
+/**
+ * A Search Result that renders custom templates.
+ */
+export interface CLISearchResultCustom<A extends Action = Action> extends CLISearchResultWithTemplate<CLITemplate.Custom, CustomTemplate, A> {
+}
 /**
  * Definition List Search Result
  */
@@ -642,7 +652,7 @@ export interface CLISearchResultSimpleText<A extends Action = Action> extends CL
 /**
  * A search result that can be rendered by Home UI.
  */
-export declare type HomeSearchResult = CLISearchResultContact<HomeAction> | CLISearchResultSimpleText<HomeAction> | CLISearchResultList<HomeAction> | CLISearchResultPlain<HomeAction>;
+export declare type HomeSearchResult = CLISearchResultContact<HomeAction> | CLISearchResultSimpleText<HomeAction> | CLISearchResultList<HomeAction> | CLISearchResultPlain<HomeAction> | CLISearchResultCustom<HomeAction>;
 export declare enum CLIFilterOptionType {
     /**
      * Display a multi-select drop down for the options

package/client-api/src/templates.d.ts

@@ -0,0 +1,135 @@
+/**
+ *  OpenFin Workspace Custom Templates API
+ *
+ *  @module Templates
+ */
+export declare type ListPairs = [string, string][];
+export declare type CustomTemplateData = Record<string, string | ListPairs>;
+export declare type ContainerFragmentTypes = PlainContainerTemplateFragment | ButtonTemplateFragment;
+export declare type PresentationFragmentTypes = TextTemplateFragment | ImageTemplateFragment | ListTemplateFragment;
+export declare type InteractiveFragmentTypes = ButtonTemplateFragment | TextTemplateFragment | ImageTemplateFragment;
+/**
+ * The options to build your custom template composition layout.
+ */
+export declare type TemplateFragment = PlainContainerTemplateFragment | ButtonTemplateFragment | TextTemplateFragment | ListTemplateFragment | ImageTemplateFragment;
+export declare const ContainerTemplateFragmentNames: {
+    readonly Container: "Container";
+    readonly Button: "Button";
+};
+export declare const PresentationTemplateFragmentNames: {
+    readonly Text: "Text";
+    readonly Image: "Image";
+    readonly List: "List";
+};
+export declare const TemplateFragmentTypes: {
+    readonly Text: "Text";
+    readonly Image: "Image";
+    readonly List: "List";
+    readonly Container: "Container";
+    readonly Button: "Button";
+};
+export interface BaseTemplateFragment<T extends keyof typeof TemplateFragmentTypes> {
+    /**
+     * Type of the template fragment.
+     */
+    type: T;
+    /**
+     * CSS style properties of the fragment.
+     *
+     * All the available custom template fragments support all of the React's inline style properties (with camelCase keys)
+     *
+     * Note: "position: fixed" is disallowed as a fragment style.
+     */
+    style?: Record<string, string | number>;
+}
+export interface FragmentAction {
+    /**
+     * The action that will be dispatched back to provider when this fragment is clicked.
+     *
+     */
+    action?: string;
+    /**
+     * The aria compliant description for this action.
+     * If you leave this blank, the renderer will generate a generic description of
+     * the fragment's type and its action.
+     *
+     */
+    actionDescription?: string;
+}
+export interface ContainerTemplateFragment<T extends keyof typeof ContainerTemplateFragmentNames> extends BaseTemplateFragment<T> {
+    /**
+     * Sub-fragments of the container.
+     *
+     * You can use container template fragment to create nested composition structures.
+     */
+    children?: TemplateFragment[];
+}
+export interface PresentationTemplateFragment<T extends keyof typeof PresentationTemplateFragmentNames> extends BaseTemplateFragment<T> {
+    /**
+     * Optional flag.
+     *
+     * If a template fragment is flagged as optional, The service will not require
+     * the fragment's `dataKey` to exist in `templateData`. If a fragment is optional and its data
+     * is missing, the fragment will be omitted quietly by the renderer.
+     */
+    optional?: boolean;
+    /**
+     * Data key of the template fragment.
+     *
+     * The data associated with this fragment will be looked up in `templateData` map with this key.
+     *
+     * Example:
+     * ```ts
+     * const myTemplateLayout = {
+     *    type: FragmentTypes.Text,
+     *    dataKey: 'info',
+     * }
+     *
+     * const searchResult: CLISearchResultCustom = {
+     *     //...
+     *     template: CLITemplate.Custom,
+     *     templateContent: {
+     *         layout: myTemplateLayout,
+     *         data: {
+     *             info: 'My Custom Search Result Info',
+     *         }
+     *     }
+     * };
+     * ```
+     *
+     */
+    dataKey: string;
+}
+/**
+ * Some common stylization options for the `Button` component.
+ */
+export declare enum ButtonStyle {
+    Primary = "primary",
+    Secondary = "secondary",
+    TextOnly = "textOnly"
+}
+export declare type PlainContainerTemplateFragment = ContainerTemplateFragment<'Container'>;
+export declare type ButtonTemplateFragment = ContainerTemplateFragment<'Button'> & FragmentAction & {
+    /**
+     * Style of the button emitted by this fragment.
+     */
+    buttonStyle?: ButtonStyle;
+};
+export declare type TextTemplateFragment = PresentationTemplateFragment<'Text'> & FragmentAction;
+export declare type ImageTemplateFragment = PresentationTemplateFragment<'Image'> & FragmentAction & {
+    /**
+     * Alternative (accessibility) text for the image.
+     */
+    alternativeText: string;
+};
+export declare type ListTemplateFragment = PresentationTemplateFragment<'List'>;
+export interface CustomTemplate {
+    /**
+     * Root of the template composition tree. See {@link ContainerTemplateFragment} for nesting.
+     */
+    layout: TemplateFragment;
+    /**
+     * Data associated with the custom search result template's presentation fragments.
+     */
+    data: CustomTemplateData;
+}

package/client-api-platform/src/api/app-directory.d.ts

@@ -4,4 +4,4 @@ import type { LaunchAppRequest } from '../shapes';
  * @param app the app directory entry.
  * @param opts launch options.
  */
-export declare function launchApp({ app, target }: LaunchAppRequest): Promise<void | import("openfin-adapter").View | import("openfin-adapter").Application | import("openfin-adapter/src/api/platform").Platform | import("openfin-adapter").Identity>;
+export declare function launchApp({ app, target }: LaunchAppRequest): Promise<void | import("openfin-adapter/src/api/platform").Platform | import("openfin-adapter").View | import("openfin-adapter").Application | import("openfin-adapter").Identity>;

package/client-api-platform/src/api/browser/browser-module.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="openfin-adapter/fin" />
 import type { AttachedPage, Page, PageWithUpdatableRuntimeAttribs } from '../../../../common/src/api/pages/shapes';
-import { OpenGlobalContextMenuRequest } from '../../../../client-api-platform/src/shapes';
+import { OpenPageTabContextMenuRequest } from '../../../../client-api-platform/src/index';
+import { IconTrayOptions, OpenGlobalContextMenuRequest, OpenViewTabContextMenuRequest, WindowStateButtonOptions } from '../../../../client-api-platform/src/shapes';
 export declare const getBrowserModule: (identity: OpenFin.Identity) => {
     identity: OpenFin.Identity;
     openfinWindow: import("openfin-adapter").Window;
@@ -12,4 +13,8 @@ export declare const getBrowserModule: (identity: OpenFin.Identity) => {
     updatePage: (req: any) => Promise<any>;
     reorderPages: (req: any) => Promise<any>;
     _openGlobalContextMenu: (req: OpenGlobalContextMenuRequest) => Promise<any>;
+    replaceIconTrayOptions: (options: IconTrayOptions) => Promise<void>;
+    replaceWindowStateButtonOptions: (options: WindowStateButtonOptions) => Promise<void>;
+    _openViewTabContextMenu: (req: OpenViewTabContextMenuRequest) => Promise<any>;
+    _openPageTabContextMenu: (req: OpenPageTabContextMenuRequest) => Promise<any>;
 };

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

@@ -1,5 +1,5 @@
 /// <reference types="openfin-adapter/fin" />
-import type { AttachedPage, Page } from '../../../../common/src/api/pages/shapes';
+import type { AttachedPage } from '../../../../common/src/api/pages/shapes';
 import type { BrowserCreateWindowRequest, BrowserWindowModule } from '../../shapes';
 export declare const getBrowserApi: (identity: OpenFin.ApplicationIdentity) => {
     wrapSync: (windowIdentity: OpenFin.Identity) => {
@@ -13,11 +13,14 @@ export declare const getBrowserApi: (identity: OpenFin.ApplicationIdentity) => {
         updatePage: (req: any) => Promise<any>;
         reorderPages: (req: any) => Promise<any>;
         _openGlobalContextMenu: (req: import("../../shapes").OpenGlobalContextMenuRequest) => Promise<any>;
+        replaceIconTrayOptions: (options: import("../../shapes").IconTrayOptions) => Promise<void>;
+        replaceWindowStateButtonOptions: (options: import("../../shapes").WindowStateButtonOptions) => Promise<void>;
+        _openViewTabContextMenu: (req: import("../../shapes").OpenViewTabContextMenuRequest) => Promise<any>;
+        _openPageTabContextMenu: (req: import("../../shapes").OpenPageTabContextMenuRequest) => Promise<any>;
     };
     createWindow: (options: BrowserCreateWindowRequest) => Promise<BrowserWindowModule>;
     getAllAttachedPages: () => Promise<AttachedPage[]>;
     getAllWindows: () => Promise<BrowserWindowModule[]>;
-    launchPage: (page: Page) => Promise<BrowserWindowModule>;
     getUniquePageTitle: (title?: string) => Promise<any>;
     getLastFocusedWindow: () => Promise<any>;
 };

package/client-api-platform/src/api/context-menu/browser-logo-handler.d.ts

@@ -1,10 +1,3 @@
-import { NamedIdentity } from 'openfin-adapter/src/identity';
-export declare enum MenuData {
-    NewWindow = "NEW_WINDOW",
-    NewPage = "NEW_PAGE",
-    CloseWindow = "CLOSE_WINDOW",
-    OpenStorefront = "OPEN_STOREFRONT",
-    Quit = "QUIT"
-}
-declare const handler: (winIdentity: NamedIdentity, data: MenuData) => Promise<void>;
+import { GlobalContextMenuItemData, OpenGlobalContextMenuPayload } from '../../shapes';
+declare const handler: (data: GlobalContextMenuItemData, payload: OpenGlobalContextMenuPayload) => Promise<void>;
 export default handler;

package/client-api-platform/src/api/context-menu/browser-pagetab-handler.d.ts

@@ -0,0 +1,3 @@
+import { OpenPageTabContextMenuPayload } from '../../../../client-api-platform/src/index';
+import { PageTabContextMenuItemData } from '../../../../client-api-platform/src/shapes';
+export declare const pageTabContextMenuItemHandler: (data: PageTabContextMenuItemData, payload: OpenPageTabContextMenuPayload) => Promise<void>;

package/client-api-platform/src/api/context-menu/browser-viewtab-handler.d.ts

@@ -0,0 +1,3 @@
+import { OpenViewTabContextMenuPayload, ViewTabMenuData } from '../../../../client-api-platform/src/index';
+declare const handler: (data: ViewTabMenuData, payload: OpenViewTabContextMenuPayload) => Promise<void>;
+export default handler;

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

@@ -1,6 +1,13 @@
 import { NamedIdentity } from 'openfin-adapter/src/identity';
-import { OpenGlobalContextMenuPayload, OpenGlobalContextMenuRequest } from '../../../../client-api-platform/src/shapes';
+import { OpenPageTabContextMenuPayload } from '../../../../client-api-platform/src/index';
+import { OpenGlobalContextMenuPayload, OpenGlobalContextMenuRequest, OpenPageTabContextMenuRequest, OpenViewTabContextMenuPayload, OpenViewTabContextMenuRequest } from '../../../../client-api-platform/src/shapes';
 export declare function openGlobalContextMenuInternal(payload: OpenGlobalContextMenuRequest & {
     identity: NamedIdentity;
 }, callerIdentity: any): Promise<void>;
-export declare const openGlobalContextMenu: (payload: OpenGlobalContextMenuPayload, callerIdentity: any) => Promise<void>;
+export declare const openCommonContextMenu: (payload: OpenGlobalContextMenuPayload | OpenViewTabContextMenuPayload | OpenPageTabContextMenuPayload, callerIdentity: any) => Promise<void>;
+export declare function openViewTabContextMenuInternal(payload: OpenViewTabContextMenuRequest & {
+    identity: NamedIdentity;
+}, callerIdentity: any): Promise<void>;
+export declare function openPageTabContextMenuInternal(payload: OpenPageTabContextMenuRequest & {
+    identity: NamedIdentity;
+}, callerIdentity: any): Promise<void>;

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

@@ -0,0 +1,4 @@
+/// <reference types="openfin-adapter/fin" />
+import { WorkspacePlatformModule } from '../shapes';
+export declare const wrapSync: (identity: OpenFin.ApplicationIdentity) => WorkspacePlatformModule;
+export declare const getCurrentSync: () => WorkspacePlatformModule;

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

@@ -20,7 +20,6 @@ export declare enum ChannelAction {
     UpdateSavedPageInternal = "updateSavedPageInternal",
     DeleteSavedPageInternal = "deleteSavedPageInternal",
     SharePage = "sharePage",
-    LaunchPage = "launchPage",
     UpdatePageForWindow = "updatePageForWindow",
     AttachPagesToWindow = "attachPagesToWindow",
     DetachPagesFromWindow = "detachPagesFromWindow",
@@ -35,6 +34,8 @@ export declare enum ChannelAction {
     GetLastFocusedBrowserWindow = "getLastFocusedBrowserWindow",
     GetThemes = "getThemes",
     OpenGlobalContextMenuInternal = "openGlobalContextMenuInternal",
+    OpenViewTabContextMenuInternal = "openViewTabContextMenuInternal",
+    OpenPageTabContextMenuInternal = "openPageTabContextMenuInternal",
     InvokeCustomActionInternal = "invokeCustomActionInternal"
 }
 /**

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

@@ -1,41 +1,3 @@
-/// <reference types="openfin-adapter/fin" />
-import type { WorkspacePlatformInitConfig, WorkspacePlatformModule } from './shapes';
 export * from './shapes';
-/**
- * Initilaize a Workspace Platform.
- *
- * ```ts
- * import * as WorkspacePlatform from '@openfin/workspace-platform';
- *
- * const customThemes: WorkspacePlatform.CustomThemes = [{
- *   label: "OpenFin's Custom Theme",
- *   palette: {
- *      // Required color options
- *      brandPrimary: '#F51F63',
- *      brandSecondary: '#1FF58A',
- *      backgroundPrimary: '#F8E71C', // hex, rgb/rgba, hsl/hsla only - no string colors: 'red'
- *   }
- * }
- *
- * const overrideCallback: WorkspacePlatform.BrowserOverrideCallback = async (
- *     WorkspacePlatformProvider
- *   ) => {
- *   class Override extends WorkspacePlatformProvider {
- *     async quit(payload, callerIdentity) {
- *       return super.quit(payload, callerIdentity);
- *     }
- *   }
- *   return new Override();
- * };
- *
- *
- * await WorkspacePlatform.init({
- *   browser: { overrideCallback },
- *   theme: customThemes
- * });
- * ```
- * @param options options for configuring the platform.
- */
-export declare const init: (options: WorkspacePlatformInitConfig) => Promise<void>;
-export declare const wrapSync: (identity: OpenFin.ApplicationIdentity) => WorkspacePlatformModule;
-export declare const getCurrentSync: () => WorkspacePlatformModule;
+export { init } from './init';
+export { getCurrentSync, wrapSync } from './api';

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

@@ -1,5 +1,37 @@
-import { BrowserInitConfig } from '../shapes';
+import type { WorkspacePlatformInitConfig } from '../shapes';
 /**
- * Initializing the Workspace Platform.
+ * Initilaize a Workspace Platform.
+ *
+ * ```ts
+ * import * as WorkspacePlatform from '@openfin/workspace-platform';
+ *
+ * const customThemes: WorkspacePlatform.CustomThemes = [{
+ *   label: "OpenFin's Custom Theme",
+ *   palette: {
+ *      // Required color options
+ *      brandPrimary: '#F51F63',
+ *      brandSecondary: '#1FF58A',
+ *      backgroundPrimary: '#F8E71C', // hex, rgb/rgba, hsl/hsla only - no string colors: 'red'
+ *   }
+ * }
+ *
+ * const overrideCallback: WorkspacePlatform.BrowserOverrideCallback = async (
+ *     WorkspacePlatformProvider
+ *   ) => {
+ *   class Override extends WorkspacePlatformProvider {
+ *     async quit(payload, callerIdentity) {
+ *       return super.quit(payload, callerIdentity);
+ *     }
+ *   }
+ *   return new Override();
+ * };
+ *
+ *
+ * await WorkspacePlatform.init({
+ *   browser: { overrideCallback },
+ *   theme: customThemes
+ * });
+ * ```
+ * @param options options for configuring the platform.
  */
-export default function init(options: BrowserInitConfig): Promise<void>;
+export declare const init: (options: WorkspacePlatformInitConfig) => Promise<void>;

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

@@ -1,7 +1,7 @@
 /// <reference types="openfin-adapter/fin" />
 import { Identity } from 'openfin-adapter';
 import type { CustomThemeOptions } from '../../../common/src/api/theming';
-import { BrowserCreateWindowRequest } from '..';
+import type { BrowserInitConfig } from '..';
 export declare function overrideViewOptions(options: Partial<OpenFin.ViewOptions>, initOptions: OpenFin.ViewOptions): any;
 export declare function preserveInteropIfManifestConflict(opts: Partial<OpenFin.ViewOptions>, fetchManifest: ({ manifestUrl: string }: {
     manifestUrl: any;
@@ -28,18 +28,6 @@ declare type LegacyWindowOptions = Omit<OpenFin.PlatformWindowCreationOptions, '
     workstacks?: OpenFin.Page[];
 };
 export declare const initWorkspacePlatformOptions: (options: LegacyWindowOptions | OpenFin.PlatformWindowCreationOptions) => OpenFin.PlatformWindowCreationOptions;
-/**
- * hasLayout()
- * Function to force layout settings
- * - Check if layout property exists if so process data, else return as is
- * - Define behavior settings
- * - Force dimension options
- * - Validate icon
- *
- * Ticket: WRK-???
- *
- * @param options - options used to handle layout settings
- * @returns processed or unprocesseed options
- */
-export declare const applyBrowserDefaults: (options: OpenFin.PlatformWindowCreationOptions, initOptions: BrowserCreateWindowRequest, theme: CustomThemeOptions) => OpenFin.PlatformWindowCreationOptions;
+export declare const applyPageDefaults: (pages: OpenFin.Page[], defaultPageOptions?: BrowserInitConfig['defaultPageOptions']) => OpenFin.Page[];
+export declare const applyBrowserDefaults: (options: OpenFin.PlatformWindowCreationOptions, initOptions: Pick<BrowserInitConfig, 'defaultWindowOptions' | 'defaultPageOptions'>, theme: CustomThemeOptions) => OpenFin.PlatformWindowCreationOptions;
 export {};