@openfin/core 33.76.36 → 33.77.1

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

@@ -1,171 +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'];
-export default class PlatformModule extends Base {
-    private _channel;
-    Layout: LayoutModule;
-    /**
-     * @internal
-     */
-    constructor(wire: Transport, channel: Channel);
-    /**
-     * Initializes a Platform. Must be called from the Provider when using a custom provider.
-     * @param options - platform options including a callback function that can be used to extend or replace
-     * default Provider behavior.
-     *
-     * @remarks Must be called from the Provider when using a custom provider.
-     *
-     * @example
-     *
-     * ```js
-     * // From Provider context
-     * await fin.Platform.init();
-     * // Platform API is now hooked up and windows contained in the manifest snapshot are open.
-     * ```
-     *
-     * `Platform.init` accepts an options object that can contain a callback function which can be used to extend or
-     * replace default Provider behavior. As an argument, this function will receive the `Provider` class, which is
-     * used to handle Platform actions. The function must return an object with methods to handle Platform API actions.
-     * The recommended approach is to extend the `Provider` class, overriding the methods you wish to alter, and return an
-     * instance of your subclass:
-     *
-     * ```js
-     * const overrideCallback = async (PlatformProvider) => {
-     *     // Actions can be performed before initialization.
-     *     // e.g. we might authenticate a user, set up a Channel, etc before initializing the Platform.
-     *     const { manifestUrl } = await fin.Application.getCurrentSync().getInfo();
-     *
-     *     // Extend or replace default PlatformProvider behavior by extending the PlatformProvider class.
-     *     class MyOverride extends PlatformProvider {
-     *         // Default behavior can be changed by implementing methods with the same names as those used by the default PlatformProvider.
-     *         async getSnapshot() {
-     *             // Since we are extending the class, we can call `super` methods to access default behavior.
-     *             const snapshot = await super.getSnapshot();
-     *             // But we can modify return values.
-     *             return { ...snapshot, answer: 42, manifestUrl };
-     *         }
-     *         async replaceLayout({ opts, target }) {
-     *             // To disable an API method, overwrite with a noop function.
-     *             return;
-     *         }
-     *     }
-     *     // Return instance with methods to be consumed by Platform.
-     *     // The returned object must implement all methods of the PlatformProvider class.
-     *     // By extending the class, we can simply inherit methods we do not wish to alter.
-     *     return new MyOverride();
-     * };
-     *
-     * fin.Platform.init({overrideCallback});
-     * ```
-     * @experimental
-     * @static
-     */
-    init(options?: OpenFin.InitPlatformOptions): Promise<void>;
-    /**
-     * Asynchronously returns a Platform object that represents an existing platform.
-     * @param identity
-     *
-     * @example
-     * ```js
-     * const { identity } = fin.me;
-     * const platform = await fin.Platform.wrap(identity);
-     * // Use wrapped instance to control layout, e.g.:
-     * const snapshot = await platform.getSnapshot();
-     * ```
-     * @static
-     */
-    wrap(identity: OpenFin.ApplicationIdentity): Promise<OpenFin.Platform>;
-    /**
-     * Synchronously returns a Platform object that represents an existing platform.
-     * @param identity
-     *
-     * @example
-     * ```js
-     * const { identity } = fin.me;
-     * const platform = fin.Platform.wrapSync(identity);
-     * // Use wrapped instance to control layout, e.g.:
-     * const snapshot = await platform.getSnapshot();
-     * ```
-     * @static
-     */
-    wrapSync(identity: OpenFin.ApplicationIdentity): OpenFin.Platform;
-    /**
-     * Asynchronously returns a Platform object that represents the current platform.
-     *
-     * @example
-     * ```js
-     * const platform = await fin.Platform.getCurrent();
-     * // Use wrapped instance to control layout, e.g.:
-     * const snapshot = await platform.getSnapshot();
-     * ```
-     * @static
-     */
-    getCurrent(): Promise<OpenFin.Platform>;
-    /**
-     * Synchronously returns a Platform object that represents the current platform.
-     *
-     * @example
-     * ```js
-     * const platform = fin.Platform.getCurrentSync();
-     * // Use wrapped instance to control layout, e.g.:
-     * const snapshot = await platform.getSnapshot();
-     * ```
-     * @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
-     *
-     * @example
-     * ```js
-     * try {
-     *     const platform = await fin.Platform.start({
-     *         uuid: 'platform-1',
-     *         autoShow: false,
-     *         defaultWindowOptions: {
-     *             stylesheetUrl: 'css-sheet-url',
-     *             cornerRounding: {
-     *                 height: 10,
-     *                 width: 10
-     *             }
-     *         }
-     *     });
-     *     console.log('Platform is running', platform);
-     * } catch(e) {
-     *     console.error(e);
-     * }
-     * ```
-     * @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 manifestUrl - The URL of platform's manifest.
-     * @param opts - Parameters that the RVM will use.
-     *
-     * @example
-     * ```js
-     * try {
-     *     const platform = await fin.Platform.startFromManifest('https://openfin.github.io/golden-prototype/public.json');
-     *     console.log('Platform is running, wrapped platform: ', platform);
-     * } catch(e) {
-     *     console.error(e);
-     * }
-     * // For a local manifest file:
-     * try {
-     *     const platform = await fin.Platform.startFromManifest('file:///C:/somefolder/app.json');
-     *     console.log('Platform is running, wrapped platform: ', platform);
-     * } catch(e) {
-     *     console.error(e);
-     * }
-     * ```
-     * @static
-     */
-    startFromManifest(manifestUrl: string, opts?: OpenFin.RvmLaunchOptions): Promise<OpenFin.Platform>;
-}
-export {};

