@types/openfin - npm Package Compare versions

Comparing version 43.0.0 to 43.0.1

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

@@ -23,3 +23,3 @@ import { WindowOption, CustomRequestHeaders } from '../window/windowOption';
     cornerRounding?: object;
-    customData?: string;
+    customData?: any;
     customRequestHeaders?: Array<CustomRequestHeaders>;
@@ -26,0 +26,0 @@ defaultCentered?: boolean;

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

@@ -1,2 +0,1 @@
-import { Identity } from '../../identity';
 import { FrameEvent } from './frame';
@@ -14,4 +13,2 @@ export declare type RuntimeEvent<Topic = string, Type = string> = Topic extends 'window' ? WindowEvent<Topic, Type> : Topic extends 'frame' ? FrameEvent<Type> : Topic extends 'application' ? ApplicationEvent<Topic, Type> : Topic extends 'external-window' ? ApplicationEvent<Topic, Type> : BaseEvent<Topic, Type>;
 }
-export interface ExternalWindowEvent<Topic, Type> extends BaseEvent<Topic, Type>, Identity {
-}
 export declare function getTopic(e: RuntimeEvent<any>): string;
@@ -18,0 +15,0 @@ export interface BaseEventMap {

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

@@ -1,24 +0,7 @@
-import { ExternalWindowEvent, BaseEventMap } from './base';
-export interface ExternalWindowEventMapping<Topic = string, Type = string> extends BaseEventMap {
-    'begin-user-bounds-changing': ExternalWindowEvent<Topic, Type>;
-    'blurred': ExternalWindowEvent<Topic, Type>;
-    'bounds-changed': ExternalWindowEvent<Topic, Type>;
-    'bounds-changing': ExternalWindowEvent<Topic, Type>;
-    'closed': ExternalWindowEvent<Topic, Type>;
-    'closing': ExternalWindowEvent<Topic, Type>;
-    'disabled-movement-bounds-changed': ExternalWindowEvent<Topic, Type>;
-    'disabled-movement-bounds-changing': ExternalWindowEvent<Topic, Type>;
-    'end-user-bounds-changing': ExternalWindowEvent<Topic, Type>;
-    'focused': ExternalWindowEvent<Topic, Type>;
-    'group-changed': ExternalWindowEvent<Topic, Type>;
-    'hidden': ExternalWindowEvent<Topic, Type>;
-    'maximized': ExternalWindowEvent<Topic, Type>;
-    'minimized': ExternalWindowEvent<Topic, Type>;
-    'restored': ExternalWindowEvent<Topic, Type>;
-    'shown': ExternalWindowEvent<Topic, Type>;
-    'user-movement-disabled': ExternalWindowEvent<Topic, Type>;
-    'user-movement-enabled': ExternalWindowEvent<Topic, Type>;
-}
+import { BaseEventMap } from './base';
+import { WindowEventMapping } from './window';
+declare type ExternalWindowEventMapping<Topic = string, Type = string> = BaseEventMap & Pick<WindowEventMapping, 'begin-user-bounds-changing' | 'blurred' | 'bounds-changed' | 'bounds-changing' | 'closed' | 'closing' | 'disabled-movement-bounds-changed' | 'disabled-movement-bounds-changing' | 'end-user-bounds-changing' | 'focused' | 'group-changed' | 'hidden' | 'maximized' | 'minimized' | 'restored' | 'shown' | 'user-movement-disabled' | 'user-movement-enabled'>;
 export declare type ExternalWindowEvents = {
     [Type in keyof ExternalWindowEventMapping]: ExternalWindowEventMapping<'external-window', Type>[Type];
 };
+export {};

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

@@ -86,2 +86,9 @@ import { CrashedEvent } from './application';
 }
