@openfin/node-adapter 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
  *
@@ -3839,6 +3843,10 @@ declare type ConstWindowOptions = {
3839
3843
  * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
3840
3844
  */
3841
3845
  viewVisibility?: ViewVisibilityOptions;
3846
+ /**
3847
+ * 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.
3848
+ */
3849
+ inheritance?: Partial<InheritableOptions>;
3842
3850
  };
3843
3851
 
3844
3852
  declare interface Container extends EventEmitter_2 {
@@ -5897,6 +5905,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
5897
5905
  * Returns a frame info object representing the window that the referenced iframe is
5898
5906
  * currently embedded in.
5899
5907
  *
5908
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
5909
+ *
5900
5910
  * @example
5901
5911
  * ```js
5902
5912
  * async function getParentWindow() {
@@ -6742,6 +6752,13 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
6742
6752
  metadata?: MetadataType;
6743
6753
  };
6744
6754
 
6755
+ declare type InheritableOptions = {
6756
+ customContext: boolean;
6757
+ customData: boolean;
6758
+ icon: boolean;
6759
+ preloadScripts: boolean;
6760
+ };
6761
+
6745
6762
  /**
6746
6763
  * Generated when an application has initialized.
6747
6764
  * @interface
@@ -8345,6 +8362,7 @@ declare type LaunchExternalProcessRule = {
8345
8362
  */
8346
8363
  declare type LaunchIntoPlatformPayload = {
8347
8364
  manifest: any;
8365
+ manifestUrl?: string;
8348
8366
  };
8349
8367
 
8350
8368
  /**
@@ -9975,6 +9993,7 @@ declare namespace OpenFin {
9975
9993
  WindowState,
9976
9994
  AutoplayPolicyOptions,
9977
9995
  ConstWindowOptions,
9996
+ InheritableOptions,
9978
9997
  MutableWindowOptions,
9979
9998
  WorkspacePlatformOptions,
9980
9999
  WebRequestHeader,
@@ -11212,9 +11231,13 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11212
11231
  */
11213
11232
  providerUrl?: string;
11214
11233
  /**
11215
- * The permissions for secured APIs.
11234
+ * @defaultValue true
11235
+ *
11236
+ * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11237
+ *
11238
+ * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11216
11239
  */
11217
- permissions?: Partial<Permissions_2>;
11240
+ allowLaunchIntoPlatform?: boolean;
11218
11241
  };
11219
11242
 
11220
11243
  /**
@@ -11974,7 +11997,7 @@ declare type PreloadScriptInfoRunning = {
11974
11997
  * @interface
11975
11998
  */
11976
11999
  declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent & {
11977
- type: 'preload-script-state-changed';
12000
+ type: 'preload-scripts-state-changed';
11978
12001
  };
11979
12002
 
11980
12003
  /**
@@ -11991,7 +12014,7 @@ declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
11991
12014
  * @interface
11992
12015
  */
11993
12016
  declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent & {
11994
- type: 'preload-script-state-changing';
12017
+ type: 'preload-scripts-state-changing';
11995
12018
  };
11996
12019
 
11997
12020
  declare type PresetLayoutOptions = OpenFin.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
  *
@@ -3839,6 +3843,10 @@ declare type ConstWindowOptions = {
3839
3843
  * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
3840
3844
  */
3841
3845
  viewVisibility?: ViewVisibilityOptions;
3846
+ /**
3847
+ * 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.
3848
+ */
3849
+ inheritance?: Partial<InheritableOptions>;
3842
3850
  };
3843
3851
 
3844
3852
  declare interface Container extends EventEmitter_2 {
@@ -5897,6 +5905,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
5897
5905
  * Returns a frame info object representing the window that the referenced iframe is
5898
5906
  * currently embedded in.
5899
5907
  *
5908
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
5909
+ *
5900
5910
  * @example
5901
5911
  * ```js
5902
5912
  * async function getParentWindow() {
@@ -6742,6 +6752,13 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
6742
6752
  metadata?: MetadataType;
6743
6753
  };
6744
6754
 
6755
+ declare type InheritableOptions = {
6756
+ customContext: boolean;
6757
+ customData: boolean;
6758
+ icon: boolean;
6759
+ preloadScripts: boolean;
6760
+ };
6761
+
6745
6762
  /**
6746
6763
  * Generated when an application has initialized.
6747
6764
  * @interface
@@ -8345,6 +8362,7 @@ declare type LaunchExternalProcessRule = {
8345
8362
  */
8346
8363
  declare type LaunchIntoPlatformPayload = {
8347
8364
  manifest: any;
8365
+ manifestUrl?: string;
8348
8366
  };
8349
8367
 
8350
8368
  /**
@@ -9975,6 +9993,7 @@ declare namespace OpenFin {
9975
9993
  WindowState,
9976
9994
  AutoplayPolicyOptions,
9977
9995
  ConstWindowOptions,
9996
+ InheritableOptions,
9978
9997
  MutableWindowOptions,
9979
9998
  WorkspacePlatformOptions,
9980
9999
  WebRequestHeader,
@@ -11212,9 +11231,13 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11212
11231
  */
11213
11232
  providerUrl?: string;
11214
11233
  /**
11215
- * The permissions for secured APIs.
11234
+ * @defaultValue true
11235
+ *
11236
+ * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11237
+ *
11238
+ * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11216
11239
  */
11217
- permissions?: Partial<Permissions_2>;
11240
+ allowLaunchIntoPlatform?: boolean;
11218
11241
  };
