@openfin/core 33.76.31 → 33.76.36

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/core",
-    "version": "33.76.31",
+    "version": "33.76.36",
     "license": "SEE LICENSE IN LICENSE.MD",
     "main": "./src/mock.js",
     "types": "./src/mock.d.ts",

package/src/OpenFin.d.ts

@@ -23,13 +23,19 @@ export type { PlatformProvider };
 export type ApplicationIdentity = {
     uuid: string;
 };
+/**
+ * Unique identifier for a window, view or iframe.
+ *
+ * @remarks The `uuid` property refers the application that owns the entity, not to the entity itself.
+ * The `name` property identifies the entity itself, and must be unique within the application.
+ */
 export type Identity = {
     /**
-     * Universally unique identifier of the compenent
+     * Universally unique identifier of the application that owns the component.
      */
     uuid: string;
     /**
-     * The name of the component
+     * The name of the component.  Must be unique within the owning application.
      */
     name: string;
 };
@@ -81,6 +87,8 @@ export type WindowBounds = Bounds & {
 };
 /**
  * A rectangular area on the screen.
+ *
+ * @remarks Origin is top-left.  All numbers are in pixels.
  */
 export type Rectangle = {
     /**
@@ -101,18 +109,18 @@ export type Rectangle = {
     height: number;
 };
 /**
- * The options object required by {@link Application.start Application.start}.
+ * The options object required by {@link Application.ApplicationModule.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
+ * * `uuid` is required in the app manifest as well as by {@link Application.ApplicationModule.start Application.start}
+ * * `name` is optional in the app manifest but required by {@link Application.ApplicationModule.start Application.start}
+ * * `url` is optional in both the app manifest {@link Application.ApplicationModule.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,
+ * This object inherits all the properties of the window creation {@link OpenFin.WindowCreationOptions options} object,
  * which will take priority over those of the same name that may be provided in `mainWindowOptions`.
  */
 export type ApplicationCreationOptions = Partial<ApplicationOptions> & {
@@ -222,7 +230,7 @@ export type InteropBrokerOptions = {
 };
 export type ContextGroupInfo = {
     /**
-     * Name of the context group.
+     * Unique identifier of the context group.
      */
     id: string;
     /**
@@ -381,7 +389,7 @@ export type TaskBar = DipScaleRects & {
     rect: RectangleByEdgePositions;
 };
 /**
- * Options required to create a new window with {@link Window.create Window.create}.
+ * Options required to create a new window with {@link Window._WindowModule.create Window.create}.
  *
  * Note that `name` is the only required property — albeit the `url` property is usually provided as well
  * (defaults to `"about:blank"` when omitted).
@@ -598,7 +606,7 @@ export type ConstWindowOptions = {
      */
     state: WindowState;
     /**
-     * @Deprecated - use `icon` instead.
+     * @deprecated - use `icon` instead.
      */
     taskbarIcon: string;
     /**
@@ -617,7 +625,7 @@ export type ConstWindowOptions = {
      *
      * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
      * If omitted, defaults to the `uuid` of the application spawning the window.
-     * If given, must match the `uuid` of the  application spawning the window.
+     * If given, must match the `uuid` of the application spawning the window.
      * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
      * really no need to provide it.
      */
@@ -1116,7 +1124,7 @@ export type ViewInfo = {
  */
 export type UpdatableViewOptions = Partial<MutableViewOptions>;
 /**
- * The options object required by {@link View.create View.create}.
+ * The options object required by {@link View.ViewModule.create View.create}.
  *
  * Note that `name` and `target` are the only required properties — albeit the `url` property is usually provided as well
  * (defaults to `"about:blank"` when omitted).
@@ -1486,7 +1494,7 @@ export type PlatformWindowCreationOptions = Partial<WindowCreationOptions> & {
 };
 /**
  * Window options apply to all platform windows.
- * Any {@link Window~options Window option} is also a valid Default Window option
+ * Any {@link OpenFin.WindowCreationOptions 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.
  */
@@ -1507,7 +1515,7 @@ export type PlatformViewCreationOptions = Partial<ViewOptions>;
  */
 export type ProcessAffinityStrategy = 'same' | 'different';
 /**
- * The options object required by {@link Platform#start Platform.start}
+ * The options object required by {@link Platform.PlatformModule#start Platform.start}
  * Any {@link ApplicationOptions Application option} is also a valid platform option
  */
 export type PlatformOptions = ApplicationCreationOptions & {
@@ -1587,7 +1595,7 @@ export type LayoutContent = Array<LayoutItemConfig | LayoutRow | LayoutColumn |
 /**
  * Represents the arrangement of Views within a Platform window's Layout.  We do not recommend trying
  * to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot} or our
- * {@link https://openfin.github.io/golden-prototype/config-gen Layout Config Generation Tool }..
+ * {@link https://openfin.github.io/golden-prototype/config-gen Layout Config Generation Tool }.
  */
 export type LayoutItemConfig = {
     /**
@@ -2121,6 +2129,9 @@ export type AppVersionRuntimeInfo = {
     healthCheck: boolean | null;
     error: string | null;
 };
+/**
+ * The LaunchEmitter is an `EventEmitter`. It can listen to app version resolver events.
+ */
 export type LaunchEmitter = TypedEventEmitter<AppVersionEvent>;
 export type RvmLaunchOptions = {
     /**
@@ -2568,7 +2579,7 @@ export type DefaultDomainSettingsRule = {
         downloadSettings: FileDownloadSettings;
     };
 };
-export type FileDownloadBehaviorNames = 'prompt' | 'no-prompt' | 'block';
+export type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
 export type FileDownloadSettings = {
     rules: DownloadRule[];
 };

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

@@ -1,148 +1,196 @@
 import type * as OpenFin from '../../OpenFin';
 import { Base } from '../base';
-/**
- * @PORTED
- * @typedef {object} ApplicationOptions
- * @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
+     * @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
      */
     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
+     * @param identity
+     *
+     * @example
+     *
+     * ```js
+     * const app = fin.Application.wrapSync({ uuid: 'testapp' });
+     * await app.close();
+     * ```
+     *
      * @static
      */
     wrapSync(identity: OpenFin.ApplicationIdentity): OpenFin.Application;
     private _create;
     /**
-     * DEPRECATED method to create a new Application. Use {@link Application.start} instead.
-     * @param { ApplicationOptions } appOptions
-     * @return {Promise.<Application>}
-     * @tutorial Application.create
+     * 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: OpenFin.ApplicationCreationOptions): Promise<OpenFin.Application>;
     /**
      * Creates and starts a new Application.
-     * @param { ApplicationOptions } appOptions
-     * @return {Promise.<Application>}
-     * @tutorial Application.start
+     * @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
      */
     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
-     * @param {RvmLaunchOptions} [opts] - Parameters that the RVM will use.
-     * @return {Promise.<void>}
+     * @param applications
+     * @param opts - Parameters that the RVM will use.
+     *
      * @static
-     * @tutorial Application.startManyManifests
+     * @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
      */
     startManyManifests(applications: Array<OpenFin.ManifestInfo>, opts?: OpenFin.RvmLaunchOptions): Promise<void>;
     /**
      * Asynchronously returns an Application object that represents the current application
-     * @return {Promise.<Application>}
-     * @tutorial Application.getCurrent
+     *
+     * @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(): Promise<OpenFin.Application>;
     /**
      * Synchronously returns an Application object that represents the current application
-     * @return {Application}
-     * @tutorial Application.getCurrentSync
+     *
+     * @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(): 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
+     * @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
      */
     startFromManifest(manifestUrl: string, opts?: OpenFin.RvmLaunchOptions): Promise<OpenFin.Application>;
+    /**
+     * @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: string): Promise<OpenFin.Application>;
     private _createFromManifest;
 }