@openfin/core 33.76.31 → 33.76.38

package/src/api/platform/Instance.js

@@ -1,332 +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 _Platform_connectToProvider;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Platform = void 0;
-/* eslint-disable import/prefer-default-export, no-undef */
-const base_1 = require("../base");
-const validate_1 = require("../../util/validate");
-// Reuse clients to avoid overwriting already-registered client in provider
-const clientMap = new Map();
-/** Manages the life cycle of windows and views in the application.
- *
- * Enables taking snapshots of itself and applyi
- * ng them to restore a previous configuration
- * as well as listen to <a href="tutorial-Platform.EventEmitter.html">platform events</a>.
- * @namespace
- */
-class Platform extends base_1.EmitterBase {
-    // eslint-disable-next-line no-shadow
-    constructor(identity, channel) {
-        // we piggyback off of application event emitter because from the core's perspective platform is just an app.
-        super(channel.wire, 'application', identity.uuid);
-        this.getClient = (identity) => {
-            this.wire.sendAction('platform-get-client', this.identity).catch((e) => {
-                // don't expose
-            });
-            const target = identity || this.identity;
-            const { uuid } = target;
-            if (!clientMap.has(uuid)) {
-                const clientPromise = __classPrivateFieldGet(this, _Platform_connectToProvider, "f").call(this, uuid);
-                clientMap.set(uuid, clientPromise);
-            }
-            // we set it above
-            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-            return clientMap.get(uuid);
-        };
-        _Platform_connectToProvider.set(this, async (uuid) => {
-            try {
-                const channelName = `custom-frame-${uuid}`;
-                const client = await this._channel.connect(channelName, { wait: false });
-                client.onDisconnection(() => {
-                    clientMap.delete(uuid);
-                });
-                return client;
-            }
-            catch (e) {
-                clientMap.delete(uuid);
-                throw new Error('The targeted Platform is not currently running. Listen for application-started event for the given Uuid.');
-            }
-        });
-        // Deprecated (renamed)
-        this.launchLegacyManifest = this.launchContentManifest;
-        const errorMsg = (0, validate_1.validateIdentity)(identity);
-        if (errorMsg) {
-            throw new Error(errorMsg);
-        }
-        this._channel = channel;
-        this.identity = { uuid: identity.uuid };
-        this.Layout = this.fin.Platform.Layout;
-        this.Application = this.fin.Application.wrapSync(this.identity);
-    }
-    /**
-     * Creates a new view and attaches it to a specified target window.
-     * @param { View~options } viewOptions View creation options
-     * @param { Identity } [target] The window to which the new view is to be attached. If no target, create a view in a new window.
-     * @param { Identity } [targetView] If provided, the new view will be added to the same tabstrip as targetView.
-     * @return { Promise<View> }
-     * @tutorial Platform.createView
-     */
-    async createView(viewOptions, target, targetView) {
-        this.wire.sendAction('platform-create-view', this.identity).catch((e) => {
-            // don't expose
-        });
-        const client = await this.getClient();
-        const response = await client.dispatch('create-view', {
-            target,
-            opts: viewOptions,
-            targetView
-        });
-        if (!response || (0, validate_1.validateIdentity)(response.identity)) {
-            throw new Error(`When overwriting the createView call, please return an object that has a valid 'identity' property: ${JSON.stringify(response)}`);
-        }
-        return this.fin.View.wrapSync(response.identity);
-    }
-    /**
-     * Creates a new Window.
-     * @param { Window~options } options Window creation options
-     * @return { Promise<_Window> }
-     * @tutorial Platform.createWindow
-     */
-    async createWindow(options) {
-        this.wire.sendAction('platform-create-window', this.identity).catch((e) => {
-            // don't expose
-        });
-        const client = await this.getClient();
-        if (!options.reason) {
-            options.reason = 'api-call';
-        }
-        const response = await client.dispatch('create-view-container', options);
-        if (!response || (0, validate_1.validateIdentity)(response.identity)) {
-            throw new Error(`When overwriting the createWindow call, please return an object that has a valid 'identity' property: ${JSON.stringify(response)}`);
-        }
-        const { identity } = response;
-        const res = this.fin.Window.wrapSync(identity);
-        // we add the identity at the top level for backwards compatibility.
-        res.name = identity.name;
-        res.uuid = identity.uuid;
-        return res;
-    }
-    /**
-     * Closes current platform, all its windows, and their views.
-     * @return { Promise<void> }
-     * @tutorial Platform.quit
-     */
-    async quit() {
-        this.wire.sendAction('platform-quit', this.identity).catch((e) => {
-            // don't expose
-        });
-        const client = await this.getClient();
-        return client.dispatch('quit');
-    }
-    /**
-     * Closes a specified view in a target window.
-     * @param { Identity } viewIdentity View identity
-     * @return { Promise<void> }
-     * @tutorial Platform.closeView
-     */
-    async closeView(viewIdentity) {
-        this.wire.sendAction('platform-close-view', this.identity).catch((e) => {
-            // don't expose
-        });
-        const client = await this.getClient();
-        await client.dispatch('close-view', {
-            view: viewIdentity
-        });
-    }
-    /**
-     * ***DEPRECATED - please use Platform.createView.***
-     * Reparents a specified view in a new target window.
-     * @param { Identity } viewIdentity View identity
-     * @param { Identity } target new owner window identity
-     * @return { Promise<View> }
-     * @tutorial Platform.createView
-     */
-    async reparentView(viewIdentity, target) {
-        var _a;
-        // eslint-disable-next-line no-console
-        console.warn('Platform.reparentView has been deprecated, please use Platform.createView');
-        this.wire.sendAction('platform-reparent-view', this.identity).catch((e) => {
-            // don't expose
-        });
-        const normalizedViewIdentity = {
-            ...viewIdentity,
-            uuid: (_a = viewIdentity.uuid) !== null && _a !== void 0 ? _a : this.identity.uuid
-        };
-        const view = await this.fin.View.wrap(normalizedViewIdentity);
-        const viewOptions = await view.getOptions();
-        return this.createView(viewOptions, target);
-    }
-    /**
-     * Returns a snapshot of the platform in its current state.
-     *
-     * Can be used to restore an application to a previous state.
-     * @return { Promise<Snapshot> }
-     * @tutorial Platform.getSnapshot
-     */
-    async getSnapshot() {
-        this.wire.sendAction('platform-get-snapshot', this.identity).catch((e) => {
-            // don't expose
-        });
-        const client = await this.getClient();
-        return client.dispatch('get-snapshot');
-    }
-    /**
-     * **NOTE**: Internal use only. It is not recommended to manage the state of individual views.
-     *
-     * Returns a snapshot of a single view's options in its current state.
-     *
-     * Can be used to restore a view to a previous state.
-     *
-     * @param { Identity } viewIdentity View identity
-     * @returns { Promise<ViewState> }
-     * @internal
-     * @experimental
-     * @tutorial Platform.getViewSnapshot
-     */
-    async getViewSnapshot(viewIdentity) {
-        const client = await this.getClient();
-        return client.dispatch('get-view-snapshot', { viewIdentity });
-    }
-    /**
-     * Adds a snapshot to a running Platform.
-     * Requested snapshot must be a valid Snapshot object, or a url or filepath to such an object.
-     *
-     * Can optionally close existing windows and overwrite current platform state with that of a snapshot.
-     *
-     * The function accepts either a snapshot taken using {@link Platform#getSnapshot getSnapshot},
-     * or a url or filepath to a snapshot JSON object.
-     * @param { Snapshot | string } requestedSnapshot Snapshot to apply, or a url or filepath.
-     * @param { ApplySnapshotOptions } [options] Optional parameters to specify whether existing windows should be closed.
-     * @return { Promise<Platform> }
-     * @tutorial Platform.applySnapshot
-     */
-    async applySnapshot(requestedSnapshot, options) {
-        this.wire.sendAction('platform-apply-snapshot', this.identity).catch((e) => {
-            // don't expose
-        });
-        const errMsg = 'Requested snapshot must be a valid Snapshot object, or a url or filepath to such an object.';
-        let snapshot;
-        if (typeof requestedSnapshot === 'string') {
-            // Fetch and parse snapshot
-            try {
-                const response = await this._channel.wire.sendAction('get-application-manifest', {
-                    manifestUrl: requestedSnapshot
-                });
-                snapshot = response.payload.data;
-            }
-            catch (err) {
-                throw new Error(`${errMsg}: ${err}`);
-            }
-        }
-        else {
-            snapshot = requestedSnapshot;
-        }
-        if (!snapshot.windows) {
-            throw new Error(errMsg);
-        }
-        const client = await this.getClient();
-        await client.dispatch('apply-snapshot', {
-            snapshot,
-            options
-        });
-        return this;
-    }
-    /**
-     * Fetches a JSON manifest using the browser process and returns a Javascript object.
-     * Can be overwritten using {@link Platform#init Platform.init}.
-     * @param { string } manifestUrl The URL of the manifest to fetch.
-     * @return { Promise<any> }
-     * @tutorial Platform.fetchManifest
-     */
-    async fetchManifest(manifestUrl) {
-        const client = await this.getClient();
-        return client.dispatch('platform-fetch-manifest', { manifestUrl });
-    }
-    /**
-     * Retrieves a manifest by url and launches a legacy application manifest or snapshot into the platform.  Returns a promise that
-     * resolves to the wrapped Platform.
-     * @param {string} manifestUrl - The URL of the manifest that will be launched into the platform.  If this app manifest
-     * contains a snapshot, that will be launched into the platform.  If not, the application described in startup_app options
-     * will be launched into the platform. The applicable startup_app options will become {@link View~options View Options}.
-     * @return {Promise<Platform>}
-     * @tutorial Platform.launchContentManifest
-     * @experimental
-     */
-    async launchContentManifest(manifestUrl) {
-        this.wire.sendAction('platform-launch-content-manifest', this.identity).catch((e) => {
-            // don't expose
-        });
-        const client = await this.getClient();
-        const manifest = await this.fetchManifest(manifestUrl);
-        client.dispatch('launch-into-platform', { manifest });
-        return this;
-    }
-    /**
-     * Set the context of a host window. The context will be available to the window itself, and to its child Views. It will be saved in any platform snapshots.
-     * It can be retrieved using {@link Platform#getWindowContext getWindowContext}.
-     * @param {any} context - A field where serializable context data can be stored to be saved in platform snapshots.
-     * @param {Identity} [target] - A target window or view may optionally be provided. If no target is provided, the update will be applied
-     * to the current window (if called from a Window) or the current host window (if called from a View).
-     * @return {Promise<void>}
-     * @tutorial Platform.setWindowContext
-     * @experimental
-     */
-    async setWindowContext(context = {}, target) {
-        this.wire.sendAction('platform-set-window-context', this.identity).catch((e) => {
-            // don't expose
-        });
-        if (!context) {
-            throw new Error('Please provide a serializable object or string to set the context.');
-        }
-        const client = await this.getClient();
-        const { entityType } = target ? await this.fin.System.getEntityInfo(target.uuid, target.name) : this.fin.me;
-        await client.dispatch('set-window-context', {
-            context,
-            entityType,
-            target: target || { uuid: this.fin.me.uuid, name: this.fin.me.name }
-        });
-    }
-    /**
-     * Get the context context of a host window that was previously set using {@link Platform#setWindowContext setWindowContext}.
-     * The context will be saved in any platform snapshots.  Returns a promise that resolves to the context.
-     * @param {Identity} [target] - A target window or view may optionally be provided. If no target is provided, target will be
-     * the current window (if called from a Window) or the current host window (if called from a View).
-     * @return {Promise<any>}
-     * @tutorial Platform.getWindowContext
-     * @experimental
-     */
-    async getWindowContext(target) {
-        this.wire.sendAction('platform-get-window-context', this.identity).catch((e) => {
-            // don't expose
-        });
-        const client = await this.getClient();
-        const { entityType } = target ? await this.fin.System.getEntityInfo(target.uuid, target.name) : this.fin.me;
-        return client.dispatch('get-window-context', {
-            target: target || { uuid: this.fin.me.uuid, name: this.fin.me.name },
-            entityType
-        });
-    }
-    /**
-     * Closes a window. If enableBeforeUnload is enabled in the Platform options, any beforeunload handler set on Views will fire
-     * This behavior can be disabled by setting skipBeforeUnload to false in the options parameter.
-     * @param {Identity} winId
-     * @param {closeWindowoptions} [options]
-     * @returns {Promise<void>}
-     * @tutorial Platform.closeWindow
-     * @experimental
-     */
-    async closeWindow(windowId, options = { skipBeforeUnload: false }) {
-        this.wire.sendAction('platform-close-window', this.identity).catch((e) => {
-            // don't expose
-        });
-        const client = await this.getClient();
-        return client.dispatch('close-window', { windowId, options });
-    }
-}
-exports.Platform = Platform;
-_Platform_connectToProvider = new WeakMap();

