@openfin/core 33.76.36 → 33.77.1

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

@@ -1,401 +0,0 @@
-/* eslint-disable class-methods-use-this, @typescript-eslint/no-empty-function, @typescript-eslint/explicit-function-return-type */
-/* todo IMPORTANT PLEASE READ!
- * Make sure any edits to the Table of Contents in the following jsdoc comment are also made to both:
- * 1. docs home page (/docs.README.md)
- * 2. App config web page (https://openfin.co/documentation/application-config/)
- */
-const InterApplicationBus = {};
-/**
- * @PORTED
- *
- * @desc The Channel namespace allows an OpenFin application to create a channel as a {@link Channel#ChannelProvider ChannelProvider},
- * or connect to a channel as a {@link Channel#ChannelClient ChannelClient}. The "handshake" between the communication partners is
- * simplified when using a channel.  A request to connect to a channel as a client will return a promise that resolves if/when the channel has been created. Both the
- * provider and client can dispatch actions that have been registered on their opposites, and dispatch returns a promise that resolves with a payload from the other
- * communication participant. There can be only one provider per channel, but many clients.  Version `9.61.35.*` or later is required for both communication partners.
- *
- * ##### Asynchronous Methods
- *  * {@link InterApplicationBus.Channel.create create(channelName, options)}
- *  * {@link InterApplicationBus.Channel.connect connect(channelName, options)}
- *  * {@link InterApplicationBus.Channel.onChannelConnect onChannelConnect(listener)}
- *  * {@link InterApplicationBus.Channel.onChannelDisconnect onChannelDisconnect(listener)}
- */
-InterApplicationBus.Channel = function () { };
-/**
- *
- * Create a new channel.  Returns a promise that resolves with a {@link Channel#ChannelProvider ChannelProvider} instance for your channel.
- * You must provide a unique channelName.  If a channelName is not provided, or it is not unique, the creation will fail. EXPERIMENTAL: pass { protocols: ['rtc'] } as options to opt-in to High Throughput Channels.
- * @param channelName - Name of the channel to be created.
- * @param options - Creation options.
- *
- * @tutorial Channel.create
- */
-InterApplicationBus.Channel.create = function () { };
-/**
- *
- * Connect to a channel.  Returns a promise for a {@link Channel#ChannelClient ChannelClient} instance for that channel.
- * If you wish to send a payload to the provider, add a payload property to the options argument. EXPERIMENTAL: pass { protocols: ['rtc'] } as options to opt-in to High Throughput Channels.
- * @param channelName - Name of the target channel.
- * @param options - Connection options.
- *
- * @tutorial Channel.connect
- *
- */
-InterApplicationBus.Channel.connect = function (options) { };
-/**
- *
- * Listens for channel connections.
- * @param listener - callback to execute.
- *
- * @tutorial Channel.onChannelConnect
- */
-InterApplicationBus.Channel.onChannelConnect = function () { };
-/**
- *
- * Listen for channel disconnections.
- * @param listener - callback to execute.
- *
- * @tutorial Channel.onChannelDisconnect
- */
-InterApplicationBus.Channel.onChannelDisconnect = function () { };
-/**
- * @PORTED
- * Instance created to enable use of a channel as a provider.  Allows for communication with the {@link Channel#ChannelClient ChannelClients} by invoking an action on
- * a single client via {@link Channel#ChannelProvider#dispatch dispatch} or all clients via {@link Channel#ChannelProvider#publish publish}
- * and to listen for communication from clients by registering an action via {@link Channel#ChannelProvider#register register}.
- *
- * ##### Constructor
- *
- * Returned by {@link InterApplicationBus.Channel.create Channel.create}.
- *
- * ##### Synchronous Methods
- *  * {@link Channel#ChannelProvider#onConnection onConnection(listener)}
- *  * {@link Channel#ChannelProvider#onDisconnection onDisconnection(listener)}
- *  * {@link Channel#ChannelProvider#publish publish(action, payload)}
- *  * {@link Channel#ChannelProvider#register register(action, listener)}
- *  * {@link Channel#ChannelProvider#remove remove(action)}
- *
- * ##### Asynchronous Methods
- *  * {@link Channel#ChannelProvider#destroy destroy()}
- *  * {@link Channel#ChannelProvider#dispatch dispatch(to, action, payload)}
- *  * {@link Channel#ChannelProvider#getAllClientInfo getAllClientInfo()}
- *
- * ##### Middleware
- * Middleware functions receive the following arguments: (action, payload, senderId).
- * The return value of the middleware function will be passed on as the payload from beforeAction, to the action listener, to afterAction
- * unless it is undefined, in which case the most recently defined payload is used.  Middleware can be used for side effects.
- *  * {@link Channel#ChannelProvider#setDefaultAction setDefaultAction(middleware)}
- *  * {@link Channel#ChannelProvider#onError onError(middleware)}
- *  * {@link Channel#ChannelProvider#beforeAction beforeAction(middleware)}
- *  * {@link Channel#ChannelProvider#afterAction afterAction(middleware)}
- *
- * @memberof! Channel#
- * @hideconstructor
- * @property {InterApplicationBus.Channel~ClientIdentity[]}  connections a read-only array containing all the identities of connecting clients.
- *
- */
-class ChannelProvider {
-    /**
-     *
-     * Destroy the channel.
-     *
-     * @tutorial ChannelProvider.destroy
-     */
-    destroy() { }
-    /**
-     *
-     * Dispatch an action to a specified client. Returns a promise for the result of executing that action on the client side.
-     * @param to - Identity of the target client.
-     * @param action - Name of the action to be invoked by the client.
-     * @param payload - Payload to be sent along with the action.
-     *
-     * @tutorial Channel.dispatch
-     */
-    dispatch() { }
-    /**
-     *
-     * Register an action to be called
-     * @param action - Name of the action to be registered for channel clients to later invoke.
-     * @param listener - Function representing the action to be taken on a client dispatch.
-     * @returns - Boolean representing the successful registration of the action.
-     * @tutorial Channel.register
-     */
-    register() { }
-    /**
-     *
-     * Publish an action and payload to every connected client.
-     * Synchronously returns an array of promises for each action (see dispatch).
-     * @param action
-     * @param payload
-     *
-     * @tutorial ChannelProvider.publish
-     */
-    publish() { }
-    /**
-     *
-     * Register a listener that is called on every new client connection.
-     * It is passed the identity of the connecting client and a payload if it was provided to {@link Channel.connect}.
-     * If you wish to reject the connection, throw an error.  Be sure to synchronously provide an onConnection upon receipt of the channelProvider
-     * to ensure all potential client connections are caught by the listener.
-     * @param listener
-     *
-     * @tutorial ChannelProvider.onConnection
-     */
-    onConnection() { }
-    /**
-     *
-     * Register a listener that is called on every new client disconnection.
-     * It is passed the disconnection event of the disconnecting client.
-     * @param listener
-     *
-     * @tutorial Channel.onDisconnection
-     */
-    onDisconnection() { }
-    /**
-     *
-     * Register middleware that fires before the action.
-     * @param middleware - Function to be executed before invoking the action.
-     *
-     * @tutorial ChannelMiddleware.beforeAction
-     */
-    beforeAction() { }
-    /**
-     *
-     * Register an error handler. This is called before responding on any error.
-     * @param middleware - Function to be executed in case of an error.
-     *
-     * @tutorial ChannelMiddleware.onError
-     */
-    onError() { }
-    /**
-     *
-     * Register middleware that fires after the action.  This is passed the return value of the action.
-     * @param middleware - Function to be executed after invoking the action.
-     *
-     * @tutorial ChannelMiddleware.afterAction
-     */
-    afterAction() { }
-    /**
-     *
-     * Remove an action by action name.
-     * @param action - Name of the action to be removed.
-     *
-     * @tutorial Channel.remove
-     */
-    remove() { }
-    /**
-     *
-     * Sets a default action. This is used any time an action that has not been registered is invoked.
-     * Default behavior if not set is to throw an error.
-     * @param middleware - Function to be executed when a client invokes an action name that has not been registered.
-     *
-     * @tutorial ChannelMiddleware.setDefaultAction
-     */
-    setDefaultAction() { }
-    /** Returns an array with info on every Client connected to the Provider
-     *
-     * @tutorial Channel.getAllClientInfo
-     */
-    getAllClientInfo() { }
-}
-/**
- * @PORTED
- * Instance created to enable use of a channel as a client.  Allows for communication with the
- * {@link Channel#ChannelProvider ChannelProvider} by invoking an action on the
- * provider via {@link Channel#ChannelClient#dispatch dispatch} and to listen for communication
- * from the provider by registering an action via {@link Channel#ChannelClient#register register}.
- *
- * ##### Constructor
- * Returned by {@link InterApplicationBus.Channel.connect Channel.connect}.
- *
- * ##### Synchronous Methods
- *  * {@link Channel#ChannelClient#onDisconnection onDisconnection(listener)}
- *  * {@link Channel#ChannelClient#register register(action, listener)}
- *  * {@link Channel#ChannelClient#remove remove(action)}
- *
- * ##### Asynchronous Methods
- *  * {@link Channel#ChannelClient#disconnect disconnect()}
- *  * {@link Channel#ChannelClient#dispatch dispatch(action, payload)}
- *
- * ##### Middleware
- * Middleware functions receive the following arguments: (action, payload, senderId).
- * The return value of the middleware function will be passed on as the payload from beforeAction, to the action listener, to afterAction
- * unless it is undefined, in which case the original payload is used.  Middleware can be used for side effects.
- *  * {@link Channel#ChannelClient#setDefaultAction setDefaultAction(middleware)}
- *  * {@link Channel#ChannelClient#onError onError(middleware)}
- *  * {@link Channel#ChannelClient#beforeAction beforeAction(middleware)}
- *  * {@link Channel#ChannelClient#afterAction afterAction(middleware)}
- *
- * @hideconstructor
- * @memberof! Channel#
- * @property {InterApplicationBus.Channel~ProviderIdentity}  providerIdentity a read-only provider identity
- */
-class ChannelClient {
-    /**
-     *
-     * Disconnect from the channel.
-     * @tutorial Channel.disconnect
-     *
-     */
-    disconnect() { }
-    /**
-     *
-     * Dispatch the given action to the channel provider.  Returns a promise that resolves with the response from the provider for that action.
-     * @param action - Name of the action to be invoked by the channel provider.
-     * @param payload - Payload to be sent along with the action.
-     * @tutorial Channel.dispatch
-     *
-     */
-    dispatch() { }
-    /**
-     *
-     * Register an action to be called by the provider of the channel.
-     * @param action - Name of the action to be registered for the channel provider to later invoke.
-     * @param listener - Function representing the action to be taken on a provider dispatch.
-     *
-     * @tutorial Channel.register
-     */
-    register() { }
-    /**
-     *
-     * Register middleware that fires before the action.
-     * @param middleware - Function to be executed before invoking the action.
-     *
-     * @tutorial ChannelMiddleware.beforeAction
-     */
-    beforeAction() { }
-    /**
-     *
-     * Register a listener that is called on channel disconnection.
-     * It is passed the disconnection event of the disconnecting channel.
-     * @param listener
-     *
-     * @tutorial Channel.onDisconnection
-     */
-    onDisconnection() { }
-    /**
-     * Register an error handler. This is called before responding on any error.
-     * @param middleware - Function to be executed in case of an error.
-     *
-     * @tutorial ChannelMiddleware.onError
-     */
-    onError() { }
-    /**
-     *
-     * Register middleware that fires after the action.  This is passed the return value of the action.
-     * @param middleware - Function to be executed after invoking the action.
-     *
-     * @tutorial ChannelMiddleware.afterAction
-     */
-    afterAction() { }
-    /**
-     *
-     * Remove an action by action name.
-     * @param action - Name of the action to be removed.
-     *
-     * @tutorial Channel.remove
-     */
-    remove() { }
-    /**
-     *
-     * Sets a default action. This is used any time an action that has not been registered is invoked.
-     * Default behavior if not set is to throw an error.
-     * @param middleware - Function to be executed when a client invokes an action name that has not been registered.
-     *
-     * @tutorial ChannelMiddleware.setDefaultAction
-     */
-    setDefaultAction() { }
-}
-/**
- * Channel action callback signature
- * @callback Channel#ChannelProvider~Action
- * @param payload - Payload sent along with the message.
- * @param identity - Identity of the sender.
- */
-/**
- * Channel action callback signature
- * @callback Channel#ChannelClient~Action
- * @param payload - Payload sent along with the message.
- * @param identity - Identity of the sender.
- */
-/**
- * Middleware function signature
- * @callback Channel#ChannelProvider~Middleware
- * @param action - Action to be invoked.
- * @param payload - Payload sent along with the message (or error for error middleware).
- * @param identity - Identity of the sender.
- */
-/**
- * Middleware function signature
- * @callback Channel#ChannelClient~Middleware
- * @param action - Action to be invoked.
- * @param payload - Payload sent along with the message (or error for error middleware).
- * @param identity - Identity of the sender.
- */
-/**
- * Callback for the channel onConnection or onDisconnection. If it errors connection will be rejected.
- * @callback Channel#ChannelProvider~ConnectionListener
- * @param identity - Identity of the client attempting to connect to the channel.
- * @param payload - Payload sent with connection request.
- */
-/**
- * @REMOVED
- * Callback for onChannelConnect or onChannelDisconnect.
- * @typedef {object} InterApplicationBus.Channel~ConnectionEvent
- * @property {string} channelId - Identifier of the channel.
- * @property {string} uuid - Channel provider uuid.
- * @property {string} [name] - Channel provider name.
- * @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.
- * @property {any} [payload] - Payload to pass to ChannelProvider onConnection action.
- * @property {boolean} [wait=true] - If true will wait for ChannelProvider to connect. If false will fail if ChannelProvider is not found.
- *
- */
-/**
- * @PORTED
- * Provider Identity.
- * @typedef {object} InterApplicationBus.Channel~ProviderIdentity
- * @property {string} uuid - Channel provider uuid.
- * @property {string} [name] - Channel provider name.
- * @property {string} channelId - Identifier of the channel.
- * @property {boolean} [isExternal] - true if it's external connection.
- * @property {string} channelName - Name of the channel.
- *
- */
-/**
- * @PORTED
- * Client Identity.
- * @typedef {object} InterApplicationBus.Channel~ClientIdentity
- * @property {string} uuid - Channel client uuid.
- * @property {string} name - Channel client name.
- * @property {string} endpointId - Unique identifier for a client, because there can be multiple clients at one name/uuid entity.
- *
- */
-/**
- * @PORTED
- * Extended Client Information
- * @typedef {object} InterApplicationBus.Channel~ClientInfo
- * @property {string} uuid - Channel client uuid
- * @property {string} name - Channel client name
- * @property {string} endpointId - Unique identifier for a client, because there can be multiple clients at one name/uuid entity.
- * @property {string} entityType - Indicates if the client belongs to a Window or View
- * @property {string} connectionUrl - URL of the View or Window at the time of connection to the Channel Provider.
- */

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

