@openfin/node-adapter 35.78.17 → 35.78.19

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.
@@ -8449,7 +8449,8 @@ declare type LayoutIdentity = Identity_5 & {
8449
8449
  };
8450
8450
 
8451
8451
  /**
8452
- * Generated when the window and all of its layout's views have either finished or failed navigation, once per layout.
8452
+ * Generated when the window is created, and all of its layout's views have either finished or failed
8453
+ * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
8453
8454
  * @interface
8454
8455
  */
8455
8456
  declare type LayoutInitializedEvent = BaseEvent_5 & {
@@ -11024,6 +11025,17 @@ declare interface PlatformProvider {
11024
11025
  */
11025
11026
  getSnapshot(payload: undefined, identity: OpenFin.Identity): Promise<OpenFin.Snapshot>;
11026
11027
  /* Excluded from this release type: getInitialLayoutSnapshot */
11028
+ /**
11029
+ * @experimental
11030
+ *
11031
+ * This API is called during the {@link PlatformProvider.getSnapshot()} call.
11032
+ * Get's the current state of a particular window and its views and returns an object that
11033
+ * can be added to the {@link OpenFin.Snapshot.windows} property. Override this function if
11034
+ * you wish to mutate each window snapshot during the {@link PlatformProvider.getSnapshot()} call
11035
+ * @param identity
11036
+ * @param callerIdentity
11037
+ */
11038
+ getWindowSnapshot(identity: OpenFin.Identity, callerIdentity: OpenFin.Identity): Promise<OpenFin.WindowCreationOptions>;
11027
11039
  /* Excluded from this release type: createViewsForLayout */
11028
11040
  /* Excluded from this release type: getViewSnapshot */
11029
11041
  /**
@@ -8449,7 +8449,8 @@ declare type LayoutIdentity = Identity_5 & {
8449
8449
  };
8450
8450
 
8451
8451
  /**
8452
- * Generated when the window and all of its layout's views have either finished or failed navigation, once per layout.
8452
+ * Generated when the window is created, and all of its layout's views have either finished or failed
8453
+ * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
8453
8454
  * @interface
8454
8455
  */
8455
8456
  declare type LayoutInitializedEvent = BaseEvent_5 & {
@@ -11024,6 +11025,17 @@ declare interface PlatformProvider {
11024
11025
  */
11025
11026
  getSnapshot(payload: undefined, identity: OpenFin.Identity): Promise<OpenFin.Snapshot>;
11026
11027
  /* Excluded from this release type: getInitialLayoutSnapshot */
11028
+ /**
11029
+ * @experimental
11030
+ *
11031
+ * This API is called during the {@link PlatformProvider.getSnapshot()} call.
11032
+ * Get's the current state of a particular window and its views and returns an object that
11033
+ * can be added to the {@link OpenFin.Snapshot.windows} property. Override this function if
11034
+ * you wish to mutate each window snapshot during the {@link PlatformProvider.getSnapshot()} call
11035
+ * @param identity
11036
+ * @param callerIdentity
11037
+ */
11038
+ getWindowSnapshot(identity: OpenFin.Identity, callerIdentity: OpenFin.Identity): Promise<OpenFin.WindowCreationOptions>;
11027
11039
  /* Excluded from this release type: createViewsForLayout */
11028
11040
  /* Excluded from this release type: getViewSnapshot */
11029
11041
  /**
@@ -8449,7 +8449,8 @@ declare type LayoutIdentity = Identity_5 & {
8449
8449
  };
8450
8450
 
8451
8451
  /**
8452
- * Generated when the window and all of its layout's views have either finished or failed navigation, once per layout.
8452
+ * Generated when the window is created, and all of its layout's views have either finished or failed
8453
+ * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
8453
8454
  * @interface
8454
8455
  */
8455
8456
  declare type LayoutInitializedEvent = BaseEvent_5 & {
@@ -11024,6 +11025,17 @@ declare interface PlatformProvider {
11024
11025
  */
11025
11026
  getSnapshot(payload: undefined, identity: OpenFin.Identity): Promise<OpenFin.Snapshot>;
11026
11027
  /* Excluded from this release type: getInitialLayoutSnapshot */
11028
+ /**
11029
+ * @experimental
11030
+ *
11031
+ * This API is called during the {@link PlatformProvider.getSnapshot()} call.
11032
+ * Get's the current state of a particular window and its views and returns an object that
11033
+ * can be added to the {@link OpenFin.Snapshot.windows} property. Override this function if
11034
+ * you wish to mutate each window snapshot during the {@link PlatformProvider.getSnapshot()} call
11035
+ * @param identity
11036
+ * @param callerIdentity
11037
+ */
11038
+ getWindowSnapshot(identity: OpenFin.Identity, callerIdentity: OpenFin.Identity): Promise<OpenFin.WindowCreationOptions>;
11027
11039
  /* Excluded from this release type: createViewsForLayout */
11028
11040
  /* Excluded from this release type: getViewSnapshot */
11029
11041
  /**
@@ -8573,7 +8573,8 @@ declare type LayoutIdentity = Identity_5 & {
8573
8573
  };
8574
8574
 
8575
8575
  /**
8576
- * Generated when the window and all of its layout's views have either finished or failed navigation, once per layout.
8576
+ * Generated when the window is created, and all of its layout's views have either finished or failed
8577
+ * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
8577
8578
  * @interface
8578
8579
  */
8579
8580
  declare type LayoutInitializedEvent = BaseEvent_5 & {
@@ -11378,6 +11379,17 @@ declare interface PlatformProvider {
11378
11379
  * @param callerIdentity
11379
11380
  */
11380
11381
  getInitialLayoutSnapshot(payload: undefined, callerIdentity: OpenFin.Identity): Promise<OpenFin.LayoutSnapshot | undefined>;
11382
+ /**
11383
+ * @experimental
11384
+ *
11385
+ * This API is called during the {@link PlatformProvider.getSnapshot()} call.
11386
+ * Get's the current state of a particular window and its views and returns an object that
11387
+ * can be added to the {@link OpenFin.Snapshot.windows} property. Override this function if
11388
+ * you wish to mutate each window snapshot during the {@link PlatformProvider.getSnapshot()} call
11389
+ * @param identity
11390
+ * @param callerIdentity
11391
+ */
11392
+ getWindowSnapshot(identity: OpenFin.Identity, callerIdentity: OpenFin.Identity): Promise<OpenFin.WindowCreationOptions>;
11381
11393
  /**
11382
11394
  * @experimental @internal
11383
11395
  *
@@ -11392,7 +11404,7 @@ declare interface PlatformProvider {
11392
11404
  */
11393
11405
  createViewsForLayout(payload: {
11394
11406
  layout: GoldenLayout.Config;
11395
- target?: OpenFin.Identity;
11407
+ target?: OpenFin.Identity | OpenFin.LayoutIdentity;
11396
11408
  }, callerIdentity: OpenFin.Identity): Promise<OpenFin.View>[];
11397
11409
  /**
11398
11410
  * **NOTE**: Internal use only. It is not recommended to manage the state of individual views.
@@ -1309,7 +1309,8 @@ var layout_constants = {};
1309
1309
  Object.defineProperty(layout_constants, "__esModule", { value: true });
1310
1310
  layout_constants.DEFAULT_LAYOUT_KEY = layout_constants.LAYOUT_CONTROLLER_ID = void 0;
1311
1311
  layout_constants.LAYOUT_CONTROLLER_ID = 'layout-entities';
1312
- layout_constants.DEFAULT_LAYOUT_KEY = 'default';
1312
+ // TODO: eventually export this somehow
1313
+ layout_constants.DEFAULT_LAYOUT_KEY = '__default__';
1313
1314
 
1314
1315
  var main = {};
1315
1316
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/node-adapter",
3
- "version": "35.78.17",
3
+ "version": "35.78.19",
4
4
  "description": "See README.md",
5
5
  "main": "out/node-adapter.js",
6
6
  "types": "out/node-adapter.d.ts",