@openfin/core 33.76.36 → 33.77.1

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,12 +0,0 @@
-/**
- * Entry point for the OpenFin Platform namespace.
- *
- * Because TypeDoc does not currently support multiple modules with the same name, the module alias "PlatformModule" is used for
- * the module containing static members of the `Platform` namespace (available under `fin.Platform`), while `Platform` documents
- * instances of the OpenFin `Platform` class.
- *
- * @packageDocumentation
- */
-import PlatformModule from './Factory';
-export default PlatformModule;
-export * from './Instance';

package/src/api/platform/index.js

@@ -1,28 +0,0 @@
-"use strict";
-/**
- * Entry point for the OpenFin Platform namespace.
- *
- * Because TypeDoc does not currently support multiple modules with the same name, the module alias "PlatformModule" is used for
- * the module containing static members of the `Platform` namespace (available under `fin.Platform`), while `Platform` documents
- * instances of the OpenFin `Platform` class.
- *
- * @packageDocumentation
- */
-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,91 +0,0 @@
-import type * as OpenFin from '../../../OpenFin';
-import { Base } from '../../base';
-import { Layout } from './Instance';
-type InitLayoutOptions = OpenFin.InitLayoutOptions;
-export declare class LayoutModule extends Base {
-    #private;
-    /**
-     * Asynchronously returns a Layout object that represents a Window's layout.
-     * @param identity
-     *
-     * @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 = await fin.Platform.Layout.wrap(windowIdentity);
-     * // Use wrapped instance to control layout, e.g.:
-     * const layoutConfig = await layout.getConfig();
-     * ```
-     * @static
-     */
-    wrap(identity: OpenFin.Identity): Promise<OpenFin.Layout>;
-    /**
-     * Synchronously returns a Layout object that represents a Window's layout.
-     * @param identity
-     *
-     * @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);
-     * // Use wrapped instance to control layout, e.g.:
-     * const layoutConfig = await layout.getConfig();
-     * ```
-     * @static
-     */
-    wrapSync(identity: OpenFin.Identity): OpenFin.Layout;
-    /**
-     * Asynchronously returns a Layout object that represents a Window's layout.
-     *
-     * @example
-     * ```js
-     * const layout = await fin.Platform.Layout.getCurrent();
-     * // Use wrapped instance to control layout, e.g.:
-     * const layoutConfig = await layout.getConfig();
-     * ```
-     * @static
-     */
-    getCurrent(): Promise<OpenFin.Layout>;
-    /**
-     * Synchronously returns a Layout object that represents a Window's layout.
-     *
-     * @remarks Cannot be called from a view.
-     *
-     *
-     * @example
-     * ```js
-     * const layout = fin.Platform.Layout.getCurrentSync();
-     * // Use wrapped instance to control layout, e.g.:
-     * const layoutConfig = await layout.getConfig();
-     * ```
-     * @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 options - Layout init options.
-     *
-     * @static
-     * @experimental
-     * @tutorial Layout.init
-     */
-    init: (options?: InitLayoutOptions) => Promise<OpenFin.Layout>;
-}
-export {};

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

@@ -1,151 +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");
-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 options - Layout init options.
-         *
-         * @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
-     *
-     * @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 = await fin.Platform.Layout.wrap(windowIdentity);
-     * // Use wrapped instance to control layout, e.g.:
-     * const layoutConfig = await layout.getConfig();
-     * ```
-     * @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
-     *
-     * @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);
-     * // Use wrapped instance to control layout, e.g.:
-     * const layoutConfig = await layout.getConfig();
-     * ```
-     * @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.
-     *
-     * @example
-     * ```js
-     * const layout = await fin.Platform.Layout.getCurrent();
-     * // Use wrapped instance to control layout, e.g.:
-     * const layoutConfig = await layout.getConfig();
-     * ```
-     * @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.
-     *
-     * @remarks Cannot be called from a view.
-     *
-     *
-     * @example
-     * ```js
-     * const layout = fin.Platform.Layout.getCurrentSync();
-     * // Use wrapped instance to control layout, e.g.:
-     * const layoutConfig = await layout.getConfig();
-     * ```
-     * @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();

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

@@ -1,192 +0,0 @@
-import type * as OpenFin from '../../../OpenFin';
-import { Transport } from '../../../transport/transport';
-import { Base } from '../../base';
-type Identity = OpenFin.Identity;
-type InitLayoutOptions = OpenFin.InitLayoutOptions;
-type PresetLayoutOptions = OpenFin.PresetLayoutOptions;
-export declare class Layout extends Base {
-    #private;
-    /**
-     * Initialize the window's Layout.
-     *
-     * @remarks 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 emit events locally 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.
-     *
-     * @example
-     * ```js
-     * // if no options are included, the layout in the window options is initialized in an element with the id `layout-container`
-     * const layout = await fin.Platform.Layout.init();
-     * ```
-     * <br /><br />
-     * # Example
-     * To target a different HTML element use the options object.
-     * ```js
-     * const containerId = 'my-custom-container-id';
-     *
-     * const myLayoutContainer = document.getElementById(containerId);
-     *
-     * myLayoutContainer.addEventListener('tab-created', function(event) {
-     *     const { tabSelector } = event.detail;
-     *     const tabElement = document.getElementById(tabSelector);
-     *     const existingColor = tabElement.style.backgroundColor;
-     *     tabElement.style.backgroundColor = "red";
-     *     setTimeout(() => {
-     *         tabElement.style.backgroundColor = existingColor;
-     *     }, 2000);
-     * });
-     *
-     * // initialize the layout into an existing HTML element with the div `my-custom-container-id`
-     * // the window must have been created with a layout in its window options
-     * const layout = await fin.Platform.Layout.init({ containerId });
-     * ```
-     */
-    init: (options?: InitLayoutOptions) => Promise<Layout>;
-    identity: Identity;
-    private platform;
-    wire: Transport;
-    /**
-     * @internal
-     */
-    constructor(identity: OpenFin.Identity, wire: Transport);
-    /**
-     * 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();
-     * ```
-     */
-    getConfig(): Promise<any>;
-    /**
-     * 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);
-     * ```
-     */
-    replace: (layout: OpenFin.LayoutOptions) => Promise<void>;
-    /**
-     * 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)`);
-     * ```
-     */
-    getRootItem(): Promise<OpenFin.ColumnOrRow | OpenFin.TabStack>;
-    /**
-     * 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);
-     * ```
-     */
-    replaceView: (viewToReplace: Identity, newView: OpenFin.PlatformViewCreationOptions) => Promise<void>;
-    /**
-     * 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' });
-     * ```
-     */
-    applyPreset: (options: PresetLayoutOptions) => Promise<void>;
-}
-export {};