Added a new type PlatfromInteropBrokerHelpers which extends ModuleHelpers

how-to/workspace-platform-starter/CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## v18.0.0
 
+- Update the interop broker override module pattern so that it is now passed a PlatformInteropBrokerHelpers object instead of the standard ModuleHelpers object. There are no additional functions at the moment but getApps returns all apps (even private ones) for the interop broker as it needs access to everything in order to perform intent resolution.
 - Added example of supporting workspace and desktop browser (through openfin/core-web as part of OpenFin anywhere) to our contact and manager portal examples in public/common by importing the fin/fdc3 api if it is not available (will require being rendered in an OpenFin Web Layout: <https://github.com/built-on-openfin/web-starter/tree/web/v18.0.0>).
 - More efficient validation of appIds associated with views/windows for faster interop based actions. The appId validation in our wps module (modules directory) has extracted into its own file and tests to ensure it continues to behave as expected across future updates have been added to the test directory.
 - Module Helpers now provide a getAnalyticsClient (it is marked as optional and the result could be undefined so it leaves the option for it to be denied to a module or removed). This client supports a ModuleAnalytic event which will have a source of Module assigned to it (you can still specify type and use the data property to provide additional module specific information). This data will be passed to the analyticProviders that receive the Workspace Analytic events. See [How to Configure Analytics](./docs/how-to-configure-analytics.md).

how-to/workspace-platform-starter/client/src/framework/platform/interop.ts

@@ -1,11 +1,15 @@
 import type OpenFin from "@openfin/core";
+import { getApps } from "../apps";
 import { createLogger } from "../logger-provider";
 import { initializeModules, loadModules } from "../modules";
 import type { WindowPositioningOptions } from "../shapes/browser-shapes";
-import type { PlatformInteropOverride, PlatformInteropOverrideOptions } from "../shapes/interopbroker-shapes";
+import type {
+	PlatformInteropBrokerHelpers,
+	PlatformInteropOverride,
+	PlatformInteropOverrideOptions
+} from "../shapes/interopbroker-shapes";
 import type { ModuleDefinition, ModuleEntry, ModuleHelpers } from "../shapes/module-shapes";
 import type { PlatformProviderOptions } from "../shapes/platform-shapes";
-
 const logger = createLogger("InteropProvider");
 const allOverrides: OpenFin.ConstructorOverride<OpenFin.InteropBroker>[] = [];
 let modules: ModuleEntry<PlatformInteropOverride, unknown, unknown, ModuleDefinition>[] = [];
@@ -43,9 +47,17 @@ export async function init(
 			...interopOverrideSettings?.openOptions
 		};
 
+		// interop broker will need access to all apps where as general modules
+		// have access to public apps and will need the specific appId or intent
+		// if they want to read/launch them.
+		const platformInteropBrokeHelpers: PlatformInteropBrokerHelpers = {
+			...helpers,
+			getApps
+		};
+
 		if (Array.isArray(moduleOptions)) {
 			modules = await loadModules<PlatformInteropOverride>(options.interop, "interopOverride");
-			await initializeModules<PlatformInteropOverride>(modules, helpers);
+			await initializeModules<PlatformInteropOverride>(modules, platformInteropBrokeHelpers);
 		}
 
 		logger.info("Getting interop overrides...");

how-to/workspace-platform-starter/client/src/framework/shapes/interopbroker-shapes.ts

@@ -282,3 +282,8 @@ export interface OpenOptions {
 	 */
 	connectionTimeout?: number;
 }
+
+/**
+ * Interop Broker helpers provides environment methods and data.
+ */
+export type PlatformInteropBrokerHelpers = ModuleHelpers;

how-to/workspace-platform-starter/client/src/modules/interop-override/openfin-cloud-interop/interop-override.ts

@@ -3,10 +3,11 @@ import { cloudInteropOverride } from "@openfin/cloud-interop";
 import type OpenFin from "@openfin/core";
 import type {
 	PlatformInteropOverride,
-	PlatformInteropOverrideOptions
+	PlatformInteropOverrideOptions,
+	PlatformInteropBrokerHelpers
 } from "workspace-platform-starter/shapes/interopbroker-shapes";
 import type { Logger, LoggerCreator } from "workspace-platform-starter/shapes/logger-shapes";
-import type { ModuleDefinition, ModuleHelpers } from "workspace-platform-starter/shapes/module-shapes";
+import type { ModuleDefinition } from "workspace-platform-starter/shapes/module-shapes";
 import { isStringValue } from "workspace-platform-starter/utils";
 import type { OpenFinCloudInteropOptions } from "./shapes";
 
@@ -30,7 +31,7 @@ export class OpenFinCloudInterop implements PlatformInteropOverride<OpenFinCloud
 	 * Helper methods for the module.
 	 * @internal
 	 */
-	private _helpers: ModuleHelpers | undefined;
+	private _helpers: PlatformInteropBrokerHelpers | undefined;
 
 	/**
 	 * Initialize the module.
@@ -42,7 +43,7 @@ export class OpenFinCloudInterop implements PlatformInteropOverride<OpenFinCloud
 	public async initialize(
 		definition: ModuleDefinition<OpenFinCloudInteropOptions>,
 		loggerCreator: LoggerCreator,
-		helpers: ModuleHelpers
+		helpers: PlatformInteropBrokerHelpers
 	): Promise<void> {
 		this._definition = definition;
 		const loggerName = definition.data?.loggerName ?? "OpenfinCloudInterop";

how-to/workspace-platform-starter/client/src/modules/interop-override/wps-interop-override/broker/wps-interop-override.ts

@@ -30,10 +30,10 @@ import type {
 	IntentRegistrationPayload,
 	IntentTargetMetaData,
 	ProcessedContext,
-	PlatformInteropOverrideOptions
+	PlatformInteropOverrideOptions,
+	PlatformInteropBrokerHelpers
 } from "workspace-platform-starter/shapes/interopbroker-shapes";
 import type { Logger } from "workspace-platform-starter/shapes/logger-shapes";
-import type { ModuleHelpers } from "workspace-platform-starter/shapes/module-shapes";
 import {
 	formatError,
 	isEmpty,
@@ -58,7 +58,7 @@ import { IntentResolverHelper } from "./intent-resolver-helper";
 export async function getConstructorOverride(
 	options: PlatformInteropOverrideOptions,
 	logger: Logger,
-	helpers: ModuleHelpers
+	helpers: PlatformInteropBrokerHelpers
 ): Promise<OpenFin.ConstructorOverride<OpenFin.InteropBroker>> {
 	if (!helpers?.getApp || !helpers?.getApps || !helpers.launchApp) {
 		throw new Error(

how-to/workspace-platform-starter/client/src/modules/interop-override/wps-interop-override/interop-override.ts

@@ -2,10 +2,11 @@
 import type OpenFin from "@openfin/core";
 import type {
 	PlatformInteropOverride,
-	PlatformInteropOverrideOptions
+	PlatformInteropOverrideOptions,
+	PlatformInteropBrokerHelpers
 } from "workspace-platform-starter/shapes/interopbroker-shapes";
 import type { Logger, LoggerCreator } from "workspace-platform-starter/shapes/logger-shapes";
-import type { ModuleDefinition, ModuleHelpers } from "workspace-platform-starter/shapes/module-shapes";
+import type { ModuleDefinition } from "workspace-platform-starter/shapes/module-shapes";
 import { getConstructorOverride as wpsConstructorOverride } from "./broker/wps-interop-override";
 import type { WpsInteropOverrideOptions } from "./shapes";
 /**
@@ -28,7 +29,7 @@ export class WpsInteropOverride implements PlatformInteropOverride<WpsInteropOve
 	 * Helper methods for the module.
 	 * @internal
 	 */
-	private _helpers: ModuleHelpers | undefined;
+	private _helpers: PlatformInteropBrokerHelpers | undefined;
 
 	/**
 	 * Initialize the module.
@@ -40,7 +41,7 @@ export class WpsInteropOverride implements PlatformInteropOverride<WpsInteropOve
 	public async initialize(
 		definition: ModuleDefinition<WpsInteropOverrideOptions>,
 		loggerCreator: LoggerCreator,
-		helpers: ModuleHelpers
+		helpers: PlatformInteropBrokerHelpers
 	): Promise<void> {
 		this._definition = definition;
 		const loggerName = definition.data?.loggerName ?? "WpsInteropOverride";

how-to/workspace-platform-starter/client/types/module/shapes/interopbroker-shapes.d.ts

@@ -252,3 +252,7 @@ export interface OpenOptions {
 	 */
 	connectionTimeout?: number;
 }
