@openfin/workspace-platform 4.3.0 → 4.7.0

package/src/init/override-callback.ts

@@ -1,159 +0,0 @@
-import { getSnapshotExtended } from '@common/utils/snapshot';
-import { closeBrowserWindows } from '@common/utils/window';
-
-import * as defaultPagesProvider from '@common/api/pages/idb';
-
-import type { BrowserInitConfig } from '@client-platform/shapes';
-
-import { launchApp } from '../api/app-directory';
-import {
-    attachPagesToWindow,
-    createSavedPageInternal,
-    deleteSavedPageInternal,
-    detachPagesFromWindow,
-    getOpenPages,
-    getPageForWindow,
-    getPagesForWindow,
-    getUniquePageTitle,
-    reorderPagesForWindow,
-    savePage,
-    setActivePageForWindow,
-    updatePageForWindow,
-    updateSavedPageInternal
-} from '../api/pages';
-import { applySnapshotWithPages, getSnapshotWithPages } from '../api/pages/helper';
-
-import { getLastFocusedBrowserWindow } from './browser-window-focus';
-import {
-    applyBrowserDefaults,
-    filterSnapshotWindows,
-    fitToMonitor,
-    initWorkspacePlatformOptions,
-    overrideViewOptions
-} from './utils';
-
-export const getOverrideCallback = (
-    initOptions: BrowserInitConfig
-): OpenFin.OverrideCallback<OpenFin.PlatformProvider> => async (Provider) => {
-    class Override extends Provider {
-        async getSnapshot() {
-            const originalSnap = await getSnapshotWithPages(async () =>
-                getSnapshotExtended(await super.getSnapshot(undefined, fin.me.identity))
-            );
-            const finalSnapshot = {
-                ...originalSnap,
-                windows: originalSnap.windows.filter(filterSnapshotWindows)
-            };
-            return finalSnapshot;
-        }
-
-        async applySnapshot({ snapshot, options }) {
-            const superApplySnapshot = (superSnapshot) =>
-                super.applySnapshot({
-                    snapshot: superSnapshot,
-                    options: { ...options, closeExistingWindows: false }
-                });
-
-            if (options?.closeExistingWindows) {
-                await closeBrowserWindows();
-            }
-            let targetSnapshot = snapshot;
-
-            if (typeof targetSnapshot === 'string') {
-                targetSnapshot = await super.fetchManifest({ manifestUrl: targetSnapshot }, fin.me.identity);
-            }
-
-            return applySnapshotWithPages(targetSnapshot, superApplySnapshot);
-        }
-
-        async createWindow(options: OpenFin.PlatformWindowCreationOptions, callerIdentity) {
-            let overrideOptions = initWorkspacePlatformOptions(options);
-
-            // override options if layout exists
-            overrideOptions = applyBrowserDefaults(overrideOptions);
-
-            // Fixes height issue on mac for workspaces loading on small monitors
-            // override default value sizes to fit available rectangle
-            overrideOptions = await fitToMonitor(overrideOptions);
-
-            return super.createWindow(overrideOptions, callerIdentity);
-        }
-
-        async createView(payload: OpenFin.CreateViewPayload, callerIdentity) {
-            overrideViewOptions(payload.opts);
-            return super.createView(payload, callerIdentity);
-        }
-
-        async replaceView(payload: OpenFin.ReplaceViewPayload, callerIdentity) {
-            overrideViewOptions(payload.opts.newView);
-            return super.replaceView(payload, callerIdentity);
-        }
-
-        async replaceLayout(payload, caller) {
-            // force our dimensions as well (particularly headerHeight)
-            delete payload.opts.layout?.dimensions;
-            return super.replaceLayout(payload, caller);
-        }
-
-        async closeView(payload: OpenFin.CloseViewPayload, callerIdentity) {
-            const view = fin.View.wrapSync(payload.view);
-            await super.closeView(payload, callerIdentity);
-            await view.destroy().catch((e) => e); // do nothing, view destroyed by super
-        }
-
-        isWorkspacePlatform = () => true;
-
-        // *****STORAGE APIs - SHOULD NOT USE INDEXEDDB STORAGE BY DEFAULT
-        getSavedPage = defaultPagesProvider.getPage;
-
-        getSavedPages = defaultPagesProvider.getPageList;
-
-        createSavedPage = defaultPagesProvider.createPage;
-
-        deleteSavedPage = defaultPagesProvider.deletePage;
-
-        updateSavedPage = defaultPagesProvider.updatePage;
-        // *****END STORAGE APIs
-
-        // *****EXECUTION APIs
-        // ***EXPOSE TO API
-        attachPagesToWindow = attachPagesToWindow;
-
-        addPage = attachPagesToWindow;
-
-        detachPagesFromWindow = detachPagesFromWindow;
-
-        getOpenPages = getOpenPages;
-
-        getPagesForWindow = getPagesForWindow;
-
-        getPageForWindow = getPageForWindow;
-
-        setActivePageForWindow = setActivePageForWindow;
-
-        launchApp = launchApp;
-
-        // INTERNAL ONLY EXECUTION APIs
-        savePage = savePage;
-
-        createSavedPageInternal = createSavedPageInternal;
-
-        updateSavedPageInternal = updateSavedPageInternal;
-
-        deleteSavedPageInternal = deleteSavedPageInternal;
-
-        reorderPagesForWindow = reorderPagesForWindow;
-
-        getUniquePageTitle = getUniquePageTitle;
-
-        updatePageForWindow = updatePageForWindow;
-
-        getLastFocusedBrowserWindow = getLastFocusedBrowserWindow;
-    }
-
-    // Client API Overrides our overrides
-    if (typeof initOptions?.overrideCallback === 'function') {
-        return initOptions.overrideCallback(Override);
-    }
-    return new Override();
-};

