@finsemble/finsemble-ui 8.2.1 → 8.3.0-beta.1

package/clients/Interop/FinsembleDesktopAgent.d.ts

@@ -1,6 +1,11 @@
-import { Channel, DesktopAgent, Context, ContextHandler, Listener, AppIntent, IntentResolution, ImplementationMetadata, TargetApp } from "@finos/fdc3";
+import { Channel, DesktopAgent, Context, ContextHandler, Listener, AppIntent, IntentResolution, ImplementationMetadata, AppMetadata, IntentHandler } from "@finos/fdc3";
 import { IRouterClient } from "../routerClient";
 import { Startup } from "../Startup/Startup";
+import { StandardError } from "../../types";
+import { InteropMessage } from "./types";
+import { AppIdentifier } from "../../typedefs/FDC3/api/AppIdentifier";
+import { PrivateChannel } from "../../typedefs/FDC3/api/PrivateChannel";
+export declare type ChannelContextHandler = (context: Context) => void;
 /**
  * See https://stackoverflow.com/questions/45847399/friend-class-in-typescript for implementation of "friend" class
  */
@@ -10,12 +15,14 @@ export declare class FinsembleDesktopAgent implements DesktopAgent {
         routerClient: IRouterClient;
         startup: Startup;
     });
-    cacheFSBLVersion(): Promise<void>;
-    private fdc3Error;
+    private privateChannelId;
+    private fetchStartupData;
     private meta;
     private handleHeartbeat;
     private triggerContextListeners;
-    private triggerIntentListeners;
+    private triggerIntentListener;
+    private handlePrivateChannelEvent;
+    private handleIntentResult;
     private handleIncoming;
     /**
      * Releases the queue, sending API calls to the interop service that had been deferred until a connection
@@ -64,13 +71,17 @@ export declare class FinsembleDesktopAgent implements DesktopAgent {
      * Apps can still directly broadcast and listen to context on any channel via the methods on the Channel class.
      * @param context
      */
-    broadcast(context: Context): void;
+    broadcast(context: Context): Promise<void>;
     /** @internal */
-    channelBroadcast(channel: string, context: Context): void;
+    channelBroadcast(channel: string, context: Context): Promise<void>;
     /**
      * Retrieves a list of the System channels available for the app to join.
      * This should include the 'global' channel.
      */
+    getUserChannels(): Promise<Channel[]>;
+    /**
+     * For backwards compatability.  Retrieves a list of the System channels available for the app to join.
+     */
     getSystemChannels(): Promise<Channel[]>;
     /**
      * Launches/links to an app by name.
@@ -78,10 +89,11 @@ export declare class FinsembleDesktopAgent implements DesktopAgent {
      * The Context argument is functionally equivalent to opening the target app with no context and broadcasting the context directly to it.
      * If opening errors, it returns an Error with a string from the OpenError enumeration.
      *
-     * @param target
+     * @param app
      * @param context
      */
-    open(target: TargetApp, context?: Context): Promise<void>;
+    open(app: string, context?: Context): Promise<AppIdentifier>;
+    open(app: AppIdentifier, context?: Context): Promise<AppIdentifier>;
     /**
      * Find out more information about a particular intent by passing its name, and optionally its context.
      *
@@ -94,7 +106,7 @@ export declare class FinsembleDesktopAgent implements DesktopAgent {
      * @param intent
      * @param context
      */
-    findIntent(intent: string, context?: Context): Promise<AppIntent>;
+    findIntent(intent: string, context?: Context, resultType?: string): Promise<AppIntent>;
     /**
      * Find all the available intents for a particular context.
      *
@@ -105,14 +117,24 @@ export declare class FinsembleDesktopAgent implements DesktopAgent {
      * If the resolution fails, the promise will return an `Error` with a string from the `ResolveError` enumeration.
      * @param context
      */
-    findIntentsByContext(context: Context): Promise<Array<AppIntent>>;
+    findIntentsByContext(context: Context, resultType?: string): Promise<Array<AppIntent>>;
+    createPrivateChannel(): Promise<PrivateChannel>;
+    /**
+     * Common implementation for raiseIntent() and raiseIntentForContext().
+     *
+     * @param intent
+     * @param context
+     * @param target
+     */
+    private raiseIntentInternal;
     /**
      * Raises an intent to the desktop agent to resolve.
      * @param intent
      * @param context
      * @param target
      */
