@openfin/core 33.76.31 → 33.76.38

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

@@ -1,115 +0,0 @@
-import type * as OpenFin from '../../OpenFin';
-import { Transport } from '../../transport/transport';
-import { Base } from '../base';
-import { LayoutModule } from './layout/index';
-type Channel = OpenFin.Fin['InterApplicationBus']['Channel'];
-/**
- * @PORTED
- * InitPlatformOptions interface
- * @typedef { object } InitPlatformOptions
- * @property { OverrideCallback } [overrideCallback] a callback function that can be used to extend or replace default Provider behavior.
- */
-/**
- * @PORTED
- * @typedef { same | different } ProcessAffinityStrategy
- * @summary Strategy to place views that share a domain into different process affinities or the same process affinity.
- * @property { string } same views in the same domain will have the same process affinity.
- * @property { string } different views in the same domain will have different process affinities.
- */
-/**
- * @PORTED
- * @typedef { object } PlatformOptions
- * @summary The options object required by {@link Platform#start Platform.start}
- * Any {@link ApplicationOptions Application option} is also a valid platform option
- * @property {Array.<Object>} [commands] Configuration for keyboard commands.
- * For details and usage, see [Using Keyboard Commands]{@link https://developers.openfin.co/docs/platform-api#section-5-3-using-keyboard-commands}.
- * @property {DefaultWindowOptions} [defaultWindowOptions] Default window options apply to all platform windows.
- * @property {View~options} [defaultViewOptions] Default view options apply to all platform views.
- * @property {ProcessAffinityStrategy} [viewProcessAffinityStrategy] 'same' | 'different'.
- */
-/**
- * @PORTED
- * @typedef { object } DefaultWindowOptions
- * @summary Default window options apply to all platform windows.
- * Any {@link Window~options Window option} is also a valid Default Window option
- * used by default in any window that is created in the current platform's scope.
- * Individual window options will override these defaults.
- * @property {string} [stylesheetUrl]
- * Specify a path of a custom CSS file to be injected to all of the platform's windows.
- * _note_: this option is only applied to windows that use the Default OpenFin Window.
- * Windows with a specified url (Custom Windows) will not be affected by this option.
- */
-/**
- * @DELETED
- * Snapshot interface
- * @typedef { object } Snapshot
- * @property { WindowOption[] } windows The array of window options objects
- */
-/**
- * @lends Platform
- */
-export default class PlatformModule extends Base {
-    private _channel;
-    Layout: LayoutModule;
-    constructor(wire: Transport, channel: Channel);
-    /**
-     * Initializes a Platform. Must be called from the Provider when using a custom provider.
-     * @param { InitPlatformOptions } [options] - platform options including a callback function that can be used to extend or replace
-     * default Provider behavior.
-     * @return {Promise.<void>}
-     * @tutorial Platform.init
-     * @experimental
-     * @static
-     */
-    init(options?: OpenFin.InitPlatformOptions): Promise<void>;
-    /**
-     * Asynchronously returns a Platform object that represents an existing platform.
-     * @param { Identity } identity
-     * @return {Promise.<Platform>}
-     * @tutorial Platform.wrap
-     * @static
-     */
-    wrap(identity: OpenFin.ApplicationIdentity): Promise<OpenFin.Platform>;
-    /**
-     * Synchronously returns a Platform object that represents an existing platform.
-     * @param { Identity } identity
-     * @return {Platform}
-     * @tutorial Platform.wrapSync
-     * @static
-     */
-    wrapSync(identity: OpenFin.ApplicationIdentity): OpenFin.Platform;
-    /**
-     * Asynchronously returns a Platform object that represents the current platform.
-     * @return {Promise.<Platform>}
-     * @tutorial Platform.getCurrent
-     * @static
-     */
-    getCurrent(): Promise<OpenFin.Platform>;
-    /**
-     * Synchronously returns a Platform object that represents the current platform.
-     * @return {Platform}
-     * @tutorial Platform.getCurrentSync
-     * @static
-     */
-    getCurrentSync(): OpenFin.Platform;
-    /**
-     * Creates and starts a Platform and returns a wrapped and running Platform instance. The wrapped Platform methods can
-     * be used to launch content into the platform.  Promise will reject if the platform is already running.
-     * @param { PlatformOptions } platformOptions
-     * @return {Promise.<Platform>}
-     * @tutorial Platform.start
-     * @static
-     */
-    start(platformOptions: OpenFin.PlatformOptions): Promise<OpenFin.Platform>;
-    /**
-     * Retrieves platforms's manifest and returns a wrapped and running Platform.  If there is a snapshot in the manifest,
-     * it will be launched into the platform.
-     * @param {string} manifestUrl - The URL of platform's manifest.
-     * @param {RvmLaunchOptions} [opts] - Parameters that the RVM will use.
-     * @return {Promise.<Platform>}
-     * @tutorial Platform.startFromManifest
-     * @static
-     */
-    startFromManifest(manifestUrl: string, opts?: OpenFin.RvmLaunchOptions): Promise<OpenFin.Platform>;
-}
-export {};

package/src/api/platform/Factory.js

