@openfin/core 34.78.7 → 34.78.9

package/out/mock.js

@@ -893,6 +893,9 @@ function requireFactory$3 () {
 	const base_1 = base;
 	const validate_1 = validate;
 	const index_1 = requireView();
+	/**
+	 * Static namespace for OpenFin API methods that interact with the {@link View} class, available under `fin.View`.
+	 */
 	class ViewModule extends base_1.Base {
 	    /**
 	     * Creates a new View.
@@ -4378,6 +4381,9 @@ function requireFactory$2 () {
 	const base_1 = base;
 	const validate_1 = validate;
 	const Instance_1 = requireInstance$1();
+	/**
+	 * Static namespace for OpenFin API methods that interact with the {@link Application} class, available under `fin.Application`.
+	 */
 	class ApplicationModule extends base_1.Base {
 	    /**
 	     * Asynchronously returns an Application object that represents an existing application.
@@ -6004,11 +6010,12 @@ function requireInstance () {
 	     * moveBy(580, 300).then(() => console.log('Moved')).catch(err => console.log(err));
 	     * ```
 	     */
-	    moveBy(deltaLeft, deltaTop) {
+	    moveBy(deltaLeft, deltaTop, positioningOptions) {
 	        return this.wire
 	            .sendAction('move-window-by', {
 	            deltaLeft,
 	            deltaTop,
+	            positioningOptions,
 	            ...this.identity
 	        })
 	            .then(() => undefined);
@@ -6038,11 +6045,12 @@ function requireInstance () {
 	     * moveTo(580, 300).then(() => console.log('Moved')).catch(err => console.log(err))
 	     * ```
 	     */
-	    moveTo(left, top) {
+	    moveTo(left, top, positioningOptions) {
 	        return this.wire
 	            .sendAction('move-window', {
 	            left,
 	            top,
+	            positioningOptions,
 	            ...this.identity
 	        })
 	            .then(() => undefined);
@@ -6075,12 +6083,13 @@ function requireInstance () {
 	     * resizeBy(580, 300, 'top-right').then(() => console.log('Resized')).catch(err => console.log(err));
 	     * ```
 	     */
-	    resizeBy(deltaWidth, deltaHeight, anchor) {
+	    resizeBy(deltaWidth, deltaHeight, anchor, positioningOptions) {
 	        return this.wire
 	            .sendAction('resize-window-by', {
 	            deltaWidth: Math.floor(deltaWidth),
 	            deltaHeight: Math.floor(deltaHeight),
 	            anchor,
+	            positioningOptions,
 	            ...this.identity
 	        })
 	            .then(() => undefined);
@@ -6113,12 +6122,13 @@ function requireInstance () {
 	     * resizeTo(580, 300, 'top-left').then(() => console.log('Resized')).catch(err => console.log(err));
 	     * ```
 	     */
-	    resizeTo(width, height, anchor) {
+	    resizeTo(width, height, anchor, positioningOptions) {
 	        return this.wire
 	            .sendAction('resize-window', {
 	            width: Math.floor(width),
 	            height: Math.floor(height),
 	            anchor,
+	            positioningOptions,
 	            ...this.identity
 	        })
 	            .then(() => undefined);
@@ -6177,7 +6187,6 @@ function requireInstance () {
 	    }
 	    /**
 	     * Sets the window's size and position.
-	     * @property { Bounds } bounds This is a * @type {string} name - name of the window.object that holds the propertys of
 	     *
 	     * @example
 	     * ```js
@@ -6204,8 +6213,10 @@ function requireInstance () {
 	     * }).then(() => console.log('Bounds set to window')).catch(err => console.log(err));
 	     * ```
 	     */
-	    setBounds(bounds) {
-	        return this.wire.sendAction('set-window-bounds', { ...bounds, ...this.identity }).then(() => undefined);
+	    setBounds(bounds, positioningOptions) {
+	        return this.wire
+	            .sendAction('set-window-bounds', { ...bounds, ...this.identity, positioningOptions })
+	            .then(() => undefined);
 	    }
 	    /**
 	     * Shows the window if it is hidden.
@@ -6547,6 +6558,9 @@ function requireFactory$1 () {
 	const base_1 = base;
 	const validate_1 = validate;
 	const Instance_1 = requireInstance();
+	/**
+	 * Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
+	 */
 	class _WindowModule extends base_1.Base {
 	    /**
 	     * Asynchronously returns a Window object that represents an existing window.
@@ -8986,17 +9000,17 @@ const channelClientsByEndpointId = new Map();
  * provider via {@link ChannelClient#dispatch dispatch} and to listen for communication
  * from the provider by registering an action via {@link ChannelClient#register register}.
  *
- * Synchronous Methods:
+ * ### Synchronous Methods:
  *  * {@link ChannelClient#onDisconnection onDisconnection(listener)}
  *  * {@link ChannelClient#register register(action, listener)}
  *  * {@link ChannelClient#remove remove(action)}
  *
- * Asynchronous Methods:
+ * ### Asynchronous Methods:
  *  * {@link ChannelClient#disconnect disconnect()}
  *  * {@link ChannelClient#dispatch dispatch(action, payload)}
  *
- * Middleware:
- * <br>Middleware functions receive the following arguments: (action, payload, senderId).
+ * ### Middleware:
+ * Middleware functions receive the following arguments: (action, payload, senderId).
  * The return value of the middleware function will be passed on as the payload from beforeAction, to the action listener, to afterAction
  * unless it is undefined, in which case the original payload is used.  Middleware can be used for side effects.
  *  * {@link ChannelClient#setDefaultAction setDefaultAction(middleware)}
@@ -9686,20 +9700,20 @@ const runtimeVersioning_1 = runtimeVersioning;
  * a single client via {@link ChannelProvider#dispatch dispatch} or all clients via {@link ChannelProvider#publish publish}
  * and to listen for communication from clients by registering an action via {@link ChannelProvider#register register}.
  *
- * Synchronous Methods:
+ * ### Synchronous Methods:
  *  * {@link ChannelProvider#onConnection onConnection(listener)}
  *  * {@link ChannelProvider#onDisconnection onDisconnection(listener)}
  *  * {@link ChannelProvider#publish publish(action, payload)}
  *  * {@link ChannelProvider#register register(action, listener)}
  *  * {@link ChannelProvider#remove remove(action)}
  *
- * Asynchronous Methods:
+ * ### Asynchronous Methods:
  *  * {@link ChannelProvider#destroy destroy()}
  *  * {@link ChannelProvider#dispatch dispatch(to, action, payload)}
  *  * {@link ChannelProvider#getAllClientInfo getAllClientInfo()}
  *
- * Middleware:
- * <br>Middleware functions receive the following arguments: (action, payload, senderId).
+ * ### Middleware:
+ * Middleware functions receive the following arguments: (action, payload, senderId).
  * The return value of the middleware function will be passed on as the payload from beforeAction, to the action listener, to afterAction
  * unless it is undefined, in which case the most recently defined payload is used.  Middleware can be used for side effects.
  *  * {@link ChannelProvider#setDefaultAction setDefaultAction(middleware)}
@@ -11186,7 +11200,7 @@ const base_1$c = base;
 /**
  * An ExternalApplication object representing native language adapter connections to the runtime. Allows
  * the developer to listen to {@link OpenFin.ExternalApplicationEvents external application events}.
- * Discovery of connections is provided by <a href="tutorial-System.getAllExternalApplications.html">getAllExternalApplications.</a>
+ * Discovery of connections is provided by {@link System.System.getAllExternalApplications getAllExternalApplications}.</a>
  *
  * Processes that can be wrapped as `ExternalApplication`s include the following:
  * - Processes which have connected to an OpenFin runtime via an adapter
@@ -11300,6 +11314,9 @@ Object.defineProperty(Factory$5, "__esModule", { value: true });
 Factory$5.ExternalApplicationModule = void 0;
 const base_1$b = base;
 const Instance_1$4 = Instance$4;
+/**
+ * Static namespace for OpenFin API methods that interact with the {@link ExternalApplication} class, available under `fin.ExternalApplication`.
+ */
 class ExternalApplicationModule extends base_1$b.Base {
     /**
      * Asynchronously returns an External Application object that represents an external application.
@@ -11527,6 +11544,9 @@ Factory$4._FrameModule = void 0;
 const base_1$9 = base;
 const validate_1$2 = validate;
 const Instance_1$3 = Instance$3;
+/**
+ * Static namespace for OpenFin API methods that interact with the {@link _Frame} class, available under `fin.Frame`.
+ */
 class _FrameModule extends base_1$9.Base {
     /**
      * Asynchronously returns a reference to the specified frame. The frame does not have to exist
@@ -11612,7 +11632,7 @@ Factory$4._FrameModule = _FrameModule;
 	 * * {@link _FrameModule} contains static methods relating to the `Frame` type, accessible through `fin.Frame`.
 	 * * {@link _Frame} describes an instance of an OpenFin Frame, e.g. as returned by `fin.Frame.getCurrent`.
 	 *
-	 * These are separate code entities, and are documented separately.  In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
+	 * These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
 	 * both of these were documented on the same page.
 	 *
 	 * Underscore prefixing of OpenFin types that alias DOM entities will be fixed in a future version.
@@ -12655,6 +12675,138 @@ const base_1$6 = base;
 const common_utils_1 = commonUtils;
 const layout_entities_1 = layoutEntities;
 const layout_constants_1 = layout_constants;
+/**
+ *
+ * Layouts give app providers the ability to embed multiple views in a single window. The Layout namespace
+ * enables the initialization and manipulation of a window's Layout. A Layout will
+ * emit events locally on the DOM element representing the layout-container.
+ *
+ *
+ * ### Layout.DOMEvents
+ *
+ * When a Layout is created, it emits events onto the DOM element representing the Layout container.
+ * This Layout container is the DOM element referenced by containerId in {@link Layout.LayoutModule#init Layout.init}.
+ * You can use the built-in event emitter to listen to these events using [addEventListener](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener).
+ * The events are emitted synchronously and only in the process where the Layout exists.
+ * Any values returned by the called listeners are ignored and will be discarded.
+ * If the target DOM element is destroyed, any events that have been set up on that element will be destroyed.
+ *
+ * @remarks The built-in event emitter is not an OpenFin event emitter so it doesn't share propagation semantics.
+ *
+ * #### {@link https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener addEventListener(type, listener [, options]);}
+ * Adds a listener to the end of the listeners array for the specified event.
+ * @example
+ * ```js
+ * const myLayoutContainer = document.getElementById('layout-container');
+ *
+ * myLayoutContainer.addEventListener('tab-created', function(event) {
+ *      const { tabSelector } = event.detail;
+ *      const tabElement = document.getElementById(tabSelector);
+ *      const existingColor = tabElement.style.backgroundColor;
+ *      tabElement.style.backgroundColor = "red";
+ *      setTimeout(() => {
+ *          tabElement.style.backgroundColor = existingColor;
+ *      }, 2000);
+ * });
+ * ```
+ *
+ * #### {@link https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/removeEventListener removeEventListener(type, listener [, options]);}
+ * Adds a listener to the end of the listeners array for the specified event.
+ * @example
+ * ```js
+ * const myLayoutContainer = document.getElementById('layout-container');
+ *
+ * const listener = function(event) {
+ *     console.log(event.detail);
+ *     console.log('container-created event fired once, removing listener');
+ *     myLayoutContainer.removeEventListener('container-created', listener);
+ * };
+ *
+ * myLayoutContainer.addEventListener('container-created', listener);
+ * ```
+ *
+ * ### Supported event types are:
+ *
+ * * tab-created
+ * * container-created
+ * * layout-state-changed
+ * * tab-closed
+ * * tab-dropped
+ *
+ * ### Layout DOM Node Events
+ *
+ * #### tab-created
+ * Generated when a tab is created.  As a user drags and drops tabs within window, new tabs are created.  A single view may have multiple tabs created and destroyed during its lifetime attached to a single window.
+ * ```js
+ * // The response has the following shape in event.detail:
+ * {
+ *     containerSelector: "container-component_A",
+ *     name: "component_A",
+ *     tabSelector: "tab-component_A",
+ *     topic: "openfin-DOM-event",
+ *     type: "tab-created",
+ *     uuid: "OpenFin POC"
+ * }
+ * ```
+ *
+ * #### container-created
+ * Generated when a container is created.  A single view will have only one container during its lifetime attached to a single window and the container's lifecycle is tied to the view.  To discover when the container is destroyed, please listen to view-detached event.
+ * ```js
+ * // The response has the following shape in event.detail:
+ * {
+ *     containerSelector: "container-component_A",
+ *     name: "component_A",
+ *     tabSelector: "tab-component_A",
+ *     topic: "openfin-DOM-event",
+ *     type: "container-created",
+ *     uuid: "OpenFin POC"
+ * }
+ * ```
+ *
+ * ### layout-state-changed
+ * Generated when the state of the layout changes in any way, such as a view added/removed/replaced. Note that this event can fire frequently as the underlying layout can change multiple components from all kinds of changes (resizing for example). Given this, it is recommended to debounce this event and then you can use the {@link Layout#getConfig Layout.getConfig} API to retrieve the most up-to-date state.
+ * ```js
+ * // The response has the following shape in event.detail
+ * {
+ *     containerSelector: "container-component_A",
+ *     name: "component_A",
+ *     tabSelector: "tab-component_A",
+ *     topic: "openfin-DOM-event",
+ *     type: "layout-state-changed",
+ *     uuid: "OpenFin POC"
+ * }
+ * ```
+ *
+ * #### tab-closed
+ * Generated when a tab is closed.
+ * ```js
+ * // The response has the following shape in event.detail:
+ * {
+ *     containerSelector: "container-component_A",
+ *     name: "component_A",
+ *     tabSelector: "tab-component_A",
+ *     topic: "openfin-DOM-event",
+ *     type: "tab-closed",
+ *     uuid: "OpenFin POC",
+ *     url: "http://openfin.co"   // The url of the view that was closed.
+ * }
+ * ```
+ *
+ * #### tab-dropped
+ * Generated when a tab is dropped.
+ * ```js
+ * // The response has the following shape in event.detail:
+ * {
+ *     containerSelector: "container-component_A",
+ *     name: "component_A",
+ *     tabSelector: "tab-component_A",
+ *     topic: "openfin-DOM-event",
+ *     type: "tab-dropped",
+ *     uuid: "OpenFin POC",
+ *     url: "http://openfin.co"    // The url of the view linked to the dropped tab.
+ * }
+ * ```
+ */
 class Layout extends base_1$6.Base {
     /**
      * @internal
@@ -12882,6 +13034,9 @@ Factory$2.LayoutModule = void 0;
 /* eslint-disable no-undef, import/prefer-default-export */
 const base_1$5 = base;
 const Instance_1$2 = Instance$1;
+/**
+ * Static namespace for OpenFin API methods that interact with the {@link Layout} class, available under `fin.Platform.Layout`.
+ */
 class LayoutModule extends base_1$5.Base {
     constructor() {
         super(...arguments);
@@ -13047,131 +13202,6 @@ _LayoutModule_layoutInitializationAttempted = new WeakMap();
 	 *
 	 * @packageDocumentation
 	 *
-	 *
-	 * ### Layout.DOMEvents
-	 *
-	 * When a Layout is created, it emits events onto the DOM element representing the Layout container.
-	 * This Layout container is the DOM element referenced by containerId in {@link Layout.LayoutModule#init Layout.init}.
-	 * You can use the built-in event emitter to listen to these events using [addEventListener](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener).
-	 * The events are emitted synchronously and only in the process where the Layout exists.
-	 * Any values returned by the called listeners are ignored and will be discarded.
-	 * If the target DOM element is destroyed, any events that have been set up on that element will be destroyed.
-	 *
-	 * @remarks The built-in event emitter is not an OpenFin event emitter so it doesn't share propagation semantics.
-	 *
-	 * #### {@link https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener addEventListener(type, listener [, options]);}
-	 * Adds a listener to the end of the listeners array for the specified event.
-	 * @example
-	 * ```js
-	 * const myLayoutContainer = document.getElementById('layout-container');
-	 *
-	 * myLayoutContainer.addEventListener('tab-created', function(event) {
-	 *      const { tabSelector } = event.detail;
-	 *      const tabElement = document.getElementById(tabSelector);
-	 *      const existingColor = tabElement.style.backgroundColor;
-	 *      tabElement.style.backgroundColor = "red";
-	 *      setTimeout(() => {
-	 *          tabElement.style.backgroundColor = existingColor;
-	 *      }, 2000);
-	 * });
-	 * ```
-	 *
-	 * #### {@link https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/removeEventListener removeEventListener(type, listener [, options]);}
-	 * Adds a listener to the end of the listeners array for the specified event.
-	 * @example
-	 * ```js
-	 * const myLayoutContainer = document.getElementById('layout-container');
-	 *
-	 * const listener = function(event) {
-	 *     console.log(event.detail);
-	 *     console.log('container-created event fired once, removing listener');
-	 *     myLayoutContainer.removeEventListener('container-created', listener);
-	 * };
-	 *
-	 * myLayoutContainer.addEventListener('container-created', listener);
-	 * ```
-	 *
-	 * ### Supported event types are:
-	 *
-	 * * tab-created
-	 * * container-created
-	 * * layout-state-changed
-	 * * tab-closed
-	 * * tab-dropped
-	 *
-	 * ### Layout DOM Node Events
-	 *
-	 * #### tab-created
-	 * Generated when a tab is created.  As a user drags and drops tabs within window, new tabs are created.  A single view may have multiple tabs created and destroyed during its lifetime attached to a single window.
-	 * ```js
-	 * // The response has the following shape in event.detail:
-	 * {
-	 *     containerSelector: "container-component_A",
-	 *     name: "component_A",
-	 *     tabSelector: "tab-component_A",
-	 *     topic: "openfin-DOM-event",
-	 *     type: "tab-created",
-	 *     uuid: "OpenFin POC"
-	 * }
-	 * ```
-	 *
-	 * #### container-created
-	 * Generated when a container is created.  A single view will have only one container during its lifetime attached to a single window and the container's lifecycle is tied to the view.  To discover when the container is destroyed, please listen to view-detached event.
-	 * ```js
-	 * // The response has the following shape in event.detail:
-	 * {
-	 *     containerSelector: "container-component_A",
-	 *     name: "component_A",
-	 *     tabSelector: "tab-component_A",
-	 *     topic: "openfin-DOM-event",
-	 *     type: "container-created",
-	 *     uuid: "OpenFin POC"
-	 * }
-	 * ```
-	 *
-	 * ### layout-state-changed
-	 * Generated when the state of the layout changes in any way, such as a view added/removed/replaced. Note that this event can fire frequently as the underlying layout can change multiple components from all kinds of changes (resizing for example). Given this, it is recommended to debounce this event and then you can use the {@link Layout#getConfig Layout.getConfig} API to retrieve the most up-to-date state.
-	 * ```js
-	 * // The response has the following shape in event.detail
-	 * {
-	 *     containerSelector: "container-component_A",
-	 *     name: "component_A",
-	 *     tabSelector: "tab-component_A",
-	 *     topic: "openfin-DOM-event",
-	 *     type: "layout-state-changed",
-	 *     uuid: "OpenFin POC"
-	 * }
-	 * ```
-	 *
-	 * #### tab-closed
-	 * Generated when a tab is closed.
-	 * ```js
-	 * // The response has the following shape in event.detail:
-	 * {
-	 *     containerSelector: "container-component_A",
-	 *     name: "component_A",
-	 *     tabSelector: "tab-component_A",
-	 *     topic: "openfin-DOM-event",
-	 *     type: "tab-closed",
-	 *     uuid: "OpenFin POC",
-	 *     url: "http://openfin.co"   // The url of the view that was closed.
-	 * }
-	 * ```
-	 *
-	 * #### tab-dropped
-	 * Generated when a tab is dropped.
-	 * ```js
-	 * // The response has the following shape in event.detail:
-	 * {
-	 *     containerSelector: "container-component_A",
-	 *     name: "component_A",
-	 *     tabSelector: "tab-component_A",
-	 *     topic: "openfin-DOM-event",
-	 *     type: "tab-dropped",
-	 *     uuid: "OpenFin POC",
-	 *     url: "http://openfin.co"    // The url of the view linked to the dropped tab.
-	 * }
-	 * ```
 	 */
 	var __createBinding = (commonjsGlobal && commonjsGlobal.__createBinding) || (Object.create ? (function(o, m, k, k2) {
 	    if (k2 === undefined) k2 = k;
@@ -13197,6 +13227,9 @@ Factory$3.PlatformModule = void 0;
 const base_1$4 = base;
 const Instance_1$1 = Instance$2;
 const index_1$1 = layout;
+/**
+ * Static namespace for OpenFin API methods that interact with the {@link Platform} class, available under `fin.Platform`.
+ */
 class PlatformModule extends base_1$4.Base {
     /**
      * @internal
@@ -16575,6 +16608,9 @@ Factory.SnapshotSourceModule = void 0;
 const base_1 = base;
 const Instance_1 = Instance;
 const utils_1 = utils;
+/**
+ * Static namespace for OpenFin API methods that interact with the {@link SnapshotSource} class, available under `fin.SnapshotSource`.
+ */
 class SnapshotSourceModule extends base_1.Base {
     /**
      * Initializes a SnapshotSource with the getSnapshot and applySnapshot methods defined.
@@ -16651,7 +16687,7 @@ Factory.SnapshotSourceModule = SnapshotSourceModule;
 	 * Entry points for the OpenFin `SnapshotSource` API.
 	 *
 	 * * {@link SnapshotSourceModule} contains static methods relating to the `SnapshotSource` type, accessible through `fin.SnapshotSource`.
-	 * * {@link SnapshotSource} describes an instance of an OpenFin SnapshotSource, e.g. as returned by `fin.SnapshotSource.getCurrent`.
+	 * * {@link SnapshotSource} describes an instance of an OpenFin SnapshotSource, e.g. as returned by `fin.SnapshotSource.wrap`.
 	 *
 	 * These are separate code entities, and are documented separately.  In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
 	 * both of these were documented on the same page.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/core",
-    "version": "34.78.7",
+    "version": "34.78.9",
     "description": "The core renderer entry point of OpenFin",
     "license": "SEE LICENSE IN LICENSE.MD",
     "main": "out/mock.js",