@openfin/core 25.68.30 → 25.70.2

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

@@ -1,86 +1,85 @@
-/// <reference types="node" />
-import { EventEmitter } from 'events';
-import { Base } from '../base';
-import Transport from '../../transport/transport';
-import { Channel } from './channel/index';
-import Message = OpenFin.Message;
-/**
- * A messaging bus that allows for pub/sub messaging between different applications.
- * @namespace
- */
-export default class InterApplicationBus extends Base {
-    Channel: Channel;
-    events: {
-        subscriberAdded: string;
-        subscriberRemoved: string;
-    };
-    private refCounter;
-    protected emitter: EventEmitter;
-    on: any;
-    removeAllListeners: any;
-    constructor(wire: Transport);
-    /**
-     * Publishes a message to all applications running on OpenFin Runtime that
-     * are subscribed to the specified topic.
-     * @param { string } topic The topic on which the message is sent
-     * @param { any } message The message to be published. Can be either a primitive
-     * data type (string, number, or boolean) or composite data type (object, array)
-     * that is composed of other primitive or composite data types
-     * @return {Promise.<void>}
-     * @tutorial InterApplicationBus.publish
-     */
-    publish(topic: string, message: any): Promise<void>;
-    /**
-     * Sends a message to a specific application on a specific topic.
-     * @param { Identity } destination The identity of the application to which the message is sent
-     * @param { string } topic The topic on which the message is sent
-     * @param { any } message The message to be sent. Can be either a primitive data
-     * type (string, number, or boolean) or composite data type (object, array) that
-     * is composed of other primitive or composite data types
-     * @return {Promise.<void>}
-     * @tutorial InterApplicationBus.send
-     */
-    send(destination: {
-        uuid: string;
-        name?: string;
-    }, topic: string, message: any): Promise<void>;
-    /**
-     * Subscribes to messages from the specified application on the specified topic.
-     * @param { Identity } source This object is described in the Identity in the typedef
-     * @param { string } topic The topic on which the message is sent
-     * @param { function } listener A function that is called when a message has
-     * been received. It is passed the message, uuid and name of the sending application.
-     * The message can be either a primitive data type (string, number, or boolean) or
-     * composite data type (object, array) that is composed of other primitive or composite
-     * data types
-     * @return {Promise.<void>}
-     * @tutorial InterApplicationBus.subscribe
-     */
-    subscribe(source: {
-        uuid: string;
-        name?: string;
-    }, topic: string, listener: any): Promise<void>;
-    /**
-     * Unsubscribes to messages from the specified application on the specified topic.
-     * @param { Identity } source This object is described in the Identity in the typedef
-     * @param { string } topic The topic on which the message is sent
-     * @param { function } listener A callback previously registered with subscribe()
-     * @return {Promise.<void>}
-     * @tutorial InterApplicationBus.unsubscribe
-     */
-    unsubscribe(source: {
-        uuid: string;
-        name?: string;
-    }, topic: string, listener: any): Promise<void>;
-    private processMessage;
-    private emitSubscriverEvent;
-    protected createSubscriptionKey(uuid: string, name: string, topic: string): string;
-    protected onmessage(message: Message<InterAppPayload>): boolean;
-}
-export declare class InterAppPayload {
-    sourceUuid: string;
-    sourceWindowName: string;
-    topic: string;
-    destinationUuid?: string;
-    message?: any;
-}
+/// <reference types="node" />
+import { EventEmitter } from 'events';
+import { Base } from '../base';
+import Transport, { Message } from '../../transport/transport';
+import { Channel } from './channel/index';
+/**
+ * A messaging bus that allows for pub/sub messaging between different applications.
+ * @namespace
+ */
+export default class InterApplicationBus extends Base {
+    Channel: Channel;
+    events: {
+        subscriberAdded: string;
+        subscriberRemoved: string;
+    };
+    private refCounter;
+    protected emitter: EventEmitter;
+    on: any;
+    removeAllListeners: any;
+    constructor(wire: Transport);
+    /**
+     * Publishes a message to all applications running on OpenFin Runtime that
+     * are subscribed to the specified topic.
+     * @param { string } topic The topic on which the message is sent
+     * @param { any } message The message to be published. Can be either a primitive
+     * data type (string, number, or boolean) or composite data type (object, array)
+     * that is composed of other primitive or composite data types
+     * @return {Promise.<void>}
+     * @tutorial InterApplicationBus.publish
+     */
+    publish(topic: string, message: any): Promise<void>;
+    /**
+     * Sends a message to a specific application on a specific topic.
+     * @param { Identity } destination The identity of the application to which the message is sent
+     * @param { string } topic The topic on which the message is sent
+     * @param { any } message The message to be sent. Can be either a primitive data
+     * type (string, number, or boolean) or composite data type (object, array) that
+     * is composed of other primitive or composite data types
+     * @return {Promise.<void>}
+     * @tutorial InterApplicationBus.send
+     */
+    send(destination: {
+        uuid: string;
+        name?: string;
+    }, topic: string, message: any): Promise<void>;
+    /**
+     * Subscribes to messages from the specified application on the specified topic.
+     * @param { Identity } source This object is described in the Identity in the typedef
+     * @param { string } topic The topic on which the message is sent
+     * @param { function } listener A function that is called when a message has
+     * been received. It is passed the message, uuid and name of the sending application.
+     * The message can be either a primitive data type (string, number, or boolean) or
+     * composite data type (object, array) that is composed of other primitive or composite
+     * data types
+     * @return {Promise.<void>}
+     * @tutorial InterApplicationBus.subscribe
+     */
+    subscribe(source: {
+        uuid: string;
+        name?: string;
+    }, topic: string, listener: any): Promise<void>;
+    /**
+     * Unsubscribes to messages from the specified application on the specified topic.
+     * @param { Identity } source This object is described in the Identity in the typedef
+     * @param { string } topic The topic on which the message is sent
+     * @param { function } listener A callback previously registered with subscribe()
+     * @return {Promise.<void>}
+     * @tutorial InterApplicationBus.unsubscribe
+     */
+    unsubscribe(source: {
+        uuid: string;
+        name?: string;
+    }, topic: string, listener: any): Promise<void>;
+    private processMessage;
+    private emitSubscriverEvent;
+    protected createSubscriptionKey(uuid: string, name: string, topic: string): string;
+    protected onmessage(message: Message<InterAppPayload>): boolean;
+}
+export declare class InterAppPayload {
+    sourceUuid: string;
+    sourceWindowName: string;
+    topic: string;
+    destinationUuid?: string;
+    message?: any;
+}

