@openfin/remote-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
  *
@@ -3859,6 +3863,10 @@ declare type ConstWindowOptions = {
3859
3863
  * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
3860
3864
  */
3861
3865
  viewVisibility?: ViewVisibilityOptions;
3866
+ /**
3867
+ * 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.
3868
+ */
3869
+ inheritance?: Partial<InheritableOptions>;
3862
3870
  };
3863
3871
 
3864
3872
  declare interface Container extends EventEmitter_2 {
@@ -5911,6 +5919,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
5911
5919
  * Returns a frame info object representing the window that the referenced iframe is
5912
5920
  * currently embedded in.
5913
5921
  *
5922
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
5923
+ *
5914
5924
  * @example
5915
5925
  * ```js
5916
5926
  * async function getParentWindow() {
@@ -6756,6 +6766,13 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
6756
6766
  metadata?: MetadataType;
6757
6767
  };
6758
6768
 
6769
+ declare type InheritableOptions = {
6770
+ customContext: boolean;
6771
+ customData: boolean;
6772
+ icon: boolean;
6773
+ preloadScripts: boolean;
6774
+ };
6775
+
6759
6776
  /**
6760
6777
  * Initialize a remote connection as a "host" application.
6761
6778
  * @param {InitOptions} options init options
@@ -8378,6 +8395,7 @@ declare type LaunchExternalProcessRule = {
8378
8395
  */
8379
8396
  declare type LaunchIntoPlatformPayload = {
8380
8397
  manifest: any;
8398
+ manifestUrl?: string;
8381
8399
  };
8382
8400
 
8383
8401
  /**
@@ -10008,6 +10026,7 @@ declare namespace OpenFin {
10008
10026
  WindowState,
10009
10027
  AutoplayPolicyOptions,
10010
10028
  ConstWindowOptions,
10029
+ InheritableOptions,
10011
10030
  MutableWindowOptions,
10012
10031
  WorkspacePlatformOptions,
10013
10032
  WebRequestHeader,
@@ -11244,9 +11263,13 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11244
11263
  */
11245
11264
  providerUrl?: string;
11246
11265
  /**
11247
- * The permissions for secured APIs.
11266
+ * @defaultValue true
11267
+ *
11268
+ * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11269
+ *
11270
+ * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11248
11271
  */
11249
- permissions?: Partial<Permissions_2>;
11272
+ allowLaunchIntoPlatform?: boolean;
11250
11273
  };
11251
11274
 
11252
11275
  /**
@@ -12006,7 +12029,7 @@ declare type PreloadScriptInfoRunning = {
12006
12029
  * @interface
12007
12030
  */
12008
12031
  declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent & {
12009
- type: 'preload-script-state-changed';
12032
+ type: 'preload-scripts-state-changed';
12010
12033
  };
12011
12034
 
12012
12035
  /**
@@ -12023,7 +12046,7 @@ declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
12023
12046
  * @interface
12024
12047
  */
12025
12048
  declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent & {
12026
- type: 'preload-script-state-changing';
12049
+ type: 'preload-scripts-state-changing';
12027
12050
  };
12028
12051
 
12029
12052
  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
  *
@@ -3859,6 +3863,10 @@ declare type ConstWindowOptions = {
3859
3863
  * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
3860
3864
  */
3861
3865
  viewVisibility?: ViewVisibilityOptions;
3866
+ /**
3867
+ * 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.
3868
+ */
3869
+ inheritance?: Partial<InheritableOptions>;
3862
3870
  };
3863
3871
 
3864
3872
  declare interface Container extends EventEmitter_2 {
@@ -5911,6 +5919,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
5911
5919
  * Returns a frame info object representing the window that the referenced iframe is
5912
5920
  * currently embedded in.
5913
5921
  *
5922
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
5923
+ *
5914
5924
  * @example
5915
5925
  * ```js
5916
5926
  * async function getParentWindow() {
@@ -6756,6 +6766,13 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
6756
6766
  metadata?: MetadataType;
6757
6767
  };
6758
6768
 
6769
+ declare type InheritableOptions = {
6770
+ customContext: boolean;
6771
+ customData: boolean;
6772
+ icon: boolean;
6773
+ preloadScripts: boolean;
6774
+ };
6775
+
6759
6776
  /**
6760
6777
  * Initialize a remote connection as a "host" application.
6761
6778
  * @param {InitOptions} options init options
@@ -8378,6 +8395,7 @@ declare type LaunchExternalProcessRule = {
8378
8395
  */
8379
8396
  declare type LaunchIntoPlatformPayload = {
8380
8397
  manifest: any;
8398
+ manifestUrl?: string;
8381
8399
  };
8382
8400
 
8383
8401
  /**
@@ -10008,6 +10026,7 @@ declare namespace OpenFin {
10008
10026
  WindowState,
10009
10027
  AutoplayPolicyOptions,
10010
10028
  ConstWindowOptions,
10029
+ InheritableOptions,
10011
10030
  MutableWindowOptions,
10012
10031
  WorkspacePlatformOptions,
10013
10032
  WebRequestHeader,
@@ -11244,9 +11263,13 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11244
11263
  */
11245
11264
  providerUrl?: string;
11246
11265
  /**
11247
- * The permissions for secured APIs.
11266
+ * @defaultValue true
11267
+ *
11268
+ * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11269
+ *
11270
+ * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11248
11271
  */
11249
- permissions?: Partial<Permissions_2>;
11272
+ allowLaunchIntoPlatform?: boolean;
11250
11273
  };
