@openfin/core 31.74.30 → 31.75.1

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

@@ -4,6 +4,7 @@ const base_1 = require("../../base");
 const utils_1 = require("./utils");
 const utils_2 = require("../utils");
 const InteropClient_1 = require("../InteropClient");
+const lodash_1 = require("lodash");
 /**
  * @typedef { object } Listener
  * @summary Listener object returned by addContextListener and addIntentListener
@@ -393,7 +394,39 @@ class Fdc3Module extends base_1.Base {
         return {
             ...currentContextGroupInfo,
             type: 'system',
-            addContextListener: this.addContextListener.bind(this),
+            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 this.fin.me.interop.getCurrentContext(realType);
+                    const wrappedHandler = (context, contextMetadata) => {
+                        if (first) {
+                            first = false;
+                            if ((0, lodash_1.isEqual)(currentContext, context)) {
+                                return;
+                            }
+                        }
+                        // eslint-disable-next-line consistent-return
+                        return realHandler(context, contextMetadata);
+                    };
+                    return this.fin.me.interop.addContextHandler(wrappedHandler, realType);
+                })();
+                return {
+                    ...listener,
+                    unsubscribe: () => listener.then((l) => l.unsubscribe())
+                };
+            },
             broadcast: this.broadcast.bind(this),
             getCurrentContext: async (contextType) => {
                 const context = await this.fin.me.interop.getCurrentContext(contextType);

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

@@ -3,6 +3,7 @@ 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;
 const utils_1 = require("../utils");
 const PrivateChannelClient_1 = require("./PrivateChannelClient");
+const lodash_1 = require("lodash");
 const getUnsupportedChannelApis = (channelType) => {
     return {
         addContextListener: () => {
@@ -111,14 +112,33 @@ const buildAppChannelObject = (sessionContextGroup) => {
             return context === undefined ? null : context;
         },
         addContextListener: (contextType, handler) => {
-            let listener;
+            let realHandler;
+            let realType;
             if (typeof contextType === 'function') {
                 console.warn('addContextListener(handler) has been deprecated. Please use addContextListener(null, handler)');
-                listener = sessionContextGroup.addContextHandler(contextType);
+                realHandler = contextType;
             }
             else {
-                listener = sessionContextGroup.addContextHandler(handler, contextType === null ? undefined : contextType);
+                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, lodash_1.isEqual)(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())
@@ -149,7 +169,7 @@ 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 typeof type === 'string' && typeof id === 'string' && (type === 'app' || type === 'private');
     }
     return false;
 };

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

@@ -1,8 +1,8 @@
 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';
+type Channel = OpenFin.Fin['InterApplicationBus']['Channel'];
 /**
  * @PORTED
  * InitPlatformOptions interface
@@ -113,3 +113,4 @@ export default class PlatformModule extends Base {
      */
     startFromManifest(manifestUrl: string, opts?: OpenFin.RvmLaunchOptions): Promise<OpenFin.Platform>;
 }
+export {};

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

@@ -1,9 +1,9 @@
 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';
+type View = OpenFin.View;
+type Channel = OpenFin.Fin['InterApplicationBus']['Channel'];
+type ChannelClient = OpenFin.ChannelClient;
+type LayoutModule = OpenFin.Fin['Platform']['Layout'];
 /** Manages the life cycle of windows and views in the application.
  *
  * Enables taking snapshots of itself and applyi
@@ -147,3 +147,4 @@ export declare class Platform extends EmitterBase<OpenFin.PlatformEvent> {
         skipBeforeUnload: boolean;
     }): Promise<void>;
 }
+export {};

package/src/api/platform/Instance.js

@@ -7,6 +7,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var _Platform_connectToProvider;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Platform = void 0;
+/* eslint-disable import/prefer-default-export, no-undef */
 const base_1 = require("../base");
 const validate_1 = require("../../util/validate");
 // Reuse clients to avoid overwriting already-registered client in provider
