@openfin/core 33.76.36 → 33.77.1

package/src/api/application/Factory.js

@@ -1,278 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const base_1 = require("../base");
-const validate_1 = require("../../util/validate");
-const Instance_1 = require("./Instance");
-class ApplicationModule extends base_1.Base {
-    /**
-     * Asynchronously returns an Application object that represents an existing application.
-     * @param identity
-     *
-     * @example
-     *
-     * ```js
-     * fin.Application.wrap({ uuid: 'testapp' })
-     * .then(app => app.isRunning())
-     * .then(running => console.log('Application is running: ' + running))
-     * .catch(err => console.log(err));
-     * ```
-     *
-     * @static
-     */
-    async wrap(identity) {
-        this.wire.sendAction('wrap-application').catch((e) => {
-            // we do not want to expose this error, just continue if this analytics-only call fails
-        });
-        const errorMsg = (0, validate_1.validateIdentity)(identity);
-        if (errorMsg) {
-            throw new Error(errorMsg);
-        }
-        return new Instance_1.Application(this.wire, identity);
-    }
-    /**
-     * Synchronously returns an Application object that represents an existing application.
-     * @param identity
-     *
-     * @example
-     *
-     * ```js
-     * const app = fin.Application.wrapSync({ uuid: 'testapp' });
-     * await app.close();
-     * ```
-     *
-     * @static
-     */
-    wrapSync(identity) {
-        this.wire.sendAction('wrap-application-sync').catch((e) => {
-            // we do not want to expose this error, just continue if this analytics-only call fails
-        });
-        const errorMsg = (0, validate_1.validateIdentity)(identity);
-        if (errorMsg) {
-            throw new Error(errorMsg);
-        }
-        return new Instance_1.Application(this.wire, identity);
-    }
-    async _create(appOptions) {
-        // set defaults:
-        if (appOptions.waitForPageLoad === undefined) {
-            appOptions.waitForPageLoad = false;
-        }
-        if (appOptions.autoShow === undefined && appOptions.isPlatformController === undefined) {
-            appOptions.autoShow = true;
-        }
-        await this.wire.sendAction('create-application', appOptions);
-        return this.wrap({ uuid: appOptions.uuid });
-    }
-    /**
-     * DEPRECATED method to create a new Application. Use {@link Application.ApplicationModule.start Application.start} instead.
-     * @param appOptions
-     *
-     *
-     * @example
-     *
-     * ```js
-     * async function createApp() {
-     *     const app = await fin.Application.create({
-     *         name: 'myApp',
-     *         uuid: 'app-3',
-     *         url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Application.create.html',
-     *         autoShow: true
-     *     });
-     *     await app.run();
-     * }
-     *
-     * createApp().then(() => console.log('Application is created')).catch(err => console.log(err));
-     * ```
-     *
-     * @ignore
-     */
-    create(appOptions) {
-        console.warn('Deprecation Warning: fin.Application.create is deprecated. Please use fin.Application.start');
-        this.wire.sendAction('application-create').catch((e) => {
-            // we do not want to expose this error, just continue if this analytics-only call fails
-        });
-        return this._create(appOptions);
-    }
-    /**
-     * Creates and starts a new Application.
-     * @param appOptions
-     *
-     * @example
-     *
-     * ```js
-     * async function start() {
-     *     return fin.Application.start({
-     *         name: 'app-1',
-     *         uuid: 'app-1',
-     *         url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Application.start.html',
-     *         autoShow: true
-     *     });
-     * }
-     * start().then(() => console.log('Application is running')).catch(err => console.log(err));
-     * ```
-     *
-     *
-     * @static
-     */
-    async start(appOptions) {
-        this.wire.sendAction('start-application').catch((e) => {
-            // we do not want to expose this error, just continue if this analytics-only call fails
-        });
-        const app = await this._create(appOptions);
-        await this.wire.sendAction('run-application', { uuid: appOptions.uuid });
-        return app;
-    }
-    /**
-     * Asynchronously starts a batch of applications given an array of application identifiers and manifestUrls.
-     * Returns once the RVM is finished attempting to launch the applications.
-     * @param applications
-     * @param opts - Parameters that the RVM will use.
-     *
-     * @static
-     * @example
-     *
-     * ```js
-     *
-     * const applicationInfoArray = [
-     *     {
-     *         "uuid": 'App-1',
-     *         "manifestUrl": 'http://localhost:5555/app1.json',
-     *     },
-     *     {
-     *         "uuid": 'App-2',
-     *         "manifestUrl": 'http://localhost:5555/app2.json',
-     *     },
-     *     {
-     *         "uuid": 'App-3',
-     *         "manifestUrl": 'http://localhost:5555/app3.json',
-     *     }
-     * ]
-     *
-     * fin.Application.startManyManifests(applicationInfoArray)
-     *     .then(() => {
-     *         console.log('RVM has finished launching the application list.');
-     *     })
-     *     .catch((err) => {
-     *         console.log(err);
-     *     })
-     * ```
-     *
-     * @experimental
-     */
-    async startManyManifests(applications, opts) {
-        return this.wire.sendAction('run-applications', { applications, opts }).then(() => undefined);
-    }
-    /**
-     * Asynchronously returns an Application object that represents the current application
-     *
-     * @example
-     *
-     * ```js
-     * async function isCurrentAppRunning () {
-     *     const app = await fin.Application.getCurrent();
-     *     return app.isRunning();
-     * }
-     *
-     * isCurrentAppRunning().then(running => {
-     *     console.log(`Current app is running: ${running}`);
-     * }).catch(err => {
-     *     console.error(err);
-     * });
-     *
-     * ```
-     *
-     * @static
-     */
-    getCurrent() {
-        this.wire.sendAction('get-current-application').catch((e) => {
-            // we do not want to expose this error, just continue if this analytics-only call fails
-        });
-        return this.wrap({ uuid: this.wire.me.uuid });
-    }
-    /**
-     * Synchronously returns an Application object that represents the current application
-     *
-     * @example
-     *
-     * ```js
-     * async function isCurrentAppRunning () {
-     *     const app = fin.Application.getCurrentSync();
-     *     return app.isRunning();
-     * }
-     *
-     * isCurrentAppRunning().then(running => {
-     *     console.log(`Current app is running: ${running}`);
-     * }).catch(err => {
-     *     console.error(err);
-     * });
-     *
-     * ```
-     *
-     * @static
-     */
-    getCurrentSync() {
-        this.wire.sendAction('get-current-application-sync').catch((e) => {
-            // we do not want to expose this error, just continue if this analytics-only call fails
-        });
-        return this.wrapSync({ uuid: this.wire.me.uuid });
-    }
-    /**
-     * Retrieves application's manifest and returns a running instance of the application.
-     * @param manifestUrl - The URL of app's manifest.
-     * @param opts - Parameters that the RVM will use.
-     *
-     * @example
-     *
-     * ```js
-     * fin.Application.startFromManifest('http://localhost:5555/app.json').then(app => console.log('App is running')).catch(err => console.log(err));
-     *
-     * // For a local manifest file:
-     * fin.Application.startFromManifest('file:///C:/somefolder/app.json').then(app => console.log('App is running')).catch(err => console.log(err));
-     * ```
-     *
-     * @static
-     */
-    async startFromManifest(manifestUrl, opts) {
-        this.wire.sendAction('application-start-from-manifest').catch((e) => {
-            // we do not want to expose this error, just continue if this analytics-only call fails
-        });
-        const app = await this._createFromManifest(manifestUrl);
-        // @ts-expect-error using private method without warning.
-        await app._run(opts); // eslint-disable-line no-underscore-dangle
-        return app;
-    }
-    /**
-     * @deprecated Use {@link Application.ApplicationModule.startFromManifest Application.startFromManifest} instead.
-     * Retrieves application's manifest and returns a wrapped application.
-     * @param manifestUrl - The URL of app's manifest.
-     * @param callback - called if the method succeeds.
-     * @param errorCallback - called if the method fails. The reason for failure is passed as an argument.
-     *
-     * @example
-     *
-     * ```js
-     * fin.Application.createFromManifest('http://localhost:5555/app.json').then(app => console.log(app)).catch(err => console.log(err));
-     * ```
-     * @ignore
-     */
-    createFromManifest(manifestUrl) {
-        console.warn('Deprecation Warning: fin.Application.createFromManifest is deprecated. Please use fin.Application.startFromManifest');
-        this.wire.sendAction('application-create-from-manifest').catch((e) => {
-            // we do not want to expose this error, just continue if this analytics-only call fails
-        });
-        return this._createFromManifest(manifestUrl);
-    }
-    _createFromManifest(manifestUrl) {
-        return this.wire
-            .sendAction('get-application-manifest', { manifestUrl })
-            .then(({ payload }) => {
-            const uuid = payload.data.platform ? payload.data.platform.uuid : payload.data.startup_app.uuid;
-            return this.wrap({ uuid });
-        })
-            .then((app) => {
-            app._manifestUrl = manifestUrl; // eslint-disable-line no-underscore-dangle
-            return app;
-        });
-    }
-}
-exports.default = ApplicationModule;