11251
11274
 
11252
11275
  /**
@@ -12006,7 +12029,7 @@ declare type PreloadScriptInfoRunning = {
12006
12029
  * @interface
12007
12030
  */
12008
12031
  declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent & {
12009
- type: 'preload-script-state-changed';
12032
+ type: 'preload-scripts-state-changed';
12010
12033
  };
12011
12034
 
12012
12035
  /**
@@ -12023,7 +12046,7 @@ declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
12023
12046
  * @interface
12024
12047
  */
12025
12048
  declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent & {
12026
- type: 'preload-script-state-changing';
12049
+ type: 'preload-scripts-state-changing';
12027
12050
  };
12028
12051
 
12029
12052
  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
  *
@@ -3859,6 +3863,10 @@ declare type ConstWindowOptions = {
3859
3863
  * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
3860
3864
  */
3861
3865
  viewVisibility?: ViewVisibilityOptions;
3866
+ /**
3867
+ * 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.
3868
+ */
3869
+ inheritance?: Partial<InheritableOptions>;
3862
3870
  };
3863
3871
 
3864
3872
  declare interface Container extends EventEmitter_2 {
@@ -5911,6 +5919,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
5911
5919
  * Returns a frame info object representing the window that the referenced iframe is
5912
5920
  * currently embedded in.
5913
5921
  *
5922
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
5923
+ *
5914
5924
  * @example
5915
5925
  * ```js
5916
5926
  * async function getParentWindow() {
@@ -6756,6 +6766,13 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
6756
6766
  metadata?: MetadataType;
6757
6767
  };
6758
6768
 
6769
+ declare type InheritableOptions = {
6770
+ customContext: boolean;
6771
+ customData: boolean;
6772
+ icon: boolean;
6773
+ preloadScripts: boolean;
6774
+ };
6775
+
6759
6776
  /**
6760
6777
  * Initialize a remote connection as a "host" application.
6761
6778
  * @param {InitOptions} options init options
@@ -8378,6 +8395,7 @@ declare type LaunchExternalProcessRule = {
8378
8395
  */
8379
8396
  declare type LaunchIntoPlatformPayload = {
8380
8397
  manifest: any;
8398
+ manifestUrl?: string;
8381
8399
  };
8382
8400
 
8383
8401
  /**
@@ -10008,6 +10026,7 @@ declare namespace OpenFin {
10008
10026
  WindowState,
10009
10027
  AutoplayPolicyOptions,
10010
10028
  ConstWindowOptions,
10029
+ InheritableOptions,
10011
10030
  MutableWindowOptions,
10012
10031
  WorkspacePlatformOptions,
10013
10032
  WebRequestHeader,
@@ -11244,9 +11263,13 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11244
11263
  */
11245
11264
  providerUrl?: string;
11246
11265
  /**
11247
- * The permissions for secured APIs.
11266
+ * @defaultValue true
11267
+ *
11268
+ * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11269
+ *
11270
+ * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11248
11271
  */
11249
- permissions?: Partial<Permissions_2>;
11272
+ allowLaunchIntoPlatform?: boolean;
11250
11273
  };
11251
11274
 
11252
11275
  /**
@@ -12006,7 +12029,7 @@ declare type PreloadScriptInfoRunning = {
12006
12029
  * @interface
12007
12030
  */
12008
12031
  declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent & {
12009
- type: 'preload-script-state-changed';
12032
+ type: 'preload-scripts-state-changed';
12010
12033
  };
12011
12034
 
12012
12035
  /**
@@ -12023,7 +12046,7 @@ declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
12023
12046
  * @interface
12024
12047
  */
12025
12048
  declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent & {
12026
- type: 'preload-script-state-changing';
12049
+ type: 'preload-scripts-state-changing';
12027
12050
  };
12028
12051
 
12029
12052
  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
  *
@@ -3914,6 +3918,10 @@ declare type ConstWindowOptions = {
3914
3918
  * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
3915
3919
  */
3916
3920
  viewVisibility?: ViewVisibilityOptions;
3921
+ /**
3922
+ * 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.
3923
+ */
3924
+ inheritance?: Partial<InheritableOptions>;
3917
3925
  };
3918
3926
 
3919
3927
  declare interface Container extends EventEmitter_2 {
@@ -5995,6 +6003,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
5995
6003
  * Returns a frame info object representing the window that the referenced iframe is
5996
6004
  * currently embedded in.
5997
6005
  *
6006
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
6007
+ *
5998
6008
  * @example
5999
6009
  * ```js
6000
6010
  * async function getParentWindow() {
@@ -6846,6 +6856,13 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
6846
6856
  metadata?: MetadataType;
6847
6857
  };
6848
6858
 
6859
+ declare type InheritableOptions = {
6860
+ customContext: boolean;
6861
+ customData: boolean;
6862
+ icon: boolean;
6863
+ preloadScripts: boolean;
6864
+ };
6865
+
6849
6866
  /**
6850
6867
  * Initialize a remote connection as a "host" application.
6851
6868
  * @param {InitOptions} options init options
@@ -8491,6 +8508,7 @@ declare type LaunchExternalProcessRule = {
8491
8508
  */
8492
8509
  declare type LaunchIntoPlatformPayload = {
8493
8510
  manifest: any;
8511
+ manifestUrl?: string;
8494
8512
  };
8495
8513
 
8496
8514
  /**
@@ -10319,6 +10337,7 @@ declare namespace OpenFin {
10319
10337
  WindowState,
10320
10338
  AutoplayPolicyOptions,
10321
10339
  ConstWindowOptions,
10340
+ InheritableOptions,
10322
10341
  MutableWindowOptions,
10323
10342
  WorkspacePlatformOptions,
10324
10343
  WebRequestHeader,
@@ -11588,9 +11607,13 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11588
11607
  */
11589
11608
  providerUrl?: string;
11590
11609
  /**
11591
- * The permissions for secured APIs.
11610
+ * @defaultValue true
11611
+ *
11612
+ * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11613
+ *
11614
+ * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11592
11615
  */
11593
- permissions?: Partial<Permissions_2>;
11616
+ allowLaunchIntoPlatform?: boolean;
11594
11617
  };
