@openfin/fdc3-api 41.102.7 → 41.103.2

package/out/fdc3-api-alpha.d.ts

@@ -4569,7 +4569,22 @@ declare type DomainSettings = {
 };
 
 /**
- * Map of preload scripts that can enable new scripts or disable options defined preloadScripts.
+ * Enables or disables specific preload scripts by URL.
+ *
+ * Uses the script's full URL as the key and an object
+ * with an `enabled` boolean property as the value.
+ * @example
+ * ```js
+ * {
+ "match": ["<all_urls>"],
+ "options": {
+ "preloadScripts": {
+ "http://localhost:53000/block-preload.js":  { "enabled": false }
+ "http://localhost:53000/allow-preload.js":  { "enabled": true }
+ }
+ }
+ }
+ * ```
  */
 declare type DomainSettingsPreloadScripts = Record<string, {
     enabled: boolean;
@@ -5735,7 +5750,7 @@ declare class FDC3ModuleBase<ChannelType extends v1_2.Channel | v2_0.Channel> {
      *
      * @tutorial fdc3.getOrCreateChannel
      */
-    getOrCreateChannel(channelId: string): Promise<ChannelType>;
+    protected getOrCreateChannel(channelId: string, fdc3Factory: (contextGroup: OpenFin.SessionContextGroup) => ChannelType): Promise<ChannelType>;
     /**
      * Returns the Interop-Broker-defined context groups available for an entity to join.
      *
@@ -6958,6 +6973,7 @@ declare class InteropBroker extends Base {
     private sessionContextGroupMap;
     private channel;
     private logging;
+    private privateChannelProviderMap;
     /* Excluded from this release type: __constructor */
     private getProvider;
     static createClosedConstructor(...args: ConstructorParameters<typeof InteropBroker>): {

package/out/fdc3-api-beta.d.ts

@@ -4569,7 +4569,22 @@ declare type DomainSettings = {
 };
 
 /**
- * Map of preload scripts that can enable new scripts or disable options defined preloadScripts.
+ * Enables or disables specific preload scripts by URL.
+ *
+ * Uses the script's full URL as the key and an object
+ * with an `enabled` boolean property as the value.
+ * @example
+ * ```js
+ * {
+ "match": ["<all_urls>"],
+ "options": {
+ "preloadScripts": {
+ "http://localhost:53000/block-preload.js":  { "enabled": false }
+ "http://localhost:53000/allow-preload.js":  { "enabled": true }
+ }
+ }
+ }
+ * ```
  */
 declare type DomainSettingsPreloadScripts = Record<string, {
     enabled: boolean;
@@ -5735,7 +5750,7 @@ declare class FDC3ModuleBase<ChannelType extends v1_2.Channel | v2_0.Channel> {
      *
      * @tutorial fdc3.getOrCreateChannel
      */
-    getOrCreateChannel(channelId: string): Promise<ChannelType>;
+    protected getOrCreateChannel(channelId: string, fdc3Factory: (contextGroup: OpenFin.SessionContextGroup) => ChannelType): Promise<ChannelType>;
     /**
      * Returns the Interop-Broker-defined context groups available for an entity to join.
      *
@@ -6958,6 +6973,7 @@ declare class InteropBroker extends Base {
     private sessionContextGroupMap;
     private channel;
     private logging;
+    private privateChannelProviderMap;
     /* Excluded from this release type: __constructor */
     private getProvider;
     static createClosedConstructor(...args: ConstructorParameters<typeof InteropBroker>): {

package/out/fdc3-api-public.d.ts

@@ -4569,7 +4569,22 @@ declare type DomainSettings = {
 };
 
 /**
- * Map of preload scripts that can enable new scripts or disable options defined preloadScripts.
+ * Enables or disables specific preload scripts by URL.
+ *
+ * Uses the script's full URL as the key and an object
+ * with an `enabled` boolean property as the value.
+ * @example
+ * ```js
+ * {
+ "match": ["<all_urls>"],
+ "options": {
+ "preloadScripts": {
+ "http://localhost:53000/block-preload.js":  { "enabled": false }
+ "http://localhost:53000/allow-preload.js":  { "enabled": true }
+ }
+ }
+ }
+ * ```
  */
 declare type DomainSettingsPreloadScripts = Record<string, {
     enabled: boolean;
@@ -5735,7 +5750,7 @@ declare class FDC3ModuleBase<ChannelType extends v1_2.Channel | v2_0.Channel> {
      *
      * @tutorial fdc3.getOrCreateChannel
      */
-    getOrCreateChannel(channelId: string): Promise<ChannelType>;
+    protected getOrCreateChannel(channelId: string, fdc3Factory: (contextGroup: OpenFin.SessionContextGroup) => ChannelType): Promise<ChannelType>;
     /**
      * Returns the Interop-Broker-defined context groups available for an entity to join.
      *
@@ -6958,6 +6973,7 @@ declare class InteropBroker extends Base {
     private sessionContextGroupMap;
     private channel;
     private logging;
+    private privateChannelProviderMap;
     /* Excluded from this release type: __constructor */
     private getProvider;
     static createClosedConstructor(...args: ConstructorParameters<typeof InteropBroker>): {

package/out/fdc3-api.d.ts

@@ -4628,7 +4628,22 @@ declare type DomainSettings = {
 };
 
 /**
- * Map of preload scripts that can enable new scripts or disable options defined preloadScripts.
+ * Enables or disables specific preload scripts by URL.
+ *
+ * Uses the script's full URL as the key and an object
+ * with an `enabled` boolean property as the value.
+ * @example
+ * ```js
+ * {
+ "match": ["<all_urls>"],
+ "options": {
+ "preloadScripts": {
+ "http://localhost:53000/block-preload.js":  { "enabled": false }
+ "http://localhost:53000/allow-preload.js":  { "enabled": true }
+ }
+ }
+ }
+ * ```
  */
 declare type DomainSettingsPreloadScripts = Record<string, {
     enabled: boolean;
@@ -5820,7 +5835,7 @@ declare class FDC3ModuleBase<ChannelType extends v1_2.Channel | v2_0.Channel> {
      *
      * @tutorial fdc3.getOrCreateChannel
      */
-    getOrCreateChannel(channelId: string): Promise<ChannelType>;
+    protected getOrCreateChannel(channelId: string, fdc3Factory: (contextGroup: OpenFin.SessionContextGroup) => ChannelType): Promise<ChannelType>;
     /**
      * Returns the Interop-Broker-defined context groups available for an entity to join.
      *
@@ -7064,6 +7079,7 @@ declare class InteropBroker extends Base {
     private sessionContextGroupMap;
     private channel;
     private logging;
+    private privateChannelProviderMap;
     /**
      * @internal
      */

package/out/fdc3-api.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var require$$2 = require('lodash/isEqual');
+var require$$0 = require('lodash/isEqual');
 
 var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
 
@@ -203,15 +203,86 @@ class PrivateChannelClient {
 }
 PrivateChannelClient$1.PrivateChannelClient = PrivateChannelClient;
 
+var fdc3Channels2_0 = {};
+
+var fdc3Channels1_2 = {};
+
+var __importDefault$2 = (commonjsGlobal && commonjsGlobal.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(fdc3Channels1_2, "__esModule", { value: true });
+fdc3Channels1_2.createV1Channel = void 0;
+const isEqual_1$1 = __importDefault$2(require$$0);
+const createV1Channel = (sessionContextGroup) => {
+    return {
+        id: sessionContextGroup.id,
+        type: 'app',
+        broadcast: sessionContextGroup.setContext,
+        getCurrentContext: async (contextType) => {
+            const context = await sessionContextGroup.getCurrentContext(contextType);
+            return context === undefined ? null : context;
+        },
+        // @ts-expect-error TODO [CORE-1524]
+        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 sessionContextGroup.getCurrentContext(realType);
+                const wrappedHandler = (context, contextMetadata) => {
+                    if (first) {
+                        first = false;
+                        if ((0, isEqual_1$1.default)(currentContext, context)) {
+                            return;
+                        }
+                    }
+                    // eslint-disable-next-line consistent-return
+                    return realHandler(context, contextMetadata);
+                };
+                return sessionContextGroup.addContextHandler(wrappedHandler, realType);
+            })();
+            return {
+                ...listener,
+                unsubscribe: () => listener.then((l) => l.unsubscribe())
+            };
+        }
+    };
+};
+fdc3Channels1_2.createV1Channel = createV1Channel;
+
+Object.defineProperty(fdc3Channels2_0, "__esModule", { value: true });
+fdc3Channels2_0.createV2Channel = void 0;
+const fdc3_channels_1_2_1$1 = fdc3Channels1_2;
+const createV2Channel = (sessionContextGroup) => {
+    const channel = (0, fdc3_channels_1_2_1$1.createV1Channel)(sessionContextGroup);
+    return {
+        ...channel,
+        // @ts-expect-error Type incompatibility on signature.
+        addContextListener: async (...args) => channel.addContextListener(...args)
+    };
+};
+fdc3Channels2_0.createV2Channel = createV2Channel;
+
 (function (exports) {
 	var __importDefault = (commonjsGlobal && commonjsGlobal.__importDefault) || function (mod) {
 	    return (mod && mod.__esModule) ? mod : { "default": mod };
 	};
 	Object.defineProperty(exports, "__esModule", { value: true });
-	exports.getIntentResolution = exports.isChannel = exports.isContext = exports.connectPrivateChannel = exports.buildAppChannelObject = exports.buildPrivateChannelObject = exports.ChannelError = exports.ResultError = exports.UnsupportedChannelApiError = exports.getUnsupportedChannelApis = void 0;
+	exports.getIntentResolution = exports.isChannel = exports.isContext = exports.connectPrivateChannel = exports.buildPrivateChannelObject = exports.ChannelError = exports.ResultError = exports.UnsupportedChannelApiError = exports.getUnsupportedChannelApis = void 0;
 	const utils_1 = utils$2;
 	const PrivateChannelClient_1 = PrivateChannelClient$1;
-	const isEqual_1 = __importDefault(require$$2);
+	__importDefault(require$$0);
+	const fdc3_channels_2_0_1 = fdc3Channels2_0;
 	const getUnsupportedChannelApis = (channelType) => {
 	    return {
 	        addContextListener: () => {
@@ -310,52 +381,6 @@ PrivateChannelClient$1.PrivateChannelClient = PrivateChannelClient;
 	    };
 	};
 	exports.buildPrivateChannelObject = buildPrivateChannelObject;
-	const buildAppChannelObject = (sessionContextGroup) => {
-	    return {
-	        id: sessionContextGroup.id,
-	        type: 'app',
-	        broadcast: sessionContextGroup.setContext,
-	        getCurrentContext: async (contextType) => {
-	            const context = await sessionContextGroup.getCurrentContext(contextType);
-	            return context === undefined ? null : context;
-	        },
-	        // @ts-expect-error TODO [CORE-1524]
-	        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 sessionContextGroup.getCurrentContext(realType);
-	                const wrappedHandler = (context, contextMetadata) => {
-	                    if (first) {
-	                        first = false;
-	                        if ((0, isEqual_1.default)(currentContext, context)) {
-	                            return;
-	                        }
-	                    }
-	                    // eslint-disable-next-line consistent-return
-	                    return realHandler(context, contextMetadata);
-	                };
-	                return sessionContextGroup.addContextHandler(wrappedHandler, realType);
-	            })();
-	            return {
-	                ...listener,
-	                unsubscribe: () => listener.then((l) => l.unsubscribe())
-	            };
-	        }
-	    };
-	};
-	exports.buildAppChannelObject = buildAppChannelObject;
 	const connectPrivateChannel = async (channelId) => {
 	    try {
 	        const channelClient = await fin.InterApplicationBus.Channel.connect(channelId);
@@ -387,6 +412,10 @@ PrivateChannelClient$1.PrivateChannelClient = PrivateChannelClient;
 	    // Generate an ID to make a session context group with. We will pass that ID to the Broker.
 	    // The broker will then setContext on that session context group later with our Intent Result,
 	    const guid = (0, utils_1.generateId)(); // TODO make this undefined in web
+	    let isPromiseSettled = false;
+	    // Adding the intentResolutionResultId to the intentObj. Because fireIntent only accepts a single arg, we have to slap it in here.
+	    const metadata = app ? { target: app, intentResolutionResultId: guid } : { intentResolutionResultId: guid };
+	    const intentObj = intent ? { name: intent, context, metadata } : { ...context, metadata };
 	    // Promise we'll use in getResult
 	    const getResultPromise = new Promise((resolve, reject) => {
 	        fin.InterApplicationBus.subscribe({ uuid: '*' }, guid, (intentResult) => {
@@ -399,13 +428,24 @@ PrivateChannelClient$1.PrivateChannelClient = PrivateChannelClient;
 	            reject(new Error('getResult is not supported in this environment'));
 	        });
 	    });
-	    // Adding the intentResolutionResultId to the intentObj. Because fireIntent only accepts a single arg, we have to slap it in here.
-	    const metadata = app ? { target: app, intentResolutionResultId: guid } : { intentResolutionResultId: guid };
-	    const intentObj = intent ? { name: intent, context, metadata } : { ...context, metadata };
+	    getResultPromise
+	        .then(() => {
+	        isPromiseSettled = true;
+	    })
+	        .catch(() => {
+	        isPromiseSettled = true;
+	    });
 	    // Set up the getResult call.
 	    const getResult = async () => {
+	        // All this mumbo jumbo is needed to make sure that getResult resolves correctly and conforms to the FDC3 spec.
+	        if (!isPromiseSettled) {
+	            return undefined;
+	        }
 	        let intentResult = await getResultPromise;
-	        if (!intentResult || typeof intentResult !== 'object') {
+	        if (isPromiseSettled && !intentResult) {
+	            return undefined;
+	        }
+	        if (typeof intentResult !== 'object') {
 	            throw new Error(ResultError.NoResultReturned);
 	        }
 	        const { error } = intentResult;
@@ -421,7 +461,7 @@ PrivateChannelClient$1.PrivateChannelClient = PrivateChannelClient;
 	                }
 	                case 'app': {
 	                    const sessionContextGroup = await interopModule.joinSessionContextGroup(id);
-	                    intentResult = (0, exports.buildAppChannelObject)(sessionContextGroup);
+	                    intentResult = (0, fdc3_channels_2_0_1.createV2Channel)(sessionContextGroup);
 	                    break;
 	                }
 	            }
@@ -1473,7 +1513,7 @@ fdc3Common.FDC3ModuleBase = void 0;
 const utils_1$2 = utils$1;
 const utils_2$1 = utils$2;
 const InteropClient_1$1 = InteropClient$1;
-const isEqual_1 = __importDefault(require$$2);
+const isEqual_1 = __importDefault(require$$0);
 class FDC3ModuleBase {
     get client() {
         return __classPrivateFieldGet(this, _FDC3ModuleBase_producer, "f").call(this);
@@ -1533,10 +1573,16 @@ class FDC3ModuleBase {
      *
      * @tutorial fdc3.getOrCreateChannel
      */
-    async getOrCreateChannel(channelId) {
+    async getOrCreateChannel(channelId, fdc3Factory) {
         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 hasChannelIdBeenUsed = await InteropClient_1$1.InteropClient.ferryFdc3Call(this.client, 'isIdUsedByPrivateChannel', {
+            channelId
+        });
+        if (hasChannelIdBeenUsed) {
+            throw new Error(utils_1$2.ChannelError.AccessDenied);
+        }
         const systemChannels = await this._getChannels();
         const userChannel = systemChannels.find((channel) => channel.id === channelId);
         if (userChannel) {
@@ -1544,7 +1590,7 @@ class FDC3ModuleBase {
         }
         try {
             const sessionContextGroup = await this.client.joinSessionContextGroup(channelId);
-            return (0, utils_1$2.buildAppChannelObject)(sessionContextGroup);
+            return fdc3Factory(sessionContextGroup);
         }
         catch (error) {
             console.error(error.message);
@@ -1694,6 +1740,7 @@ Object.defineProperty(fdc31_2, "__esModule", { value: true });
 exports.Fdc3Module = fdc31_2.Fdc3Module = void 0;
 const utils_1$1 = utils$2;
 const fdc3_common_1$1 = fdc3Common;
+const fdc3_channels_1_2_1 = fdc3Channels1_2;
 /**
  * @version 1.2
  * The FDC3 Client Library provides a set APIs to be used for FDC3 compliance,
@@ -1876,7 +1923,7 @@ class Fdc3Module extends fdc3_common_1$1.FDC3ModuleBase {
      * @tutorial fdc3.getOrCreateChannel
      */
     async getOrCreateChannel(channelId) {
-        return super.getOrCreateChannel(channelId);
+        return super.getOrCreateChannel(channelId, fdc3_channels_1_2_1.createV1Channel);
     }
     /**
      * 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.
@@ -1908,6 +1955,7 @@ const utils_1 = utils$2;
 const InteropClient_1 = InteropClient$1;
 const utils_2 = utils$1;
 const PrivateChannelClient_1 = PrivateChannelClient$1;
+const fdc3_channels_2_0_1 = fdc3Channels2_0;
 /**
  * @version 2.0
  * The FDC3 Client Library provides a set APIs to be used for FDC3 compliance,
@@ -2159,7 +2207,7 @@ class Fdc3Module2 extends fdc3_common_1.FDC3ModuleBase {
      * @tutorial fdc3.getOrCreateChannel
      */
     async getOrCreateChannel(channelId) {
-        return super.getOrCreateChannel(channelId);
+        return super.getOrCreateChannel(channelId, fdc3_channels_2_0_1.createV2Channel);
     }
     /**
      * Returns a Channel with an auto-generated identity that is intended for private communication between applications. Primarily used to create channels that will be returned to other applications via an IntentResolution for a raised intent.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/fdc3-api",
-    "version": "41.102.7",
+    "version": "41.103.2",
     "description": "OpenFin fdc3 module utilities and types.",
     "license": "SEE LICENSE IN LICENSE.md",
     "private": false,