@openfin/fdc3-api 36.79.15 → 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

@@ -88,12 +88,21 @@ declare type Api = {
     iframe?: {
         /**
          * Inject OpenFin API into cross-origin iframes
+         *
+         * @defaultValue false
          */
         crossOriginInjection?: boolean;
         /**
          * Inject OpenFin API into same-origin iframes
+         *
+         * @defaultValue true
          */
         sameOriginInjection?: boolean;
+        /**
+         * @deprecated Shared names should not be used; support is provided purely for back-compat reasons.
+         *
+         * When `true`, iframes will have the same name as their parent WebContents.
+         */
         enableDeprecatedSharedName?: boolean;
     };
     /**
@@ -1668,9 +1677,9 @@ declare class Base {
      * on the context in which the devtools panel was opened.
      */
     get me(): Identity;
-    protected isNodeEnvironment: () => boolean;
-    protected isOpenFinEnvironment: () => boolean;
-    protected isBrowserEnvironment: () => boolean;
+    /* Excluded from this release type: isNodeEnvironment */
+    /* Excluded from this release type: isOpenFinEnvironment */
+    /* Excluded from this release type: isBrowserEnvironment */
 }
 
 /**
@@ -5202,8 +5211,14 @@ declare interface Environment {
     getRtcPeer(): RTCPeerConnection;
     getWsConstructor(): typeof WebSocket;
     whenReady(): Promise<void>;
+    getInteropInfo(fin: OpenFin.Fin<OpenFin.EntityType>): Promise<InternalInteropBrokerOptions & {
+        fdc3Version?: Fdc3Version;
+    }>;
+    readonly type: EnvironmentType;
 }
 
+declare type EnvironmentType = 'node' | 'openfin' | 'other';
+
 declare type ErrorMiddleware = OpenFin.ErrorMiddleware;
 
 declare type ErrorMiddleware_2 = (topic: string, error: Error, id: ProviderIdentity_7 | ClientIdentity) => unknown;
@@ -5607,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
@@ -7320,6 +7337,15 @@ declare class InterApplicationBus extends Base {
 
 declare type InternalConnectConfig = ExistingConnectConfig | NewConnectConfig;
 
+declare type InternalFDC3Info = {
+    providerVersion: string;
+    provider: string;
+};
+
+declare type InternalInteropBrokerOptions = OpenFin.InteropBrokerOptions & {
+    fdc3Info: InternalFDC3Info;
+};
+
 /**
  * Define whether to enable interop action logging.
  *
@@ -7448,6 +7474,7 @@ declare type InteropActionLoggingOption = {
  *
  */
 declare class InteropBroker extends Base {
+    #private;
     private getProvider;
     private interopClients;
     private contextGroupsById;

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

@@ -88,12 +88,21 @@ declare type Api = {
     iframe?: {
         /**
          * Inject OpenFin API into cross-origin iframes
+         *
+         * @defaultValue false
          */
         crossOriginInjection?: boolean;
         /**
          * Inject OpenFin API into same-origin iframes
+         *
+         * @defaultValue true
          */
         sameOriginInjection?: boolean;
+        /**
+         * @deprecated Shared names should not be used; support is provided purely for back-compat reasons.
+         *
+         * When `true`, iframes will have the same name as their parent WebContents.
+         */
         enableDeprecatedSharedName?: boolean;
     };
     /**
@@ -1668,9 +1677,9 @@ declare class Base {
      * on the context in which the devtools panel was opened.
      */
     get me(): Identity;
-    protected isNodeEnvironment: () => boolean;
-    protected isOpenFinEnvironment: () => boolean;
-    protected isBrowserEnvironment: () => boolean;
+    /* Excluded from this release type: isNodeEnvironment */
+    /* Excluded from this release type: isOpenFinEnvironment */
+    /* Excluded from this release type: isBrowserEnvironment */
 }
 
 /**
@@ -5202,8 +5211,14 @@ declare interface Environment {
     getRtcPeer(): RTCPeerConnection;
     getWsConstructor(): typeof WebSocket;
     whenReady(): Promise<void>;
+    getInteropInfo(fin: OpenFin.Fin<OpenFin.EntityType>): Promise<InternalInteropBrokerOptions & {
+        fdc3Version?: Fdc3Version;
+    }>;
+    readonly type: EnvironmentType;
 }
 
+declare type EnvironmentType = 'node' | 'openfin' | 'other';
+
 declare type ErrorMiddleware = OpenFin.ErrorMiddleware;
 
 declare type ErrorMiddleware_2 = (topic: string, error: Error, id: ProviderIdentity_7 | ClientIdentity) => unknown;
@@ -5607,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
@@ -7320,6 +7337,15 @@ declare class InterApplicationBus extends Base {
 
 declare type InternalConnectConfig = ExistingConnectConfig | NewConnectConfig;
 
+declare type InternalFDC3Info = {
+    providerVersion: string;
+    provider: string;
+};
+
+declare type InternalInteropBrokerOptions = OpenFin.InteropBrokerOptions & {
+    fdc3Info: InternalFDC3Info;
+};
+
 /**
  * Define whether to enable interop action logging.
  *
@@ -7448,6 +7474,7 @@ declare type InteropActionLoggingOption = {
  *
  */
 declare class InteropBroker extends Base {
+    #private;
     private getProvider;
     private interopClients;
     private contextGroupsById;

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

@@ -88,12 +88,21 @@ declare type Api = {
     iframe?: {
         /**
          * Inject OpenFin API into cross-origin iframes
+         *
+         * @defaultValue false
          */
         crossOriginInjection?: boolean;
         /**
          * Inject OpenFin API into same-origin iframes
+         *
+         * @defaultValue true
          */
         sameOriginInjection?: boolean;
+        /**
+         * @deprecated Shared names should not be used; support is provided purely for back-compat reasons.
+         *
+         * When `true`, iframes will have the same name as their parent WebContents.
+         */
         enableDeprecatedSharedName?: boolean;
     };
     /**
@@ -1668,9 +1677,9 @@ declare class Base {
      * on the context in which the devtools panel was opened.
      */
     get me(): Identity;
-    protected isNodeEnvironment: () => boolean;
-    protected isOpenFinEnvironment: () => boolean;
-    protected isBrowserEnvironment: () => boolean;
+    /* Excluded from this release type: isNodeEnvironment */
+    /* Excluded from this release type: isOpenFinEnvironment */
+    /* Excluded from this release type: isBrowserEnvironment */
 }
 
 /**
@@ -5202,8 +5211,14 @@ declare interface Environment {
     getRtcPeer(): RTCPeerConnection;
     getWsConstructor(): typeof WebSocket;
     whenReady(): Promise<void>;
+    getInteropInfo(fin: OpenFin.Fin<OpenFin.EntityType>): Promise<InternalInteropBrokerOptions & {
+        fdc3Version?: Fdc3Version;
+    }>;
+    readonly type: EnvironmentType;
 }
 
+declare type EnvironmentType = 'node' | 'openfin' | 'other';
+
 declare type ErrorMiddleware = OpenFin.ErrorMiddleware;
 
 declare type ErrorMiddleware_2 = (topic: string, error: Error, id: ProviderIdentity_7 | ClientIdentity) => unknown;
@@ -5607,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
@@ -7320,6 +7337,15 @@ declare class InterApplicationBus extends Base {
 
 declare type InternalConnectConfig = ExistingConnectConfig | NewConnectConfig;
 
+declare type InternalFDC3Info = {
+    providerVersion: string;
+    provider: string;
+};
+
+declare type InternalInteropBrokerOptions = OpenFin.InteropBrokerOptions & {
+    fdc3Info: InternalFDC3Info;
+};
+
 /**
  * Define whether to enable interop action logging.
  *
@@ -7448,6 +7474,7 @@ declare type InteropActionLoggingOption = {
  *
  */
 declare class InteropBroker extends Base {
+    #private;
     private getProvider;
     private interopClients;
     private contextGroupsById;

package/out/fdc3-api.d.ts

@@ -88,12 +88,21 @@ declare type Api = {
     iframe?: {
         /**
          * Inject OpenFin API into cross-origin iframes
+         *
+         * @defaultValue false
          */
         crossOriginInjection?: boolean;
         /**
          * Inject OpenFin API into same-origin iframes
+         *
+         * @defaultValue true
          */
         sameOriginInjection?: boolean;
+        /**
+         * @deprecated Shared names should not be used; support is provided purely for back-compat reasons.
+         *
+         * When `true`, iframes will have the same name as their parent WebContents.
+         */
         enableDeprecatedSharedName?: boolean;
     };
     /**
@@ -1688,8 +1697,20 @@ declare class Base {
      * on the context in which the devtools panel was opened.
      */
     get me(): Identity;
+    /**
+     * @internal
+     * @deprecated
+     */
     protected isNodeEnvironment: () => boolean;
+    /**
+     * @internal
+     * @deprecated
+     */
     protected isOpenFinEnvironment: () => boolean;
+    /**
+     * @internal
+     * @deprecated
+     */
     protected isBrowserEnvironment: () => boolean;
 }
 
@@ -5250,8 +5271,14 @@ declare interface Environment {
     getRtcPeer(): RTCPeerConnection;
     getWsConstructor(): typeof WebSocket;
     whenReady(): Promise<void>;
+    getInteropInfo(fin: OpenFin.Fin<OpenFin.EntityType>): Promise<InternalInteropBrokerOptions & {
+        fdc3Version?: Fdc3Version;
+    }>;
+    readonly type: EnvironmentType;
 }
 
+declare type EnvironmentType = 'node' | 'openfin' | 'other';
+
 declare type ErrorMiddleware = OpenFin.ErrorMiddleware;
 
 declare type ErrorMiddleware_2 = (topic: string, error: Error, id: ProviderIdentity_7 | ClientIdentity) => unknown;
@@ -5676,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
@@ -7410,6 +7439,15 @@ declare class InterAppPayload {
 
 declare type InternalConnectConfig = ExistingConnectConfig | NewConnectConfig;
 
+declare type InternalFDC3Info = {
+    providerVersion: string;
+    provider: string;
+};
+
+declare type InternalInteropBrokerOptions = OpenFin.InteropBrokerOptions & {
+    fdc3Info: InternalFDC3Info;
+};
+
 /**
  * Define whether to enable interop action logging.
  *
@@ -7538,6 +7576,7 @@ declare type InteropActionLoggingOption = {
  *
  */
 declare class InteropBroker extends Base {
+    #private;
     private getProvider;
     private interopClients;
     private contextGroupsById;
@@ -7549,7 +7588,7 @@ declare class InteropBroker extends Base {
     /**
      * @internal
      */
-    constructor(wire: Transport, getProvider: () => Promise<OpenFin.ChannelProvider>, options?: any);
+    constructor(wire: Transport, getProvider: () => Promise<OpenFin.ChannelProvider>, options: InternalInteropBrokerOptions);
     static createClosedConstructor(...args: ConstructorParameters<typeof InteropBroker>): {
         new (): InteropBroker;
     };

package/out/fdc3-api.js

@@ -57,14 +57,26 @@ class Base {
      * @internal
      */
     constructor(wire) {
+        /**
+         * @internal
+         * @deprecated
+         */
         this.isNodeEnvironment = () => {
-            return this.wire.environment.constructor.name === 'NodeEnvironment';
+            return this.wire.environment.type === 'node';
         };
+        /**
+         * @internal
+         * @deprecated
+         */
         this.isOpenFinEnvironment = () => {
-            return this.wire.environment.constructor.name === 'OpenFinEnvironment';
+            return this.wire.environment.type === 'openfin';
         };
+        /**
+         * @internal
+         * @deprecated
+         */
         this.isBrowserEnvironment = () => {
-            return this.wire.environment.constructor.name === 'BrowserEnvironment';
+            return this.wire.environment.type === 'other';
         };
         this.wire = wire;
     }
@@ -622,12 +634,12 @@ PrivateChannelClient$1.PrivateChannelClient = PrivateChannelClient;
 	const getIntentResolution = async (interopModule, context, app, intent) => {
 	    // Generate an ID to make a session context group with. We will pass that ID to the Broker.
 	    // The broker will then setContext on that session context group later with our Intent Result,
-	    const guid = (0, utils_1.generateId)();
+	    const guid = (0, utils_1.generateId)(); // TODO make this undefined in web
 	    // Promise we'll use in getResult
-	    const getResultPromise = new Promise((resolve) => {
+	    const getResultPromise = new Promise((resolve, reject) => {
 	        fin.InterApplicationBus.subscribe({ uuid: '*' }, guid, (intentResult) => {
 	            resolve(intentResult);
-	        });
+	        }).catch(() => reject(new Error('getResult is not supported in this environment')));
 	    });
 	    // Adding the intentResolutionResultId to the intentObj. Because fireIntent only accepts a single arg, we have to slap it in here.
 	    const metadata = app ? { target: app, intentResolutionResultId: guid } : { intentResolutionResultId: guid };
@@ -1526,7 +1538,7 @@ class Fdc3Module extends base_1$1.Base {
             const { metadata } = context;
             const intentResolutionResultId = intentMetadata?.intentResolutionResultId || metadata?.intentResolutionResultId;
             if (intentResolutionResultId) {
-                this.fin.InterApplicationBus.publish(intentResolutionResultId, null);
+                this.fin.InterApplicationBus.publish(intentResolutionResultId, null).catch(() => null);
             }
             handler(raisedIntent.context);
         };
@@ -2017,7 +2029,7 @@ class Fdc3Module2 extends base_1.Base {
                 intentResultToSend = { error: true };
             }
             if (intentResolutionResultId) {
-                this.fin.InterApplicationBus.publish(intentResolutionResultId, intentResultToSend);
+                this.fin.InterApplicationBus.publish(intentResolutionResultId, intentResultToSend).catch(() => null);
             }
             if (intentResult instanceof Error) {
                 throw new Error(intentResult.message);
@@ -2152,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.15",
+    "version": "36.79.18",
     "description": "OpenFin fdc3 module utilities and types.",
     "license": "SEE LICENSE IN LICENSE.MD",
     "private": false,