@openfin/cloud-interop 0.41.102 → 0.41.103

package/out/logger.d.ts

@@ -0,0 +1,17 @@
+import { LogLevel as CloudAPILogLevel } from '@openfin/cloud-interop-core-api';
+export declare const enum LogLevel {
+    WARN = 0,
+    INFO = 1,
+    DEBUG = 2
+}
+export interface LogSink {
+    log: (logLevel: CloudAPILogLevel, message: string, ...args: unknown[]) => void;
+}
+/**
+ * This logger retrofits on top of the CloudAPILogger function signature so it must use CloudAPILogLevel inputs
+ */
+export declare class Logger implements LogSink {
+    private readonly logLevel;
+    constructor(level?: CloudAPILogLevel);
+    log(logLevel: CloudAPILogLevel, message: string, ...args: unknown[]): void;
+}

package/out/override.d.ts

@@ -1,11 +1,43 @@
-import { ConnectParameters } from '@openfin/cloud-interop-core-api';
+import { LogLevel as CloudAPILogLevel, ConnectParameters } from '@openfin/cloud-interop-core-api';
 import type OpenFin from '@openfin/core';
-export type CloudInteropOverrideParams = ConnectParameters & {
+import { LogSink } from './logger';
+type ConnectParametersNoLogger = Omit<ConnectParameters, 'logger'>;
+export type CloudInteropOverrideParams = ConnectParametersNoLogger & {
+    /**
+     * URL of the Cloud Interop service
+     */
     url: string;
+    /**
+     * How long to wait for connected clients to respond, defaults to 3 seconds.
+     * Do not make this number too high, as it will block findIntent/findIntentsByContext calls
+     */
+    findIntentTimeout?: number;
+    /**
+     * If provided will defer to this logger, otherwise logs to console.debug, reduced by LogLevel
+     */
+    logger?: LogSink;
+    /**
+     * The level which cloud-interop override will log. Defaults to 'warn'
+     */
+    logLevel?: CloudAPILogLevel;
 };
 export type CloudInteropConnectionStates = 'connected' | 'reconnecting' | 'disconnected';
 /**
  * Enhances InteropBroker with Cloud Interop functionality
+ *
+ * Ensure that CloudInteropOverride comes first in the list of composable overrides, for example:
+ * ```
+ * const CloudInteropOverride = await cloudInteropOverride(settings);
+ * await fin.Platform.init({
+ *     ...,
+ *     interopOverride: [
+ *         CloudInteropOverride, // <--- must come first
+ *         (BaseProvider) => class MyCustomProvider extends BaseProvider { ... }
+ *     ]
+ * });
+ * ```
+ *
  * @param {CloudInteropOverrideParams} config Configuration to connect to the Cloud Interop service
  */
 export declare function cloudInteropOverride(config: CloudInteropOverrideParams): Promise<OpenFin.ConstructorOverride<OpenFin.InteropBroker>>;
+export {};

package/out/utils.d.ts

@@ -0,0 +1,2 @@
+import type { v2_0 as FDC3v2 } from '@openfin/fdc3';
+export declare const isContext: (chan: unknown) => chan is FDC3v2.Context;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/cloud-interop",
-    "version": "0.41.102",
+    "version": "0.41.103",
     "description": "",
     "private": false,
     "files": [
@@ -11,6 +11,7 @@
     "scripts": {
         "prebuild": "rimraf out",
         "build": "rollup -c",
+        "watch": "rollup -c --watch",
         "ci:prepublish": "of-npm prepublish",
         "ci:postpublish": "of-npm postpublish",
         "ci:publish": "npm publish",
@@ -19,9 +20,9 @@
     "author": "",
     "license": "SEE LICENSE IN LICENSE.md",
     "peerDependencies": {
-        "@openfin/core": "41.100.100"
+        "@openfin/core": "41.100.101"
     },
     "dependencies": {
-        "@openfin/cloud-interop-core-api": "^0.0.1-alpha.fba3468"
+        "@openfin/cloud-interop-core-api": "0.0.1-alpha.79a6af0"
     }
 }