@openfin/core 33.76.36 → 33.77.1

package/src/api/interop/fdc3/fdc3-1.2.js

@@ -1,435 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const base_1 = require("../../base");
-const utils_1 = require("./utils");
-const utils_2 = require("../utils");
-const InteropClient_1 = require("../InteropClient");
-const lodash_1 = require("lodash");
-/**
- * @typedef { object } Listener
- * @summary Listener object returned by addContextListener and addIntentListener
- * @property {function} unsubscribe function for addContextListener and addIntentListener.
- */
-/**
- * @typedef { object } Channel
- * @summary Information for a Context Group. Contains metadata for displaying the group properly.
- * @property {string} id Name of the context group
- * @property {DisplayMetadata} displayMetadata Metadata for the Context Group. Contains the group's human-readable name, color, and an image, as defined by the Interop Broker.
- * @property {string} type Defaults to system.
- * @property {function} broadcast Broadcasts a context for the channel.
- * @property {function} addContextListener Add a context handler for incoming context.
- * @property {function} getCurrentContext Gets the current context for the channel.
- */
-/**
- * @typedef  { object } AppMetadata
- * @summary App metadata is provided by the FDC3 App Directory.
- * @property {string} name
- * @property {string} [appId]
- * @property {string} [version]
- * @property {string} [title]
- * @property {string} [tooltip]
- * @property {string} [description]
- * @property {Array<string>} [icons]
- * @property {Array<string>} [images]
- */
-/**
- * @typedef { string | AppMetadata } TargetApp
- * @summary Some operations can identify an app just by its name, or pass full app metadata.
- */
-/**
- * @typedef { object } IntentResolution
- * @summary IntentResolution provides a standard format for data returned upon resolving an Intent.
- * @property { TargetApp } source identifier for the Application resolving the Intent (null if the Intent could not be resolved)
- * @property { string } [data] Return data structure - if one is provided for the given Intent.
- * @property { string } version The version number of the Intents schema being used
- */
-/**
- * @typedef { object } AppIntent
- * @summary An interface that represents the binding of an intent to apps.
- * @property { Intent } intent
- * @property { Array<AppMetadata> } apps
- */
-/**
- * @typedef { object } ImplementationMetadata
- * @summary An interface that represents FDC3 implementation meta data.
- * @property { string } fdc3Version The FDC3 version
- * @property { string } provider The provider uuid with prepend 'openfin'
- * @property { string } [providerVersion] The provider runtime version
- */
-/**
- * @version 1.2
- * The FDC3 Client Library provides a set APIs to be used for FDC3 compliance,
- * while using our Interop API under the hood. In order to use this set of APIs
- * you will need to set up your own {@link InteropBroker InteropBroker} or use a Platform application, which does the setup for you. Refer to our documentation on
- * our {@link https://developers.openfin.co/of-docs/docs/enable-color-linking Interop API}.
- *
- * To enable the FDC3 APIs in a {@link Window Window} or {@link View View}, add the fdc3InteropApi
- * property to its options:
- *
- * ```js
- * {
- *     autoShow: false,
- *     saveWindowState: true,
- *     url: 'https://openfin.co',
- *     fdc3InteropApi: '1.2'
- * }
- * ```
- *
- * If using a {@link Platform Platform } application, you can set this property in defaultWindowOptions and defaultViewOptions.
- *
- * In order to ensure that the FDC3 Api is ready before use, you can use the 'fdc3Ready' event fired on the DOM Window object:
- *
- * ```js
- * function fdc3Action() {
- *     // Make some fdc3 API calls here
- * }
- *
- * if (window.fdc3) {
- *    fdc3Action();
- * } else {
- *    window.addEventListener('fdc3Ready', fdc3Action);
- * }
- * ```
- */
-class Fdc3Module extends base_1.Base {
-    /**
-     * Add a context handler for incoming context. If an entity is part of a context group, and then sets its context handler, it will receive all of its declared contexts. If you wish to listen for all incoming contexts, pass `null` for the contextType argument.
-     * @param contextType - The type of context you wish to handle.
-     * @param handler - Handler for incoming context.
-     *
-     * @tutorial fdc3.addContextListener
-     * @static
-     */
-    addContextListener(contextType, handler) {
-        this.wire.sendAction('fdc3-add-context-listener').catch((e) => {
-            // we do not want to expose this error, just continue if this analytics-only call fails
-        });
-        let listener;
-        if (typeof contextType === 'function') {
-            console.warn('addContextListener(handler) has been deprecated. Please use addContextListener(null, handler)');
-            listener = this.fin.me.interop.addContextHandler(contextType);
-        }
-        else {
-            listener = this.fin.me.interop.addContextHandler(handler, contextType === null ? undefined : contextType);
-        }
-        return {
-            ...listener,
-            unsubscribe: () => listener.then((l) => l.unsubscribe())
-        };
-    }
-    /**
-     * Broadcasts a context for the channel of the current entity.
-     * @param context - New context to set.
-     *
-     * @tutorial fdc3.broadcast
-     * @static
-     */
-    async broadcast(context) {
-        this.wire.sendAction('fdc3-broadcast').catch((e) => {
-            // we do not want to expose this error, just continue if this analytics-only call fails
-        });
-        return this.fin.me.interop.setContext(context);
-    }
-    /**
-     * Returns the Interop-Broker-defined context groups available for an entity to join.
-     *
-     * @tutorial fdc3.getSystemChannels
-     * @static
-     */
-    async getSystemChannels() {
-        this.wire.sendAction('fdc3-get-system-channels').catch((e) => {
-            // we do not want to expose this error, just continue if this analytics-only call fails
-        });
-        const channels = await this.fin.me.interop.getContextGroups();
-        // fdc3 implementation of getSystemChannels returns on array of channels, have to decorate over
-        // this so people know that these APIs are not supported
-        return channels.map((channel) => {
-            return { ...channel, type: 'system', ...(0, utils_1.getUnsupportedChannelApis)() };
-        });
-    }
-    /**
-     * Join all Interop Clients at the given identity to context group `contextGroupId`.
-     * If no target is specified, it adds the sender to the context group.
-     * Because multiple Channel connections/Interop Clients can potentially exist at a `uuid`/`name` combo, we currently join all Channel connections/Interop Clients at the given identity to the context group.
-     * If an `endpointId` is provided (which is unlikely, unless the call is coming from an external adapter), then we only join that single connection to the context group.
-     * For all intents and purposes, there will only be 1 connection present in Platform and Browser implementations, so this point is more-or-less moot.
-     * @param channelId - Id of the context group.
-     *
-     * @tutorial fdc3.joinChannel
-     * @static
-     */
-    async joinChannel(channelId) {
-        this.wire.sendAction('fdc3-join-channel').catch((e) => {
-            // we do not want to expose this error, just continue if this analytics-only call fails
-        });
-        try {
-            return await this.fin.me.interop.joinContextGroup(channelId);
-        }
-        catch (error) {
-            if (error.message === utils_2.BROKER_ERRORS.joinSessionContextGroupWithJoinContextGroup) {
-                console.error('The Channel you have tried to join is an App Channel. Custom Channels can only be defined by the Interop Broker through code or manifest configuration. Please use getOrCreateChannel.');
-            }
-            else {
-                console.error(error.message);
-            }
-            if (error.message.startsWith('Attempting to join a context group that does not exist')) {
-                throw new Error(utils_1.ChannelError.NoChannelFound);
-            }
-            throw new Error(utils_1.ChannelError.AccessDenied);
-        }
-    }
-    /**
-     * Removes the specified target from a context group.
-     * If no target is specified, it removes the sender from their context group.
-     *
-     * @tutorial fdc3.leaveCurrentChannel
-     * @static
-     */
-    async leaveCurrentChannel() {
-        this.wire.sendAction('fdc3-leave-current-channel').catch((e) => {
-            // we do not want to expose this error, just continue if this analytics-only call fails
-        });
-        return this.fin.me.interop.removeFromContextGroup();
-    }
-    /**
-     * Adds a listener for incoming Intents.
-     * @param intent - Name of the Intent
-     * @param handler - Handler for incoming Intent
-     *
-     * @tutorial fdc3.addIntentListener
-     * @static
-     */
-    addIntentListener(intent, handler) {
-        this.wire.sendAction('fdc3-add-intent-listener').catch((e) => {
-            // we do not want to expose this error, just continue if this analytics-only call fails
-        });
-        const contextHandler = (raisedIntent) => {
-            handler(raisedIntent.context);
-        };
-        const listener = this.fin.me.interop.registerIntentHandler(contextHandler, intent, {
-            fdc3Version: '1.2'
-        });
-        return {
-            ...listener,
-            unsubscribe: () => listener.then((l) => l.unsubscribe())
-        };
-    }
-    /**
-     * Raises a specific intent.
-     * @param intent Name of the Intent.
-     * @param context Context associated with the Intent.
-     * @param  app App that will resolve the Intent. This is added as metadata to the Intent. Can be accessed by the app provider in {@link InteropBroker#handleFiredIntent InteropBroker.handleFiredIntent}.
-     *
-     * @tutorial fdc3.raiseIntent
-     * @static
-     */
-    async raiseIntent(intent, context, app) {
-        this.wire.sendAction('fdc3-raise-intent').catch((e) => {
-            // we do not want to expose this error, just continue if this analytics-only call fails
-        });
-        const intentObj = app
-            ? { name: intent, context, metadata: { target: app } }
-            : { name: intent, context };
-        try {
-            return await this.fin.me.interop.fireIntent(intentObj);
-        }
-        catch (error) {
-            const errorToThrow = error.message === utils_2.BROKER_ERRORS.fireIntent ? 'ResolverUnavailable' : error.message;
-            throw new Error(errorToThrow);
-        }
-    }
-    /**
-     * Returns the Channel that the entity is subscribed to. Returns null if not joined to a channel.
-     *
-     * @tutorial fdc3.getCurrentChannel
-     */
-    async getCurrentChannel() {
-        this.wire.sendAction('fdc3-get-current-channel').catch((e) => {
-            // we do not want to expose this error, just continue if this analytics-only call fails
-        });
-        const currentContextGroupInfo = await this.getCurrentContextGroupInfo();
-        if (!currentContextGroupInfo) {
-            return null;
-        }
-        return this.buildChannelObject(currentContextGroupInfo);
-    }
-    /**
-     * Find out more information about a particular intent by passing its name, and optionally its context.
-     * @param intent Name of the Intent
-     * @param context
-     *
-     * @tutorial fdc3.findIntent
-     */
-    async findIntent(intent, context) {
-        this.wire.sendAction('fdc3-find-intent').catch((e) => {
-            // we do not want to expose this error, just continue if this analytics-only call fails
-        });
-        try {
-            return await this.fin.me.interop.getInfoForIntent({ name: intent, context });
-        }
-        catch (error) {
-            const errorToThrow = error.message === utils_2.BROKER_ERRORS.getInfoForIntent ? 'ResolverUnavailable' : error.message;
-            throw new Error(errorToThrow);
-        }
-    }
-    /**
-     * Find all the available intents for a particular context.
-     * @param context
-     *
-     * @tutorial fdc3.findIntentsByContext
-     */
-    async findIntentsByContext(context) {
-        this.wire.sendAction('fdc3-find-intents-by-context').catch((e) => {
-            // we do not want to expose this error, just continue if this analytics-only call fails
-        });
-        try {
-            return await this.fin.me.interop.getInfoForIntentsByContext(context);
-        }
-        catch (error) {
-            const errorToThrow = error.message === utils_2.BROKER_ERRORS.getInfoForIntentsByContext ? 'ResolverUnavailable' : error.message;
-            throw new Error(errorToThrow);
-        }
-    }
-    /**
-     * Finds and raises an intent against a target app based purely on context data.
-     * @param context
-     * @param app
-     *
-     * @tutorial fdc3.raiseIntentForContext
-     */
-    async raiseIntentForContext(context, app) {
-        this.wire.sendAction('fdc3-raise-intent-for-context').catch((e) => {
-            // we do not want to expose this error, just continue if this analytics-only call fails
-        });
-        try {
-            return await this.fin.me.interop.fireIntentForContext({ ...context, metadata: { target: app } });
-        }
-        catch (error) {
-            const errorToThrow = error.message === utils_2.BROKER_ERRORS.fireIntentForContext ? 'ResolverUnavailable' : error.message;
-            throw new Error(errorToThrow);
-        }
-    }
-    /**
-     * Returns a Channel object for the specified channel, creating it as an App Channel if it does not exist.
-     * @param channelId
-     *
-     * @tutorial fdc3.getOrCreateChannel
-     */
-    async getOrCreateChannel(channelId) {
-        this.wire.sendAction('fdc3-get-or-create-channel').catch((e) => {
-            // we do not want to expose this error, just continue if this analytics-only call fails
-        });
-        const systemChannels = await this.getSystemChannels();
-        const userChannel = systemChannels.find((channel) => channel.id === channelId);
-        if (userChannel) {
-            return { ...userChannel, type: 'system', ...(0, utils_1.getUnsupportedChannelApis)() };
-        }
-        try {
-            const sessionContextGroup = await this.fin.me.interop.joinSessionContextGroup(channelId);
-            return (0, utils_1.buildAppChannelObject)(sessionContextGroup);
-        }
-        catch (error) {
-            console.error(error.message);
-            throw new Error(utils_1.ChannelError.CreationFailed);
-        }
-    }
-    /**
-     * Returns metadata relating to the FDC3 object and its provider, including the supported version of the FDC3 specification and the name of the provider of the implementation.
-     *
-     * @tutorial fdc3.getInfo
-     */
-    getInfo() {
-        this.wire.sendAction('fdc3-get-info').catch((e) => {
-            // we do not want to expose this error, just continue if this analytics-only call fails
-        });
-        // @ts-expect-error
-        const { uuid, fdc3InteropApi } = fin.__internal_.initialOptions;
-        // @ts-expect-error
-        const runtimeVersion = fin.desktop.getVersion();
-        return {
-            fdc3Version: fdc3InteropApi,
-            provider: `openfin-${uuid}`,
-            providerVersion: runtimeVersion
-        };
-    }
-    /**
-     * Launches an app with target information, which can either be a string or an AppMetadata object.
-     * @param app
-     * @param context
-     *
-     * @tutorial fdc3.open
-     */
-    async open(app, context) {
-        this.wire.sendAction('fdc3-open').catch((e) => {
-            // we do not want to expose this error, just continue if this analytics-only call fails
-        });
-        try {
-            return await InteropClient_1.InteropClient.ferryFdc3Call(this.fin.me.interop, 'fdc3Open', { app, context });
-        }
-        catch (error) {
-            const errorToThrow = error.message === utils_2.BROKER_ERRORS.fdc3Open ? 'ResolverUnavailable' : error.message;
-            throw new Error(errorToThrow);
-        }
-    }
-    // utils
-    // eslint-disable-next-line class-methods-use-this
-    async getCurrentContextGroupInfo() {
-        const contextGroups = await this.fin.me.interop.getContextGroups();
-        const clientsInCtxGroupsPromise = contextGroups.map(async (ctxGroup) => {
-            return this.fin.me.interop.getAllClientsInContextGroup(ctxGroup.id);
-        });
-        const clientsInCtxGroups = await Promise.all(clientsInCtxGroupsPromise);
-        const clientIdx = clientsInCtxGroups.findIndex((clientIdentityArr) => {
-            return clientIdentityArr.some((clientIdentity) => {
-                const { uuid, name } = clientIdentity;
-                return this.fin.me.uuid === uuid && this.fin.me.name === name;
-            });
-        });
-        return contextGroups[clientIdx];
-    }
-    async buildChannelObject(currentContextGroupInfo) {
-        return {
-            ...currentContextGroupInfo,
-            type: 'system',
-            addContextListener: (contextType, handler) => {
-                let realHandler;
-                let realType;
-                if (typeof contextType === 'function') {
-                    console.warn('addContextListener(handler) has been deprecated. Please use addContextListener(null, handler)');
-                    realHandler = contextType;
-                }
-                else {
-                    realHandler = handler;
-                    if (typeof contextType === 'string') {
-                        realType = contextType;
-                    }
-                }
-                const listener = (async () => {
-                    let first = true;
-                    const currentContext = await this.fin.me.interop.getCurrentContext(realType);
-                    const wrappedHandler = (context, contextMetadata) => {
-                        if (first) {
-                            first = false;
-                            if ((0, lodash_1.isEqual)(currentContext, context)) {
-                                return;
-                            }
-                        }
-                        // eslint-disable-next-line consistent-return
-                        return realHandler(context, contextMetadata);
-                    };
-                    return this.fin.me.interop.addContextHandler(wrappedHandler, realType);
-                })();
-                return {
-                    ...listener,
-                    unsubscribe: () => listener.then((l) => l.unsubscribe())
-                };
-            },
-            broadcast: this.broadcast.bind(this),
-            getCurrentContext: async (contextType) => {
-                const context = await this.fin.me.interop.getCurrentContext(contextType);
-                return context === undefined ? null : context;
-            }
-        };
-    }
-}
-exports.default = Fdc3Module;