package/src/api/platform/common-utils.d.ts

@@ -1,7 +0,0 @@
-import type * as OpenFin from '../../OpenFin';
-type LayoutPresetType = OpenFin.LayoutPresetType;
-export declare function isValidPresetType(type: LayoutPresetType): type is LayoutPresetType;
-declare const _default: {
-    isValidPresetType: typeof isValidPresetType;
-};
-export default _default;

package/src/api/platform/common-utils.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isValidPresetType = void 0;
-function isValidPresetType(type) {
-    switch (type) {
-        case 'columns':
-        case 'grid':
-        case 'rows':
-        case 'tabs':
-            return true;
-        default:
-            return false;
-    }
-}
-exports.isValidPresetType = isValidPresetType;
-exports.default = { isValidPresetType };

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

@@ -1,3 +0,0 @@
-import PlatformModule from './Factory';
-export default PlatformModule;
-export * from './Instance';

package/src/api/platform/index.js

@@ -1,19 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const Factory_1 = require("./Factory");
-exports.default = Factory_1.default;
-__exportStar(require("./Instance"), exports);

package/src/api/platform/layout/Factory.d.ts

@@ -1,114 +0,0 @@
-import type * as OpenFin from '../../../OpenFin';
-import { Base } from '../../base';
-import { Layout } from './Instance';
-type InitLayoutOptions = OpenFin.InitLayoutOptions;
-/**
- * @PORTED
- * InitLayoutOptions interface
- * @typedef { object } InitLayoutOptions
- * @property { string } [containerId] The id attribute of the container where the window's Layout should be initialized.  If not provided
- * then an element with id `layout-container` is used. We recommend using a div element.
- */
-/**
- * @PORTED
- * PresetLayoutOptions interface
- * @typedef { object } PresetLayoutOptions
- * @property { LayoutPresetTypes } presetType Which preset layout arrangement to use.
- * The preset options are `columns`, `grid`, `rows`, and `tabs`.
- */
-/**
- * LayoutConfig interface
- * @typedef { object } LayoutConfig
- * @property { Array<LayoutItem> } content Content of the layout.  There can only be one top-level LayoutItem in the content array.
- * We do not recommend trying to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot}
- * or our {@link https://openfin.github.io/golden-prototype/config-gen Layout Config Generation Tool }.
- * @property { LayoutSettings } settings Configuration for certain Layout behaviors. See the LayoutSettings interface.
- */
-/**
- * @PORTED
- * LayoutItem Interface
- * @typedef { object } LayoutItem Represents the arrangement of Views within a Platform window's Layout.  We do not recommend trying
- * to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot} or our
- * {@link https://openfin.github.io/golden-prototype/config-gen Layout Config Generation Tool }.
- * @property { string } type The type of the item. Possible values are 'row', 'column', 'stack', and 'component'.
- * @property { Array<LayoutItem> } [content] An array of configurations for items that will be created as children of this item.
- * @property { string } [componentName] Only a `component` type will have this property and it should be set to `view`.
- * @property { View~options } [componentState] Only a `component` type will have this property and it represents the view
- * options of a given component.
- */
-/**
- * @PORTED
- * LayoutSettings Interface
- * @typedef { object } LayoutSettings Represents a potential ways to customize behavior of your Layout
- * @property { boolean } [constrainDragToHeaders=false] Limits the area to which tabs can be dragged.
- * If true, stack headers are the only areas where tabs can be dropped.
- * @property { boolean } [hasHeaders=true] Turns tab headers on or off.
- * If false, the layout will be displayed with splitters only.
- * @property {object} [newTabButton]
- * Configuration of the Plus button that appears on each tabstrip. Upon pressing, a new tab
- * will be added to the tabstrip with the specified url.
- * @property {string} [newTabButton.url] Specifies the url that opens in the tab created upon pressing the button.
- * @property { boolean } [popoutWholeStack=false] Whether the popout button will only act on the entire stack,
- * as opposed to only the active tab.
- * @property { boolean } [preventDragIn=false] If true, tabs can't be dragged into the window.
- * @property { boolean } [preventDragOut=false] If true, tabs can't be dragged out of the window.
- * @property { boolean } [preventSplitterResize=false] If true, tab contents can't be resized by the user.
- * @property { boolean } [reorderEnabled=true] If true, the user can re-arrange the layout by
- * dragging items by their tabs to the desired location.
- * @property { boolean } [showCloseIcon=false] Whether to show the close button on stack header
- * (not to be confused with close button on every tab).
- * @property { boolean } [showMaximiseIcon=false] Whether to show the maximize button on stack header.
- * The button will maximize the current tab to fill the entire window.
- * @property { boolean } [showPopoutIcon=false] Whether to show the popout button on stack header.
- * The button will create a new window with current tab as its content.
- * In case `popoutWholeStack` is set to true, all tabs in the stack will be in the new window.
- */
-/**
- * @lends Platform#Layout
- */
-export declare class LayoutModule extends Base {
-    #private;
-    /**
-     * Asynchronously returns a Layout object that represents a Window's layout.
-     * @param { Identity } identity
-     * @return {Promise.<Layout>}
-     * @tutorial Layout.wrap
-     * @static
-     */
-    wrap(identity: OpenFin.Identity): Promise<OpenFin.Layout>;
-    /**
-     * Synchronously returns a Layout object that represents a Window's layout.
-     * @param { Identity } identity
-     * @return {Layout}
-     * @tutorial Layout.wrapSync
-     * @static
-     */
-    wrapSync(identity: OpenFin.Identity): OpenFin.Layout;
-    /**
-     * Asynchronously returns a Layout object that represents a Window's layout.
-     * @return {Promise.<Layout>}
-     * @tutorial Layout.getCurrent
-     * @static
-     */
-    getCurrent(): Promise<OpenFin.Layout>;
-    /**
-     * Synchronously returns a Layout object that represents a Window's layout.
-     * @return {Layout}
-     * @tutorial Layout.getCurrentSync
-     * @static
-     */
-    getCurrentSync(): OpenFin.Layout;
-    /**
-     * Initialize the window's Layout.  Must be called from a custom window that has a 'layout' option set upon creation of that window.
-     * If a containerId is not provided, this method attempts to find an element with the id `layout-container`.
-     * A Layout will <a href="tutorial-Layout.DOMEvents.html">emit events locally</a> on the DOM element representing the layout-container.
-     * In order to capture the relevant events during Layout initiation, set up the listeners on the DOM element prior to calling `init`.
-     * @param { InitLayoutOptions } [options] - Layout init options.
-     * @return { Promise<Layout> }
-     * @static
-     * @experimental
-     * @tutorial Layout.init
-     */
-    init: (options?: InitLayoutOptions) => Promise<OpenFin.Layout>;
-}
-export {};

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

