@openfin/core-web 0.38.1

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

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

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

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

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

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

@@ -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

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

@@ -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

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

@@ -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'.

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

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

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

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

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

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

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

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

package/out/iframe-broker.d.ts

@@ -0,0 +1,14 @@
+export declare type ConnectionOptions = {
+    sharedWorkerUrl: string;
+    experimental?: {
+        crossTab?: 'same-site' | 'none';
+    };
+};
+
+export declare const init: (options: ConnectionOptions) => Promise<void>;
+
+export declare function rejectConnections(options?: {
+    reason: string;
+}): void;
+
+export { }

package/out/iframe-broker.js

@@ -0,0 +1 @@
+"use strict";const e="web-broker-ports-ready",t="worker-initialize-connection",r="create-fallback-connection",i="request-fallback-connection",o=e=>`ack-${e}`,n=(...e)=>({log:(...t)=>console.log(`[${(new Date).toISOString()}]`,...(e=>e.map((e=>`[${e}]`)))(e),...t),getLogger:(...t)=>n(...e,...t)});class s{static get lockApi(){return navigator.locks}constructor(e){this.name=e,this.releaseCallback=null,s.pending.add(this),this.lockAcquiredPromise=new Promise(((e,t)=>{this.lockReleasedPromise=s.lockApi.request(this.name,(()=>(s.pending.delete(this),e(),new Promise((e=>{s.held.add(this),this.releaseCallback=e}))))).catch((e=>{throw t(e),e}))}))}async acquired(){await this.lockAcquiredPromise}async release(){if(!this.releaseCallback)throw new Error(`Lock ${this.name} not acquired.`);this.releaseCallback(),this.releaseCallback=null,await this.lockReleasedPromise,s.held.delete(this)}async onReleased(e){if(!this.lockReleasedPromise)throw new Error(`Lock ${this.name} not queued.`);return this.lockReleasedPromise.then(e)}autoRelease(){this.acquired().then((()=>this.release()))}static async releaseAll(){const e=Promise.all([...this.pending].map((async e=>{await e.acquired(),await e.release()})));await Promise.all([...this.held].map((async e=>{await e.release()}))),await e}}s.pending=new Set,s.held=new Set;const a=e=>window.top===e,c=(e,t)=>{try{return e.origin===t.origin}catch(e){return!1}},d="openfin/web-shared-worker";class h{constructor(e,t,n){this.workerUrl=e,this.iframeWindow=t,this.forceWorker=n,this.isSharedWorkerSupported=()=>!this.forceWorker&&!!window.SharedWorker,this.state="ready",this.establishWorkerConnectionViaWindow=async e=>{if(c(this.iframeWindow,e)){const t=new MessageChannel;return new Promise(((n,s)=>{t.port1.addEventListener("message",(e=>{e.data.topic===o(r)&&(e.data.success?n(t.port1):s(e.data.reason))})),t.port1.start();const a={topic:i};e.postMessage(a,location.origin,[t.port2])}))}throw new Error("Could not connect via top level browsing context as its origin does not much the web interop broker.")},this.listenForNestedConnections=e=>{"top-window"===this.state&&c(this.iframeWindow,this.iframeWindow.parent)&&this.iframeWindow.parent.addEventListener("message",(t=>{if(t.origin===location.origin&&t.data.topic===i){const[i]=t.ports,o={topic:r};e.postMessage(o,[i])}}))},this.initialize=async()=>{if("ready"!==this.state)throw new Error("Worker connection already initialized");if((e=>{const t=r=>!(!(e=>{try{return!e.origin}catch(e){return!0}})(r)&&r.origin===e.origin)||!a(r)&&t(r.parent);return!a(e)&&t(e.parent)})(this.iframeWindow)&&c(this.iframeWindow,this.iframeWindow.top))return this.state="partitioned-frame",this.establishWorkerConnectionViaWindow(this.iframeWindow.top);if(a(this.iframeWindow.parent)){let e;return this.state="top-window",e=this.isSharedWorkerSupported()?new SharedWorker(this.workerUrl,d).port:new Worker(this.workerUrl),this.listenForNestedConnections(e),e}{if(this.state="frame",!this.isSharedWorkerSupported())try{return await this.establishWorkerConnectionViaWindow(this.iframeWindow.top)}catch(e){throw new Error(`SharedWorker is not supported and an unexpected error occured when trying to connect via fallback mechanism: ${e.message}`)}const{port:e}=new SharedWorker(this.workerUrl,d);return e}}}}const l=n("@openfin/core-web/iframe-broker"),w=()=>{const e=((e,t)=>{const r=new RegExp(`^${t}<(?<meta>.*)>$`).exec(e)?.groups?.meta;if(r)try{return JSON.parse(atob(r))}catch(e){throw new Error(`Failed to decode JSON from ${r}.`)}})(window.name,"of-broker");if(!e)throw new Error("Invalid or missing identity string in iframe context. Ensure that this iframe is being renderered via the @openfin/core-web library.");return e};function p(t){const r={topic:o(e),success:!1,reason:t?.reason??"Connection Rejected"};window.parent.postMessage(r,"*")}exports.init=async r=>{try{const{sharedWorkerUrl:i}=r;await("loading"===document.readyState?new Promise((e=>{const t=()=>{e(),window.removeEventListener("DOMContentLoaded",t)};window.addEventListener("DOMContentLoaded",t)})):Promise.resolve());const n=w(),a=new h(i,window,"same-site"!==r.experimental?.crossTab),c=await a.initialize();l.log(`Loading ${i} in ${a.state} mode...`);const d=await(async(r,i,n)=>{const a=new MessageChannel,c=new MessageChannel,d={topic:t,payload:{identity:n}},h=new s((e=>`__OPENFIN__${e.uuid}_${e.name}`)(n));await h.acquired(),await new Promise(((e,r)=>{i.addEventListener("message",(i=>{i.data.topic===o(t)&&(i.data.success?e():r(new Error(i.data.reason)))})),i.start?.(),i.postMessage(d,[c.port2])}));const l={topic:o(e),success:!0,payload:{identity:n}};return r.postMessage(l,"*",[a.port2,c.port1]),a.port1})(window.parent,c,n);d.start(),c.start?.(),l.log(`Port transfer complete in ${a.state} mode. Connection established with identity ${JSON.stringify(n)}. SharedWorker support=${a.isSharedWorkerSupported()}`)}catch(e){const t=new Error(`An unexpected error occured during initialization. ${e.message}`);p({reason:t.message}),console.error(t)}},exports.rejectConnections=p;