@@ -78,7 +79,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)}`);

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

@@ -10,7 +10,7 @@ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
     return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
 };
-var _LayoutModule_layoutManager;
+var _LayoutModule_layoutManager, _LayoutModule_layoutInitializationAttempted;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LayoutModule = void 0;
 /* eslint-disable no-undef, import/prefer-default-export */
@@ -91,6 +91,7 @@ class LayoutModule extends base_1.Base {
     constructor() {
         super(...arguments);
         _LayoutModule_layoutManager.set(this, void 0);
+        _LayoutModule_layoutInitializationAttempted.set(this, false);
         /**
          * Initialize the window's Layout.  Must be called from a custom window that has a 'layout' option set upon creation of that window.
          * If a containerId is not provided, this method attempts to find an element with the id `layout-container`.
@@ -109,9 +110,10 @@ class LayoutModule extends base_1.Base {
             if (!this.fin.me.isWindow) {
                 throw new Error('Layout.init can only be called from a Window context.');
             }
-            else if (__classPrivateFieldGet(this, _LayoutModule_layoutManager, "f")) {
+            else if (__classPrivateFieldGet(this, _LayoutModule_layoutInitializationAttempted, "f")) {
                 throw new Error('Layout for this window already initialized, please use Layout.replace call to replace the layout.');
             }
+            __classPrivateFieldSet(this, _LayoutModule_layoutInitializationAttempted, true, "f");
             // We need to go through environment to make sure it is only imported/bundled in OpenFin.
             const ManagerConstructor = await this.wire.environment.getManagerConstructor();
             const viewOverlay = new view_overlay_1.ViewOverlay(this.wire);
@@ -136,7 +138,7 @@ class LayoutModule extends base_1.Base {
             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"), ofWindow.identity.uuid, contentItemCache), { id: layout_constants_1.LAYOUT_CONTROLLER_ID });
+            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") });
         };
@@ -203,4 +205,4 @@ class LayoutModule extends base_1.Base {
     }
 }
 exports.LayoutModule = LayoutModule;
-_LayoutModule_layoutManager = new WeakMap();
+_LayoutModule_layoutManager = new WeakMap(), _LayoutModule_layoutInitializationAttempted = new WeakMap();

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

@@ -114,6 +114,9 @@ class Layout extends base_1.Base {
      * @return {Promise<TabStack | ColumnOrRow>}
      */
     async getRootItem() {
+        this.wire.sendAction('layout-get-root-item').catch(() => {
+            // don't expose
+        });
         const client = await __classPrivateFieldGet(this, _Layout_layoutClient, "f").getValue();
         const root = await client.getRoot();
         return layout_entities_1.LayoutNode.getEntity(root, client);

package/src/api/platform/layout/controllers/layout-entities-controller.d.ts

@@ -8,9 +8,10 @@ type ViewCreationOrReference = OpenFin.Identity | OpenFin.PlatformViewCreationOp
  */
 export declare class LayoutEntitiesController {
     private layoutManager;
-    private uuid;
     private layoutContentCache;
-    constructor(layoutManager: any, uuid: string, layoutContentCache: LayoutContentCache);
+    private wire;
+    constructor(layoutManager: any, layoutContentCache: LayoutContentCache);
+    private analytics;
     /**
      * @internal
      * @returns the root contentItem of the layout.
@@ -87,6 +88,7 @@ export declare class LayoutEntitiesController {
      * @throws If the view does not exist, fails to create, or the stack does not exist.
      */
     addViewToStack: (stackEntityId: string, viewCreationOrReference: ViewCreationOrReference, { index }?: OpenFin.AddViewToStackOptions) => Promise<OpenFin.Identity>;
+    private findViewInStack;
     /**
      * @internal
      * Removes a view from the given stack. If it's the only view, the stack will be destroyed, unless window creation
@@ -102,15 +104,16 @@ export declare class LayoutEntitiesController {
      * Creates a new adjacent 'stack' and adds the views to it at the specified position
      * @param targetId Entity id of the content item to add a stack adjacent to it
      * @param views List of identities or view creation options of the views to include in the stack
-     * @param options Creation options, defaults to position: 'right'
+     * @param options Creation options, defaults to { position: 'right' }
      * @returns the Entity Id of the new stack
      */
-    createAdjacentStack: (targetId: string, views: ViewCreationOrReference[], options: {
+    createAdjacentStack: (targetId: string, views: ViewCreationOrReference[], { position }?: {
         position?: OpenFin.LayoutPosition;
     }) => Promise<string>;
     getAdjacentStacks: ({ targetId, edge }: {
         targetId: string;
         edge: OpenFin.LayoutPosition;
     }) => Promise<Pick<OpenFin.LayoutEntityDefinition, 'entityId'>[]>;
+    setStackActiveView: (stackEntityId: string, viewIdentity: OpenFin.Identity) => Promise<void>;
 }
 export {};

package/src/api/platform/layout/controllers/layout-entities-controller.js

@@ -17,15 +17,20 @@ const layout_traversal_1 = require("../utils/layout-traversal");
 class LayoutEntitiesController {
     constructor(
     // workaround to prevent importing entire GoldenLayouts, also re-written at build time to type any
-    layoutManager, uuid, layoutContentCache) {
+    layoutManager, layoutContentCache) {
         this.layoutManager = layoutManager;
-        this.uuid = uuid;
         this.layoutContentCache = layoutContentCache;
+        this.analytics = (topic) => {
+            this.wire.sendAction(`layout-controller-${topic}`).catch(() => {
+                // don't expose
+            });
+        };
         /**
          * @internal
          * @returns the root contentItem of the layout.
          */
         this.getRoot = () => {
+            this.analytics('get-root');
             const root = this.layoutManager.layout.root.contentItems[0];
             return {
                 // TODO: fix typing
@@ -42,6 +47,7 @@ class LayoutEntitiesController {
          */
         this.getStackByView = async (view) => {
             var _a, _b, _c, _d;
+            this.analytics('get-stack-by-view');
             const viewComponent = this.layoutManager.getViewComponent(view);
             if (!viewComponent || ((_b = (_a = viewComponent.container) === null || _a === void 0 ? void 0 : _a.parent) === null || _b === void 0 ? void 0 : _b.parent.type) !== 'stack') {
                 return undefined;
@@ -64,12 +70,13 @@ class LayoutEntitiesController {
          * @throws if the content item associated with the entity id does not exist or is not a stack.
          */
         this.getStackViews = (id) => {
+            this.analytics('get-stack-views');
             const stack = this.layoutContentCache.getContentItemOrThrow(id, ['stack']);
             const views = stack.contentItems.map((ci) => {
                 var _a;
                 return ({
                     name: (_a = ci.config.componentState) === null || _a === void 0 ? void 0 : _a.name,
-                    uuid: this.uuid
+                    uuid: this.layoutManager.ofWindow.identity.uuid
                 });
             });
             return views;
@@ -81,6 +88,7 @@ class LayoutEntitiesController {
          */
         this.isRoot = (id) => {
             var _a;
+            this.analytics('is-root');
             const ci = this.layoutContentCache.getContentItemOrThrow(id);
             return !!((_a = ci.parent) === null || _a === void 0 ? void 0 : _a.isRoot);
         };
@@ -91,6 +99,7 @@ class LayoutEntitiesController {
          * @returns True if the content item exists and belongs to the layout.
          */
         this.exists = (entityId) => {
+            this.analytics('exists');
             return this.layoutContentCache.hasKey(entityId);
         };
         /**
@@ -110,6 +119,7 @@ class LayoutEntitiesController {
          * @throws If the view does not exist, fails to create, or the stack does not exist.
          */
         this.addViewToStack = async (stackEntityId, viewCreationOrReference, { index } = { index: 0 }) => {
+            this.analytics('add-view-to-stack');
             const currentStack = this.layoutContentCache.getContentItemOrThrow(stackEntityId);
             if (index && index > currentStack.contentItems.length + 1) {
                 throw new Error(`Index '${index}' out of range, please exclude the index or specify a number between 0 and ${currentStack.contentItems.length}`);
@@ -124,6 +134,9 @@ class LayoutEntitiesController {
             });
             return identity;
         };
+        this.findViewInStack = (stack, viewIdentity) => {
+            return stack.contentItems.find((ci) => { var _a, _b; return ((_b = (_a = ci.config) === null || _a === void 0 ? void 0 : _a.componentState) === null || _b === void 0 ? void 0 : _b.name) === viewIdentity.name; });
+        };
         /**
          * @internal
          * Removes a view from the given stack. If it's the only view, the stack will be destroyed, unless window creation
@@ -134,9 +147,11 @@ class LayoutEntitiesController {
          * @throws If the stack does not exist or the view does not exist or belong to the stack.
          */
         this.removeViewFromStack = async (stackEntityId, view) => {
-            const views = this.getStackViews(stackEntityId);
-            if (!views.find((existingView) => existingView.name === view.name)) {
-                throw new Error(`Tried to remove a view ('${view.name}') which does not exist in the stack.`);
+            this.analytics('remove-view-from-stack');
+            const stack = this.layoutContentCache.getContentItemOrThrow(stackEntityId, ['stack']);
+            const viewInstance = this.findViewInStack(stack, view);
+            if (!viewInstance) {
+                throw new Error(`Tried to remove a view ('${view.name}') which does not belong to the stack.`);
             }
             await this.layoutManager.platform.closeView(view);
         };
@@ -145,14 +160,14 @@ class LayoutEntitiesController {
          * Creates a new adjacent 'stack' and adds the views to it at the specified position
          * @param targetId Entity id of the content item to add a stack adjacent to it
          * @param views List of identities or view creation options of the views to include in the stack
-         * @param options Creation options, defaults to position: 'right'
+         * @param options Creation options, defaults to { position: 'right' }
          * @returns the Entity Id of the new stack
          */
-        this.createAdjacentStack = async (targetId, views, options) => {
-            if (views.length === 0) {
-                throw new Error('Cannot create stack with empty view array.');
+        this.createAdjacentStack = async (targetId, views, { position = 'right' } = {}) => {
+            this.analytics('create-adjacent-stack');
+            if (!Array.isArray(views) || views.length === 0) {
+                throw new Error('The parameter "views" must be an array with at least 1 element.');
             }
-            const { position = 'right' } = options;
             if (!['top', 'bottom', 'left', 'right'].includes(position)) {
                 throw new Error(`Invalid position '${position}' specified.`);
             }
@@ -177,12 +192,23 @@ class LayoutEntitiesController {
             return entityId;
         };
         this.getAdjacentStacks = async ({ targetId, edge }) => {
+            this.analytics('get-adjacent-stacks');
             const contentItem = this.layoutContentCache.getContentItemOrThrow(targetId);
             // call utils helper to traverse and return adjacent stacks
             return (0, layout_traversal_1.getAdjacentStacks)(contentItem, edge).map((stack) => ({
                 entityId: this.layoutContentCache.getOrCreateEntityId(stack),
             }));
         };
+        this.setStackActiveView = async (stackEntityId, viewIdentity) => {
+            this.analytics('set-stack-active-view');
+            const stack = this.layoutContentCache.getContentItemOrThrow(stackEntityId, ['stack']);
+            const view = this.findViewInStack(stack, viewIdentity);
+            if (!view) {
+                throw new Error(`Tried to set a view ('${viewIdentity.name}') as active when it does not belong to the stack.`);
+            }
+            stack.setActiveContentItem(view, true);
+        };
+        this.wire = this.layoutManager.platform.wire;
     }
     /**
      * @internal
@@ -193,6 +219,7 @@ class LayoutEntitiesController {
      * @throws if the entity associated with {@link id} is not in the entity cache, does not belogn to a layout, or is not a column/row.
      */
     getContent(id) {
+        this.analytics('get-content');
         const ci = this.layoutContentCache.getContentItemOrThrow(id, ['column', 'row']);
         return ci.contentItems.map((item) => ({
             type: item.type,
@@ -209,6 +236,7 @@ class LayoutEntitiesController {
      * content item or has been removed from the layout entirely.
      */
     getParent(id) {
+        this.analytics('get-parent');
         const ci = this.layoutContentCache.getContentItemOrThrow(id);
         if (ci.parent && !ci.parent.isRoot && ci.parent.contentItems.includes(ci)) {
             return {
@@ -253,4 +281,7 @@ __decorate([
 __decorate([
     (0, decorators_1.expose)()
 ], LayoutEntitiesController.prototype, "getAdjacentStacks", void 0);
+__decorate([
+    (0, decorators_1.expose)()
+], LayoutEntitiesController.prototype, "setStackActiveView", void 0);
 exports.LayoutEntitiesController = LayoutEntitiesController;

package/src/api/platform/layout/controllers/tab-drag-controller.d.ts

@@ -1,6 +1,6 @@
 import type * as OpenFin from '../../../../OpenFin';
 import { ViewOverlay } from '../utils/view-overlay';
-import { View } from '../../../view';
+type View = OpenFin.View;
 /**
  * Set of apis used to facilitate tab drag interactions without needing to hide views.
  * @ignore
@@ -56,3 +56,4 @@ export declare class TabDragController {
      */
     observeOverlay: (dropZonePreview: HTMLElement) => Promise<void>;
 }
+export {};