package/src/api/interappbus/index.js

@@ -1,175 +1,175 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InterAppPayload = void 0;
-const events_1 = require("events");
-const base_1 = require("../base");
-const ref_counter_1 = require("../../util/ref-counter");
-const index_1 = require("./channel/index");
-const validate_1 = require("../../util/validate");
-/**
- * A messaging bus that allows for pub/sub messaging between different applications.
- * @namespace
- */
-class InterApplicationBus extends base_1.Base {
-    constructor(wire) {
-        super(wire);
-        this.events = {
-            subscriberAdded: 'subscriber-added',
-            subscriberRemoved: 'subscriber-removed'
-        };
-        this.refCounter = new ref_counter_1.default();
-        this.Channel = new index_1.Channel(wire);
-        this.emitter = new events_1.EventEmitter();
-        wire.registerMessageHandler(this.onmessage.bind(this));
-        this.on = this.emitter.on.bind(this.emitter);
-        this.removeAllListeners = this.emitter.removeAllListeners.bind(this.emitter);
-    }
-    /**
-     * Publishes a message to all applications running on OpenFin Runtime that
-     * are subscribed to the specified topic.
-     * @param { string } topic The topic on which the message is sent
-     * @param { any } message The message to be published. Can be either a primitive
-     * data type (string, number, or boolean) or composite data type (object, array)
-     * that is composed of other primitive or composite data types
-     * @return {Promise.<void>}
-     * @tutorial InterApplicationBus.publish
-     */
-    publish(topic, message) {
-        return this.wire
-            .sendAction('publish-message', {
-            topic,
-            message,
-            sourceWindowName: this.me.name
-        })
-            .then(() => undefined);
-    }
-    /**
-     * Sends a message to a specific application on a specific topic.
-     * @param { Identity } destination The identity of the application to which the message is sent
-     * @param { string } topic The topic on which the message is sent
-     * @param { any } message The message to be sent. Can be either a primitive data
-     * type (string, number, or boolean) or composite data type (object, array) that
-     * is composed of other primitive or composite data types
-     * @return {Promise.<void>}
-     * @tutorial InterApplicationBus.send
-     */
-    async send(destination, topic, message) {
-        const errorMsg = validate_1.validateIdentity(destination);
-        if (errorMsg) {
-            throw new Error(errorMsg);
-        }
-        await this.wire.sendAction('send-message', {
-            destinationUuid: destination.uuid,
-            destinationWindowName: destination.name,
-            topic,
-            message,
-            sourceWindowName: this.me.name
-        });
-    }
-    /**
-     * Subscribes to messages from the specified application on the specified topic.
-     * @param { Identity } source This object is described in the Identity in the typedef
-     * @param { string } topic The topic on which the message is sent
-     * @param { function } listener A function that is called when a message has
-     * been received. It is passed the message, uuid and name of the sending application.
-     * The message can be either a primitive data type (string, number, or boolean) or
-     * composite data type (object, array) that is composed of other primitive or composite
-     * data types
-     * @return {Promise.<void>}
-     * @tutorial InterApplicationBus.subscribe
-     */
-    subscribe(source, topic, listener) {
-        const subKey = this.createSubscriptionKey(source.uuid, source.name || '*', topic);
-        const sendSubscription = () => {
-            return this.wire.sendAction('subscribe', {
-                sourceUuid: source.uuid,
-                sourceWindowName: source.name || '*',
-                topic,
-                destinationWindowName: this.me.name
-            });
-        };
-        const alreadySubscribed = () => {
-            return Promise.resolve();
-        };
-        this.emitter.on(subKey, listener);
-        return this.refCounter.actOnFirst(subKey, sendSubscription, alreadySubscribed);
-    }
-    /**
-     * Unsubscribes to messages from the specified application on the specified topic.
-     * @param { Identity } source This object is described in the Identity in the typedef
-     * @param { string } topic The topic on which the message is sent
-     * @param { function } listener A callback previously registered with subscribe()
-     * @return {Promise.<void>}
-     * @tutorial InterApplicationBus.unsubscribe
-     */
-    unsubscribe(source, topic, listener) {
-        const sourceWindowName = source.name || '*';
-        const subKey = this.createSubscriptionKey(source.uuid, sourceWindowName, topic);
-        const sendUnsubscription = () => {
-            return this.wire.sendAction('unsubscribe', {
-                sourceUuid: source.uuid,
-                sourceWindowName,
-                topic,
-                destinationWindowName: this.me.name
-            });
-        };
-        const dontSendUnsubscription = () => {
-            return new Promise((r) => r).then(() => undefined);
-        };
-        this.emitter.removeListener(subKey, listener);
-        return this.refCounter.actOnLast(subKey, sendUnsubscription, dontSendUnsubscription);
-    }
-    processMessage(message) {
-        const { payload: { message: payloadMessage, sourceWindowName, sourceUuid, topic } } = message;
-        const keys = [
-            this.createSubscriptionKey(sourceUuid, sourceWindowName, topic),
-            this.createSubscriptionKey(sourceUuid, '*', topic),
-            this.createSubscriptionKey('*', '*', topic)
-        ];
-        const idOfSender = { uuid: sourceUuid, name: sourceWindowName };
-        keys.forEach((key) => {
-            this.emitter.emit(key, payloadMessage, idOfSender);
-        });
-    }
-    emitSubscriverEvent(type, message) {
-        const { payload: { targetName: name, uuid, topic } } = message;
-        const payload = { name, uuid, topic };
-        this.emitter.emit(type, payload);
-    }
-    // eslint-disable-next-line class-methods-use-this
-    createSubscriptionKey(uuid, name, topic) {
-        const n = name || '*';
-        if (!(uuid && n && topic)) {
-            throw new Error('Missing uuid, name, or topic string');
-        }
-        return createKey(uuid, n, topic);
-    }
-    onmessage(message) {
-        const { action } = message;
-        switch (action) {
-            case 'process-message':
-                this.processMessage(message);
-                break;
-            case this.events.subscriberAdded:
-                this.emitSubscriverEvent(this.events.subscriberAdded, message);
-                break;
-            case this.events.subscriberRemoved:
-                this.emitSubscriverEvent(this.events.subscriberRemoved, message);
-                break;
-            default:
-                break;
-        }
-        return true;
-    }
-}
-exports.default = InterApplicationBus;
-class InterAppPayload {
-}
-exports.InterAppPayload = InterAppPayload;
-function createKey(...toHash) {
-    return toHash
-        .map((item) => {
-        return Buffer.from(`${item}`).toString('base64');
-    })
-        .join('/');
-}
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InterAppPayload = void 0;
+const events_1 = require("events");
+const base_1 = require("../base");
+const ref_counter_1 = require("../../util/ref-counter");
+const index_1 = require("./channel/index");
+const validate_1 = require("../../util/validate");
+/**
+ * A messaging bus that allows for pub/sub messaging between different applications.
+ * @namespace
+ */
+class InterApplicationBus extends base_1.Base {
+    constructor(wire) {
+        super(wire);
+        this.events = {
+            subscriberAdded: 'subscriber-added',
+            subscriberRemoved: 'subscriber-removed'
+        };
+        this.refCounter = new ref_counter_1.default();
+        this.Channel = new index_1.Channel(wire);
+        this.emitter = new events_1.EventEmitter();
+        wire.registerMessageHandler(this.onmessage.bind(this));
+        this.on = this.emitter.on.bind(this.emitter);
+        this.removeAllListeners = this.emitter.removeAllListeners.bind(this.emitter);
+    }
+    /**
+     * Publishes a message to all applications running on OpenFin Runtime that
+     * are subscribed to the specified topic.
+     * @param { string } topic The topic on which the message is sent
+     * @param { any } message The message to be published. Can be either a primitive
+     * data type (string, number, or boolean) or composite data type (object, array)
+     * that is composed of other primitive or composite data types
+     * @return {Promise.<void>}
+     * @tutorial InterApplicationBus.publish
+     */
+    publish(topic, message) {
+        return this.wire
+            .sendAction('publish-message', {
+            topic,
+            message,
+            sourceWindowName: this.me.name
+        })
+            .then(() => undefined);
+    }
+    /**
+     * Sends a message to a specific application on a specific topic.
+     * @param { Identity } destination The identity of the application to which the message is sent
+     * @param { string } topic The topic on which the message is sent
+     * @param { any } message The message to be sent. Can be either a primitive data
+     * type (string, number, or boolean) or composite data type (object, array) that
+     * is composed of other primitive or composite data types
+     * @return {Promise.<void>}
+     * @tutorial InterApplicationBus.send
+     */
+    async send(destination, topic, message) {
+        const errorMsg = validate_1.validateIdentity(destination);
+        if (errorMsg) {
+            throw new Error(errorMsg);
+        }
+        await this.wire.sendAction('send-message', {
+            destinationUuid: destination.uuid,
+            destinationWindowName: destination.name,
+            topic,
+            message,
+            sourceWindowName: this.me.name
+        });
+    }
+    /**
+     * Subscribes to messages from the specified application on the specified topic.
+     * @param { Identity } source This object is described in the Identity in the typedef
+     * @param { string } topic The topic on which the message is sent
+     * @param { function } listener A function that is called when a message has
+     * been received. It is passed the message, uuid and name of the sending application.
+     * The message can be either a primitive data type (string, number, or boolean) or
+     * composite data type (object, array) that is composed of other primitive or composite
+     * data types
+     * @return {Promise.<void>}
+     * @tutorial InterApplicationBus.subscribe
+     */
+    subscribe(source, topic, listener) {
+        const subKey = this.createSubscriptionKey(source.uuid, source.name || '*', topic);
+        const sendSubscription = () => {
+            return this.wire.sendAction('subscribe', {
+                sourceUuid: source.uuid,
+                sourceWindowName: source.name || '*',
+                topic,
+                destinationWindowName: this.me.name
+            });
+        };
+        const alreadySubscribed = () => {
+            return Promise.resolve();
+        };
+        this.emitter.on(subKey, listener);
+        return this.refCounter.actOnFirst(subKey, sendSubscription, alreadySubscribed);
+    }
+    /**
+     * Unsubscribes to messages from the specified application on the specified topic.
+     * @param { Identity } source This object is described in the Identity in the typedef
+     * @param { string } topic The topic on which the message is sent
+     * @param { function } listener A callback previously registered with subscribe()
+     * @return {Promise.<void>}
+     * @tutorial InterApplicationBus.unsubscribe
+     */
+    unsubscribe(source, topic, listener) {
+        const sourceWindowName = source.name || '*';
+        const subKey = this.createSubscriptionKey(source.uuid, sourceWindowName, topic);
+        const sendUnsubscription = () => {
+            return this.wire.sendAction('unsubscribe', {
+                sourceUuid: source.uuid,
+                sourceWindowName,
+                topic,
+                destinationWindowName: this.me.name
+            });
+        };
+        const dontSendUnsubscription = () => {
+            return new Promise((r) => r).then(() => undefined);
+        };
+        this.emitter.removeListener(subKey, listener);
+        return this.refCounter.actOnLast(subKey, sendUnsubscription, dontSendUnsubscription);
+    }
+    processMessage(message) {
+        const { payload: { message: payloadMessage, sourceWindowName, sourceUuid, topic } } = message;
+        const keys = [
+            this.createSubscriptionKey(sourceUuid, sourceWindowName, topic),
+            this.createSubscriptionKey(sourceUuid, '*', topic),
+            this.createSubscriptionKey('*', '*', topic)
+        ];
+        const idOfSender = { uuid: sourceUuid, name: sourceWindowName };
+        keys.forEach((key) => {
+            this.emitter.emit(key, payloadMessage, idOfSender);
+        });
+    }
+    emitSubscriverEvent(type, message) {
+        const { payload: { targetName: name, uuid, topic } } = message;
+        const payload = { name, uuid, topic };
+        this.emitter.emit(type, payload);
+    }
+    // eslint-disable-next-line class-methods-use-this
+    createSubscriptionKey(uuid, name, topic) {
+        const n = name || '*';
+        if (!(uuid && n && topic)) {
+            throw new Error('Missing uuid, name, or topic string');
+        }
+        return createKey(uuid, n, topic);
+    }
+    onmessage(message) {
+        const { action } = message;
+        switch (action) {
+            case 'process-message':
+                this.processMessage(message);
+                break;
+            case this.events.subscriberAdded:
+                this.emitSubscriverEvent(this.events.subscriberAdded, message);
+                break;
+            case this.events.subscriberRemoved:
+                this.emitSubscriverEvent(this.events.subscriberRemoved, message);
+                break;
+            default:
+                break;
+        }
+        return true;
+    }
+}
+exports.default = InterApplicationBus;
+class InterAppPayload {
+}
+exports.InterAppPayload = InterAppPayload;
+function createKey(...toHash) {
+    return toHash
+        .map((item) => {
+        return Buffer.from(`${item}`).toString('base64');
+    })
+        .join('/');
+}

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

