@openfin/fdc3-api 36.79.17 → 36.79.18

package/README.md

@@ -4,6 +4,8 @@ OpenFin FDC3 Client Library.
 
 ## How to use
 
+This package takes a reference to `fin` and uses the interop client found on `fin.me.interop` to instantiate an object matching the fdc3 spec.
+
 ```typescript
 import { fdc3FromFin } from '@openfin/fdc3-api';
 
@@ -11,3 +13,13 @@ const fdc3 = await fdc3FromFin(window.fin);
 
 window.fdc3 = fdc3;
 ```
+
+To specify a version of fdc3 you may pass the `fdc3Version` option. Supported options are '1.2' and '2.0'. Default is '2.0'.
+
+```typescript
+import { fdc3FromFin } from '@openfin/fdc3-api';
+
+const fdc3 = await fdc3FromFin(window.fin, { fdc3Version: '1.2'});
+
+window.fdc3 = fdc3;
+```

package/out/fdc3-api-alpha.d.ts

@@ -5622,7 +5622,9 @@ declare namespace FDC3 {
     }
 }
 
-export declare function fdc3FromFin(fin: OpenFin.Fin<OpenFin.EntityType>, version?: Fdc3Version): Promise<Fdc3Module | Fdc3Module2>;
+export declare function fdc3FromFin(fin: OpenFin.Fin<OpenFin.EntityType>, { fdc3Version }?: {
+    fdc3Version?: Fdc3Version;
+}): Promise<Fdc3Module | Fdc3Module2>;
 
 /**
  * @version 1.2

package/out/fdc3-api-beta.d.ts

@@ -5622,7 +5622,9 @@ declare namespace FDC3 {
     }
 }
 
-export declare function fdc3FromFin(fin: OpenFin.Fin<OpenFin.EntityType>, version?: Fdc3Version): Promise<Fdc3Module | Fdc3Module2>;
+export declare function fdc3FromFin(fin: OpenFin.Fin<OpenFin.EntityType>, { fdc3Version }?: {
+    fdc3Version?: Fdc3Version;
+}): Promise<Fdc3Module | Fdc3Module2>;
 
 /**
  * @version 1.2

package/out/fdc3-api-public.d.ts

@@ -5622,7 +5622,9 @@ declare namespace FDC3 {
     }
 }
 
-export declare function fdc3FromFin(fin: OpenFin.Fin<OpenFin.EntityType>, version?: Fdc3Version): Promise<Fdc3Module | Fdc3Module2>;
+export declare function fdc3FromFin(fin: OpenFin.Fin<OpenFin.EntityType>, { fdc3Version }?: {
+    fdc3Version?: Fdc3Version;
+}): Promise<Fdc3Module | Fdc3Module2>;
 
 /**
  * @version 1.2

package/out/fdc3-api.d.ts

@@ -5703,7 +5703,9 @@ declare namespace FDC3 {
     }
 }
 
-export declare function fdc3FromFin(fin: OpenFin.Fin<OpenFin.EntityType>, version?: Fdc3Version): Promise<Fdc3Module | Fdc3Module2>;
+export declare function fdc3FromFin(fin: OpenFin.Fin<OpenFin.EntityType>, { fdc3Version }?: {
+    fdc3Version?: Fdc3Version;
+}): Promise<Fdc3Module | Fdc3Module2>;
 
 /**
  * @version 1.2

package/out/fdc3-api.js

@@ -2164,9 +2164,9 @@ exports.Fdc3Module2 = fdc32_0.Fdc3Module2 = Fdc3Module2;
 	exports.getFdc3 = getFdc3; 
 } (fdc3));
 
-async function fdc3FromFin(fin, version) {
+async function fdc3FromFin(fin, { fdc3Version } = { fdc3Version: '2.0' }) {
     // @ts-expect-error
-    return fdc3.getFdc3(fin.wire, version);
+    return fdc3.getFdc3(fin.wire, fdc3Version);
 }
 
 exports.fdc3FromFin = fdc3FromFin;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/fdc3-api",
-    "version": "36.79.17",
+    "version": "36.79.18",
     "description": "OpenFin fdc3 module utilities and types.",
     "license": "SEE LICENSE IN LICENSE.MD",
     "private": false,