@openfin/core 30.73.22 → 30.73.24

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

@@ -1,9 +1,9 @@
-import * as OpenFin from '../../../OpenFin';
+import type * as OpenFin from '../../../OpenFin';
 import Transport from '../../../transport/transport';
-import ProviderIdentity = OpenFin.ProviderIdentity;
-import ChannelMiddleware = OpenFin.ChannelMiddleware;
-import ErrorMiddleware = OpenFin.ErrorMiddleware;
-import ChannelAction = OpenFin.ChannelAction;
+declare type ProviderIdentity = OpenFin.ProviderIdentity;
+declare type ChannelMiddleware = OpenFin.ChannelMiddleware;
+declare type ErrorMiddleware = OpenFin.ErrorMiddleware;
+declare type ChannelAction = OpenFin.ChannelAction;
 export declare class ProtectedItems {
     providerIdentity: ProviderIdentity;
     wire: Transport;
@@ -25,3 +25,4 @@ export declare class ChannelBase {
     setDefaultAction(func: ChannelMiddleware): void;
     register(topic: string, listener: ChannelAction): boolean;
 }
+export {};

package/src/api/interappbus/channel/channels-docs.d.ts

@@ -278,6 +278,7 @@ declare class ChannelClient {
  * @param {any} payload - Payload sent with connection request.
  */
 /**
+ * @REMOVED
  * Callback for onChannelConnect or onChannelDisconnect.
  * @typedef {object} InterApplicationBus.Channel~ConnectionEvent
  * @property {string} channelId - Identifier of the channel.
@@ -286,17 +287,20 @@ declare class ChannelClient {
  * @property {string} channelName - Name of the channel.
  */
 /**
+ * @PORTED
  * Protocol values for determining channel messaging strategy.
  * @typedef {('classic' | 'rtc')} InterApplicationBus.Channel~MessagingProtocols - EXPERIMENTAL
  *
  */
 /**
+ * @PORTED
  * Channel provider creation options.
  * @typedef {object} InterApplicationBus.Channel~ChannelCreateOptions
  * @property {InterApplicationBus.Channel~MessagingProtocols[]} [protocols=['classic']] - EXPERIMENTAL: Messaging protocols supported by the channel provider.
  *
  */
 /**
+ * @PORTED
  * Options provided on a client connection to a channel.
  * @typedef {object} InterApplicationBus.Channel~ChannelConnectOptions
  * @property {InterApplicationBus.Channel~MessagingProtocols[]} [protocols=['classic']] - EXPERIMENTAL: Messaging protocols requested by the client, connection will fail if the provider protocols are not compatible.
@@ -305,6 +309,7 @@ declare class ChannelClient {
  *
  */
 /**
+ * @PORTED
  * Provider Identity.
  * @typedef {object} InterApplicationBus.Channel~ProviderIdentity
  * @property {string} uuid - Channel provider uuid.
@@ -315,6 +320,7 @@ declare class ChannelClient {
  *
  */
 /**
+ * @PORTED
  * Client Identity.
  * @typedef {object} InterApplicationBus.Channel~ClientIdentity
  * @property {string} uuid - Channel client uuid.
@@ -323,6 +329,7 @@ declare class ChannelClient {
  *
  */
 /**
+ * @PORTED
  * Extended Client Information
  * @typedef {object} InterApplicationBus.Channel~ClientInfo
  * @property {string} uuid - Channel client uuid

package/src/api/interappbus/channel/channels-docs.js

@@ -336,6 +336,7 @@ class ChannelClient {
  * @param {any} payload - Payload sent with connection request.
  */
 /**
+ * @REMOVED
  * Callback for onChannelConnect or onChannelDisconnect.
  * @typedef {object} InterApplicationBus.Channel~ConnectionEvent
  * @property {string} channelId - Identifier of the channel.
@@ -344,17 +345,20 @@ class ChannelClient {
  * @property {string} channelName - Name of the channel.
  */
 /**
+ * @PORTED
  * Protocol values for determining channel messaging strategy.
  * @typedef {('classic' | 'rtc')} InterApplicationBus.Channel~MessagingProtocols - EXPERIMENTAL
  *
  */
 /**
+ * @PORTED
  * Channel provider creation options.
  * @typedef {object} InterApplicationBus.Channel~ChannelCreateOptions
  * @property {InterApplicationBus.Channel~MessagingProtocols[]} [protocols=['classic']] - EXPERIMENTAL: Messaging protocols supported by the channel provider.
  *
  */
 /**
+ * @PORTED
  * Options provided on a client connection to a channel.
  * @typedef {object} InterApplicationBus.Channel~ChannelConnectOptions
  * @property {InterApplicationBus.Channel~MessagingProtocols[]} [protocols=['classic']] - EXPERIMENTAL: Messaging protocols requested by the client, connection will fail if the provider protocols are not compatible.
@@ -363,6 +367,7 @@ class ChannelClient {
  *
  */
 /**
+ * @PORTED
  * Provider Identity.
  * @typedef {object} InterApplicationBus.Channel~ProviderIdentity
  * @property {string} uuid - Channel provider uuid.
@@ -373,6 +378,7 @@ class ChannelClient {
  *
  */
 /**
+ * @PORTED
  * Client Identity.
  * @typedef {object} InterApplicationBus.Channel~ClientIdentity
  * @property {string} uuid - Channel client uuid.
@@ -381,6 +387,7 @@ class ChannelClient {
  *
  */
 /**
+ * @PORTED
  * Extended Client Information
  * @typedef {object} InterApplicationBus.Channel~ClientInfo
  * @property {string} uuid - Channel client uuid

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

@@ -1,8 +1,8 @@
-import * as OpenFin from '../../../OpenFin';
+import type * as OpenFin from '../../../OpenFin';
 import { ChannelBase } from './channel';
 import Transport from '../../../transport/transport';
 import { AnyStrategy } from './protocols/strategy-types';
-import ProviderIdentity = OpenFin.ProviderIdentity;
+declare type ProviderIdentity = OpenFin.ProviderIdentity;
 declare type DisconnectionListener = (providerIdentity: ProviderIdentity) => any;
 interface RoutingInfo extends ProviderIdentity {
     endpointId: string;
@@ -12,12 +12,13 @@ export default class ChannelClient extends ChannelBase {
     private disconnectListener;
     private endpointId;
     static closeChannelByEndpointId(id: string): void;
-    static handleProviderDisconnect(channel: ChannelClient, eventPayload: ProviderIdentity): void;
+    static handleProviderDisconnect(eventPayload: ProviderIdentity): void;
     constructor(routingInfo: RoutingInfo, wire: Transport, strategy: AnyStrategy);
     protected processAction: (action: string, payload: any, senderIdentity: ProviderIdentity | OpenFin.ClientIdentity) => Promise<any>;
     get providerIdentity(): ProviderIdentity;
     dispatch(action: string, payload?: any): Promise<any>;
     onDisconnection(listener: DisconnectionListener): void;
     disconnect(): Promise<void>;
+    sendDisconnectAction(): Promise<void>;
 }
 export {};

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

@@ -38,10 +38,14 @@ class ChannelClient extends channel_1.ChannelBase {
             __classPrivateFieldGet(channel, _ChannelClient_close, "f").call(channel);
         }
     }
-    // closes the channel and invokes the disconnect listener if an event payload is passed.
-    static handleProviderDisconnect(channel, eventPayload) {
-        channel.disconnectListener(eventPayload);
-        __classPrivateFieldGet(channel, _ChannelClient_close, "f").call(channel);
+    // closes the corresponding channel and invokes the disconnect listener if an event payload is passed.
+    static handleProviderDisconnect(eventPayload) {
+        for (const channelClient of channelClientsByEndpointId.values()) {
+            if (channelClient.providerIdentity.channelId === eventPayload.channelId) {
+                channelClient.disconnectListener(eventPayload);
+                __classPrivateFieldGet(channelClient, _ChannelClient_close, "f").call(channelClient);
+            }
+        }
     }
     get providerIdentity() {
         const protectedObj = __classPrivateFieldGet(this, _ChannelClient_protectedObj, "f");
@@ -67,6 +71,10 @@ class ChannelClient extends channel_1.ChannelBase {
         };
     }
     async disconnect() {
+        await this.sendDisconnectAction();
+        __classPrivateFieldGet(this, _ChannelClient_close, "f").call(this);
+    }
+    async sendDisconnectAction() {
         const protectedObj = __classPrivateFieldGet(this, _ChannelClient_protectedObj, "f");
         const { channelName, uuid, name } = protectedObj.providerIdentity;
         await protectedObj.wire.sendAction('disconnect-from-channel', {
@@ -75,7 +83,6 @@ class ChannelClient extends channel_1.ChannelBase {
             name,
             endpointId: this.endpointId
         });
-        __classPrivateFieldGet(this, _ChannelClient_close, "f").call(this);
     }
 }
 exports.default = ChannelClient;

package/src/api/interappbus/channel/connection-manager.d.ts

@@ -1,4 +1,4 @@
-import * as OpenFin from '../../../OpenFin';
+import type * as OpenFin from '../../../OpenFin';
 import { ChannelMessage } from '.';
 import Transport from '../../../transport/transport';
 import { Base } from '../../base';

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

@@ -1,18 +1,18 @@
-import * as OpenFin from '../../../OpenFin';
+import type * as OpenFin from '../../../OpenFin';
 import ChannelClient from './client';
 import { ChannelProvider } from './provider';
 import { EmitterBase } from '../../base';
 import Transport, { Message } from '../../../transport/transport';
-import { ChannelEvents } from '../../events/channel';
-import ProviderIdentity = OpenFin.ProviderIdentity;
-import Identity = OpenFin.Identity;
+import { ChannelEvent } from '../../events/channel';
+declare type ProviderIdentity = OpenFin.ProviderIdentity;
+declare type Identity = OpenFin.Identity;
 export interface ChannelMessage extends Message<any> {
     senderIdentity: Identity;
     ackToSender: any;
     providerIdentity: ProviderIdentity;
     connectAction: boolean;
 }
-export declare class Channel extends EmitterBase<ChannelEvents> {
+export declare class Channel extends EmitterBase<ChannelEvent> {
     #private;
     constructor(wire: Transport);
     getAllChannels(): Promise<ProviderIdentity[]>;
@@ -21,3 +21,4 @@ export declare class Channel extends EmitterBase<ChannelEvents> {
     connect(channelName: string, options?: OpenFin.ChannelConnectOptions): Promise<ChannelClient>;
     create(channelName: string, options?: OpenFin.ChannelCreateOptions): Promise<ChannelProvider>;
 }
+export {};

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

@@ -25,6 +25,9 @@ class Channel extends base_1.EmitterBase {
         super(wire, 'channel');
         _Channel_connectionManager.set(this, void 0);
         __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 getAllChannels() {
         return this.wire.sendAction('get-all-channels').then(({ payload }) => payload.data);
@@ -83,18 +86,13 @@ class Channel extends base_1.EmitterBase {
             // The provider does not care about endpoint disconnection.
             strategy.onEndpointDisconnect(routingInfo.channelId, async () => {
                 try {
-                    await channel.disconnect();
+                    await channel.sendDisconnectAction();
                 }
                 catch (error) {
                     console.warn(`Something went wrong during disconnect for client with uuid: ${routingInfo.uuid} / name: ${routingInfo.name} / endpointId: ${routingInfo.endpointId}.`);
                 }
                 finally {
-                    client_1.default.handleProviderDisconnect(channel, routingInfo);
-                }
-            });
-            this.on('disconnected', (eventPayload) => {
-                if (eventPayload.channelName === channelName) {
-                    client_1.default.handleProviderDisconnect(channel, eventPayload);
+                    client_1.default.handleProviderDisconnect(routingInfo);
                 }
             });
             return channel;
@@ -120,6 +118,8 @@ class Channel extends base_1.EmitterBase {
         }
         const { payload: { data: providerIdentity } } = await this.wire.sendAction('create-channel', { channelName });
         const channel = __classPrivateFieldGet(this, _Channel_connectionManager, "f").createProvider(options, providerIdentity);
+        // TODO: fix typing (internal)
+        // @ts-expect-error
         this.on('client-disconnected', (eventPayload) => {
             if (eventPayload.channelName === channelName) {
                 provider_1.ChannelProvider.handleClientDisconnection(channel, eventPayload);

package/src/api/interappbus/channel/protocols/classic/strategy.d.ts

@@ -1,9 +1,9 @@
-import * as OpenFin from '../../../../../OpenFin';
+import type * as OpenFin from '../../../../../OpenFin';
 import Transport from '../../../../../transport/transport';
 import { MessageReceiver } from './message-receiver';
 import { ChannelStrategy, EndpointPayload } from '../strategy';
 import { LocalSupportedProtocol } from '..';
-import ProviderIdentity = OpenFin.ProviderIdentity;
+declare type ProviderIdentity = OpenFin.ProviderIdentity;
 export declare class ClassicStrategy implements ChannelStrategy<EndpointPayload> {
     #private;
     private messageReceiver;
@@ -21,3 +21,4 @@ export declare class ClassicStrategy implements ChannelStrategy<EndpointPayload>
     isValidEndpointPayload(payload: any): payload is EndpointPayload;
 }
 export declare const ClassicInfo: LocalSupportedProtocol;
+export {};

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

@@ -15,6 +15,9 @@ export interface RTCProtocolOffer extends ProtocolPacketBase {
     };
 }
 export declare type ProtocolOffer = ClassicProtocolOffer | RTCProtocolOffer;
+/**
+ * Protocol values for determining channel messaging strategy.
+ */
 export declare type MessagingProtocols = ProtocolOffer['type'];
 export declare type LocalSupportedProtocol = {
     type: MessagingProtocols;

package/src/api/interappbus/channel/protocols/rtc/endpoint.d.ts

@@ -1,5 +1,5 @@
-import * as OpenFin from '../../../../../OpenFin';
-import ProviderIdentity = OpenFin.ProviderIdentity;
+import type * as OpenFin from '../../../../../OpenFin';
+declare type ProviderIdentity = OpenFin.ProviderIdentity;
 export interface RTCEndpointChannels {
     request: RTCDataChannel;
     response: RTCDataChannel;
@@ -22,3 +22,4 @@ export declare class RTCEndpoint {
     close: () => void;
     get connected(): boolean;
 }
+export {};

package/src/api/interappbus/channel/protocols/rtc/endpoint.js

@@ -51,7 +51,11 @@ class RTCEndpoint {
         };
         this.rtc.channels.response.addEventListener('message', (e) => {
             var _a;
-            const { messageId, payload, success, error } = JSON.parse(e.data);
+            let { data } = e;
+            if (e.data instanceof ArrayBuffer) {
+                data = new TextDecoder().decode(e.data);
+            }
+            const { messageId, payload, success, error } = JSON.parse(data);
             const { resolve, reject } = (_a = this.responseMap.get(messageId)) !== null && _a !== void 0 ? _a : {};
             if (resolve && reject) {
                 this.responseMap.delete(messageId);
@@ -68,7 +72,11 @@ class RTCEndpoint {
             }
         });
         this.rtc.channels.request.addEventListener('message', async (e) => {
-            const { messageId, action, payload } = JSON.parse(e.data);
+            let { data } = e;
+            if (e.data instanceof ArrayBuffer) {
+                data = new TextDecoder().decode(e.data);
+            }
+            const { messageId, action, payload } = JSON.parse(data);
             if (__classPrivateFieldGet(this, _RTCEndpoint_processAction, "f")) {
                 try {
                     const res = await __classPrivateFieldGet(this, _RTCEndpoint_processAction, "f").call(this, action, payload, endpointIdentity);

package/src/api/interappbus/channel/protocols/rtc/strategy.d.ts

@@ -1,8 +1,8 @@
-import * as OpenFin from '../../../../../OpenFin';
+import type * as OpenFin from '../../../../../OpenFin';
 import { ChannelStrategy } from '../strategy';
 import { RTCPacket } from './endpoint';
 import { LocalSupportedProtocol } from '..';
-import ProviderIdentity = OpenFin.ProviderIdentity;
+declare type ProviderIdentity = OpenFin.ProviderIdentity;
 export interface RTCStrategyEndpointPayload {
     endpointIdentity: OpenFin.ClientIdentity | ProviderIdentity;
     rtc: RTCPacket;
@@ -21,3 +21,4 @@ export declare class RTCStrategy implements ChannelStrategy<RTCStrategyEndpointP
     isValidEndpointPayload(payload: any): payload is RTCStrategyEndpointPayload;
 }
 export declare const RTCInfo: LocalSupportedProtocol;
+export {};

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

@@ -82,4 +82,4 @@ class RTCStrategy {
 }
 exports.RTCStrategy = RTCStrategy;
 _RTCStrategy_processAction = new WeakMap(), _RTCStrategy_rtcEndpointMap = new WeakMap(), _RTCStrategy_connected = new WeakMap();
-exports.RTCInfo = { version: 1, minimumVersion: 0, type: 'rtc' };
+exports.RTCInfo = { version: 2, minimumVersion: 0, type: 'rtc' };

package/src/api/interappbus/channel/protocols/strategy.d.ts

@@ -1,5 +1,5 @@
-import * as OpenFin from '../../../../OpenFin';
-import ProviderIdentity = OpenFin.ProviderIdentity;
+import type * as OpenFin from '../../../../OpenFin';
+declare type ProviderIdentity = OpenFin.ProviderIdentity;
 export interface ChannelStrategy<T extends unknown> {
     onEndpointDisconnect(endpointId: string, listener: () => void): void;
     receive(listener: (action: string, payload: any, identity: any) => Promise<any>): void;
@@ -14,3 +14,4 @@ export declare type EndpointIdentity = OpenFin.ClientIdentity | ProviderIdentity
 export declare type EndpointPayload = {
     endpointIdentity: EndpointIdentity;
 };
+export {};

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

@@ -1,9 +1,9 @@
-import * as OpenFin from '../../../OpenFin';
+import type * as OpenFin from '../../../OpenFin';
 import { ChannelBase } from './channel';
 import Transport from '../../../transport/transport';
 import { AnyStrategy } from './protocols/strategy-types';
-import ProviderIdentity = OpenFin.ProviderIdentity;
-import ClientIdentity = OpenFin.ClientIdentity;
+declare type ProviderIdentity = OpenFin.ProviderIdentity;
+declare type ClientIdentity = OpenFin.ClientIdentity;
 export declare type ConnectionListener = (identity: ClientIdentity, connectionMessage?: any) => Promise<any> | any;
 export declare type DisconnectionListener = (identity: ClientIdentity) => any;
 declare type ClientConnectionPayload = OpenFin.ClientIdentity & OpenFin.ClientInfo;

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

@@ -1,8 +1,9 @@
-import * as OpenFin from '../../OpenFin';
+import type * as OpenFin from '../../OpenFin';
 import { Base } from '../base';
 import { InteropBroker } from './InteropBroker';
 import { InteropClient } from './InteropClient';
 /**
+ * @PORTED
  * @typedef { object } InteropConfig
  * @summary Information relevant to the Interop Broker.
  * @property {string} [currentContextGroup] Context Group for the client. (green, yellow, red, etc.)
@@ -20,7 +21,6 @@ export default class InteropModule extends Base {
      * @param { OverrideCallback<InteropBroker> } [override] - A callback function that can be used to extend or replace default Interop Broker behavior.
      * @return {Promise.<InteropBroker>}
      * @tutorial Interop.init
-     * @experimental
      * @static
      */
     init(name: string, override?: OpenFin.OverrideCallback<InteropBroker>): Promise<InteropBroker>;
@@ -31,7 +31,6 @@ export default class InteropModule extends Base {
      * what context(s) the entity wants to subscribe to, and the current Context Group of the entity.
      * @return {InteropClient}
      * @tutorial Interop.connectSync
-     * @experimental
      * @static
      */
     connectSync(name: string, interopConfig?: OpenFin.InteropConfig): InteropClient;

package/src/api/interop/Factory.js

@@ -1,10 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const lodash_1 = require("lodash");
+const inaccessibleObject_1 = require("../../util/inaccessibleObject");
 const base_1 = require("../base");
 const InteropBroker_1 = require("./InteropBroker");
 const InteropClient_1 = require("./InteropClient");
-const defaultOverride = (Class, ...args) => new Class(...args);
+const overrideCheck_1 = require("./fdc3/overrideCheck");
+const defaultOverride = (Class) => new Class();
+const BrokerParamAccessError = 'You have attempted to use or modify InteropBroker parameters, which is not allowed. You are likely using an older InteropBroker override scheme. Please consult our Interop docs for guidance on migrating to the new override scheme.';
 /**
+ * @PORTED
  * @typedef { object } InteropConfig
  * @summary Information relevant to the Interop Broker.
  * @property {string} [currentContextGroup] Context Group for the client. (green, yellow, red, etc.)
@@ -22,15 +27,18 @@ class InteropModule extends base_1.Base {
      * @param { OverrideCallback<InteropBroker> } [override] - A callback function that can be used to extend or replace default Interop Broker behavior.
      * @return {Promise.<InteropBroker>}
      * @tutorial Interop.init
-     * @experimental
      * @static
      */
     async init(name, override = defaultOverride) {
+        var _a;
         this.wire.sendAction('interop-init').catch((e) => {
             // don't expose, analytics-only call
         });
         // Allows for manifest-level configuration, without having to override. (e.g. specifying custom context groups)
         const options = await this.fin.Application.getCurrentSync().getInfo();
+        const opts = (_a = options.initialOptions.interopBrokerConfiguration) !== null && _a !== void 0 ? _a : {};
+        const objectThatThrows = (0, inaccessibleObject_1.createUnusableObject)(BrokerParamAccessError);
+        const warningOptsClone = (0, inaccessibleObject_1.createWarningObject)(BrokerParamAccessError, (0, lodash_1.cloneDeep)(opts));
         let provider;
         const getProvider = () => {
             if (!provider) {
@@ -38,7 +46,16 @@ class InteropModule extends base_1.Base {
             }
             return provider;
         };
-        return override(InteropBroker_1.InteropBroker, this.wire, getProvider, options.initialOptions.interopBrokerConfiguration);
+        const throwingGetProvider = async () => {
+            // eslint-disable-next-line no-console
+            throw new Error(BrokerParamAccessError);
+        };
+        const OverrideableBroker = InteropBroker_1.InteropBroker.createClosedConstructor(this.wire, getProvider, opts);
+        // We need to use these objects because removing them entirely would be a breaking change and we want an informative error
+        // @ts-expect-error
+        const broker = await override(OverrideableBroker, objectThatThrows, throwingGetProvider, warningOptsClone);
+        (0, overrideCheck_1.overrideCheck)(broker, (0, overrideCheck_1.getDefaultViewFdc3VersionFromAppInfo)(options));
+        return broker;
     }
     /**
      * Connects a client to an Interop broker. This is called under-the-hood for Views in a Platform.
@@ -47,7 +64,6 @@ class InteropModule extends base_1.Base {
      * what context(s) the entity wants to subscribe to, and the current Context Group of the entity.
      * @return {InteropClient}
      * @tutorial Interop.connectSync
-     * @experimental
      * @static
      */
     connectSync(name, interopConfig) {