@openfin/node-adapter 34.78.56 → 34.78.58

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -43,6 +43,8 @@ declare type Accelerator = {
43
43
  };
44
44
 
45
45
  /**
46
+ * Options to use when adding a view to a {@link TabStack}.
47
+ *
46
48
  * @interface
47
49
  */
48
50
  declare type AddViewOptions = CreateViewTarget & {
@@ -8849,7 +8851,8 @@ declare type LayoutIdentity = Identity_5 & {
8849
8851
  };
8850
8852
 
8851
8853
  /**
8852
- * Generated when the window and all of its layout's views have either finished or failed navigation, once per layout.
8854
+ * Generated when the window is created, and all of its layout's views have either finished or failed
8855
+ * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
8853
8856
  * @interface
8854
8857
  */
8855
8858
  declare type LayoutInitializedEvent = BaseEvent_5 & {
@@ -9208,6 +9211,9 @@ declare type LayoutOptions = {
9208
9211
  };
9209
9212
  };
9210
9213
 
9214
+ /**
9215
+ * Represents the position of an item in a layout relative to another.
9216
+ */
9211
9217
  declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
9212
9218
 
9213
9219
  /**
@@ -9926,7 +9932,7 @@ declare type MutableWindowOptions = {
9926
9932
  showTaskbarIcon: boolean;
9927
9933
  interop: InteropConfig;
9928
9934
  /* Excluded from this release type: _internalWorkspaceData */
9929
- workspacePlatform: WorkspacePlatformOptions;
9935
+ workspacePlatform: unknown;
9930
9936
  };
9931
9937
 
9932
9938
  declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;
