@openfin/core 33.76.36 → 33.77.1

package/src/api/interappbus/index.js

@@ -1,210 +0,0 @@
-"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.
- *
- */
-class InterApplicationBus extends base_1.Base {
-    /**
-     * @internal
-     */
-    constructor(wire) {
-        super(wire);
-        this.events = {
-            subscriberAdded: 'subscriber-added',
-            subscriberRemoved: 'subscriber-removed'
-        };
-        this.refCounter = new ref_counter_1.RefCounter();
-        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 topic The topic on which the message is sent
-     * @param 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
-     *
-     * @example
-     * ```js
-     * fin.InterApplicationBus.publish('topic', 'hello').then(() => console.log('Published')).catch(err => console.log(err));
-     * ```
-     */
-    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 destination The identity of the application to which the message is sent
-     * @param topic The topic on which the message is sent
-     * @param 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
-     *
-     * @example
-     * ```js
-     * fin.InterApplicationBus.send(fin.me, 'topic', 'Hello there!').then(() => console.log('Message sent')).catch(err => console.log(err));
-     * ```
-     */
-    async send(destination, topic, message) {
-        const errorMsg = (0, 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 source This object is described in the Identity in the typedef
-     * @param topic The topic on which the message is sent
-     * @param 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
-     *
-     * @example
-     * ```js
-     * // subscribe to a specified application
-     * fin.InterApplicationBus.subscribe(fin.me, 'topic', sub_msg => console.log(sub_msg)).then(() => console.log('Subscribed to the specified application')).catch(err => console.log(err));
-     *
-     * // subscribe to wildcard
-     * fin.InterApplicationBus.subscribe({ uuid: '*' }, 'topic', sub_msg => console.log(sub_msg)).then(() => console.log('Subscribed to *')).catch(err => console.log(err));
-     * ```
-     */
-    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.
-     *
-     * @remarks If you are listening to all apps on a topic, (i.e you passed `{ uuid:'*' }` to the subscribe function)
-     * then you need to pass `{ uuid:'*' }` to unsubscribe as well. If you are listening to a specific application,
-     * (i.e you passed `{ uuid:'some_app' }` to the subscribe function) then you need to provide the same identifier to
-     * unsubscribe, unsubscribing to `*` on that same topic will not unhook your initial listener otherwise.
-     *
-     * @param source This object is described in the Identity in the typedef
-     * @param topic The topic on which the message is sent
-     * @param listener A callback previously registered with subscribe()
-     *
-     * @example
-     * ```js
-     * const listener = console.log;
-     *
-     * // If any application publishes a message on topic `foo`, our listener will be called.
-     * await fin.InterApplicationBus.subscribe({ uuid:'*' }, 'foo', listener)
-     *
-     * // When you want to unsubscribe, you need to specify the uuid of the app you'd like to
-     * // unsubscribe from (or `*`) and provide the same function you gave the subscribe function
-     * await fin.InterApplicationBus.unsubscribe({ uuid:'*' }, 'foo', listener)
-     * ```
-     */
-    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;
-/**
- * @internal
- */
-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,57 +0,0 @@
-import type * as OpenFin from '../../OpenFin';
-import { Base } from '../base';
-import { InteropBroker } from './InteropBroker';
-import { InteropClient } from './InteropClient';
-/**
- * @PORTED
- * @typedef { object } InteropConfig
- * @summary Information relevant to the Interop Broker.
- * @property {string} [currentContextGroup] Context Group for the client. (green, yellow, red, etc.)
- * @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.
- *
- */
-export default class InteropModule extends Base {
-    /**
-     * Initializes an Interop Broker. This is called under-the-hood for Platforms.
-     *
-     * @remarks For Platforms, this is set up automatically. We advise to only create your own Interop Broker
-     * when not using a Platform app. You can override functions in the Interop Broker. More info {@link InteropBroker here}.
-     *
-     * @param name - Name of the Interop Broker.
-     * @param override - A callback function that can be used to extend or replace default Interop Broker behavior.
-     *
-     * @example
-     * ``` js
-     * const interopBroker = await fin.Interop.init('openfin');
-     * const contextGroups = await interopBroker.getContextGroups();
-     * console.log(contextGroups);
-     * ```
-     * @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.
-     *
-     * @remarks
-     * @param name - The name of the Interop Broker to connect to. For Platforms, this will default to the uuid of the Platform.
-     * @param 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.
-     *
-     * @example
-     * ```js
-     * const interopConfig = {
-     *     currentContextGroup: 'green'
-     * }
-     *
-     * const interopBroker = await fin.Interop.init('openfin');
-     * const client = await fin.Interop.connectSync('openfin', interopConfig);
-     * const contextGroupInfo = await client.getInfoForContextGroup();
-     * console.log(contextGroupInfo);
-     * ```
-     * @static
-     */
-    connectSync(name: string, interopConfig?: OpenFin.InteropConfig): InteropClient;
-}

package/src/api/interop/Factory.js

@@ -1,96 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const lodash_1 = require("lodash");
-const inaccessibleObject_1 = require("../../util/inaccessibleObject");
-const base_1 = require("../base");
-const InteropBroker_1 = require("./InteropBroker");
-const InteropClient_1 = require("./InteropClient");
-const overrideCheck_1 = require("./fdc3/overrideCheck");
-const defaultOverride = (Class) => new Class();
-const BrokerParamAccessError = 'You have attempted to use or modify InteropBroker parameters, which is not allowed. You are likely using an older InteropBroker override scheme. Please consult our Interop docs for guidance on migrating to the new override scheme.';
-/**
- * @PORTED
- * @typedef { object } InteropConfig
- * @summary Information relevant to the Interop Broker.
- * @property {string} [currentContextGroup] Context Group for the client. (green, yellow, red, etc.)
- * @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.
- *
- */
-class InteropModule extends base_1.Base {
-    /**
-     * Initializes an Interop Broker. This is called under-the-hood for Platforms.
-     *
-     * @remarks For Platforms, this is set up automatically. We advise to only create your own Interop Broker
-     * when not using a Platform app. You can override functions in the Interop Broker. More info {@link InteropBroker here}.
-     *
-     * @param name - Name of the Interop Broker.
-     * @param override - A callback function that can be used to extend or replace default Interop Broker behavior.
-     *
-     * @example
-     * ``` js
-     * const interopBroker = await fin.Interop.init('openfin');
-     * const contextGroups = await interopBroker.getContextGroups();
-     * console.log(contextGroups);
-     * ```
-     * @static
-     */
-    async init(name, override = defaultOverride) {
-        var _a;
-        this.wire.sendAction('interop-init').catch((e) => {
-            // don't expose, analytics-only call
-        });
-        // Allows for manifest-level configuration, without having to override. (e.g. specifying custom context groups)
-        const options = await this.fin.Application.getCurrentSync().getInfo();
-        const opts = (_a = options.initialOptions.interopBrokerConfiguration) !== null && _a !== void 0 ? _a : {};
-        const objectThatThrows = (0, inaccessibleObject_1.createUnusableObject)(BrokerParamAccessError);
-        const warningOptsClone = (0, inaccessibleObject_1.createWarningObject)(BrokerParamAccessError, (0, lodash_1.cloneDeep)(opts));
-        let provider;
-        const getProvider = () => {
-            if (!provider) {
-                provider = this.fin.InterApplicationBus.Channel.create(`interop-broker-${name}`);
-            }
-            return provider;
-        };
-        const throwingGetProvider = async () => {
-            // eslint-disable-next-line no-console
-            throw new Error(BrokerParamAccessError);
-        };
-        const OverrideableBroker = InteropBroker_1.InteropBroker.createClosedConstructor(this.wire, getProvider, opts);
-        // We need to use these objects because removing them entirely would be a breaking change and we want an informative error
-        // @ts-expect-error
-        const broker = await override(OverrideableBroker, objectThatThrows, throwingGetProvider, warningOptsClone);
-        (0, overrideCheck_1.overrideCheck)(broker, (0, overrideCheck_1.getDefaultViewFdc3VersionFromAppInfo)(options));
-        return broker;
-    }
-    /**
-     * Connects a client to an Interop broker. This is called under-the-hood for Views in a Platform.
-     *
-     * @remarks
-     * @param name - The name of the Interop Broker to connect to. For Platforms, this will default to the uuid of the Platform.
-     * @param 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.
-     *
-     * @example
-     * ```js
-     * const interopConfig = {
-     *     currentContextGroup: 'green'
-     * }
-     *
-     * const interopBroker = await fin.Interop.init('openfin');
-     * const client = await fin.Interop.connectSync('openfin', interopConfig);
-     * const contextGroupInfo = await client.getInfoForContextGroup();
-     * console.log(contextGroupInfo);
-     * ```
-     * @static
-     */
-    connectSync(name, interopConfig) {
-        this.wire.sendAction('interop-connect-sync').catch((e) => {
-            // don't expose, analytics-only call
-        });
-        return new InteropClient_1.InteropClient(this.wire, name, interopConfig);
-    }
-}
-exports.default = InteropModule;