@finsemble/finsemble-ui 10.0.0-beta.3 → 10.0.0-iocd.2

package/clients/routerClient.d.ts

@@ -0,0 +1,521 @@
+/*!
+ * Copyright 2017 - 2020 by ChartIQ, Inc.
+ * All rights reserved.
+ */
+/**
+ * For communications amongst desktop services, components, or outside the container entirely, Finsemble provides an event infrastructure with high level protocols.
+ * The Router is the center of this functionality, sending and receiving messages between windows.
+ *
+ *
+ * See the [Router tutorial](/docs/how-finsemble-works/TheRouter) for an overview.
+ * @module RouterClient
+ */
+import { RouterMessage, RouterListenerUnsubscribe, RouterConfig, SendToRouter, ListenerCallback, TransmitMessageFromService, SubscribeCallback, StandardQueryResponse, SubscriberResponse, ResponderMessage, PublishCallback, QueryResponseCallback, UnsubscribeCallback, NotifyCallback, QueryMessageFromService, QueryResponseFromService, NotifyMessageFromService, PublishMessageFromService, SubscribeMessageFromService, UnsubscribeMessageFromService } from "../platform/services/router/types";
+import { StandardError, StandardErrorCallback } from "../types";
+export { AvailableTransports, ConnectionMetadata, IACTransportInfo, IncomingTransportInfo, IPCTransportInfo, ListenerCallback, ListenerResponse, PublishCallback, PublishHookMessage, PublishMessage, PublishMessageFromService, QueryMessage, QueryMessageFromService, QueryResponse, QueryResponseCallback, ResponderMessage, RouterConfig, RouterHeader, RouterListenerUnsubscribe, RouterMessage, RouterResponse, RouterTransportSettings, SendToRouter, SharedWorkerTransportInfo, StandardQueryResponse, SubscribeCallback, SubscribeHookMessage, SubscribeMessage, SubscribeMessageFromService, SubscriberResponse, TransmitMessage, TransmitMessageFromService, TransportInfo, UnsubscribeCallback, UnsubscribeHookMessage, UnsubscribeMessage, UnsubscribeMessageFromService, } from "../platform/services/router/types";
+/**
+ * @ignore
+ */
+export declare class RouterConnection {
+    queue: SendToRouter[];
+    started: boolean;
+    handshakeHandler: any;
+    timeCalibrationHandler: any;
+    clientName: string;
+    transport: any;
+    isRouterReady: boolean;
+    isTransportFailed: boolean;
+    parentReadyCallbackQueue: (() => void)[];
+    parentFailureCallbackQueue: (() => void)[];
+    mapListeners: Record<string, ListenerCallback[]>;
+    mapQueryResponders: Record<string, StandardErrorCallback<ResponderMessage<any, any>>>;
+    mapPubSubResponders: Record<string, {
+        subscribeCallback?: SubscribeCallback;
+        publishCallback?: PublishCallback;
+        unsubscribeCallback?: UnsubscribeCallback;
+    }>;
+    mapPubSubResponderState: Record<string, any>;
+    mapPubSubResponderRegEx: Record<string, RegExp>;
+    pubsubListOfSubscribers: Record<string, string[]>;
+    mapSubscribersID: Record<string, NotifyCallback>;
+    mapSubscribersTopic: Record<string, string>;
+    mapQueryResponses: Record<string, QueryResponseCallback>;
+    mapQueryResponseTimeOut: Record<string, any>;
+    constructor();
+    onReadyCallBack(): void;
+    sendToRouterService(message: SendToRouter): void;
+    originatedHere(message: SendToRouter): boolean;
+    invokeListeners(message: TransmitMessageFromService): void;
+    /**
+     * When an incoming query request is received from a client (via the RouterService) we look
+     * up the registered responder and pass it the incoming query along with
+     * a sendQueryResponse() method that will return the data back to the client.
+     */
+    invokeResponder(queryMessage: QueryMessageFromService): void;
+    /**
+     * Received a query response back from the router service. Look up the callback
+     * and invoke it with the received data.
+     */
+    invokeQueryResponse(message: QueryResponseFromService): void;
+    /**
+     * Updates pub/sub subscriptions whenever state updates (or on initial subscribe to the topic).
+     * This looks up local subscribers and calls them with the pub/sub state.
+     */
+    invokeNotifyCallback(notifyMessage: NotifyMessageFromService): void;
+    /**
+     * Returns a responder given a topic. The topic could be a regex key, in
+     * which case mapPubSubResponderRegEx is searched
+     */
+    private findResponder;
+    invokePublishEvent(publishMessage: PublishMessageFromService): void;
+    invokeSubscribeEvent(subscribeMessage: SubscribeMessageFromService): void;
+    invokeUnsubscribeEvent(unsubscribeMessage: UnsubscribeMessageFromService): void;
+    sendNotifyToSubscriber(subscribeMessage: SubscribeMessageFromService, err: string | null, notifyData?: any): void;
+    removeSubscribers(topic: string, subscribeID: string): void;
+    routeIncomingMessage(incomingMessage: SendToRouter): void;
+    asyncConnectToEventRouter(routerConfig: RouterConfig, transportName: string, cb?: () => void): void;
+    addPubSubResponderCallBack<T>(topic: string | RegExp, subscribeCallback?: SubscribeCallback<T>, publishCallback?: PublishCallback<T>, unsubscribeCallback?: UnsubscribeCallback): boolean;
+    /**
+     * Estimates offset to align the reference time with Router Service.  Does this by exchanging messages with RouterService, getting the service's time, and estimating communication delay.
+     */
+    calibrateTimeWithRouterService(callback: (offset: number) => void): void;
+    /**
+     * Starts the router client, creating a unique name to represent this instance, initiating the
+     * transport that is specified in routerConfig, and then registering itself with the router
+     * service. Most of this work occurs in the internal function `asyncConnectToEventRouter()`.
+     */
+    start(routerConfig: RouterConfig): Promise<string | null>;
+    disconnectFromService(): void;
+    /**
+     * Stops the router. This disconnects all responders and listeners and closes all transports.
+     * Once stopped, a router may be started again.
+     */
+    stop(): void;
+    onReady(cb?: () => void): Promise<void>;
+    onFailure(cb?: () => void): Promise<void>;
+    addListener<T = any>(channel: string, eventHandler: ListenerCallback<T>): RouterListenerUnsubscribe;
+    transmit<T = any>(toChannel: string, data: T, options?: {
+        suppressWarnings: boolean;
+    }): void;
+    removeListener(channel: string, eventHandler: Function): void;
+    addResponder<Q = any, R = any>(channel: string, queryEventHandler: StandardErrorCallback<ResponderMessage<Q, R>>): void;
+    query<Q = any, R = any>(responderChannel: string, queryEvent: Q, queryParams: {
+        timeout?: number;
+        logWhenNoResponder?: boolean;
+    } | QueryResponseCallback<R> | undefined, responseEventHandler?: QueryResponseCallback<R>): Promise<StandardQueryResponse<R>>;
+    removeResponder(responderChannel: string): void;
+    addPubSubResponder<T = any>(topic: string | RegExp, initialState?: object, params?: {
+        subscribeCallback?: SubscribeCallback<T>;
+        unsubscribeCallback?: UnsubscribeCallback;
+        publishCallback?: PublishCallback<T>;
+    }, callback?: (err?: string | Error, result?: "success") => void): void;
+    removePubSubResponder(topic: string | RegExp): void;
+    subscribe<T = any>(topic: string, notifyCallback: (err: StandardError, response: SubscriberResponse<T>) => void): {
+        subscribeID: string;
+        topic: string;
+    };
+    publish<T = any>(topic: string, data: T): void;
+    unsubscribe(subscribeIDStruct: {
+        subscribeID: string;
+        topic: string;
+    }): void;
+    /**
+     * Test an incoming router message to see if it originated from the same origin (e.g. a trusted source...not cross-domain). Currently same origin is known only because a sharedWorker transport is used (by definition SharedWorkers do not work cross-domain).  This means any message coming in over the Inter-application Bus will not be trusted; however, by default all same-origin components and services connect to the router using a SharedWorker transport.
+     *
+     * ```javascript
+     * FSBL.Clients.RouterClient.trustedMessage(incomingRouterMessage);
+     * ```
+     * @param {object} incomingMessage an incoming router message (e.g. transmit, query, notification) to test to see if trusted.
+     */
+    trustedMessage(incomingMessage: RouterMessage): boolean;
+    disconnectAll(): void;
+}
+/**
+ * @ignore
+ */
+export declare const RouterController: {
+    /**
+     * Used to start the router. This is called by entry points (FSBLDesktop.ts, FSBLFreestanding.ts, FSBLService.ts [ in baseService, serviceManager's bootEngine.ts, logger's main.jsx ]  )
+     * @private
+     */
+    start: (params: RouterConfig) => Promise<string | null>;
+    /**
+     * Used to stop the router. Generally used for unit testing.
+     * @private
+     */
+    stop: () => void;
+    /**
+     * Used internally by Logger client
+     */
+    calibrateTimeWithRouterService(callback: (offset: number) => void): void;
+};
+/**
+ * @language javascript, java, dotnet
+ * @deprecated Don't use this method. (Apps that use the FSBL API and wait on the global `onReady` event are guaranteed that the router will be ready). Internal code
+ * should wait on Startup.onReady().
+ *
+ * Checks if Router is ready. May be invoked multiple times. Invokes optional callback and resolves promise when ready, which may be immediately.  Router is not ready until underlying transport to Router Service is ready.
+ *
+ * @param {function} [cb] Optional callback function to invoke when Router is ready.
+ * @return {Promise} Promise resolves when Router is ready
+ */
+export declare const onReady: (cb?: () => void) => Promise<void>;
+/**
+ * @language javascript, java, dotnet
+ * May be invoked multiple times. Invokes optional callback and resolves promise if router client fails, typically due to underlying transport failure.
+ *
+ * @param {function} [cb] Optional callback function to invoke if the routerClient fail due to a loss of connectivity.
+ * @return {Promise} Promise resolves on Router failure
+ */
+export declare const onFailure: (cb?: () => void) => Promise<void>;
+/**
+ * @language javascript, java, dotnet
+ * Adds a listener for incoming transmit events on the specified channel. Each of the incoming events will trigger the specified event handler. The number of listeners is not limited (either local to this Finsemble window or in a separate Finsemble window).
+ *
+ * See [`transmit`](#transmit) for sending a corresponding event message to the listener. See [`removeListener`](#removelistener) to remove the listener.
+ *
+ * ```javascript
+ * FSBL.Clients.RouterClient.addListener("SomeChannelName", function (error, response) {
+ * 	if (error) {
+ *  		Logger.system.error("ChannelA Error: " + JSON.stringify(error));
+ * 	} else {
+ *  		var data = response.data;
+ *  		if (response.originatedHere()) {
+ *   			Logger.system.warn("Received a message from the calling window, ignoring");
+ *  		} else {
+ * 			// Logic to perform with data
+ * 		}
+ * 	}
+ * });
+ * ```
+ * @param {string} channel A unique string to identify the channel (must match corresponding transmit channel name).
+ * @param {function} eventHandler A callback handling any possible error and the response. Use <b>response.originatedHere()</b> to determine if the message came from the same window. (see example below).
+ * @return {RouterListenerUnsubscribe} Returns a function that can be called to unsubscribe (convenient alternative to removeListener)
+ */
+export declare const addListener: <T = any>(channel: string, eventHandler: ListenerCallback<T>) => RouterListenerUnsubscribe;
+/**
+ * @language javascript, java, dotnet
+ * Transmits data to all listeners on the specified channel. If there are no listeners on the channel, the event is discarded without error. All listeners on the channel in this Finsemble window and other Finsemble windows will receive the transmit.
+ *
+ * See [`addListener`](#addlistener) to add a listener to receive the transmit.
+ *
+ * ```javascript
+ * FSBL.Clients.RouterClient.transmit("SomeChannelName", event);
+ * ```
+ * @param {string} toChannel A unique string to identify the channel (must match corresponding listener channel name).
+ * @param {any} data An object or primitive type to be transmitted.
+ * @param {object} options An object containing options for your transmission.
+ * @param {boolean} options.suppressWarnings By default, the Router will log warnings if you transmit to a channel with no listeners. Set this to true to eliminate those warnings.
+ */
+export declare const transmit: <T = any>(toChannel: string, data: T, options?: {
+    suppressWarnings: boolean;
+}) => void;
+/**
+ * @language javascript, java, dotnet
+ * Removes an event listener from the specified channel for the specific event handler; only listeners created locally can be removed.
+ *
+ * See [`addListener`](#addlistener) for corresponding add of a listener.
+ *
+ * @param {string} channel The unique channel name from which to remove the listener.
+ * @param {function} eventHandler Function used for the event handler when the listener was added.
+ */
+export declare const removeListener: (channel: string, eventHandler: Function) => void;
+/**
+ * @language javascript, java, dotnet
+ * Adds a query responder to the specified channel. The responder's `queryEventHandler` function will receive all incoming queries for the specified channel (whether from this Finsemble window or remote Finsemble windows).
+ *
+ * :::note
+ * Only one responder is allowed per channel within Finsemble.
+ * :::
+ *
+ * See [`query`](#query) for sending a corresponding query-event message to this responder.
+ *
+ * ```javascript
+ * FSBL.Clients.RouterClient.addResponder("ResponderChannelName", function (error, queryMessage) {
+ *	if (error) {
+ *		Logger.system.log('addResponder failed: ' + JSON.stringify(error));
+ *	} else {
+ *		console.log("incoming data=" + queryMessage.data);
+ * 		var response="Back at ya"; // Responses can be objects or strings
+ * 		queryMessage.sendQueryResponse(null, response); // The callback must respond, else a timeout will occur on the querying client.
+ * 	}
+ * });
+ * ```
+ * @param {string} channel A unique string to identify the channel (must match corresponding query channel name); only one responder is allowed per channel.
+ * @param {StandardCallback} queryEventHandler A function to handle the incoming query (see example); note the incoming `queryMessage` contains a function to send the response.
+ */
+export declare const addResponder: <Q = any, R = any>(channel: string, queryEventHandler: StandardErrorCallback<ResponderMessage<Q, R>>) => void;
+/**
+ * @language javascript, java, dotnet
+ * Sends a query to the responder listening on the specified channel. The responder may be in this Finsemble window or another Finsemble window.
+ *
+ *
+ * See [`addResponder`](#addresponser) to add a responder to receive the query.
+ *
+ * ```javascript
+ * FSBL.Clients.RouterClient.query("someChannelName", {}, function (error, queryResponseMessage) {
+ *	if (error) {
+ *		Logger.system.log('query failed: ' + JSON.stringify(error));
+ *	} else {
+ *		// process income query response message
+ *		var responseData = queryResponseMessage.data;
+ *		Logger.system.log('query response: ' + JSON.stringify(queryResponseMessage));
+ *	}
+ * });
+ *
+ * FSBL.Clients.RouterClient.query("someChannelName", { queryKey: "abc123"}, { timeout: 1000 }, function (error, queryResponseMessage) {
+ *	if (!error) {
+ *		// process income query response message
+ *		var responseData = queryResponseMessage.data;
+ *	}
+ * });
+ * ```
+ * @param {string} responderChannel A unique string that identifies the channel (must match the channel name on which a responder is listening).
+ * @param {object} queryEvent The event message sent to the responder.
+ * @param {function} responseEventHandler An event handler to receive the query response (sent from a responder that is listening on this channel).
+ */
+export declare const query: <Q = any, R = any>(responderChannel: string, queryEvent: Q, queryParams?: {
+    timeout?: number | undefined;
+    logWhenNoResponder?: boolean | undefined;
+} | QueryResponseCallback<R> | undefined, responseEventHandler?: QueryResponseCallback<R> | undefined) => Promise<StandardQueryResponse<R>>;
+/**
+ * @language javascript, java, dotnet
+ * Removes the query responder from the specified channel. Only a locally added responder can be removed (i.e., a responder defined in the same component or service).
+ *
+ * See [`addResponder()`](#addresponder) for adding a query responder.
+ *
+ * ```javascript
+ * FSBL.Clients.RouterClient.removeResponder("someChannelName");
+ * ```
+ * @param {string} responderChannel String identifying the channel from which to remove the responder.
+ */
+export declare const removeResponder: (responderChannel: string) => void;
+/**
+ * @language javascript, java, dotnet
+ * Adds a PubSub responder for the specified topic (either a specific string or a regular-expression match). PubSub
+ * topics are stateful. New subscribers to the topic are automatically provided the most recent state.
+ * Once a responder has been added, other apps can subscribe to and publish state on the topic
+ *
+ * See [`publish()`](#publish) and [`subscribe()`](#subscribe).
+ *
+ * Only one responder may be set per topic across the entire system (otherwise a warning will show in Central Logger).
+ * If another responder is set with an overlapping regular-expression then the responder with an exact string is still guaranteed to get the messages
+ * (the regex responder will not receive messages that match a responder with a matching string).
+ *
+ * > If multiple responders are set with _overlapping_ regular-expressions, then the receiver is _indeterminate_.
+ *
+ * When initializing a responder, hooks can be provided to intercept and manipulate publish, subscribe, and unsubscribe events (see parameters).
+ *
+ * ```javascript
+ * // Example, initializing a responder without any optional hooks:
+ * FSBL.Clients.RouterClient.addPubSubResponder("topicABC", { "State": "start" });
+ *
+ * // Example, initializing a responder with a regex for matching topics:
+ * FSBL.Clients.RouterClient.addPubSubResponder(new RegExp("topicA*"), { "State": "start" });
+ *
+ * // Example, initializing a responder with all three hooks and an initial state:
+ * FSBL.Clients.RouterClient.addPubSubResponder("topicABC", { "State": "start" },
+ * 	{
+ * 		subscribeCallback:subscribeCallback,
+ * 		publishCallback:publishCallback,
+ * 		unsubscribeCallback:unsubscribeCallback
+ * 	});
+ *
+ * // Example publish hook:
+ * function publishCallback(error, publish) {
+ * 	if (publish) {
+ * 		// `publish.data` contains the data that the originating app published.
+ * 		console.log(publish.data);
+ *
+ * 		// This function must be called to complete the publication. Set the first parameter to `null`
+ * 		// to complete the publication. Set the first parameter to a string in order to suppress the publication
+ * 		// and return an error to the publisher.
+ * 		//
+ * 		// The second parameter must contain the data that you wish to publish. This data will be sent to all
+ * 		// subscribers including the originating app. It can be either the originating state (from `publish.data`)
+ * 		// or a different/manipulated state. This will become the new current state for the topic.
+ * 		publish.sendNotifyToAllSubscribers(null, { someOtherData: "blah"});
+ * 	}
+ * }
+ *
+ * // Example subscribe hook:
+ * function subscribeCallback(error, subscribe) {
+ * 	if (subscribe) {
+ * 		// This function must be called to accept or reject the subscription. Send an error code as the first parameter
+ * 		// to reject. Send null as the first parameter to accept. Once accepted, the subscriber will receive
+ * 		// the current topic's state unless the second parameter is provided which will override what is sent
+ * 		// to the subscriber (but not override the topic's actual internal state).
+ * 		subscribe.sendNotifyToSubscriber(null, { "NOTIFICATION-STATE": "One" });
+ * 	}
+ * }
+ *
+ * // Example unsubscribe hook:
+ * function unsubscribeCallback(error, unsubscribe) {
+ * 	if (unsubscribe) {
+ * 		// This function must be called to accept or reject the unsubscription. Send null (or nothing) as the first
+ * 		// parameter to accept the unsubscription. Send an error code to reject it.
+ * 		unsubscribe.removeSubscriber(null);
+ * 	}
+ * }
+ * ```
+ * @param string|RegExp topic A unique topic for this responder, or a RegEx (e.g. '/abc.+/') to handle a set of topics.
+ * @param {object} initialState The initial state for the topic (defaults to `{}`).
+ * @param {object} params Optional hooks
+ * @param {function} params.publishCallback This hook is called whenever a remote app publishes new state.
+ * `[arg2].sendNotifyToAllSubscribers()` must be called to complete the publication but can send a different state than what was published by the originating app
+ * (the originating publishing app will receive this state on its subscriptions).
+ * See example publish hook.
+ *
+ * @param {function} params.subscribeCallback This hook is called whenever a remote app subscribes to this responder's topic.
+ * It can be used to deny subscriptions or to run independent code for any new subscription.
+ * `[arg2].sendNotifyToSubscriber()` must be called in order for the responder to complete the subscription, and can optionally provide
+ * the subscribing app with a different initial than the topic's current state.
+ * See example subscribe hook.
+ *
+ * @param {function} params.unsubscribeCallback This hook is called whenever a remote app unsubscribes from this responder's topic.
+ * `[arg2].removeSubscriber()` must be called in order to complete the unsubscription.
+ * See example unsubscribe hook.
+ *
+ * @param {function} callback An optional callback function which should accept a possible error.
+ * If `addPubSubResponder()` failed then the first parameter to the callback will contain the error condition.
+ * The most common error is when adding a responder for a topic that already has a responder:
+ * "RouterClient.addPubSubResponder: Responder already locally defined for topic ${topic}";
+ */
+export declare const addPubSubResponder: <T = any>(topic: string | RegExp, initialState?: object, params?: {
+    subscribeCallback?: SubscribeCallback<T> | undefined;
+    unsubscribeCallback?: UnsubscribeCallback | undefined;
+    publishCallback?: PublishCallback<T> | undefined;
+} | undefined, callback?: ((err?: string | Error, result?: "success") => void) | undefined) => void;
+/**
+ * @language javascript, java, dotnet
+ * Removes a PubSub responder from the specified topic. Only locally created responders (i.e. created in the local window) can be removed.
+ *
+ * See [`addPubSubResponder`](#addpubsubresponder) for corresponding addition of a PubSub responder.
+ *
+ * ```javascript
+ * FSBL.Clients.RouterClient.removePubSubResponder("topicABC");
+ * ```
+ * @param {string} topic Unique topic for responder being removed (may be RegEx, but if so much be exact RegEx used previously with `addPubSubResponder`).
+ */
+export declare const removePubSubResponder: (topic: string | RegExp) => void;
+/**
+ * @language javascript, java, dotnet
+ * Subscribe to a PubSub responder. Each responder topic can have many subscribers (local in this window or remote in other windows). Each subscriber immediately (but asynchronously) receives back current state in a notify; new notifications are received for each publish sent to the same topic.
+ *
+ * See [`addPubSubResponder`](#addpubsubresponder) for corresponding addition of a PubSub responder to handle the subscribe. See [`publish()`](#publish) for how to publish data to subscribers.
+ *
+ * ```javascript
+ * var subscribeId = RouterClient.subscribe("topicABC", function(err, notify) {
+ *	if (!err) {
+ *		var notificationStateData = notify.data;
+ *		// do something with notify data
+ *	}
+ * });
+ * ```
+ * @param {string} topic A unique string representing the topic being subscribed to.
+ * @param {function} notifyCallback Invoked on immediately upon subscription, then again on each incoming notification for the specified topic.
+ * @returns {object} An object containing a unique id representing the subscription. This can be used later to unsubscribe.
+ */
+export declare const subscribe: <T = any>(topic: string, notifyCallback: (err: StandardError, response: SubscriberResponse<T>) => void) => {
+    subscribeID: string;
+    topic: string;
+};
+/**
+ * @language javascript, java, dotnet
+ * Publish to a PubSub Responder, which will trigger a corresponding notification to all subscribers (local in this window or remote in other windows). There may be multiple publishers for a topic (again, in same window or remote windows).
+ *
+ * See [`addPubSubResponder`](#addpubsubresponder) for corresponding addition of a PubSub publisher (i.e., sending notifications to all subscriber). See [`Subscribe`](#subscribe) for corresponding subscription published results (in the form of a `Notify` event).
+ *
+ * ```javascript
+ * FSBL.Clients.RouterClient.publish("topicABC", topicState);
+ * ```
+ * @param {string} topic A unique string representing the topic being published.
+ * @param {object} event The topic state to be published to all subscribers (unless the PubSub responder optionally modifies in between).
+ */
+export declare const publish: <T = any>(topic: string, event: T) => void;
+/**
+ * @language javascript, java, dotnet
+ * Unsubscribes from a PubSub responder so no more notifications are received (but doesn't affect other subscriptions). Only works from the window the PubSub responder was created in.
+ *
+ * See [`subscribe`](#subscribe) for corresponding subscription being removed.
+ *
+ * ```javascript
+ * FSBL.Clients.RouterClient.unsubscribe(subscribeId);
+ * ```
+ * @param {object} subscribeIDStruct
+ * @param {string} subscribeIDStruct.subscribeID The id returned from the corresponding subscription to the topic.
+ * @param {string} subscribeIDStruct.topic The topic for the subscription.
+ */
+export declare const unsubscribe: (subscribeIDStruct: {
+    subscribeID: string;
+    topic: string;
+}) => void;
+/**
+ * @language javascript, java, dotnet
+ * Tests an incoming Router message to see if it originated from the same origin (i.e., a trusted source; not cross-domain).
+ *
+ * Currently, the origin of an incoming Router message is determined by way of the SharedWorker transport. By definition, SharedWorkers do not work across domains.
+ * This means any message coming in over the transport will not be trusted. However, by default, all same-origin components
+ * and services connect to the Router using a SharedWorker transport.
+ *
+ * ```javascript
+ * FSBL.Clients.RouterClient.trustedMessage(incomingRouterMessage);
+ * ```
+ * @param {object} incomingMessage An incoming Router message (e.g., transmit, query, notification) to test to see if trusted.
+ */
+export declare const trustedMessage: (incomingMessage: RouterMessage) => boolean;
+/**
+ * @language javascript, java, dotnet
+ * Removes all listeners, responders, and subscribers for this router client -- automatically called when the client is shutting down. Can be called multiple times.
+ */
+export declare const disconnectAll: () => void;
+/**
+ * Used internally by Logger client
+ * @ignore
+ */
+export declare const calibrateTimeWithRouterService: (callback: (offset: number) => void) => void;
+/**
+ * @ignore
+ */
+export declare const RouterClient: {
+    onReady: (cb?: () => void) => Promise<void>;
+    onFailure: (cb?: () => void) => Promise<void>;
+    addListener: <T = any>(channel: string, eventHandler: ListenerCallback<T>) => RouterListenerUnsubscribe;
+    transmit: <T_1 = any>(toChannel: string, data: T_1, options?: {
+        suppressWarnings: boolean;
+    }) => void;
+    removeListener: (channel: string, eventHandler: Function) => void;
+    addResponder: <Q = any, R = any>(channel: string, queryEventHandler: StandardErrorCallback<ResponderMessage<Q, R>>) => void;
+    query: <Q_1 = any, R_1 = any>(responderChannel: string, queryEvent: Q_1, queryParams?: {
+        timeout?: number | undefined;
+        logWhenNoResponder?: boolean | undefined;
+    } | QueryResponseCallback<R_1> | undefined, responseEventHandler?: QueryResponseCallback<R_1> | undefined) => Promise<StandardQueryResponse<R_1>>;
+    removeResponder: (responderChannel: string) => void;
+    addPubSubResponder: <T_2 = any>(topic: string | RegExp, initialState?: object, params?: {
+        subscribeCallback?: SubscribeCallback<T_2> | undefined;
+        unsubscribeCallback?: UnsubscribeCallback | undefined;
+        publishCallback?: PublishCallback<T_2> | undefined;
+    } | undefined, callback?: ((err?: string | Error, result?: "success") => void) | undefined) => void;
+    removePubSubResponder: (topic: string | RegExp) => void;
+    subscribe: <T_3 = any>(topic: string, notifyCallback: (err: StandardError, response: SubscriberResponse<T_3>) => void) => {
+        subscribeID: string;
+        topic: string;
+    };
+    publish: <T_4 = any>(topic: string, event: T_4) => void;
+    unsubscribe: (subscribeIDStruct: {
+        subscribeID: string;
+        topic: string;
+    }) => void;
+    trustedMessage: (incomingMessage: RouterMessage) => boolean;
+    disconnectAll: () => void;
+    calibrateTimeWithRouterService: (callback: (offset: number) => void) => void;
+};
+/**
+ * @ignore
+ */
+export declare type IRouterClient = typeof RouterClient;
+/**
+ * @ignore
+ */
+export default RouterClient;
+//# sourceMappingURL=routerClient.d.ts.map

