@openfin/core-web 0.40.10 → 0.40.12

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/core-web",
-    "version": "0.40.10",
+    "version": "0.40.12",
     "description": "",
     "private": false,
     "files": [
@@ -49,11 +49,10 @@
     "dependencies": {
         "buffer": "6.0.3",
         "events": "^3.3.0",
-        "golden-layout": "2.6.0",
         "lodash": "4.17.21",
         "uuid": "^8.3.2"
     },
     "peerDependencies": {
-        "@openfin/core": "40.82.10"
+        "@openfin/core": "40.82.12"
     }
 }

package/out/docs/@openfin/core-web/README.md

@@ -1,50 +0,0 @@
-**@openfin/core-web** • [API](../../README.md)
-
-***
-
-[@openfin/core-web](../../README.md) / @openfin/core-web
-
-# @openfin/core-web
-
-The main entry point for leveraging OpenFin Web Interop in a web application.
-
-## Remarks
-
-This module provides a way to connect to an OpenFin Web Interop broker, which allows for communication between Web applications.
-
-## Example
-
-```ts
-import { connect } from '@openfin/core-web';
-
-const fin = await connect({
-   options: {
-      brokerUrl: 'ws://localhost:9696/broker'
-      interopConfig: {
-         providerId: 'my-provider-id',
-         currentContextGroup: 'my-context-group'
-     }
-  }
- });
-```
-
-## Index
-
-### Type Aliases
-
-- [BaseConfig](type-aliases/BaseConfig.md)
-- [BaseConnectionOptions](type-aliases/BaseConnectionOptions.md)
-- [ConnectConfig](type-aliases/ConnectConfig.md)
-- [InheritModeConnectConfig](type-aliases/InheritModeConnectConfig.md)
-- [StandAloneConnectConfig](type-aliases/StandAloneConnectConfig.md)
-- [ViewComponentConfig](type-aliases/ViewComponentConfig.md)
-- [WebCreateLayoutOptions](type-aliases/WebCreateLayoutOptions.md)
-- [WebLayoutComponent](type-aliases/WebLayoutComponent.md)
-- [WebLayoutInitOptions](type-aliases/WebLayoutInitOptions.md)
-- [WebLayoutOptions](type-aliases/WebLayoutOptions.md)
-- [WebLayoutPlatformOptions](type-aliases/WebLayoutPlatformOptions.md)
-- [WebLayoutSnapshot](type-aliases/WebLayoutSnapshot.md)
-
-### Functions
-
-- [connect](functions/connect.md)

package/out/docs/@openfin/core-web/functions/connect.md

@@ -1,54 +0,0 @@
-**@openfin/core-web** • [API](../../../README.md)
-
-***
-
-[@openfin/core-web](../../../README.md) / [@openfin/core-web](../README.md) / connect
-
-# Function: connect()
-
-> **connect**(`connectConfig`): `Promise`\<`Fin`\<`"external connection"`\>\>
-
-## connect(connectConfig: ConnectConfig)
-Establishes a connection to an OpenFin Web Interop Broker, returning a fin object that supports a subset of APIS.
-
-### Supported APIs
-
-* fin.InterApplicationBus.Channels
-* fin.Interop
-* fin.me.identity
-* fin.Platform.Layout.init
-* fin.Platform.Layout.create
-* fin.Platform.Layout.destroy
-* fin.Platform.Layout.getCurrentLayoutManagerSync
-
-## Parameters
-
-• **connectConfig**: [`ConnectConfig`](../type-aliases/ConnectConfig.md)
-
-Config used to initialise the connection
-
-## Returns
-
-`Promise`\<`Fin`\<`"external connection"`\>\>
-
-Fin api object
-
-## Throws
-
-If the connection to the broker fails.
-
-## Throws
-
-If the connection elapses the configured timeout
-
-## Throws
-
-If the provided InheritModeConnectConfig.validateOptions returns false
-
-## Throws
-
-If connection inheritance is enabled but the current browsing context is not rendered as a View within an OpenFin WebLayout and no ConnectConfig.options are provided.
-
-## Throws
-
-If a platform object is provided but the layoutSnapshot is invalid.

package/out/docs/@openfin/core-web/iframe-broker/README.md