+export interface WindowEndBoundsChangingEvent<Topic, Type> extends WindowEvent<Topic, Type> {
+    height: number;
+    left: number;
+    top: number;
+    width: number;
+    windowState: 'minimized' | 'normal' | 'maximized';
+}
 export interface WindowBoundsChange<Topic, Type> extends WindowEvent<Topic, Type> {
@@ -124,3 +131,3 @@ changeType: 0 | 1 | 2;
     'embedded': WindowEvent<Topic, Type>;
-    'end-user-bounds-changing': WindowBeginBoundsChangingEvent<Topic, Type>;
+    'end-user-bounds-changing': WindowEndBoundsChangingEvent<Topic, Type>;
     'external-process-exited': WindowExternalProcessExitedEvent<Topic, Type>;
@@ -127,0 +134,0 @@ 'external-process-started': WindowExternalProcessStartedEvent<Topic, Type>;

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

@@ -18,2 +18,3 @@ import { _Window } from '../window/window';
      * @experimental
+     * @tutorial Window.wrap
      */
@@ -32,2 +33,3 @@ wrap(identity: Identity): Promise<ExternalWindow>;
      * @experimental
+     * @tutorial Window.wrapSync
      */
@@ -37,6 +39,12 @@ wrapSync(identity: Identity): ExternalWindow;
 /**
- * @classdesc An ExternalWindow object representing an adopted native window
- * on the system. Allows the developer to call actions on external windows as
- * well as listen to external window events.
+ * @classdesc An ExternalWindow is an OpenFin object representing a window that belongs to a non-openfin application.<br>
+ * While External Windows don't have the complete functionality of an OpenFin Window object,
+ * they can be used to tap into any application that is currently running in the OS.<br>
+ * External Windows are useful for grouping, moving and resizing non-openfin applications
+ * as well as listening to events that are dispatched by these applications.<br>
+ * They are also compatible with OpenFin's Layouts service to facilitate
+ * a complete positional control over all running applications.<br>
+ * External Windows has the ability to listen for <a href="tutorial-ExternalWindow.EventEmitter.html"> external window specific events</a>.
  * @class
+ * @alias ExternalWindow
  * @hideconstructor
@@ -51,2 +59,3 @@ */
      * @experimental
+     * @tutorial Window.bringToFront
      */
@@ -58,2 +67,3 @@ bringToFront(): Promise<void>;
      * @experimental
+     * @tutorial Window.close
     */
@@ -66,2 +76,3 @@ close(): Promise<void>;
      * @experimental
+     * @tutorial Window.disableUserMovement
      */
@@ -74,2 +85,3 @@ disableUserMovement(): Promise<void>;
      * @experimental
+     * @tutorial Window.enableUserMovement
      */
@@ -81,2 +93,3 @@ enableUserMovement(): Promise<void>;
      * @experimental
+     * @tutorial Window.flash
      */
@@ -89,2 +102,3 @@ flash(): Promise<void>;
      * @experimental
+     * @tutorial Window.focus
      */
@@ -96,2 +110,3 @@ focus(): Promise<void>;
      * @experimental
+     * @tutorial Window.getBounds
     */
@@ -105,2 +120,3 @@ getBounds(): Promise<Bounds>;
      * @experimental
+     * @tutorial Window.getGroup
      */
@@ -112,2 +128,3 @@ getGroup(): Promise<Array<ExternalWindow | _Window>>;
      * @experimental
+     * @tutorial Window.getInfo
      */
@@ -119,2 +136,3 @@ getInfo(): Promise<any>;
      * @experimental
+     * @tutorial Window.getOptions
      */
@@ -127,2 +145,3 @@ getOptions(): Promise<any>;
      * @experimental
+     * @tutorial Window.getState
      */
@@ -134,2 +153,3 @@ getState(): Promise<string>;
      * @experimental
+     * @tutorial Window.hide
      */
@@ -141,2 +161,3 @@ hide(): Promise<void>;
      * @experimental
+     * @tutorial Window.isShowing
      */
@@ -149,2 +170,3 @@ isShowing(): Promise<boolean>;
      * @experimental
+     * @tutorial Window.joinGroup
      */
@@ -157,2 +179,3 @@ joinGroup(target: ExternalWindow | _Window): Promise<void>;
      * @experimental
+     * @tutorial Window.leaveGroup
      */
@@ -164,2 +187,3 @@ leaveGroup(): Promise<void>;
      * @experimental
+     * @tutorial Window.maximize
      */
@@ -172,2 +196,3 @@ maximize(): Promise<void>;
      * @experimental
+     * @tutorial Window.mergeGroups
      */
@@ -179,2 +204,3 @@ mergeGroups(target: ExternalWindow | _Window): Promise<void>;
      * @experimental
+     * @tutorial Window.minimize
      */
@@ -188,2 +214,3 @@ minimize(): Promise<void>;
      * @experimental
+     * @tutorial Window.moveBy
      */
@@ -197,2 +224,3 @@ moveBy(deltaLeft: number, deltaTop: number): Promise<void>;
      * @experimental
+     * @tutorial Window.moveTo
      */
@@ -209,2 +237,3 @@ moveTo(left: number, top: number): Promise<void>;
      * @experimental
+     * @tutorial Window.resizeBy
      */
@@ -221,2 +250,3 @@ resizeBy(deltaWidth: number, deltaHeight: number, anchor: AnchorType): Promise<void>;
      * @experimental
+     * @tutorial Window.resizeTo
      */
@@ -228,2 +258,3 @@ resizeTo(width: number, height: number, anchor: AnchorType): Promise<void>;
      * @experimental
+     * @tutorial Window.restore
      */
@@ -236,2 +267,3 @@ restore(): Promise<void>;
      * @experimental
+     * @tutorial Window.setAsForeground
      */
@@ -244,2 +276,3 @@ setAsForeground(): Promise<void>;
      * @experimental
+     * @tutorial Window.setBounds
      */
@@ -251,2 +284,3 @@ setBounds(bounds: Bounds): Promise<void>;
      * @experimental
+     * @tutorial Window.show
      */
@@ -262,2 +296,3 @@ show(): Promise<void>;
      * @experimental
+     * @tutorial Window.showAt
      */
@@ -269,2 +304,3 @@ showAt(left: number, top: number): Promise<void>;
      * @experimental
+     * @tutorial Window.stopFlashing
      */
@@ -277,4 +313,5 @@ stopFlashing(): Promise<void>;
      * @experimental
+     * @tutorial Window.updateOptions
      */
     updateOptions(options: any): Promise<void>;
 }

