@openfin/fdc3-api 40.82.17 → 40.82.20

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

@@ -2262,8 +2262,6 @@ declare class Channel extends EmitterBase<ChannelEvent> {
 
 declare type Channel_2 = OpenFin.Fin['InterApplicationBus']['Channel'];
 
-declare type Channel_3 = OpenFin.Fin['InterApplicationBus']['Channel'];
-
 declare type ChannelAction = OpenFin.ChannelAction;
 
 declare type ChannelAction_2 = (payload: unknown, id: ProviderIdentity_4 | ClientIdentity) => unknown;
@@ -4698,6 +4696,7 @@ declare interface Environment {
     getInteropInfo(fin: OpenFin.Fin<OpenFin.EntityType>): Promise<InternalInteropBrokerOptions & {
         fdc3Version?: Version;
     }>;
+    getViewWindowIdentity(fin: OpenFin.Fin<OpenFin.EntityType>, identity: OpenFin.Identity): Promise<OpenFin.Identity>;
     readonly type: EnvironmentType;
 }
 
@@ -7865,6 +7864,7 @@ declare type LaunchIntoPlatformPayload = {
  */
 declare class Layout extends Base {
     #private;
+    /* Excluded from this release type: getClient */
     /* Excluded from this release type: init */
     identity: OpenFin.Identity | OpenFin.LayoutIdentity;
     private platform;
@@ -7964,7 +7964,17 @@ declare class Layout extends Base {
      * ```
      */
     getRootItem(): Promise<OpenFin.ColumnOrRow | OpenFin.TabStack>;
-    getStackByView(identity: OpenFin.Identity): Promise<OpenFin.TabStack>;
+    /**
+     * Retrieves the OpenFin.TabStack instance which the View belongs to.
+     *
+     * @example
+     * ```js
+     * const viewIdentity = { uuid: 'uuid', name: 'view-name' };
+     * const stack = await fin.View.wrapSync(viewIdentity).getStackByViewIdentity(viewIdentity);
+     * console.log(await stack.getViews());
+     * ```
+     */
+    getStackByViewIdentity(identity: OpenFin.Identity): Promise<OpenFin.TabStack>;
     /**
      * Replaces the specified view with a view with the provided configuration.
      *
@@ -8334,6 +8344,17 @@ declare class LayoutModule extends Base {
      * ```
      */
     getCurrentSync(): OpenFin.Layout;
+    /**
+     * Retrieves the OpenFin.Layout instance for the Window the View is attached to.
+     *
+     * @example
+     * ```js
+     * const viewIdentity = { uuid: 'uuid', name: 'view-name' };
+     * const layout = await fin.Platform.Layout.getLayoutByViewIdentity(viewIdentity);
+     * console.log(await layout.getCurrentViews());
+     * ```
+     */
+    getLayoutByViewIdentity(viewIdentity: OpenFin.Identity): Promise<OpenFin.Layout>;
     /**
      * Initialize the window's Layout.
      *
@@ -9960,6 +9981,7 @@ declare class Platform extends EmitterBase<OpenFin.PlatformEvent> {
     private _channel;
     Application: OpenFin.Application;
     identity: OpenFin.ApplicationIdentity;
+    /* Excluded from this release type: clientMap */
     /* Excluded from this release type: __constructor */
     getClient: (identity?: OpenFin.ApplicationIdentity) => Promise<ChannelClient_2>;
     /**
@@ -15867,7 +15889,7 @@ declare class View_2 extends WebContents<OpenFin.ViewEvent> {
      */
     getInfo: () => Promise<OpenFin.ViewInfo>;
     /**
-     * Retrieves the layout for the window the view is attached to.
+     * Retrieves the OpenFin.Layout instance for the Window the View is attached to.
      *
      * @example
      * ```js

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

@@ -2262,8 +2262,6 @@ declare class Channel extends EmitterBase<ChannelEvent> {
 
 declare type Channel_2 = OpenFin.Fin['InterApplicationBus']['Channel'];
 
-declare type Channel_3 = OpenFin.Fin['InterApplicationBus']['Channel'];
-
 declare type ChannelAction = OpenFin.ChannelAction;
 
 declare type ChannelAction_2 = (payload: unknown, id: ProviderIdentity_4 | ClientIdentity) => unknown;
@@ -4698,6 +4696,7 @@ declare interface Environment {
     getInteropInfo(fin: OpenFin.Fin<OpenFin.EntityType>): Promise<InternalInteropBrokerOptions & {
         fdc3Version?: Version;
     }>;
+    getViewWindowIdentity(fin: OpenFin.Fin<OpenFin.EntityType>, identity: OpenFin.Identity): Promise<OpenFin.Identity>;
     readonly type: EnvironmentType;
 }
 
@@ -7865,6 +7864,7 @@ declare type LaunchIntoPlatformPayload = {
  */
 declare class Layout extends Base {
     #private;
+    /* Excluded from this release type: getClient */
     /* Excluded from this release type: init */
     identity: OpenFin.Identity | OpenFin.LayoutIdentity;
     private platform;
@@ -7964,7 +7964,17 @@ declare class Layout extends Base {
      * ```
      */
     getRootItem(): Promise<OpenFin.ColumnOrRow | OpenFin.TabStack>;
-    getStackByView(identity: OpenFin.Identity): Promise<OpenFin.TabStack>;
+    /**
+     * Retrieves the OpenFin.TabStack instance which the View belongs to.
+     *
+     * @example
+     * ```js
+     * const viewIdentity = { uuid: 'uuid', name: 'view-name' };
+     * const stack = await fin.View.wrapSync(viewIdentity).getStackByViewIdentity(viewIdentity);
+     * console.log(await stack.getViews());
+     * ```
+     */
+    getStackByViewIdentity(identity: OpenFin.Identity): Promise<OpenFin.TabStack>;
     /**
      * Replaces the specified view with a view with the provided configuration.
      *
@@ -8334,6 +8344,17 @@ declare class LayoutModule extends Base {
      * ```
      */
     getCurrentSync(): OpenFin.Layout;
+    /**
+     * Retrieves the OpenFin.Layout instance for the Window the View is attached to.
+     *
+     * @example
+     * ```js
+     * const viewIdentity = { uuid: 'uuid', name: 'view-name' };
+     * const layout = await fin.Platform.Layout.getLayoutByViewIdentity(viewIdentity);
+     * console.log(await layout.getCurrentViews());
+     * ```
+     */
+    getLayoutByViewIdentity(viewIdentity: OpenFin.Identity): Promise<OpenFin.Layout>;
     /**
      * Initialize the window's Layout.
      *
@@ -9960,6 +9981,7 @@ declare class Platform extends EmitterBase<OpenFin.PlatformEvent> {
     private _channel;
     Application: OpenFin.Application;
     identity: OpenFin.ApplicationIdentity;
+    /* Excluded from this release type: clientMap */
     /* Excluded from this release type: __constructor */
     getClient: (identity?: OpenFin.ApplicationIdentity) => Promise<ChannelClient_2>;
     /**
@@ -15867,7 +15889,7 @@ declare class View_2 extends WebContents<OpenFin.ViewEvent> {
      */
     getInfo: () => Promise<OpenFin.ViewInfo>;
     /**
-     * Retrieves the layout for the window the view is attached to.
+     * Retrieves the OpenFin.Layout instance for the Window the View is attached to.
      *
      * @example
      * ```js

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

@@ -2262,8 +2262,6 @@ declare class Channel extends EmitterBase<ChannelEvent> {
 
 declare type Channel_2 = OpenFin.Fin['InterApplicationBus']['Channel'];
 
-declare type Channel_3 = OpenFin.Fin['InterApplicationBus']['Channel'];
-
 declare type ChannelAction = OpenFin.ChannelAction;
 
 declare type ChannelAction_2 = (payload: unknown, id: ProviderIdentity_4 | ClientIdentity) => unknown;
@@ -4698,6 +4696,7 @@ declare interface Environment {
     getInteropInfo(fin: OpenFin.Fin<OpenFin.EntityType>): Promise<InternalInteropBrokerOptions & {
         fdc3Version?: Version;
     }>;
+    getViewWindowIdentity(fin: OpenFin.Fin<OpenFin.EntityType>, identity: OpenFin.Identity): Promise<OpenFin.Identity>;
     readonly type: EnvironmentType;
 }
 
@@ -7865,6 +7864,7 @@ declare type LaunchIntoPlatformPayload = {
  */
 declare class Layout extends Base {
     #private;
+    /* Excluded from this release type: getClient */
     /* Excluded from this release type: init */
     identity: OpenFin.Identity | OpenFin.LayoutIdentity;
     private platform;
@@ -7964,7 +7964,17 @@ declare class Layout extends Base {
      * ```
      */
     getRootItem(): Promise<OpenFin.ColumnOrRow | OpenFin.TabStack>;
-    getStackByView(identity: OpenFin.Identity): Promise<OpenFin.TabStack>;
+    /**
+     * Retrieves the OpenFin.TabStack instance which the View belongs to.
+     *
+     * @example
+     * ```js
+     * const viewIdentity = { uuid: 'uuid', name: 'view-name' };
+     * const stack = await fin.View.wrapSync(viewIdentity).getStackByViewIdentity(viewIdentity);
+     * console.log(await stack.getViews());
+     * ```
+     */
+    getStackByViewIdentity(identity: OpenFin.Identity): Promise<OpenFin.TabStack>;
     /**
      * Replaces the specified view with a view with the provided configuration.
      *
@@ -8334,6 +8344,17 @@ declare class LayoutModule extends Base {
      * ```
      */
     getCurrentSync(): OpenFin.Layout;
+    /**
+     * Retrieves the OpenFin.Layout instance for the Window the View is attached to.
+     *
+     * @example
+     * ```js
+     * const viewIdentity = { uuid: 'uuid', name: 'view-name' };
+     * const layout = await fin.Platform.Layout.getLayoutByViewIdentity(viewIdentity);
+     * console.log(await layout.getCurrentViews());
+     * ```
+     */
+    getLayoutByViewIdentity(viewIdentity: OpenFin.Identity): Promise<OpenFin.Layout>;
     /**
      * Initialize the window's Layout.
      *
@@ -9960,6 +9981,7 @@ declare class Platform extends EmitterBase<OpenFin.PlatformEvent> {
     private _channel;
     Application: OpenFin.Application;
     identity: OpenFin.ApplicationIdentity;
+    /* Excluded from this release type: clientMap */
     /* Excluded from this release type: __constructor */
     getClient: (identity?: OpenFin.ApplicationIdentity) => Promise<ChannelClient_2>;
     /**
@@ -15867,7 +15889,7 @@ declare class View_2 extends WebContents<OpenFin.ViewEvent> {
      */
     getInfo: () => Promise<OpenFin.ViewInfo>;
     /**
-     * Retrieves the layout for the window the view is attached to.
+     * Retrieves the OpenFin.Layout instance for the Window the View is attached to.
      *
      * @example
      * ```js

package/out/fdc3-api.d.ts

@@ -2301,8 +2301,6 @@ declare class Channel extends EmitterBase<ChannelEvent> {
 
 declare type Channel_2 = OpenFin.Fin['InterApplicationBus']['Channel'];
 
-declare type Channel_3 = OpenFin.Fin['InterApplicationBus']['Channel'];
-
 declare type ChannelAction = OpenFin.ChannelAction;
 
 declare type ChannelAction_2 = (payload: unknown, id: ProviderIdentity_4 | ClientIdentity) => unknown;
@@ -4762,6 +4760,7 @@ declare interface Environment {
     getInteropInfo(fin: OpenFin.Fin<OpenFin.EntityType>): Promise<InternalInteropBrokerOptions & {
         fdc3Version?: Version;
     }>;
+    getViewWindowIdentity(fin: OpenFin.Fin<OpenFin.EntityType>, identity: OpenFin.Identity): Promise<OpenFin.Identity>;
     readonly type: EnvironmentType;
 }
 
@@ -7982,6 +7981,10 @@ declare type LaunchIntoPlatformPayload = {
  */
 declare class Layout extends Base {
     #private;
+    /**
+     * @internal
+     */
+    static getClient(layout: Layout): Promise<LayoutEntitiesClient>;
     /**
      * @internal
      */
@@ -8087,7 +8090,17 @@ declare class Layout extends Base {
      * ```
      */
     getRootItem(): Promise<OpenFin.ColumnOrRow | OpenFin.TabStack>;
-    getStackByView(identity: OpenFin.Identity): Promise<OpenFin.TabStack>;
+    /**
+     * Retrieves the OpenFin.TabStack instance which the View belongs to.
+     *
+     * @example
+     * ```js
+     * const viewIdentity = { uuid: 'uuid', name: 'view-name' };
+     * const stack = await fin.View.wrapSync(viewIdentity).getStackByViewIdentity(viewIdentity);
+     * console.log(await stack.getViews());
+     * ```
+     */
+    getStackByViewIdentity(identity: OpenFin.Identity): Promise<OpenFin.TabStack>;
     /**
      * Replaces the specified view with a view with the provided configuration.
      *
@@ -8457,6 +8470,17 @@ declare class LayoutModule extends Base {
      * ```
      */
     getCurrentSync(): OpenFin.Layout;
+    /**
+     * Retrieves the OpenFin.Layout instance for the Window the View is attached to.
+     *
+     * @example
+     * ```js
+     * const viewIdentity = { uuid: 'uuid', name: 'view-name' };
+     * const layout = await fin.Platform.Layout.getLayoutByViewIdentity(viewIdentity);
+     * console.log(await layout.getCurrentViews());
+     * ```
+     */
+    getLayoutByViewIdentity(viewIdentity: OpenFin.Identity): Promise<OpenFin.Layout>;
     /**
      * Initialize the window's Layout.
      *
@@ -10275,10 +10299,16 @@ declare class Platform extends EmitterBase<OpenFin.PlatformEvent> {
     private _channel;
     Application: OpenFin.Application;
     identity: OpenFin.ApplicationIdentity;
+    /**
+     * @internal
+     * Reuse clients to avoid overwriting already-registered client in provider
+     * This ensures that only channel client is created per channel name per `fin` instance
+     */
+    private static clientMap;
     /**
      * @internal
      */
-    constructor(identity: OpenFin.ApplicationIdentity, channel: Channel_3);
+    constructor(wire: Transport, identity: OpenFin.ApplicationIdentity, channelName?: string);
     getClient: (identity?: OpenFin.ApplicationIdentity) => Promise<ChannelClient_2>;
     /**
      * Creates a new view and attaches it to a specified target window.
@@ -16276,7 +16306,7 @@ declare class View_2 extends WebContents<OpenFin.ViewEvent> {
      */
     getInfo: () => Promise<OpenFin.ViewInfo>;
     /**
-     * Retrieves the layout for the window the view is attached to.
+     * Retrieves the OpenFin.Layout instance for the Window the View is attached to.
      *
      * @example
      * ```js

package/package.json

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