@@ -1,117 +0,0 @@
-import type * as OpenFin from '../../../OpenFin';
-import { ChannelBase } from './channel';
-import { Transport } from '../../../transport/transport';
-import { AnyStrategy } from './protocols/strategy-types';
-type ProviderIdentity = OpenFin.ProviderIdentity;
-type DisconnectionListener = (providerIdentity: ProviderIdentity) => any;
-export type RoutingInfo = ProviderIdentity & {
-    endpointId: string;
-};
-/**
- * Instance created to enable use of a channel as a client.  Allows for communication with the
- * {@link ChannelProvider ChannelProvider} by invoking an action on the
- * provider via {@link ChannelClient#dispatch dispatch} and to listen for communication
- * from the provider by registering an action via {@link ChannelClient#register register}.
- *
- * Synchronous Methods:
- *  * {@link ChannelClient#onDisconnection onDisconnection(listener)}
- *  * {@link ChannelClient#register register(action, listener)}
- *  * {@link ChannelClient#remove remove(action)}
- *
- * Asynchronous Methods:
- *  * {@link ChannelClient#disconnect disconnect()}
- *  * {@link ChannelClient#dispatch dispatch(action, payload)}
- *
- * Middleware:
- * <br>Middleware functions receive the following arguments: (action, payload, senderId).
- * The return value of the middleware function will be passed on as the payload from beforeAction, to the action listener, to afterAction
- * unless it is undefined, in which case the original payload is used.  Middleware can be used for side effects.
- *  * {@link ChannelClient#setDefaultAction setDefaultAction(middleware)}
- *  * {@link ChannelClient#onError onError(middleware)}
- *  * {@link ChannelClient#beforeAction beforeAction(middleware)}
- *  * {@link ChannelClient#afterAction afterAction(middleware)}
- */
-export default class ChannelClient extends ChannelBase {
-    #private;
-    private disconnectListener;
-    private endpointId;
-    /**
-     * @internal
-     */
-    static closeChannelByEndpointId(id: string): void;
-    /**
-     * @internal
-     * closes the corresponding channel and invokes the disconnect listener if an event payload is passed.
-     */
-    static handleProviderDisconnect(eventPayload: ProviderIdentity): void;
-    /**
-     * @internal
-     */
-    constructor(routingInfo: RoutingInfo, wire: Transport, strategy: AnyStrategy);
-    protected processAction: (action: string, payload: any, senderIdentity: ProviderIdentity | OpenFin.ClientIdentity) => Promise<any>;
-    /**
-     * a read-only provider identity
-     */
-    get providerIdentity(): ProviderIdentity;
-    /**
-     * Dispatch the given action to the channel provider. Returns a promise that resolves with the response from
-     * the provider for that action.
-     *
-     * @param action
-     * @param payload
-     *
-     * @example
-     *
-     * ```js
-     * (async ()=> {
-     *     const client = await fin.InterApplicationBus.Channel.connect('channelName');
-     *
-     *     await client.register('client-action', (payload, identity) => {
-     *         console.log(payload, identity);
-     *         return {
-     *             echo: payload
-     *         };
-     *     });
-     *
-     *     const providerResponse = await client.dispatch('provider-action', { message: 'Hello From the client'});
-     *     console.log(providerResponse);
-     * })();
-     * ```
-     */
-    dispatch(action: string, payload?: any): Promise<any>;
-    /**
-     * Register a listener that is called on provider disconnection. It is passed the disconnection event of the
-     * disconnecting provider.
-     *
-     * @param listener
-     *
-     * @example
-     *
-     * ```js
-     * (async ()=> {
-     *     const client = await fin.InterApplicationBus.Channel.connect('channelName');
-     *
-     *     await client.onDisconnection(evt => {
-     *         console.log('Provider disconnected', `uuid: ${evt.uuid}, name: ${evt.name}`);
-     *     });
-     * })();
-     * ```
-     */
-    onDisconnection(listener: DisconnectionListener): void;
-    /**
-     * Disconnects the client from the channel.
-     *
-     * @example
-     *
-     * ```js
-     * (async ()=> {
-     *     const client = await fin.InterApplicationBus.Channel.connect('channelName');
-     *
-     *     await client.disconnect();
-     * })();
-     * ```
-     */
-    disconnect(): Promise<void>;
-    sendDisconnectAction(): Promise<void>;
-}
-export {};

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