11219
11242
 
11220
11243
  /**
@@ -11974,7 +11997,7 @@ declare type PreloadScriptInfoRunning = {
11974
11997
  * @interface
11975
11998
  */
11976
11999
  declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent & {
11977
- type: 'preload-script-state-changed';
12000
+ type: 'preload-scripts-state-changed';
11978
12001
  };
11979
12002
 
11980
12003
  /**
@@ -11991,7 +12014,7 @@ declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
11991
12014
  * @interface
11992
12015
  */
11993
12016
  declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent & {
11994
- type: 'preload-script-state-changing';
12017
+ type: 'preload-scripts-state-changing';
11995
12018
  };
11996
12019
 
11997
12020
  declare type PresetLayoutOptions = OpenFin.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
  *
@@ -3839,6 +3843,10 @@ declare type ConstWindowOptions = {
3839
3843
  * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
3840
3844
  */
3841
3845
  viewVisibility?: ViewVisibilityOptions;
3846
+ /**
3847
+ * 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.
3848
+ */
3849
+ inheritance?: Partial<InheritableOptions>;
3842
3850
  };
3843
3851
 
3844
3852
  declare interface Container extends EventEmitter_2 {
@@ -5897,6 +5905,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
5897
5905
  * Returns a frame info object representing the window that the referenced iframe is
5898
5906
  * currently embedded in.
5899
5907
  *
5908
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
5909
+ *
5900
5910
  * @example
5901
5911
  * ```js
5902
5912
  * async function getParentWindow() {
@@ -6742,6 +6752,13 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
6742
6752
  metadata?: MetadataType;
6743
6753
  };
6744
6754
 
6755
+ declare type InheritableOptions = {
6756
+ customContext: boolean;
6757
+ customData: boolean;
6758
+ icon: boolean;
6759
+ preloadScripts: boolean;
6760
+ };
6761
+
6745
6762
  /**
6746
6763
  * Generated when an application has initialized.
6747
6764
  * @interface
@@ -8345,6 +8362,7 @@ declare type LaunchExternalProcessRule = {
8345
8362
  */
8346
8363
  declare type LaunchIntoPlatformPayload = {
8347
8364
  manifest: any;
8365
+ manifestUrl?: string;
8348
8366
  };
8349
8367
 
8350
8368
  /**
@@ -9975,6 +9993,7 @@ declare namespace OpenFin {
9975
9993
  WindowState,
9976
9994
  AutoplayPolicyOptions,
9977
9995
  ConstWindowOptions,
9996
+ InheritableOptions,
9978
9997
  MutableWindowOptions,
9979
9998
  WorkspacePlatformOptions,
9980
9999
  WebRequestHeader,
@@ -11212,9 +11231,13 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11212
11231
  */
11213
11232
  providerUrl?: string;
11214
11233
  /**
11215
- * The permissions for secured APIs.
11234
+ * @defaultValue true
11235
+ *
11236
+ * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11237
+ *
11238
+ * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11216
11239
  */
11217
- permissions?: Partial<Permissions_2>;
11240
+ allowLaunchIntoPlatform?: boolean;
11218
11241
  };
11219
11242
 
11220
11243
  /**
@@ -11974,7 +11997,7 @@ declare type PreloadScriptInfoRunning = {
11974
11997
  * @interface
11975
11998
  */
11976
11999
  declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent & {
11977
- type: 'preload-script-state-changed';
12000
+ type: 'preload-scripts-state-changed';
11978
12001
  };
11979
12002
 
11980
12003
  /**
@@ -11991,7 +12014,7 @@ declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
11991
12014
  * @interface
11992
12015
  */
11993
12016
  declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent & {
11994
- type: 'preload-script-state-changing';
12017
+ type: 'preload-scripts-state-changing';
11995
12018
  };
11996
12019
 
11997
12020
  declare type PresetLayoutOptions = OpenFin.PresetLayoutOptions;
@@ -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
  *
@@ -3894,6 +3898,10 @@ declare type ConstWindowOptions = {
3894
3898
  * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
3895
3899
  */
3896
3900
  viewVisibility?: ViewVisibilityOptions;
3901
+ /**
3902
+ * 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.
3903
+ */
3904
+ inheritance?: Partial<InheritableOptions>;
3897
3905
  };
3898
3906
 
3899
3907
  declare interface Container extends EventEmitter_2 {
@@ -6003,6 +6011,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
6003
6011
  * Returns a frame info object representing the window that the referenced iframe is
6004
6012
  * currently embedded in.
6005
6013
  *
6014
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
6015
+ *
6006
6016
  * @example
6007
6017
  * ```js
6008
6018
  * async function getParentWindow() {
@@ -6854,6 +6864,13 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
6854
6864
  metadata?: MetadataType;
6855
6865
  };
6856
6866
 
6867
+ declare type InheritableOptions = {
6868
+ customContext: boolean;
6869
+ customData: boolean;
6870
+ icon: boolean;
6871
+ preloadScripts: boolean;
6872
+ };
6873
+
6857
6874
  /**
6858
6875
  * Generated when an application has initialized.
6859
6876
  * @interface
@@ -8480,6 +8497,7 @@ declare type LaunchExternalProcessRule = {
8480
8497
  */
8481
8498
  declare type LaunchIntoPlatformPayload = {
8482
8499
  manifest: any;
8500
+ manifestUrl?: string;
8483
8501
  };
8484
8502
 
8485
8503
  /**
@@ -10308,6 +10326,7 @@ declare namespace OpenFin {
10308
10326
  WindowState,
10309
10327
  AutoplayPolicyOptions,
10310
10328
  ConstWindowOptions,
10329
+ InheritableOptions,
10311
10330
  MutableWindowOptions,
10312
10331
  WorkspacePlatformOptions,
10313
10332
  WebRequestHeader,
@@ -11578,9 +11597,13 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11578
11597
  */
11579
11598
  providerUrl?: string;
11580
11599
  /**
11581
- * The permissions for secured APIs.
11600
+ * @defaultValue true
11601
+ *
11602
+ * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11603
+ *
11604
+ * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11582
11605
  */
11583
- permissions?: Partial<Permissions_2>;
11606
+ allowLaunchIntoPlatform?: boolean;
11584
11607
  };
