@openfin/workspace 6.2.4 → 6.3.0

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

@@ -0,0 +1,3 @@
+export * from './shapes';
+export { init } from './init';
+export { getCurrentSync, wrapSync } from './api';

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

@@ -0,0 +1,3 @@
+import { CustomActionsMap, InvokeCustomActionRequest } from '..';
+export declare const initCustomActions: (actions: CustomActionsMap) => void;
+export declare const invokeCustomActionInternal: ({ actionId, payload }: InvokeCustomActionRequest) => any;

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

@@ -0,0 +1,37 @@
+import type { WorkspacePlatformInitConfig } 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>;

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

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

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,33 @@
+/// <reference types="openfin-adapter/fin" />
+import { Identity } from 'openfin-adapter';
+import type { CustomThemeOptions } from '../../../common/src/api/theming';
+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;
+}, 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;
+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 {};