11595
11618
 
11596
11619
  /**
@@ -12395,7 +12418,7 @@ declare type PreloadScriptInfoRunning = {
12395
12418
  * @interface
12396
12419
  */
12397
12420
  declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent & {
12398
- type: 'preload-script-state-changed';
12421
+ type: 'preload-scripts-state-changed';
12399
12422
  };
12400
12423
 
12401
12424
  /**
@@ -12412,7 +12435,7 @@ declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
12412
12435
  * @interface
12413
12436
  */
12414
12437
  declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent & {
12415
- type: 'preload-script-state-changing';
12438
+ type: 'preload-scripts-state-changing';
12416
12439
  };
12417
12440
 
12418
12441
  declare type PresetLayoutOptions = OpenFin.PresetLayoutOptions;
@@ -8530,6 +8530,8 @@ class _Frame extends base_1$h.EmitterBase {
8530
8530
  * Returns a frame info object representing the window that the referenced iframe is
8531
8531
  * currently embedded in.
8532
8532
  *
8533
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
8534
+ *
8533
8535
  * @example
8534
8536
  * ```js
8535
8537
  * async function getParentWindow() {
@@ -14471,12 +14473,12 @@ class Platform extends base_1$5.EmitterBase {
14471
14473
  * @experimental
14472
14474
  */
14473
14475
  async launchContentManifest(manifestUrl) {
14474
- this.wire.sendAction('platform-launch-content-manifest', this.identity).catch((e) => {
14476
+ this.wire.sendAction('platform-launch-content-manifest', this.identity).catch(() => {
14475
14477
  // don't expose
14476
14478
  });
14477
14479
  const client = await this.getClient();
14478
14480
  const manifest = await this.fetchManifest(manifestUrl);
14479
- client.dispatch('launch-into-platform', { manifest });
14481
+ client.dispatch('launch-into-platform', { manifest, manifestUrl });
14480
14482
  return this;
14481
14483
  }
14482
14484
  /**
@@ -15119,7 +15121,7 @@ class LayoutModule extends base_1$3.Base {
15119
15121
  return this.wrapSync(this.fin.me.identity);
15120
15122
  };
15121
15123
  _LayoutModule_getLayoutManagerSpy.set(this, (layoutIdentity, layoutManager) => {
15122
- const msg = '[Layout] You are using a deprecated property `layoutManager` - it will be removed in v39.';
15124
+ const msg = '[Layout] You are using a deprecated property `layoutManager` - it will throw if you access it starting in v37.';
15123
15125
  const managerProxy = new Proxy(layoutManager, {
15124
15126
  get(target, key) {
15125
15127
  console.warn(`[Layout-mgr-proxy] accessing ${key.toString()}`);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/remote-adapter",
3
- "version": "36.79.18",
3
+ "version": "36.80.1",
4
4
  "description": "Establish intermachine runtime connections using webRTC.",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "private": false,