@types/openfin - npm Package Compare versions

Comparing version 39.0.1 to 41.0.0

openfin/_v2/api/application/application.d.ts

@@ -41,13 +41,13 @@ import { EmitterBase, Base, Reply } from '../base';
 /**
- * @typedef {object} Application~options
+ * @typedef {object} ApplicationOption
  * @summary Application creation options.
- * @desc This is the options object required by {@link Application.create Application.create}.
+ * @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.create Application.create}
- * * `name` is optional in the app manifest but required by {@link Application.create Application.create}
- * * `url` is optional in both the app manifest {@link Application.create Application.create} and  but is usually given
+ * * `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 `ApplicationOptions` TypeScript interface in `@types/openfin`._
+ * _This jsdoc typedef mirrors the `ApplicationOption` TypeScript interface in `@types/openfin`._
  *
@@ -120,2 +120,9 @@ * **IMPORTANT NOTE:**
     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: ApplicationOption): Promise<Application>;
@@ -153,2 +160,3 @@ /**
     createFromManifest(manifestUrl: string): Promise<Application>;
+    private _createFromManifest;
 }
@@ -326,3 +334,11 @@ /**
     restart(): Promise<void>;
+    /**
+     * DEPRECATED method to run the application.
+     * Needed when starting application via {@link Application.create}, but NOT needed when starting via {@link Application.start}.
+     * @return {Promise.<void>}
+     * @tutorial Application.run
+     * @ignore
+     */
     run(): Promise<void>;
