@openfin/core 40.82.21 → 40.82.22

package/out/mock-alpha.d.ts

@@ -7681,6 +7681,29 @@ declare class Layout extends Base {
      * ```
      */
     applyPreset: (options: PresetLayoutOptions) => Promise<void>;
+    /**
+     * Adds a view to the platform layout. Behaves like @link{Platform#createView} with the current layout as the target.
+     *
+     * @param viewOptions - The options for creating the view.
+     * @param options - Optional parameters for adding the view.
+     * @param options.location - The location where the view should be added.
+     * @param options.targetView - The target view to which the new view should be added.
+     * @returns A promise that resolves to an object containing the identity of the added view.
+     */
+    addView(viewOptions: OpenFin_2.PlatformViewCreationOptions, { location, targetView }?: {
+        location?: OpenFin_2.CreateViewTarget['location'];
+        targetView?: OpenFin_2.Identity;
+    }): Promise<{
+        identity: OpenFin_2.Identity;
+    }>;
+    /**
+     * Closes a view by its identity. Throws an error if the view does not belong to the current layout.
+     * Behaves like @link{Platform#closeView} but only closes the view if it belongs the current layout.
+     *
+     * @param viewIdentity - The identity of the view to close.
+     * @returns A promise that resolves when the view is closed.
+     */
+    closeView(viewIdentity: OpenFin_2.Identity): Promise<void>;
 }
 
 /**
@@ -7693,7 +7716,7 @@ declare type LayoutColumn = LayoutItemConfig & {
 /**
  * @interface
  */
-declare type LayoutComponent = LayoutItemConfig & {
+declare type LayoutComponent = Omit<LayoutItemConfig, 'content' | 'type'> & {
     /**
      * Only a component type will have this property and it should be set to view.
      */
@@ -7702,6 +7725,7 @@ declare type LayoutComponent = LayoutItemConfig & {
      * Only a component type will have this property and it represents the view options of a given component.
      */
     componentState?: Partial<ViewCreationOptions>;
+    type: 'component';
 };
 
 declare type LayoutContent = Array<LayoutItemConfig | LayoutRow | LayoutColumn | LayoutComponent>;
@@ -7893,7 +7917,7 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
     /**
      * @experimental
      */
-    getLayoutIdentityForView(viewIdentity: Identity_4): LayoutIdentity;
+    getLayoutIdentityForView(viewIdentity: Identity_4): LayoutIdentity | undefined;
     /**
      * @experimental
      */

package/out/mock-beta.d.ts

@@ -7681,6 +7681,29 @@ declare class Layout extends Base {
      * ```
      */
     applyPreset: (options: PresetLayoutOptions) => Promise<void>;
+    /**
+     * Adds a view to the platform layout. Behaves like @link{Platform#createView} with the current layout as the target.
+     *
+     * @param viewOptions - The options for creating the view.
+     * @param options - Optional parameters for adding the view.
+     * @param options.location - The location where the view should be added.
+     * @param options.targetView - The target view to which the new view should be added.
+     * @returns A promise that resolves to an object containing the identity of the added view.
+     */
+    addView(viewOptions: OpenFin_2.PlatformViewCreationOptions, { location, targetView }?: {
+        location?: OpenFin_2.CreateViewTarget['location'];
+        targetView?: OpenFin_2.Identity;
+    }): Promise<{
+        identity: OpenFin_2.Identity;
+    }>;
+    /**
+     * Closes a view by its identity. Throws an error if the view does not belong to the current layout.
+     * Behaves like @link{Platform#closeView} but only closes the view if it belongs the current layout.
+     *
+     * @param viewIdentity - The identity of the view to close.
+     * @returns A promise that resolves when the view is closed.
+     */
+    closeView(viewIdentity: OpenFin_2.Identity): Promise<void>;
 }
 
 /**
@@ -7693,7 +7716,7 @@ declare type LayoutColumn = LayoutItemConfig & {
 /**
  * @interface
  */
