@openfin/core 29.73.10 → 29.73.11

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/core",
-    "version": "29.73.10",
+    "version": "29.73.11",
     "license": "Apache-2.0",
     "main": "./src/mock.js",
     "types": "./src/mock.d.ts",

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

@@ -19,7 +19,6 @@ export default class InteropModule extends Base {
      * @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>;
@@ -30,7 +29,6 @@ export default class InteropModule extends Base {
      * 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;

package/src/api/interop/Factory.js

@@ -26,7 +26,6 @@ class InteropModule extends base_1.Base {
      * @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
      */
     async init(name, override = defaultOverride) {
@@ -63,7 +62,6 @@ class InteropModule extends base_1.Base {
      * 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, interopConfig) {

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

@@ -4,7 +4,7 @@ import { Base } from '../base';
 import type Transport from '../../transport/transport';
 declare type Identity = OpenFin.Identity;
 /**
- * {@link https://developers.openfin.co/of-docs/docs/enable-color-linking **THE INTEROP API IS EXPERIMENTAL. IF YOU WOULD LIKE TO USE IT, PLEASE USE OUR DEFAULT IMPLEMENTATION IN BROWSER**}
+ * {@link https://developers.openfin.co/of-docs/docs/enable-color-linking}
  *
  * The Interop Broker is responsible for keeping track of the Interop state of the Platform, and for directing messages to the proper locations.
  *
@@ -181,7 +181,6 @@ export declare class InteropBroker extends Base {
      * @param { SetContextOptions } setContextOptions - New context to set.
      * @param { ClientIdentity } clientIdentity - Identity of the client sender.
      * @return { void }
-     * @experimental
      */
     setContext({ context }: {
         context: OpenFin.Context;
@@ -203,7 +202,6 @@ export declare class InteropBroker extends Base {
      * @return { Promise<void> }
      * @param { JoinContextGroupOptions } joinContextGroupOptions - Id of the Context Group and identity of the entity to join to the group.
      * @param { ClientIdentity } senderIdentity - Identity of the client sender.
-     * @experimental
      */
     joinContextGroup({ contextGroupId, target }: {
         contextGroupId: string;
@@ -215,7 +213,6 @@ export declare class InteropBroker extends Base {
      * @return { Promise<void> }
      * @param { AddClientToContextGroupOptions } addClientToContextGroupOptions - Contains the contextGroupId
      * @param { ClientIdentity } clientIdentity - Identity of the client sender.
-     * @experimental
      */
     addClientToContextGroup({ contextGroupId }: {
         contextGroupId: string;
@@ -228,7 +225,6 @@ export declare class InteropBroker extends Base {
      * @return { Promise<void> }
      * @param { RemoveFromContextGroupOptions } removeFromContextGroupOptions - Contains the target identity to remove.
      * @param { ClientIdentity } senderIdentity - Identity of the client sender.
-     * @experimental
      */
     removeFromContextGroup({ target }: {
         target: OpenFin.Identity;
@@ -238,14 +234,12 @@ export declare class InteropBroker extends Base {
      * Used by Platform Windows.
      * @return { Promise<void> }
      * @property { ClientIdentity } clientIdentity - Identity of the client sender.
-     * @experimental
      */
     removeClientFromContextGroup(clientIdentity: OpenFin.ClientIdentity): Promise<void>;
     /**
      * Returns the Interop-Broker-defined context groups available for an entity to join. Because this function is used in the rest of the Interop Broker to fetch the Context Groups, overriding this allows you to customize the Context Groups for the Interop Broker. However, we recommend customizing the context groups through configuration instead.
      * Used by Platform Windows.
      * @return { Promise<ContextGroupInfo[]>}
-     * @experimental
      */
     getContextGroups(): Readonly<OpenFin.ContextGroupInfo[]>;
     /**
@@ -253,7 +247,6 @@ export declare class InteropBroker extends Base {
      * Used by Platform Windows.
      * @param { GetInfoForContextGroupOptions } getInfoForContextGroupOptions - Contains contextGroupId, the context group you wish to get display info for.
      * @return { Promise<ContextGroupInfo>}
-     * @experimental
      */
     getInfoForContextGroup({ contextGroupId }: {
         contextGroupId: string;
@@ -263,7 +256,6 @@ export declare class InteropBroker extends Base {
      * Used by Platform Windows.
      * @param { GetAllClientsInContextGroupOptions } getAllClientsInContextGroupOptions - Contains contextGroupId, the context group you wish to get clients for.
      * @return { Promise<ClientIdentity[]>}
-     * @experimental
      */
     getAllClientsInContextGroup({ contextGroupId }: {
         contextGroupId: string;
@@ -275,7 +267,6 @@ export declare class InteropBroker extends Base {
      * @param { ClientIdentity }  clientIdentity Identity of the Client making the request.
      * @return { Promise<unknown> }
      * @tutorial interop.handleFiredIntent
-     * @experimental
      */
     handleFiredIntent(intent: OpenFin.Intent, clientIdentity: OpenFin.ClientIdentity): Promise<unknown>;
     /**
@@ -284,7 +275,6 @@ export declare class InteropBroker extends Base {
      * @param { Intent } intent The combination of an action and a context that is passed to an application for resolution.
      * @param { Identity } target - Identity of the target that will handle the intent.
      * @return { Promise<void> }
-     * @experimental
      */
     setIntentTarget(intent: OpenFin.Intent, target: OpenFin.Identity): Promise<void>;
     /**
@@ -294,7 +284,6 @@ export declare class InteropBroker extends Base {
      * @param { ClientIdentity }  clientIdentity Identity of the Client making the request.
      * @return { Promise<unknown> }
      * @tutorial interop.handleInfoForIntent
-     * @experimental
      */
     handleInfoForIntent(options: OpenFin.InfoForIntentOptions, clientIdentity: OpenFin.ClientIdentity): Promise<unknown>;
     /**
@@ -304,7 +293,6 @@ export declare class InteropBroker extends Base {
      * @param { ClientIdentity } clientIdentity Identity of the Client making the request.
      * @return { Promise<unknown> }
      * @tutorial interop.handleInfoForIntentsByContext
-     * @experimental
      */
     handleInfoForIntentsByContext(context: OpenFin.Context | OpenFin.FindIntentsByContextOptions, clientIdentity: OpenFin.ClientIdentity): Promise<unknown>;
     /**
@@ -314,7 +302,6 @@ export declare class InteropBroker extends Base {
      * @param { ClientIdentity }  clientIdentity Identity of the Client making the request.
      * @return { Promise<unknown> }
      * @tutorial interop.handleFiredIntentForContext
-     * @experimental
      */
     handleFiredIntentForContext(contextForIntent: OpenFin.ContextForIntent, clientIdentity: OpenFin.ClientIdentity): Promise<unknown>;
     /**

package/src/api/interop/InteropBroker.js

@@ -50,7 +50,7 @@ let contextGroups = [
     }
 ];
 /**
- * {@link https://developers.openfin.co/of-docs/docs/enable-color-linking **THE INTEROP API IS EXPERIMENTAL. IF YOU WOULD LIKE TO USE IT, PLEASE USE OUR DEFAULT IMPLEMENTATION IN BROWSER**}
+ * {@link https://developers.openfin.co/of-docs/docs/enable-color-linking}
  *
  * The Interop Broker is responsible for keeping track of the Interop state of the Platform, and for directing messages to the proper locations.
  *
@@ -254,7 +254,6 @@ class InteropBroker extends base_1.Base {
      * @param { SetContextOptions } setContextOptions - New context to set.
      * @param { ClientIdentity } clientIdentity - Identity of the client sender.
      * @return { void }
-     * @experimental
      */
     setContext({ context }, clientIdentity) {
         this.wire.sendAction('interop-broker-set-context').catch((e) => {
@@ -328,7 +327,6 @@ class InteropBroker extends base_1.Base {
      * @return { Promise<void> }
      * @param { JoinContextGroupOptions } joinContextGroupOptions - Id of the Context Group and identity of the entity to join to the group.
      * @param { ClientIdentity } senderIdentity - Identity of the client sender.
-     * @experimental
      */
     async joinContextGroup({ contextGroupId, target }, senderIdentity) {
         this.wire.sendAction('interop-broker-join-context-group').catch((e) => {
@@ -374,7 +372,6 @@ class InteropBroker extends base_1.Base {
      * @return { Promise<void> }
      * @param { AddClientToContextGroupOptions } addClientToContextGroupOptions - Contains the contextGroupId
      * @param { ClientIdentity } clientIdentity - Identity of the client sender.
-     * @experimental
      */
     async addClientToContextGroup({ contextGroupId }, clientIdentity) {
         this.wire.sendAction('interop-broker-add-client-to-context-group').catch((e) => {
@@ -418,7 +415,6 @@ class InteropBroker extends base_1.Base {
      * @return { Promise<void> }
      * @param { RemoveFromContextGroupOptions } removeFromContextGroupOptions - Contains the target identity to remove.
      * @param { ClientIdentity } senderIdentity - Identity of the client sender.
-     * @experimental
      */
     async removeFromContextGroup({ target }, senderIdentity) {
         this.wire.sendAction('interop-broker-remove-from-context-group').catch((e) => {
@@ -459,7 +455,6 @@ class InteropBroker extends base_1.Base {
      * Used by Platform Windows.
      * @return { Promise<void> }
      * @property { ClientIdentity } clientIdentity - Identity of the client sender.
-     * @experimental
      */
     async removeClientFromContextGroup(clientIdentity) {
         this.wire.sendAction('interop-broker-remove-client-from-context-group').catch((e) => {
@@ -476,7 +471,6 @@ class InteropBroker extends base_1.Base {
      * Returns the Interop-Broker-defined context groups available for an entity to join. Because this function is used in the rest of the Interop Broker to fetch the Context Groups, overriding this allows you to customize the Context Groups for the Interop Broker. However, we recommend customizing the context groups through configuration instead.
      * Used by Platform Windows.
      * @return { Promise<ContextGroupInfo[]>}
-     * @experimental
      */
     // eslint-disable-next-line class-methods-use-this
     getContextGroups() {
@@ -494,7 +488,6 @@ class InteropBroker extends base_1.Base {
      * Used by Platform Windows.
      * @param { GetInfoForContextGroupOptions } getInfoForContextGroupOptions - Contains contextGroupId, the context group you wish to get display info for.
      * @return { Promise<ContextGroupInfo>}
-     * @experimental
      */
     getInfoForContextGroup({ contextGroupId }) {
         this.wire.sendAction('interop-broker-get-info-for-context-group').catch((e) => {
@@ -508,7 +501,6 @@ class InteropBroker extends base_1.Base {
      * Used by Platform Windows.
      * @param { GetAllClientsInContextGroupOptions } getAllClientsInContextGroupOptions - Contains contextGroupId, the context group you wish to get clients for.
      * @return { Promise<ClientIdentity[]>}
-     * @experimental
      */
     getAllClientsInContextGroup({ contextGroupId }) {
         this.wire.sendAction('interop-broker-get-all-clients-in-context-group').catch((e) => {
@@ -528,7 +520,6 @@ class InteropBroker extends base_1.Base {
      * @param { ClientIdentity }  clientIdentity Identity of the Client making the request.
      * @return { Promise<unknown> }
      * @tutorial interop.handleFiredIntent
-     * @experimental
      */
     // eslint-disable-next-line class-methods-use-this
     async handleFiredIntent(intent, clientIdentity) {
@@ -542,7 +533,6 @@ class InteropBroker extends base_1.Base {
      * @param { Intent } intent The combination of an action and a context that is passed to an application for resolution.
      * @param { Identity } target - Identity of the target that will handle the intent.
      * @return { Promise<void> }
-     * @experimental
      */
     async setIntentTarget(intent, target) {
         this.wire.sendAction('interop-broker-set-intent-target').catch((e) => {
@@ -586,7 +576,6 @@ class InteropBroker extends base_1.Base {
      * @param { ClientIdentity }  clientIdentity Identity of the Client making the request.
      * @return { Promise<unknown> }
      * @tutorial interop.handleInfoForIntent
-     * @experimental
      */
     // eslint-disable-next-line class-methods-use-this
     async handleInfoForIntent(options, clientIdentity) {
@@ -601,7 +590,6 @@ class InteropBroker extends base_1.Base {
      * @param { ClientIdentity } clientIdentity Identity of the Client making the request.
      * @return { Promise<unknown> }
      * @tutorial interop.handleInfoForIntentsByContext
-     * @experimental
      */
     // eslint-disable-next-line class-methods-use-this
     async handleInfoForIntentsByContext(context, clientIdentity) {
@@ -616,7 +604,6 @@ class InteropBroker extends base_1.Base {
      * @param { ClientIdentity }  clientIdentity Identity of the Client making the request.
      * @return { Promise<unknown> }
      * @tutorial interop.handleFiredIntentForContext
-     * @experimental
      */
     // eslint-disable-next-line class-methods-use-this
     async handleFiredIntentForContext(contextForIntent, clientIdentity) {

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

@@ -82,7 +82,7 @@ import { Base } from '../base';
  * @return {Promise<void>}
  */
 /**
- * {@link https://developers.openfin.co/of-docs/docs/enable-color-linking **THE INTEROP API IS EXPERIMENTAL. IF YOU WOULD LIKE TO USE IT, PLEASE USE OUR DEFAULT IMPLEMENTATION IN BROWSER**}
+ * {@link https://developers.openfin.co/of-docs/docs/enable-color-linking}
  *
  * The Interop Client API is broken up into two groups:
  *
@@ -206,7 +206,6 @@ export declare class InteropClient extends Base {
      * @param { Intent } intent - The combination of an action and a context that is passed to an application for resolution.
      * @return { Promise<unknown>}
      * @tutorial interop.fireIntent
-     * @experimental
      */
     fireIntent<T = unknown>(intent: OpenFin.Intent): Promise<T>;
     /**
@@ -215,7 +214,6 @@ export declare class InteropClient extends Base {
      * @param { string } intentName - The name of an intent.
      * @return { Promise<Subscription> }
      * @tutorial interop.registerIntentHandler
-     * @experimental
      */
     registerIntentHandler(handler: OpenFin.IntentHandler, intentName: string, options?: any): Promise<{
         unsubscribe: () => Promise<void>;
@@ -226,7 +224,6 @@ export declare class InteropClient extends Base {
      * @param { string } [contextType]
      * @return { Promise<Context> }
      * @tutorial interop.getCurrentContext
-     * @experimental
      */
     getCurrentContext(contextType?: string): Promise<OpenFin.Context>;
     /**
@@ -234,7 +231,6 @@ export declare class InteropClient extends Base {
      * @param { InfoForIntentOptions } options
      * @return { Promise<unknown> }
      * @tutorial interop.getInfoForIntent
-     * @experimental
      */
     getInfoForIntent<T = unknown>(options: OpenFin.InfoForIntentOptions): Promise<T>;
     /**
@@ -242,7 +238,6 @@ export declare class InteropClient extends Base {
      * @param { Context } context
      * @return { Promise<unknown> }
      * @tutorial interop.getInfoForIntentsByContext
-     * @experimental
      */
     getInfoForIntentsByContext<T = unknown>(context: OpenFin.Context): Promise<T>;
     /**
@@ -251,7 +246,6 @@ export declare class InteropClient extends Base {
      * @param { ContextForIntent } context
      * @return { Promise<unknown> }
      * @tutorial interop.fireIntentForContext
-     * @experimental
      */
     fireIntentForContext<T = unknown>(context: OpenFin.ContextForIntent): Promise<T>;
     /**
@@ -261,7 +255,6 @@ export declare class InteropClient extends Base {
      * @param { string } sessionContextGroupId - Id of the context group.
      * @return { Promise<SessionContextGroup>}
      * @tutorial interop.joinSessionContextGroup
-     * @experimental
      */
     joinSessionContextGroup(sessionContextGroupId: string): Promise<OpenFin.SessionContextGroup>;
     /**

package/src/api/interop/InteropClient.js

@@ -98,7 +98,7 @@ const utils_1 = require("./utils");
  * @return {Promise<void>}
  */
 /**
- * {@link https://developers.openfin.co/of-docs/docs/enable-color-linking **THE INTEROP API IS EXPERIMENTAL. IF YOU WOULD LIKE TO USE IT, PLEASE USE OUR DEFAULT IMPLEMENTATION IN BROWSER**}
+ * {@link https://developers.openfin.co/of-docs/docs/enable-color-linking}
  *
  * The Interop Client API is broken up into two groups:
  *
@@ -305,7 +305,6 @@ class InteropClient extends base_1.Base {
      * @param { Intent } intent - The combination of an action and a context that is passed to an application for resolution.
      * @return { Promise<unknown>}
      * @tutorial interop.fireIntent
-     * @experimental
      */
     async fireIntent(intent) {
         this.wire.sendAction('interop-client-fire-intent').catch((e) => {
@@ -320,7 +319,6 @@ class InteropClient extends base_1.Base {
      * @param { string } intentName - The name of an intent.
      * @return { Promise<Subscription> }
      * @tutorial interop.registerIntentHandler
-     * @experimental
      */
     async registerIntentHandler(handler, intentName, options) {
         this.wire.sendAction('interop-client-register-intent-handler').catch((e) => {
@@ -348,7 +346,6 @@ class InteropClient extends base_1.Base {
      * @param { string } [contextType]
      * @return { Promise<Context> }
      * @tutorial interop.getCurrentContext
-     * @experimental
      */
     async getCurrentContext(contextType) {
         this.wire.sendAction('interop-client-get-current-context').catch((e) => {
@@ -362,7 +359,6 @@ class InteropClient extends base_1.Base {
      * @param { InfoForIntentOptions } options
      * @return { Promise<unknown> }
      * @tutorial interop.getInfoForIntent
-     * @experimental
      */
     async getInfoForIntent(options) {
         this.wire.sendAction('interop-client-get-info-for-intent').catch((e) => {
@@ -376,7 +372,6 @@ class InteropClient extends base_1.Base {
      * @param { Context } context
      * @return { Promise<unknown> }
      * @tutorial interop.getInfoForIntentsByContext
-     * @experimental
      */
     async getInfoForIntentsByContext(context) {
         this.wire.sendAction('interop-client-get-info-for-intents-by-context').catch((e) => {
@@ -391,7 +386,6 @@ class InteropClient extends base_1.Base {
      * @param { ContextForIntent } context
      * @return { Promise<unknown> }
      * @tutorial interop.fireIntentForContext
-     * @experimental
      */
     async fireIntentForContext(context) {
         this.wire.sendAction('interop-client-fire-intent-for-context').catch((e) => {
@@ -407,7 +401,6 @@ class InteropClient extends base_1.Base {
      * @param { string } sessionContextGroupId - Id of the context group.
      * @return { Promise<SessionContextGroup>}
      * @tutorial interop.joinSessionContextGroup
-     * @experimental
      */
     async joinSessionContextGroup(sessionContextGroupId) {
         try {