@openfin/core 33.76.36 → 33.76.38

package/src/api/platform/layout/Instance.js

@@ -1,224 +0,0 @@
-"use strict";
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var _Layout_layoutClient;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Layout = void 0;
-const lazy_1 = require("../../../util/lazy");
-const validate_1 = require("../../../util/validate");
-const base_1 = require("../../base");
-const common_utils_1 = require("../common-utils");
-const layout_entities_1 = require("./entities/layout-entities");
-const layout_constants_1 = require("./layout.constants");
-class Layout extends base_1.Base {
-    /**
-     * @internal
-     */
-    // eslint-disable-next-line no-shadow
-    constructor(identity, wire) {
-        super(wire);
-        /**
-         * @internal
-         * Lazily constructed {@link LayoutEntitiesClient} bound to this platform's client and identity
-         * The client is for {@link LayoutEntitiesController}
-         */
-        _Layout_layoutClient.set(this, new lazy_1.Lazy(async () => layout_entities_1.LayoutNode.newLayoutEntitiesClient(await this.platform.getClient(), layout_constants_1.LAYOUT_CONTROLLER_ID, this.identity)));
-        /**
-         * Replaces a Platform window's layout with a new layout.
-         *
-         * @remarks Any views that were in the old layout but not the new layout will be destroyed. Views will be assigned a randomly generated name to avoid collisions.
-         * @example
-         * ```js
-         * let windowIdentity;
-         * if (fin.me.isWindow) {
-         *     windowIdentity = fin.me.identity;
-         * } else if (fin.me.isView) {
-         *     windowIdentity = (await fin.me.getCurrentWindow()).identity;
-         * } else {
-         *     throw new Error('Not running in a platform View or Window');
-         * }
-         *
-         * const layout = fin.Platform.Layout.wrapSync(windowIdentity);
-         *
-         * const newLayout = {
-         *     content: [
-         *         {
-         *             type: 'stack',
-         *             content: [
-         *                 {
-         *                     type: 'component',
-         *                     componentName: 'view',
-         *                     componentState: {
-         *                         name: 'new_component_A1',
-         *                         processAffinity: 'ps_1',
-         *                         url: 'https://www.example.com'
-         *                     }
-         *                 },
-         *                 {
-         *                     type: 'component',
-         *                     componentName: 'view',
-         *                     componentState: {
-         *                         name: 'new_component_A2',
-         *                         url: 'https://cdn.openfin.co/embed-web/chart.html'
-         *                     }
-         *                 }
-         *             ]
-         *         }
-         *     ]
-         * };
-         *
-         * layout.replace(newLayout);
-         * ```
-         */
-        this.replace = async (layout) => {
-            this.wire.sendAction('layout-replace').catch((e) => {
-                // don't expose
-            });
-            const client = await this.platform.getClient();
-            await client.dispatch('replace-layout', {
-                target: this.identity,
-                opts: { layout }
-            });
-        };
-        /**
-         * Replaces the specified view with a view with the provided configuration.
-         *
-         * @remarks The old view is stripped of its listeners and either closed or attached to the provider window
-         * depending on `detachOnClose` view option.
-         *
-         * @param viewToReplace Identity of the view to be replaced
-         * @param newView Creation options of the new view.
-         *
-         * @example
-         * ```js
-         * let currentWindow;
-         * if (fin.me.isWindow) {
-         *     currentWindow = fin.me;
-         * } else if (fin.me.isView) {
-         *     currentWindow = await fin.me.getCurrentWindow();
-         * } else {
-         *     throw new Error('Not running in a platform View or Window');
-         * }
-         *
-         * const layout = fin.Platform.Layout.wrapSync(currentWindow.identity);
-         * const viewToReplace = (await currentWindow.getCurrentViews())[0];
-         * const newViewConfig = {url: 'https://example.com'};
-         * await layout.replaceView(viewToReplace.identity, newViewConfig);
-         * ```
-         */
-        this.replaceView = async (viewToReplace, newView) => {
-            this.wire.sendAction('layout-replace-view').catch((e) => {
-                // don't expose
-            });
-            const client = await this.platform.getClient();
-            await client.dispatch('replace-view', {
-                target: this.identity,
-                opts: { viewToReplace, newView }
-            });
-        };
-        /**
-         * Replaces a Platform window's layout with a preset layout arrangement using the existing Views attached to the window.
-         * The preset options are `columns`, `grid`, `rows`, and `tabs`.
-         * @param options Mandatory object with `presetType` property that sets which preset layout arrangement to use.
-         * The preset options are `columns`, `grid`, `rows`, and `tabs`.
-         *
-         * @example
-         * ```js
-         * let windowIdentity;
-         * if (fin.me.isWindow) {
-         *     windowIdentity = fin.me.identity;
-         * } else if (fin.me.isView) {
-         *     windowIdentity = (await fin.me.getCurrentWindow()).identity;
-         * } else {
-         *     throw new Error('Not running in a platform View or Window');
-         * }
-         *
-         * const layout = fin.Platform.Layout.wrapSync(windowIdentity);
-         * await layout.applyPreset({ presetType: 'grid' });
-         *
-         * // wait 5 seconds until you change the layout from grid to tabs
-         * await new Promise (res => setTimeout(res, 5000));
-         * await layout.applyPreset({ presetType: 'tabs' });
-         * ```
-         */
-        this.applyPreset = async (options) => {
-            this.wire.sendAction('layout-apply-preset').catch((e) => {
-                // don't expose
-            });
-            const client = await this.platform.getClient();
-            const { presetType } = options;
-            if (!presetType || !(0, common_utils_1.isValidPresetType)(presetType)) {
-                throw new Error('Cannot apply preset layout, please include an applicable presetType property in the PresetLayoutOptions.');
-            }
-            await client.dispatch('apply-preset-layout', {
-                target: this.identity,
-                opts: { presetType }
-            });
-        };
-        const errorMsg = (0, validate_1.validateIdentity)(identity);
-        if (errorMsg) {
-            throw new Error(errorMsg);
-        }
-        this.identity = identity;
-        this.platform = this.fin.Platform.wrapSync({ uuid: identity.uuid });
-        if (identity.uuid === this.fin.me.uuid && identity.name === this.fin.me.name) {
-            this.init = this.fin.Platform.Layout.init;
-        }
-    }
-    /**
-     * Returns the configuration of the window's layout.  Returns the same information that is returned for all windows in getSnapshot.
-     *
-     * @remarks Cannot be called from a View.
-     *
-     *
-     * @example
-     * ```js
-     * const layout = fin.Platform.Layout.getCurrentSync();
-     * // Use wrapped instance to get the layout configuration of the current window's Layout:
-     * const layoutConfig = await layout.getConfig();
-     * ```
-     */
-    async getConfig() {
-        this.wire.sendAction('layout-get-config').catch((e) => {
-            // don't expose
-        });
-        const client = await this.platform.getClient();
-        return client.dispatch('get-frame-snapshot', {
-            target: this.identity
-        });
-    }
-    /**
-     * Retrieves the top level content item of the layout.
-     *
-     * @remarks Cannot be called from a view.
-     *
-     *
-     *
-     * @example
-     * ```js
-     * if (!fin.me.isWindow) {
-     *     throw new Error('Not running in a platform View.');
-     * }
-     *
-     * // From the layout window
-     * const layout = fin.Platform.Layout.getCurrentSync();
-     * // Retrieves the ColumnOrRow instance
-     * const rootItem = await layout.getRootItem();
-     * const content = await rootItem.getContent();
-     * console.log(`The root ColumnOrRow instance has ${content.length} item(s)`);
-     * ```
-     */
-    async getRootItem() {
-        this.wire.sendAction('layout-get-root-item').catch(() => {
-            // don't expose
-        });
-        const client = await __classPrivateFieldGet(this, _Layout_layoutClient, "f").getValue();
-        const root = await client.getRoot();
-        return layout_entities_1.LayoutNode.getEntity(root, client);
-    }
-}
-exports.Layout = Layout;
-_Layout_layoutClient = new WeakMap();