+/**
+ * Interop Broker helpers provides environment methods and data.
+ */
+export type PlatformInteropBrokerHelpers = ModuleHelpers;

how-to/workspace-platform-starter/templates/src/interop-override/interop-override.ts

@@ -2,10 +2,11 @@
 import type OpenFin from "@openfin/core";
 import type {
 	PlatformInteropOverride,
-	PlatformInteropOverrideOptions
+	PlatformInteropOverrideOptions,
+	PlatformInteropBrokerHelpers
 } from "workspace-platform-starter/shapes/interopbroker-shapes";
 import type { Logger, LoggerCreator } from "workspace-platform-starter/shapes/logger-shapes";
-import type { ModuleDefinition, ModuleHelpers } from "workspace-platform-starter/shapes/module-shapes";
+import type { ModuleDefinition } from "workspace-platform-starter/shapes/module-shapes";
 import type { ExampleInteropOverrideOptions } from "./shapes";
 
 /**
@@ -28,7 +29,7 @@ export class ExampleInteropOverride implements PlatformInteropOverride<ExampleIn
 	 * Helper methods for the module.
 	 * @internal
 	 */
-	private _helpers: ModuleHelpers | undefined;
+	private _helpers: PlatformInteropBrokerHelpers | undefined;
 
 	/**
 	 * Initialize the module.
@@ -40,7 +41,7 @@ export class ExampleInteropOverride implements PlatformInteropOverride<ExampleIn
 	public async initialize(
 		definition: ModuleDefinition<ExampleInteropOverrideOptions>,
 		loggerCreator: LoggerCreator,
-		helpers: ModuleHelpers
+		helpers: PlatformInteropBrokerHelpers
 	): Promise<void> {
 		this._definition = definition;
 		this._logger = loggerCreator("ExampleInteropOverride");