+    private _run;
     /**
@@ -349,3 +365,3 @@ * Instructs the RVM to schedule one restart of the application.
     /**
-     * Sets new application's shortcut configuration.
+     * Sets new application's shortcut configuration. Windows only.
      * @param { ShortCutConfig } config New application's shortcut configuration.
@@ -352,0 +368,0 @@ * @param { boolean } [config.desktop] - Enable/disable desktop shortcut.

openfin/_v2/api/events/window.d.ts

 import { CrashedEvent } from './application';
 import { WindowEvent, BaseEventMap } from './base';
+import { WindowOptionDiff } from '../window/windowOption';
 export declare type SpecificWindowEvent<Type> = WindowEvent<'window', Type>;
@@ -28,2 +29,5 @@ export interface WindowAlertRequestedEvent<Topic, Type> extends WindowEvent<Topic, Type> {
 }
+export interface WindowOptionsChangedEvent<Topic, Type> extends WindowEvent<Topic, Type> {
+    diff: WindowOptionDiff;
+}
 export interface WindowExternalProcessExitedEvent<Topic, Type> extends WindowEvent<Topic, Type> {
@@ -130,2 +134,3 @@ processUuid: string;
     'navigation-rejected': WindowNavigationRejectedEvent<Topic, Type>;
+    'options-changed': WindowOptionsChangedEvent<Topic, Type>;
     'preload-scripts-state-changed': WindowPreloadScriptsStateChangeEvent<Topic, Type>;
@@ -163,2 +168,3 @@ 'preload-scripts-state-changing': WindowPreloadScriptsStateChangeEvent<Topic, Type>;
     'window-navigation-rejected': WindowNavigationRejectedEvent<Topic, Type>;
+    'window-options-changed': WindowOptionsChangedEvent<Topic, Type>;
     'window-preload-scripts-state-changed': WindowPreloadScriptsStateChangeEvent<Topic, Type>;
@@ -165,0 +171,0 @@ 'window-preload-scripts-state-changing': WindowPreloadScriptsStateChangedEvent<Topic, Type>;

openfin/_v2/api/interappbus/interappbus.d.ts

@@ -35,3 +35,3 @@ /// <reference types="node" />
      * Sends a message to a specific application on a specific topic.
-     * @param { Identity } destination The uuid of the application to which the message is sent
+     * @param { Identity } destination The identity of the application to which the message is sent
      * @param { string } topic The topic on which the message is sent
@@ -38,0 +38,0 @@ * @param { any } message The message to be sent. Can be either a primitive data

openfin/_v2/api/window/window.d.ts

@@ -260,3 +260,3 @@ import { Base, EmitterBase } from '../base';
  * Specify a taskbar group for the window.
- * _If omitted, defaults to app's uuid (`fin.desktop.Application.getCurrent().uuid`)._
+ * _If omitted, defaults to app's uuid (`fin.Application.getCurrentSync().identity.uuid`)._
  *
@@ -427,3 +427,3 @@ * @property {string} [url="about:blank"]
     /**
-     * Gets the current bounds (top, left, width, height) of the window.
+     * Gets the current bounds (top, bottom, right, left, width, height) of the window.
      * @return {Promise.<Bounds>}
@@ -504,3 +504,3 @@ * @tutorial Window.getBounds
     /**
-     * Flashes the window’s frame and taskbar icon until stopFlashing is called.
+     * Flashes the window’s frame and taskbar icon until stopFlashing is called or until a focus event is fired.
      * @return {Promise.<void>}
@@ -517,4 +517,4 @@ * @tutorial Window.flash
     /**
-     * Retrieves an array containing wrapped fin.desktop.Windows that are grouped with this
-     * window. If a window is not in a group an empty array is returned. Please note that
+     * Retrieves an array containing wrapped fin.Windows that are grouped with this window.
+     * If a window is not in a group an empty array is returned. Please note that
      * calling window is included in the result array.
@@ -564,2 +564,8 @@ * @return {Promise.<Array<_Window>>}
     /**
+     * Gets the [Window Object](https://developer.mozilla.org/en-US/docs/Web/API/Window) previously getNativeWindow
+     * @return {object}
+     * @tutorial Window.getWebWindow
+     */
+    getWebWindow(): Window;
+    /**
      * Determines if the window is a main window.
@@ -698,3 +704,4 @@ * @return {boolean}
     /**
-     * Updates the window using the passed options
+     * Updates the window using the passed options.
+     * Values that are objects are deep-merged, overwriting only the values that are provided.
      * @param {*} options Changes a window's options that were defined upon creation. See tutorial
@@ -727,3 +734,3 @@ * @return {Promise.<void>}
     /**
-     * Navigates the window to a specified URL.
+     * Navigates the window to a specified URL. The url must contain the protocol prefix such as http:// or https://.
      * @param {string} url - The URL to navigate the window to.
@@ -730,0 +737,0 @@ * @return {Promise.<void>}

openfin/_v2/api/window/windowOption.d.ts

@@ -47,1 +47,7 @@ import { DownloadPreloadOption } from '../system/download-preload';
 }
+export declare type WindowOptionDiff = {
+    [key in keyof WindowOption]: {
+        oldVal: WindowOption[key];
+        newVal: WindowOption[key];
+    };
+};

openfin/_v2/environment/environment.d.ts

 import { NewConnectConfig } from '../transport/wire';
+import { Identity } from '../identity';
 export interface Environment {
@@ -9,3 +10,4 @@ writeToken(path: string, token: string): Promise<string>;
     isWindowExists(uuid: string, name: string): boolean;
+    getWebWindow(identity: Identity): Window;
 }
 export declare const notImplementedEnvErrorMsg = "Not implemented in this environment";

openfin/_v2/environment/node-env.d.ts

 import { Environment } from './environment';
 import { NewConnectConfig } from '../transport/wire';
+import { Identity } from '../identity';
 export default class NodeEnvironment implements Environment {
@@ -11,2 +12,3 @@ private messageCounter;
     isWindowExists: (uuid: string, name: string) => boolean;
+    getWebWindow: (identity: Identity) => Window;
 }

openfin/_v2/environment/openfin-env.d.ts

 import { Environment } from './environment';
 import { NewConnectConfig } from '../transport/wire';
+import { Identity } from '../identity';
 export default class OpenFinEnvironment implements Environment {
@@ -11,2 +12,3 @@ writeToken: (path: string, token: string) => Promise<string>;
     isWindowExists: (uuid: string, name: string) => boolean;
+    getWebWindow: (identity: Identity) => Window;
 }

openfin/_v2/launcher/util.d.ts

 export declare function exists(path: string): Promise<Boolean>;
-export declare function get(url: string): Promise<any>;
 export declare function unzip(file: string, dest: string): Promise<any>;
 export declare function rmDir(dirPath: string, removeSelf?: boolean): Promise<void>;
-export declare function downloadFile(url: string, writeLocation: string): Promise<{}>;
 export declare function resolveRuntimeVersion(versionOrChannel: string): Promise<string>;
 export declare function first<T>(arr: T[], func: (x: T, i: number, r: T[]) => boolean): T | null;
 export declare function resolveDir(base: string, paths: string[]): Promise<string>;

openfin/_v2/launcher/win-launch.d.ts

 /// <reference types="node" />
 import { ChildProcess } from 'child_process';
 import { ConfigWithRuntime } from '../transport/wire';
-export default function launch(config: ConfigWithRuntime, manifestLocation: string, namedPipeName: string, Installer_Work_Dir: string): Promise<ChildProcess>;
+export default function launch(config: ConfigWithRuntime, manifestLocation: string, namedPipeName: string): Promise<ChildProcess>;

openfin/_v2/transport/wire.d.ts

@@ -20,2 +20,6 @@ /// <reference types="node" />
 }
+export interface ServiceConfig {
+    name: string;
+    manifestUrl: string;
+}
 export interface BaseConfig {
@@ -36,2 +40,3 @@ uuid?: string;
     runtime?: RuntimeConfig;
+    services?: ServiceConfig[];
     appAssets?: [{
@@ -38,0 +43,0 @@ src: string;

openfin/index.d.ts

@@ -1,2 +0,2 @@
-// Type definitions for non-npm package OpenFin API 39.0
+// Type definitions for non-npm package OpenFin API 41.0
 // Project: https://openfin.co/
@@ -10,3 +10,3 @@ // Definitions by: Chris Barker <https://github.com/chrisbarker>
 
-// based on v10.66.39.25
+// based on v10.66.41.11
 // see https://openfin.co/support/technical-faq/#what-do-the-numbers-in-the-runtime-version-mean
@@ -13,0 +13,0 @@

openfin/package.json

 {
     "name": "@types/openfin",
-    "version": "39.0.1",
-    "description": "TypeScript definitions for non-npm package OpenFin API",
+    "version": "41.0.0",
+    "description": "TypeScript definitions for OpenFin API",
     "license": "MIT",
@@ -32,3 +32,4 @@ "contributors": [
         "type": "git",
-        "url": "https://github.com/DefinitelyTyped/DefinitelyTyped.git"
+        "url": "https://github.com/DefinitelyTyped/DefinitelyTyped.git",
+        "directory": "types/openfin"
     },
@@ -40,4 +41,4 @@ "scripts": {},
     },
-    "typesPublisherContentHash": "83c312e10b4a4cfbf40b04967ebd71a20280b30ee91ab0e2b7c12cb5b06740ce",
+    "typesPublisherContentHash": "e2e4256ce371df65a8c9410d63eb0956f6b5ac725239c4f8dd465d025d1b2e6a",
     "typeScriptVersion": "2.9"
 }

openfin/README.md

@@ -5,3 +5,3 @@ # Installation
 # Summary
-This package contains type definitions for non-npm package OpenFin API ( https://openfin.co/ ).
+This package contains type definitions for OpenFin API ( https://openfin.co/ ).
 
@@ -12,3 +12,3 @@ # Details
 Additional Details
- * Last updated: Thu, 14 Feb 2019 16:52:09 GMT
+ * Last updated: Thu, 09 May 2019 00:42:18 GMT
  * Dependencies: @types/node, @types/ws
@@ -15,0 +15,0 @@ * Global values: fin

No alert changes

Improved metrics

Total package byte prevSize

210789

0.81%

Lines of code

5009

0.89%

No dependency changes