package/src/api/platform/Factory.js

@@ -1,240 +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");
-class PlatformModule extends base_1.Base {
-    /**
-     * @internal
-     */
-    constructor(wire, channel) {
-        super(wire);
-        this._channel = channel;
-        /**
-         *
-         * @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 options - platform options including a callback function that can be used to extend or replace
-     * default Provider behavior.
-     *
-     * @remarks Must be called from the Provider when using a custom provider.
-     *
-     * @example
-     *
-     * ```js
-     * // From Provider context
-     * await fin.Platform.init();
-     * // Platform API is now hooked up and windows contained in the manifest snapshot are open.
-     * ```
-     *
-     * `Platform.init` accepts an options object that can contain a callback function which can be used to extend or
-     * replace default Provider behavior. As an argument, this function will receive the `Provider` class, which is
-     * used to handle Platform actions. The function must return an object with methods to handle Platform API actions.
-     * The recommended approach is to extend the `Provider` class, overriding the methods you wish to alter, and return an
-     * instance of your subclass:
-     *
-     * ```js
-     * const overrideCallback = async (PlatformProvider) => {
-     *     // Actions can be performed before initialization.
-     *     // e.g. we might authenticate a user, set up a Channel, etc before initializing the Platform.
-     *     const { manifestUrl } = await fin.Application.getCurrentSync().getInfo();
-     *
-     *     // Extend or replace default PlatformProvider behavior by extending the PlatformProvider class.
-     *     class MyOverride extends PlatformProvider {
-     *         // Default behavior can be changed by implementing methods with the same names as those used by the default PlatformProvider.
-     *         async getSnapshot() {
-     *             // Since we are extending the class, we can call `super` methods to access default behavior.
-     *             const snapshot = await super.getSnapshot();
-     *             // But we can modify return values.
-     *             return { ...snapshot, answer: 42, manifestUrl };
-     *         }
-     *         async replaceLayout({ opts, target }) {
-     *             // To disable an API method, overwrite with a noop function.
-     *             return;
-     *         }
-     *     }
-     *     // Return instance with methods to be consumed by Platform.
-     *     // The returned object must implement all methods of the PlatformProvider class.
-     *     // By extending the class, we can simply inherit methods we do not wish to alter.
-     *     return new MyOverride();
-     * };
-     *
-     * fin.Platform.init({overrideCallback});
-     * ```
-     * @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
-     *
-     * @example
-     * ```js
-     * const { identity } = fin.me;
-     * const platform = await fin.Platform.wrap(identity);
-     * // Use wrapped instance to control layout, e.g.:
-     * const snapshot = await platform.getSnapshot();
-     * ```
-     * @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
-     *
-     * @example
-     * ```js
-     * const { identity } = fin.me;
-     * const platform = fin.Platform.wrapSync(identity);
-     * // Use wrapped instance to control layout, e.g.:
-     * const snapshot = await platform.getSnapshot();
-     * ```
-     * @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.
-     *
-     * @example
-     * ```js
-     * const platform = await fin.Platform.getCurrent();
-     * // Use wrapped instance to control layout, e.g.:
-     * const snapshot = await platform.getSnapshot();
-     * ```
-     * @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.
-     *
-     * @example
-     * ```js
-     * const platform = fin.Platform.getCurrentSync();
-     * // Use wrapped instance to control layout, e.g.:
-     * const snapshot = await platform.getSnapshot();
-     * ```
-     * @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
-     *
-     * @example
-     * ```js
-     * try {
-     *     const platform = await fin.Platform.start({
-     *         uuid: 'platform-1',
-     *         autoShow: false,
-     *         defaultWindowOptions: {
-     *             stylesheetUrl: 'css-sheet-url',
-     *             cornerRounding: {
-     *                 height: 10,
-     *                 width: 10
-     *             }
-     *         }
-     *     });
-     *     console.log('Platform is running', platform);
-     * } catch(e) {
-     *     console.error(e);
-     * }
-     * ```
-     * @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 manifestUrl - The URL of platform's manifest.
-     * @param opts - Parameters that the RVM will use.
-     *
-     * @example
-     * ```js
-     * try {
-     *     const platform = await fin.Platform.startFromManifest('https://openfin.github.io/golden-prototype/public.json');
-     *     console.log('Platform is running, wrapped platform: ', platform);
-     * } catch(e) {
-     *     console.error(e);
-     * }
-     * // For a local manifest file:
-     * try {
-     *     const platform = await fin.Platform.startFromManifest('file:///C:/somefolder/app.json');
-     *     console.log('Platform is running, wrapped platform: ', platform);
-     * } catch(e) {
-     *     console.error(e);
-     * }
-     * ```
-     * @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;