@openfin/core 31.74.22 → 31.74.23

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/core",
-    "version": "31.74.22",
+    "version": "31.74.23",
     "license": "SEE LICENSE IN LICENSE.MD",
     "main": "./src/mock.js",
     "types": "./src/mock.d.ts",

package/src/OpenFin.d.ts

@@ -1,21 +1,23 @@
-import type { Application } from './api/application';
+import type { Application } from './api/application/index';
 import { AppVersionEvent } from './api/events/system';
 import { TypedEventEmitter } from './api/events/typedEventEmitter';
-import type { ExternalApplication } from './api/external-application';
+import type { ExternalApplication } from './api/external-application/index';
 import { FinApi } from './api/fin';
-import type { _Frame } from './api/frame';
+import type { _Frame } from './api/frame/index';
 import type ChannelClient from './api/interappbus/channel/client';
-import { MessagingProtocols } from './api/interappbus/channel/protocols';
+import { MessagingProtocols } from './api/interappbus/channel/protocols/index';
 import type { ChannelProvider } from './api/interappbus/channel/provider';
-import type { InteropBroker, InteropClient } from './api/interop';
-import type { Platform } from './api/platform';
-import type { Layout } from './api/platform/layout';
+import type { InteropBroker, InteropClient } from './api/interop/index';
+import type { Platform } from './api/platform/index';
+import type { Layout } from './api/platform/layout/index';
 import { PlatformProvider } from './api/platform/provider';
-import { SnapshotSource } from './api/snapshot-source';
-import type { View } from './api/view';
-import { _Window } from './api/window';
+import { SnapshotSource } from './api/snapshot-source/index';
+import type { View } from './api/view/index';
+import { _Window } from './api/window/index';
+import { ColumnOrRow, TabStack } from './api/platform/layout/entities/layout-entities';
 export type Fin<MeType extends EntityType = 'window' | 'view'> = FinApi<MeType>;
