@openfin/workspace-platform 5.2.0 → 5.5.0

package/client-api-platform/src/api/pages/helper.d.ts

@@ -0,0 +1,22 @@
+/// <reference types="openfin-adapter/fin" />
+import { SnapshotExtended } from '../../../../common/src/utils/snapshot';
+/**
+ * Get a snapshot with pages.
+ *
+ * Makes sure that the layout of the page is up to date with the window's layout.
+ *
+ * @returns a snapshot with windows that contain pages.
+ */
+export declare function getSnapshotWithPages(superGetSnapshot?: () => Promise<SnapshotExtended>): Promise<SnapshotExtended>;
+/**
+ * Launch a snapshot that contains windows with pages.
+ *
+ * If a page with the same ID is already launched in the platform,
+ * focus and set it as the active page.
+ *
+ * If there is no page on the desktop with the same ID, launch
+ * the new window with the page.
+ *
+ * @param snapshot the snapshot to launch.
+ */
+export declare function applySnapshotWithPages(snapshot: OpenFin.Snapshot, superApplySnapshot?: (superSnapshot: OpenFin.Snapshot) => Promise<void>): Promise<void>;

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

@@ -0,0 +1,30 @@
+/// <reference types="openfin-adapter/fin" />
+import type { AttachPagesToWindowPayload } from '../../../../common/src/api/pages/shapes';
+import type { CreateSavedPageRequest, Page, UpdateSavedPageRequest } from '../../../../client-api-platform/src/shapes';
+/**
+ * Get all open pages in which are attached to a window.
+ * @returns the list of attached pages.
+ */
+export declare const getAllAttachedPages: () => Promise<import("@client-platform/shapes").AttachedPage[]>;
+export declare const createSavedPageInternal: ({ page }: CreateSavedPageRequest) => Promise<void>;
+export declare const deleteSavedPageInternal: (id: string) => Promise<void>;
+export declare const updateSavedPageInternal: ({ pageId, page }: UpdateSavedPageRequest) => Promise<any>;
+export declare const savePage: (page: Page) => Promise<any>;
+export declare const attachPagesToWindow: (payload: AttachPagesToWindowPayload) => Promise<void>;
+export declare const updatePageForWindow: (payload: any) => Promise<void>;
+export declare const detachPagesFromWindow: (payload: any) => Promise<void>;
+export declare const setActivePage: (payload: any) => Promise<void>;
+export declare const getPagesForWindow: (identity: OpenFin.Identity) => Promise<import("@client-platform/shapes").AttachedPage[]>;
+export declare const getPageForWindow: ({ identity, pageId }: {
+    identity: any;
+    pageId: any;
+}) => Promise<import("@client-platform/shapes").AttachedPage>;
+export declare const reorderPagesForWindow: (payload: any) => Promise<void>;
+export declare const getActivePageIdForWindow: (identity: any) => Promise<string>;
+/**
+ * Checks if a given page name is unique
+ * If not, add a progressive number to it
+ * @param initialName The initial name to test
+ * @returns string: a unique page name
+ */
+export declare function getUniquePageTitle(initialName?: string): Promise<string>;

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

@@ -0,0 +1,48 @@
+/// <reference types="openfin-adapter/fin" />
+/**
+ * All of the remote procedures that can be called in the
+ * a Workspace Platform's address space.
+ *
+ * When adding a new channel action make sure to add a function that's name matches
+ * the value of the enum for the remote procedure in the Workspace Platform overrides.
+ * All of the registered channel action handlers can be found here in the platform's overrides:
+ * @see link: [Provider Protocol Handlers](https://github.com/openfin/workspace/client-api-platform/src/init/override-callback.ts)
+ */
+export declare enum ChannelAction {
+    LaunchApp = "launchApp",
+    SavePage = "savePage",
+    GetSavedPage = "getSavedPage",
+    CreateSavedPage = "createSavedPage",
+    UpdateSavedPage = "updateSavedPage",
+    DeleteSavedPage = "deleteSavedPage",
+    GetSavedPages = "getSavedPages",
+    CreateSavedPageInternal = "createSavedPageInternal",
+    UpdateSavedPageInternal = "updateSavedPageInternal",
+    DeleteSavedPageInternal = "deleteSavedPageInternal",
+    SharePage = "sharePage",
+    LaunchPage = "launchPage",
+    UpdatePageForWindow = "updatePageForWindow",
+    AttachPagesToWindow = "attachPagesToWindow",
+    DetachPagesFromWindow = "detachPagesFromWindow",
+    ReorderPagesForWindow = "reorderPagesForWindow",
+    SetActivePage = "setActivePage",
+    GetAllAttachedPages = "getAllAttachedPages",
+    GetActivePageIdForWindow = "getActivePageIdForWindow",
+    GetPagesForWindow = "getPagesForWindow",
+    GetPageForWindow = "getPageForWindow",
+    GetSavedPageMetadata = "getSavedPageMetadata",
+    GetUniquePageTitle = "getUniquePageTitle",
+    GetLastFocusedBrowserWindow = "getLastFocusedBrowserWindow",
+    GetThemes = "getThemes"
+}
+/**
+ * Get a channel client for a specific Workspace platform.
+ *
+ * The channel client can execute remote procedures on the platform via its `dispatch` function.
+ * A call to the `dispatch` function will block until the channel action has concluded execution
+ * in the Workspace platform's address space.
+ * For a list of supported procedures, see the `ChannelAction` enum.
+ *
+ * @returns the channel client for the Workspace platform.
+ */
+export declare const getChannelClient: (identity: OpenFin.ApplicationIdentity) => Promise<import("openfin-adapter").ChannelClient>;

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