-    raiseIntent(intent: string, context: Context, target?: TargetApp): Promise<IntentResolution>;
+    raiseIntent(intent: string, context: Context, target?: AppIdentifier): Promise<IntentResolution>;
+    raiseIntent(intent: string, context: Context, target?: String): Promise<IntentResolution>;
     /**
      * Finds and raises an intent against a target app based purely on context data.
      *
@@ -121,22 +143,37 @@ export declare class FinsembleDesktopAgent implements DesktopAgent {
      * @param context
      * @param target
      */
-    raiseIntentForContext(context: Context, target?: TargetApp): Promise<IntentResolution>;
+    raiseIntentForContext(context: Context, target?: AppIdentifier): Promise<IntentResolution>;
+    raiseIntentForContext(context: Context, target?: String): Promise<IntentResolution>;
     /**
-     * Adds a listener for incoming Intents from the Agent.
+     * Adds a listener for incoming Intents from the Agent.  Unlike addContextListener, there can only be one listener for an intent.
      * @param intent
      * @param handler
      */
-    addIntentListener(intent: string, handler: ContextHandler): Listener;
+    addIntentListener(intent: string, handler: IntentHandler): Promise<Listener>;
+    private listenerForPrivateChannelEvent;
     /** @internal */
-    channelAddContextListener(channel: string | null, contextTypeOrHandler: string | null | ContextHandler, handler?: ContextHandler): Listener;
+    channelOnAddContextListener(channel: string, handler: (contextType?: string) => void): Listener;
+    /** @internal */
+    channelOnUnsubscribe(channel: string, handler: (contextType?: string) => void): Listener;
+    /** @internal */
+    channelOnDisconnect(channel: string, handler: () => void): Listener;
+    /** @internal */
+    channelDisconnect(channel: string): void;
+    /** @internal */
+    channelAddContextListener(channel: string | null, contextTypeOrHandler: string | null | ContextHandler, handler?: ContextHandler): Listener & {
+        exchangePromise: Promise<{
+            err?: StandardError;
+            receiveMessage?: InteropMessage | undefined;
+        }>;
+    };
     /**
      * Adds a listener for incoming context broadcast from the Desktop Agent.
      * If the consumer is only interested in a context of a particular type, they can use the relevant overload that allows the type to be specified.
      * @param contextTypeOrHandler
      * @param handler
      */
-    addContextListener(contextTypeOrHandler: string | null | ContextHandler, handler?: ContextHandler): Listener;
+    addContextListener(contextTypeOrHandler: string | null | ContextHandler, handler?: ContextHandler): Promise<Listener>;
     /**
      * Joins the app to the specified channel.
      * If an app is joined to a channel, all fdc3.broadcast calls will go to the channel, and all listeners assigned via fdc3.addContextListener will listen on the channel.
@@ -145,6 +182,7 @@ export declare class FinsembleDesktopAgent implements DesktopAgent {
      * Error with a string from the ChannelError enumeration.
      * @param channelId
      */
+    joinUserChannel(channelId: string): Promise<void>;
     joinChannel(channelId: string): Promise<void>;
     /**
      * Returns a Channel object for the specified channel, creating it (as an App channel) - if it does not exist.
@@ -153,8 +191,6 @@ export declare class FinsembleDesktopAgent implements DesktopAgent {
      */
     getOrCreateChannel(channelId: string): Promise<Channel>;
     /**
-     * FDC3 2.0 pre-release
-     *
      * Get all joined channels
      *
      * Known race condition: getCurrentChannels() can return an empty string if it is called before the InteropService's linker module
@@ -173,11 +209,19 @@ export declare class FinsembleDesktopAgent implements DesktopAgent {
      * Context broadcast and listening through the top-level fdc3.broadcast and fdc3.addContextListener will be in a no-op when the app is not on a channel.
      */
     leaveCurrentChannel(): Promise<void>;
+    /**
+     * Return specified app's meta data.
+     */
+    getAppMetadata(app: AppIdentifier): Promise<AppMetadata>;
+    /**
+     * Return all the open instances of given appID.
+     */
+    findInstances(app: AppIdentifier): Promise<Array<AppIdentifier>>;
     /**
      * Retrieves information about the FDC3 Desktop Agent implementation, such as
      * the implemented version of the FDC3 specification and the name of the implementation
      * provider.
      */