package/src/init/utils.ts

@@ -1,164 +0,0 @@
-import { workspaceCdnEnvUrl } from '@common/utils/env';
-import Route from '@common/utils/route';
-import { WindowName } from '@common/utils/window';
-
-import type { AttachedPage } from '@common/api/pages/shapes';
-
-const defaultBrowserUrl = workspaceCdnEnvUrl + Route.Browser;
-
-export function overrideViewOptions(options: Partial<OpenFin.ViewOptions>) {
-    options.detachOnClose = true;
-}
-
-export const filterSnapshotWindows = (win: OpenFin.WindowOptions) => {
-    const isHome = win.name === WindowName.Home;
-    const isHomeInternal = win.name?.startsWith(WindowName.HomeInternal);
-    const isInternalMenu = win.name?.startsWith(WindowName.BrowserMenu);
-    return !isHome && !isHomeInternal && !isInternalMenu;
-};
-
-/**
- * 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 const fitToMonitor = async (options) => {
-    // get monitor dimensions
-    const monitor = await fin.System.getMonitorInfo();
-
-    // Extract the max height from the available area between top and bottom
-    const maxHeight = monitor.primaryMonitor.availableRect.bottom - monitor.primaryMonitor.availableRect.top;
-    const maxWidth = monitor.primaryMonitor.availableRect.right - monitor.primaryMonitor.availableRect.left;
-
-    /**
-     * Q?: Should these default values be somewhere global?
-     * I know that we have values set somewhere, probably in
-     * a database or backend, but I don't see anything
-     * defined in the workspace code.
-     */
-    // createView doesn't pass default size properties, so defaults added here
-    options.defaultHeight = options.defaultHeight || '800';
-    options.defaultWidth = options.defaultWidth || '800';
-
-    // if max height is less than default height set default height to max height
-    if (maxHeight < options.defaultHeight) {
-        options.defaultHeight = maxHeight;
-    }
-    // if max width is less than default width set default width to max width
-    if (maxWidth < options.defaultWidth) {
-        options.defaultWidth = maxWidth;
-    }
-
-    return options;
-};
-
-type LegacyWindowOptions = Omit<OpenFin.PlatformWindowCreationOptions, 'workspacePlatform'> & {
-    pages?: OpenFin.Page[];
-    workstacks?: OpenFin.Page[];
-};
-
-const migrateLegacyOptions = ({
-    workstacks,
-    pages,
-    ...rest
-}: LegacyWindowOptions): OpenFin.PlatformWindowCreationOptions => {
-    return { ...rest, workspacePlatform: { pages: pages || workstacks || null } };
-};
-
-export const initWorkspacePlatformOptions = (
-    options: LegacyWindowOptions | OpenFin.PlatformWindowCreationOptions
-): OpenFin.PlatformWindowCreationOptions => {
-    if ('workspacePlatform' in options) return options;
-
-    return migrateLegacyOptions(options);
-};
-
-const defaultWindowOptions = {
-    contextMenuSettings: {
-        reload: false
-    },
-    url: defaultBrowserUrl,
-    contextMenu: true,
-    waitForPageLoad: true,
-    cornerRounding: {
-        height: 8,
-        width: 8
-    },
-    closeOnLastViewRemoved: false,
-    experimental: {
-        showFavicons: true,
-        defaultFaviconUrl: `${workspaceCdnEnvUrl}/icons/defaultFavicon.svg`
-    },
-    permissions: {
-        System: {
-            openUrlWithBrowser: {
-                enabled: true,
-                protocols: ['mailto']
-            }
-        }
-    }
-};
-
-const defaultLayout = {
-    dimensions: {
-        borderWidth: 3,
-        headerHeight: 30
-    }
-};
-
-/**
- * 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 const applyBrowserDefaults = (options: OpenFin.PlatformWindowCreationOptions) => {
-    const pages: AttachedPage[] = options?.workspacePlatform?.pages;
-    if (pages) {
-        const activePage = pages.find((page) => page.isActive);
-        if (activePage) {
-            options.layout = activePage.layout;
-        } else {
-            pages[0].isActive = true;
-            options.layout = pages[0].layout;
-        }
-    }
-    if (options.layout) {
-        // If the window has a layout it should always be opened in our default browser window
-        // TODO: Would need to alter this to allow for non-Browser layout windows
-        Object.assign(options, defaultWindowOptions);
-        options.layout = Object.assign(options.layout, defaultLayout);
-
-        // just use the normal OpenFin icon and taskbarIcon options
-        if (options.icon || (options as any).taskbarIcon) {
-            options.taskbarIconGroup = options.taskbarIconGroup || fin.me.identity.uuid;
-        }
-
-        const newTabUrl = options.workspacePlatform.newTabUrl;
-        if (newTabUrl) {
-            if (!options.layout.settings) {
-                options.layout.settings = {};
-            }
-            options.layout.settings.newTabButton = { url: newTabUrl };
-        }
-    }
-    return options;
-};

package/src/shapes.ts

@@ -1,160 +0,0 @@
-import type { InteropBroker } from 'openfin-adapter/src/api/interop';
-
-import type { App } from '../../client-api/src/shapes';
-import type { AttachedPage, Page, PageWithUpdatableRuntimeAttribs } from '../../common/src/api/pages/shapes';
-
-export type { App, Image, AppIntent } from '../../client-api/src/shapes';
-export { AppManifestType } from '../../client-api/src/shapes';
-
-export interface CreateSavedPageRequest {
-    page: Page;
-}
-
-export interface UpdateSavedPageRequest {
-    /** The ID of the page to update. */
-    pageId: string;
-
-    /** The updated page. */
-    page: Page;
-}
-
-export interface ReorderPagesRequest {
-    /** The ordered ids of the attached pages. */
-    pageIds: string[];
-}
-
-export interface UpdateOpenPageRequest {
-    /** The ID of the page to update. */
-    pageId: string;
-
-    /** The updated page. */
-    page: Partial<PageWithUpdatableRuntimeAttribs>;
-}
-
-export type { Page, PageLayout, PageLayoutDetails } from '../../common/src/api/pages/shapes';
-
-export type BrowserCreateWindowRequestInternal = BrowserCreateWindowRequest & OpenFin.WindowCreationOptions;
-
-export interface BrowserCreateWindowRequest extends Omit<OpenFin.PlatformWindowCreationOptions, 'workspacePlatform'> {
-    workspacePlatform: {
-        pages: Page[];
-        favicon?: string;
-        title?: string;
-        newTabUrl?: string;
-        newPageUrl?: string;
-    };
-}
-
-export interface BrowserWindowModule {
-    identity: OpenFin.Identity;
-    openfinWindow: OpenFin.Window;
-    getPage(id: string): Promise<AttachedPage>;
-    /**
-     * Return all the pages that are attached to a browser window.
-     */
-    getPages(): Promise<AttachedPage[]>;
-
-    setActivePage(id: string): Promise<void>;
-
-    /**
-     * Attach a page to a browser window.
-     * If a page with same id or title is attached to an existing browser window, an error will be thrown.
-     *
-     * @param page the attach page to a browser window.
-     */
-    addPage(page: PageWithUpdatableRuntimeAttribs): Promise<void>;
-    removePage(id: string): Promise<void>;
-    updatePage(req: UpdateOpenPageRequest): Promise<void>;
-    reorderPages(req: ReorderPagesRequest): Promise<void>;
-}
-
-export interface BrowserWindowFactory {
-    /**
-     * Synchronously returns a Browser Window object that represents an existing window
-     *
-     * @param identity of the window
-     */
-    wrapSync: (identity: OpenFin.Identity) => BrowserWindowModule;
-    /**
-     * Get a list of pages that are open on browser windows.
-     */
-    getOpenPages(): Promise<AttachedPage[]>;
-    /**
-     *  Get all the Browser Windows that are open in the Workspace Platform
-     *
-     */
-    getAllWindows(): Promise<BrowserWindowModule[]>;
-    // Overrideable execution APIs - WILL BE PART OF OVERRIDECALLBACK - TOP LEVEL, NOT NESTED
-    /**
-     * Create a new browser window.
-     *
-     * @param options the browser window creation options
-     */
-    createWindow: (options: BrowserCreateWindowRequest) => Promise<BrowserWindowModule>;
-
-    /**
-     * Get a unique title for a page.
-     * @param title a prefix for the title.
-     */
-    getUniquePageTitle(title?: string): Promise<string>;
-
-    /**
-     * Get the identity of the last focused Browser window.
-     */
-    getLastFocusedWindow(): Promise<OpenFin.Identity>;
-}
-
-export interface WorkspacePlatformStorage {
-    getPages(): Promise<Page[]>;
-    getPage(id: string): Promise<Page>;
-    createPage(page: CreateSavedPageRequest): Promise<void>;
-    updatePage(req: UpdateSavedPageRequest): Promise<void>;
-    deletePage(id: string): Promise<void>;
-    savePage(page: Page): Promise<void>;
-}
-
-export interface LaunchAppPayload {
-    target?: OpenFin.EntityInfo;
-    app: App;
-}
-
-export interface WorkspacePlatformModule extends OpenFin.Platform {
-    /**
-     * Launch a browser snapshot that contains windows with pages.
-     *
-     * @param snapshot the browser snapshot to launch or a url or filepath to retrieve a JSON snapshot.
-     */
-    applySnapshot(snapshot: BrowserSnapshot | string): Promise<OpenFin.Platform>;
-
-    getSnapshot(): Promise<BrowserSnapshot>;
-
-    launchApp: (payload: LaunchAppPayload) => Promise<void>;
-
-    Browser: BrowserWindowFactory;
-
-    Storage: WorkspacePlatformStorage;
-}
-
-export interface BrowserSnapshot {
-    windows: BrowserCreateWindowRequestInternal[];
-}
-export interface WorkspacePlatformProvider extends OpenFin.PlatformProvider {
-    // Storage Overrides
-    getSavedPages(query?: string): Promise<Page[]>;
-    getSavedPage(id: string): Promise<Page>;
-    createSavedPage(req: CreateSavedPageRequest): Promise<void>;
-    updateSavedPage(req: UpdateSavedPageRequest): Promise<void>;
-    deleteSavedPage(id: string): Promise<void>;
-}
-
-export interface WorkspacePlatformInitConfig {
-    browser: BrowserInitConfig;
-    licenseKey: string;
-    theme?: any;
-}
-export interface BrowserInitConfig {
-    defaultWindowOptions?: BrowserCreateWindowRequest;
-    defaultViewOptions?: OpenFin.ViewOptions;
-    overrideCallback?: Partial<OpenFin.OverrideCallback<WorkspacePlatformProvider, WorkspacePlatformProvider>>;
-    interopOverride?: OpenFin.OverrideCallback<InteropBroker, InteropBroker>;
-}

package/src/umd.ts

@@ -1,5 +0,0 @@
-import injectAPI from '@common/utils/umd';
-
-import * as WorkspacePlatform from '../index';
-
-injectAPI('Workspace.WorkspacePlatform', WorkspacePlatform);

package/tsconfig.json

@@ -1,13 +0,0 @@
-{
-    "extends": "@openfin/common/tsconfig.json",
-    "compilerOptions": {
-        "outDir": "out",
-        "noUnusedLocals": true,
-        "downlevelIteration": true,
-        "declaration": true,
-        "removeComments": false,
-        "noEmit": false
-    },
-    "include": ["./src/**/*.ts", "./src/**/*.tsx", "../common/common.d.ts"],
-    "exclude": ["node_modules"]
-}

package/webpack.common.config.js

@@ -1 +0,0 @@
-module.exports = require('@openfin/common/webpack.common.config');