11585
11608
 
11586
11609
  /**
@@ -12385,7 +12408,7 @@ declare type PreloadScriptInfoRunning = {
12385
12408
  * @interface
12386
12409
  */
12387
12410
  declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent & {
12388
- type: 'preload-script-state-changed';
12411
+ type: 'preload-scripts-state-changed';
12389
12412
  };
12390
12413
 
12391
12414
  /**
@@ -12402,7 +12425,7 @@ declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
12402
12425
  * @interface
12403
12426
  */
12404
12427
  declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent & {
12405
- type: 'preload-script-state-changing';
12428
+ type: 'preload-scripts-state-changing';
12406
12429
  };
12407
12430
 
12408
12431
  declare type PresetLayoutOptions = OpenFin.PresetLayoutOptions;
@@ -10224,6 +10224,8 @@ class _Frame extends base_1$a.EmitterBase {
10224
10224
  * Returns a frame info object representing the window that the referenced iframe is
10225
10225
  * currently embedded in.
10226
10226
  *
10227
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
10228
+ *
10227
10229
  * @example
10228
10230
  * ```js
10229
10231
  * async function getParentWindow() {
@@ -11152,12 +11154,12 @@ class Platform extends base_1$7.EmitterBase {
11152
11154
  * @experimental
11153
11155
  */
11154
11156
  async launchContentManifest(manifestUrl) {
11155
- this.wire.sendAction('platform-launch-content-manifest', this.identity).catch((e) => {
11157
+ this.wire.sendAction('platform-launch-content-manifest', this.identity).catch(() => {
11156
11158
  // don't expose
11157
11159
  });
11158
11160
  const client = await this.getClient();
11159
11161
  const manifest = await this.fetchManifest(manifestUrl);
11160
- client.dispatch('launch-into-platform', { manifest });
11162
+ client.dispatch('launch-into-platform', { manifest, manifestUrl });
11161
11163
  return this;
11162
11164
  }
11163
11165
  /**
@@ -11822,7 +11824,7 @@ class LayoutModule extends base_1$5.Base {
11822
11824
  return this.wrapSync(this.fin.me.identity);
11823
11825
  };
11824
11826
  _LayoutModule_getLayoutManagerSpy.set(this, (layoutIdentity, layoutManager) => {
11825
- const msg = '[Layout] You are using a deprecated property `layoutManager` - it will be removed in v39.';
11827
+ const msg = '[Layout] You are using a deprecated property `layoutManager` - it will throw if you access it starting in v37.';
11826
11828
  const managerProxy = new Proxy(layoutManager, {
11827
11829
  get(target, key) {
11828
11830
  console.warn(`[Layout-mgr-proxy] accessing ${key.toString()}`);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/node-adapter",
3
- "version": "36.79.18",
3
+ "version": "36.80.1",
4
4
  "description": "See README.md",
5
5
  "main": "out/node-adapter.js",
6
6
  "types": "out/node-adapter.d.ts",