package/clients/routerClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"routerClient.d.ts","sourceRoot":"","sources":["../../../src/clients/routerClient.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH;;;;;;;GAOG;AAOH,OAAO,EACN,aAAa,EACb,yBAAyB,EACzB,YAAY,EACZ,YAAY,EACZ,gBAAgB,EAChB,0BAA0B,EAE1B,iBAAiB,EAEjB,qBAAqB,EACrB,kBAAkB,EAClB,gBAAgB,EAChB,eAAe,EAEf,qBAAqB,EACrB,mBAAmB,EAEnB,cAAc,EACd,uBAAuB,EACvB,wBAAwB,EAExB,wBAAwB,EAExB,yBAAyB,EAKzB,2BAA2B,EAE3B,6BAA6B,EAE7B,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EAAE,aAAa,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAC;AAIhE,OAAO,EACN,mBAAmB,EACnB,kBAAkB,EAClB,gBAAgB,EAChB,qBAAqB,EACrB,gBAAgB,EAChB,gBAAgB,EAChB,gBAAgB,EAChB,eAAe,EACf,kBAAkB,EAClB,cAAc,EACd,yBAAyB,EACzB,YAAY,EACZ,uBAAuB,EACvB,aAAa,EACb,qBAAqB,EACrB,gBAAgB,EAChB,YAAY,EACZ,YAAY,EACZ,yBAAyB,EACzB,aAAa,EACb,cAAc,EACd,uBAAuB,EACvB,YAAY,EACZ,yBAAyB,EACzB,qBAAqB,EACrB,iBAAiB,EACjB,oBAAoB,EACpB,gBAAgB,EAChB,2BAA2B,EAC3B,kBAAkB,EAClB,eAAe,EACf,0BAA0B,EAC1B,aAAa,EACb,mBAAmB,EACnB,sBAAsB,EACtB,kBAAkB,EAClB,6BAA6B,GAC7B,MAAM,mCAAmC,CAAC;AAmG3C;;GAEG;AACH,qBAAa,gBAAgB;IAC5B,KAAK,EAAE,YAAY,EAAE,CAAM;IAE3B,OAAO,EAAE,OAAO,CAAS;IAEzB,gBAAgB,EAAE,GAAG,CAAC;IAEtB,sBAAsB,EAAE,GAAG,CAAC;IAE5B,UAAU,EAAE,MAAM,CAAyC;IAE3D,SAAS,EAAE,GAAG,CAAQ;IAEtB,aAAa,UAAS;IAEtB,iBAAiB,UAAS;IAE1B,wBAAwB,EAAE,CAAC,MAAM,IAAI,CAAC,EAAE,CAAM;IAE9C,0BAA0B,EAAE,CAAC,MAAM,IAAI,CAAC,EAAE,CAAM;IAGhD,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,CAAC,CAAM;IAGtD,kBAAkB,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,gBAAgB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,CAAM;IAE3F,mBAAmB,EAAE,MAAM,CAC1B,MAAM,EACN;QACC,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;QACtC,eAAe,CAAC,EAAE,eAAe,CAAC;QAClC,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;KAC1C,CACD,CAAM;IAGP,uBAAuB,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAM;IAElD,uBAAuB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAM;IAGrD,uBAAuB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAM;IAGvD,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAM;IAGtD,mBAAmB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAM;IAEjD,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAM;IAG9D,uBAAuB,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAM;;IASlD,eAAe;IAaf,mBAAmB,CAAC,OAAO,EAAE,YAAY;IAUzC,cAAc,CAAC,OAAO,EAAE,YAAY;IAKpC,eAAe,CAAC,OAAO,EAAE,0BAA0B;IAmBnD;;;;OAIG;IACH,eAAe,CAAC,YAAY,EAAE,uBAAuB;IAgErD;;;OAGG;IACH,mBAAmB,CAAC,OAAO,EAAE,wBAAwB;IA4BrD;;;OAGG;IACH,oBAAoB,CAAC,aAAa,EAAE,wBAAwB;IA+B5D;;;OAGG;IACH,OAAO,CAAC,aAAa;IAgBrB,kBAAkB,CAAC,cAAc,EAAE,yBAAyB;IA8D5D,oBAAoB,CAAC,gBAAgB,EAAE,2BAA2B;IAyClE,sBAAsB,CAAC,kBAAkB,EAAE,6BAA6B;IAgDxE,sBAAsB,CAAC,gBAAgB,EAAE,2BAA2B,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI,EAAE,UAAU,CAAC,EAAE,GAAG;IAsC1G,iBAAiB,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;IAsBpD,oBAAoB,CAAC,eAAe,EAAE,YAAY;IA+ClD,yBAAyB,CAAC,YAAY,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,IAAI;IA4H5F,0BAA0B,CAAC,CAAC,EAC3B,KAAK,EAAE,MAAM,GAAG,MAAM,EACtB,iBAAiB,CAAC,EAAE,iBAAiB,CAAC,CAAC,CAAC,EACxC,eAAe,CAAC,EAAE,eAAe,CAAC,CAAC,CAAC,EACpC,mBAAmB,CAAC,EAAE,mBAAmB;IAkB1C;;OAEG;IACH,8BAA8B,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI;IA2EjE;;;;OAIG;IACH,KAAK,CAAC,YAAY,EAAE,YAAY;IA4BhC,qBAAqB,IAAI,IAAI;IAW7B;;;OAGG;IACH,IAAI;IAcJ,OAAO,CAAC,EAAE,CAAC,EAAE,MAAM,IAAI;IAgBvB,SAAS,CAAC,EAAE,CAAC,EAAE,MAAM,IAAI;IAgBzB,WAAW,CAAC,CAAC,GAAG,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAAG,yBAAyB;IAkCnG,QAAQ,CAAC,CAAC,GAAG,GAAG,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE;QAAE,gBAAgB,EAAE,OAAO,CAAA;KAAE,GAAG,IAAI;IAiB5F,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,QAAQ,GAAG,IAAI;IAiC7D,YAAY,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,GAAG,GAAG,EAC5B,OAAO,EAAE,MAAM,EACf,iBAAiB,EAAE,qBAAqB,CAAC,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAC9D,IAAI;IAuBP,KAAK,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,GAAG,GAAG,EACrB,gBAAgB,EAAE,MAAM,EACxB,UAAU,EAAE,CAAC,EACb,WAAW,EACR;QACA,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,kBAAkB,CAAC,EAAE,OAAO,CAAC;KAC5B,GACD,qBAAqB,CAAC,CAAC,CAAC,GACxB,SAAS,EACZ,oBAAoB,CAAC,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAC7C,OAAO,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAoEpC,eAAe,CAAC,gBAAgB,EAAE,MAAM,GAAG,IAAI;IAiB/C,kBAAkB,CAAC,CAAC,GAAG,GAAG,EACzB,KAAK,EAAE,MAAM,GAAG,MAAM,EACtB,YAAY,CAAC,EAAE,MAAM,EACrB,MAAM,CAAC,EAAE;QACR,iBAAiB,CAAC,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC;QACzC,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;QAC1C,eAAe,CAAC,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC;KACrC,EACD,QAAQ,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,KAAK,EAAE,MAAM,CAAC,EAAE,SAAS,KAAK,IAAI,GAC3D,IAAI;IAmEP,qBAAqB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAsBnD,SAAS,CAAC,CAAC,GAAG,GAAG,EAChB,KAAK,EAAE,MAAM,EACb,cAAc,EAAE,CAAC,GAAG,EAAE,aAAa,EAAE,QAAQ,EAAE,kBAAkB,CAAC,CAAC,CAAC,KAAK,IAAI,GAC3E;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE;IAkBzC,OAAO,CAAC,CAAC,GAAG,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,GAAG,IAAI;IAc9C,WAAW,CAAC,iBAAiB,EAAE;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI;IAsB5E;;;;;;;OAOG;IACH,cAAc,CAAC,eAAe,EAAE,aAAa,GAAG,OAAO;IAMvD,aAAa;CAsBb;AAED;;GAEG;AACH,eAAO,MAAM,gBAAgB;IAC5B;;;OAGG;oBACa,YAAY,KAAG,QAAQ,MAAM,GAAG,IAAI,CAAC;IAMrD;;;OAGG;gBACO,IAAI;IAKd;;OAEG;sDAC+C,MAAM,KAAK,IAAI;CAIjE,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,OAAO,QAAS,MAAM,IAAI,KAAG,QAAQ,IAAI,CAIrD,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,SAAS,QAAS,MAAM,IAAI,KAAG,QAAQ,IAAI,CAGvD,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,WAAW,qBAAsB,MAAM,wCAAsC,yBAGzF,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,QAAQ,uBAAwB,MAAM,qBAAqB;IAAE,gBAAgB,EAAE,OAAO,CAAA;CAAE,KAAG,IAGvG,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc,YAAa,MAAM,gBAAgB,QAAQ,KAAG,IAGxE,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,YAAY,8BACf,MAAM,uEAEb,IAGF,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AAEH,eAAO,MAAM,KAAK,uCACC,MAAM;;;2IAaxB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,eAAe,qBAAsB,MAAM,KAAG,IAG1D,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0FG;AACH,eAAO,MAAM,kBAAkB,mBACvB,MAAM,GAAG,MAAM,iBACP,MAAM;;;;kCAMH,MAAM,GAAG,KAAK,WAAW,SAAS,KAAK,IAAI,kBAC3D,IAGF,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,qBAAqB,UAAW,MAAM,GAAG,MAAM,KAAG,IAG9D,CAAC;AAEF;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,SAAS,mBACd,MAAM,wBACS,aAAa,sCAAsC,IAAI;iBAC5D,MAAM;WAAS,MAAM;CAGtC,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,OAAO,mBAAoB,MAAM,eAAa,IAG1D,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,WAAW,sBAAuB;IAAE,WAAW,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,KAAG,IAGvF,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,cAAc,oBAAqB,aAAa,KAAG,OAG/D,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,aAAa,QAAO,IAGhC,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,8BAA8B,sBAAuB,MAAM,KAAK,IAAI,SAGhF,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,YAAY;mBA3YI,MAAM,IAAI,KAAG,QAAQ,IAAI,CAAC;qBAaxB,MAAM,IAAI,KAAG,QAAQ,IAAI,CAAC;oCA6BX,MAAM,wCAAsC,yBAAyB;qCAmBtE,MAAM,uBAAqB;QAAE,gBAAgB,EAAE,OAAO,CAAA;KAAE,KAAG,IAAI;8BAcpE,MAAM,gBAAgB,QAAQ,KAAG,IAAI;8CA8BnE,MAAM,uEAEb,IAAI;oDAoCY,MAAM;;;;wCA0ByB,MAAM,KAAG,IAAI;2CAiGvD,MAAM,GAAG,MAAM,iBACP,MAAM;;;;sCAMH,MAAM,GAAG,KAAK,WAAW,SAAS,KAAK,IAAI,kBAC3D,IAAI;mCAgBsC,MAAM,GAAG,MAAM,KAAG,IAAI;kCAwB3D,MAAM,wBACS,aAAa,wCAAsC,IAAI;qBAC5D,MAAM;eAAS,MAAM;;gCAiBC,MAAM,iBAAa,IAAI;qCAkBhB;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,KAAG,IAAI;sCAkB5C,aAAa,KAAG,OAAO;yBAStC,IAAI;wDAS6B,MAAM,KAAK,IAAI;CAyBhF,CAAC;AAEF;;GAEG;AACH,oBAAY,aAAa,GAAG,OAAO,YAAY,CAAC;AAEhD;;GAEG;AACH,eAAe,YAAY,CAAC"}