@@ -1,35 +0,0 @@
-**@openfin/core-web** • [API](../../../README.md)
-
-***
-
-[@openfin/core-web](../../../README.md) / @openfin/core-web/iframe-broker
-
-# @openfin/core-web/iframe-broker
-
-This module is the entry point for the Iframe Broker. It is responsible for initializing the OpenFin Web Interop environment.
-
-## Remarks
-
-This module is intended to be used in an iframe context, and is responsible for setting up the connection between the iframe and the OpenFin Web Interop broker.
-This module requires hosting the script exported by the module:@openfin/core-web/worker module.
-
-## Example
-
-```ts
-import { init } from '@openfin/core-web/iframe-broker';
-
-init({
-  sharedWorkerUrl: 'path to shared worker script'
-});
-```
-
-## Index
-
-### Type Aliases
-
-- [ConnectionOptions](type-aliases/ConnectionOptions.md)
-
-### Functions
-
-- [init](functions/init.md)
-- [rejectConnections](functions/rejectConnections.md)

package/out/docs/@openfin/core-web/iframe-broker/functions/init.md

@@ -1,17 +0,0 @@
-**@openfin/core-web** • [API](../../../../README.md)
-
-***
-
-[@openfin/core-web](../../../../README.md) / [@openfin/core-web/iframe-broker](../README.md) / init
-
-# Function: init()
-
-> **init**(`options`): `Promise`\<`void`\>
-
-## Parameters
-
-• **options**: [`ConnectionOptions`](../type-aliases/ConnectionOptions.md)
-
-## Returns
-
-`Promise`\<`void`\>

package/out/docs/@openfin/core-web/iframe-broker/functions/rejectConnections.md

@@ -1,19 +0,0 @@
-**@openfin/core-web** • [API](../../../../README.md)
-
-***
-
-[@openfin/core-web](../../../../README.md) / [@openfin/core-web/iframe-broker](../README.md) / rejectConnections
-
-# Function: rejectConnections()
-
-> **rejectConnections**(`options`?): `void`
-
-## Parameters
-
-• **options?**
-
-• **options\.reason?**: `string`
-
-## Returns
-
-`void`

package/out/docs/@openfin/core-web/iframe-broker/type-aliases/ConnectionOptions.md

@@ -1,23 +0,0 @@
-**@openfin/core-web** • [API](../../../../README.md)
-
-***
-
-[@openfin/core-web](../../../../README.md) / [@openfin/core-web/iframe-broker](../README.md) / ConnectionOptions
-
-# Type alias: ConnectionOptions
-
-> **ConnectionOptions**: `object`
-
-## Type declaration
-
-### experimental?
-
-> **`optional`** **experimental**: `object`
-
-### experimental.crossTab?
-
-> **`optional`** **crossTab**: `"same-site"` \| `"none"`
-
-### sharedWorkerUrl
-
-> **sharedWorkerUrl**: `string`

package/out/docs/@openfin/core-web/shared-worker/README.md

@@ -1,16 +0,0 @@
-**@openfin/core-web** • [API](../../../README.md)
-
-***
-
-[@openfin/core-web](../../../README.md) / @openfin/core-web/shared-worker
-
-# @openfin/core-web/shared-worker
-
-This file is the entry point for the worker powering web-interop.
-It has no exports and is intended to be hosted with the url given to the `sharedWorkerUrl` option in the Iframe Broker (see: ["@openfin/core-web/iframe-broker"](../iframe-broker/README.md)).
-
-## Index
-
-### Variables
-
-- [default](variables/default.md)

package/out/docs/@openfin/core-web/shared-worker/variables/default.md

@@ -1,9 +0,0 @@
-**@openfin/core-web** • [API](../../../../README.md)
-
-***
-
-[@openfin/core-web](../../../../README.md) / [@openfin/core-web/shared-worker](../README.md) / default
-
-# Variable: default
-
-> **default**: `null`

package/out/docs/@openfin/core-web/type-aliases/BaseConfig.md

@@ -1,18 +0,0 @@
-**@openfin/core-web** • [API](../../../README.md)
-
-***
-
-[@openfin/core-web](../../../README.md) / [@openfin/core-web](../README.md) / BaseConfig
-
-# Type alias: BaseConfig
-
-> **BaseConfig**: `object`
-
-## Type declaration
-
-### platform?
-
-> **`optional`** **platform**: [`WebLayoutPlatformOptions`](WebLayoutPlatformOptions.md)
-
-Options used to initialize Web Layouts related features. If omitted, calling `fin.Platform.Layout.init()`
-will not work.

package/out/docs/@openfin/core-web/type-aliases/BaseConnectionOptions.md