@@ -1,37 +1,37 @@
-import { Base } from '../base';
-import { InteropBroker } from './InteropBroker';
-import { InteropClient } from './InteropClient';
-/**
- * @typedef { object } InteropConfig
- * @summary Information relevant to the Interop Broker.
- * @property {string} [currentContextGroup] Context Group for the client. (green, yellow, red, etc.)
- * @property {string} [providerId] When provided, automatically connects the client to the specified provider uuid
- */
-/**
- * Manages creation of Interop Brokers and Interop Clients. These APIs are called under-the-hood in Platforms.
- * @namespace
- * @alias Interop
- */
-export default class InteropModule extends Base {
-    /**
-     * Initializes an Interop Broker. This is called under-the-hood for Platforms.
-     * @param { string } name - Name of the Interop Broker.
-     * @param { OverrideCallback<InteropBroker> } [override] - A callback function that can be used to extend or replace default Interop Broker behavior.
-     * @return {Promise.<InteropBroker>}
-     * @tutorial Interop.init
-     * @experimental
-     * @static
-     */
-    init(name: string, override?: OpenFin.OverrideCallback<InteropBroker>): Promise<InteropBroker>;
-    /**
-     * Connects a client to an Interop broker. This is called under-the-hood for Views in a Platform.
-     * @param { string } name - The name of the Interop Broker to connect to. For Platforms, this will default to the uuid of the Platform.
-     * @param { InteropConfig } [interopConfig] - Information relevant to the Interop Broker. Typically a declaration of
-     * what context(s) the entity wants to subscribe to, and the current Context Group of the entity.
-     * @return {InteropClient}
-     * @tutorial Interop.connectSync
-     * @experimental
-     * @static
-     */
-    connectSync(name: string, interopConfig: OpenFin.InteropConfig): InteropClient;
-}
+import { Base } from '../base';
+import { InteropBroker } from './InteropBroker';
+import { InteropClient } from './InteropClient';
+/**
+ * @typedef { object } InteropConfig
+ * @summary Information relevant to the Interop Broker.
+ * @property {string} [currentContextGroup] Context Group for the client. (green, yellow, red, etc.)
+ * @property {string} [providerId] When provided, automatically connects the client to the specified provider uuid
+ */
+/**
+ * Manages creation of Interop Brokers and Interop Clients. These APIs are called under-the-hood in Platforms.
+ * @namespace
+ * @alias Interop
+ */
+export default class InteropModule extends Base {
+    /**
+     * Initializes an Interop Broker. This is called under-the-hood for Platforms.
+     * @param { string } name - Name of the Interop Broker.
+     * @param { OverrideCallback<InteropBroker> } [override] - A callback function that can be used to extend or replace default Interop Broker behavior.
+     * @return {Promise.<InteropBroker>}
+     * @tutorial Interop.init
+     * @experimental
+     * @static
+     */
+    init(name: string, override?: OpenFin.OverrideCallback<InteropBroker>): Promise<InteropBroker>;
+    /**
+     * Connects a client to an Interop broker. This is called under-the-hood for Views in a Platform.
+     * @param { string } name - The name of the Interop Broker to connect to. For Platforms, this will default to the uuid of the Platform.
+     * @param { InteropConfig } [interopConfig] - Information relevant to the Interop Broker. Typically a declaration of
+     * what context(s) the entity wants to subscribe to, and the current Context Group of the entity.
+     * @return {InteropClient}
+     * @tutorial Interop.connectSync
+     * @experimental
+     * @static
+     */
+    connectSync(name: string, interopConfig: OpenFin.InteropConfig): InteropClient;
+}