@openfin/core 33.76.36 → 33.77.1

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

@@ -1,334 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ChannelBase = exports.ProtectedItems = void 0;
-const resultOrPayload = (func) => async (topic, payload, senderIdentity) => {
-    const res = await func(topic, payload, senderIdentity);
-    return res === undefined ? payload : res;
-};
-class ProtectedItems {
-    /**
-     * @internal
-     */
-    constructor(providerIdentity, wire) {
-        this.providerIdentity = providerIdentity;
-        this.wire = wire;
-    }
-}
-exports.ProtectedItems = ProtectedItems;
-class ChannelBase {
-    static defaultAction(topic) {
-        throw new Error(`No action registered at target for ${topic}`);
-    }
-    constructor() {
-        this.subscriptions = new Map();
-    }
-    async processAction(topic, payload, senderIdentity) {
-        try {
-            const mainAction = this.subscriptions.has(topic)
-                ? this.subscriptions.get(topic)
-                : (currentPayload, id) => { var _a; return ((_a = this.defaultAction) !== null && _a !== void 0 ? _a : ChannelBase.defaultAction)(topic, currentPayload, id); };
-            const preActionProcessed = this.preAction ? await this.preAction(topic, payload, senderIdentity) : payload;
-            const actionProcessed = await mainAction(preActionProcessed, senderIdentity);
-            return this.postAction ? await this.postAction(topic, actionProcessed, senderIdentity) : actionProcessed;
-        }
-        catch (e) {
-            if (this.errorMiddleware) {
-                return this.errorMiddleware(topic, e, senderIdentity);
-            }
-            throw e;
-        }
-    }
-    /**
-     * Register middleware that fires before the action.
-     *
-     * @param func
-     *
-     * @example
-     *
-     * Channel Provider:
-     * ```js
-     * (async ()=> {
-     *     const provider = await fin.InterApplicationBus.Channel.create('channelName');
-     *
-     *     provider.register('provider-action', (payload, identity) => {
-     *         console.log(payload, identity);
-     *         return {
-     *             echo: payload
-     *         };
-     *     });
-     *
-     *     provider.beforeAction((action, payload, identity) => {
-     *         //The payload can be altered here before handling the action.
-     *         payload.received = Date.now();
-     *         return payload;
-     *     });
-     *
-     * })();
-     * ```
-     *
-     * Channel Client:
-     * ```js
-     * (async ()=> {
-     *     const client = await fin.InterApplicationBus.Channel.connect('channelName');
-     *
-     *     client.register('client-action', (payload, identity) => {
-     *         console.log(payload, identity);
-     *         return {
-     *             echo: payload
-     *         };
-     *     });
-     *
-     *     client.beforeAction((action, payload, identity) => {
-     *         //The payload can be altered here before handling the action.
-     *         payload.received = Date.now();
-     *         return payload;
-     *     });
-     *
-     *     const providerResponse = await client.dispatch('provider-action', { message: 'Hello From the client' });
-     *     console.log(providerResponse);
-     * })();
-     * ```
-     */
-    beforeAction(func) {
-        if (this.preAction) {
-            throw new Error('Already registered beforeAction middleware');
-        }
-        this.preAction = resultOrPayload(func);
-    }
-    /**
-     * Register an error handler. This is called before responding on any error.
-     *
-     * @param func
-     *
-     * Channel Provider:
-     * ```js
-     * (async ()=> {
-     *     const provider = await fin.InterApplicationBus.Channel.create('channelName');
-     *
-     *     provider.register('provider-action', (payload, identity) => {
-     *         console.log(payload);
-     *         throw new Error('Action error');
-     *         return {
-     *             echo: payload
-     *         };
-     *     });
-     *
-     *     provider.onError((action, error, identity) => {
-     *         console.log('uncaught Exception in action:', action);
-     *         console.error(error);
-     *     });
-     *
-     * })();
-     * ```
-     *
-     * Channel Client:
-     * ```js
-     * (async ()=> {
-     *     const client = await fin.InterApplicationBus.Channel.connect('channelName');
-     *
-     *     client.register('client-action', (payload, identity) => {
-     *         console.log(payload);
-     *         throw new Error('Action error');
-     *         return {
-     *             echo: payload
-     *         };
-     *     });
-     *
-     *     client.onError((action, error, identity) => {
-     *         console.log('uncaught Exception in action:', action);
-     *         console.error(error);
-     *     });
-     * })();
-     * ```
-     */
-    onError(func) {
-        if (this.errorMiddleware) {
-            throw new Error('Already registered error middleware');
-        }
-        this.errorMiddleware = func;
-    }
-    /**
-     * Register middleware that fires after the action.
-     *
-     * @param func
-     *
-     * @remarks If the action does not return the payload, then the afterAction will not have access to the payload object.
-     *
-     * @example
-     *
-     * Channel Provider:
-     * ```js
-     * (async ()=> {
-     *     const provider = await fin.InterApplicationBus.Channel.create('channelName');
-     *
-     *     await provider.register('provider-action', (payload, identity) => {
-     *         return {
-     *             echo: payload
-     *         };
-     *     });
-     *
-     *     await provider.afterAction((action, payload, identity) => {
-     *         //the payload can be altered here after handling the action but before sending an acknowledgement.
-     *         payload.sent = date.now();
-     *         return payload;
-     *     });
-     *
-     * })();
-     * ```
-     *
-     * Channel Client:
-     * ```js
-     * (async ()=> {
-     *     const client = await fin.InterApplicationBus.Channel.connect('channelName');
-     *
-     *     await client.register('client-action', (payload, identity) => {
-     *         return {
-     *             echo: payload
-     *         };
-     *     });
-     *
-     *     await client.afterAction((action, payload, identity) => {
-     *         //the payload can be altered here after handling the action but before sending an acknowledgement.
-     *         payload.sent = date.now();
-     *         return payload;
-     *     });
-     *
-     * })();
-     * ```
-     */
-    afterAction(func) {
-        if (this.postAction) {
-            throw new Error('Already registered afterAction middleware');
-        }
-        this.postAction = resultOrPayload(func);
-    }
-    /**
-     * Remove an action by action name.
-     *
-     * @param action
-     *
-     * @example
-     *
-     * ```js
-     * (async ()=> {
-     *     const provider = await fin.InterApplicationBus.Channel.create('channelName');
-     *
-     *     await provider.register('provider-action', (payload, identity) => {
-     *         console.log(payload);
-     *         return {
-     *             echo: payload
-     *         };
-     *     });
-     *
-     *     await provider.remove('provider-action');
-     *
-     * })();
-     * ```
-     */
-    remove(action) {
-        this.subscriptions.delete(action);
-    }
-    /**
-     * Registers a default action. This is used any time an action that has not been registered is invoked.
-     *
-     * @example
-     *
-     * Channel Provider:
-     * ```js
-     * (async ()=> {
-     *     const provider = await fin.InterApplicationBus.Channel.create('channelName');
-     *
-     *     await provider.setDefaultAction((action, payload, identity) => {
-     *         console.log(`Client with identity ${JSON.stringify(identity)} has attempted to dispatch unregistered action: ${action}.`);
-     *
-     *         return {
-     *             echo: payload
-     *         };
-     *     });
-     *
-     * })();
-     * ```
-     *
-     * Channel Client:
-     * ```js
-     * (async ()=> {
-     *     const client = await fin.InterApplicationBus.Channel.connect('channelName');
-     *
-     *     await client.setDefaultAction((action, payload, identity) => {
-     *         console.log(`Provider with identity ${JSON.stringify(identity)} has attempted to dispatch unregistered action: ${action}.`);
-     *
-     *         return {
-     *             echo: payload
-     *         };
-     *     });
-     *
-     * })();
-     * ```
-     * @param func
-     */
-    setDefaultAction(func) {
-        if (this.defaultAction) {
-            throw new Error('default action can only be set once');
-        }
-        else {
-            this.defaultAction = func;
-        }
-    }
-    /**
-     * Register an action to be called by dispatching from any channelClient or channelProvider.
-     *
-     * @param topic
-     * @param listener
-     *
-     * @remarks The return value will be sent back as an acknowledgement to the original caller. You can throw an
-     * error to send a negative-acknowledgement and the error will reject the promise returned to the sender by the
-     * dispatch call.  Once a listener is registered for a particular action, it stays in place receiving and responding
-     * to incoming messages until it is removed.  This messaging mechanism works exactly the same when messages are
-     * dispatched from the provider to a client.  However, the provider has an additional publish method that sends messages
-     * to all connected clients.
-     *
-     * Because multiple clients can share the same `name` and `uuid`, in order to distinguish between individual clients,
-     * the `identity` argument in a provider's registered action callback contains an `endpointId` property. When dispatching
-     * from a provider to a client, the `endpointId` property must be provided in order to send an action to a specific client.
-     *
-     * @example
-     *
-     * Channel Provider:
-     * ```js
-     * (async ()=> {
-     *     const provider = await fin.InterApplicationBus.Channel.create('channelName');
-     *
-     *     await provider.register('provider-action', (payload, identity) => {
-     *        console.log('Action dispatched by client: ', identity);
-     *        console.log('Payload sent in dispatch: ', payload);
-     *
-     *        return { echo: payload };
-     *    });
-     * })();
-     * ```
-     *
-     * Channel Client:
-     * ```js
-     * (async ()=> {
-     *     const client = await fin.InterApplicationBus.Channel.connect('channelName');
-     *
-     *     await client.register('client-action', (payload, identity) => {
-     *        console.log('Action dispatched by client: ', identity);
-     *        console.log('Payload sent in dispatch: ', payload);
-     *
-     *        return { echo: payload };
-     *    });
-     * })();
-     * ```
-     */
-    register(topic, listener) {
-        if (this.subscriptions.has(topic)) {
-            throw new Error(`Subscription already registered for action: ${topic}. Unsubscribe before adding new subscription`);
-        }
-        else {
-            this.subscriptions.set(topic, listener);
-            return true;
-        }
-    }
-}
-exports.ChannelBase = ChannelBase;

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

