@openfin/core 35.78.17 → 35.78.18

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.
@@ -8439,7 +8439,8 @@ declare type LayoutIdentity = Identity_5 & {
8439
8439
  };
8440
8440
 
8441
8441
  /**
8442
- * Generated when the window and all of its layout's views have either finished or failed navigation, once per layout.
8442
+ * Generated when the window is created, and all of its layout's views have either finished or failed
8443
+ * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
8443
8444
  * @interface
8444
8445
  */
8445
8446
  declare type LayoutInitializedEvent = BaseEvent_5 & {
@@ -11014,6 +11015,17 @@ declare interface PlatformProvider {
11014
11015
  */
11015
11016
  getSnapshot(payload: undefined, identity: OpenFin_2.Identity): Promise<OpenFin_2.Snapshot>;
11016
11017
  /* Excluded from this release type: getInitialLayoutSnapshot */
11018
+ /**
11019
+ * @experimental
11020
+ *
11021
+ * This API is called during the {@link PlatformProvider.getSnapshot()} call.
11022
+ * Get's the current state of a particular window and its views and returns an object that
11023
+ * can be added to the {@link OpenFin.Snapshot.windows} property. Override this function if
11024
+ * you wish to mutate each window snapshot during the {@link PlatformProvider.getSnapshot()} call
11025
+ * @param identity
11026
+ * @param callerIdentity
11027
+ */
11028
+ getWindowSnapshot(identity: OpenFin_2.Identity, callerIdentity: OpenFin_2.Identity): Promise<OpenFin_2.WindowCreationOptions>;
11017
11029
  /* Excluded from this release type: createViewsForLayout */
11018
11030
  /* Excluded from this release type: getViewSnapshot */
11019
11031
  /**
@@ -8439,7 +8439,8 @@ declare type LayoutIdentity = Identity_5 & {
8439
8439
  };
8440
8440
 
8441
8441
  /**
8442
- * Generated when the window and all of its layout's views have either finished or failed navigation, once per layout.
8442
+ * Generated when the window is created, and all of its layout's views have either finished or failed
8443
+ * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
8443
8444
  * @interface
8444
8445
  */
8445
8446
  declare type LayoutInitializedEvent = BaseEvent_5 & {
@@ -11014,6 +11015,17 @@ declare interface PlatformProvider {
11014
11015
  */
11015
11016
  getSnapshot(payload: undefined, identity: OpenFin_2.Identity): Promise<OpenFin_2.Snapshot>;
11016
11017
  /* Excluded from this release type: getInitialLayoutSnapshot */
11018
+ /**
11019
+ * @experimental
11020
+ *
11021
+ * This API is called during the {@link PlatformProvider.getSnapshot()} call.
11022
+ * Get's the current state of a particular window and its views and returns an object that
11023
+ * can be added to the {@link OpenFin.Snapshot.windows} property. Override this function if
11024
+ * you wish to mutate each window snapshot during the {@link PlatformProvider.getSnapshot()} call
11025
+ * @param identity
11026
+ * @param callerIdentity
11027
+ */
11028
+ getWindowSnapshot(identity: OpenFin_2.Identity, callerIdentity: OpenFin_2.Identity): Promise<OpenFin_2.WindowCreationOptions>;
11017
11029
  /* Excluded from this release type: createViewsForLayout */
11018
11030
  /* Excluded from this release type: getViewSnapshot */
11019
11031
  /**
@@ -8439,7 +8439,8 @@ declare type LayoutIdentity = Identity_5 & {
8439
8439
  };
8440
8440
 
8441
8441
  /**
8442
- * Generated when the window and all of its layout's views have either finished or failed navigation, once per layout.
8442
+ * Generated when the window is created, and all of its layout's views have either finished or failed
8443
+ * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
8443
8444
  * @interface
8444
8445
  */
8445
8446
  declare type LayoutInitializedEvent = BaseEvent_5 & {
@@ -11014,6 +11015,17 @@ declare interface PlatformProvider {
11014
11015
  */
11015
11016
  getSnapshot(payload: undefined, identity: OpenFin_2.Identity): Promise<OpenFin_2.Snapshot>;
11016
11017
  /* Excluded from this release type: getInitialLayoutSnapshot */
11018
+ /**
11019
+ * @experimental
11020
+ *
11021
+ * This API is called during the {@link PlatformProvider.getSnapshot()} call.
11022
+ * Get's the current state of a particular window and its views and returns an object that
11023
+ * can be added to the {@link OpenFin.Snapshot.windows} property. Override this function if
11024
+ * you wish to mutate each window snapshot during the {@link PlatformProvider.getSnapshot()} call
11025
+ * @param identity
11026
+ * @param callerIdentity
11027
+ */
11028
+ getWindowSnapshot(identity: OpenFin_2.Identity, callerIdentity: OpenFin_2.Identity): Promise<OpenFin_2.WindowCreationOptions>;
11017
11029
  /* Excluded from this release type: createViewsForLayout */
11018
11030
  /* Excluded from this release type: getViewSnapshot */
11019
11031
  /**
package/out/mock.d.ts CHANGED
@@ -8541,7 +8541,8 @@ declare type LayoutIdentity = Identity_5 & {
8541
8541
  };
8542
8542
 
8543
8543
  /**
8544
- * Generated when the window and all of its layout's views have either finished or failed navigation, once per layout.
8544
+ * Generated when the window is created, and all of its layout's views have either finished or failed
8545
+ * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
8545
8546
  * @interface
8546
8547
  */
8547
8548
  declare type LayoutInitializedEvent = BaseEvent_5 & {
@@ -11346,6 +11347,17 @@ declare interface PlatformProvider {
11346
11347
  * @param callerIdentity
11347
11348
  */
11348
11349
  getInitialLayoutSnapshot(payload: undefined, callerIdentity: OpenFin_2.Identity): Promise<OpenFin_2.LayoutSnapshot | undefined>;
11350
+ /**
11351
+ * @experimental
11352
+ *
11353
+ * This API is called during the {@link PlatformProvider.getSnapshot()} call.
11354
+ * Get's the current state of a particular window and its views and returns an object that
11355
+ * can be added to the {@link OpenFin.Snapshot.windows} property. Override this function if
11356
+ * you wish to mutate each window snapshot during the {@link PlatformProvider.getSnapshot()} call
11357
+ * @param identity
11358
+ * @param callerIdentity
11359
+ */
11360
+ getWindowSnapshot(identity: OpenFin_2.Identity, callerIdentity: OpenFin_2.Identity): Promise<OpenFin_2.WindowCreationOptions>;
11349
11361
  /**
11350
11362
  * @experimental @internal
11351
11363
  *
@@ -11360,7 +11372,7 @@ declare interface PlatformProvider {
11360
11372
  */
11361
11373
  createViewsForLayout(payload: {
11362
11374
  layout: GoldenLayout.Config;
11363
- target?: OpenFin_2.Identity;
11375
+ target?: OpenFin_2.Identity | OpenFin_2.LayoutIdentity;
11364
11376
  }, callerIdentity: OpenFin_2.Identity): Promise<OpenFin_2.View>[];
11365
11377
  /**
11366
11378
  * **NOTE**: Internal use only. It is not recommended to manage the state of individual views.
package/out/mock.js CHANGED
@@ -1529,7 +1529,8 @@ var layout_constants = {};
1529
1529
  Object.defineProperty(layout_constants, "__esModule", { value: true });
1530
1530
  layout_constants.DEFAULT_LAYOUT_KEY = layout_constants.LAYOUT_CONTROLLER_ID = void 0;
1531
1531
  layout_constants.LAYOUT_CONTROLLER_ID = 'layout-entities';
1532
- layout_constants.DEFAULT_LAYOUT_KEY = 'default';
1532
+ // TODO: eventually export this somehow
1533
+ layout_constants.DEFAULT_LAYOUT_KEY = '__default__';
1533
1534
 
1534
1535
  var main = {};
1535
1536
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/core",
3
- "version": "35.78.17",
3
+ "version": "35.78.18",
4
4
  "description": "The core renderer entry point of OpenFin",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "main": "out/mock.js",