@@ -1,174 +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 __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
-    if (kind === "m") throw new TypeError("Private method is not writable");
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
-    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
-};
-var _LayoutModule_layoutInitializationAttempted;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.LayoutModule = void 0;
-/* eslint-disable no-undef, import/prefer-default-export */
-const base_1 = require("../../base");
-const Instance_1 = require("./Instance");
-/**
- * @PORTED
- * InitLayoutOptions interface
- * @typedef { object } InitLayoutOptions
- * @property { string } [containerId] The id attribute of the container where the window's Layout should be initialized.  If not provided
- * then an element with id `layout-container` is used. We recommend using a div element.
- */
-/**
- * @PORTED
- * PresetLayoutOptions interface
- * @typedef { object } PresetLayoutOptions
- * @property { LayoutPresetTypes } presetType Which preset layout arrangement to use.
- * The preset options are `columns`, `grid`, `rows`, and `tabs`.
- */
-/**
- * LayoutConfig interface
- * @typedef { object } LayoutConfig
- * @property { Array<LayoutItem> } content Content of the layout.  There can only be one top-level LayoutItem in the content array.
- * We do not recommend trying to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot}
- * or our {@link https://openfin.github.io/golden-prototype/config-gen Layout Config Generation Tool }.
- * @property { LayoutSettings } settings Configuration for certain Layout behaviors. See the LayoutSettings interface.
- */
-/**
- * @PORTED
- * LayoutItem Interface
- * @typedef { object } LayoutItem Represents the arrangement of Views within a Platform window's Layout.  We do not recommend trying
- * to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot} or our
- * {@link https://openfin.github.io/golden-prototype/config-gen Layout Config Generation Tool }.
- * @property { string } type The type of the item. Possible values are 'row', 'column', 'stack', and 'component'.
- * @property { Array<LayoutItem> } [content] An array of configurations for items that will be created as children of this item.
- * @property { string } [componentName] Only a `component` type will have this property and it should be set to `view`.
- * @property { View~options } [componentState] Only a `component` type will have this property and it represents the view
- * options of a given component.
- */
-/**
- * @PORTED
- * LayoutSettings Interface
- * @typedef { object } LayoutSettings Represents a potential ways to customize behavior of your Layout
- * @property { boolean } [constrainDragToHeaders=false] Limits the area to which tabs can be dragged.
- * If true, stack headers are the only areas where tabs can be dropped.
- * @property { boolean } [hasHeaders=true] Turns tab headers on or off.
- * If false, the layout will be displayed with splitters only.
- * @property {object} [newTabButton]
- * Configuration of the Plus button that appears on each tabstrip. Upon pressing, a new tab
- * will be added to the tabstrip with the specified url.
- * @property {string} [newTabButton.url] Specifies the url that opens in the tab created upon pressing the button.
- * @property { boolean } [popoutWholeStack=false] Whether the popout button will only act on the entire stack,
- * as opposed to only the active tab.
- * @property { boolean } [preventDragIn=false] If true, tabs can't be dragged into the window.
- * @property { boolean } [preventDragOut=false] If true, tabs can't be dragged out of the window.
- * @property { boolean } [preventSplitterResize=false] If true, tab contents can't be resized by the user.
- * @property { boolean } [reorderEnabled=true] If true, the user can re-arrange the layout by
- * dragging items by their tabs to the desired location.
- * @property { boolean } [showCloseIcon=false] Whether to show the close button on stack header
- * (not to be confused with close button on every tab).
- * @property { boolean } [showMaximiseIcon=false] Whether to show the maximize button on stack header.
- * The button will maximize the current tab to fill the entire window.
- * @property { boolean } [showPopoutIcon=false] Whether to show the popout button on stack header.
- * The button will create a new window with current tab as its content.
- * In case `popoutWholeStack` is set to true, all tabs in the stack will be in the new window.
- */
-/**
- * @lends Platform#Layout
- */
-class LayoutModule extends base_1.Base {
-    constructor() {
-        super(...arguments);
-        _LayoutModule_layoutInitializationAttempted.set(this, false);
-        /**
-         * Initialize the window's Layout.  Must be called from a custom window that has a 'layout' option set upon creation of that window.
-         * If a containerId is not provided, this method attempts to find an element with the id `layout-container`.
-         * A Layout will <a href="tutorial-Layout.DOMEvents.html">emit events locally</a> on the DOM element representing the layout-container.
-         * In order to capture the relevant events during Layout initiation, set up the listeners on the DOM element prior to calling `init`.
-         * @param { InitLayoutOptions } [options] - Layout init options.
-         * @return { Promise<Layout> }
-         * @static
-         * @experimental
-         * @tutorial Layout.init
-         */
-        this.init = async (options = {}) => {
-            this.wire.sendAction('layout-init').catch((e) => {
-                // don't expose
-            });
-            if (!this.fin.me.isWindow) {
-                throw new Error('Layout.init can only be called from a Window context.');
-            }
-            else if (__classPrivateFieldGet(this, _LayoutModule_layoutInitializationAttempted, "f")) {
-                throw new Error('Layout for this window already initialized, please use Layout.replace call to replace the layout.');
-            }
-            __classPrivateFieldSet(this, _LayoutModule_layoutInitializationAttempted, true, "f");
-            return this.wire.environment.initLayout(this.fin, this.wire, options);
-        };
-    }
-    /**
-     * Asynchronously returns a Layout object that represents a Window's layout.
-     * @param { Identity } identity
-     * @return {Promise.<Layout>}
-     * @tutorial Layout.wrap
-     * @static
-     */
-    // eslint-disable-next-line class-methods-use-this
-    async wrap(identity) {
-        this.wire.sendAction('layout-wrap').catch((e) => {
-            // don't expose
-        });
-        return new Instance_1.Layout(identity, this.wire);
-    }
-    /**
-     * Synchronously returns a Layout object that represents a Window's layout.
-     * @param { Identity } identity
-     * @return {Layout}
-     * @tutorial Layout.wrapSync
-     * @static
-     */
-    // eslint-disable-next-line class-methods-use-this
-    wrapSync(identity) {
-        this.wire.sendAction('layout-wrap-sync').catch((e) => {
-            // don't expose
-        });
-        return new Instance_1.Layout(identity, this.wire);
-    }
-    /**
-     * Asynchronously returns a Layout object that represents a Window's layout.
-     * @return {Promise.<Layout>}
-     * @tutorial Layout.getCurrent
-     * @static
-     */
-    async getCurrent() {
-        this.wire.sendAction('layout-get-current').catch((e) => {
-            // don't expose
-        });
-        if (!this.fin.me.isWindow) {
-            throw new Error('You are not in a Window context.  Only Windows can have a Layout.');
-        }
-        const { uuid, name } = this.fin.me;
-        return this.wrap({ uuid, name });
-    }
-    /**
-     * Synchronously returns a Layout object that represents a Window's layout.
-     * @return {Layout}
-     * @tutorial Layout.getCurrentSync
-     * @static
-     */
-    getCurrentSync() {
-        this.wire.sendAction('layout-get-current-sync').catch((e) => {
-            // don't expose
-        });
-        if (!this.fin.me.isWindow) {
-            throw new Error('You are not in a Window context.  Only Windows can have a Layout.');
-        }
-        const { uuid, name } = this.fin.me;
-        return this.wrapSync({ uuid, name });
-    }
-}
-exports.LayoutModule = LayoutModule;
-_LayoutModule_layoutInitializationAttempted = new WeakMap();