package/src/api/platform/layout/controllers/layout-content-cache.d.ts

@@ -1,9 +0,0 @@
-export declare class LayoutContentCache {
-    private contentItemCache;
-    private contentItemCacheId;
-    private createCacheKey;
-    hasKey: (id: string) => boolean;
-    getItemOrUndefined: (id: string) => GoldenLayout.ContentItem | undefined;
-    getContentItemOrThrow: (id: string, expectedType?: string[]) => GoldenLayout.ContentItem;
-    getOrCreateEntityId: (contentItem: GoldenLayout.ContentItem) => string;
-}

package/src/api/platform/layout/controllers/layout-content-cache.js

@@ -1,54 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.LayoutContentCache = void 0;
-const reversible_map_1 = require("../../../../util/reversible-map");
-class LayoutContentCache {
-    constructor() {
-        // ContentItems currently do not have a unique id, this helps us to lookup items by value
-        this.contentItemCache = new reversible_map_1.ReversibleMap();
-        this.contentItemCacheId = 0;
-        this.createCacheKey = () => {
-            const key = `entity-${this.contentItemCacheId.toString()}`;
-            this.contentItemCacheId += 1;
-            return key;
-        };
-        this.hasKey = (id) => {
-            return this.contentItemCache.hasKey(id);
-        };
-        this.getItemOrUndefined = (id) => {
-            try {
-                return this.getContentItemOrThrow(id);
-            }
-            catch (error) {
-                return undefined;
-            }
-        };
-        this.getContentItemOrThrow = (id, expectedType) => {
-            if (!this.contentItemCache.hasKey(id)) {
-                throw new Error('Layout component has been destroyed or detached from the current layout.');
-            }
-            const contentItem = this.contentItemCache.getValue(id);
-            if (expectedType && !expectedType.includes(contentItem.type)) {
-                throw new Error(`Layout item is not the expected type. Expected ${expectedType.join(', ')}, got ${contentItem.type}.`);
-            }
-            return contentItem;
-        };
-        this.getOrCreateEntityId = (contentItem) => {
-            if (this.contentItemCache.hasValue(contentItem)) {
-                return this.contentItemCache.getKey(contentItem);
-            }
-            // eslint-disable-next-line @typescript-eslint/no-unused-vars
-            const onItemDestroyed = ({ origin, ...rest }) => {
-                if (origin === contentItem) {
-                    this.contentItemCache.deleteValue(contentItem);
-                    contentItem.unbind('itemDestroyed', onItemDestroyed);
-                }
-            };
-            contentItem.on('itemDestroyed', onItemDestroyed);
-            const key = this.createCacheKey();
-            this.contentItemCache.setUnique(key, contentItem);
-            return key;
-        };
-    }
-}
-exports.LayoutContentCache = LayoutContentCache;