@@ -1,184 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const base_1 = require("../base");
-const Instance_1 = require("./Instance");
-const index_1 = require("./layout/index");
-/**
- * @PORTED
- * InitPlatformOptions interface
- * @typedef { object } InitPlatformOptions
- * @property { OverrideCallback } [overrideCallback] a callback function that can be used to extend or replace default Provider behavior.
- */
-/**
- * @PORTED
- * @typedef { same | different } ProcessAffinityStrategy
- * @summary Strategy to place views that share a domain into different process affinities or the same process affinity.
- * @property { string } same views in the same domain will have the same process affinity.
- * @property { string } different views in the same domain will have different process affinities.
- */
-/**
- * @PORTED
- * @typedef { object } PlatformOptions
- * @summary The options object required by {@link Platform#start Platform.start}
- * Any {@link ApplicationOptions Application option} is also a valid platform option
- * @property {Array.<Object>} [commands] Configuration for keyboard commands.
- * For details and usage, see [Using Keyboard Commands]{@link https://developers.openfin.co/docs/platform-api#section-5-3-using-keyboard-commands}.
- * @property {DefaultWindowOptions} [defaultWindowOptions] Default window options apply to all platform windows.
- * @property {View~options} [defaultViewOptions] Default view options apply to all platform views.
- * @property {ProcessAffinityStrategy} [viewProcessAffinityStrategy] 'same' | 'different'.
- */
-/**
- * @PORTED
- * @typedef { object } DefaultWindowOptions
- * @summary Default window options apply to all platform windows.
- * Any {@link Window~options Window option} is also a valid Default Window option
- * used by default in any window that is created in the current platform's scope.
- * Individual window options will override these defaults.
- * @property {string} [stylesheetUrl]
- * Specify a path of a custom CSS file to be injected to all of the platform's windows.
- * _note_: this option is only applied to windows that use the Default OpenFin Window.
- * Windows with a specified url (Custom Windows) will not be affected by this option.
- */
-/**
- * @DELETED
- * Snapshot interface
- * @typedef { object } Snapshot
- * @property { WindowOption[] } windows The array of window options objects
- */
-/**
- * @lends Platform
- */
-class PlatformModule extends base_1.Base {
-    constructor(wire, channel) {
-        super(wire);
-        this._channel = channel;
-        /**
-         * @namespace
-         * @desc Layouts give app providers the ability to embed multiple views in a single window.  The Layout namespace
-         * enables the initialization and manipulation of a window's Layout.  A Layout will
-         * <a href="tutorial-Layout.DOMEvents.html">emit events locally</a> on the DOM element representing the layout-container.
-         */
-        this.Layout = new index_1.LayoutModule(this.wire);
-    }
-    /**
-     * Initializes a Platform. Must be called from the Provider when using a custom provider.
-     * @param { InitPlatformOptions } [options] - platform options including a callback function that can be used to extend or replace
-     * default Provider behavior.
-     * @return {Promise.<void>}
-     * @tutorial Platform.init
-     * @experimental
-     * @static
-     */
-    async init(options) {
-        return this.wire.environment.initPlatform(this.fin, options);
-    }
-    /**
-     * Asynchronously returns a Platform object that represents an existing platform.
-     * @param { Identity } identity
-     * @return {Promise.<Platform>}
-     * @tutorial Platform.wrap
-     * @static
-     */
-    async wrap(identity) {
-        this.wire.sendAction('platform-wrap').catch((e) => {
-            // don't expose
-        });
-        return new Instance_1.Platform({ uuid: identity.uuid }, this._channel);
-    }
-    /**
-     * Synchronously returns a Platform object that represents an existing platform.
-     * @param { Identity } identity
-     * @return {Platform}
-     * @tutorial Platform.wrapSync
-     * @static
-     */
-    wrapSync(identity) {
-        this.wire.sendAction('platform-wrap-sync').catch((e) => {
-            // don't expose
-        });
-        return new Instance_1.Platform({ uuid: identity.uuid }, this._channel);
-    }
-    /**
-     * Asynchronously returns a Platform object that represents the current platform.
-     * @return {Promise.<Platform>}
-     * @tutorial Platform.getCurrent
-     * @static
-     */
-    async getCurrent() {
-        this.wire.sendAction('platform-get-current').catch((e) => {
-            // don't expose
-        });
-        return this.wrap({ uuid: this.wire.me.uuid });
-    }
-    /**
-     * Synchronously returns a Platform object that represents the current platform.
-     * @return {Platform}
-     * @tutorial Platform.getCurrentSync
-     * @static
-     */
-    getCurrentSync() {
-        this.wire.sendAction('platform-get-current-sync').catch((e) => {
-            // don't expose
-        });
-        return this.wrapSync({ uuid: this.wire.me.uuid });
-    }
-    /**
-     * Creates and starts a Platform and returns a wrapped and running Platform instance. The wrapped Platform methods can
-     * be used to launch content into the platform.  Promise will reject if the platform is already running.
-     * @param { PlatformOptions } platformOptions
-     * @return {Promise.<Platform>}
-     * @tutorial Platform.start
-     * @static
-     */
-    start(platformOptions) {
-        this.wire.sendAction('platform-start').catch((e) => {
-            // don't expose
-        });
-        // eslint-disable-next-line no-async-promise-executor
-        return new Promise(async (resolve, reject) => {
-            try {
-                const { uuid } = platformOptions;
-                // @ts-expect-error using private variable.
-                const app = await this.fin.Application._create({ ...platformOptions, isPlatformController: true });
-                // TODO: fix typing (internal)
-                // @ts-expect-error
-                app.once('platform-api-ready', () => resolve(this.wrapSync({ uuid })));
-                // @ts-expect-error using private variable.
-                app._run({ uuid });
-            }
-            catch (e) {
-                reject(e);
-            }
-        });
-    }
-    /**
-     * Retrieves platforms's manifest and returns a wrapped and running Platform.  If there is a snapshot in the manifest,
-     * it will be launched into the platform.
-     * @param {string} manifestUrl - The URL of platform's manifest.
-     * @param {RvmLaunchOptions} [opts] - Parameters that the RVM will use.
-     * @return {Promise.<Platform>}
-     * @tutorial Platform.startFromManifest
-     * @static
-     */
-    startFromManifest(manifestUrl, opts) {
-        this.wire.sendAction('platform-start-from-manifest').catch((e) => {
-            // don't expose
-        });
-        // eslint-disable-next-line no-async-promise-executor
-        return new Promise(async (resolve, reject) => {
-            try {
-                // @ts-expect-error using private variable.
-                const app = await this.fin.Application._createFromManifest(manifestUrl);
-                // TODO: fix typing (internal)
-                // @ts-expect-error
-                app.once('platform-api-ready', () => resolve(this.wrapSync({ uuid: app.identity.uuid })));
-                // @ts-expect-error using private method without warning.
-                app._run(opts);
-            }
-            catch (e) {
-                reject(e);
-            }
-        });
-    }
-}
-exports.default = PlatformModule;

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

