@openfin/cloud-interop - npm Package Compare versions

Comparing version 0.42.1 to 0.42.2

package.json

 {
     "name": "@openfin/cloud-interop",
-    "version": "0.42.1",
+    "version": "0.42.2",
     "description": "",
@@ -23,3 +23,3 @@ "private": false,
     "peerDependencies": {
-        "@openfin/core": "42.100.2"
+        "@openfin/core": "42.100.3"
     },
@@ -26,0 +26,0 @@ "dependencies": {

README.md

@@ -7,4 +7,23 @@ # @openfin/cloud-interop
 
-Once overriden the `InteropBroker` will connect to the given Cloud Interop Service upon initialization. `Context` will be sent to the Cloud Interop server and the broker will receive `Context` updates from other any other connected brokers in the shared session.
+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.
 
+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.
+
+## Override Options
+
+| Option                             | Type                                                           | Description                                                                                   | Default Value     | Required |
+|------------------------------------|----------------------------------------------------------------|-----------------------------------------------------------------------------------------------|-------------------|----------|
+| `url`                              | `string`                                                       | URL of the Cloud Interop service                                                              | N/A               | Yes      |
+| `platformId`                       | `string`                                                       | Platform ID                                                                                  | N/A               | Yes      |
+| `sourceId`                         | `string`                                                       | Source ID                                                                                     | N/A               | Yes      |
+| `reconnectRetryLimit`              | `number` (optional)                                            | Limit for reconnect retries                                                                   | N/A               | No       |
+| `keepAliveIntervalSeconds`         | `number` (optional)                                            | Interval in seconds to keep the connection alive                                              | N/A               | No       |
+| `findIntentTimeout`                | `number` (optional)                                            | How long to wait for connected clients to respond. Do not make this too high.                 | `3 seconds`       | No       |
+| `authenticationType`               | ``'jwt' \| 'basic' \| 'default'`` (optional)                   | Type of authentication to use                                                                  | N/A               | No       |
+| `basicAuthenticationParameters`    | `{ username: string, password: string }` (optional)            | Parameters for basic authentication                                                            | N/A               | No       |
+| `jwtAuthenticationParameters`      | `{ jwtRequestCallback: () => string \| object, authenticationId: string }` (optional) | Parameters for JWT authentication                                                               | N/A               | No       |
+| `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       |
+| `logLevel`                         | ``'log' \| 'debug' \| 'info' \| 'warn' \| 'error'`` (optional) | The level at which cloud-interop override will log.                                            | `'warn'`          | No       |
+
+
 ## Usage
@@ -11,0 +30,0 @@

No alert changes

Improved metrics

Total package byte prevSize

386163

increased by0.92%

Number of lines in readme file

123

increased by18.27%

No dependency changes