@@ -11421,6 +11427,17 @@ declare interface PlatformProvider {
11421
11427
  */
11422
11428
  getSnapshot(payload: undefined, identity: OpenFin.Identity): Promise<OpenFin.Snapshot>;
11423
11429
  /* Excluded from this release type: getInitialLayoutSnapshot */
11430
+ /**
11431
+ * @experimental
11432
+ *
11433
+ * This API is called during the {@link PlatformProvider.getSnapshot()} call.
11434
+ * Gets the current state of a particular window and its views and returns an object that
11435
+ * can be added to the {@link OpenFin.Snapshot.windows} property. Override this function if
11436
+ * you wish to mutate each window snapshot during the {@link PlatformProvider.getSnapshot()} call
11437
+ * @param identity
11438
+ * @param callerIdentity
11439
+ */
11440
+ getWindowSnapshot(identity: OpenFin.Identity, callerIdentity: OpenFin.Identity): Promise<OpenFin.WindowCreationOptions>;
11424
11441
  /* Excluded from this release type: createViewsForLayout */
11425
11442
  /* Excluded from this release type: getViewSnapshot */
11426
11443
  /**
@@ -15340,20 +15357,6 @@ declare interface TabDragListener extends EventEmitter_2 {
15340
15357
  contentItem: ContentItem;
15341
15358
  }
15342
15359
 
15343
- /**
15344
- * @typedef {string} LayoutPosition
15345
- * @summary Represents the position of an item in a layout relative to another. Possible values are 'top', 'bottom', 'left' and 'right'.
15346
- */
15347
- /**
15348
- * @typedef {object} StackCreationOptions
15349
- * @summary Stack creation options.
15350
- * @property {LayoutPosition} [position] - The position to create the new {@link TabStack} in, relative to the given adjacent {@link TabStack}. Defaults to 'right'.
15351
- */
15352
- /**
15353
- * @typedef {object} TabStack~AddViewOptions
15354
- * @summary Options to use when adding a view to a {@link TabStack}
15355
- * @property {number} [index] - Insertion index when adding the view. Defaults to 0.
15356
- */
15357
15360
  /**
15358
15361
  * A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
15359
15362
  */
@@ -43,6 +43,8 @@ declare type Accelerator = {
43
43
  };
44
44
 
45
45
  /**
46
+ * Options to use when adding a view to a {@link TabStack}.
47
+ *
46
48
  * @interface
47
49
  */
48
50
  declare type AddViewOptions = CreateViewTarget & {
@@ -8849,7 +8851,8 @@ declare type LayoutIdentity = Identity_5 & {
8849
8851
  };
8850
8852
 
8851
8853
  /**
8852
- * Generated when the window and all of its layout's views have either finished or failed navigation, once per layout.
8854
+ * Generated when the window is created, and all of its layout's views have either finished or failed
8855
+ * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
8853
8856
  * @interface
8854
8857
  */
8855
8858
  declare type LayoutInitializedEvent = BaseEvent_5 & {
@@ -9208,6 +9211,9 @@ declare type LayoutOptions = {
9208
9211
  };
9209
9212
  };
9210
9213
 
9214
+ /**
9215
+ * Represents the position of an item in a layout relative to another.
9216
+ */
9211
9217
  declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
9212
9218
 
9213
9219
  /**
@@ -9926,7 +9932,7 @@ declare type MutableWindowOptions = {
9926
9932
  showTaskbarIcon: boolean;
9927
9933
  interop: InteropConfig;
9928
9934
  /* Excluded from this release type: _internalWorkspaceData */
9929
- workspacePlatform: WorkspacePlatformOptions;
9935
+ workspacePlatform: unknown;
9930
9936
  };
9931
9937
 
9932
9938
  declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;
@@ -11421,6 +11427,17 @@ declare interface PlatformProvider {
11421
11427
  */
11422
11428
  getSnapshot(payload: undefined, identity: OpenFin.Identity): Promise<OpenFin.Snapshot>;
11423
11429
  /* Excluded from this release type: getInitialLayoutSnapshot */
11430
+ /**
11431
+ * @experimental
11432
+ *
11433
+ * This API is called during the {@link PlatformProvider.getSnapshot()} call.
11434
+ * Gets the current state of a particular window and its views and returns an object that
11435
+ * can be added to the {@link OpenFin.Snapshot.windows} property. Override this function if
11436
+ * you wish to mutate each window snapshot during the {@link PlatformProvider.getSnapshot()} call
11437
+ * @param identity
11438
+ * @param callerIdentity
11439
+ */
11440
+ getWindowSnapshot(identity: OpenFin.Identity, callerIdentity: OpenFin.Identity): Promise<OpenFin.WindowCreationOptions>;
11424
11441
  /* Excluded from this release type: createViewsForLayout */
11425
11442
  /* Excluded from this release type: getViewSnapshot */
11426
11443
  /**
@@ -15340,20 +15357,6 @@ declare interface TabDragListener extends EventEmitter_2 {
15340
15357
  contentItem: ContentItem;
15341
15358
  }
15342
15359
 
15343
- /**
15344
- * @typedef {string} LayoutPosition
15345
- * @summary Represents the position of an item in a layout relative to another. Possible values are 'top', 'bottom', 'left' and 'right'.
15346
- */
15347
- /**
15348
- * @typedef {object} StackCreationOptions
15349
- * @summary Stack creation options.
15350
- * @property {LayoutPosition} [position] - The position to create the new {@link TabStack} in, relative to the given adjacent {@link TabStack}. Defaults to 'right'.
15351
- */
15352
- /**
15353
- * @typedef {object} TabStack~AddViewOptions
15354
- * @summary Options to use when adding a view to a {@link TabStack}
15355
- * @property {number} [index] - Insertion index when adding the view. Defaults to 0.
15356
- */
15357
15360
  /**
15358
15361
  * A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
15359
15362
  */
@@ -43,6 +43,8 @@ declare type Accelerator = {
43
43
  };
44
44
 
45
45
  /**
46
+ * Options to use when adding a view to a {@link TabStack}.
47
+ *
46
48
  * @interface
47
49
  */
48
50
  declare type AddViewOptions = CreateViewTarget & {
@@ -8849,7 +8851,8 @@ declare type LayoutIdentity = Identity_5 & {
8849
8851
  };
8850
8852
 
8851
8853
  /**
8852
- * Generated when the window and all of its layout's views have either finished or failed navigation, once per layout.
8854
+ * Generated when the window is created, and all of its layout's views have either finished or failed
8855
+ * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
8853
8856
  * @interface
8854
8857
  */
8855
8858
  declare type LayoutInitializedEvent = BaseEvent_5 & {
@@ -9208,6 +9211,9 @@ declare type LayoutOptions = {
9208
9211
  };
9209
9212
  };
9210
9213
 
9214
+ /**
9215
+ * Represents the position of an item in a layout relative to another.
9216
+ */
9211
9217
  declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
9212
9218
 
9213
9219
  /**
@@ -9926,7 +9932,7 @@ declare type MutableWindowOptions = {
9926
9932
  showTaskbarIcon: boolean;
9927
9933
  interop: InteropConfig;
9928
9934
  /* Excluded from this release type: _internalWorkspaceData */
9929
- workspacePlatform: WorkspacePlatformOptions;
9935
+ workspacePlatform: unknown;
9930
9936
  };
9931
9937
 
9932
9938
  declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;
@@ -11421,6 +11427,17 @@ declare interface PlatformProvider {
11421
11427
  */
11422
11428
  getSnapshot(payload: undefined, identity: OpenFin.Identity): Promise<OpenFin.Snapshot>;
11423
11429
  /* Excluded from this release type: getInitialLayoutSnapshot */
11430
+ /**
11431
+ * @experimental
11432
+ *
11433
+ * This API is called during the {@link PlatformProvider.getSnapshot()} call.
11434
+ * Gets the current state of a particular window and its views and returns an object that
11435
+ * can be added to the {@link OpenFin.Snapshot.windows} property. Override this function if
11436
+ * you wish to mutate each window snapshot during the {@link PlatformProvider.getSnapshot()} call
11437
+ * @param identity
11438
+ * @param callerIdentity
11439
+ */
11440
+ getWindowSnapshot(identity: OpenFin.Identity, callerIdentity: OpenFin.Identity): Promise<OpenFin.WindowCreationOptions>;
11424
11441
  /* Excluded from this release type: createViewsForLayout */
11425
11442
  /* Excluded from this release type: getViewSnapshot */
11426
11443
  /**
@@ -15340,20 +15357,6 @@ declare interface TabDragListener extends EventEmitter_2 {
15340
15357
  contentItem: ContentItem;
15341
15358
  }
15342
15359
 
15343
- /**
15344
- * @typedef {string} LayoutPosition
15345
- * @summary Represents the position of an item in a layout relative to another. Possible values are 'top', 'bottom', 'left' and 'right'.
15346
- */
15347
- /**
15348
- * @typedef {object} StackCreationOptions
15349
- * @summary Stack creation options.
15350
- * @property {LayoutPosition} [position] - The position to create the new {@link TabStack} in, relative to the given adjacent {@link TabStack}. Defaults to 'right'.
15351
- */
15352
- /**
15353
- * @typedef {object} TabStack~AddViewOptions
15354
- * @summary Options to use when adding a view to a {@link TabStack}
15355
- * @property {number} [index] - Insertion index when adding the view. Defaults to 0.
15356
- */
15357
15360
  /**
15358
15361
  * A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
15359
15362
  */
@@ -43,6 +43,8 @@ declare type Accelerator = {
43
43
  };
44
44
 
45
45
  /**
46
+ * Options to use when adding a view to a {@link TabStack}.
47
+ *
46
48
  * @interface
47
49
  */
48
50
  declare type AddViewOptions = CreateViewTarget & {
@@ -3411,57 +3413,6 @@ declare type ClosingEvent = BaseEvent_5 & {
3411
3413
  */
3412
3414
  declare class ColumnOrRow extends LayoutNode {
3413
3415
  #private;
3414
- /**
3415
- * Determines if this {@link ColumnOrRow} is the top level content item in the current layout.
3416
- * @function isRoot
3417
- * @memberof ColumnOrRow
3418
- * @instance
3419
- * @tutorial ColumnOrRow.isRoot
3420
- * @returns Resolves true if this TabStack is the top level content item, or false if it is not.
3421
- */
3422
- /**
3423
- * Determines if this {@link ColumnOrRow} exists.
3424
- * @function exists
3425
- * @instance
3426
- * @memberof ColumnOrRow
3427
- * @tutorial ColumnOrRow.exists
3428
- * @returns Resolves true if the TabStack exists, or false if it has been destroyed.
3429
- */
3430
- /**
3431
- * Retrieves the parent {@link ColumnOrRow} of this {@link ColumnOrRow}, if one exists.
3432
- * @function getParent
3433
- * @instance
3434
- * @memberof ColumnOrRow
3435
- * @tutorial ColumnOrRow.getParent
3436
- * @returns Promise resolving with the {@link ColumnOrRow} that contains this item, or undefined if
3437
- * this {@link ColumnOrRow}does not exist or is the root content item.
3438
- */
3439
- /**
3440
- * Returns all the adjacent stacks that share an edge with the given {@link ColumnOrRow}.
3441
- * @function getAdjacentStacks
3442
- * @instance
3443
- * @memberof ColumnOrRow
3444
- * @param {LayoutPosition} edge - Edge to check for any adjacent stacks.
3445
- *
3446
- * @tutorial ColumnOrRow.getAdjacentStacks
3447
- */
3448
- /**
3449
- * Given a list of view creation options or references and a layout position, creates a {@link TabStack} adjacent to the given {@link ColumnOrRow}
3450
- *
3451
- * Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
3452
- * during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
3453
- * This means the views you pass to createAdjacentStack() may not render in the order given by the array.
3454
- * Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
3455
- *
3456
- * @function createAdjacentStack
3457
- * @instance
3458
- * @memberof ColumnOrRow
3459
- * @param views - List of identities or view creation options of the views to include in the stack
3460
- * @param options - Creation options.
3461
- * @returns The created TabStack
3462
- * @tutorial ColumnOrRow.createAdjacentStack
3463
- * @experimental
3464
- */
3465
3416
  /**
3466
3417
  * @internal
3467
3418
  */
@@ -9024,7 +8975,8 @@ declare type LayoutIdentity = Identity_5 & {
9024
8975
  };
9025
8976
 
9026
8977
  /**
9027
- * Generated when the window and all of its layout's views have either finished or failed navigation, once per layout.
8978
+ * Generated when the window is created, and all of its layout's views have either finished or failed
8979
+ * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
9028
8980
  * @interface
9029
8981
  */
9030
8982
  declare type LayoutInitializedEvent = BaseEvent_5 & {
@@ -9387,6 +9339,15 @@ declare abstract class LayoutNode {
9387
9339
  /**
9388
9340
  * Creates a new TabStack adjacent to the given TabStack or ColumnOrRow. Inputs can be new views to create, or existing views.
9389
9341
  *
9342
+ * Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
9343
+ * during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
9344
+ * This means the views you pass to createAdjacentStack() may not render in the order given by the array.
9345
+ * Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
9346
+ *
9347
+ * @param views The views that will populate the new TabStack.
9348
+ * @param options Additional options that control new TabStack creation.
9349
+ * @returns The newly-created TabStack.
9350
+ *
9390
9351
  * @example
9391
9352
  * ```js
9392
9353
  * if (!fin.me.isView) {
@@ -9421,12 +9382,15 @@ declare abstract class LayoutNode {
9421
9382
  * console.log(`A new TabStack created to the right has ${newStack.length} views in it`);
9422
9383
  *
9423
9384
  * ```
9385
+ * @experimental
9424
9386
  */
9425
9387
  createAdjacentStack: (views: OpenFin.PlatformViewCreationOptions[], options: {
9426
9388
  position?: OpenFin.LayoutPosition;
9427
9389
  }) => Promise<TabStack>;
9428
9390
  /**
9429
- * Retrieves the adjacent TabStacks of the given TabStack or ColumnOrRow
9391
+ * Retrieves the adjacent TabStacks of the given TabStack or ColumnOrRow.
9392
+ *
9393
+ * @param edge Edge whose adjacent TabStacks will be returned.
9430
9394
  *
9431
9395
  * @example
9432
9396
  * ```js
@@ -9446,6 +9410,7 @@ declare abstract class LayoutNode {
9446
9410
  * console.log(`The entity has ${rightStacks.length} stacks to the right, and ${leftStacks.length} stacks to the left`);
9447
9411
  *
9448
9412
  * ```
9413
+ * @experimental
9449
9414
  */
9450
9415
  getAdjacentStacks: (edge: OpenFin.LayoutPosition) => Promise<TabStack[]>;
9451
9416
  }
@@ -9540,6 +9505,9 @@ declare type LayoutOptions = {
9540
9505
  };
9541
9506
  };
9542
9507
 
9508
+ /**
9509
+ * Represents the position of an item in a layout relative to another.
9510
+ */
9543
9511
  declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
9544
9512
 
9545
9513
  /**
@@ -10266,7 +10234,7 @@ declare type MutableWindowOptions = {
10266
10234
  * Used by Workspace to store custom data. Overwriting or modifying this field may impact the functionality of Workspace
10267
10235
  */
10268
10236
  _internalWorkspaceData: any;
10269
- workspacePlatform: WorkspacePlatformOptions;
10237
+ workspacePlatform: unknown;
10270
10238
  };
10271
10239
 
10272
10240
  declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;
@@ -11813,6 +11781,17 @@ declare interface PlatformProvider {
11813
11781
  * @param callerIdentity
11814
11782
  */
11815
11783
  getInitialLayoutSnapshot(payload: undefined, callerIdentity: OpenFin.Identity): Promise<OpenFin.LayoutSnapshot | undefined>;
11784
+ /**
11785
+ * @experimental
11786
+ *
11787
+ * This API is called during the {@link PlatformProvider.getSnapshot()} call.
11788
+ * Gets the current state of a particular window and its views and returns an object that
11789
+ * can be added to the {@link OpenFin.Snapshot.windows} property. Override this function if
11790
+ * you wish to mutate each window snapshot during the {@link PlatformProvider.getSnapshot()} call
11791
+ * @param identity
11792
+ * @param callerIdentity
11793
+ */
11794
+ getWindowSnapshot(identity: OpenFin.Identity, callerIdentity: OpenFin.Identity): Promise<OpenFin.WindowCreationOptions>;
11816
11795
  /**
11817
11796
  * @experimental @internal
11818
11797
  *
@@ -11827,7 +11806,7 @@ declare interface PlatformProvider {
11827
11806
  */
11828
11807
  createViewsForLayout(payload: {
11829
11808
  layout: GoldenLayout.Config;
11830
- target?: OpenFin.Identity;
11809
+ target?: OpenFin.Identity | OpenFin.LayoutIdentity;
11831
11810
  }, callerIdentity: OpenFin.Identity): Promise<OpenFin.View>[];
11832
11811
  /**
11833
11812
  * **NOTE**: Internal use only. It is not recommended to manage the state of individual views.
@@ -15795,75 +15774,11 @@ declare interface TabDragListener extends EventEmitter_2 {
15795
15774
  contentItem: ContentItem;
15796
15775
  }
15797
15776
 
15798
- /**
15799
- * @typedef {string} LayoutPosition
15800
- * @summary Represents the position of an item in a layout relative to another. Possible values are 'top', 'bottom', 'left' and 'right'.
15801
- */
15802
- /**
15803
- * @typedef {object} StackCreationOptions
15804
- * @summary Stack creation options.
15805
- * @property {LayoutPosition} [position] - The position to create the new {@link TabStack} in, relative to the given adjacent {@link TabStack}. Defaults to 'right'.
15806
- */
15807
- /**
15808
- * @typedef {object} TabStack~AddViewOptions
15809
- * @summary Options to use when adding a view to a {@link TabStack}
15810
- * @property {number} [index] - Insertion index when adding the view. Defaults to 0.
15811
- */
15812
15777
  /**
15813
15778
  * A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
15814
15779
  */
15815
15780
  declare class TabStack extends LayoutNode {
15816
15781
  #private;
15817
- /**
15818
- * Determines if this {@link TabStack} is the top level content item in the current layout.
15819
- * @function isRoot
15820
- * @memberof TabStack
15821
- * @instance
15822
- * @tutorial TabStack.isRoot
15823
- * @returns Resolves true if this TabStack is the top level content item, or false if it is not.
15824
- */
15825
- /**
15826
- * Determines if this {@link TabStack} exists.
15827
- * @function exists
15828
- * @instance
15829
- * @memberof TabStack
15830
- * @tutorial TabStack.exists
15831
- * @returns Resolves true if this is the TabStack exists, or false if it has been destroyed.
15832
- */
15833
- /**
15834
- * Retrieves the parent {@link ColumnOrRow} of this {@link TabStack}, if one exists.
15835
- * @function getParent
15836
- * @instance
15837
- * @memberof TabStack
15838
- * @tutorial TabStack.getParent
15839
- * @returns is the root content item or does not exist.
15840
- */
15841
- /**
15842
- * Returns all the adjacent stacks that share an edge with the given {@link TabStack}.
15843
- * @function getAdjacentStacks
15844
- * @instance
15845
- * @memberof TabStack
15846
- * @param {LayoutPosition} edge - Edge to check for any adjacent stacks.
15847
- *
15848
- * @tutorial TabStack.getAdjacentStacks
15849
- */
15850
- /**
15851
- * Given a list of view creation options or references and a layout position, creates a {@link TabStack} adjacent to the current {@link TabStack}
15852
- *
15853
- * Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
15854
- * during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
15855
- * This means the views you pass to createAdjacentStack() may not render in the order given by the array.
15856
- * Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
15857
- *
15858
- * @function createAdjacentStack
15859
- * @instance
15860
- * @memberof TabStack
15861
- * @param views - List of identities or view creation options of the views to include in the stack
15862
- * @param options - Creation options.
15863
- * @returns The created TabStack.
15864
- * @tutorial TabStack.createAdjacentStack
15865
- * @experimental
15866
- */
15867
15782
  /** @internal */
15868
15783
  constructor(client: LayoutEntitiesClient, entityId: string);
15869
15784
  /**
@@ -1012,6 +1012,15 @@ class LayoutNode {
1012
1012
  /**
1013
1013
  * Creates a new TabStack adjacent to the given TabStack or ColumnOrRow. Inputs can be new views to create, or existing views.
1014
1014
  *
1015
+ * Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
1016
+ * during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
1017
+ * This means the views you pass to createAdjacentStack() may not render in the order given by the array.
1018
+ * Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
1019
+ *
1020
+ * @param views The views that will populate the new TabStack.
1021
+ * @param options Additional options that control new TabStack creation.
1022
+ * @returns The newly-created TabStack.
1023
+ *
1015
1024
  * @example
1016
1025
  * ```js
1017
1026
  * if (!fin.me.isView) {
@@ -1046,13 +1055,16 @@ class LayoutNode {
1046
1055
  * console.log(`A new TabStack created to the right has ${newStack.length} views in it`);
1047
1056
  *
1048
1057
  * ```
1058
+ * @experimental
1049
1059
  */
1050
1060
  this.createAdjacentStack = async (views, options) => {
1051
1061
  const entityId = await __classPrivateFieldGet$e(this, _LayoutNode_client, "f").createAdjacentStack(this.entityId, views, options);
1052
1062
  return LayoutNode.getEntity({ entityId, type: 'stack' }, __classPrivateFieldGet$e(this, _LayoutNode_client, "f"));
1053
1063
  };
1054
1064
  /**
1055
- * Retrieves the adjacent TabStacks of the given TabStack or ColumnOrRow
1065
+ * Retrieves the adjacent TabStacks of the given TabStack or ColumnOrRow.
1066
+ *
1067
+ * @param edge Edge whose adjacent TabStacks will be returned.
1056
1068
  *
1057
1069
  * @example
1058
1070
  * ```js
@@ -1072,6 +1084,7 @@ class LayoutNode {
1072
1084
  * console.log(`The entity has ${rightStacks.length} stacks to the right, and ${leftStacks.length} stacks to the left`);
1073
1085
  *
1074
1086
  * ```
1087
+ * @experimental
1075
1088
  */
1076
1089
  this.getAdjacentStacks = async (edge) => {
1077
1090
  const adjacentStacks = await __classPrivateFieldGet$e(this, _LayoutNode_client, "f").getAdjacentStacks({
@@ -1115,74 +1128,10 @@ LayoutNode.getEntity = (definition, client) => {
1115
1128
  throw new Error(`Unrecognised Layout Entity encountered ('${JSON.stringify(definition)})`);
1116
1129
  }
1117
1130
  };
1118
- /**
1119
- * @typedef {string} LayoutPosition
1120
- * @summary Represents the position of an item in a layout relative to another. Possible values are 'top', 'bottom', 'left' and 'right'.
1121
- */
1122
- /**
1123
- * @typedef {object} StackCreationOptions
1124
- * @summary Stack creation options.
1125
- * @property {LayoutPosition} [position] - The position to create the new {@link TabStack} in, relative to the given adjacent {@link TabStack}. Defaults to 'right'.
1126
- */
1127
- /**
1128
- * @typedef {object} TabStack~AddViewOptions
1129
- * @summary Options to use when adding a view to a {@link TabStack}
1130
- * @property {number} [index] - Insertion index when adding the view. Defaults to 0.
1131
- */
1132
1131
  /**
1133
1132
  * A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
1134
1133
  */
1135
1134
  class TabStack extends LayoutNode {
1136
- /**
1137
- * Determines if this {@link TabStack} is the top level content item in the current layout.
1138
- * @function isRoot
1139
- * @memberof TabStack
1140
- * @instance
1141
- * @tutorial TabStack.isRoot
1142
- * @returns Resolves true if this TabStack is the top level content item, or false if it is not.
1143
- */
1144
- /**
1145
- * Determines if this {@link TabStack} exists.
1146
- * @function exists
1147
- * @instance
1148
- * @memberof TabStack
1149
- * @tutorial TabStack.exists
1150
- * @returns Resolves true if this is the TabStack exists, or false if it has been destroyed.
1151
- */
1152
- /**
1153
- * Retrieves the parent {@link ColumnOrRow} of this {@link TabStack}, if one exists.
1154
- * @function getParent
1155
- * @instance
1156
- * @memberof TabStack
1157
- * @tutorial TabStack.getParent
1158
- * @returns is the root content item or does not exist.
1159
- */
1160
- /**
1161
- * Returns all the adjacent stacks that share an edge with the given {@link TabStack}.
1162
- * @function getAdjacentStacks
1163
- * @instance
1164
- * @memberof TabStack
1165
- * @param {LayoutPosition} edge - Edge to check for any adjacent stacks.
1166
- *
1167
- * @tutorial TabStack.getAdjacentStacks
1168
- */
1169
- /**
1170
- * Given a list of view creation options or references and a layout position, creates a {@link TabStack} adjacent to the current {@link TabStack}
1171
- *
1172
- * Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
1173
- * during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
1174
- * This means the views you pass to createAdjacentStack() may not render in the order given by the array.
1175
- * Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
1176
- *
1177
- * @function createAdjacentStack
1178
- * @instance
1179
- * @memberof TabStack
1180
- * @param views - List of identities or view creation options of the views to include in the stack
1181
- * @param options - Creation options.
1182
- * @returns The created TabStack.
1183
- * @tutorial TabStack.createAdjacentStack
1184
- * @experimental
1185
- */
1186
1135
  /** @internal */
1187
1136
  constructor(client, entityId) {
1188
1137
  super(client, entityId);
@@ -1315,57 +1264,6 @@ _TabStack_client = new WeakMap();
1315
1264
  * A ColumnOrRow is used to manage the state of Column and Rows within an OpenFin Layout.
1316
1265
  */
1317
1266
  class ColumnOrRow extends LayoutNode {
1318
- /**
1319
- * Determines if this {@link ColumnOrRow} is the top level content item in the current layout.
1320
- * @function isRoot
1321
- * @memberof ColumnOrRow
1322
- * @instance
1323
- * @tutorial ColumnOrRow.isRoot
1324
- * @returns Resolves true if this TabStack is the top level content item, or false if it is not.
1325
- */
1326
- /**
1327
- * Determines if this {@link ColumnOrRow} exists.
1328
- * @function exists
1329
- * @instance
1330
- * @memberof ColumnOrRow
1331
- * @tutorial ColumnOrRow.exists
1332
- * @returns Resolves true if the TabStack exists, or false if it has been destroyed.
1333
- */
1334
- /**
1335
- * Retrieves the parent {@link ColumnOrRow} of this {@link ColumnOrRow}, if one exists.
1336
- * @function getParent
1337
- * @instance
1338
- * @memberof ColumnOrRow
1339
- * @tutorial ColumnOrRow.getParent
1340
- * @returns Promise resolving with the {@link ColumnOrRow} that contains this item, or undefined if
1341
- * this {@link ColumnOrRow}does not exist or is the root content item.
1342
- */
1343
- /**
1344
- * Returns all the adjacent stacks that share an edge with the given {@link ColumnOrRow}.
1345
- * @function getAdjacentStacks
1346
- * @instance
1347
- * @memberof ColumnOrRow
1348
- * @param {LayoutPosition} edge - Edge to check for any adjacent stacks.
1349
- *
1350
- * @tutorial ColumnOrRow.getAdjacentStacks
1351
- */
1352
- /**
1353
- * Given a list of view creation options or references and a layout position, creates a {@link TabStack} adjacent to the given {@link ColumnOrRow}
1354
- *
1355
- * Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
1356
- * during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
1357
- * This means the views you pass to createAdjacentStack() may not render in the order given by the array.
1358
- * Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
1359
- *
1360
- * @function createAdjacentStack
1361
- * @instance
1362
- * @memberof ColumnOrRow
1363
- * @param views - List of identities or view creation options of the views to include in the stack
1364
- * @param options - Creation options.
1365
- * @returns The created TabStack
1366
- * @tutorial ColumnOrRow.createAdjacentStack
1367
- * @experimental
1368
- */
1369
1267
  /**
1370
1268
  * @internal
1371
1269
  */
@@ -1411,7 +1309,8 @@ var layout_constants = {};
1411
1309
  Object.defineProperty(layout_constants, "__esModule", { value: true });
1412
1310
  layout_constants.DEFAULT_LAYOUT_KEY = layout_constants.LAYOUT_CONTROLLER_ID = void 0;
1413
1311
  layout_constants.LAYOUT_CONTROLLER_ID = 'layout-entities';
1414
- layout_constants.DEFAULT_LAYOUT_KEY = 'default';
1312
+ // TODO: eventually export this somehow
1313
+ layout_constants.DEFAULT_LAYOUT_KEY = '__default__';
1415
1314
 
1416
1315
  var main = {};
1417
1316
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/node-adapter",
3
- "version": "34.78.56",
3
+ "version": "34.78.58",
4
4
  "description": "See README.md",
5
5
  "main": "out/node-adapter.js",
6
6
  "types": "out/node-adapter.d.ts",