@@ -0,0 +1,10 @@
+import { Page } from '../../../common/src/api/pages/shapes';
+import type { CreateSavedPageRequest, UpdateSavedPageRequest } from '../shapes';
+export declare const getStorageApi: (identity: any) => {
+    createPage: (req: CreateSavedPageRequest) => Promise<any>;
+    deletePage: (id: string) => Promise<any>;
+    updatePage: (req: UpdateSavedPageRequest) => Promise<any>;
+    getPage: (id: string) => Promise<any>;
+    getPages: (query?: string) => Promise<Page[]>;
+    savePage: (page: Page) => Promise<any>;
+};

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

@@ -0,0 +1,5 @@
+/// <reference types="openfin-adapter/fin" />
+import type { CustomThemes } from '../../../common/src/api/theming';
+export declare const getThemingApi: (identity: OpenFin.ApplicationIdentity) => {
+    getThemes: () => Promise<CustomThemes>;
+};

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

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

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

@@ -0,0 +1,41 @@
+/// <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;

package/client-api-platform/src/init/browser-window-focus.d.ts

@@ -0,0 +1,19 @@
+/// <reference types="openfin-adapter/fin" />
+/**
+ * Get the last focused browser window.
+ * @returns the last focused browser window.
+ */
+export declare function getLastFocusedBrowserWindow(): Promise<OpenFin.Identity>;
+/**
+ * Set the OpenFin identity of the last focused browser window.
+ */
+export declare function setLastFocusedBrowserWindow(identity?: OpenFin.Identity): void;
+/**
+ * Listen for a browser window to be focused.
+ * When a browser window is focused, store it in local storage as the last focused browser window.
+ */
+export declare function listenForBrowserWindowFocus(): Promise<void>;
+/**
+ * Stop listening for a browser window to be focused.
+ */
+export declare function removeBrowserWindowFocusListener(): Promise<void>;

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

@@ -0,0 +1 @@
+export default function registerViewCleanUp(): void;

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

@@ -0,0 +1,5 @@
+import { BrowserInitConfig } from '../shapes';
+/**
+ * Initializing the Workspace Platform.
+ */
+export default function init(options: BrowserInitConfig): Promise<void>;

package/client-api-platform/src/init/override-callback.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="openfin-adapter/fin" />
+import type { BrowserInitConfig } from '../../../client-api-platform/src/shapes';
+export declare const getOverrideCallback: (initOptions: BrowserInitConfig) => OpenFin.OverrideCallback<OpenFin.PlatformProvider>;

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

@@ -0,0 +1,9 @@
+import { CustomThemes } from '../shapes';
+export declare const getThemes: () => CustomThemes;
+/**
+ * initTheming()
+ * Accepts an array of CustomThemes objects and stores it
+ * @param customPaletteOptions - optional - array of custom color pallettes
+ * @returns array of custom theme objects
+ */
+export default function initTheming(customPalettes: CustomThemes): void;

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

@@ -0,0 +1,45 @@
+/// <reference types="openfin-adapter/fin" />
+import { Identity } from 'openfin-adapter';
+import type { CustomThemeOptions } from '../../../common/src/api/theming';
+import { BrowserCreateWindowRequest } from '..';
+export declare function overrideViewOptions(options: Partial<OpenFin.ViewOptions>, initOptions: OpenFin.ViewOptions): OpenFin.ViewOptions & Partial<OpenFin.ViewOptions>;
+export declare function preserveInteropIfManifestConflict(opts: Partial<OpenFin.ViewOptions>, fetchManifest: ({ manifestUrl: string }: {
+    manifestUrl: any;
+}, callerIdentity: Identity) => any, callerIdentity: Identity): Promise<any>;
+export declare const filterSnapshotWindows: (win: OpenFin.WindowOptions) => boolean;
+/**
+ * fitToMonitor()
+ * Function to determine if window size is too large
+ * for available rectangle area.
+ *
+ * - Checks monitor data for available rectangle coords
+ * - Defines max width/height for current monitor
+ * - Defines default width/height if property is not set
+ * - Updates options object default width/height if they exceed max values
+ *
+ * Ticket: WRK-1084
+ *
+ * @param options - Object passed into createWindow -> contains height and width
+ * @returns unprocessed or processed options object
+ */
+export declare const fitToMonitor: (options: any) => Promise<any>;
+declare type LegacyWindowOptions = Omit<OpenFin.PlatformWindowCreationOptions, 'workspacePlatform'> & {
+    pages?: OpenFin.Page[];
+    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 {};