package/src/api/platform/layout/controllers/layout-entities-controller.d.ts

@@ -1,119 +0,0 @@
-import type * as OpenFin from '../../../../OpenFin';
-import type { LayoutContentCache } from './layout-content-cache';
-type ViewCreationOrReference = OpenFin.Identity | OpenFin.PlatformViewCreationOptions;
-/**
- * @internal
- * Controller for the layout entities apis, allowing alterations to be applied
- * to an instance of layout manager in a structured manner.
- */
-export declare class LayoutEntitiesController {
-    private layoutManager;
-    private layoutContentCache;
-    private wire;
-    constructor(layoutManager: any, layoutContentCache: LayoutContentCache);
-    private analytics;
-    /**
-     * @internal
-     * @returns the root contentItem of the layout.
-     */
-    getRoot: () => OpenFin.LayoutEntityDefinition;
-    /**
-     * @internal
-     * Retrieves the containing stack of a given view identity.
-     * @param view Identity of the view to retrieve the stack of.
-     * @returns Stack containing the given view.
-     * @throws If the view does not belong to a stack within the layout manager.
-     */
-    getStackByView: (view: OpenFin.Identity) => Promise<OpenFin.LayoutEntityDefinition | undefined>;
-    /**
-     * @internal
-     * Returns all views belonging to a given stack
-     *
-     * NOTE: Due to (TODO: ticket) Golden Layouts has an issue which changes the order of tabs
-     * when the amount of new views to add overflows the width of the container. This results
-     * in tabs being re-ordered in the UI, while the underlying content item array remains in the
-     * original order specified. So calling getStackViews() will return this underlying array order,
-     * with indexes that will not match up to the render-order of the tabs.
-     *
-     * @param id - Entity id of the stack.
-     * @returns A list of view identities in order of appearance.
-     * @throws if the content item associated with the entity id does not exist or is not a stack.
-     */
-    getStackViews: (id: string) => OpenFin.Identity[];
-    /**
-     * @internal
-     * Retrieves the content of a column or row and adds each to the
-     * entity cache to allow them to be addressed externally.
-     * @param id Entity id of the Column Or Row to retrieve the content of.
-     * @returns Array of layout entity definitions
-     * @throws if the entity associated with {@link id} is not in the entity cache, does not belogn to a layout, or is not a column/row.
-     */
-    getContent(id: string): OpenFin.LayoutEntityDefinition[];
-    /**
-     * @internal
-     * Retrieves the parent content item of the given entity, and adds it to the entity cache
-     * so it can be addressed externally.
-     * @param id Entity id associated with a layout content item.
-     * @returns An entity definition for the given entity's parent, or undefined if the entity is the top level
-     * content item or has been removed from the layout entirely.
-     */
-    getParent(id: string): OpenFin.LayoutEntityDefinition | undefined;
-    /**
-     * @internal
-     * @param id Entity id associated with a layout content item.
-     * @returns true if the given entity is the root content item, false otherwise.
-     */
-    isRoot: (id: string) => boolean;
-    /**
-     * @internal
-     * Checks whether the given entity exists.
-     * @param entityId Id of a content item within the layout
-     * @returns True if the content item exists and belongs to the layout.
-     */
-    exists: (entityId: string) => boolean;
-    /**
-     * @internal
-     * Adds an existing view to the stack, or creates and adds a view to the given stack.
-     *
-     * NOTE: Due to (TODO: ticket) Golden Layouts has an issue which changes the order of tabs
-     * when the amount of new views to add overflows the width of the container. This results
-     * in tabs being re-ordered in the UI, while the underlying content item array remains in the
-     * original order specified. So calling getStackViews() will return this underlying array order,
-     * with indexes that will not match up to the render-order of the tabs.
-     *
-     * @param stackEntityId Entity id of the stack content item within the layout.
-     * @param viewCreationOrReference View identity or creation options
-     * @param options Optional view options: index number used to insert the view into the stack at that index. Defaults to 0 (front of the stack)
-     * @returns Promise resolving with the identity of the newly added view.
-     * @throws If the view does not exist, fails to create, or the stack does not exist.
-     */
-    addViewToStack: (stackEntityId: string, viewCreationOrReference: ViewCreationOrReference, { index }?: OpenFin.AddViewToStackOptions) => Promise<OpenFin.Identity>;
-    private findViewInStack;
-    /**
-     * @internal
-     * Removes a view from the given stack. If it's the only view, the stack will be destroyed, unless window creation
-     * option closeOnLastViewRemoved is set to false.
-     *
-     * @param stackEntityId Entity id of a stack content item to remove the view from.
-     * @param view Identity of the view to remove.
-     * @throws If the stack does not exist or the view does not exist or belong to the stack.
-     */
-    removeViewFromStack: (stackEntityId: string, view: OpenFin.Identity) => Promise<void>;
-    /**
-     * @internal
-     * Creates a new adjacent 'stack' and adds the views to it at the specified position
-     * @param targetId Entity id of the content item to add a stack adjacent to it
-     * @param views List of identities or view creation options of the views to include in the stack
-     * @param options Creation options, defaults to { position: 'right' }
-     * @returns the Entity Id of the new stack
-     */
-    createAdjacentStack: (targetId: string, views: ViewCreationOrReference[], { position }?: {
-        position?: OpenFin.LayoutPosition;
-    }) => Promise<string>;
-    getAdjacentStacks: ({ targetId, edge }: {
-        targetId: string;
-        edge: OpenFin.LayoutPosition;
-    }) => Promise<Pick<OpenFin.LayoutEntityDefinition, 'entityId'>[]>;
-    setStackActiveView: (stackEntityId: string, viewIdentity: OpenFin.Identity) => Promise<void>;
-}
-export {};