@openfin/core 30.73.22 → 30.73.24

package/src/api/interop/InteropClient.js

@@ -17,12 +17,14 @@ const base_1 = require("../base");
 const SessionContextGroupClient_1 = require("./SessionContextGroupClient");
 const utils_1 = require("./utils");
 /**
+ * @PORTED
  * @typedef { object } Intent
  * @summary The combination of an action and a context that is passed to an application for resolution.
  * @property { string } name Name of the intent.
  * @property { Context } context Data associated with the intent
  */
 /**
+ * @REMOVED
  * @typedef { object } Subscription
  * @summary Object returned when subscribing a handler.
  * @property { function } unsubscribe Function to unsubscribe the handler.
@@ -36,6 +38,7 @@ const utils_1 = require("./utils");
  * @summary Subscription function for registerIntentHandler
  */
 /**
+ * @PORTED
  * @typedef { object } ClientIdentity
  * @summary The Identity for a Channel Client. Includes endpointId to differentiate between different connections for an entity.
  * @property {string} uuid GUID of an application.
@@ -43,12 +46,14 @@ const utils_1 = require("./utils");
  * @property {string} endpointId Unique differentiator for different Channel connections for an entity.
  */
 /**
+ * @PORTED
  * @typedef { object } ContextGroupInfo
  * @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.
  */
 /**
+ * @PORTED
  * @typedef { object } DisplayMetadata
  * @summary The display data for a Context Group.
  * @property {string} name A user-readable name for this context group, e.g: `"Red"`
@@ -56,6 +61,7 @@ const utils_1 = require("./utils");
  * @property {string} [glyph] A URL of an image that can be used to display this context group
  */
 /**
+ * @PORTED
  * @typedef { object } Context
  * @summary Data passed between entities and applications.
  * @property {object} [id] An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
@@ -63,6 +69,7 @@ const utils_1 = require("./utils");
  * @property {string} type Conserved type for the context (e.g. `instrument` or `country`)
  */
 /**
+ * @REMOVED
  * @typedef { object } ContextForIntent
  * @summary Data passed between entities and applications, including an optional metadata.
  * @property {object} [id] An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
@@ -71,6 +78,7 @@ const utils_1 = require("./utils");
  * @property {any} [metadata]
  */
 /**
+ * @REMOVED
  * @typedef { object } SessionContextGroup
  * @summary An instance of a SessionContextGroup
  * @property {string} id The SessionContextGroup's id.
@@ -98,7 +106,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 +313,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 +327,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 +354,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 +367,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 +380,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 +394,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 +409,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 {

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

@@ -1,4 +1,4 @@
-import * as OpenFin from '../../OpenFin';
+import type * as OpenFin from '../../OpenFin';
 import type { ChannelProvider } from '../interappbus/channel/provider';
 export default class SessionContextGroupBroker {
     id: string;

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

@@ -1,4 +1,4 @@
-import * as OpenFin from '../../OpenFin';
+import type * as OpenFin from '../../OpenFin';
 import Transport from '../../transport/transport';
 import { Base } from '../base';
 export default class SessionContextGroupClient extends Base {

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

@@ -1,4 +1,4 @@
-import * as OpenFin from '../../../OpenFin';
+import type * as OpenFin from '../../../OpenFin';
 import type { Listener, Context, ContextHandler } from './shapes/fdc3v2';
 declare type HandlerId = string;
 export declare class PrivateChannelClient {

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

@@ -1,4 +1,4 @@
-import * as OpenFin from '../../../OpenFin';
+import type * as OpenFin from '../../../OpenFin';
 import { ChannelProvider } from '../../interappbus/channel/provider';
 declare type HandlerId = string;
 export declare class PrivateChannelProvider {

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

@@ -1,4 +1,4 @@
-import * as FDC3v1 from './shapes/fdc3v1';
+import type * as FDC3v1 from './shapes/fdc3v1';
 import { Base } from '../../base';
 /**
  * @typedef { object } Listener

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

@@ -130,7 +130,7 @@ class Fdc3Module extends base_1.Base {
         this.wire.sendAction('fdc3-broadcast').catch((e) => {
             // we do not want to expose this error, just continue if this analytics-only call fails
         });
-        this.fin.me.interop.setContext(context);
+        return this.fin.me.interop.setContext(context);
     }
     /**
      * Returns the Interop-Broker-defined context groups available for an entity to join.
@@ -165,7 +165,7 @@ class Fdc3Module extends base_1.Base {
             // we do not want to expose this error, just continue if this analytics-only call fails
         });
         try {
-            await this.fin.me.interop.joinContextGroup(channelId);
+            return await this.fin.me.interop.joinContextGroup(channelId);
         }
         catch (error) {
             if (error.message === utils_2.BROKER_ERRORS.joinSessionContextGroupWithJoinContextGroup) {
@@ -187,7 +187,7 @@ class Fdc3Module extends base_1.Base {
         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
         });
-        this.fin.me.interop.removeFromContextGroup();
+        return this.fin.me.interop.removeFromContextGroup();
     }
     /**
      * Adds a listener for incoming Intents.
@@ -232,7 +232,7 @@ class Fdc3Module extends base_1.Base {
             return await this.fin.me.interop.fireIntent(intentObj);
         }
         catch (error) {
-            const errorToThrow = error.message === utils_2.BROKER_ERRORS.fireIntent ? 'ResolverUnavailable' : error;
+            const errorToThrow = error.message === utils_2.BROKER_ERRORS.fireIntent ? 'ResolverUnavailable' : error.message;
             throw new Error(errorToThrow);
         }
     }
@@ -266,7 +266,7 @@ class Fdc3Module extends base_1.Base {
             return await this.fin.me.interop.getInfoForIntent({ name: intent, context });
         }
         catch (error) {
-            const errorToThrow = error.message === utils_2.BROKER_ERRORS.getInfoForIntent ? 'ResolverUnavailable' : error;
+            const errorToThrow = error.message === utils_2.BROKER_ERRORS.getInfoForIntent ? 'ResolverUnavailable' : error.message;
             throw new Error(errorToThrow);
         }
     }
@@ -284,7 +284,7 @@ class Fdc3Module extends base_1.Base {
             return await this.fin.me.interop.getInfoForIntentsByContext(context);
         }
         catch (error) {
-            const errorToThrow = error.message === utils_2.BROKER_ERRORS.getInfoForIntentsByContext ? 'ResolverUnavailable' : error;
+            const errorToThrow = error.message === utils_2.BROKER_ERRORS.getInfoForIntentsByContext ? 'ResolverUnavailable' : error.message;
             throw new Error(errorToThrow);
         }
     }
@@ -303,7 +303,7 @@ class Fdc3Module extends base_1.Base {
             return await this.fin.me.interop.fireIntentForContext({ ...context, metadata: { target: app } });
         }
         catch (error) {
-            const errorToThrow = error.message === utils_2.BROKER_ERRORS.fireIntentForContext ? 'ResolverUnavailable' : error;
+            const errorToThrow = error.message === utils_2.BROKER_ERRORS.fireIntentForContext ? 'ResolverUnavailable' : error.message;
             throw new Error(errorToThrow);
         }
     }
@@ -354,7 +354,7 @@ class Fdc3Module extends base_1.Base {
             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;
+            const errorToThrow = error.message === utils_2.BROKER_ERRORS.fdc3Open ? 'ResolverUnavailable' : error.message;
             throw new Error(errorToThrow);
         }
     }

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

@@ -1,5 +1,5 @@
-import * as FDC3v1 from './shapes/fdc3v1';
-import * as FDC3v2 from './shapes/fdc3v2';
+import type * as FDC3v1 from './shapes/fdc3v1';
+import type * as FDC3v2 from './shapes/fdc3v2';
 import { Base } from '../../base';
 import Transport from '../../../transport/transport';
 /**
@@ -283,7 +283,7 @@ export default class Fdc3Module2 extends Base implements FDC3v2.DesktopAgent {
      * Returns the Channel object for the current User channel membership
      * @returns { Promise<FDC3.Channel | null> }
      */