openfin/_v2/api/fin.d.ts

@@ -15,2 +15,3 @@ /// <reference types="node" />
 import { Identity } from '../identity';
+import { BrowserViewModule } from './browserview/browserview';
 export default class Fin extends EventEmitter {
@@ -28,4 +29,5 @@ private wire;
     GlobalHotkey: GlobalHotkey;
+    BrowserView: BrowserViewModule;
     readonly me: Identity;
     constructor(wire: Transport);
 }

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

@@ -6,3 +6,3 @@ import { Base } from '../base';
 import { WindowEvents } from '../events/window';
-import { AnchorType, Transition, TransitionOptions, Bounds } from '../../shapes';
+import { AnchorType, Bounds, Transition, TransitionOptions } from '../../shapes';
 import { WindowOption } from './windowOption';
@@ -185,3 +185,3 @@ import { EntityType } from '../frame/frame';
  *
- * @property {string} [customData=""] - _Updatable._
+ * @property {any} [customData=""] - _Updatable._
  * A field that the user can attach serializable data to to be ferried around with the window options.
@@ -800,4 +800,4 @@ * _When omitted, the default value of this property is the empty string (`""`)._
      * Provides credentials to authentication requests
-     * @param { string } userName userName to provide to the authentication challange
-     * @param { string } password password to provide to the authentication challange
+     * @param { string } userName userName to provide to the authentication challenge
+     * @param { string } password password to provide to the authentication challenge
      * @return {Promise.<void>}
@@ -804,0 +804,0 @@ * @tutorial Window.authenticate

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

@@ -16,3 +16,3 @@ import { DownloadPreloadOption } from '../system/download-preload';
     cornerRounding?: object;
-    customData?: string;
+    customData?: any;
     customRequestHeaders?: Array<CustomRequestHeaders>;
@@ -19,0 +19,0 @@ defaultCentered?: boolean;

openfin/_v2/shapes.d.ts

@@ -34,3 +34,3 @@ export declare type AnchorType = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
 }
-export declare interface RGB {
+export interface RGB {
     red: number;
@@ -40,3 +40,3 @@ blue: number;
 }
-export declare interface ContextMenuSettings {
+export interface ContextMenuSettings {
     enable?: boolean;
@@ -43,0 +43,0 @@ devtools?: boolean;

openfin/package.json

 {
     "name": "@types/openfin",
-    "version": "43.0.0",
+    "version": "43.0.1",
     "description": "TypeScript definitions for OpenFin API",
@@ -45,4 +45,4 @@ "license": "MIT",
     },
-    "typesPublisherContentHash": "18d375f3ad0174de3c32423a326bc284a21ca50e1cc4c8ebf6d756117350bf13",
+    "typesPublisherContentHash": "8f3290952337b37e0d2554299a6f82bac67c4a46b409e6e3a6024b4f8f9f0bb9",
     "typeScriptVersion": "2.9"
 }

openfin/README.md

@@ -11,3 +11,3 @@ # Installation
 Additional Details
- * Last updated: Thu, 27 Jun 2019 23:54:45 GMT
+ * Last updated: Thu, 11 Jul 2019 22:51:57 GMT
  * Dependencies: @types/node, @types/ws
@@ -14,0 +14,0 @@ * Global values: fin

No alert changes

Improved metrics

Total package byte prevSize

240424

1.03%

Number of package files

77

1.32%

Lines of code

5777

1.21%

No dependency changes