@openfin/core 40.82.17 → 40.82.20

Sign up to get free protection for your applications and to get access to all the features.
@@ -2265,8 +2265,6 @@ declare class Channel extends EmitterBase<ChannelEvent> {
2265
2265
 
2266
2266
  declare type Channel_2 = OpenFin_2.Fin['InterApplicationBus']['Channel'];
2267
2267
 
2268
- declare type Channel_3 = OpenFin_2.Fin['InterApplicationBus']['Channel'];
2269
-
2270
2268
  declare type ChannelAction = OpenFin_2.ChannelAction;
2271
2269
 
2272
2270
  declare type ChannelAction_2 = (payload: unknown, id: ProviderIdentity_4 | ClientIdentity) => unknown;
@@ -4701,6 +4699,7 @@ declare interface Environment {
4701
4699
  getInteropInfo(fin: OpenFin_2.Fin<OpenFin_2.EntityType>): Promise<InternalInteropBrokerOptions & {
4702
4700
  fdc3Version?: Version;
4703
4701
  }>;
4702
+ getViewWindowIdentity(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, identity: OpenFin_2.Identity): Promise<OpenFin_2.Identity>;
4704
4703
  readonly type: EnvironmentType;
4705
4704
  }
4706
4705
 
@@ -7523,6 +7522,7 @@ declare type LaunchIntoPlatformPayload = {
7523
7522
  */
7524
7523
  declare class Layout extends Base {
7525
7524
  #private;
7525
+ /* Excluded from this release type: getClient */
7526
7526
  /* Excluded from this release type: init */
7527
7527
  identity: OpenFin_2.Identity | OpenFin_2.LayoutIdentity;
7528
7528
  private platform;
@@ -7622,7 +7622,17 @@ declare class Layout extends Base {
7622
7622
  * ```
7623
7623
  */
7624
7624
  getRootItem(): Promise<OpenFin_2.ColumnOrRow | OpenFin_2.TabStack>;
7625
- getStackByView(identity: OpenFin_2.Identity): Promise<OpenFin_2.TabStack>;
7625
+ /**
7626
+ * Retrieves the OpenFin.TabStack instance which the View belongs to.
7627
+ *
7628
+ * @example
7629
+ * ```js
7630
+ * const viewIdentity = { uuid: 'uuid', name: 'view-name' };
7631
+ * const stack = await fin.View.wrapSync(viewIdentity).getStackByViewIdentity(viewIdentity);
7632
+ * console.log(await stack.getViews());
7633
+ * ```
7634
+ */
7635
+ getStackByViewIdentity(identity: OpenFin_2.Identity): Promise<OpenFin_2.TabStack>;
7626
7636
  /**
7627
7637
  * Replaces the specified view with a view with the provided configuration.
7628
7638
  *
@@ -7992,6 +8002,17 @@ declare class LayoutModule extends Base {
7992
8002
  * ```
7993
8003
  */
7994
8004
  getCurrentSync(): OpenFin_2.Layout;
8005
+ /**
8006
+ * Retrieves the OpenFin.Layout instance for the Window the View is attached to.
8007
+ *
8008
+ * @example
8009
+ * ```js
8010
+ * const viewIdentity = { uuid: 'uuid', name: 'view-name' };
8011
+ * const layout = await fin.Platform.Layout.getLayoutByViewIdentity(viewIdentity);
8012
+ * console.log(await layout.getCurrentViews());
8013
+ * ```
8014
+ */
8015
+ getLayoutByViewIdentity(viewIdentity: OpenFin_2.Identity): Promise<OpenFin_2.Layout>;
7995
8016
  /**
7996
8017
  * Initialize the window's Layout.
7997
8018
  *
@@ -9620,6 +9641,7 @@ declare class Platform extends EmitterBase<OpenFin_2.PlatformEvent> {
9620
9641
  private _channel;
9621
9642
  Application: OpenFin_2.Application;
9622
9643
  identity: OpenFin_2.ApplicationIdentity;
9644
+ /* Excluded from this release type: clientMap */
9623
9645
  /* Excluded from this release type: __constructor */
9624
9646
  getClient: (identity?: OpenFin_2.ApplicationIdentity) => Promise<ChannelClient_2>;
9625
9647
  /**
@@ -15421,7 +15443,7 @@ declare class View_2 extends WebContents<OpenFin_2.ViewEvent> {
15421
15443
  */
15422
15444
  getInfo: () => Promise<OpenFin_2.ViewInfo>;
15423
15445
  /**
15424
- * Retrieves the layout for the window the view is attached to.
15446
+ * Retrieves the OpenFin.Layout instance for the Window the View is attached to.
15425
15447
  *
15426
15448
  * @example
15427
15449
  * ```js
@@ -2265,8 +2265,6 @@ declare class Channel extends EmitterBase<ChannelEvent> {
2265
2265
 
2266
2266
  declare type Channel_2 = OpenFin_2.Fin['InterApplicationBus']['Channel'];
2267
2267
 
2268
- declare type Channel_3 = OpenFin_2.Fin['InterApplicationBus']['Channel'];
2269
-
2270
2268
  declare type ChannelAction = OpenFin_2.ChannelAction;
2271
2269
 
2272
2270
  declare type ChannelAction_2 = (payload: unknown, id: ProviderIdentity_4 | ClientIdentity) => unknown;
@@ -4701,6 +4699,7 @@ declare interface Environment {
4701
4699
  getInteropInfo(fin: OpenFin_2.Fin<OpenFin_2.EntityType>): Promise<InternalInteropBrokerOptions & {
4702
4700
  fdc3Version?: Version;
4703
4701
  }>;
4702
+ getViewWindowIdentity(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, identity: OpenFin_2.Identity): Promise<OpenFin_2.Identity>;
4704
4703
  readonly type: EnvironmentType;
4705
4704
  }
4706
4705
 
@@ -7523,6 +7522,7 @@ declare type LaunchIntoPlatformPayload = {
7523
7522
  */
7524
7523
  declare class Layout extends Base {
7525
7524
  #private;
7525
+ /* Excluded from this release type: getClient */
7526
7526
  /* Excluded from this release type: init */
7527
7527
  identity: OpenFin_2.Identity | OpenFin_2.LayoutIdentity;
7528
7528
  private platform;
@@ -7622,7 +7622,17 @@ declare class Layout extends Base {
7622
7622
  * ```
7623
7623
  */
7624
7624
  getRootItem(): Promise<OpenFin_2.ColumnOrRow | OpenFin_2.TabStack>;
7625
- getStackByView(identity: OpenFin_2.Identity): Promise<OpenFin_2.TabStack>;
7625
+ /**
7626
+ * Retrieves the OpenFin.TabStack instance which the View belongs to.
7627
+ *
7628
+ * @example
7629
+ * ```js
7630
+ * const viewIdentity = { uuid: 'uuid', name: 'view-name' };
7631
+ * const stack = await fin.View.wrapSync(viewIdentity).getStackByViewIdentity(viewIdentity);
7632
+ * console.log(await stack.getViews());
7633
+ * ```
7634
+ */
7635
+ getStackByViewIdentity(identity: OpenFin_2.Identity): Promise<OpenFin_2.TabStack>;
7626
7636
  /**
7627
7637
  * Replaces the specified view with a view with the provided configuration.
7628
7638
  *
@@ -7992,6 +8002,17 @@ declare class LayoutModule extends Base {
7992
8002
  * ```
7993
8003
  */
7994
8004
  getCurrentSync(): OpenFin_2.Layout;
8005
+ /**
8006
+ * Retrieves the OpenFin.Layout instance for the Window the View is attached to.
8007
+ *
8008
+ * @example
8009
+ * ```js
8010
+ * const viewIdentity = { uuid: 'uuid', name: 'view-name' };
8011
+ * const layout = await fin.Platform.Layout.getLayoutByViewIdentity(viewIdentity);
8012
+ * console.log(await layout.getCurrentViews());
8013
+ * ```
8014
+ */
8015
+ getLayoutByViewIdentity(viewIdentity: OpenFin_2.Identity): Promise<OpenFin_2.Layout>;
7995
8016
  /**
7996
8017
  * Initialize the window's Layout.
7997
8018
  *
@@ -9620,6 +9641,7 @@ declare class Platform extends EmitterBase<OpenFin_2.PlatformEvent> {
9620
9641
  private _channel;
9621
9642
  Application: OpenFin_2.Application;
9622
9643
  identity: OpenFin_2.ApplicationIdentity;
9644
+ /* Excluded from this release type: clientMap */
9623
9645
  /* Excluded from this release type: __constructor */
9624
9646
  getClient: (identity?: OpenFin_2.ApplicationIdentity) => Promise<ChannelClient_2>;
9625
9647
  /**
@@ -15421,7 +15443,7 @@ declare class View_2 extends WebContents<OpenFin_2.ViewEvent> {
15421
15443
  */
15422
15444
  getInfo: () => Promise<OpenFin_2.ViewInfo>;
15423
15445
  /**
15424
- * Retrieves the layout for the window the view is attached to.
15446
+ * Retrieves the OpenFin.Layout instance for the Window the View is attached to.
15425
15447
  *
15426
15448
  * @example
15427
15449
  * ```js
@@ -2265,8 +2265,6 @@ declare class Channel extends EmitterBase<ChannelEvent> {
2265
2265
 
2266
2266
  declare type Channel_2 = OpenFin_2.Fin['InterApplicationBus']['Channel'];
2267
2267
 
2268
- declare type Channel_3 = OpenFin_2.Fin['InterApplicationBus']['Channel'];
2269
-
2270
2268
  declare type ChannelAction = OpenFin_2.ChannelAction;
2271
2269
 
2272
2270
  declare type ChannelAction_2 = (payload: unknown, id: ProviderIdentity_4 | ClientIdentity) => unknown;
@@ -4701,6 +4699,7 @@ declare interface Environment {
4701
4699
  getInteropInfo(fin: OpenFin_2.Fin<OpenFin_2.EntityType>): Promise<InternalInteropBrokerOptions & {
4702
4700
  fdc3Version?: Version;
4703
4701
  }>;
4702
+ getViewWindowIdentity(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, identity: OpenFin_2.Identity): Promise<OpenFin_2.Identity>;
4704
4703
  readonly type: EnvironmentType;
4705
4704
  }
4706
4705
 
@@ -7523,6 +7522,7 @@ declare type LaunchIntoPlatformPayload = {
7523
7522
  */
7524
7523
  declare class Layout extends Base {
7525
7524
  #private;
7525
+ /* Excluded from this release type: getClient */
7526
7526
  /* Excluded from this release type: init */
7527
7527
  identity: OpenFin_2.Identity | OpenFin_2.LayoutIdentity;
7528
7528
  private platform;
@@ -7622,7 +7622,17 @@ declare class Layout extends Base {
7622
7622
  * ```
7623
7623
  */
7624
7624
  getRootItem(): Promise<OpenFin_2.ColumnOrRow | OpenFin_2.TabStack>;
7625
- getStackByView(identity: OpenFin_2.Identity): Promise<OpenFin_2.TabStack>;
7625
+ /**
7626
+ * Retrieves the OpenFin.TabStack instance which the View belongs to.
7627
+ *
7628
+ * @example
7629
+ * ```js
7630
+ * const viewIdentity = { uuid: 'uuid', name: 'view-name' };
7631
+ * const stack = await fin.View.wrapSync(viewIdentity).getStackByViewIdentity(viewIdentity);
7632
+ * console.log(await stack.getViews());
7633
+ * ```
7634
+ */
7635
+ getStackByViewIdentity(identity: OpenFin_2.Identity): Promise<OpenFin_2.TabStack>;
7626
7636
  /**
7627
7637
  * Replaces the specified view with a view with the provided configuration.
7628
7638
  *
@@ -7992,6 +8002,17 @@ declare class LayoutModule extends Base {
7992
8002
  * ```
7993
8003
  */
7994
8004
  getCurrentSync(): OpenFin_2.Layout;
8005
+ /**
8006
+ * Retrieves the OpenFin.Layout instance for the Window the View is attached to.
8007
+ *
8008
+ * @example
8009
+ * ```js
8010
+ * const viewIdentity = { uuid: 'uuid', name: 'view-name' };
8011
+ * const layout = await fin.Platform.Layout.getLayoutByViewIdentity(viewIdentity);
8012
+ * console.log(await layout.getCurrentViews());
8013
+ * ```
8014
+ */
8015
+ getLayoutByViewIdentity(viewIdentity: OpenFin_2.Identity): Promise<OpenFin_2.Layout>;
7995
8016
  /**
7996
8017
  * Initialize the window's Layout.
7997
8018
  *
@@ -9620,6 +9641,7 @@ declare class Platform extends EmitterBase<OpenFin_2.PlatformEvent> {
9620
9641
  private _channel;
9621
9642
  Application: OpenFin_2.Application;
9622
9643
  identity: OpenFin_2.ApplicationIdentity;
9644
+ /* Excluded from this release type: clientMap */
9623
9645
  /* Excluded from this release type: __constructor */
9624
9646
  getClient: (identity?: OpenFin_2.ApplicationIdentity) => Promise<ChannelClient_2>;
9625
9647
  /**
@@ -15421,7 +15443,7 @@ declare class View_2 extends WebContents<OpenFin_2.ViewEvent> {
15421
15443
  */
15422
15444
  getInfo: () => Promise<OpenFin_2.ViewInfo>;
15423
15445
  /**
15424
- * Retrieves the layout for the window the view is attached to.
15446
+ * Retrieves the OpenFin.Layout instance for the Window the View is attached to.
15425
15447
  *
15426
15448
  * @example
15427
15449
  * ```js
package/out/mock.d.ts CHANGED
@@ -2304,8 +2304,6 @@ declare class Channel extends EmitterBase<ChannelEvent> {
2304
2304
 
2305
2305
  declare type Channel_2 = OpenFin_2.Fin['InterApplicationBus']['Channel'];
2306
2306
 
2307
- declare type Channel_3 = OpenFin_2.Fin['InterApplicationBus']['Channel'];
2308
-
2309
2307
  declare type ChannelAction = OpenFin_2.ChannelAction;
2310
2308
 
2311
2309
  declare type ChannelAction_2 = (payload: unknown, id: ProviderIdentity_4 | ClientIdentity) => unknown;
@@ -4765,6 +4763,7 @@ declare interface Environment {
4765
4763
  getInteropInfo(fin: OpenFin_2.Fin<OpenFin_2.EntityType>): Promise<InternalInteropBrokerOptions & {
4766
4764
  fdc3Version?: Version;
4767
4765
  }>;
4766
+ getViewWindowIdentity(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, identity: OpenFin_2.Identity): Promise<OpenFin_2.Identity>;
4768
4767
  readonly type: EnvironmentType;
4769
4768
  }
4770
4769
 
@@ -7640,6 +7639,10 @@ declare type LaunchIntoPlatformPayload = {
7640
7639
  */
7641
7640
  declare class Layout extends Base {
7642
7641
  #private;
7642
+ /**
7643
+ * @internal
7644
+ */
7645
+ static getClient(layout: Layout): Promise<LayoutEntitiesClient>;
7643
7646
  /**
7644
7647
  * @internal
7645
7648
  */
@@ -7745,7 +7748,17 @@ declare class Layout extends Base {
7745
7748
  * ```
7746
7749
  */
7747
7750
  getRootItem(): Promise<OpenFin_2.ColumnOrRow | OpenFin_2.TabStack>;
7748
- getStackByView(identity: OpenFin_2.Identity): Promise<OpenFin_2.TabStack>;
7751
+ /**
7752
+ * Retrieves the OpenFin.TabStack instance which the View belongs to.
7753
+ *
7754
+ * @example
7755
+ * ```js
7756
+ * const viewIdentity = { uuid: 'uuid', name: 'view-name' };
7757
+ * const stack = await fin.View.wrapSync(viewIdentity).getStackByViewIdentity(viewIdentity);
7758
+ * console.log(await stack.getViews());
7759
+ * ```
7760
+ */
7761
+ getStackByViewIdentity(identity: OpenFin_2.Identity): Promise<OpenFin_2.TabStack>;
7749
7762
  /**
7750
7763
  * Replaces the specified view with a view with the provided configuration.
7751
7764
  *
@@ -8115,6 +8128,17 @@ declare class LayoutModule extends Base {
8115
8128
  * ```
8116
8129
  */
8117
8130
  getCurrentSync(): OpenFin_2.Layout;
8131
+ /**
8132
+ * Retrieves the OpenFin.Layout instance for the Window the View is attached to.
8133
+ *
8134
+ * @example
8135
+ * ```js
8136
+ * const viewIdentity = { uuid: 'uuid', name: 'view-name' };
8137
+ * const layout = await fin.Platform.Layout.getLayoutByViewIdentity(viewIdentity);
8138
+ * console.log(await layout.getCurrentViews());
8139
+ * ```
8140
+ */
8141
+ getLayoutByViewIdentity(viewIdentity: OpenFin_2.Identity): Promise<OpenFin_2.Layout>;
8118
8142
  /**
8119
8143
  * Initialize the window's Layout.
8120
8144
  *
@@ -9935,10 +9959,16 @@ declare class Platform extends EmitterBase<OpenFin_2.PlatformEvent> {
9935
9959
  private _channel;
9936
9960
  Application: OpenFin_2.Application;
9937
9961
  identity: OpenFin_2.ApplicationIdentity;
9962
+ /**
9963
+ * @internal
9964
+ * Reuse clients to avoid overwriting already-registered client in provider
9965
+ * This ensures that only channel client is created per channel name per `fin` instance
9966
+ */
9967
+ private static clientMap;
9938
9968
  /**
9939
9969
  * @internal
9940
9970
  */
9941
- constructor(identity: OpenFin_2.ApplicationIdentity, channel: Channel_3);
9971
+ constructor(wire: Transport, identity: OpenFin_2.ApplicationIdentity, channelName?: string);
9942
9972
  getClient: (identity?: OpenFin_2.ApplicationIdentity) => Promise<ChannelClient_2>;
9943
9973
  /**
9944
9974
  * Creates a new view and attaches it to a specified target window.
@@ -15830,7 +15860,7 @@ declare class View_2 extends WebContents<OpenFin_2.ViewEvent> {
15830
15860
  */
15831
15861
  getInfo: () => Promise<OpenFin_2.ViewInfo>;
15832
15862
  /**
15833
- * Retrieves the layout for the window the view is attached to.
15863
+ * Retrieves the OpenFin.Layout instance for the Window the View is attached to.
15834
15864
  *
15835
15865
  * @example
15836
15866
  * ```js