@openfin/remote-adapter 37.80.25 → 37.80.34

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;
@@ -983,7 +983,11 @@ declare type ApplicationInfo = {
983
983
  */
984
984
  declare class ApplicationModule extends Base {
985
985
  /**
986
- * Asynchronously returns an Application object that represents an existing application.
986
+ * Asynchronously returns an API handle for the given Application identity.
987
+ *
988
+ * @remarks Wrapping an Application identity that does not yet exist will *not* throw an error, and instead
989
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
990
+ * for an Application throughout its entire lifecycle.
987
991
  *
988
992
  * @example
989
993
  *
@@ -997,7 +1001,11 @@ declare class ApplicationModule extends Base {
997
1001
  */
998
1002
  wrap(identity: OpenFin.ApplicationIdentity): Promise<OpenFin.Application>;
999
1003
  /**
1000
- * Synchronously returns an Application object that represents an existing application.
1004
+ * Synchronously returns an API handle for the given Application identity.
1005
+ *
1006
+ * @remarks Wrapping an Application identity that does not yet exist will *not* throw an error, and instead
1007
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
1008
+ * for an Aplication throughout its entire lifecycle.
1001
1009
  *
1002
1010
  * @example
1003
1011
  *
@@ -3832,7 +3840,7 @@ declare type ConstWindowOptions = {
3832
3840
  */
3833
3841
  viewVisibility?: ViewVisibilityOptions;
3834
3842
  /**
3835
- * Controls whether an option is inherited from the parent application. Use { <option>: false } to disable a specific <option>. All inheritable properties will be inherited by default if omitted."
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.
3836
3844
  */
3837
3845
  inheritance?: Partial<InheritableOptions>;
3838
3846
  };
@@ -5881,6 +5889,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
5881
5889
  * Returns a frame info object representing the window that the referenced iframe is
5882
5890
  * currently embedded in.
5883
5891
  *
5892
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
5893
+ *
5884
5894
  * @example
5885
5895
  * ```js
5886
5896
  * async function getParentWindow() {
@@ -5948,8 +5958,11 @@ declare type FrameInfo = {
5948
5958
  */
5949
5959
  declare class _FrameModule extends Base {
5950
5960
  /**
5951
- * Asynchronously returns a reference to the specified frame. The frame does not have to exist
5952
- * @param identity - the identity of the frame you want to wrap
5961
+ * Asynchronously returns an API handle for the given Frame identity.
5962
+ *
5963
+ * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
5964
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
5965
+ * for a Frame throughout its entire lifecycle.
5953
5966
  *
5954
5967
  * @example
5955
5968
  * ```js
@@ -5960,8 +5973,11 @@ declare class _FrameModule extends Base {
5960
5973
  */
5961
5974
  wrap(identity: OpenFin.Identity): Promise<OpenFin.Frame>;
5962
5975
  /**
5963
- * Synchronously returns a reference to the specified frame. The frame does not have to exist
5964
- * @param identity - the identity of the frame you want to wrap
5976
+ * Synchronously returns an API handle for the given Frame identity.
5977
+ *
5978
+ * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
5979
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
5980
+ * for a Frame throughout its entire lifecycle.
5965
5981
  *
5966
5982
  * @example
5967
5983
  * ```js
@@ -6019,14 +6035,6 @@ declare type GetLogRequestType_2 = {
6019
6035
  * The name of the running application
6020
6036
  */
6021
6037
  name: string;
6022
- /**
6023
- * The file length of the log file
6024
- */
6025
- endFile?: string;
6026
- /**
6027
- * The size limit of the log file.
6028
- */
6029
- sizeLimit?: number;
6030
6038
  };
6031
6039
 
6032
6040
  declare type GetterCall<T> = ApiCall<void, T>;
@@ -8355,6 +8363,7 @@ declare type LaunchExternalProcessRule = {
8355
8363
  */
8356
8364
  declare type LaunchIntoPlatformPayload = {
8357
8365
  manifest: any;
8366
+ manifestUrl?: string;
8358
8367
  };
8359
8368
 
8360
8369
  /**
@@ -11202,6 +11211,14 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11202
11211
  * The provider url.
11203
11212
  */
11204
11213
  providerUrl?: string;
11214
+ /**
11215
+ * @defaultValue true
11216
+ *
11217
+ * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11218
+ *
11219
+ * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11220
+ */
11221
+ allowLaunchIntoPlatform?: boolean;
11205
11222
  };
11206
11223
 
11207
11224
  /**
@@ -16127,7 +16144,11 @@ declare class ViewModule extends Base {
16127
16144
  */
16128
16145
  create(options: OpenFin.ViewCreationOptions): Promise<OpenFin.View>;
16129
16146
  /**
16130
- * Asynchronously returns a View object that represents an existing view.
16147
+ * Asynchronously returns an API handle for the given View identity.
16148
+ *
16149
+ * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
16150
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
16151
+ * for a View throughout its entire lifecycle.
16131
16152
  *
16132
16153
  * @example
16133
16154
  * ```js
@@ -16139,7 +16160,11 @@ declare class ViewModule extends Base {
16139
16160
  */
16140
16161
  wrap(identity: OpenFin.Identity): Promise<OpenFin.View>;
16141
16162
  /**
16142
- * Synchronously returns a View object that represents an existing view.
16163
+ * Synchronously returns an API handle for the given View identity.
16164
+ *
16165
+ * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
16166
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
16167
+ * for a View throughout its entire lifecycle.
16143
16168
  *
16144
16169
  * @example
16145
16170
  * ```js
@@ -18587,7 +18612,11 @@ declare type WindowInitializedEvent = InitializedEvent_2;
18587
18612
  */
18588
18613
  declare class _WindowModule extends Base {
18589
18614
  /**
18590
- * Asynchronously returns a Window object that represents an existing window.
18615
+ * Asynchronously returns an API handle for the given Window identity.
18616
+ *
18617
+ * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
18618
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
18619
+ * for a Window throughout its entire lifecycle.
18591
18620
  *
18592
18621
  * @example
18593
18622
  * ```js
@@ -18607,7 +18636,11 @@ declare class _WindowModule extends Base {
18607
18636
  */
18608
18637
  wrap(identity: OpenFin.Identity): Promise<OpenFin.Window>;
18609
18638
  /**
18610
- * Synchronously returns a Window object that represents an existing window.
18639
+ * Synchronously returns an API handle for the given Window identity.
18640
+ *
18641
+ * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
18642
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
18643
+ * for a Window throughout its entire lifecycle.
18611
18644
  *
18612
18645
  * @example
18613
18646
  * ```js
@@ -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;
@@ -983,7 +983,11 @@ declare type ApplicationInfo = {
983
983
  */
984
984
  declare class ApplicationModule extends Base {
985
985
  /**
986
- * Asynchronously returns an Application object that represents an existing application.
986
+ * Asynchronously returns an API handle for the given Application identity.
987
+ *
988
+ * @remarks Wrapping an Application identity that does not yet exist will *not* throw an error, and instead
989
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
990
+ * for an Application throughout its entire lifecycle.
987
991
  *
988
992
  * @example
989
993
  *
@@ -997,7 +1001,11 @@ declare class ApplicationModule extends Base {
997
1001
  */
998
1002
  wrap(identity: OpenFin.ApplicationIdentity): Promise<OpenFin.Application>;
999
1003
  /**
1000
- * Synchronously returns an Application object that represents an existing application.
1004
+ * Synchronously returns an API handle for the given Application identity.
1005
+ *
1006
+ * @remarks Wrapping an Application identity that does not yet exist will *not* throw an error, and instead
1007
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
1008
+ * for an Aplication throughout its entire lifecycle.
1001
1009
  *
1002
1010
  * @example
1003
1011
  *
@@ -3832,7 +3840,7 @@ declare type ConstWindowOptions = {
3832
3840
  */
3833
3841
  viewVisibility?: ViewVisibilityOptions;
3834
3842
  /**
3835
- * Controls whether an option is inherited from the parent application. Use { <option>: false } to disable a specific <option>. All inheritable properties will be inherited by default if omitted."
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.
3836
3844
  */
3837
3845
  inheritance?: Partial<InheritableOptions>;
3838
3846
  };
@@ -5881,6 +5889,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
5881
5889
  * Returns a frame info object representing the window that the referenced iframe is
5882
5890
  * currently embedded in.
5883
5891
  *
5892
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
5893
+ *
5884
5894
  * @example
5885
5895
  * ```js
5886
5896
  * async function getParentWindow() {
@@ -5948,8 +5958,11 @@ declare type FrameInfo = {
5948
5958
  */
5949
5959
  declare class _FrameModule extends Base {
5950
5960
  /**
5951
- * Asynchronously returns a reference to the specified frame. The frame does not have to exist
5952
- * @param identity - the identity of the frame you want to wrap
5961
+ * Asynchronously returns an API handle for the given Frame identity.
5962
+ *
5963
+ * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
5964
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
5965
+ * for a Frame throughout its entire lifecycle.
5953
5966
  *
5954
5967
  * @example
5955
5968
  * ```js
@@ -5960,8 +5973,11 @@ declare class _FrameModule extends Base {
5960
5973
  */
5961
5974
  wrap(identity: OpenFin.Identity): Promise<OpenFin.Frame>;
5962
5975
  /**
5963
- * Synchronously returns a reference to the specified frame. The frame does not have to exist
5964
- * @param identity - the identity of the frame you want to wrap
5976
+ * Synchronously returns an API handle for the given Frame identity.
5977
+ *
5978
+ * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
5979
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
5980
+ * for a Frame throughout its entire lifecycle.
5965
5981
  *
5966
5982
  * @example
5967
5983
  * ```js
@@ -6019,14 +6035,6 @@ declare type GetLogRequestType_2 = {
6019
6035
  * The name of the running application
6020
6036
  */
6021
6037
  name: string;
6022
- /**
6023
- * The file length of the log file
6024
- */
6025
- endFile?: string;
6026
- /**
6027
- * The size limit of the log file.
6028
- */
6029
- sizeLimit?: number;
6030
6038
  };
6031
6039
 
6032
6040
  declare type GetterCall<T> = ApiCall<void, T>;
@@ -8355,6 +8363,7 @@ declare type LaunchExternalProcessRule = {
8355
8363
  */
8356
8364
  declare type LaunchIntoPlatformPayload = {
8357
8365
  manifest: any;
8366
+ manifestUrl?: string;
8358
8367
  };
8359
8368
 
8360
8369
  /**
@@ -11202,6 +11211,14 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11202
11211
  * The provider url.
11203
11212
  */
11204
11213
  providerUrl?: string;
11214
+ /**
11215
+ * @defaultValue true
11216
+ *
11217
+ * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11218
+ *
11219
+ * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11220
+ */
11221
+ allowLaunchIntoPlatform?: boolean;
11205
11222
  };
11206
11223
 
11207
11224
  /**
@@ -16127,7 +16144,11 @@ declare class ViewModule extends Base {
16127
16144
  */
16128
16145
  create(options: OpenFin.ViewCreationOptions): Promise<OpenFin.View>;
16129
16146
  /**
16130
- * Asynchronously returns a View object that represents an existing view.
16147
+ * Asynchronously returns an API handle for the given View identity.
16148
+ *
16149
+ * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
16150
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
16151
+ * for a View throughout its entire lifecycle.
16131
16152
  *
16132
16153
  * @example
16133
16154
  * ```js
@@ -16139,7 +16160,11 @@ declare class ViewModule extends Base {
16139
16160
  */
16140
16161
  wrap(identity: OpenFin.Identity): Promise<OpenFin.View>;
16141
16162
  /**
16142
- * Synchronously returns a View object that represents an existing view.
16163
+ * Synchronously returns an API handle for the given View identity.
16164
+ *
16165
+ * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
16166
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
16167
+ * for a View throughout its entire lifecycle.
16143
16168
  *
16144
16169
  * @example
16145
16170
  * ```js
@@ -18587,7 +18612,11 @@ declare type WindowInitializedEvent = InitializedEvent_2;
18587
18612
  */
18588
18613
  declare class _WindowModule extends Base {
18589
18614
  /**
18590
- * Asynchronously returns a Window object that represents an existing window.
18615
+ * Asynchronously returns an API handle for the given Window identity.
18616
+ *
18617
+ * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
18618
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
18619
+ * for a Window throughout its entire lifecycle.
18591
18620
  *
18592
18621
  * @example
18593
18622
  * ```js
@@ -18607,7 +18636,11 @@ declare class _WindowModule extends Base {
18607
18636
  */
18608
18637
  wrap(identity: OpenFin.Identity): Promise<OpenFin.Window>;
18609
18638
  /**
18610
- * Synchronously returns a Window object that represents an existing window.
18639
+ * Synchronously returns an API handle for the given Window identity.
18640
+ *
18641
+ * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
18642
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
18643
+ * for a Window throughout its entire lifecycle.
18611
18644
  *
18612
18645
  * @example
18613
18646
  * ```js
@@ -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;
@@ -983,7 +983,11 @@ declare type ApplicationInfo = {
983
983
  */
984
984
  declare class ApplicationModule extends Base {
985
985
  /**
986
- * Asynchronously returns an Application object that represents an existing application.
986
+ * Asynchronously returns an API handle for the given Application identity.
987
+ *
988
+ * @remarks Wrapping an Application identity that does not yet exist will *not* throw an error, and instead
989
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
990
+ * for an Application throughout its entire lifecycle.
987
991
  *
988
992
  * @example
989
993
  *
@@ -997,7 +1001,11 @@ declare class ApplicationModule extends Base {
997
1001
  */
998
1002
  wrap(identity: OpenFin.ApplicationIdentity): Promise<OpenFin.Application>;
999
1003
  /**
1000
- * Synchronously returns an Application object that represents an existing application.
1004
+ * Synchronously returns an API handle for the given Application identity.
1005
+ *
1006
+ * @remarks Wrapping an Application identity that does not yet exist will *not* throw an error, and instead
1007
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
1008
+ * for an Aplication throughout its entire lifecycle.
1001
1009
  *
1002
1010
  * @example
1003
1011
  *
@@ -3832,7 +3840,7 @@ declare type ConstWindowOptions = {
3832
3840
  */
3833
3841
  viewVisibility?: ViewVisibilityOptions;
3834
3842
  /**
3835
- * Controls whether an option is inherited from the parent application. Use { <option>: false } to disable a specific <option>. All inheritable properties will be inherited by default if omitted."
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.
3836
3844
  */
3837
3845
  inheritance?: Partial<InheritableOptions>;
3838
3846
  };
@@ -5881,6 +5889,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
5881
5889
  * Returns a frame info object representing the window that the referenced iframe is
5882
5890
  * currently embedded in.
5883
5891
  *
5892
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
5893
+ *
5884
5894
  * @example
5885
5895
  * ```js
5886
5896
  * async function getParentWindow() {
@@ -5948,8 +5958,11 @@ declare type FrameInfo = {
5948
5958
  */
5949
5959
  declare class _FrameModule extends Base {
5950
5960
  /**
5951
- * Asynchronously returns a reference to the specified frame. The frame does not have to exist
5952
- * @param identity - the identity of the frame you want to wrap
5961
+ * Asynchronously returns an API handle for the given Frame identity.
5962
+ *
5963
+ * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
5964
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
5965
+ * for a Frame throughout its entire lifecycle.
5953
5966
  *
5954
5967
  * @example
5955
5968
  * ```js
@@ -5960,8 +5973,11 @@ declare class _FrameModule extends Base {
5960
5973
  */
5961
5974
  wrap(identity: OpenFin.Identity): Promise<OpenFin.Frame>;
5962
5975
  /**
5963
- * Synchronously returns a reference to the specified frame. The frame does not have to exist
5964
- * @param identity - the identity of the frame you want to wrap
5976
+ * Synchronously returns an API handle for the given Frame identity.
5977
+ *
5978
+ * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
5979
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
5980
+ * for a Frame throughout its entire lifecycle.
5965
5981
  *
5966
5982
  * @example
5967
5983
  * ```js
@@ -6019,14 +6035,6 @@ declare type GetLogRequestType_2 = {
6019
6035
  * The name of the running application
6020
6036
  */
6021
6037
  name: string;
6022
- /**
6023
- * The file length of the log file
6024
- */
6025
- endFile?: string;
6026
- /**
6027
- * The size limit of the log file.
6028
- */
6029
- sizeLimit?: number;
6030
6038
  };
6031
6039
 
6032
6040
  declare type GetterCall<T> = ApiCall<void, T>;
@@ -8355,6 +8363,7 @@ declare type LaunchExternalProcessRule = {
8355
8363
  */
8356
8364
  declare type LaunchIntoPlatformPayload = {
8357
8365
  manifest: any;
8366
+ manifestUrl?: string;
8358
8367
  };
8359
8368
 
8360
8369
  /**
@@ -11202,6 +11211,14 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11202
11211
  * The provider url.
11203
11212
  */
11204
11213
  providerUrl?: string;
11214
+ /**
11215
+ * @defaultValue true
11216
+ *
11217
+ * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11218
+ *
11219
+ * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11220
+ */
11221
+ allowLaunchIntoPlatform?: boolean;
11205
11222
  };
11206
11223
 
11207
11224
  /**
@@ -16127,7 +16144,11 @@ declare class ViewModule extends Base {
16127
16144
  */
16128
16145
  create(options: OpenFin.ViewCreationOptions): Promise<OpenFin.View>;
16129
16146
  /**
16130
- * Asynchronously returns a View object that represents an existing view.
16147
+ * Asynchronously returns an API handle for the given View identity.
16148
+ *
16149
+ * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
16150
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
16151
+ * for a View throughout its entire lifecycle.
16131
16152
  *
16132
16153
  * @example
16133
16154
  * ```js
@@ -16139,7 +16160,11 @@ declare class ViewModule extends Base {
16139
16160
  */
16140
16161
  wrap(identity: OpenFin.Identity): Promise<OpenFin.View>;
16141
16162
  /**
16142
- * Synchronously returns a View object that represents an existing view.
16163
+ * Synchronously returns an API handle for the given View identity.
16164
+ *
16165
+ * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
16166
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
16167
+ * for a View throughout its entire lifecycle.
16143
16168
  *
16144
16169
  * @example
16145
16170
  * ```js
@@ -18587,7 +18612,11 @@ declare type WindowInitializedEvent = InitializedEvent_2;
18587
18612
  */
18588
18613
  declare class _WindowModule extends Base {
18589
18614
  /**
18590
- * Asynchronously returns a Window object that represents an existing window.
18615
+ * Asynchronously returns an API handle for the given Window identity.
18616
+ *
18617
+ * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
18618
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
18619
+ * for a Window throughout its entire lifecycle.
18591
18620
  *
18592
18621
  * @example
18593
18622
  * ```js
@@ -18607,7 +18636,11 @@ declare class _WindowModule extends Base {
18607
18636
  */
18608
18637
  wrap(identity: OpenFin.Identity): Promise<OpenFin.Window>;
18609
18638
  /**
18610
- * Synchronously returns a Window object that represents an existing window.
18639
+ * Synchronously returns an API handle for the given Window identity.
18640
+ *
18641
+ * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
18642
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
18643
+ * for a Window throughout its entire lifecycle.
18611
18644
  *
18612
18645
  * @example
18613
18646
  * ```js
@@ -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;
@@ -989,7 +989,11 @@ declare type ApplicationInfo = {
989
989
  */
990
990
  declare class ApplicationModule extends Base {
991
991
  /**
992
- * Asynchronously returns an Application object that represents an existing application.
992
+ * Asynchronously returns an API handle for the given Application identity.
993
+ *
994
+ * @remarks Wrapping an Application identity that does not yet exist will *not* throw an error, and instead
995
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
996
+ * for an Application throughout its entire lifecycle.
993
997
  *
994
998
  * @example
995
999
  *
@@ -1003,7 +1007,11 @@ declare class ApplicationModule extends Base {
1003
1007
  */
1004
1008
  wrap(identity: OpenFin.ApplicationIdentity): Promise<OpenFin.Application>;
1005
1009
  /**
1006
- * Synchronously returns an Application object that represents an existing application.
1010
+ * Synchronously returns an API handle for the given Application identity.
1011
+ *
1012
+ * @remarks Wrapping an Application identity that does not yet exist will *not* throw an error, and instead
1013
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
1014
+ * for an Aplication throughout its entire lifecycle.
1007
1015
  *
1008
1016
  * @example
1009
1017
  *
@@ -3887,7 +3895,7 @@ declare type ConstWindowOptions = {
3887
3895
  */
3888
3896
  viewVisibility?: ViewVisibilityOptions;
3889
3897
  /**
3890
- * Controls whether an option is inherited from the parent application. Use { <option>: false } to disable a specific <option>. All inheritable properties will be inherited by default if omitted."
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.
3891
3899
  */
3892
3900
  inheritance?: Partial<InheritableOptions>;
3893
3901
  };
@@ -5965,6 +5973,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
5965
5973
  * Returns a frame info object representing the window that the referenced iframe is
5966
5974
  * currently embedded in.
5967
5975
  *
5976
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
5977
+ *
5968
5978
  * @example
5969
5979
  * ```js
5970
5980
  * async function getParentWindow() {
@@ -6032,8 +6042,11 @@ declare type FrameInfo = {
6032
6042
  */
6033
6043
  declare class _FrameModule extends Base {
6034
6044
  /**
6035
- * Asynchronously returns a reference to the specified frame. The frame does not have to exist
6036
- * @param identity - the identity of the frame you want to wrap
6045
+ * Asynchronously returns an API handle for the given Frame identity.
6046
+ *
6047
+ * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
6048
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
6049
+ * for a Frame throughout its entire lifecycle.
6037
6050
  *
6038
6051
  * @example
6039
6052
  * ```js
@@ -6044,8 +6057,11 @@ declare class _FrameModule extends Base {
6044
6057
  */
6045
6058
  wrap(identity: OpenFin.Identity): Promise<OpenFin.Frame>;
6046
6059
  /**
6047
- * Synchronously returns a reference to the specified frame. The frame does not have to exist
6048
- * @param identity - the identity of the frame you want to wrap
6060
+ * Synchronously returns an API handle for the given Frame identity.
6061
+ *
6062
+ * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
6063
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
6064
+ * for a Frame throughout its entire lifecycle.
6049
6065
  *
6050
6066
  * @example
6051
6067
  * ```js
@@ -6103,14 +6119,6 @@ declare type GetLogRequestType_2 = {
6103
6119
  * The name of the running application
6104
6120
  */
6105
6121
  name: string;
6106
- /**
6107
- * The file length of the log file
6108
- */
6109
- endFile?: string;
6110
- /**
6111
- * The size limit of the log file.
6112
- */
6113
- sizeLimit?: number;
6114
6122
  };
6115
6123
 
6116
6124
  declare type GetterCall<T> = ApiCall<void, T>;
@@ -8468,6 +8476,7 @@ declare type LaunchExternalProcessRule = {
8468
8476
  */
8469
8477
  declare type LaunchIntoPlatformPayload = {
8470
8478
  manifest: any;
8479
+ manifestUrl?: string;
8471
8480
  };
8472
8481
 
8473
8482
  /**
@@ -11546,6 +11555,14 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11546
11555
  * The provider url.
11547
11556
  */
11548
11557
  providerUrl?: string;
11558
+ /**
11559
+ * @defaultValue true
11560
+ *
11561
+ * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11562
+ *
11563
+ * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11564
+ */
11565
+ allowLaunchIntoPlatform?: boolean;
11549
11566
  };
11550
11567
 
11551
11568
  /**
@@ -16566,7 +16583,11 @@ declare class ViewModule extends Base {
16566
16583
  */
16567
16584
  create(options: OpenFin.ViewCreationOptions): Promise<OpenFin.View>;
16568
16585
  /**
16569
- * Asynchronously returns a View object that represents an existing view.
16586
+ * Asynchronously returns an API handle for the given View identity.
16587
+ *
16588
+ * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
16589
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
16590
+ * for a View throughout its entire lifecycle.
16570
16591
  *
16571
16592
  * @example
16572
16593
  * ```js
@@ -16578,7 +16599,11 @@ declare class ViewModule extends Base {
16578
16599
  */
16579
16600
  wrap(identity: OpenFin.Identity): Promise<OpenFin.View>;
16580
16601
  /**
16581
- * Synchronously returns a View object that represents an existing view.
16602
+ * Synchronously returns an API handle for the given View identity.
16603
+ *
16604
+ * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
16605
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
16606
+ * for a View throughout its entire lifecycle.
16582
16607
  *
16583
16608
  * @example
16584
16609
  * ```js
@@ -19033,7 +19058,11 @@ declare type WindowInitializedEvent = InitializedEvent_2;
19033
19058
  */
19034
19059
  declare class _WindowModule extends Base {
19035
19060
  /**
19036
- * Asynchronously returns a Window object that represents an existing window.
19061
+ * Asynchronously returns an API handle for the given Window identity.
19062
+ *
19063
+ * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
19064
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
19065
+ * for a Window throughout its entire lifecycle.
19037
19066
  *
19038
19067
  * @example
19039
19068
  * ```js
@@ -19053,7 +19082,11 @@ declare class _WindowModule extends Base {
19053
19082
  */
19054
19083
  wrap(identity: OpenFin.Identity): Promise<OpenFin.Window>;
19055
19084
  /**
19056
- * Synchronously returns a Window object that represents an existing window.
19085
+ * Synchronously returns an API handle for the given Window identity.
19086
+ *
19087
+ * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
19088
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
19089
+ * for a Window throughout its entire lifecycle.
19057
19090
  *
19058
19091
  * @example
19059
19092
  * ```js
@@ -3391,7 +3391,11 @@ function requireFactory$2 () {
3391
3391
  return this.wrapSync({ uuid, name: options.name });
3392
3392
  }
3393
3393
  /**
3394
- * Asynchronously returns a View object that represents an existing view.
3394
+ * Asynchronously returns an API handle for the given View identity.
3395
+ *
3396
+ * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
3397
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
3398
+ * for a View throughout its entire lifecycle.
3395
3399
  *
3396
3400
  * @example
3397
3401
  * ```js
@@ -3410,7 +3414,11 @@ function requireFactory$2 () {
3410
3414
  return new index_1.View(this.wire, identity);
3411
3415
  }
3412
3416
  /**
3413
- * Synchronously returns a View object that represents an existing view.
3417
+ * Synchronously returns an API handle for the given View identity.
3418
+ *
3419
+ * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
3420
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
3421
+ * for a View throughout its entire lifecycle.
3414
3422
  *
3415
3423
  * @example
3416
3424
  * ```js
@@ -6109,7 +6117,11 @@ function requireFactory$1 () {
6109
6117
  */
6110
6118
  class ApplicationModule extends base_1.Base {
6111
6119
  /**
6112
- * Asynchronously returns an Application object that represents an existing application.
6120
+ * Asynchronously returns an API handle for the given Application identity.
6121
+ *
6122
+ * @remarks Wrapping an Application identity that does not yet exist will *not* throw an error, and instead
6123
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
6124
+ * for an Application throughout its entire lifecycle.
6113
6125
  *
6114
6126
  * @example
6115
6127
  *
@@ -6132,7 +6144,11 @@ function requireFactory$1 () {
6132
6144
  return new Instance_1.Application(this.wire, identity);
6133
6145
  }
6134
6146
  /**
6135
- * Synchronously returns an Application object that represents an existing application.
6147
+ * Synchronously returns an API handle for the given Application identity.
6148
+ *
6149
+ * @remarks Wrapping an Application identity that does not yet exist will *not* throw an error, and instead
6150
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
6151
+ * for an Aplication throughout its entire lifecycle.
6136
6152
  *
6137
6153
  * @example
6138
6154
  *
@@ -7697,7 +7713,11 @@ function requireFactory () {
7697
7713
  */
7698
7714
  class _WindowModule extends base_1.Base {
7699
7715
  /**
7700
- * Asynchronously returns a Window object that represents an existing window.
7716
+ * Asynchronously returns an API handle for the given Window identity.
7717
+ *
7718
+ * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
7719
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
7720
+ * for a Window throughout its entire lifecycle.
7701
7721
  *
7702
7722
  * @example
7703
7723
  * ```js
@@ -7726,7 +7746,11 @@ function requireFactory () {
7726
7746
  return new Instance_1._Window(this.wire, identity);
7727
7747
  }
7728
7748
  /**
7729
- * Synchronously returns a Window object that represents an existing window.
7749
+ * Synchronously returns an API handle for the given Window identity.
7750
+ *
7751
+ * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
7752
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
7753
+ * for a Window throughout its entire lifecycle.
7730
7754
  *
7731
7755
  * @example
7732
7756
  * ```js
@@ -8530,6 +8554,8 @@ class _Frame extends base_1$h.EmitterBase {
8530
8554
  * Returns a frame info object representing the window that the referenced iframe is
8531
8555
  * currently embedded in.
8532
8556
  *
8557
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
8558
+ *
8533
8559
  * @example
8534
8560
  * ```js
8535
8561
  * async function getParentWindow() {
@@ -8555,8 +8581,11 @@ const Instance_1$4 = Instance$4;
8555
8581
  */
8556
8582
  class _FrameModule extends base_1$g.Base {
8557
8583
  /**
8558
- * Asynchronously returns a reference to the specified frame. The frame does not have to exist
8559
- * @param identity - the identity of the frame you want to wrap
8584
+ * Asynchronously returns an API handle for the given Frame identity.
8585
+ *
8586
+ * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
8587
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
8588
+ * for a Frame throughout its entire lifecycle.
8560
8589
  *
8561
8590
  * @example
8562
8591
  * ```js
@@ -8576,8 +8605,11 @@ class _FrameModule extends base_1$g.Base {
8576
8605
  return new Instance_1$4._Frame(this.wire, identity);
8577
8606
  }
8578
8607
  /**
8579
- * Synchronously returns a reference to the specified frame. The frame does not have to exist
8580
- * @param identity - the identity of the frame you want to wrap
8608
+ * Synchronously returns an API handle for the given Frame identity.
8609
+ *
8610
+ * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
8611
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
8612
+ * for a Frame throughout its entire lifecycle.
8581
8613
  *
8582
8614
  * @example
8583
8615
  * ```js
@@ -14493,12 +14525,12 @@ class Platform extends base_1$5.EmitterBase {
14493
14525
  * @experimental
14494
14526
  */
14495
14527
  async launchContentManifest(manifestUrl) {
14496
- this.wire.sendAction('platform-launch-content-manifest', this.identity).catch((e) => {
14528
+ this.wire.sendAction('platform-launch-content-manifest', this.identity).catch(() => {
14497
14529
  // don't expose
14498
14530
  });
14499
14531
  const client = await this.getClient();
14500
14532
  const manifest = await this.fetchManifest(manifestUrl);
14501
- client.dispatch('launch-into-platform', { manifest });
14533
+ client.dispatch('launch-into-platform', { manifest, manifestUrl });
14502
14534
  return this;
14503
14535
  }
14504
14536
  /**
@@ -15133,16 +15165,16 @@ class LayoutModule extends base_1$3.Base {
15133
15165
  __classPrivateFieldSet$1(this, _LayoutModule_layoutManager, await this.wire.environment.initLayoutManager(this.fin, this.wire, options), "f");
15134
15166
  await this.wire.environment.applyLayoutSnapshot(this.fin, __classPrivateFieldGet$1(this, _LayoutModule_layoutManager, "f"), options);
15135
15167
  if (!options.layoutManagerOverride) {
15136
- // in single-layout case, we return the undocumented layoutManager type (deprecate with CORE-1081)
15168
+ // CORE-1081 to be removed when we actually delete the `layoutManager` prop
15169
+ // in single-layout case, we return the undocumented layoutManager type
15137
15170
  const layoutIdentity = { layoutName: layout_constants_1.DEFAULT_LAYOUT_KEY, ...this.fin.me.identity };
15138
- const layoutManager = await this.wire.environment.resolveLayout(__classPrivateFieldGet$1(this, _LayoutModule_layoutManager, "f"), layoutIdentity);
15139
- return __classPrivateFieldGet$1(this, _LayoutModule_getLayoutManagerSpy, "f").call(this, layoutIdentity, layoutManager);
15171
+ return __classPrivateFieldGet$1(this, _LayoutModule_getLayoutManagerSpy, "f").call(this, layoutIdentity);
15140
15172
  }
15141
15173
  return this.wrapSync(this.fin.me.identity);
15142
15174
  };
15143
- _LayoutModule_getLayoutManagerSpy.set(this, (layoutIdentity, layoutManager) => {
15175
+ _LayoutModule_getLayoutManagerSpy.set(this, (layoutIdentity) => {
15144
15176
  const msg = '[Layout] You are using a deprecated property `layoutManager` - it will throw if you access it starting in v37.';
15145
- const managerProxy = new Proxy(layoutManager, {
15177
+ const managerProxy = new Proxy({}, {
15146
15178
  get(target, key) {
15147
15179
  console.warn(`[Layout-mgr-proxy] accessing ${key.toString()}`);
15148
15180
  throw new Error(msg);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/remote-adapter",
3
- "version": "37.80.25",
3
+ "version": "37.80.34",
4
4
  "description": "Establish intermachine runtime connections using webRTC.",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "private": false,