@@ -1,342 +0,0 @@
-declare const InterApplicationBus: any;
-/**
- * @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.
- *
- */
-declare class ChannelProvider {
-    /**
-     *
-     * Destroy the channel.
-     *
-     * @tutorial ChannelProvider.destroy
-     */
-    destroy(): void;
-    /**
-     *
-     * 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(): void;
-    /**
-     *
-     * 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(): void;
-    /**
-     *
-     * 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(): void;
-    /**
-     *
-     * 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(): void;
-    /**
-     *
-     * 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(): void;
-    /**
-     *
-     * Register middleware that fires before the action.
-     * @param middleware - Function to be executed before invoking the action.
-     *
-     * @tutorial ChannelMiddleware.beforeAction
-     */
-    beforeAction(): void;
-    /**
-     *
-     * 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(): void;
-    /**
-     *
-     * 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(): void;
-    /**
-     *
-     * Remove an action by action name.
-     * @param action - Name of the action to be removed.
-     *
-     * @tutorial Channel.remove
-     */
-    remove(): void;
-    /**
-     *
-     * 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(): void;
-    /** Returns an array with info on every Client connected to the Provider
-     *
-     * @tutorial Channel.getAllClientInfo
-     */
-    getAllClientInfo(): void;
-}
-/**
- * @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
- */
-declare class ChannelClient {
-    /**
-     *
-     * Disconnect from the channel.
-     * @tutorial Channel.disconnect
-     *
-     */
-    disconnect(): void;
-    /**
-     *
-     * 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(): void;
-    /**
-     *
-     * 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(): void;
-    /**
-     *
-     * Register middleware that fires before the action.
-     * @param middleware - Function to be executed before invoking the action.
-     *
-     * @tutorial ChannelMiddleware.beforeAction
-     */
-    beforeAction(): void;
-    /**
-     *
-     * 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(): void;
-    /**
-     * 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(): void;
-    /**
-     *
-     * 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(): void;
-    /**
-     *
-     * Remove an action by action name.
-     * @param action - Name of the action to be removed.
-     *
-     * @tutorial Channel.remove
-     */
-    remove(): void;
-    /**
-     *
-     * 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(): void;
-}
-/**
- * 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.
- */