@openfin/core 25.68.30 → 25.70.2

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

@@ -1,109 +1,109 @@
-import { Base } from '../base';
-import { Channel } from '../interappbus/channel/index';
-import Transport from '../../transport/transport';
-import { LayoutModule } from './layout/index';
-/**
- * InitPlatformOptions interface
- * @typedef { object } InitPlatformOptions
- * @property { OverrideCallback } [overrideCallback] a callback function that can be used to extend or replace default Provider behavior.
- */
-/**
- * @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.
- */
-/**
- * @typedef { object } PlatformOptions
- * @summary The options object required by {@link Platform#start Platform.start}
- * Any {@link ApplicationOption 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'.
- */
-/**
- * @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.
- */
-/**
- * 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;
-    private _initializer;
-    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>;
-}
+import { Base } from '../base';
+import { Channel } from '../interappbus/channel/index';
+import Transport from '../../transport/transport';
+import { LayoutModule } from './layout/index';
+/**
+ * InitPlatformOptions interface
+ * @typedef { object } InitPlatformOptions
+ * @property { OverrideCallback } [overrideCallback] a callback function that can be used to extend or replace default Provider behavior.
+ */
+/**
+ * @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.
+ */
+/**
+ * @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'.
+ */
+/**
+ * @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.
+ */
+/**
+ * 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;
+    private _initializer;
+    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>;
+}

package/src/api/platform/Factory.js

@@ -1,188 +1,188 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/* eslint-disable no-undef, no-underscore-dangle */
-const base_1 = require("../base");
-const index_1 = require("./layout/index");
-const Instance_1 = require("./Instance");
-/**
- * InitPlatformOptions interface
- * @typedef { object } InitPlatformOptions
- * @property { OverrideCallback } [overrideCallback] a callback function that can be used to extend or replace default Provider behavior.
- */
-/**
- * @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.
- */
-/**
- * @typedef { object } PlatformOptions
- * @summary The options object required by {@link Platform#start Platform.start}
- * Any {@link ApplicationOption 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'.
- */
-/**
- * @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.
- */
-/**
- * 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;
-        this._initializer = (...args) => this.wire.environment
-            .getProviderInitializer()
-            .then((initConstructor) => initConstructor(this.wire.environment)(...args));
-        /**
-         * @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) {
-        const overrideCallback = options === null || options === void 0 ? void 0 : options.overrideCallback;
-        const interopBroker = await this.fin.Interop.init(this.fin.me.uuid, options === null || options === void 0 ? void 0 : options.interopOverride);
-        // eslint-disable-next-line @typescript-eslint/ban-ts-ignore
-        // @ts-ignore debugging purposes
-        window.interopBroker = interopBroker;
-        return this._initializer(overrideCallback, interopBroker);
-    }
-    /**
-     * 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;
-                // eslint-disable-next-line @typescript-eslint/ban-ts-ignore
-                // @ts-ignore using private variable.
-                const app = await this.fin.Application._create({ ...platformOptions, isPlatformController: true });
-                app.once('platform-api-ready', () => resolve(this.wrapSync({ uuid })));
-                // eslint-disable-next-line @typescript-eslint/ban-ts-ignore
-                // @ts-ignore 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 {
-                // eslint-disable-next-line @typescript-eslint/ban-ts-ignore
-                // @ts-ignore using private variable.
-                const app = await this.fin.Application._createFromManifest(manifestUrl);
-                app.once('platform-api-ready', () => resolve(this.wrapSync({ uuid: app.identity.uuid })));
-                // eslint-disable-next-line @typescript-eslint/ban-ts-ignore
-                // @ts-ignore using private method without warning.
-                app._run(opts);
-            }
-            catch (e) {
-                reject(e);
-            }
-        });
-    }
-}
-exports.default = PlatformModule;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable no-undef, no-underscore-dangle */
+const base_1 = require("../base");
+const index_1 = require("./layout/index");
+const Instance_1 = require("./Instance");
+/**
+ * InitPlatformOptions interface
+ * @typedef { object } InitPlatformOptions
+ * @property { OverrideCallback } [overrideCallback] a callback function that can be used to extend or replace default Provider behavior.
+ */
+/**
+ * @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.
+ */
+/**
+ * @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'.
+ */
+/**
+ * @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.
+ */
+/**
+ * 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;
+        this._initializer = (...args) => this.wire.environment
+            .getProviderInitializer()
+            .then((initConstructor) => initConstructor(this.wire.environment)(...args));
+        /**
+         * @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) {
+        const overrideCallback = options === null || options === void 0 ? void 0 : options.overrideCallback;
+        const interopBroker = await this.fin.Interop.init(this.fin.me.uuid, options === null || options === void 0 ? void 0 : options.interopOverride);
+        // eslint-disable-next-line @typescript-eslint/ban-ts-ignore
+        // @ts-ignore debugging purposes
+        window.interopBroker = interopBroker;
+        return this._initializer(overrideCallback, interopBroker);
+    }
+    /**
+     * 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;
+                // eslint-disable-next-line @typescript-eslint/ban-ts-ignore
+                // @ts-ignore using private variable.
+                const app = await this.fin.Application._create({ ...platformOptions, isPlatformController: true });
+                app.once('platform-api-ready', () => resolve(this.wrapSync({ uuid })));
+                // eslint-disable-next-line @typescript-eslint/ban-ts-ignore
+                // @ts-ignore 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 {
+                // eslint-disable-next-line @typescript-eslint/ban-ts-ignore
+                // @ts-ignore using private variable.
+                const app = await this.fin.Application._createFromManifest(manifestUrl);
+                app.once('platform-api-ready', () => resolve(this.wrapSync({ uuid: app.identity.uuid })));
+                // eslint-disable-next-line @typescript-eslint/ban-ts-ignore
+                // @ts-ignore using private method without warning.
+                app._run(opts);
+            }
+            catch (e) {
+                reject(e);
+            }
+        });
+    }
+}
+exports.default = PlatformModule;