@@ -1,150 +0,0 @@
-import type * as OpenFin from '../../OpenFin';
-import { EmitterBase } from '../base';
-type View = OpenFin.View;
-type Channel = OpenFin.Fin['InterApplicationBus']['Channel'];
-type ChannelClient = OpenFin.ChannelClient;
-type LayoutModule = OpenFin.Fin['Platform']['Layout'];
-/** 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
- */
-export declare class Platform extends EmitterBase<OpenFin.PlatformEvent> {
-    #private;
-    Layout: LayoutModule;
-    private _channel;
-    Application: OpenFin.Application;
-    identity: OpenFin.ApplicationIdentity;
-    constructor(identity: OpenFin.ApplicationIdentity, channel: Channel);
-    getClient: (identity?: OpenFin.ApplicationIdentity) => Promise<ChannelClient>;
-    /**
-     * 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
-     */
-    createView(viewOptions: OpenFin.PlatformViewCreationOptions, target?: OpenFin.CreateViewTarget, targetView?: OpenFin.Identity): Promise<View>;
-    /**
-     * Creates a new Window.
-     * @param { Window~options } options Window creation options
-     * @return { Promise<_Window> }
-     * @tutorial Platform.createWindow
-     */
-    createWindow(options: OpenFin.PlatformWindowCreationOptions): Promise<OpenFin.Window & OpenFin.Identity>;
-    /**
-     * Closes current platform, all its windows, and their views.
-     * @return { Promise<void> }
-     * @tutorial Platform.quit
-     */
-    quit(): Promise<void>;
-    /**
-     * Closes a specified view in a target window.
-     * @param { Identity } viewIdentity View identity
-     * @return { Promise<void> }
-     * @tutorial Platform.closeView
-     */
-    closeView(viewIdentity: OpenFin.Identity): Promise<void>;
-    /**
-     * ***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
-     */
-    reparentView(viewIdentity: OpenFin.Identity, target: OpenFin.Identity): Promise<View>;
-    /**
-     * 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
-     */
-    getSnapshot(): Promise<OpenFin.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
-     */
-    getViewSnapshot(viewIdentity: OpenFin.Identity): Promise<OpenFin.ViewState>;
-    /**
-     * 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
-     */
-    applySnapshot(requestedSnapshot: OpenFin.Snapshot | string, options?: OpenFin.ApplySnapshotOptions): Promise<Platform>;
-    /**
-     * 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
-     */
-    fetchManifest(manifestUrl: string): Promise<any>;
-    launchLegacyManifest: (manifestUrl: string) => Promise<Platform>;
-    /**
-     * 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
-     */
-    launchContentManifest(manifestUrl: string): Promise<Platform>;
-    /**
-     * 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
-     */
-    setWindowContext(context?: any, target?: OpenFin.Identity): Promise<void>;
-    /**
-     * 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
-     */
-    getWindowContext(target?: OpenFin.Identity): Promise<any>;
-    /**
-     * 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
-     */
-    closeWindow(windowId: OpenFin.Identity, options?: {
-        skipBeforeUnload: boolean;
-    }): Promise<void>;
-}
-export {};