@openfin/core 30.73.27 → 30.74.6

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

@@ -6,7 +6,6 @@ const InteropClient_1 = require("../InteropClient");
 const utils_2 = require("./utils");
 const fdc3_1_2_1 = require("./fdc3-1.2");
 const PrivateChannelClient_1 = require("./PrivateChannelClient");
-const PrivateChannelProvider_1 = require("./PrivateChannelProvider");
 /**
  * @typedef { object } AppIdentifier
  * @summary Identifies an application, or instance of an application, and is used to target FDC3 API calls at specific applications.
@@ -181,7 +180,7 @@ class Fdc3Module2 extends base_1.Base {
      * Find all the available instances for a particular application.
      * @param { AppIdentifier } app
      * @returns { Promise<Array<AppIdentifier>> }
-     * @tutorial findInstances
+     * @tutorial fdc3v2.findInstances
      */
     async findInstances(app) {
         this.wire.sendAction('fdc3-find-instances').catch((e) => {
@@ -191,7 +190,7 @@ class Fdc3Module2 extends base_1.Base {
             return await InteropClient_1.InteropClient.ferryFdc3Call(this.fin.me.interop, 'fdc3FindInstances', app);
         }
         catch (error) {
-            const errorToThrow = error.message === utils_1.BROKER_ERRORS.fdc3FindInstances ? 'ResolverUnavailable' : error;
+            const errorToThrow = error.message === utils_1.BROKER_ERRORS.fdc3FindInstances ? 'ResolverUnavailable' : error.message;
             throw new Error(errorToThrow);
         }
     }
@@ -199,7 +198,7 @@ class Fdc3Module2 extends base_1.Base {
      * Retrieves the AppMetadata for an AppIdentifier, which provides additional metadata (such as icons, a title and description) from the App Directory record for the application, that may be used for display purposes.
      * @param { AppIdentifier } app
      * @returns { Promise<AppMetadata(2)> }
-     * @tutorial getAppMetadata
+     * @tutorial fdc3v2.getAppMetadata
      */
     async getAppMetadata(app) {
         this.wire.sendAction('fdc3-get-app-metadata').catch((e) => {
@@ -209,7 +208,7 @@ class Fdc3Module2 extends base_1.Base {
             return await InteropClient_1.InteropClient.ferryFdc3Call(this.fin.me.interop, 'fdc3GetAppMetadata', app);
         }
         catch (error) {
-            const errorToThrow = error.message === utils_1.BROKER_ERRORS.fdc3GetAppMetadata ? 'ResolverUnavailable' : error;
+            const errorToThrow = error.message === utils_1.BROKER_ERRORS.fdc3GetAppMetadata ? 'ResolverUnavailable' : error.message;
             throw new Error(errorToThrow);
         }
     }
@@ -268,7 +267,7 @@ class Fdc3Module2 extends base_1.Base {
             return await this.fin.me.interop.getInfoForIntent({ name: intent, context, metadata: { resultType } });
         }
         catch (error) {
-            const errorToThrow = error.message === utils_1.BROKER_ERRORS.getInfoForIntent ? 'ResolverUnavailable' : error;
+            const errorToThrow = error.message === utils_1.BROKER_ERRORS.getInfoForIntent ? 'ResolverUnavailable' : error.message;
             throw new Error(errorToThrow);
         }
     }
@@ -277,7 +276,7 @@ class Fdc3Module2 extends base_1.Base {
      * @param { Context } context
      * @param { string } [resultType] The type of result returned for any intent specified during resolution.
      * @returns { Promise<Array<AppIntent(2)>> }
-     * @tutorial findIntentsByContext
+     * @tutorial fdc3v2.findIntentsByContext
      */
     async findIntentsByContext(context, resultType) {
         this.wire.sendAction('fdc3-find-intents-by-context').catch((e) => {
@@ -288,7 +287,7 @@ class Fdc3Module2 extends base_1.Base {
             return await InteropClient_1.InteropClient.ferryFdc3Call(this.fin.me.interop, 'fdc3v2FindIntentsByContext', payload);
         }
         catch (error) {
-            const errorToThrow = error.message === utils_1.BROKER_ERRORS.getInfoForIntentsByContext ? 'ResolverUnavailable' : error;
+            const errorToThrow = error.message === utils_1.BROKER_ERRORS.getInfoForIntentsByContext ? 'ResolverUnavailable' : error.message;
             throw new Error(errorToThrow);
         }
     }
@@ -298,7 +297,7 @@ class Fdc3Module2 extends base_1.Base {
      * @param { Context } context Context associated with the Intent
      * @param { AppIdentifier | TargetApp } [app]
      * @returns { Promise<IntentResolution(2)> }
-     * @tutorial raiseIntent
+     * @tutorial fdc3v2.raiseIntent
      */
     async raiseIntent(intent, context, app) {
         this.wire.sendAction('fdc3-raise-intent').catch((e) => {
@@ -308,7 +307,7 @@ class Fdc3Module2 extends base_1.Base {
             return (0, utils_2.getIntentResolution)(this.fin.me.interop, context, app, intent);
         }
         catch (error) {
-            const errorToThrow = error.message === utils_1.BROKER_ERRORS.fireIntent ? 'ResolverUnavailable' : error;
+            const errorToThrow = error.message === utils_1.BROKER_ERRORS.fireIntent ? 'ResolverUnavailable' : error.message;
             throw new Error(errorToThrow);
         }
     }
@@ -317,7 +316,7 @@ class Fdc3Module2 extends base_1.Base {
      * @param { Context } context Context associated with the Intent
      * @param { AppIdentifier | TargetApp } [app]
      * @returns { Promise<IntentResolution(2)> }
-     * @tutorial raiseIntentForContext
+     * @tutorial fdc3v2.raiseIntentForContext
      */
     async raiseIntentForContext(context, app) {
         // TODO: We have to do the same thing we do for raiseIntent here as well.
@@ -328,7 +327,7 @@ class Fdc3Module2 extends base_1.Base {
             return (0, utils_2.getIntentResolution)(this.fin.me.interop, context, app);
         }
         catch (error) {
-            const errorToThrow = error.message === utils_1.BROKER_ERRORS.fireIntent ? 'ResolverUnavailable' : error;
+            const errorToThrow = error.message === utils_1.BROKER_ERRORS.fireIntent ? 'ResolverUnavailable' : error.message;
             throw new Error(errorToThrow);
         }
     }
@@ -349,27 +348,27 @@ class Fdc3Module2 extends base_1.Base {
         // The FDC3 Intenter handler only expects the context and contextMetadata to be passed to the handler,
         // so we wrap it here and only pass those paramaters.
         const contextHandler = async (raisedIntent) => {
+            let intentResult;
+            let intentResultToSend;
             const { context, metadata: intentMetadata } = raisedIntent;
             const { contextMetadata, metadata, ...rest } = context;
-            let intentResult;
+            const intentResolutionResultId = (intentMetadata === null || intentMetadata === void 0 ? void 0 : intentMetadata.intentResolutionResultId) || (metadata === null || metadata === void 0 ? void 0 : metadata.intentResolutionResultId);
             try {
                 const newContext = metadata ? { metadata, ...rest } : { ...rest };
                 intentResult = await handler(newContext, contextMetadata);
+                intentResultToSend = intentResult;
             }
             catch (error) {
                 intentResult = error;
+                intentResultToSend = { error: true };
             }
-            const intentResolutionResultId = (intentMetadata === null || intentMetadata === void 0 ? void 0 : intentMetadata.intentResolutionResultId) || (metadata === null || metadata === void 0 ? void 0 : metadata.intentResolutionResultId);
             if (intentResolutionResultId) {
-                // Send whatever the result is.
-                this.fin.InterApplicationBus.publish(intentResolutionResultId, intentResult);
+                this.fin.InterApplicationBus.publish(intentResolutionResultId, intentResultToSend);
             }
             if (intentResult instanceof Error) {
                 throw new Error(intentResult.message);
             }
-            else {
-                return intentResult;
-            }
+            return intentResult;
         };
         return this.fin.me.interop.registerIntentHandler(contextHandler, intent, { fdc3Version: '2.0' });
     }
@@ -385,12 +384,11 @@ class Fdc3Module2 extends base_1.Base {
     /**
      * 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.
      * @returns { Promise<PrivateChannel> }
-     * @tutorial createPrivateChannel
+     * @tutorial fdc3v2.createPrivateChannel
      */
     async createPrivateChannel() {
         const channelId = (0, utils_1.generateId)();
-        const channelProvider = await this.fin.InterApplicationBus.Channel.create(channelId);
-        const newPrivateChannelProvider = new PrivateChannelProvider_1.PrivateChannelProvider(channelProvider, channelId);
+        await InteropClient_1.InteropClient.ferryFdc3Call(this.fin.me.interop, 'createPrivateChannelProvider', { channelId });
         const channelClient = await this.fin.InterApplicationBus.Channel.connect(channelId);
         const newPrivateChannelClient = new PrivateChannelClient_1.PrivateChannelClient(channelClient, channelId);
         return (0, utils_2.buildPrivateChannelObject)(newPrivateChannelClient);
@@ -398,7 +396,7 @@ class Fdc3Module2 extends base_1.Base {
     /**
      * Retrieves a list of the User Channels available for the app to join.
      * @returns { Promise<Channel[]>}
-     * @tutorial getUserChannels
+     * @tutorial fdc3v2.getUserChannels
      */
     async getUserChannels() {
         const channels = await this.fin.me.interop.getContextGroups();
@@ -422,7 +420,7 @@ class Fdc3Module2 extends base_1.Base {
      * Join an app to a specified User channel.
      * @param { string } channelId Channel name
      * @returns { Promise<void> }
-     * @tutorial joinUserChannel
+     * @tutorial fdc3v2.joinUserChannel
      */
     async joinUserChannel(channelId) {
         return this.fdc3Module.joinChannel(channelId);
@@ -441,9 +439,18 @@ class Fdc3Module2 extends base_1.Base {
     /**
      * Returns the Channel object for the current User channel membership
      * @returns { Promise<FDC3.Channel | null> }
+     * @tutorial fdc3.getCurrentChannel
      */
     async getCurrentChannel() {
-        return this.fdc3Module.getCurrentChannel();
+        const currentChannel = await this.fdc3Module.getCurrentChannel();
+        if (!currentChannel) {
+            return null;
+        }
+        return {
+            ...currentChannel,
+            type: 'user',
+            broadcast: this.broadcast.bind(this)
+        };
     }
     /**
      * Removes the app from any User channel membership.
@@ -457,7 +464,7 @@ class Fdc3Module2 extends base_1.Base {
      * Retrieves information about the FDC3 implementation, including the supported version of the FDC3 specification, the name of the provider of the implementation, its own version number, details of whether optional API features are implemented and the metadata of the calling application according to the desktop agent.
      * fdc3HandleGetInfo must be overridden in the InteropBroker so that the ImplementationMetadata will have the appMetadata info.
      * @returns { Promise<ImplementationMetadata(2)> }
-     * @tutorial getInfo
+     * @tutorial fdc3v2.getInfo
      */
     async getInfo() {
         return InteropClient_1.InteropClient.ferryFdc3Call(this.fin.me.interop, 'fdc3v2GetInfo', { fdc3Version: '2.0' });

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

@@ -1,13 +1,12 @@
 import Fdc3Module from './fdc3-1.2';
 import Fdc3Module2 from './fdc3-2.0';
-import type Transport from '../../../transport/transport';
+import type { Transport } from '../../../transport/transport';
+import { Fdc3Version } from './versions';
 declare global {
     interface Window {
         fdc3: Fdc3Module | Fdc3Module2;
     }
 }
-declare type Fdc3Versions = '1.2' | '2.0';
-export declare const versionMap: Record<Fdc3Versions, typeof Fdc3Module | typeof Fdc3Module2>;
+export declare const versionMap: Record<Fdc3Version, typeof Fdc3Module | typeof Fdc3Module2>;
 export declare function registerFdc3Shim(version: string, transport: Transport): void;
-export declare function getFdc3(transport: Transport, version?: Fdc3Versions): Fdc3Module | Fdc3Module2;
-export {};
+export declare function getFdc3(transport: Transport, version?: Fdc3Version): Fdc3Module | Fdc3Module2;

package/src/api/interop/fdc3/overrideCheck.d.ts

@@ -0,0 +1,4 @@
+import * as OpenFin from '../../../OpenFin';
+import { Fdc3Version } from './versions';
+export declare function getDefaultViewFdc3VersionFromAppInfo({ manifest, initialOptions }: Awaited<ReturnType<OpenFin.Application['getInfo']>>): Fdc3Version | undefined;
+export declare function overrideCheck(overriddenBroker: OpenFin.InteropBroker, fdc3InteropApi?: Fdc3Version): void;

package/src/api/interop/fdc3/overrideCheck.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.overrideCheck = exports.getDefaultViewFdc3VersionFromAppInfo = void 0;
+const InteropBroker_1 = require("../InteropBroker");
+function getDefaultViewFdc3VersionFromAppInfo({ manifest, initialOptions }) {
+    var _a, _b, _c, _d;
+    const setVersion = (_c = (_b = (_a = manifest.platform) === null || _a === void 0 ? void 0 : _a.defaultViewOptions) === null || _b === void 0 ? void 0 : _b.fdc3InteropApi) !== null && _c !== void 0 ? _c : (_d = initialOptions.defaultViewOptions) === null || _d === void 0 ? void 0 : _d.fdc3InteropApi;
+    return ['1.2', '2.0'].includes(setVersion !== null && setVersion !== void 0 ? setVersion : '') ? setVersion : undefined;
+}
+exports.getDefaultViewFdc3VersionFromAppInfo = getDefaultViewFdc3VersionFromAppInfo;
+// TODO: Unit test this
+function overrideCheck(overriddenBroker, fdc3InteropApi) {
+    if (fdc3InteropApi && fdc3InteropApi === '2.0') {
+        const mustOverrideAPIs = [
+            'fdc3HandleFindInstances',
+            'handleInfoForIntent',
+            'handleInfoForIntentsByContext',
+            'fdc3HandleGetAppMetadata',
+            'fdc3HandleGetInfo',
+            'fdc3HandleOpen',
+            'handleFiredIntent',
+            'handleFiredIntentForContext'
+        ];
+        const notOverridden = mustOverrideAPIs.filter((api) => {
+            return overriddenBroker[api] === InteropBroker_1.InteropBroker.prototype[api];
+        });
+        if (notOverridden.length > 0) {
+            console.warn(`WARNING: FDC3 2.0 has been set as a default option for Views in this Platform, but the required InteropBroker APIs for FDC3 2.0 compliance have not all been overridden.\nThe following APIs need to be overridden:\n${notOverridden.join('\n')}`);
+        }
+    }
+}
+exports.overrideCheck = overrideCheck;

package/src/api/interop/fdc3/shapes/fdc3v2.d.ts

@@ -64,7 +64,7 @@ export interface DesktopAgent {
     addContextListener(contextType: string | null, handler: ContextHandler): Promise<Listener>;
     getUserChannels(): Promise<Array<SystemChannel>>;
     joinUserChannel(channelId: string): Promise<void>;
-    getOrCreateChannel(channelId: string): Promise<ChannelV1>;
+    getOrCreateChannel(channelId: string): Promise<Channel>;
     createPrivateChannel(): Promise<PrivateChannel>;
     getCurrentChannel(): Promise<ChannelV1 | null>;
     leaveCurrentChannel(): Promise<void>;

package/src/api/interop/fdc3/utils.d.ts

@@ -21,8 +21,25 @@ export declare enum ResultError {
      */
     IntentHandlerRejected = "IntentHandlerRejected"
 }
+export declare enum ChannelError {
+    /** Returned if the specified channel is not found when attempting to join a
+     *  channel via the `joinUserChannel` function of the DesktopAgent (`fdc3`).
+     */
+    NoChannelFound = "NoChannelFound",
+    /** SHOULD be returned when a request to join a user channel or to a retrieve
+     *  a Channel object via the `joinUserChannel` or `getOrCreateChannel` methods
+     *  of the DesktopAgent (`fdc3`) object is denied.
+     */
+    AccessDenied = "AccessDenied",
+    /** SHOULD be returned when a channel cannot be created or retrieved via the
+     *  `getOrCreateChannel` method of the DesktopAgent (`fdc3`).
+     */
+    CreationFailed = "CreationFailed"
+}
 export declare const buildPrivateChannelObject: (privateChannelClient: PrivateChannelClient) => PrivateChannel;
 export declare const buildAppChannelObject: (sessionContextGroup: OpenFin.SessionContextGroup) => Channel;
 export declare const connectPrivateChannel: (channelId: string) => Promise<PrivateChannel>;
+export declare const isContext: (context: unknown) => context is Context;
+export declare const isChannel: (channel: unknown) => channel is Channel;
 export declare const getIntentResolution: (interopModule: OpenFin.InteropClient, context: Context, app?: AppIdentifier | TargetApp, intent?: string) => Promise<IntentResolution>;
 export {};

package/src/api/interop/fdc3/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getIntentResolution = exports.connectPrivateChannel = exports.buildAppChannelObject = exports.buildPrivateChannelObject = exports.ResultError = exports.UnsupportedChannelApiError = exports.getUnsupportedChannelApis = void 0;
+exports.getIntentResolution = exports.isChannel = exports.isContext = exports.connectPrivateChannel = exports.buildAppChannelObject = exports.buildPrivateChannelObject = exports.ChannelError = exports.ResultError = exports.UnsupportedChannelApiError = exports.getUnsupportedChannelApis = void 0;
 const utils_1 = require("../utils");
 const PrivateChannelClient_1 = require("./PrivateChannelClient");
 const getUnsupportedChannelApis = (channelType) => {
@@ -35,6 +35,22 @@ var ResultError;
      */
     ResultError["IntentHandlerRejected"] = "IntentHandlerRejected";
 })(ResultError = exports.ResultError || (exports.ResultError = {}));
+var ChannelError;
+(function (ChannelError) {
+    /** Returned if the specified channel is not found when attempting to join a
+     *  channel via the `joinUserChannel` function of the DesktopAgent (`fdc3`).
+     */
+    ChannelError["NoChannelFound"] = "NoChannelFound";
+    /** SHOULD be returned when a request to join a user channel or to a retrieve
+     *  a Channel object via the `joinUserChannel` or `getOrCreateChannel` methods
+     *  of the DesktopAgent (`fdc3`) object is denied.
+     */
+    ChannelError["AccessDenied"] = "AccessDenied";
+    /** SHOULD be returned when a channel cannot be created or retrieved via the
+     *  `getOrCreateChannel` method of the DesktopAgent (`fdc3`).
+     */
+    ChannelError["CreationFailed"] = "CreationFailed";
+})(ChannelError = exports.ChannelError || (exports.ChannelError = {}));
 const buildPrivateChannelObject = (privateChannelClient) => {
     let clientDisconnected = false;
     const checkIfClientDisconnected = () => {
@@ -122,6 +138,22 @@ const connectPrivateChannel = async (channelId) => {
     }
 };
 exports.connectPrivateChannel = connectPrivateChannel;
+const isContext = (context) => {
+    if (context && typeof context === 'object' && 'type' in context) {
+        const { type } = context;
+        return typeof type === 'string';
+    }
+    return false;
+};
+exports.isContext = isContext;
+const isChannel = (channel) => {
+    if (channel && typeof channel === 'object' && 'type' in channel && 'id' in channel) {
+        const { type, id } = channel;
+        return (typeof type === 'string' && typeof id === 'string' && (type === 'app' || type === 'private'));
+    }
+    return false;
+};
+exports.isChannel = isChannel;
 const getIntentResolution = async (interopModule, context, app, intent) => {
     // 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,
@@ -138,31 +170,33 @@ const getIntentResolution = async (interopModule, context, app, intent) => {
     // Set up the getResult call.
     const getResult = async () => {
         let intentResult = await getResultPromise;
-        if (!intentResult) {
+        if (!intentResult || typeof intentResult !== 'object') {
             throw new Error(ResultError.NoResultReturned);
         }
-        if (intentResult instanceof Error) {
+        const { error } = intentResult;
+        if (error) {
             throw new Error(ResultError.IntentHandlerRejected);
         }
-        if (typeof intentResult === 'object') {
+        if ((0, exports.isChannel)(intentResult)) {
             const { id, type } = intentResult;
-            if (type && id && typeof id === 'string') {
-                switch (type) {
-                    case 'private': {
-                        intentResult = await (0, exports.connectPrivateChannel)(id);
-                        break;
-                    }
-                    case 'app': {
-                        const sessionContextGroup = await interopModule.joinSessionContextGroup(id);
-                        intentResult = (0, exports.buildAppChannelObject)(sessionContextGroup);
-                        break;
-                    }
-                    default: {
-                        break;
-                    }
+            switch (type) {
+                case 'private': {
+                    intentResult = await (0, exports.connectPrivateChannel)(id);
+                    break;
+                }
+                case 'app': {
+                    const sessionContextGroup = await interopModule.joinSessionContextGroup(id);
+                    intentResult = (0, exports.buildAppChannelObject)(sessionContextGroup);
+                    break;
+                }
+                default: {
+                    break;
                 }
             }
         }
+        else if (!(0, exports.isContext)(intentResult)) {
+            throw new Error(ResultError.NoResultReturned);
+        }
         return intentResult;
     };
     // Finally fire the intent.

package/src/api/interop/fdc3/versions.d.ts

@@ -0,0 +1 @@
+export declare type Fdc3Version = '1.2' | '2.0';

package/src/api/interop/fdc3/versions.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/api/me.d.ts

@@ -1,5 +1,5 @@
 import type * as OpenFin from '../OpenFin';
-import type Transport from '../transport/transport';
+import type { Transport } from '../transport/transport';
 import type { InteropClient } from './interop';
 export declare const environmentUnsupportedMessage = "You are not running in OpenFin.";
 declare type EntityType = OpenFin.EntityType;

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

@@ -1,20 +1,23 @@
 import type * as OpenFin from '../../OpenFin';
 import { Base } from '../base';
 import { Channel } from '../interappbus/channel/index';
-import Transport from '../../transport/transport';
+import { Transport } from '../../transport/transport';
 import { LayoutModule } from './layout/index';
 /**
+ * @PORTED
  * InitPlatformOptions interface
  * @typedef { object } InitPlatformOptions
  * @property { OverrideCallback } [overrideCallback] a callback function that can be used to extend or replace default Provider behavior.
  */
 /**
+ * @PORTED
  * @typedef { same | different } ProcessAffinityStrategy
  * @summary Strategy to place views that share a domain into different process affinities or the same process affinity.
  * @property { string } same views in the same domain will have the same process affinity.
  * @property { string } different views in the same domain will have different process affinities.
  */
 /**
+ * @PORTED
  * @typedef { object } PlatformOptions
  * @summary The options object required by {@link Platform#start Platform.start}
  * Any {@link ApplicationOptions Application option} is also a valid platform option
@@ -25,6 +28,7 @@ import { LayoutModule } from './layout/index';
  * @property {ProcessAffinityStrategy} [viewProcessAffinityStrategy] 'same' | 'different'.
  */
 /**
+ * @PORTED
  * @typedef { object } DefaultWindowOptions
  * @summary Default window options apply to all platform windows.
  * Any {@link Window~options Window option} is also a valid Default Window option
@@ -36,6 +40,7 @@ import { LayoutModule } from './layout/index';
  * Windows with a specified url (Custom Windows) will not be affected by this option.
  */
 /**
+ * @DELETED
  * Snapshot interface
  * @typedef { object } Snapshot
  * @property { WindowOption[] } windows The array of window options objects

package/src/api/platform/Factory.js

@@ -5,17 +5,20 @@ const base_1 = require("../base");
 const index_1 = require("./layout/index");
 const Instance_1 = require("./Instance");
 /**
+ * @PORTED
  * InitPlatformOptions interface
  * @typedef { object } InitPlatformOptions
  * @property { OverrideCallback } [overrideCallback] a callback function that can be used to extend or replace default Provider behavior.
  */
 /**
+ * @PORTED
  * @typedef { same | different } ProcessAffinityStrategy
  * @summary Strategy to place views that share a domain into different process affinities or the same process affinity.
  * @property { string } same views in the same domain will have the same process affinity.
  * @property { string } different views in the same domain will have different process affinities.
  */
 /**
+ * @PORTED
  * @typedef { object } PlatformOptions
  * @summary The options object required by {@link Platform#start Platform.start}
  * Any {@link ApplicationOptions Application option} is also a valid platform option
@@ -26,6 +29,7 @@ const Instance_1 = require("./Instance");
  * @property {ProcessAffinityStrategy} [viewProcessAffinityStrategy] 'same' | 'different'.
  */
 /**
+ * @PORTED
  * @typedef { object } DefaultWindowOptions
  * @summary Default window options apply to all platform windows.
  * Any {@link Window~options Window option} is also a valid Default Window option
@@ -37,6 +41,7 @@ const Instance_1 = require("./Instance");
  * Windows with a specified url (Custom Windows) will not be affected by this option.
  */
 /**
+ * @DELETED
  * Snapshot interface
  * @typedef { object } Snapshot
  * @property { WindowOption[] } windows The array of window options objects

package/src/api/platform/Instance.d.ts

@@ -27,7 +27,7 @@ export declare class Platform extends EmitterBase<OpenFin.PlatformEvent> {
      * @return { Promise<View> }
      * @tutorial Platform.createView
      */
-    createView(viewOptions: OpenFin.PlatformViewCreationOptions, target?: OpenFin.Identity, targetView?: OpenFin.Identity): Promise<View>;
+    createView(viewOptions: OpenFin.PlatformViewCreationOptions, target?: OpenFin.CreateViewTarget, targetView?: OpenFin.Identity): Promise<View>;
     /**
      * Creates a new Window.
      * @param { Window~options } options Window creation options
@@ -66,14 +66,16 @@ export declare class Platform extends EmitterBase<OpenFin.PlatformEvent> {
      */
     getSnapshot(): Promise<OpenFin.Snapshot>;
     /**
+     * **NOTE**: Internal use only. It is not recommended to manage the state of individual views.
+     *
      * Returns a snapshot of a single view's options in its current state.
      *
      * Can be used to restore a view to a previous state.
      *
-     * NOTE: this method is meant for advanced usage only, it is not recommended to manage the state of individual views.
-     *
      * @param { Identity } viewIdentity View identity
      * @returns { Promise<ViewState> }
+     * @internal
+     * @experimental
      * @tutorial Platform.getViewSnapshot
      */
     getViewSnapshot(viewIdentity: OpenFin.Identity): Promise<OpenFin.ViewState>;

package/src/api/platform/Instance.js

@@ -78,7 +78,7 @@ class Platform extends base_1.EmitterBase {
         const response = await client.dispatch('create-view', {
             target,
             opts: viewOptions,
-            targetView
+            targetView,
         });
         if (!response || (0, validate_1.validateIdentity)(response.identity)) {
             throw new Error(`When overwriting the createView call, please return an object that has a valid 'identity' property: ${JSON.stringify(response)}`);
@@ -175,14 +175,16 @@ class Platform extends base_1.EmitterBase {
         return client.dispatch('get-snapshot');
     }
     /**
+     * **NOTE**: Internal use only. It is not recommended to manage the state of individual views.
+     *
      * Returns a snapshot of a single view's options in its current state.
      *
      * Can be used to restore a view to a previous state.
      *
-     * NOTE: this method is meant for advanced usage only, it is not recommended to manage the state of individual views.
-     *
      * @param { Identity } viewIdentity View identity
      * @returns { Promise<ViewState> }
+     * @internal
+     * @experimental
      * @tutorial Platform.getViewSnapshot
      */
     async getViewSnapshot(viewIdentity) {

package/src/api/platform/layout/Factory.d.ts

@@ -3,12 +3,14 @@ import { Layout } from './Instance';
 import { Base } from '../../base';
 declare type InitLayoutOptions = OpenFin.InitLayoutOptions;
 /**
+ * @PORTED
  * InitLayoutOptions interface
  * @typedef { object } InitLayoutOptions
  * @property { string } [containerId] The id attribute of the container where the window's Layout should be initialized.  If not provided
  * then an element with id `layout-container` is used. We recommend using a div element.
  */
 /**
+ * @PORTED
  * PresetLayoutOptions interface
  * @typedef { object } PresetLayoutOptions
  * @property { LayoutPresetTypes } presetType Which preset layout arrangement to use.
@@ -23,6 +25,7 @@ declare type InitLayoutOptions = OpenFin.InitLayoutOptions;
  * @property { LayoutSettings } settings Configuration for certain Layout behaviors. See the LayoutSettings interface.
  */
 /**
+ * @PORTED
  * LayoutItem Interface
  * @typedef { object } LayoutItem Represents the arrangement of Views within a Platform window's Layout.  We do not recommend trying
  * to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot} or our
@@ -34,6 +37,7 @@ declare type InitLayoutOptions = OpenFin.InitLayoutOptions;
  * options of a given component.
  */
 /**
+ * @PORTED
  * LayoutSettings Interface
  * @typedef { object } LayoutSettings Represents a potential ways to customize behavior of your Layout
  * @property { boolean } [constrainDragToHeaders=false] Limits the area to which tabs can be dragged.

package/src/api/platform/layout/Factory.js

@@ -19,13 +19,19 @@ const Instance_1 = require("./Instance");
 const base_1 = require("../../base");
 const splitter_controller_1 = require("./controllers/splitter-controller");
 const view_overlay_1 = require("./utils/view-overlay");
+const api_exposer_1 = require("../../api-exposer");
+const layout_entities_controller_1 = require("./controllers/layout-entities-controller");
+const layout_constants_1 = require("./layout.constants");
+const layout_content_cache_1 = require("./controllers/layout-content-cache");
 /**
+ * @PORTED
  * InitLayoutOptions interface
  * @typedef { object } InitLayoutOptions
  * @property { string } [containerId] The id attribute of the container where the window's Layout should be initialized.  If not provided
  * then an element with id `layout-container` is used. We recommend using a div element.
  */
 /**
+ * @PORTED
  * PresetLayoutOptions interface
  * @typedef { object } PresetLayoutOptions
  * @property { LayoutPresetTypes } presetType Which preset layout arrangement to use.
@@ -40,6 +46,7 @@ const view_overlay_1 = require("./utils/view-overlay");
  * @property { LayoutSettings } settings Configuration for certain Layout behaviors. See the LayoutSettings interface.
  */
 /**
+ * @PORTED
  * LayoutItem Interface
  * @typedef { object } LayoutItem Represents the arrangement of Views within a Platform window's Layout.  We do not recommend trying
  * to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot} or our
@@ -51,6 +58,7 @@ const view_overlay_1 = require("./utils/view-overlay");
  * options of a given component.
  */
 /**
+ * @PORTED
  * LayoutSettings Interface
  * @typedef { object } LayoutSettings Represents a potential ways to customize behavior of your Layout
  * @property { boolean } [constrainDragToHeaders=false] Limits the area to which tabs can be dragged.
@@ -109,9 +117,9 @@ class LayoutModule extends base_1.Base {
             const viewOverlay = new view_overlay_1.ViewOverlay(this.wire);
             const splitterController = new splitter_controller_1.SplitterController(viewOverlay);
             const tabDragController = new tab_drag_controller_1.TabDragController(viewOverlay);
-            __classPrivateFieldSet(this, _LayoutModule_layoutManager, new ManagerConstructor(splitterController, tabDragController), "f");
-            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-            // @ts-ignore - layout warning here for backwards compatibility, can remove layout check in .52
+            const contentItemCache = new layout_content_cache_1.LayoutContentCache();
+            __classPrivateFieldSet(this, _LayoutModule_layoutManager, new ManagerConstructor(splitterController, tabDragController, contentItemCache), "f");
+            // @ts-expect-error - layout warning here for backwards compatibility, can remove layout check in .52
             let { layout, containerId } = options;
             if (layout) {
                 console.warn(`We recommend using a layout in window options.
@@ -125,6 +133,10 @@ class LayoutModule extends base_1.Base {
             // pull createChannelConnection out of LayoutManager and setup channel connections here using layoutmanager instance methods?
             await __classPrivateFieldGet(this, _LayoutModule_layoutManager, "f").initManager();
             await __classPrivateFieldGet(this, _LayoutModule_layoutManager, "f").createLayout(layout, container);
+            const { client, ofWindow } = ManagerConstructor.getClientAndWindow(__classPrivateFieldGet(this, _LayoutModule_layoutManager, "f"));
+            // expose LayoutEntitiesController instance for API consumption
+            const channelStrategy = new api_exposer_1.ChannelsExposer(client);
+            await new api_exposer_1.ApiExposer(channelStrategy).exposeInstance(new layout_entities_controller_1.LayoutEntitiesController(__classPrivateFieldGet(this, _LayoutModule_layoutManager, "f"), contentItemCache), { id: layout_constants_1.LAYOUT_CONTROLLER_ID });
             // Adding this to the returned instance undocumented/typed for Browser.
             return Object.assign(this.getCurrentSync(), { layoutManager: __classPrivateFieldGet(this, _LayoutModule_layoutManager, "f") });
         };