@@ -1,181 +0,0 @@
-"use strict";
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    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 __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
-    if (kind === "m") throw new TypeError("Private method is not writable");
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
-    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
-};
-var _ChannelClient_protectedObj, _ChannelClient_strategy, _ChannelClient_close;
-Object.defineProperty(exports, "__esModule", { value: true });
-const channel_1 = require("./channel");
-const channelClientsByEndpointId = new Map();
-/**
- * Instance created to enable use of a channel as a client.  Allows for communication with the
- * {@link ChannelProvider ChannelProvider} by invoking an action on the
- * provider via {@link ChannelClient#dispatch dispatch} and to listen for communication
- * from the provider by registering an action via {@link ChannelClient#register register}.
- *
- * Synchronous Methods:
- *  * {@link ChannelClient#onDisconnection onDisconnection(listener)}
- *  * {@link ChannelClient#register register(action, listener)}
- *  * {@link ChannelClient#remove remove(action)}
- *
- * Asynchronous Methods:
- *  * {@link ChannelClient#disconnect disconnect()}
- *  * {@link ChannelClient#dispatch dispatch(action, payload)}
- *
- * Middleware:
- * <br>Middleware functions receive the following arguments: (action, payload, senderId).
- * The return value of the middleware function will be passed on as the payload from beforeAction, to the action listener, to afterAction
- * unless it is undefined, in which case the original payload is used.  Middleware can be used for side effects.
- *  * {@link ChannelClient#setDefaultAction setDefaultAction(middleware)}
- *  * {@link ChannelClient#onError onError(middleware)}
- *  * {@link ChannelClient#beforeAction beforeAction(middleware)}
- *  * {@link ChannelClient#afterAction afterAction(middleware)}
- */
-class ChannelClient extends channel_1.ChannelBase {
-    /**
-     * @internal
-     */
-    static closeChannelByEndpointId(id) {
-        const channel = channelClientsByEndpointId.get(id);
-        if (channel) {
-            __classPrivateFieldGet(channel, _ChannelClient_close, "f").call(channel);
-        }
-    }
-    /**
-     * @internal
-     * 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);
-            }
-        }
-    }
-    /**
-     * @internal
-     */
-    constructor(routingInfo, wire, strategy) {
-        super();
-        _ChannelClient_protectedObj.set(this, void 0);
-        _ChannelClient_strategy.set(this, void 0);
-        // needs to be bound;
-        this.processAction = (action, payload, senderIdentity) => super.processAction(action, payload, senderIdentity);
-        _ChannelClient_close.set(this, () => {
-            channelClientsByEndpointId.delete(this.endpointId);
-            __classPrivateFieldGet(this, _ChannelClient_strategy, "f").close();
-        });
-        __classPrivateFieldSet(this, _ChannelClient_protectedObj, new channel_1.ProtectedItems(routingInfo, wire), "f");
-        this.disconnectListener = () => undefined;
-        this.endpointId = routingInfo.endpointId;
-        __classPrivateFieldSet(this, _ChannelClient_strategy, strategy, "f");
-        channelClientsByEndpointId.set(this.endpointId, this);
-        strategy.receive(this.processAction);
-    }
-    /**
-     * a read-only provider identity
-     */
-    get providerIdentity() {
-        const protectedObj = __classPrivateFieldGet(this, _ChannelClient_protectedObj, "f");
-        return protectedObj.providerIdentity;
-    }
-    /**
-     * Dispatch the given action to the channel provider. Returns a promise that resolves with the response from
-     * the provider for that action.
-     *
-     * @param action
-     * @param payload
-     *
-     * @example
-     *
-     * ```js
-     * (async ()=> {
-     *     const client = await fin.InterApplicationBus.Channel.connect('channelName');
-     *
-     *     await client.register('client-action', (payload, identity) => {
-     *         console.log(payload, identity);
-     *         return {
-     *             echo: payload
-     *         };
-     *     });
-     *
-     *     const providerResponse = await client.dispatch('provider-action', { message: 'Hello From the client'});
-     *     console.log(providerResponse);
-     * })();
-     * ```
-     */
-    async dispatch(action, payload) {
-        if (__classPrivateFieldGet(this, _ChannelClient_strategy, "f").isEndpointConnected(this.providerIdentity.channelId)) {
-            return __classPrivateFieldGet(this, _ChannelClient_strategy, "f").send(this.providerIdentity.channelId, action, payload);
-        }
-        throw new Error('The client you are trying to dispatch from is disconnected from the target provider.');
-    }
-    /**
-     * Register a listener that is called on provider disconnection. It is passed the disconnection event of the
-     * disconnecting provider.
-     *
-     * @param listener
-     *
-     * @example
-     *
-     * ```js
-     * (async ()=> {
-     *     const client = await fin.InterApplicationBus.Channel.connect('channelName');
-     *
-     *     await client.onDisconnection(evt => {
-     *         console.log('Provider disconnected', `uuid: ${evt.uuid}, name: ${evt.name}`);
-     *     });
-     * })();
-     * ```
-     */
-    onDisconnection(listener) {
-        this.disconnectListener = (payload) => {
-            try {
-                listener(payload);
-            }
-            catch (err) {
-                throw new Error(`Error while calling the onDisconnection callback: ${err.message}`);
-            }
-            finally {
-                this.disconnectListener = () => undefined;
-            }
-        };
-    }
-    /**
-     * Disconnects the client from the channel.
-     *
-     * @example
-     *
-     * ```js
-     * (async ()=> {
-     *     const client = await fin.InterApplicationBus.Channel.connect('channelName');
-     *
-     *     await client.disconnect();
-     * })();
-     * ```
-     */
-    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', {
-            channelName,
-            uuid,
-            name,
-            endpointId: this.endpointId
-        });
-    }
-}
-exports.default = ChannelClient;
-_ChannelClient_protectedObj = new WeakMap(), _ChannelClient_strategy = new WeakMap(), _ChannelClient_close = new WeakMap();