-declare type LayoutComponent = LayoutItemConfig & {
+declare type LayoutComponent = Omit<LayoutItemConfig, 'content' | 'type'> & {
     /**
      * Only a component type will have this property and it should be set to view.
      */
@@ -7702,6 +7725,7 @@ declare type LayoutComponent = LayoutItemConfig & {
      * Only a component type will have this property and it represents the view options of a given component.
      */
     componentState?: Partial<ViewCreationOptions>;
+    type: 'component';
 };
 
 declare type LayoutContent = Array<LayoutItemConfig | LayoutRow | LayoutColumn | LayoutComponent>;
@@ -7893,7 +7917,7 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
     /**
      * @experimental
      */
-    getLayoutIdentityForView(viewIdentity: Identity_4): LayoutIdentity;
+    getLayoutIdentityForView(viewIdentity: Identity_4): LayoutIdentity | undefined;
     /**
      * @experimental
      */

package/out/mock-public.d.ts

@@ -7681,6 +7681,29 @@ declare class Layout extends Base {
      * ```
      */
     applyPreset: (options: PresetLayoutOptions) => Promise<void>;
+    /**
+     * Adds a view to the platform layout. Behaves like @link{Platform#createView} with the current layout as the target.
+     *
+     * @param viewOptions - The options for creating the view.
+     * @param options - Optional parameters for adding the view.
+     * @param options.location - The location where the view should be added.
+     * @param options.targetView - The target view to which the new view should be added.
+     * @returns A promise that resolves to an object containing the identity of the added view.
+     */
+    addView(viewOptions: OpenFin_2.PlatformViewCreationOptions, { location, targetView }?: {
+        location?: OpenFin_2.CreateViewTarget['location'];
+        targetView?: OpenFin_2.Identity;
+    }): Promise<{
+        identity: OpenFin_2.Identity;
+    }>;
+    /**
+     * Closes a view by its identity. Throws an error if the view does not belong to the current layout.
+     * Behaves like @link{Platform#closeView} but only closes the view if it belongs the current layout.
+     *
+     * @param viewIdentity - The identity of the view to close.
+     * @returns A promise that resolves when the view is closed.
+     */
+    closeView(viewIdentity: OpenFin_2.Identity): Promise<void>;
 }
 
 /**
@@ -7693,7 +7716,7 @@ declare type LayoutColumn = LayoutItemConfig & {
 /**
  * @interface
  */
-declare type LayoutComponent = LayoutItemConfig & {
+declare type LayoutComponent = Omit<LayoutItemConfig, 'content' | 'type'> & {
     /**
      * Only a component type will have this property and it should be set to view.
      */
@@ -7702,6 +7725,7 @@ declare type LayoutComponent = LayoutItemConfig & {
      * Only a component type will have this property and it represents the view options of a given component.
      */
     componentState?: Partial<ViewCreationOptions>;
+    type: 'component';
 };
 
 declare type LayoutContent = Array<LayoutItemConfig | LayoutRow | LayoutColumn | LayoutComponent>;
@@ -7893,7 +7917,7 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
     /**
      * @experimental
      */
-    getLayoutIdentityForView(viewIdentity: Identity_4): LayoutIdentity;
+    getLayoutIdentityForView(viewIdentity: Identity_4): LayoutIdentity | undefined;
     /**
      * @experimental
      */

package/out/mock.d.ts

@@ -7807,6 +7807,29 @@ declare class Layout extends Base {
      * ```
      */
     applyPreset: (options: PresetLayoutOptions) => Promise<void>;
+    /**
+     * Adds a view to the platform layout. Behaves like @link{Platform#createView} with the current layout as the target.
+     *
+     * @param viewOptions - The options for creating the view.
+     * @param options - Optional parameters for adding the view.
+     * @param options.location - The location where the view should be added.
+     * @param options.targetView - The target view to which the new view should be added.
+     * @returns A promise that resolves to an object containing the identity of the added view.
+     */
+    addView(viewOptions: OpenFin_2.PlatformViewCreationOptions, { location, targetView }?: {
+        location?: OpenFin_2.CreateViewTarget['location'];
+        targetView?: OpenFin_2.Identity;
+    }): Promise<{
+        identity: OpenFin_2.Identity;
+    }>;
+    /**
+     * Closes a view by its identity. Throws an error if the view does not belong to the current layout.
+     * Behaves like @link{Platform#closeView} but only closes the view if it belongs the current layout.
+     *
+     * @param viewIdentity - The identity of the view to close.
+     * @returns A promise that resolves when the view is closed.
+     */
+    closeView(viewIdentity: OpenFin_2.Identity): Promise<void>;
 }
 
 /**
@@ -7819,7 +7842,7 @@ declare type LayoutColumn = LayoutItemConfig & {
 /**
  * @interface
  */
-declare type LayoutComponent = LayoutItemConfig & {
+declare type LayoutComponent = Omit<LayoutItemConfig, 'content' | 'type'> & {
     /**
      * Only a component type will have this property and it should be set to view.
      */
@@ -7828,6 +7851,7 @@ declare type LayoutComponent = LayoutItemConfig & {
      * Only a component type will have this property and it represents the view options of a given component.
      */
     componentState?: Partial<ViewCreationOptions>;
+    type: 'component';
 };
 
 declare type LayoutContent = Array<LayoutItemConfig | LayoutRow | LayoutColumn | LayoutComponent>;
@@ -8019,7 +8043,7 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
     /**
      * @experimental
      */
-    getLayoutIdentityForView(viewIdentity: Identity_4): LayoutIdentity;
+    getLayoutIdentityForView(viewIdentity: Identity_4): LayoutIdentity | undefined;
     /**
      * @experimental
      */

package/out/mock.js

@@ -11893,7 +11893,7 @@ var __classPrivateFieldGet$4 = (commonjsGlobal && commonjsGlobal.__classPrivateF
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _Layout_layoutClient;
+var _Layout_instances, _Layout_layoutClient, _Layout_forwardLayoutAction;
 Object.defineProperty(Instance$1, "__esModule", { value: true });
 Instance$1.Layout = void 0;
 const lazy_1 = lazy;
@@ -12047,6 +12047,7 @@ class Layout extends base_1$5.Base {
     // eslint-disable-next-line no-shadow
     constructor(identity, wire) {
         super(wire);
+        _Layout_instances.add(this);
         /**
          * @internal
          * Lazily constructed {@link LayoutEntitiesClient} bound to this platform's client and identity
@@ -12286,9 +12287,50 @@ class Layout extends base_1$5.Base {
         }
         return layout_entities_1.LayoutNode.getEntity(stack, client);
     }
+    /**
+     * Adds a view to the platform layout. Behaves like @link{Platform#createView} with the current layout as the target.
+     *
+     * @param viewOptions - The options for creating the view.
+     * @param options - Optional parameters for adding the view.
+     * @param options.location - The location where the view should be added.
+     * @param options.targetView - The target view to which the new view should be added.
+     * @returns A promise that resolves to an object containing the identity of the added view.
+     */
+    async addView(viewOptions, { location, targetView } = {}) {
+        this.wire.sendAction('layout-add-view').catch((e) => {
+            // don't expose
+        });
+        const { identity } = await __classPrivateFieldGet$4(this, _Layout_instances, "m", _Layout_forwardLayoutAction).call(this, 'layout-add-view', {
+            viewOptions,
+            location,
+            targetView
+        });
+        return { identity };
+    }
+    /**
+     * Closes a view by its identity. Throws an error if the view does not belong to the current layout.
+     * Behaves like @link{Platform#closeView} but only closes the view if it belongs the current layout.
+     *
+     * @param viewIdentity - The identity of the view to close.
+     * @returns A promise that resolves when the view is closed.
+     */
+    async closeView(viewIdentity) {
+        this.wire.sendAction('layout-close-view').catch((e) => {
+            // don't expose
+        });
+        await __classPrivateFieldGet$4(this, _Layout_instances, "m", _Layout_forwardLayoutAction).call(this, 'layout-close-view', { viewIdentity });
+    }
 }
 Instance$1.Layout = Layout;
-_Layout_layoutClient = new WeakMap();
+_Layout_layoutClient = new WeakMap(), _Layout_instances = new WeakSet(), _Layout_forwardLayoutAction = 
+/**
+ * @internal
+ * Use to type-guard actions sent to the layout via the provider.
+ */
+async function _Layout_forwardLayoutAction(action, payload) {
+    const client = await this.platform.getClient();
+    return client.dispatch(action, { target: this.identity, opts: payload });
+};
 
 var __classPrivateFieldGet$3 = (commonjsGlobal && commonjsGlobal.__classPrivateFieldGet) || function (receiver, state, kind, f) {
     if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/core",
-    "version": "40.82.21",
+    "version": "40.82.22",
     "description": "The core renderer entry point of OpenFin",
     "license": "SEE LICENSE IN LICENSE.md",
     "main": "out/mock.js",