@openfin/fdc3-api 40.82.21 → 40.82.22

package/out/fdc3-api-alpha.d.ts

@@ -8023,6 +8023,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.PlatformViewCreationOptions, { location, targetView }?: {
+        location?: OpenFin.CreateViewTarget['location'];
+        targetView?: OpenFin.Identity;
+    }): Promise<{
+        identity: OpenFin.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.Identity): Promise<void>;
 }
 
 /**
@@ -8035,7 +8058,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.
      */
@@ -8044,6 +8067,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>;
@@ -8235,7 +8259,7 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
     /**
      * @experimental
      */
-    getLayoutIdentityForView(viewIdentity: Identity_4): LayoutIdentity;
+    getLayoutIdentityForView(viewIdentity: Identity_4): LayoutIdentity | undefined;
     /**
      * @experimental
      */

package/out/fdc3-api-beta.d.ts

@@ -8023,6 +8023,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.PlatformViewCreationOptions, { location, targetView }?: {
+        location?: OpenFin.CreateViewTarget['location'];
+        targetView?: OpenFin.Identity;
+    }): Promise<{
+        identity: OpenFin.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.Identity): Promise<void>;
 }
 
 /**
@@ -8035,7 +8058,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.
      */
@@ -8044,6 +8067,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>;
@@ -8235,7 +8259,7 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
     /**
      * @experimental
      */
-    getLayoutIdentityForView(viewIdentity: Identity_4): LayoutIdentity;
+    getLayoutIdentityForView(viewIdentity: Identity_4): LayoutIdentity | undefined;
     /**
      * @experimental
      */

package/out/fdc3-api-public.d.ts

@@ -8023,6 +8023,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.PlatformViewCreationOptions, { location, targetView }?: {
+        location?: OpenFin.CreateViewTarget['location'];
+        targetView?: OpenFin.Identity;
+    }): Promise<{
+        identity: OpenFin.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.Identity): Promise<void>;
 }
 
 /**
@@ -8035,7 +8058,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.
      */
@@ -8044,6 +8067,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>;
@@ -8235,7 +8259,7 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
     /**
      * @experimental
      */
-    getLayoutIdentityForView(viewIdentity: Identity_4): LayoutIdentity;
+    getLayoutIdentityForView(viewIdentity: Identity_4): LayoutIdentity | undefined;
     /**
      * @experimental
      */

package/out/fdc3-api.d.ts

@@ -8149,6 +8149,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.PlatformViewCreationOptions, { location, targetView }?: {
+        location?: OpenFin.CreateViewTarget['location'];
+        targetView?: OpenFin.Identity;
+    }): Promise<{
+        identity: OpenFin.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.Identity): Promise<void>;
 }
 
 /**
@@ -8161,7 +8184,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.
      */
@@ -8170,6 +8193,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>;
@@ -8361,7 +8385,7 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
     /**
      * @experimental
      */
-    getLayoutIdentityForView(viewIdentity: Identity_4): LayoutIdentity;
+    getLayoutIdentityForView(viewIdentity: Identity_4): LayoutIdentity | undefined;
     /**
      * @experimental
      */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/fdc3-api",
-    "version": "40.82.21",
+    "version": "40.82.22",
     "description": "OpenFin fdc3 module utilities and types.",
     "license": "SEE LICENSE IN LICENSE.md",
     "private": false,