-export type { Application, ExternalApplication, _Frame as Frame, ChannelClient, ChannelProvider, Platform, Layout, View, _Window as Window, InteropClient, InteropBroker, SnapshotSource };
+export type { Application, ExternalApplication, _Frame as Frame, ChannelClient, ChannelProvider, Platform, Layout, View, ColumnOrRow, TabStack, _Window as Window, InteropClient, InteropBroker, SnapshotSource };
+export type { LayoutEntityDefinition, LayoutEntityTypes, LayoutPosition } from './api/platform/layout/entities/shapes';
 export type WebContent = View | _Window;
 export type { PlatformProvider };
 export type ApplicationIdentity = {
@@ -244,7 +246,7 @@ export type DisplayMetadata = {
      */
     readonly glyph?: string;
 };
-export type LegacyWinOptionsInAppOptions = Pick<WindowCreationOptions, 'accelerator' | 'alwaysOnTop' | 'api' | 'aspectRatio' | 'autoplayPolicy' | 'autoShow' | 'backgroundColor' | 'contentNavigation' | 'contextMenu' | 'cornerRounding' | 'customData' | 'customRequestHeaders' | 'defaultCentered' | 'defaultHeight' | 'defaultLeft' | 'defaultTop' | 'defaultWidth' | 'frame' | 'hideOnClose' | 'icon' | 'maxHeight' | 'maximizable' | 'maxWidth' | 'minHeight' | 'minimizable' | 'minWidth' | 'opacity' | 'preloadScripts' | 'resizable' | 'resizeRegion' | 'saveWindowState' | 'ignoreSavedWindowState' | 'shadow' | 'showTaskbarIcon' | 'smallWindow' | 'state' | 'taskbarIconGroup' | 'waitForPageLoad'>;
+export type LegacyWinOptionsInAppOptions = Pick<WindowCreationOptions, 'accelerator' | 'alwaysOnTop' | 'api' | 'aspectRatio' | 'autoplayPolicy' | 'autoShow' | 'backgroundColor' | 'contentNavigation' | 'contextMenu' | 'cornerRounding' | 'customData' | 'customRequestHeaders' | 'defaultCentered' | 'defaultHeight' | 'defaultLeft' | 'defaultTop' | 'defaultWidth' | 'frame' | 'hideOnClose' | 'icon' | 'maxHeight' | 'maximizable' | 'maxWidth' | 'minHeight' | 'minimizable' | 'minWidth' | 'opacity' | 'preloadScripts' | 'resizable' | 'resizeRegion' | 'saveWindowState' | 'ignoreSavedWindowState' | 'shadow' | 'showTaskbarIcon' | 'smallWindow' | 'state' | 'taskbarIconGroup' | 'waitForPageLoad' | '_internalWorkspaceData'>;
 export type Snapshot = {
     windows: WindowCreationOptions[];
     snapshotDetails?: {
@@ -792,6 +794,11 @@ export type MutableWindowOptions = {
      */
     showTaskbarIcon: boolean;
     interop: InteropConfig;
+    /**
+     * @internal
+     * Used by Workspace to store custom data. Overwriting or modifying this field may impact the functionality of Workspace
+     */
+    _internalWorkspaceData: any;
     workspacePlatform: WorkspacePlatformOptions;
 };
 export type WorkspacePlatformOptions = {
@@ -1191,6 +1198,11 @@ export type MutableViewOptions = {
      */
     preventDragOut: boolean;
     interop?: InteropConfig;
+    /**
+     * @internal
+     * Used by Workspace to store custom data. Overwriting or modifying this field may impact the functionality of Workspace
+     */
+    _internalWorkspaceData: any;
 };
 /**
  * User-facing options for a view.
@@ -1330,6 +1342,22 @@ export type ApplySnapshotPayload = {
      */
     options?: ApplySnapshotOptions;
 };
+export type AddViewToStackOptions = {
+    /**
+     * Optional index within the stack to insert the view. Defaults to 0
+     */
+    index?: number;
+};
+export type CreateViewTarget = Identity & {
+    /**
+     * If specified, view creation will not attach to a window and caller must
+     * insert the view into the layout explicitly
+     */
+    location?: {
+        id: string;
+        index?: number;
+    };
+};
 export type CreateViewPayload = {
     /**
      * Options for the view to be added.
@@ -1338,7 +1366,7 @@ export type CreateViewPayload = {
     /**
      * Window the view will be added to. If no target is provided, a new window will be created.
      */
-    target: Identity;
+    target?: CreateViewTarget;
     targetView?: Identity;
 };
 export type ReplaceViewPayload = {
@@ -1460,10 +1488,7 @@ export type PlatformWindowOptions = WindowCreationOptions & {
      */
     stylesheetUrl: string;
 };
-export type PlatformViewCreationOptions = Partial<ViewOptions> & {
-    url: string;
-    target: Identity;
-};
+export type PlatformViewCreationOptions = Partial<ViewOptions>;
 /**
  * Strategy to assign views to process affinity by domain.
  *
@@ -1898,6 +1923,7 @@ export type Margins = {
  * Options for printing a webpage in OpenFin.
  */
 export type PrintOptions = {
+    content?: 'self';
     /**
      * Disables prompting the user for print settings.
      */
@@ -1941,7 +1967,7 @@ export type PrintOptions = {
     /**
      * Page range to print.
      */
-    pageRanges?: Record<'from' | 'to', number>;
+    pageRanges?: Array<Record<'from' | 'to', number>>;
     /**
      * Duplex mode of the printed webpage.
      */
@@ -1951,6 +1977,14 @@ export type PrintOptions = {
      */
     dpi?: Dpi;
 };
+export type ScreenshotPrintOptions = {
+    content: 'screenshot';
+};
+export type WindowViewsPrintOptions = {
+    content: 'views';
+    includeSelf?: boolean;
+};
+export type WindowPrintOptions = PrintOptions | ScreenshotPrintOptions | WindowViewsPrintOptions;
 /**
  * A request to write data to the clipboard.
  */
@@ -2218,6 +2252,7 @@ export type FindInPageResult = {
 export type FrameInfo = {
     name: string;
     uuid: string;
+    url: string;
     entityType: EntityType;
     parent: Identity;
 };
@@ -2894,6 +2929,9 @@ export interface PopupResult<T = any> {
     data?: T;
     lastDispatchResult?: PopupResult;
 }
+export type SystemShutdownHandler = (shutdownEvent: {
+    proceed: () => void;
+}) => void;
 export type AppVersionProgressEvent = {
     type: 'app-version-progress';
 } & AppVersionProgress;
@@ -2956,3 +2994,24 @@ export interface InteropActionLoggingOption {
 export type InteropLoggingActions = 'beforeAction' | 'afterAction';
 export type InteropLoggingOptions = Record<InteropLoggingActions, InteropActionLoggingOption>;
 export type { Me } from './api/me';
+/**
+ * Configuration for page capture.
+ */
+export interface CapturePageOptions {
+    /**
+     * The area of the window to be captured.
+     */
+    area?: Rectangle;
+    /**
+     * @defaultValue 'png'
+     *
+     * The format of the captured image.  Can be 'png', 'jpg', or 'bmp'.
+     */
+    format?: 'bmp' | 'jpg' | 'png';
+    /**
+     * @defaultValue 100
+     *
+     * Quality of JPEG image. Between 0 - 100.
+     */
+    quality?: number;
+}

package/src/api/application/Factory.js

@@ -203,7 +203,6 @@ class ApplicationModule extends base_1.Base {
             // we do not want to expose this error, just continue if this analytics-only call fails
         });
         const app = await this._createFromManifest(manifestUrl);
-        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
         // @ts-expect-error using private method without warning.
         await app._run(opts); // eslint-disable-line no-underscore-dangle
         return app;

package/src/api/application/Instance.js

@@ -141,11 +141,29 @@ class Application extends base_1.EmitterBase {
      * @tutorial Application.quit
      */
     async quit(force = false) {
-        await this._close(force);
-        await this.wire.sendAction('destroy-application', { force, ...this.identity });
-    }
-    _close(force = false) {
-        return this.wire.sendAction('close-application', { force, ...this.identity }).then(() => undefined);
+        try {
+            await this._close(force);
+            await this.wire.sendAction('destroy-application', { force, ...this.identity });
+        }
+        catch (error) {
+            const acceptableErrors = [
+                'Remote connection has closed',
+                'Could not locate the requested application'
+            ];
+            if (!acceptableErrors.some(msg => error.message.includes(msg))) {
+                throw error;
+            }
+        }
+    }
+    async _close(force = false) {
+        try {
+            await this.wire.sendAction('close-application', { force, ...this.identity });
+        }
+        catch (error) {
+            if (!error.message.includes('Remote connection has closed')) {
+                throw error;
+            }
+        }
     }
     close(force = false) {
         console.warn('Deprecation Warning: Application.close is deprecated Please use Application.quit');

package/src/api/base.d.ts

@@ -2,14 +2,13 @@
 import { EventEmitter } from 'events';
 import { Transport } from '../transport/transport';
 import type * as OpenFin from '../OpenFin';
-import Fin from './fin';
 import { BaseEvent, EventHandler } from './events/base';
 type ApplicationIdentity = OpenFin.ApplicationIdentity;
 type Identity = OpenFin.Identity;
 export declare class Base {
     wire: Transport;
     constructor(wire: Transport);
-    protected get fin(): Fin;
+    protected get fin(): OpenFin.Fin<OpenFin.EntityType>;
     get me(): Identity;
     protected isNodeEnvironment: () => boolean;
     protected isOpenFinEnvironment: () => boolean;

package/src/api/base.js

@@ -14,7 +14,6 @@ var _EmitterBase_emitterAccessor;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Reply = exports.EmitterBase = exports.Base = void 0;
 const promises_1 = require("../util/promises");
-const fin_store_1 = require("../transport/fin_store");
 class Base {
     constructor(wire) {
         this.isNodeEnvironment = () => {
@@ -29,7 +28,7 @@ class Base {
         this.wire = wire;
     }
     get fin() {
-        return (0, fin_store_1.getFin)(this.wire);
+        return this.wire.getFin();
     }
     get me() {
         return this.wire.me;

package/src/api/events/system.d.ts

@@ -1,6 +1,6 @@
 import type * as OpenFin from '../../OpenFin';
 import { PropagatedApplicationEvent } from './application';
-import { BaseEvent } from './base';
+import { BaseEvent, IdentityEvent } from './base';
 import { PropagatedViewEvent } from './view';
 import { PropagatedWindowEvent } from './window';
 import { AppVersionCompleteEvent, AppVersionErrorEvent, AppVersionProgressEvent, AppVersionRuntimeStatusEvent } from '../../OpenFin';
@@ -38,13 +38,16 @@ export type EventWithId<Event extends AppVersionEvent> = Event extends infer E e
     appVersionId: string;
 } : never;
 export type AppVersionEventWithId = EventWithId<AppVersionEvent>;
-export type ApplicationCreatedEvent = BaseEvent & {
+export type ApplicationCreatedEvent = IdentityEvent & {
     type: 'application-created';
 };
 export type DesktopIconClickedEvent = BaseEvent & {
     type: 'desktop-icon-clicked';
 };
+export type SystemShutdownEvent = BaseEvent & {
+    type: 'system-shutdown';
+};
 export type SystemEvent = {
     topic: 'system';
-} & (ExcludeRequested<PropagatedWindowEvent> | PropagatedViewEvent | PropagatedApplicationEvent | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleEvent | MonitorEvent | SessionChangedEvent | AppVersionEventWithId);
+} & (ExcludeRequested<PropagatedWindowEvent> | PropagatedViewEvent | PropagatedApplicationEvent | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleEvent | MonitorEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent);
 export type SystemEventType = SystemEvent['type'];

package/src/api/fin.js

@@ -13,13 +13,11 @@ const index_8 = require("./global-hotkey/index");
 const index_9 = require("./view/index");
 const index_10 = require("./platform/index");
 const me_1 = require("./me");
-const fin_store_1 = require("../transport/fin_store");
 const interop_1 = require("./interop");
 const snapshot_source_1 = require("./snapshot-source");
 class Fin extends events_1.EventEmitter {
     constructor(wire) {
         super();
-        (0, fin_store_1.registerFin)(wire, this);
         this.wire = wire;
         this.System = new index_1.default(wire);
         this.Window = new index_2.default(wire);
@@ -33,6 +31,7 @@ class Fin extends events_1.EventEmitter {
         this.View = new index_9.default(wire);
         this.Interop = new interop_1.default(wire);
         this.SnapshotSource = new snapshot_source_1.default(wire);
+        wire.registerFin(this);
         this.me = (0, me_1.getMe)(wire);
         // Handle disconnect events
         wire.on('disconnected', () => {

package/src/api/interappbus/channel/index.d.ts

@@ -15,6 +15,7 @@ export interface ChannelMessage extends Message<any> {
 export declare class Channel extends EmitterBase<ChannelEvent> {
     #private;
     constructor(wire: Transport);
+    private channelExists;
     getAllChannels(): Promise<ProviderIdentity[]>;
     onChannelConnect(listener: (...args: any[]) => void): Promise<void>;
     onChannelDisconnect(listener: (...args: any[]) => void): Promise<void>;

package/src/api/interappbus/channel/index.js

@@ -10,7 +10,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _Channel_connectionManager;
+var _Channel_connectionManager, _Channel_internalEmitter, _Channel_readyToConnect;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Channel = void 0;
 /* eslint-disable no-console */
@@ -18,16 +18,29 @@ const client_1 = require("./client");
 const provider_1 = require("./provider");
 const base_1 = require("../../base");
 const connection_manager_1 = require("./connection-manager");
-// eslint-disable-next-line @typescript-eslint/no-empty-function
-const noop = () => { };
+const events_1 = require("events");
+const lazy_1 = require("../../../util/lazy");
 class Channel extends base_1.EmitterBase {
     constructor(wire) {
         super(wire, 'channel');
         _Channel_connectionManager.set(this, void 0);
+        _Channel_internalEmitter.set(this, new events_1.EventEmitter());
+        // OpenFin API has not been injected at construction time, *must* wait for API to be ready.
+        _Channel_readyToConnect.set(this, new lazy_1.AsyncRetryableLazy(async () => {
+            await Promise.all([
+                this.on('disconnected', (eventPayload) => {
+                    client_1.default.handleProviderDisconnect(eventPayload);
+                }),
+                this.on('connected', (...args) => {
+                    __classPrivateFieldGet(this, _Channel_internalEmitter, "f").emit('connected', ...args);
+                })
+            ]).catch(() => new Error('error setting up channel connection listeners'));
+        }));
         __classPrivateFieldSet(this, _Channel_connectionManager, new connection_manager_1.ConnectionManager(wire), "f");
-        this.on('disconnected', (eventPayload) => {
-            client_1.default.handleProviderDisconnect(eventPayload);
-        }).catch((e) => console.error('Error setting up a disconnected listener:', e));
+    }
+    async channelExists(channelName) {
+        const channels = await this.getAllChannels();
+        return channels.some((providerIdentity) => providerIdentity.channelName === channelName);
     }
     async getAllChannels() {
         return this.wire.sendAction('get-all-channels').then(({ payload }) => payload.data);
@@ -38,47 +51,39 @@ class Channel extends base_1.EmitterBase {
     async onChannelDisconnect(listener) {
         await this.on('disconnected', listener);
     }
-    async connect(channelName, options) {
+    async connect(channelName, options = {}) {
+        // Make sure we don't connect before listeners are set up
+        // This also errors if we're not in OpenFin, ensuring we don't run unnecessary code
+        await __classPrivateFieldGet(this, _Channel_readyToConnect, "f").getValue();
         if (!channelName || typeof channelName !== 'string') {
             throw new Error('Please provide a channelName string to connect to a channel.');
         }
-        const opts = Object.assign(this.wire.environment.getDefaultChannelOptions().connect, options || {});
-        let resolver = noop;
-        let listener = noop;
-        const waitResponse = new Promise((resolve) => {
-            resolver = resolve;
-            listener = (payload) => {
-                if (channelName === payload.channelName) {
-                    this.removeListener('connected', listener);
-                    resolve(this.connect(channelName, opts));
-                }
-            };
-            this.on('connected', listener);
-        });
+        const opts = { wait: true, ...this.wire.environment.getDefaultChannelOptions().connect, ...options };
+        const shouldWait = opts.wait;
+        if (shouldWait) {
+            const channelExists = await this.channelExists(channelName);
+            if (!channelExists) {
+                console.warn(`Channel not found for channelName: ${channelName}, waiting for channel connection.`);
+                await new Promise((resolve) => {
+                    const connectedListener = (payload) => {
+                        if (channelName === payload.channelName) {
+                            __classPrivateFieldGet(this, _Channel_internalEmitter, "f").removeListener('connected', connectedListener);
+                            resolve();
+                        }
+                    };
+                    __classPrivateFieldGet(this, _Channel_internalEmitter, "f").on('connected', connectedListener);
+                });
+            }
+        }
         try {
             const { offer, rtc: rtcPacket } = await __classPrivateFieldGet(this, _Channel_connectionManager, "f").createClientOffer(opts);
-            let connectionUrl;
-            const entityType = this.wire.environment.getCurrentEntityType();
-            if (entityType === 'iframe') {
-                // @ts-expect-error
-                // TODO: type this correctly (frame types are broken)
-                connectionUrl = (await this.fin.me.getInfo()).url;
-            }
-            else if (entityType === 'window' || entityType === 'view') {
-                connectionUrl = (await this.fin.me.getInfo()).url;
-            }
-            const res = await this.wire.sendAction('connect-to-channel', {
+            const connectionUrl = (await this.fin.me.getInfo()).url;
+            const { payload: { data: routingInfo } } = await this.wire.sendAction('connect-to-channel', {
                 channelName,
                 ...opts,
                 offer,
                 connectionUrl
             });
-            const { payload: { data: routingInfo } } = res;
-            // If there isn't a matching channel, the above sendAction call will error out and go to catch, skipping the logic below.
-            if (resolver) {
-                resolver();
-            }
-            this.removeListener('connected', listener);
             const strategy = await __classPrivateFieldGet(this, _Channel_connectionManager, "f").createClientStrategy(rtcPacket, routingInfo);
             const channel = new client_1.default(routingInfo, this.wire, strategy);
             // It is the client's responsibility to handle endpoint disconnection to the provider.
@@ -97,18 +102,13 @@ class Channel extends base_1.EmitterBase {
             });
             return channel;
         }
-        catch (e) {
-            const shouldWait = { wait: true, ...opts }.wait;
+        catch (error) {
             const internalNackMessage = 'internal-nack';
-            if (shouldWait && e.message && e.message.includes(internalNackMessage)) {
-                console.warn(`Channel not found for channelName: ${channelName}, waiting for channel connection.`);
-                return waitResponse;
-            }
-            if (e.message === internalNackMessage) {
-                throw new Error(`No channel found for channelName: ${channelName}`);
+            if (error.message.includes(internalNackMessage)) {
+                throw new Error(`No channel found for channelName: ${channelName}.`);
             }
             else {
-                throw new Error(e);
+                throw new Error(error);
             }
         }
     }
@@ -129,4 +129,4 @@ class Channel extends base_1.EmitterBase {
     }
 }
 exports.Channel = Channel;
-_Channel_connectionManager = new WeakMap();
+_Channel_connectionManager = new WeakMap(), _Channel_internalEmitter = new WeakMap(), _Channel_readyToConnect = new WeakMap();

package/src/api/interappbus/channel/protocols/classic/strategy.js

@@ -10,7 +10,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _ClassicStrategy_wire, _ClassicStrategy_endpointIdentityMap;
+var _ClassicStrategy_wire, _ClassicStrategy_endpointIdentityMap, _ClassicStrategy_pendingMessagesByEndpointId;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ClassicInfo = exports.ClassicStrategy = void 0;
 /*
@@ -26,7 +26,11 @@ class ClassicStrategy {
         // Store full endpointIdentity by endpointId of all known endpoints for this strategy instance.
         // (clients will only have 1: the provider, the provider will have all clients)
         _ClassicStrategy_endpointIdentityMap.set(this, new Map());
+        // Store a set of cancellable promises to be able to reject them when client
+        // connection problems occur
+        _ClassicStrategy_pendingMessagesByEndpointId.set(this, new Map);
         this.send = async (endpointId, action, payload) => {
+            var _a;
             const to = __classPrivateFieldGet(this, _ClassicStrategy_endpointIdentityMap, "f").get(endpointId);
             if (!to) {
                 throw new Error(`Could not locate routing info for endpoint ${endpointId}`);
@@ -38,20 +42,27 @@ class ClassicStrategy {
                 delete cleanId.endpointId;
             }
             delete cleanId.isLocalEndpointId;
-            const raw = await __classPrivateFieldGet(this, _ClassicStrategy_wire, "f")
+            // grab the promise before awaiting it to save in our pending messages map
+            const p = __classPrivateFieldGet(this, _ClassicStrategy_wire, "f")
                 .sendAction('send-channel-message', {
                 ...cleanId,
                 providerIdentity: this.providerIdentity,
                 action,
                 payload
-            })
-                .catch((reason) => {
-                throw new Error(reason.message);
+            });
+            (_a = __classPrivateFieldGet(this, _ClassicStrategy_pendingMessagesByEndpointId, "f").get(endpointId)) === null || _a === void 0 ? void 0 : _a.add(p);
+            const raw = await p.catch((error) => {
+                throw new Error(error.message);
+            }).finally(() => {
+                var _a;
+                // clean up the pending promise
+                (_a = __classPrivateFieldGet(this, _ClassicStrategy_pendingMessagesByEndpointId, "f").get(endpointId)) === null || _a === void 0 ? void 0 : _a.delete(p);
             });
             return raw.payload.data.result;
         };
         this.close = async () => {
             this.messageReceiver.removeEndpoint(this.providerIdentity.channelId, this.endpointId);
+            [...__classPrivateFieldGet(this, _ClassicStrategy_endpointIdentityMap, "f").keys()].forEach((id) => this.closeEndpoint(id));
             __classPrivateFieldSet(this, _ClassicStrategy_endpointIdentityMap, new Map(), "f");
         };
         __classPrivateFieldSet(this, _ClassicStrategy_wire, wire, "f");
@@ -63,13 +74,20 @@ class ClassicStrategy {
         this.messageReceiver.addEndpoint(listener, this.providerIdentity.channelId, this.endpointId);
     }
     async closeEndpoint(endpointId) {
+        const id = __classPrivateFieldGet(this, _ClassicStrategy_endpointIdentityMap, "f").get(endpointId);
         __classPrivateFieldGet(this, _ClassicStrategy_endpointIdentityMap, "f").delete(endpointId);
+        const pendingSet = __classPrivateFieldGet(this, _ClassicStrategy_pendingMessagesByEndpointId, "f").get(endpointId);
+        pendingSet === null || pendingSet === void 0 ? void 0 : pendingSet.forEach((p) => {
+            const errorMsg = `Channel connection with identity uuid: ${id === null || id === void 0 ? void 0 : id.uuid} / name: ${id === null || id === void 0 ? void 0 : id.name} / endpointId: ${endpointId} no longer connected.`;
+            p.cancel(new Error(errorMsg));
+        });
     }
     isEndpointConnected(endpointId) {
         return __classPrivateFieldGet(this, _ClassicStrategy_endpointIdentityMap, "f").has(endpointId);
     }
     addEndpoint(endpointId, payload) {
         __classPrivateFieldGet(this, _ClassicStrategy_endpointIdentityMap, "f").set(endpointId, payload.endpointIdentity);
+        __classPrivateFieldGet(this, _ClassicStrategy_pendingMessagesByEndpointId, "f").set(endpointId, new Set());
     }
     isValidEndpointPayload(payload) {
         var _a, _b;
@@ -78,6 +96,6 @@ class ClassicStrategy {
     }
 }
 exports.ClassicStrategy = ClassicStrategy;
-_ClassicStrategy_wire = new WeakMap(), _ClassicStrategy_endpointIdentityMap = new WeakMap();
+_ClassicStrategy_wire = new WeakMap(), _ClassicStrategy_endpointIdentityMap = new WeakMap(), _ClassicStrategy_pendingMessagesByEndpointId = new WeakMap();
 // Arbitrarily starting at 5 to leave the door open to backfilling pre endpointId etc.
 exports.ClassicInfo = { version: 5, minimumVersion: 0, type: 'classic' };

package/src/api/interappbus/index.js

@@ -17,7 +17,7 @@ class InterApplicationBus extends base_1.Base {
             subscriberAdded: 'subscriber-added',
             subscriberRemoved: 'subscriber-removed'
         };
-        this.refCounter = new ref_counter_1.default();
+        this.refCounter = new ref_counter_1.RefCounter();
         this.Channel = new index_1.Channel(wire);
         this.emitter = new events_1.EventEmitter();
         wire.registerMessageHandler(this.onmessage.bind(this));

package/src/api/interop/InteropClient.d.ts

@@ -88,7 +88,7 @@ import { Base } from '../base';
  * @summary A SessionContextGroup instance method for adding a handler for context change.
  * @param {ContextHandler} contextHandler The callback to be invoked. Is invoked when (a) the context changes or (b) immediately after getting created if the context is already set.
  * @param {string} [contextType] The context type this handler should listen to. If not specified, a global handler for all context types will get created. Only one global handler is allowed per SessionContextGroup.
- * @return {Promise<void>}
+ * @return {Promise<Subscription>}
  */
 /**
  * {@link https://developers.openfin.co/of-docs/docs/enable-color-linking}

package/src/api/interop/InteropClient.js

@@ -103,7 +103,7 @@ const utils_1 = require("./utils");
  * @summary A SessionContextGroup instance method for adding a handler for context change.
  * @param {ContextHandler} contextHandler The callback to be invoked. Is invoked when (a) the context changes or (b) immediately after getting created if the context is already set.
  * @param {string} [contextType] The context type this handler should listen to. If not specified, a global handler for all context types will get created. Only one global handler is allowed per SessionContextGroup.
- * @return {Promise<void>}
+ * @return {Promise<Subscription>}
  */
 /**
  * {@link https://developers.openfin.co/of-docs/docs/enable-color-linking}

package/src/api/interop/SessionContextGroupBroker.d.ts

@@ -18,7 +18,7 @@ export default class SessionContextGroupBroker {
     handlerAdded(payload: {
         handlerId: string;
         contextType?: string;
-    }, clientIdentity: OpenFin.ClientIdentity): void;
+    }, clientIdentity: OpenFin.ClientIdentity): Promise<void>;
     handlerRemoved(payload: {
         handlerId: string;
     }, clientIdentity: OpenFin.ClientIdentity): void;

package/src/api/interop/SessionContextGroupBroker.js

@@ -48,7 +48,7 @@ class SessionContextGroupBroker {
     getClientState(id) {
         return this.clients.get(id.endpointId);
     }
-    handlerAdded(payload, clientIdentity) {
+    async handlerAdded(payload, clientIdentity) {
         const { handlerId, contextType } = payload;
         const clientSubscriptionState = this.getClientState(clientIdentity);
         if (!clientSubscriptionState) {
@@ -59,17 +59,18 @@ class SessionContextGroupBroker {
             clientSubscriptionState.contextHandlers.set(contextType, [...currentHandlerList, handlerId]);
             const currentContext = this.contextGroupMap.get(contextType);
             if (currentContext) {
-                this.provider.dispatch(clientIdentity, handlerId, currentContext);
+                await this.provider.dispatch(clientIdentity, handlerId, currentContext);
             }
         }
         else {
             clientSubscriptionState.globalHandler = handlerId;
-            [...this.contextGroupMap.keys()].forEach((currentContextType) => {
+            const globalDispatchPromises = [...this.contextGroupMap.keys()].map(async (currentContextType) => {
                 const currentContext = this.contextGroupMap.get(currentContextType);
                 if (currentContext) {
-                    this.provider.dispatch(clientIdentity, handlerId, currentContext);
+                    await this.provider.dispatch(clientIdentity, handlerId, currentContext);
                 }
             });
+            await Promise.all(globalDispatchPromises);
         }
     }
     handlerRemoved(payload, clientIdentity) {

package/src/api/interop/SessionContextGroupClient.js

@@ -63,7 +63,7 @@ class SessionContextGroupClient extends base_1.Base {
             handlerId = `sessionContextHandler:invoke-${this.id}`;
         }
         client.register(handlerId, (0, utils_1.wrapContextHandler)(contextHandler, handlerId));
-        client.dispatch(`sessionContextGroup:handlerAdded-${this.id}`, { handlerId, contextType });
+        await client.dispatch(`sessionContextGroup:handlerAdded-${this.id}`, { handlerId, contextType });
         return { unsubscribe: await this.createUnsubscribeCb(handlerId) };
     }
     async createUnsubscribeCb(handlerId) {