@@ -1,29 +0,0 @@
-**@openfin/core-web** • [API](../../../README.md)
-
-***
-
-[@openfin/core-web](../../../README.md) / [@openfin/core-web](../README.md) / BaseConnectionOptions
-
-# Type alias: BaseConnectionOptions
-
-> **BaseConnectionOptions**: `object`
-
-## Type declaration
-
-### brokerUrl
-
-> **brokerUrl**: `string`
-
-The URL of the Web Interop broker to connect to.
-
-### interopConfig?
-
-> **`optional`** **interopConfig**: `Partial`\<`OpenFin.InteropConfig`\>
-
-Interop options to use to generate an interop client in `fin.me.interop`
-
-### timeout?
-
-> **`optional`** **timeout**: `number`
-
-Tears down and cancels the connection attempt if it is not complete within the specified timeout (in ms).

package/out/docs/@openfin/core-web/type-aliases/ConnectConfig.md

@@ -1,9 +0,0 @@
-**@openfin/core-web** • [API](../../../README.md)
-
-***
-
-[@openfin/core-web](../../../README.md) / [@openfin/core-web](../README.md) / ConnectConfig
-
-# Type alias: ConnectConfig
-
-> **ConnectConfig**: [`StandAloneConnectConfig`](StandAloneConnectConfig.md) \| [`InheritModeConnectConfig`](InheritModeConnectConfig.md)

package/out/docs/@openfin/core-web/type-aliases/InheritModeConnectConfig.md

@@ -1,49 +0,0 @@
-**@openfin/core-web** • [API](../../../README.md)
-
-***
-
-[@openfin/core-web](../../../README.md) / [@openfin/core-web](../README.md) / InheritModeConnectConfig
-
-# Type alias: InheritModeConnectConfig
-
-> **InheritModeConnectConfig**: [`BaseConfig`](BaseConfig.md) & `object`
-
-## Type declaration
-
-### connectionInheritance
-
-> **connectionInheritance**: `"enabled"`
-
-#### Default Value
-
-'disabled'
-
-If 'enabled', attempts to inherit connection options if it is running as a View within an OpenFin WebLayout.
-This means that the `brokerUrl` and `Identity` of the connection will be determined by the WebBroker
-of the page where the WebLayout is instantiated via `fin.Platform.Layout.init()` call.
-
-If 'disabled', the `options` property is required.
-
-### options?
-
-> **`optional`** **options**: [`BaseConnectionOptions`](BaseConnectionOptions.md)
-
-Options used to connect to an OpenFin Web Broker. Please note, these will be overriden if connectionInheritance
-is 'enabled' and supported for the current browsing context. In the case that inherited options are unavailable,
-these options will be used.
-
-### validateOptions()?
-
-> **`optional`** **validateOptions**: (`inheritedOptions`) => `boolean` \| `Promise`\<`boolean`\>
-
-Validates the inherited connection options from the parent browsing context, if available.
-
-#### Parameters
-
-• **inheritedOptions**: `Omit`\<[`BaseConnectionOptions`](BaseConnectionOptions.md), `"timeout"`\>
-
-Inherited options
-
-#### Returns
-
-`boolean` \| `Promise`\<`boolean`\>

package/out/docs/@openfin/core-web/type-aliases/StandAloneConnectConfig.md

@@ -1,31 +0,0 @@
-**@openfin/core-web** • [API](../../../README.md)
-
-***
-
-[@openfin/core-web](../../../README.md) / [@openfin/core-web](../README.md) / StandAloneConnectConfig
-
-# Type alias: StandAloneConnectConfig
-
-> **StandAloneConnectConfig**: [`BaseConfig`](BaseConfig.md) & `object`
-
-## Type declaration
-
-### connectionInheritance?
-
-> **`optional`** **connectionInheritance**: `"disabled"`
-
-#### Default Value
-
-'disabled'
-
-If 'enabled', attempts to inherit connection options if it is running as a View within an OpenFin WebLayout.
-This means that the `brokerUrl` and `Identity` of the connection will be determined by the WebBroker
-of the page where the WebLayout is instantiated via `fin.Platform.Layout.init()` call.
-
-If 'disabled', the `options` property is required.
-
-### options
-
-> **options**: [`BaseConnectionOptions`](BaseConnectionOptions.md)
-
-Options used to connect to an OpenFin Web Broker. Mandatory if StandAloneConnectConfig.connectionInheritance is 'disabled'.

package/out/docs/@openfin/core-web/type-aliases/ViewComponentConfig.md

@@ -1,9 +0,0 @@
-**@openfin/core-web** • [API](../../../README.md)
-
-***
-
-[@openfin/core-web](../../../README.md) / [@openfin/core-web](../README.md) / ViewComponentConfig
-
-# Type alias: ViewComponentConfig
-
-> **ViewComponentConfig**: [`WebLayoutComponent`](WebLayoutComponent.md)\[`"componentState"`\]

