@openfin/cloud-interop 0.42.1 → 0.42.3
Sign up to get free protection for your applications and to get access to all the features.
- package/README.md +20 -1
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -4,7 +4,26 @@ This package contains an override that enables Cloud Interop for `InteropBroker`
|
|
|
4
4
|
|
|
5
5
|
Overrides are passed to `fin.Platform.init` when initializing a platform or to `fin.Interop.init` when creating an `InteropBroker` directly.
|
|
6
6
|
|
|
7
|
-
Once overriden the `InteropBroker` will connect to the given Cloud Interop Service upon initialization. `Context` will be sent to the Cloud Interop
|
|
7
|
+
Once overriden the `InteropBroker` will connect to the given Cloud Interop Service upon initialization. `Context` will be sent to the Cloud Interop Service when the override broker calls `setContext` and the broker will also subscribe `Context` updates from other any other connected brokers in the shared session.
|
|
8
|
+
|
|
9
|
+
The Cloud Interop Service also supports `Intent`'s. Connected `InteropBroker`'s info calls (`handleInfoForIntent`, `handleInfoForIntentsByContext`, `fdc3.findIntent`, `fdc3.findIntentsByContext`) will include results for remote sessions and decorate those app identifiers with additional metadata which can then be used to raise `Intent`'s on remote sessions.
|
|
10
|
+
|
|
11
|
+
## Override Options
|
|
12
|
+
|
|
13
|
+
| Option | Type | Description | Default Value | Required |
|
|
14
|
+
|------------------------------------|----------------------------------------------------------------|-----------------------------------------------------------------------------------------------|-------------------|----------|
|
|
15
|
+
| `url` | `string` | URL of the Cloud Interop service | N/A | Yes |
|
|
16
|
+
| `platformId` | `string` | Platform ID | N/A | Yes |
|
|
17
|
+
| `sourceId` | `string` | Source ID | N/A | Yes |
|
|
18
|
+
| `reconnectRetryLimit` | `number` (optional) | Limit for reconnect retries | N/A | No |
|
|
19
|
+
| `keepAliveIntervalSeconds` | `number` (optional) | Interval in seconds to keep the connection alive | N/A | No |
|
|
20
|
+
| `findIntentTimeout` | `number` (optional) | How long to wait for connected clients to respond. Do not make this too high. | `3 seconds` | No |
|
|
21
|
+
| `authenticationType` | ``'jwt' \| 'basic' \| 'default'`` (optional) | Type of authentication to use | N/A | No |
|
|
22
|
+
| `basicAuthenticationParameters` | `{ username: string, password: string }` (optional) | Parameters for basic authentication | N/A | No |
|
|
23
|
+
| `jwtAuthenticationParameters` | `{ jwtRequestCallback: () => string \| object, authenticationId: string }` (optional) | Parameters for JWT authentication | N/A | No |
|
|
24
|
+
| `logger` | ``(logLevel: 'log' \| 'debug' \| 'info' \| 'warn' \| 'error', message: string, ...args: unknown[]) => void`` (optional) | If provided, will defer to this logger, otherwise logs to `console.debug`, reduced by LogLevel | `console.debug` | No |
|
|
25
|
+
| `logLevel` | ``'log' \| 'debug' \| 'info' \| 'warn' \| 'error'`` (optional) | The level at which cloud-interop override will log. | `'warn'` | No |
|
|
26
|
+
|
|
8
27
|
|
|
9
28
|
## Usage
|
|
10
29
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@openfin/cloud-interop",
|
|
3
|
-
"version": "0.42.
|
|
3
|
+
"version": "0.42.3",
|
|
4
4
|
"description": "",
|
|
5
5
|
"private": false,
|
|
6
6
|
"files": [
|
|
@@ -20,9 +20,9 @@
|
|
|
20
20
|
"author": "",
|
|
21
21
|
"license": "SEE LICENSE IN LICENSE.md",
|
|
22
22
|
"peerDependencies": {
|
|
23
|
-
"@openfin/core": "42.100.
|
|
23
|
+
"@openfin/core": "42.100.4"
|
|
24
24
|
},
|
|
25
25
|
"dependencies": {
|
|
26
|
-
"@openfin/cloud-interop-core-api": "0.0.1-alpha.
|
|
26
|
+
"@openfin/cloud-interop-core-api": "0.0.1-alpha.05c8c77"
|
|
27
27
|
}
|
|
28
28
|
}
|