@openfin/core 36.79.18 → 36.80.1

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.
@@ -966,7 +966,7 @@ declare type ApplicationIdentity_2 = {
966
966
  * @interface
967
967
  */
968
968
  declare type ApplicationInfo = {
969
- initialOptions: ApplicationCreationOptions;
969
+ initialOptions: ApplicationCreationOptions | PlatformOptions;
970
970
  launchMode: string;
971
971
  manifest: Manifest & {
972
972
  [key: string]: any;
@@ -1280,6 +1280,10 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1280
1280
  * Define the {@link https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads file download rules} and domain-based api injection rules.
1281
1281
  */
1282
1282
  domainSettings: DomainSettings;
1283
+ /**
1284
+ * The permissions for secured APIs.
1285
+ */
1286
+ permissions?: Partial<Permissions_2>;
1283
1287
  /**
1284
1288
  * @defaultValue false
1285
1289
  *
@@ -3835,6 +3839,10 @@ declare type ConstWindowOptions = {
3835
3839
  * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
3836
3840
  */
3837
3841
  viewVisibility?: ViewVisibilityOptions;
3842
+ /**
3843
+ * Controls whether an option is inherited from the parent application. The option is set as part of the window options for the parent application in either the {@link Manifest.startup_app} or {@link Manifest.platform} properties in the manifest or in {@link ApplicationOptions.mainWindowOptions} when calling {@link Application.ApplicationModule.start Application.start}. Use { [option]: false } to disable a specific [option]. All inheritable properties will be inherited by default if omitted.
3844
+ */
3845
+ inheritance?: Partial<InheritableOptions>;
3838
3846
  };
3839
3847
 
3840
3848
  declare interface Container extends EventEmitter_2 {
@@ -5889,6 +5897,8 @@ declare class _Frame extends EmitterBase<OpenFin_2.FrameEvent> {
5889
5897
  * Returns a frame info object representing the window that the referenced iframe is
5890
5898
  * currently embedded in.
5891
5899
  *
5900
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
5901
+ *
5892
5902
  * @example
5893
5903
  * ```js
5894
5904
  * async function getParentWindow() {
@@ -6734,6 +6744,13 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
6734
6744
  metadata?: MetadataType;
6735
6745
  };
6736
6746
 
6747
+ declare type InheritableOptions = {
6748
+ customContext: boolean;
6749
+ customData: boolean;
6750
+ icon: boolean;
6751
+ preloadScripts: boolean;
6752
+ };
6753
+
6737
6754
  /**
6738
6755
  * Generated when an application has initialized.
6739
6756
  * @interface
@@ -8335,6 +8352,7 @@ declare type LaunchExternalProcessRule = {
8335
8352
  */
8336
8353
  declare type LaunchIntoPlatformPayload = {
8337
8354
  manifest: any;
8355
+ manifestUrl?: string;
8338
8356
  };
8339
8357
 
8340
8358
  /**
@@ -9965,6 +9983,7 @@ declare namespace OpenFin_2 {
9965
9983
  WindowState,
9966
9984
  AutoplayPolicyOptions,
9967
9985
  ConstWindowOptions,
9986
+ InheritableOptions,
9968
9987
  MutableWindowOptions,
9969
9988
  WorkspacePlatformOptions,
9970
9989
  WebRequestHeader,
@@ -11202,9 +11221,13 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11202
11221
  */
11203
11222
  providerUrl?: string;
11204
11223
  /**
11205
- * The permissions for secured APIs.
11224
+ * @defaultValue true
11225
+ *
11226
+ * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11227
+ *
11228
+ * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11206
11229
  */
11207
- permissions?: Partial<Permissions_2>;
11230
+ allowLaunchIntoPlatform?: boolean;
11208
11231
  };
11209
11232
 
11210
11233
  /**
@@ -11964,7 +11987,7 @@ declare type PreloadScriptInfoRunning = {
11964
11987
  * @interface
11965
11988
  */
11966
11989
  declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent & {
11967
- type: 'preload-script-state-changed';
11990
+ type: 'preload-scripts-state-changed';
11968
11991
  };
11969
11992
 
11970
11993
  /**
@@ -11981,7 +12004,7 @@ declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
11981
12004
  * @interface
11982
12005
  */
11983
12006
  declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent & {
11984
- type: 'preload-script-state-changing';
12007
+ type: 'preload-scripts-state-changing';
11985
12008
  };
11986
12009
 
11987
12010
  declare type PresetLayoutOptions = OpenFin_2.PresetLayoutOptions;
@@ -966,7 +966,7 @@ declare type ApplicationIdentity_2 = {
966
966
  * @interface
967
967
  */
968
968
  declare type ApplicationInfo = {
969
- initialOptions: ApplicationCreationOptions;
969
+ initialOptions: ApplicationCreationOptions | PlatformOptions;
970
970
  launchMode: string;
971
971
  manifest: Manifest & {
972
972
  [key: string]: any;
@@ -1280,6 +1280,10 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1280
1280
  * Define the {@link https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads file download rules} and domain-based api injection rules.
1281
1281
  */
1282
1282
  domainSettings: DomainSettings;
1283
+ /**
1284
+ * The permissions for secured APIs.
1285
+ */
1286
+ permissions?: Partial<Permissions_2>;
1283
1287
  /**
1284
1288
  * @defaultValue false
1285
1289
  *
@@ -3835,6 +3839,10 @@ declare type ConstWindowOptions = {
3835
3839
  * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
3836
3840
  */
3837
3841
  viewVisibility?: ViewVisibilityOptions;
3842
+ /**
3843
+ * Controls whether an option is inherited from the parent application. The option is set as part of the window options for the parent application in either the {@link Manifest.startup_app} or {@link Manifest.platform} properties in the manifest or in {@link ApplicationOptions.mainWindowOptions} when calling {@link Application.ApplicationModule.start Application.start}. Use { [option]: false } to disable a specific [option]. All inheritable properties will be inherited by default if omitted.
3844
+ */
3845
+ inheritance?: Partial<InheritableOptions>;
3838
3846
  };
3839
3847
 
3840
3848
  declare interface Container extends EventEmitter_2 {
@@ -5889,6 +5897,8 @@ declare class _Frame extends EmitterBase<OpenFin_2.FrameEvent> {
5889
5897
  * Returns a frame info object representing the window that the referenced iframe is
5890
5898
  * currently embedded in.
5891
5899
  *
5900
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
5901
+ *
5892
5902
  * @example
5893
5903
  * ```js
5894
5904
  * async function getParentWindow() {
@@ -6734,6 +6744,13 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
6734
6744
  metadata?: MetadataType;
6735
6745
  };
6736
6746
 
6747
+ declare type InheritableOptions = {
6748
+ customContext: boolean;
6749
+ customData: boolean;
6750
+ icon: boolean;
6751
+ preloadScripts: boolean;
6752
+ };
6753
+
6737
6754
  /**
6738
6755
  * Generated when an application has initialized.
6739
6756
  * @interface
@@ -8335,6 +8352,7 @@ declare type LaunchExternalProcessRule = {
8335
8352
  */
8336
8353
  declare type LaunchIntoPlatformPayload = {
8337
8354
  manifest: any;
8355
+ manifestUrl?: string;
8338
8356
  };
8339
8357
 
8340
8358
  /**
@@ -9965,6 +9983,7 @@ declare namespace OpenFin_2 {
9965
9983
  WindowState,
9966
9984
  AutoplayPolicyOptions,
9967
9985
  ConstWindowOptions,
9986
+ InheritableOptions,
9968
9987
  MutableWindowOptions,
9969
9988
  WorkspacePlatformOptions,
9970
9989
  WebRequestHeader,
@@ -11202,9 +11221,13 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11202
11221
  */
11203
11222
  providerUrl?: string;
11204
11223
  /**
11205
- * The permissions for secured APIs.
11224
+ * @defaultValue true
11225
+ *
11226
+ * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11227
+ *
11228
+ * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11206
11229
  */
11207
- permissions?: Partial<Permissions_2>;
11230
+ allowLaunchIntoPlatform?: boolean;
11208
11231
  };
11209
11232
 
11210
11233
  /**
@@ -11964,7 +11987,7 @@ declare type PreloadScriptInfoRunning = {
11964
11987
  * @interface
11965
11988
  */
11966
11989
  declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent & {
11967
- type: 'preload-script-state-changed';
11990
+ type: 'preload-scripts-state-changed';
11968
11991
  };
11969
11992
 
11970
11993
  /**
@@ -11981,7 +12004,7 @@ declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
11981
12004
  * @interface
11982
12005
  */
11983
12006
  declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent & {
11984
- type: 'preload-script-state-changing';
12007
+ type: 'preload-scripts-state-changing';
11985
12008
  };
11986
12009
 
11987
12010
  declare type PresetLayoutOptions = OpenFin_2.PresetLayoutOptions;
@@ -966,7 +966,7 @@ declare type ApplicationIdentity_2 = {
966
966
  * @interface
967
967
  */
968
968
  declare type ApplicationInfo = {
969
- initialOptions: ApplicationCreationOptions;
969
+ initialOptions: ApplicationCreationOptions | PlatformOptions;
970
970
  launchMode: string;
971
971
  manifest: Manifest & {
972
972
  [key: string]: any;
@@ -1280,6 +1280,10 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1280
1280
  * Define the {@link https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads file download rules} and domain-based api injection rules.
1281
1281
  */
1282
1282
  domainSettings: DomainSettings;
1283
+ /**
1284
+ * The permissions for secured APIs.
1285
+ */
1286
+ permissions?: Partial<Permissions_2>;
1283
1287
  /**
1284
1288
  * @defaultValue false
1285
1289
  *
@@ -3835,6 +3839,10 @@ declare type ConstWindowOptions = {
3835
3839
  * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
3836
3840
  */
3837
3841
  viewVisibility?: ViewVisibilityOptions;
3842
+ /**
3843
+ * Controls whether an option is inherited from the parent application. The option is set as part of the window options for the parent application in either the {@link Manifest.startup_app} or {@link Manifest.platform} properties in the manifest or in {@link ApplicationOptions.mainWindowOptions} when calling {@link Application.ApplicationModule.start Application.start}. Use { [option]: false } to disable a specific [option]. All inheritable properties will be inherited by default if omitted.
3844
+ */
3845
+ inheritance?: Partial<InheritableOptions>;
3838
3846
  };
3839
3847
 
3840
3848
  declare interface Container extends EventEmitter_2 {
@@ -5889,6 +5897,8 @@ declare class _Frame extends EmitterBase<OpenFin_2.FrameEvent> {
5889
5897
  * Returns a frame info object representing the window that the referenced iframe is
5890
5898
  * currently embedded in.
5891
5899
  *
5900
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
5901
+ *
5892
5902
  * @example
5893
5903
  * ```js
5894
5904
  * async function getParentWindow() {
@@ -6734,6 +6744,13 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
6734
6744
  metadata?: MetadataType;
6735
6745
  };
6736
6746
 
6747
+ declare type InheritableOptions = {
6748
+ customContext: boolean;
6749
+ customData: boolean;
6750
+ icon: boolean;
6751
+ preloadScripts: boolean;
6752
+ };
6753
+
6737
6754
  /**
6738
6755
  * Generated when an application has initialized.
6739
6756
  * @interface
@@ -8335,6 +8352,7 @@ declare type LaunchExternalProcessRule = {
8335
8352
  */
8336
8353
  declare type LaunchIntoPlatformPayload = {
8337
8354
  manifest: any;
8355
+ manifestUrl?: string;
8338
8356
  };
8339
8357
 
8340
8358
  /**
@@ -9965,6 +9983,7 @@ declare namespace OpenFin_2 {
9965
9983
  WindowState,
9966
9984
  AutoplayPolicyOptions,
9967
9985
  ConstWindowOptions,
9986
+ InheritableOptions,
9968
9987
  MutableWindowOptions,
9969
9988
  WorkspacePlatformOptions,
9970
9989
  WebRequestHeader,
@@ -11202,9 +11221,13 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11202
11221
  */
11203
11222
  providerUrl?: string;
11204
11223
  /**
11205
- * The permissions for secured APIs.
11224
+ * @defaultValue true
11225
+ *
11226
+ * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11227
+ *
11228
+ * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11206
11229
  */
11207
- permissions?: Partial<Permissions_2>;
11230
+ allowLaunchIntoPlatform?: boolean;
11208
11231
  };
11209
11232
 
11210
11233
  /**
@@ -11964,7 +11987,7 @@ declare type PreloadScriptInfoRunning = {
11964
11987
  * @interface
11965
11988
  */
11966
11989
  declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent & {
11967
- type: 'preload-script-state-changed';
11990
+ type: 'preload-scripts-state-changed';
11968
11991
  };
11969
11992
 
11970
11993
  /**
@@ -11981,7 +12004,7 @@ declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
11981
12004
  * @interface
11982
12005
  */
11983
12006
  declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent & {
11984
- type: 'preload-script-state-changing';
12007
+ type: 'preload-scripts-state-changing';
11985
12008
  };
11986
12009
 
11987
12010
  declare type PresetLayoutOptions = OpenFin_2.PresetLayoutOptions;
package/out/mock.d.ts CHANGED
@@ -972,7 +972,7 @@ declare type ApplicationIdentity_2 = {
972
972
  * @interface
973
973
  */
974
974
  declare type ApplicationInfo = {
975
- initialOptions: ApplicationCreationOptions;
975
+ initialOptions: ApplicationCreationOptions | PlatformOptions;
976
976
  launchMode: string;
977
977
  manifest: Manifest & {
978
978
  [key: string]: any;
@@ -1286,6 +1286,10 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1286
1286
  * Define the {@link https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads file download rules} and domain-based api injection rules.
1287
1287
  */
1288
1288
  domainSettings: DomainSettings;
1289
+ /**
1290
+ * The permissions for secured APIs.
1291
+ */
1292
+ permissions?: Partial<Permissions_2>;
1289
1293
  /**
1290
1294
  * @defaultValue false
1291
1295
  *
@@ -3890,6 +3894,10 @@ declare type ConstWindowOptions = {
3890
3894
  * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
3891
3895
  */
3892
3896
  viewVisibility?: ViewVisibilityOptions;
3897
+ /**
3898
+ * Controls whether an option is inherited from the parent application. The option is set as part of the window options for the parent application in either the {@link Manifest.startup_app} or {@link Manifest.platform} properties in the manifest or in {@link ApplicationOptions.mainWindowOptions} when calling {@link Application.ApplicationModule.start Application.start}. Use { [option]: false } to disable a specific [option]. All inheritable properties will be inherited by default if omitted.
3899
+ */
3900
+ inheritance?: Partial<InheritableOptions>;
3893
3901
  };
3894
3902
 
3895
3903
  declare interface Container extends EventEmitter_2 {
@@ -5973,6 +5981,8 @@ declare class _Frame extends EmitterBase<OpenFin_2.FrameEvent> {
5973
5981
  * Returns a frame info object representing the window that the referenced iframe is
5974
5982
  * currently embedded in.
5975
5983
  *
5984
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
5985
+ *
5976
5986
  * @example
5977
5987
  * ```js
5978
5988
  * async function getParentWindow() {
@@ -6824,6 +6834,13 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
6824
6834
  metadata?: MetadataType;
6825
6835
  };
6826
6836
 
6837
+ declare type InheritableOptions = {
6838
+ customContext: boolean;
6839
+ customData: boolean;
6840
+ icon: boolean;
6841
+ preloadScripts: boolean;
6842
+ };
6843
+
6827
6844
  /**
6828
6845
  * Generated when an application has initialized.
6829
6846
  * @interface
@@ -8448,6 +8465,7 @@ declare type LaunchExternalProcessRule = {
8448
8465
  */
8449
8466
  declare type LaunchIntoPlatformPayload = {
8450
8467
  manifest: any;
8468
+ manifestUrl?: string;
8451
8469
  };
8452
8470
 
8453
8471
  /**
@@ -10276,6 +10294,7 @@ declare namespace OpenFin_2 {
10276
10294
  WindowState,
10277
10295
  AutoplayPolicyOptions,
10278
10296
  ConstWindowOptions,
10297
+ InheritableOptions,
10279
10298
  MutableWindowOptions,
10280
10299
  WorkspacePlatformOptions,
10281
10300
  WebRequestHeader,
@@ -11546,9 +11565,13 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11546
11565
  */
11547
11566
  providerUrl?: string;
11548
11567
  /**
11549
- * The permissions for secured APIs.
11568
+ * @defaultValue true
11569
+ *
11570
+ * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11571
+ *
11572
+ * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11550
11573
  */
11551
- permissions?: Partial<Permissions_2>;
11574
+ allowLaunchIntoPlatform?: boolean;
11552
11575
  };
11553
11576
 
11554
11577
  /**
@@ -12353,7 +12376,7 @@ declare type PreloadScriptInfoRunning = {
12353
12376
  * @interface
12354
12377
  */
12355
12378
  declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent & {
12356
- type: 'preload-script-state-changed';
12379
+ type: 'preload-scripts-state-changed';
12357
12380
  };
12358
12381
 
12359
12382
  /**
@@ -12370,7 +12393,7 @@ declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
12370
12393
  * @interface
12371
12394
  */
12372
12395
  declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent & {
12373
- type: 'preload-script-state-changing';
12396
+ type: 'preload-scripts-state-changing';
12374
12397
  };
12375
12398
 
12376
12399
  declare type PresetLayoutOptions = OpenFin_2.PresetLayoutOptions;
package/out/mock.js CHANGED
@@ -10451,6 +10451,8 @@ class _Frame extends base_1$a.EmitterBase {
10451
10451
  * Returns a frame info object representing the window that the referenced iframe is
10452
10452
  * currently embedded in.
10453
10453
  *
10454
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
10455
+ *
10454
10456
  * @example
10455
10457
  * ```js
10456
10458
  * async function getParentWindow() {
@@ -11379,12 +11381,12 @@ class Platform extends base_1$7.EmitterBase {
11379
11381
  * @experimental
11380
11382
  */
11381
11383
  async launchContentManifest(manifestUrl) {
11382
- this.wire.sendAction('platform-launch-content-manifest', this.identity).catch((e) => {
11384
+ this.wire.sendAction('platform-launch-content-manifest', this.identity).catch(() => {
11383
11385
  // don't expose
11384
11386
  });
11385
11387
  const client = await this.getClient();
11386
11388
  const manifest = await this.fetchManifest(manifestUrl);
11387
- client.dispatch('launch-into-platform', { manifest });
11389
+ client.dispatch('launch-into-platform', { manifest, manifestUrl });
11388
11390
  return this;
11389
11391
  }
11390
11392
  /**
@@ -12049,7 +12051,7 @@ class LayoutModule extends base_1$5.Base {
12049
12051
  return this.wrapSync(this.fin.me.identity);
12050
12052
  };
12051
12053
  _LayoutModule_getLayoutManagerSpy.set(this, (layoutIdentity, layoutManager) => {
12052
- const msg = '[Layout] You are using a deprecated property `layoutManager` - it will be removed in v39.';
12054
+ const msg = '[Layout] You are using a deprecated property `layoutManager` - it will throw if you access it starting in v37.';
12053
12055
  const managerProxy = new Proxy(layoutManager, {
12054
12056
  get(target, key) {
12055
12057
  console.warn(`[Layout-mgr-proxy] accessing ${key.toString()}`);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/core",
3
- "version": "36.79.18",
3
+ "version": "36.80.1",
4
4
  "description": "The core renderer entry point of OpenFin",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "main": "out/mock.js",