-    getInfo(): ImplementationMetadata;
+    getInfo(): Promise<ImplementationMetadata>;
 }
 //# sourceMappingURL=FinsembleDesktopAgent.d.ts.map

package/clients/Interop/FinsembleDesktopAgent.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FinsembleDesktopAgent.d.ts","sourceRoot":"","sources":["../../../../src/clients/Interop/FinsembleDesktopAgent.ts"],"names":[],"mappings":"AACA,OAAO,EACN,OAAO,EAEP,YAAY,EACZ,OAAO,EACP,cAAc,EACd,QAAQ,EACR,SAAS,EACT,gBAAgB,EAChB,sBAAsB,EACtB,SAAS,EAGT,MAAM,aAAa,CAAC;AAErB,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAsK7C;;GAEG;AACH,qBAAa,qBAAsB,YAAW,YAAY;;gBA+B7C,EAAE,YAAY,EAAE,OAAO,EAAE,EAAE;QAAE,YAAY,EAAE,aAAa,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAE;IAgBlF,gBAAgB;IAatB,OAAO,CAAC,SAAS;IAIjB,OAAO,CAAC,IAAI;IAOZ,OAAO,CAAC,eAAe;IAIvB,OAAO,CAAC,uBAAuB;IAsD/B,OAAO,CAAC,sBAAsB;IAO9B,OAAO,CAAC,cAAc;IAkBtB;;;OAGG;IACH,OAAO,CAAC,YAAY;IAoBpB;;;;OAIG;IACH,OAAO,CAAC,QAAQ;IAiBhB;;;OAGG;YACW,OAAO;IAsErB;;;;;OAKG;IACG,KAAK;IAYX;;;;OAIG;IACG,IAAI;IAYV;;;;;;;OAOG;IACH,YAAY,CAAC,EAAE,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI;IAIxC,gBAAgB;IACV,wBAAwB,CAAC,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,GAAG,IAAI,GAAG,SAAS,CAAC;IAiB1G;;;;;;OAMG;IACH,SAAS,CAAC,OAAO,EAAE,OAAO;IAc1B,gBAAgB;IAChB,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;IAclD;;;OAGG;IACG,iBAAiB,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAa7C;;;;;;;;OAQG;IACG,IAAI,CAAC,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAqB/D;;;;;;;;;;;OAWG;IACG,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC;IA0BvE;;;;;;;;;OASG;IACG,oBAAoB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IAuBvE;;;;;OAKG;IACG,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC,gBAAgB,CAAC;IA+BlG;;;;;;;OAOG;IACG,qBAAqB,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC,gBAAgB,CAAC;IA0B5F;;;;OAIG;IACH,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc,GAAG,QAAQ;IAmCpE,gBAAgB;IAChB,yBAAyB,CACxB,OAAO,EAAE,MAAM,GAAG,IAAI,EACtB,oBAAoB,EAAE,MAAM,GAAG,IAAI,GAAG,cAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACtB,QAAQ;IA2CX;;;;;OAKG;IACH,kBAAkB,CAAC,oBAAoB,EAAE,MAAM,GAAG,IAAI,GAAG,cAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,QAAQ;IAY5G;;;;;;;OAOG;IACG,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAcnD;;;;OAIG;IACG,kBAAkB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAO7D;;;;;;;;;OASG;IACG,kBAAkB,IAAI,OAAO,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC;IAoBrD;;;OAGG;IACG,iBAAiB,IAAI,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC;IAKlD;;;OAGG;IACG,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC;IAS1C;;;;OAIG;IACH,OAAO,IAAI,sBAAsB;CAQjC"}
+{"version":3,"file":"FinsembleDesktopAgent.d.ts","sourceRoot":"","sources":["../../../../src/clients/Interop/FinsembleDesktopAgent.ts"],"names":[],"mappings":"AAWA,OAAO,EACN,OAAO,EAEP,YAAY,EACZ,OAAO,EACP,cAAc,EACd,QAAQ,EACR,SAAS,EACT,gBAAgB,EAChB,sBAAsB,EACtB,WAAW,EAGX,aAAa,EAIb,MAAM,aAAa,CAAC;AAErB,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAoB,aAAa,EAAE,MAAM,aAAa,CAAC;AAK9D,OAAO,EAEN,cAAc,EAwCd,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,aAAa,EAAE,MAAM,uCAAuC,CAAC;AACtE,OAAO,EAAE,cAAc,EAAE,MAAM,wCAAwC,CAAC;AAiNxE,oBAAY,qBAAqB,GAAG,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;AAE/D;;GAEG;AACH,qBAAa,qBAAsB,YAAW,YAAY;;gBAgD7C,EAAE,YAAY,EAAE,OAAO,EAAE,EAAE;QAAE,YAAY,EAAE,aAAa,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAE;IAaxF,OAAO,CAAC,gBAAgB;YAKV,gBAAgB;IAmB9B,OAAO,CAAC,IAAI;IAOZ,OAAO,CAAC,eAAe;IAIvB,OAAO,CAAC,uBAAuB;YAuDjB,qBAAqB;YA2FrB,yBAAyB;YA2BzB,kBAAkB;IAiBhC,OAAO,CAAC,cAAc;IAwBtB;;;OAGG;IACH,OAAO,CAAC,YAAY;IAqBpB;;;;OAIG;IACH,OAAO,CAAC,QAAQ;IAiBhB;;;OAGG;YACW,OAAO;IAsErB;;;;;OAKG;IACG,KAAK;IAYX;;;;OAIG;IACG,IAAI;IAYV;;;;;;;OAOG;IACH,YAAY,CAAC,EAAE,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI;IAIxC,gBAAgB;IACV,wBAAwB,CAAC,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,GAAG,IAAI,GAAG,SAAS,CAAC;IAiB1G;;;;;;OAMG;IACG,SAAS,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAchD,gBAAgB;IACV,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;IAcxD;;;OAGG;IACG,eAAe,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAa3C;;OAEG;IACG,iBAAiB,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAI7C;;;;;;;;OAQG;IACG,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC;IAE5D,IAAI,CAAC,GAAG,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC;IA4BzE;;;;;;;;;;;OAWG;IACG,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAiC5F;;;;;;;;;OASG;IACG,oBAAoB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IA+BtF,oBAAoB,IAAI,OAAO,CAAC,cAAc,CAAC;IAIrD;;;;;;OAMG;YACW,mBAAmB;IA8FjC;;;;;OAKG;IACG,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAEhG,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAgB/F;;;;;;;OAOG;IACG,qBAAqB,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAE1F,qBAAqB,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IASzF;;;;OAIG;IACH,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,QAAQ,CAAC;IAsD5E,OAAO,CAAC,8BAA8B;IA0CtC,gBAAgB;IAChB,2BAA2B,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,WAAW,CAAC,EAAE,MAAM,KAAK,IAAI,GAAG,QAAQ;IAI/F,gBAAgB;IAChB,oBAAoB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,WAAW,CAAC,EAAE,MAAM,KAAK,IAAI,GAAG,QAAQ;IAIxF,gBAAgB;IAChB,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,IAAI,GAAG,QAAQ;IAInE,gBAAgB;IAChB,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IASxC,gBAAgB;IAChB,yBAAyB,CACxB,OAAO,EAAE,MAAM,GAAG,IAAI,EACtB,oBAAoB,EAAE,MAAM,GAAG,IAAI,GAAG,cAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACtB,QAAQ,GAAG;QACb,eAAe,EAAE,OAAO,CAAC;YACxB,GAAG,CAAC,EAAE,aAAa,CAAC;YACpB,cAAc,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;SAC5C,CAAC,CAAC;KACH;IA4CD;;;;;OAKG;IAEH,kBAAkB,CACjB,oBAAoB,EAAE,MAAM,GAAG,IAAI,GAAG,cAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACtB,OAAO,CAAC,QAAQ,CAAC;IA2BpB;;;;;;;OAOG;IACG,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAkCjD,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAInD;;;;OAIG;IACG,kBAAkB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAkB7D;;;;;;;OAOG;IACG,kBAAkB,IAAI,OAAO,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC;IAkBrD;;;OAGG;IACG,iBAAiB,IAAI,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC;IAKlD;;;OAGG;IACG,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC;IAS1C;;OAEG;IACG,cAAc,CAAC,GAAG,EAAE,aAAa,GAAG,OAAO,CAAC,WAAW,CAAC;IAsB9D;;OAEG;IACG,aAAa,CAAC,GAAG,EAAE,aAAa,GAAG,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;IAetE;;;;OAIG;IACH,OAAO,IAAI,OAAO,CAAC,sBAAsB,CAAC;CA2B1C"}