@openfin/core 25.68.26

package/README.md

@@ -0,0 +1,41 @@
+# OpenFin Core
+
+This package contains the type definitions and API entry points for the OpenFin Core API.  Start here to develop OpenFin applications in TypeScript.
+
+Libraries are also available for the following frameworks:
+
+* [Node.js](https://www.npmjs.com/package/openfin-adapter)
+* [.Net](https://developers.openfin.co/of-docs/docs/net-api)
+* [Java](https://developers.openfin.co/of-docs/docs/java-api)
+
+## Installation
+
+This package cannot be installed as a dev dependency because it is not types-only.
+
+To install, run:
+
+`npm i -S @openfin/core`
+
+## Usage
+
+The `fin` export is the primary API entry point.  Type definitions are defined in the package's default export.  The exported `inOpenFin` boolean is true if the `fin` API is available in the current context.
+
+```typescript
+import OpenFin, { fin, inOpenFin } from "@openfin/core"; 
+
+const showWindow = async (identity: OpenFin.Identity) => {
+   const win = await fin.Window.wrap(identity);
+   await win.show();
+}
+```
+
+## License
+
+Copyright 2020-2022 OpenFin
+
+The code in this package is distributed under the Apache License, Version 2.0.
+
+However, if you run this code, it may call on the OpenFin RVM or OpenFin Runtime, which are covered by OpenFin's Developer, Community, and Enterprise licenses. You can learn more about OpenFin licensing at the links listed below or email us at support@openfin.co with questions.
+
+- [Licensing](https://www.openfin.co/licensing/)
+- [Developer agreement](https://openfin.co/developer-agreement/)

package/docs.README(OLD).md

@@ -0,0 +1,82 @@
+The HadoukenIO node-adapter allows the use of the Hadouken API from Node.js applications.
+
+## Requirements
+
+- Node.js LTS ^6.9
+
+### Install as dependency
+
+$ `npm install -S HadoukenIO/node-adapter`
+
+### Usage
+
+Connecting to an already running runtime
+
+```javascript
+const { connect, Identity } = require("hadouken-js-adapter");
+
+async function launchApp() {
+    const fin  = await connect({
+        address: "ws://localhost:9696",
+        uuid: "my-uuid-123"
+    });
+
+    const version = await fin.System.getVersion();
+    console.log("Connected to Hadouken version", version);
+
+    const app = await fin.Application.create({
+        name: "adapter-test-app",
+        url: 'http://hadouken.io/',
+        uuid: "adapter-test-app",
+        autoShow: true,
+        nonPersistent : true
+    });
+
+    await app.run();
+}
+
+launchApp().then(() => {
+    console.log("success");
+}).catch((err) => {
+    console.log("Error trying to connect,", err.message);
+    console.log(err.stack);
+});
+```
+
+Launching a runtime and connecting
+
+```javascript
+const { connect, Identity } = require("hadouken-js-adapter");
+
+async function launchApp() {
+    const fin  = await connect({
+        uuid: "my-uuid-123",
+        runtime: {
+            version: 'stable'
+        }
+    });
+
+    const version = await fin.System.getVersion();
+    console.log("Connected to Hadouken version", version);
+
+    const app = await fin.Application.create({
+        name: "adapter-test-app",
+        url: 'http://hadouken.io/',
+        uuid: "adapter-test-app",
+        autoShow: true,
+        nonPersistent : true
+    });
+
+    await app.run();
+}
+
+launchApp().then(() => {
+    console.log("success");
+}).catch((err) => {
+    console.log("Error trying to connect,", err.message);
+    console.log(err.stack);
+});
+
+```
+
+Note that either an address or a runtime object with version are required to connect

package/fin.d.ts

@@ -0,0 +1,4 @@
+/* eslint-disable spaced-comment */
+/* eslint-disable @typescript-eslint/triple-slash-reference */
+/// <reference path="./OpenFin.d.ts"/>
+declare const fin: import('./src/api/fin').FinApi<'window' | 'view'>;

package/package.json

@@ -0,0 +1,33 @@
+{
+    "name": "@openfin/core",
+    "version": "25.68.26",
+    "license": "Apache-2.0",
+    "main": "./src/mock.js",
+    "types": "./src/mock.d.ts",
+    "scripts": {
+        "path": "PATH"
+    },
+    "devDependencies": {
+        "@types/jquery": "^3.3.31",
+        "@types/lodash": "^4.14.171",
+        "@types/mocha": "^2.2.38",
+        "@types/rimraf": "0.0.28",
+        "@types/sinon": "^1.16.34",
+        "@types/ws": "~0.0.36",
+        "events": "^3.0.0",
+        "grunt": "^1.0.4",
+        "grunt-mocha-test": "^0.13.3",
+        "http-server": "^0.11.1",
+        "jsdoc": "3.5.5",
+        "mocha": "^5.2.0",
+        "mocha-junit-reporter": "1.23.3",
+        "ps-node": "^0.1.6",
+        "rimraf": "^2.6.2",
+        "shelljs": "^0.8.2",
+        "sinon": "~1.17.6"
+    },
+    "dependencies": {
+        "lodash": "^4.17.21",
+        "ws": "^7.3.0"
+    }
+}

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

@@ -0,0 +1,145 @@
+import { Base } from '../base';
+/**
+ * @typedef {object} ApplicationOption
+ * @summary Application creation options.
+ * @desc This is the options object required by {@link Application.start Application.start}.
+ *
+ * The following options are required:
+ * * `uuid` is required in the app manifest as well as by {@link Application.start Application.start}
+ * * `name` is optional in the app manifest but required by {@link Application.start Application.start}
+ * * `url` is optional in both the app manifest {@link Application.start Application.start} and  but is usually given
+ * (defaults to `"about:blank"` when omitted).
+ *
+ * _This jsdoc typedef mirrors the `ApplicationOption` TypeScript interface in `@types/openfin`._
+ *
+ * **IMPORTANT NOTE:**
+ * This object inherits all the properties of the window creation {@link Window~options options} object,
+ * which will take priority over those of the same name that may be provided in `mainWindowOptions`.
+ *
+ * @property {boolean} [disableIabSecureLogging=false]
+ * When set to `true` it will disable IAB secure logging for the app.
+ *
+ * @property {string} [loadErrorMessage="There was an error loading the application."]
+ * An error message to display when the application (launched via manifest) fails to load.
+ * A dialog box will be launched with the error message just before the runtime exits.
+ * Load fails such as failed DNS resolutions or aborted connections as well as cancellations, _e.g.,_ `window.stop()`,
+ * will trigger this dialog.
+ * Client response codes such as `404 Not Found` are not treated as fails as they are valid server responses.
+ *
+ * @property {Window~options} [mainWindowOptions]
+ * The options of the main window of the application.
+ * For a description of these options, click the link (in the Type column).
+ *
+ * @property {number} [maxViewPoolSize=1000]
+ * Platforms Only.  The maximum number of "detached" or "pooled" Views that can exist in the Platform before being closed.
+ * If you do not wish for views to be pooled on your platform, set this property to zero.
+ *
+ * @property {boolean} [preventQuitOnLastWindowClosed=false]
+ * Platforms Only. Prevent the Platform Provider from quitting automatically when the last Platform Window is closed.
+ * Note: if the Platform Provider is showing, it won't close automatically.
+ * If you want a hidden Platform Provider to remain open after the last Platform Window has been closed, set this property to true.
+ *
+ * @property {string} [name]
+ * The name of the application (and the application's main window).
+ *
+ * If provided, _must_ match `uuid`.
+ *
+ * @property {boolean} [nonPersistent=false]
+ * A flag to configure the application as non-persistent.
+ * Runtime exits when there are no persistent apps running.
+ *
+ * @property {boolean} [plugins=false]
+ * Enable Flash at the application level.
+ *
+ * @property {boolean} [spellCheck=false]
+ * Enable spell check at the application level.
+ *
+ * @property {string} [url="about:blank"]
+ * The url to the application (specifically the application's main window).
+ *
+ * @property {boolean} [enableJumpList=false]
+ * Enables the use of the Jumplists API and the 'pin to taskbar' functionality.
+ * Only relevant in Windows.
+ *
+ * @property {string} uuid
+ * The _Unique Universal Identifier_ (UUID) of the application, unique within the set of all other applications
+ *  running in the OpenFin Runtime.
+ *
+ * Note that `name` and `uuid` must match.
+ *
+ * @property {boolean} [webSecurity=true]
+ * When set to `false` it will disable the same-origin policy for the app.
+ */
+/**
+ * @lends Application
+ */
+export default class ApplicationModule extends Base {
+    /**
+     * Asynchronously returns an Application object that represents an existing application.
+     * @param { Identity } identity
+     * @return {Promise.<Application>}
+     * @tutorial Application.wrap
+     * @static
+     */
+    wrap(identity: OpenFin.ApplicationIdentity): Promise<OpenFin.Application>;
+    /**
+     * Synchronously returns an Application object that represents an existing application.
+     * @param { Identity } identity
+     * @return {Application}
+     * @tutorial Application.wrapSync
+     * @static
+     */
+    wrapSync(identity: OpenFin.ApplicationIdentity): OpenFin.Application;
+    private _create;
+    /**
+     * DEPRECATED method to create a new Application. Use {@link Application.start} instead.
+     * @param { ApplicationOption } appOptions
+     * @return {Promise.<Application>}
+     * @tutorial Application.create
+     * @ignore
+     */
+    create(appOptions: OpenFin.ApplicationCreationOptions): Promise<OpenFin.Application>;
+    /**
+     * Creates and starts a new Application.
+     * @param { ApplicationOption } appOptions
+     * @return {Promise.<Application>}
+     * @tutorial Application.start
+     * @static
+     */
+    start(appOptions: OpenFin.ApplicationCreationOptions): Promise<OpenFin.Application>;
+    /**
+     * 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 { Array.<ManifestInfo> } applications
+     * @return {Promise.<void>}
+     * @static
+     * @tutorial Application.startManyManifests
+     * @experimental
+     */
+    startManyManifests(applications: Array<OpenFin.ManifestInfo>): Promise<void>;
+    /**
+     * Asynchronously returns an Application object that represents the current application
+     * @return {Promise.<Application>}
+     * @tutorial Application.getCurrent
+     * @static
+     */
+    getCurrent(): Promise<OpenFin.Application>;
+    /**
+     * Synchronously returns an Application object that represents the current application
+     * @return {Application}
+     * @tutorial Application.getCurrentSync
+     * @static
+     */
+    getCurrentSync(): OpenFin.Application;
+    /**
+     * Retrieves application's manifest and returns a running instance of the application.
+     * @param {string} manifestUrl - The URL of app's manifest.
+     * @param {RvmLaunchOptions} [opts] - Parameters that the RVM will use.
+     * @return {Promise.<Application>}
+     * @tutorial Application.startFromManifest
+     * @static
+     */
+    startFromManifest(manifestUrl: string, opts?: OpenFin.RvmLaunchOptions): Promise<OpenFin.Application>;
+    createFromManifest(manifestUrl: string): Promise<OpenFin.Application>;
+    private _createFromManifest;
+}

package/src/api/application/Factory.js

@@ -0,0 +1,229 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const base_1 = require("../base");
+const validate_1 = require("../../util/validate");
+const Instance_1 = require("./Instance");
+/**
+ * @typedef {object} ApplicationOption
+ * @summary Application creation options.
+ * @desc This is the options object required by {@link Application.start Application.start}.
+ *
+ * The following options are required:
+ * * `uuid` is required in the app manifest as well as by {@link Application.start Application.start}
+ * * `name` is optional in the app manifest but required by {@link Application.start Application.start}
+ * * `url` is optional in both the app manifest {@link Application.start Application.start} and  but is usually given
+ * (defaults to `"about:blank"` when omitted).
+ *
+ * _This jsdoc typedef mirrors the `ApplicationOption` TypeScript interface in `@types/openfin`._
+ *
+ * **IMPORTANT NOTE:**
+ * This object inherits all the properties of the window creation {@link Window~options options} object,
+ * which will take priority over those of the same name that may be provided in `mainWindowOptions`.
+ *
+ * @property {boolean} [disableIabSecureLogging=false]
+ * When set to `true` it will disable IAB secure logging for the app.
+ *
+ * @property {string} [loadErrorMessage="There was an error loading the application."]
+ * An error message to display when the application (launched via manifest) fails to load.
+ * A dialog box will be launched with the error message just before the runtime exits.
+ * Load fails such as failed DNS resolutions or aborted connections as well as cancellations, _e.g.,_ `window.stop()`,
+ * will trigger this dialog.
+ * Client response codes such as `404 Not Found` are not treated as fails as they are valid server responses.
+ *
+ * @property {Window~options} [mainWindowOptions]
+ * The options of the main window of the application.
+ * For a description of these options, click the link (in the Type column).
+ *
+ * @property {number} [maxViewPoolSize=1000]
+ * Platforms Only.  The maximum number of "detached" or "pooled" Views that can exist in the Platform before being closed.
+ * If you do not wish for views to be pooled on your platform, set this property to zero.
+ *
+ * @property {boolean} [preventQuitOnLastWindowClosed=false]
+ * Platforms Only. Prevent the Platform Provider from quitting automatically when the last Platform Window is closed.
+ * Note: if the Platform Provider is showing, it won't close automatically.
+ * If you want a hidden Platform Provider to remain open after the last Platform Window has been closed, set this property to true.
+ *
+ * @property {string} [name]
+ * The name of the application (and the application's main window).
+ *
+ * If provided, _must_ match `uuid`.
+ *
+ * @property {boolean} [nonPersistent=false]
+ * A flag to configure the application as non-persistent.
+ * Runtime exits when there are no persistent apps running.
+ *
+ * @property {boolean} [plugins=false]
+ * Enable Flash at the application level.
+ *
+ * @property {boolean} [spellCheck=false]
+ * Enable spell check at the application level.
+ *
+ * @property {string} [url="about:blank"]
+ * The url to the application (specifically the application's main window).
+ *
+ * @property {boolean} [enableJumpList=false]
+ * Enables the use of the Jumplists API and the 'pin to taskbar' functionality.
+ * Only relevant in Windows.
+ *
+ * @property {string} uuid
+ * The _Unique Universal Identifier_ (UUID) of the application, unique within the set of all other applications
+ *  running in the OpenFin Runtime.
+ *
+ * Note that `name` and `uuid` must match.
+ *
+ * @property {boolean} [webSecurity=true]
+ * When set to `false` it will disable the same-origin policy for the app.
+ */
+/**
+ * @lends Application
+ */
+class ApplicationModule extends base_1.Base {
+    /**
+     * Asynchronously returns an Application object that represents an existing application.
+     * @param { Identity } identity
+     * @return {Promise.<Application>}
+     * @tutorial Application.wrap
+     * @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 = 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 } identity
+     * @return {Application}
+     * @tutorial Application.wrapSync
+     * @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 = 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.start} instead.
+     * @param { ApplicationOption } appOptions
+     * @return {Promise.<Application>}
+     * @tutorial Application.create
+     * @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 { ApplicationOption } appOptions
+     * @return {Promise.<Application>}
+     * @tutorial Application.start
+     * @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 { Array.<ManifestInfo> } applications
+     * @return {Promise.<void>}
+     * @static
+     * @tutorial Application.startManyManifests
+     * @experimental
+     */
+    async startManyManifests(applications) {
+        return this.wire.sendAction('run-applications', { applications }).then(() => undefined);
+    }
+    /**
+     * Asynchronously returns an Application object that represents the current application
+     * @return {Promise.<Application>}
+     * @tutorial Application.getCurrent
+     * @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
+     * @return {Application}
+     * @tutorial Application.getCurrentSync
+     * @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 {string} manifestUrl - The URL of app's manifest.
+     * @param {RvmLaunchOptions} [opts] - Parameters that the RVM will use.
+     * @return {Promise.<Application>}
+     * @tutorial Application.startFromManifest
+     * @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);
+        // eslint-disable-next-line @typescript-eslint/ban-ts-ignore
+        // @ts-ignore using private method without warning.
+        await app._run(opts); // eslint-disable-line no-underscore-dangle
+        return app;
+    }
+    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;