-    getCurrentChannel(): Promise<FDC3v1.Channel | null>;
+    getCurrentChannel(): Promise<FDC3v2.Channel | null>;
     /**
      * Removes the app from any User channel membership.
      * @returns { Promise<void> }

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

@@ -191,7 +191,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);
         }
     }
@@ -209,7 +209,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 +268,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);
         }
     }
@@ -288,7 +288,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);
         }
     }
@@ -308,7 +308,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);
         }
     }
@@ -328,7 +328,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);
         }
     }
@@ -443,7 +443,15 @@ class Fdc3Module2 extends base_1.Base {
      * @returns { Promise<FDC3.Channel | null> }
      */
     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.

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 { 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/utils.d.ts

@@ -1,6 +1,6 @@
-import { TargetApp } from './shapes/fdc3v1';
-import { AppIdentifier, IntentResolution, Channel, PrivateChannel, Context } from './shapes/fdc3v2';
-import * as OpenFin from '../../../OpenFin';
+import type { TargetApp } from './shapes/fdc3v1';
+import type { AppIdentifier, IntentResolution, Channel, PrivateChannel, Context } from './shapes/fdc3v2';
+import type * as OpenFin from '../../../OpenFin';
 import { PrivateChannelClient } from './PrivateChannelClient';
 interface UnsupportedChannelApis {
     addContextListener(): Error;

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/interop/utils.d.ts

@@ -1,4 +1,4 @@
-import * as OpenFin from '../../OpenFin';
+import type * as OpenFin from '../../OpenFin';
 export declare const generateId: () => string;
 export declare const wrapInTryCatch: <T>(f: (...args: any[]) => T, prefix?: string) => (...args: any[]) => T;
 export declare const wrapContextHandler: (handler: OpenFin.ContextHandler, handlerId: string) => (context: OpenFin.Context) => Promise<void>;

package/src/api/me.d.ts

@@ -1,8 +1,8 @@
-import * as OpenFin from '../OpenFin';
+import type * as OpenFin from '../OpenFin';
 import type Transport from '../transport/transport';
 import type { InteropClient } from './interop';
 export declare const environmentUnsupportedMessage = "You are not running in OpenFin.";
-import EntityType = OpenFin.EntityType;
+declare type EntityType = OpenFin.EntityType;
 export declare type EntityTypeHelpers<T extends EntityType> = T extends 'view' ? {
     isView: true;
     isWindow: false;
@@ -37,3 +37,4 @@ export declare type Me<MeType extends EntityType> = OpenFin.EntityInfo & (MeType
     isOpenFin: boolean;
 };
 export declare function getMe<MeType extends EntityType>(wire: Transport<MeType>): Me<MeType>;
+export {};

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

@@ -1,20 +1,23 @@
-import * as OpenFin from '../../OpenFin';
+import type * as OpenFin from '../../OpenFin';
 import { Base } from '../base';
 import { Channel } from '../interappbus/channel/index';
 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
@@ -145,6 +150,8 @@ class PlatformModule extends base_1.Base {
                 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
                 // @ts-ignore using private variable.
                 const app = await this.fin.Application._create({ ...platformOptions, isPlatformController: true });
+                // TODO: fix typing (internal)
+                // @ts-expect-error
                 app.once('platform-api-ready', () => resolve(this.wrapSync({ uuid })));
                 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
                 // @ts-ignore using private variable.
@@ -174,6 +181,8 @@ class PlatformModule extends base_1.Base {
                 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
                 // @ts-ignore using private variable.
                 const app = await this.fin.Application._createFromManifest(manifestUrl);
+                // TODO: fix typing (internal)
+                // @ts-expect-error
                 app.once('platform-api-ready', () => resolve(this.wrapSync({ uuid: app.identity.uuid })));
                 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
                 // @ts-ignore using private method without warning.

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

@@ -1,17 +1,17 @@
-import * as OpenFin from '../../OpenFin';
+import type * as OpenFin from '../../OpenFin';
 import { View } from '../view';
 import { EmitterBase } from '../base';
 import { Channel } from '../interappbus/channel/index';
 import ChannelClient from '../interappbus/channel/client';
 import { LayoutModule } from './layout';
-declare type PlatformEvents = OpenFin.PlatformEvents;
 /** Manages the life cycle of windows and views in the application.
  *
- * Enables taking snapshots of itself and applying them to restore a previous configuration
+ * Enables taking snapshots of itself and applyi
+ * ng them to restore a previous configuration
  * as well as listen to <a href="tutorial-Platform.EventEmitter.html">platform events</a>.
  * @namespace
  */
-export declare class Platform extends EmitterBase<PlatformEvents> {
+export declare class Platform extends EmitterBase<OpenFin.PlatformEvent> {
     #private;
     Layout: LayoutModule;
     private _channel;
@@ -66,14 +66,16 @@ export declare class Platform extends EmitterBase<PlatformEvents> {
      */
     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>;
@@ -145,4 +147,3 @@ export declare class Platform extends EmitterBase<PlatformEvents> {
         skipBeforeUnload: boolean;
     }): Promise<void>;
 }
-export {};

package/src/api/platform/Instance.js

@@ -13,7 +13,8 @@ const validate_1 = require("../../util/validate");
 const clientMap = new Map();
 /** Manages the life cycle of windows and views in the application.
  *
- * Enables taking snapshots of itself and applying them to restore a previous configuration
+ * Enables taking snapshots of itself and applyi
+ * ng them to restore a previous configuration
  * as well as listen to <a href="tutorial-Platform.EventEmitter.html">platform events</a>.
  * @namespace
  */
@@ -174,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/common-utils.d.ts

@@ -1,5 +1,5 @@
-import * as OpenFin from '../../OpenFin';
-import LayoutPresetType = OpenFin.LayoutPresetType;
+import type * as OpenFin from '../../OpenFin';
+declare type LayoutPresetType = OpenFin.LayoutPresetType;
 export declare function isValidPresetType(type: LayoutPresetType): type is LayoutPresetType;
 declare const _default: {
     isValidPresetType: typeof isValidPresetType;

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

@@ -1,14 +1,16 @@
-import * as OpenFin from '../../../OpenFin';
+import type * as OpenFin from '../../../OpenFin';
 import { Layout } from './Instance';
 import { Base } from '../../base';
-import InitLayoutOptions = OpenFin.InitLayoutOptions;
+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 @@ import 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 @@ import 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.
@@ -107,3 +111,4 @@ export declare class LayoutModule extends Base {
      */
     init: (options?: InitLayoutOptions) => Promise<OpenFin.Layout>;
 }
+export {};