@openfin/core-web 0.38.42 → 0.38.44

package/docs/platform-developer-guide.md

@@ -22,8 +22,8 @@ An HTML page, loaded as a hidden iframe by clients, must be hosted in the same o
 
 In order to build a Web Broker, the following requirements must be met:
 
-1. You must host the `@openfin/core-web/shared-worker` bundle on a domain (for example https://www.example.com/mysharedworker.js).
-2. You must host a web broker page on that same domain (for example, https://www.example.com/web-broker).
+1. You must host the `@openfin/core-web/shared-worker` bundle on a domain (for example <https://www.example.com/mysharedworker.js>).
+2. You must host a web broker page on that same domain (for example, <https://www.example.com/web-broker>).
 3. That page must call `init` from `@openfin/core-web/iframe-broker` with the URL of the shared worker hosted in step 1.
 
     ```typescript
@@ -132,7 +132,7 @@ Note that the `fin.Platform.Layout` API is exactly the same in web, so you can r
 In order to use layouts, specify the `platform` option to the `connect` call and pass in the `layoutSnapshot`.
 
 ```typescript
-import { connect, type WebLayoutSnapshot } from '@openfin/web-interop';
+import { connect, type WebLayoutSnapshot } from '@openfin/core-web';
 
 const brokerUrl = 'http://example.com/web-broker';
 
@@ -146,20 +146,30 @@ const layoutSnapshot: WebLayoutSnapshot = {
                     type: 'row',
                     content: [
                         {
-                            title: 'Bloomberg',
-                            type: 'component',
-                            componentName: 'view',
-                            componentState: {
-                                url: 'http://bloomberg.com/'
-                            }
+                            type: 'stack',
+                            content: [
+                                {
+                                    title: 'Example',
+                                    type: 'component',
+                                    componentName: 'view',
+                                    componentState: {
+                                        url: 'http://example.com/'
+                                    }
+                                }
+                            ]
                         },
                         {
-                            title: 'OpenFin',
-                            type: 'component',
-                            componentName: 'view',
-                            componentState: {
-                                url: 'http://www.openfin.co/'
-                            }
+                            type: 'stack',
+                            content: [
+                                {
+                                    title: 'Example',
+                                    type: 'component',
+                                    componentName: 'view',
+                                    componentState: {
+                                        url: 'http://example.com/'
+                                    }
+                                }
+                            ]
                         }
                     ]
                 }
@@ -187,13 +197,19 @@ const layoutSnapshot: WebLayoutSnapshot = {
 
 (async () => {
     // Connect to the OpenFin Web Broker. Pass in the `platform` key with a layoutSnapshot.
-    const fin = await connect({ options: { brokerUrl, platform: { layoutSnapshot } } });
+    const fin = await connect({
+        connectionInheritance: 'enabled',
+        options: { brokerUrl },
+        platform: { layoutSnapshot }
+    });
+
+    const container = document.getElementById('layout-container');
 
     // You may now use the `fin` object. In this case, we want to initialize and create layouts.
-    await fin.Platform.Layout.init();
+    await fin.Platform.Layout.init({ container });
 
-    // Then from the context of our Layout UI component, we create the layout (see https://developers.openfin.co/of-docs/docs/multi-layouts):
-    await fin.Platform.Layout.create({ ... });
+    // For multi-layout information see https://developers.openfin.co/of-docs/docs/multi-layouts
+    // In the multi-layout case we would also call `fin.Platform.Layout.create()`.
 })();
 ```
 

package/docs/web-application-developer-guide.md

@@ -109,17 +109,15 @@ Note that FDC3 support in web is currently limited to context sharing on system
 
 ## Context Aware Connections and Connection Inheritance
 
-`@openfin/core-web` has been designed to support inheritance of brokerUrls and interop configurations if your content is running as a view within an OpenFin Layout. This allows content developers to develop platform-agnostic experiences and ensure that they are able to interact with other content connected to the same Web Broker.
-
-However, as Web Layouts is not publicly available yet, the `connect` `connectionInheritance` setting will default to `'disabled'`.
+`@openfin/core-web` has been designed to support inheritance of brokerUrls and interop configurations if your content is running as a View within an OpenFin Layout. This allows content developers to develop platform-agnostic experiences and ensure that they are able to interact with other content connected to the same Web Broker.
 
 ## API Reference
 
 (Please note, this link works in your IDE and not on npmjs.com, we will update this soon.)
 
--   [@openfin/core-web](../out/docs/@openfin/core-web/README.md)
+- [@openfin/core-web](../out/docs/@openfin/core-web/README.md)
 
 ## See Also
 
--   [Fin API reference](https://developer.openfin.co/docs/javascript/stable)
--   [OpenFin Container Developer guide](https://developers.openfin.co/of-docs/docs/container-overview)
+- [Fin API reference](https://developer.openfin.co/docs/javascript/stable)
+- [OpenFin Container Developer guide](https://developers.openfin.co/of-docs/docs/container-overview)

package/out/api-client.d.ts

@@ -1,8 +1,16 @@
 import type OpenFin from '@openfin/core';
 
+export declare type BaseConfig = {
+    /**
+     * Options used to initialize Web Layouts related features. If omitted, calling `fin.Platform.Layout.init()`
+     * will not work.
+     */
+    platform?: WebLayoutPlatformOptions;
+};
+
 export declare type BaseConnectionOptions = {
     /**
-     * The URL of the Web Interop broker to connect to. Can be inherited from a parent browsing context if using an <of-view>
+     * The URL of the Web Interop broker to connect to.
      */
     brokerUrl: string;
     /**
@@ -16,7 +24,7 @@ export declare type BaseConnectionOptions = {
 };
 
 /**
- * ## connect(connectionConfig: ConnectionConfig)
+ * ## connect(connectConfig: ConnectConfig)
  * Establishes a connection to an OpenFin Web Interop Broker, returning a fin object that supports a subset of APIS.
  *
  * ### Supported APIs
@@ -29,28 +37,32 @@ export declare type BaseConnectionOptions = {
  * * fin.Platform.Layout.destroy
  * * fin.Platform.Layout.getCurrentLayoutManagerSync
  *
- * @param connectionConfig Config used to initialise the connection
+ * @param connectConfig Config used to initialise the connection
  * @returns Fin api object
  * @throws If the connection to the broker fails.
  * @throws If the connection elapses the configured timeout
  * @throws If the provided {@link InheritModeConnectConfig.validateOptions} returns false
- * @throws If connection inheritance is enabled but the current browsing context is not rendered in an <of-view> element and no {@link ConnectionConfig.options} are provided.
+ * @throws If connection inheritance is enabled but the current browsing context is not rendered as a View within an OpenFin WebLayout and no {@link ConnectConfig.options} are provided.
  * @throws If a platform object is provided but the layoutSnapshot is invalid.
  */
-export declare const connect: (connectionConfig: ConnectionConfig) => Promise<OpenFin.Fin<'external connection'>>;
+export declare const connect: (connectConfig: ConnectConfig) => Promise<OpenFin.Fin<'external connection'>>;
 
-export declare type ConnectionConfig = StandAloneConnectonConfig | InheritModeConnectConfig;
+export declare type ConnectConfig = StandAloneConnectConfig | InheritModeConnectConfig;
 
-export declare type InheritModeConnectConfig = {
+export declare type InheritModeConnectConfig = BaseConfig & {
     /**
-     * If 'enabled', connection option inheritance is enabled if the current browsing context is
-     * a nested browsing context within an <of-view> element. This means that the brokerUrl and Identity
-     * of the connection will be determined by the parent browsing context. Specifying a value is mandatory.
+     * @defaultValue '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.
      */
     connectionInheritance: 'enabled';
     /**
-     * Options used to connect to an OpenFin Web Broker. Please note, these will be overriden if connection inheritance
-     * is enabled and supported for the current browsing context.
+     * 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.
      */
     options?: BaseConnectionOptions;
     /**
@@ -61,21 +73,21 @@ export declare type InheritModeConnectConfig = {
     validateOptions?: (inheritedOptions: Omit<BaseConnectionOptions, 'timeout'>) => boolean | Promise<boolean>;
 };
 
-export declare type StandAloneConnectonConfig = {
+export declare type StandAloneConnectConfig = BaseConfig & {
     /**
-     * If 'enabled', connection option inheritance is enabled if the current browsing context is
-     * a nested browsing context within an <of-view> element. This means that the brokerUrl and Identity
-     * of the connection will be determined by the parent browsing context. Specifying a value is mandatory.
+     * @defaultValue '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.
      */
     connectionInheritance?: 'disabled';
     /**
-     * Options used to connect to an OpenFin Web Broker. Mandatory if {@link StandAloneConnectonConfig.connectionInheritance} is false.
+     * Options used to connect to an OpenFin Web Broker. Mandatory if {@link StandAloneConnectConfig.connectionInheritance} is 'disabled'.
      */
     options: BaseConnectionOptions;
-    /**
-     * Options used to initialize web-layouts related features.
-     */
-    platform?: WebLayoutPlatformOptions;
 };
 
 export declare type WebCreateLayoutOptions = Omit<OpenFin.CreateLayoutOptions, 'layout'> & {

package/out/api-client.js

@@ -1 +1 @@
-"use strict";var e=require("./main-014f1c1a.js");require("buffer"),require("uuid"),require("events"),require("lodash"),exports.connect=e.connect;
+"use strict";var e=require("./main-439f0e51.js");require("buffer"),require("uuid"),require("events"),require("lodash"),exports.connect=e.connect;

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

@@ -32,10 +32,11 @@ const fin = await connect({
 
 ### Type Aliases
 
+- [BaseConfig](type-aliases/BaseConfig.md)
 - [BaseConnectionOptions](type-aliases/BaseConnectionOptions.md)
-- [ConnectionConfig](type-aliases/ConnectionConfig.md)
+- [ConnectConfig](type-aliases/ConnectConfig.md)
 - [InheritModeConnectConfig](type-aliases/InheritModeConnectConfig.md)
-- [StandAloneConnectonConfig](type-aliases/StandAloneConnectonConfig.md)
+- [StandAloneConnectConfig](type-aliases/StandAloneConnectConfig.md)
 - [WebCreateLayoutOptions](type-aliases/WebCreateLayoutOptions.md)
 - [WebLayoutComponent](type-aliases/WebLayoutComponent.md)
 - [WebLayoutInitOptions](type-aliases/WebLayoutInitOptions.md)

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

@@ -6,9 +6,9 @@
 
 # Function: connect()
 
-> **connect**(`connectionConfig`): `Promise`\<`Fin`\<`"external connection"`\>\>
+> **connect**(`connectConfig`): `Promise`\<`Fin`\<`"external connection"`\>\>
 
-## connect(connectionConfig: ConnectionConfig)
+## connect(connectConfig: ConnectConfig)
 Establishes a connection to an OpenFin Web Interop Broker, returning a fin object that supports a subset of APIS.
 
 ### Supported APIs
@@ -23,7 +23,7 @@ Establishes a connection to an OpenFin Web Interop Broker, returning a fin objec
 
 ## Parameters
 
-• **connectionConfig**: [`ConnectionConfig`](../type-aliases/ConnectionConfig.md)
+• **connectConfig**: [`ConnectConfig`](../type-aliases/ConnectConfig.md)
 
 Config used to initialise the connection
 
@@ -47,7 +47,7 @@ If the provided InheritModeConnectConfig.validateOptions returns false
 
 ## Throws
 
-If connection inheritance is enabled but the current browsing context is not rendered in an `<of-view>` element and no ConnectionConfig.options are provided.
+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
 

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

@@ -0,0 +1,18 @@
+**@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

@@ -14,7 +14,7 @@
 
 > **brokerUrl**: `string`
 
-The URL of the Web Interop broker to connect to. Can be inherited from a parent browsing context if using an `<of-view>`
+The URL of the Web Interop broker to connect to.
 
 ### interopConfig?
 

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

@@ -0,0 +1,9 @@
+**@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

@@ -6,7 +6,7 @@
 
 # Type alias: InheritModeConnectConfig
 
-> **InheritModeConnectConfig**: `object`
+> **InheritModeConnectConfig**: [`BaseConfig`](BaseConfig.md) & `object`
 
 ## Type declaration
 
@@ -14,16 +14,22 @@
 
 > **connectionInheritance**: `"enabled"`
 
-If 'enabled', connection option inheritance is enabled if the current browsing context is
-a nested browsing context within an `<of-view>` element. This means that the brokerUrl and Identity
-of the connection will be determined by the parent browsing context. Specifying a value is mandatory.
+#### 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 connection inheritance
-is enabled and supported for the current browsing context.
+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.
 
 ### validateOptions()?
 

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

@@ -0,0 +1,31 @@
+**@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'.