package/out/docs/@openfin/core-web/type-aliases/WebCreateLayoutOptions.md

@@ -1,15 +0,0 @@
-**@openfin/core-web** • [API](../../../README.md)
-
-***
-
-[@openfin/core-web](../../../README.md) / [@openfin/core-web](../README.md) / WebCreateLayoutOptions
-
-# Type alias: WebCreateLayoutOptions
-
-> **WebCreateLayoutOptions**: `Omit`\<`OpenFin.CreateLayoutOptions`, `"layout"`\> & `object`
-
-## Type declaration
-
-### layout
-
-> **layout**: [`WebLayoutOptions`](WebLayoutOptions.md)

package/out/docs/@openfin/core-web/type-aliases/WebLayoutComponent.md

@@ -1,23 +0,0 @@
-**@openfin/core-web** • [API](../../../README.md)
-
-***
-
-[@openfin/core-web](../../../README.md) / [@openfin/core-web](../README.md) / WebLayoutComponent
-
-# Type alias: WebLayoutComponent
-
-> **WebLayoutComponent**: `OpenFin.LayoutComponent` & `object`
-
-Web-only component supplied to IframeViewComponent as it's config
-
-## Type declaration
-
-### componentState?
-
-> **`optional`** **componentState**: `OpenFin.LayoutComponent`\[`"componentState"`\] & `object`
-
-#### Type declaration
-
-##### web?
-
-> **`optional`** **web**: `WebState`

package/out/docs/@openfin/core-web/type-aliases/WebLayoutInitOptions.md

@@ -1,15 +0,0 @@
-**@openfin/core-web** • [API](../../../README.md)
-
-***
-
-[@openfin/core-web](../../../README.md) / [@openfin/core-web](../README.md) / WebLayoutInitOptions
-
-# Type alias: WebLayoutInitOptions
-
-> **WebLayoutInitOptions**: `Omit`\<`OpenFin.InitLayoutOptions`, `"layoutManagerOverride"`\> & `object`
-
-## Type declaration
-
-### layoutManagerOverride?
-
-> **`optional`** **layoutManagerOverride**: `OpenFin.LayoutManagerOverride`\<[`WebLayoutSnapshot`](WebLayoutSnapshot.md)\>

package/out/docs/@openfin/core-web/type-aliases/WebLayoutOptions.md

@@ -1,15 +0,0 @@
-**@openfin/core-web** • [API](../../../README.md)
-
-***
-
-[@openfin/core-web](../../../README.md) / [@openfin/core-web](../README.md) / WebLayoutOptions
-
-# Type alias: WebLayoutOptions
-
-> **WebLayoutOptions**: `Omit`\<`OpenFin.LayoutOptions`, `"content"`\> & `object`
-
-## Type declaration
-
-### content?
-
-> **`optional`** **content**: `WebLayoutContent`

package/out/docs/@openfin/core-web/type-aliases/WebLayoutPlatformOptions.md

@@ -1,15 +0,0 @@
-**@openfin/core-web** • [API](../../../README.md)
-
-***
-
-[@openfin/core-web](../../../README.md) / [@openfin/core-web](../README.md) / WebLayoutPlatformOptions
-
-# Type alias: WebLayoutPlatformOptions
-
-> **WebLayoutPlatformOptions**: `object`
-
-## Type declaration
-
-### layoutSnapshot
-
-> **layoutSnapshot**: [`WebLayoutSnapshot`](WebLayoutSnapshot.md)

package/out/docs/@openfin/core-web/type-aliases/WebLayoutSnapshot.md

@@ -1,15 +0,0 @@
-**@openfin/core-web** • [API](../../../README.md)
-
-***
-
-[@openfin/core-web](../../../README.md) / [@openfin/core-web](../README.md) / WebLayoutSnapshot
-
-# Type alias: WebLayoutSnapshot
-
-> **WebLayoutSnapshot**: `object`
-
-## Type declaration
-
-### layouts
-
-> **layouts**: `Record`\<`string`, [`WebLayoutOptions`](WebLayoutOptions.md)\>

package/out/docs/README.md

@@ -1,11 +0,0 @@
-**@openfin/core-web** • API
-
-***
-
-# @openfin/core-web
-
-## Modules
-
-- [@openfin/core-web](@openfin/core-web/README.md)
-- [@openfin/core-web/iframe-broker](@openfin/core-web/iframe-broker/README.md)
-- [@openfin/core-web/shared-worker](@openfin/core-web/shared-worker/README.md)