@openfin/node-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
  *
@@ -3812,7 +3820,7 @@ declare type ConstWindowOptions = {
3812
3820
  */
3813
3821
  viewVisibility?: ViewVisibilityOptions;
3814
3822
  /**
3815
- * 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."
3823
+ * 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.
3816
3824
  */
3817
3825
  inheritance?: Partial<InheritableOptions>;
3818
3826
  };
@@ -5867,6 +5875,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
5867
5875
  * Returns a frame info object representing the window that the referenced iframe is
5868
5876
  * currently embedded in.
5869
5877
  *
5878
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
5879
+ *
5870
5880
  * @example
5871
5881
  * ```js
5872
5882
  * async function getParentWindow() {
@@ -5934,8 +5944,11 @@ declare type FrameInfo = {
5934
5944
  */
5935
5945
  declare class _FrameModule extends Base {
5936
5946
  /**
5937
- * Asynchronously returns a reference to the specified frame. The frame does not have to exist
5938
- * @param identity - the identity of the frame you want to wrap
5947
+ * Asynchronously returns an API handle for the given Frame identity.
5948
+ *
5949
+ * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
5950
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
5951
+ * for a Frame throughout its entire lifecycle.
5939
5952
  *
5940
5953
  * @example
5941
5954
  * ```js
@@ -5946,8 +5959,11 @@ declare class _FrameModule extends Base {
5946
5959
  */
5947
5960
  wrap(identity: OpenFin.Identity): Promise<OpenFin.Frame>;
5948
5961
  /**
5949
- * Synchronously returns a reference to the specified frame. The frame does not have to exist
5950
- * @param identity - the identity of the frame you want to wrap
5962
+ * Synchronously returns an API handle for the given Frame identity.
5963
+ *
5964
+ * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
5965
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
5966
+ * for a Frame throughout its entire lifecycle.
5951
5967
  *
5952
5968
  * @example
5953
5969
  * ```js
@@ -6005,14 +6021,6 @@ declare type GetLogRequestType_2 = {
6005
6021
  * The name of the running application
6006
6022
  */
6007
6023
  name: string;
6008
- /**
6009
- * The file length of the log file
6010
- */
6011
- endFile?: string;
6012
- /**
6013
- * The size limit of the log file.
6014
- */
6015
- sizeLimit?: number;
6016
6024
  };
6017
6025
 
6018
6026
  declare type GetterCall<T> = ApiCall<void, T>;
@@ -8322,6 +8330,7 @@ declare type LaunchExternalProcessRule = {
8322
8330
  */
8323
8331
  declare type LaunchIntoPlatformPayload = {
8324
8332
  manifest: any;
8333
+ manifestUrl?: string;
8325
8334
  };
8326
8335
 
8327
8336
  /**
@@ -11170,6 +11179,14 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11170
11179
  * The provider url.
11171
11180
  */
11172
11181
  providerUrl?: string;
11182
+ /**
11183
+ * @defaultValue true
11184
+ *
11185
+ * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11186
+ *
11187
+ * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11188
+ */
11189
+ allowLaunchIntoPlatform?: boolean;
11173
11190
  };
11174
11191
 
11175
11192
  /**
@@ -16095,7 +16112,11 @@ declare class ViewModule extends Base {
16095
16112
  */
16096
16113
  create(options: OpenFin.ViewCreationOptions): Promise<OpenFin.View>;
16097
16114
  /**
16098
- * Asynchronously returns a View object that represents an existing view.
16115
+ * Asynchronously returns an API handle for the given View identity.
16116
+ *
16117
+ * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
16118
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
16119
+ * for a View throughout its entire lifecycle.
16099
16120
  *
16100
16121
  * @example
16101
16122
  * ```js
@@ -16107,7 +16128,11 @@ declare class ViewModule extends Base {
16107
16128
  */
16108
16129
  wrap(identity: OpenFin.Identity): Promise<OpenFin.View>;
16109
16130
  /**
16110
- * Synchronously returns a View object that represents an existing view.
16131
+ * Synchronously returns an API handle for the given View identity.
16132
+ *
16133
+ * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
16134
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
16135
+ * for a View throughout its entire lifecycle.
16111
16136
  *
16112
16137
  * @example
16113
16138
  * ```js
@@ -18555,7 +18580,11 @@ declare type WindowInitializedEvent = InitializedEvent_2;
18555
18580
  */
18556
18581
  declare class _WindowModule extends Base {
18557
18582
  /**
18558
- * Asynchronously returns a Window object that represents an existing window.
18583
+ * Asynchronously returns an API handle for the given Window identity.
18584
+ *
18585
+ * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
18586
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
18587
+ * for a Window throughout its entire lifecycle.
18559
18588
  *
18560
18589
  * @example
18561
18590
  * ```js
@@ -18575,7 +18604,11 @@ declare class _WindowModule extends Base {
18575
18604
  */
18576
18605
  wrap(identity: OpenFin.Identity): Promise<OpenFin.Window>;
18577
18606
  /**
18578
- * Synchronously returns a Window object that represents an existing window.
18607
+ * Synchronously returns an API handle for the given Window identity.
18608
+ *
18609
+ * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
18610
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
18611
+ * for a Window throughout its entire lifecycle.
18579
18612
  *
18580
18613
  * @example
18581
18614
  * ```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
  *
@@ -3812,7 +3820,7 @@ declare type ConstWindowOptions = {
3812
3820
  */
3813
3821
  viewVisibility?: ViewVisibilityOptions;
3814
3822
  /**
3815
- * 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."
3823
+ * 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.
3816
3824
  */
3817
3825
  inheritance?: Partial<InheritableOptions>;
3818
3826
  };
@@ -5867,6 +5875,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
5867
5875
  * Returns a frame info object representing the window that the referenced iframe is
5868
5876
  * currently embedded in.
5869
5877
  *
5878
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
5879
+ *
5870
5880
  * @example
5871
5881
  * ```js
5872
5882
  * async function getParentWindow() {
@@ -5934,8 +5944,11 @@ declare type FrameInfo = {
5934
5944
  */
5935
5945
  declare class _FrameModule extends Base {
5936
5946
  /**
5937
- * Asynchronously returns a reference to the specified frame. The frame does not have to exist
5938
- * @param identity - the identity of the frame you want to wrap
5947
+ * Asynchronously returns an API handle for the given Frame identity.
5948
+ *
5949
+ * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
5950
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
5951
+ * for a Frame throughout its entire lifecycle.
5939
5952
  *
5940
5953
  * @example
5941
5954
  * ```js
@@ -5946,8 +5959,11 @@ declare class _FrameModule extends Base {
5946
5959
  */
5947
5960
  wrap(identity: OpenFin.Identity): Promise<OpenFin.Frame>;
5948
5961
  /**
5949
- * Synchronously returns a reference to the specified frame. The frame does not have to exist
5950
- * @param identity - the identity of the frame you want to wrap
5962
+ * Synchronously returns an API handle for the given Frame identity.
5963
+ *
5964
+ * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
5965
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
5966
+ * for a Frame throughout its entire lifecycle.
5951
5967
  *
5952
5968
  * @example
5953
5969
  * ```js
@@ -6005,14 +6021,6 @@ declare type GetLogRequestType_2 = {
6005
6021
  * The name of the running application
6006
6022
  */
6007
6023
  name: string;
6008
- /**
6009
- * The file length of the log file
6010
- */
6011
- endFile?: string;
6012
- /**
6013
- * The size limit of the log file.
6014
- */
6015
- sizeLimit?: number;
6016
6024
  };
6017
6025
 
6018
6026
  declare type GetterCall<T> = ApiCall<void, T>;
@@ -8322,6 +8330,7 @@ declare type LaunchExternalProcessRule = {
8322
8330
  */
8323
8331
  declare type LaunchIntoPlatformPayload = {
8324
8332
  manifest: any;
8333
+ manifestUrl?: string;
8325
8334
  };
8326
8335
 
8327
8336
  /**
@@ -11170,6 +11179,14 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11170
11179
  * The provider url.
11171
11180
  */
11172
11181
  providerUrl?: string;
11182
+ /**
11183
+ * @defaultValue true
11184
+ *
11185
+ * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11186
+ *
11187
+ * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11188
+ */
11189
+ allowLaunchIntoPlatform?: boolean;
11173
11190
  };
11174
11191
 
11175
11192
  /**
@@ -16095,7 +16112,11 @@ declare class ViewModule extends Base {
16095
16112
  */
16096
16113
  create(options: OpenFin.ViewCreationOptions): Promise<OpenFin.View>;
16097
16114
  /**
16098
- * Asynchronously returns a View object that represents an existing view.
16115
+ * Asynchronously returns an API handle for the given View identity.
16116
+ *
16117
+ * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
16118
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
16119
+ * for a View throughout its entire lifecycle.
16099
16120
  *
16100
16121
  * @example
16101
16122
  * ```js
@@ -16107,7 +16128,11 @@ declare class ViewModule extends Base {
16107
16128
  */
16108
16129
  wrap(identity: OpenFin.Identity): Promise<OpenFin.View>;
16109
16130
  /**
16110
- * Synchronously returns a View object that represents an existing view.
16131
+ * Synchronously returns an API handle for the given View identity.
16132
+ *
16133
+ * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
16134
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
16135
+ * for a View throughout its entire lifecycle.
16111
16136
  *
16112
16137
  * @example
16113
16138
  * ```js
@@ -18555,7 +18580,11 @@ declare type WindowInitializedEvent = InitializedEvent_2;
18555
18580
  */
18556
18581
  declare class _WindowModule extends Base {
18557
18582
  /**
18558
- * Asynchronously returns a Window object that represents an existing window.
18583
+ * Asynchronously returns an API handle for the given Window identity.
18584
+ *
18585
+ * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
18586
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
18587
+ * for a Window throughout its entire lifecycle.
18559
18588
  *
18560
18589
  * @example
18561
18590
  * ```js
@@ -18575,7 +18604,11 @@ declare class _WindowModule extends Base {
18575
18604
  */
18576
18605
  wrap(identity: OpenFin.Identity): Promise<OpenFin.Window>;
18577
18606
  /**
18578
- * Synchronously returns a Window object that represents an existing window.
18607
+ * Synchronously returns an API handle for the given Window identity.
18608
+ *
18609
+ * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
18610
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
18611
+ * for a Window throughout its entire lifecycle.
18579
18612
  *
18580
18613
  * @example
18581
18614
  * ```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
  *
@@ -3812,7 +3820,7 @@ declare type ConstWindowOptions = {
3812
3820
  */
3813
3821
  viewVisibility?: ViewVisibilityOptions;
3814
3822
  /**
3815
- * 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."
3823
+ * 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.
3816
3824
  */
3817
3825
  inheritance?: Partial<InheritableOptions>;
3818
3826
  };
@@ -5867,6 +5875,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
5867
5875
  * Returns a frame info object representing the window that the referenced iframe is
5868
5876
  * currently embedded in.
5869
5877
  *
5878
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
5879
+ *
5870
5880
  * @example
5871
5881
  * ```js
5872
5882
  * async function getParentWindow() {
@@ -5934,8 +5944,11 @@ declare type FrameInfo = {
5934
5944
  */
5935
5945
  declare class _FrameModule extends Base {
5936
5946
  /**
5937
- * Asynchronously returns a reference to the specified frame. The frame does not have to exist
5938
- * @param identity - the identity of the frame you want to wrap
5947
+ * Asynchronously returns an API handle for the given Frame identity.
5948
+ *
5949
+ * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
5950
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
5951
+ * for a Frame throughout its entire lifecycle.
5939
5952
  *
5940
5953
  * @example
5941
5954
  * ```js
@@ -5946,8 +5959,11 @@ declare class _FrameModule extends Base {
5946
5959
  */
5947
5960
  wrap(identity: OpenFin.Identity): Promise<OpenFin.Frame>;
5948
5961
  /**
5949
- * Synchronously returns a reference to the specified frame. The frame does not have to exist
5950
- * @param identity - the identity of the frame you want to wrap
5962
+ * Synchronously returns an API handle for the given Frame identity.
5963
+ *
5964
+ * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
5965
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
5966
+ * for a Frame throughout its entire lifecycle.
5951
5967
  *
5952
5968
  * @example
5953
5969
  * ```js
@@ -6005,14 +6021,6 @@ declare type GetLogRequestType_2 = {
6005
6021
  * The name of the running application
6006
6022
  */
6007
6023
  name: string;
6008
- /**
6009
- * The file length of the log file
6010
- */
6011
- endFile?: string;
6012
- /**
6013
- * The size limit of the log file.
6014
- */
6015
- sizeLimit?: number;
6016
6024
  };
6017
6025
 
6018
6026
  declare type GetterCall<T> = ApiCall<void, T>;
@@ -8322,6 +8330,7 @@ declare type LaunchExternalProcessRule = {
8322
8330
  */
8323
8331
  declare type LaunchIntoPlatformPayload = {
8324
8332
  manifest: any;
8333
+ manifestUrl?: string;
8325
8334
  };
8326
8335
 
8327
8336
  /**
@@ -11170,6 +11179,14 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11170
11179
  * The provider url.
11171
11180
  */
11172
11181
  providerUrl?: string;
11182
+ /**
11183
+ * @defaultValue true
11184
+ *
11185
+ * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11186
+ *
11187
+ * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11188
+ */
11189
+ allowLaunchIntoPlatform?: boolean;
11173
11190
  };
11174
11191
 
11175
11192
  /**
@@ -16095,7 +16112,11 @@ declare class ViewModule extends Base {
16095
16112
  */
16096
16113
  create(options: OpenFin.ViewCreationOptions): Promise<OpenFin.View>;
16097
16114
  /**
16098
- * Asynchronously returns a View object that represents an existing view.
16115
+ * Asynchronously returns an API handle for the given View identity.
16116
+ *
16117
+ * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
16118
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
16119
+ * for a View throughout its entire lifecycle.
16099
16120
  *
16100
16121
  * @example
16101
16122
  * ```js
@@ -16107,7 +16128,11 @@ declare class ViewModule extends Base {
16107
16128
  */
16108
16129
  wrap(identity: OpenFin.Identity): Promise<OpenFin.View>;
16109
16130
  /**
16110
- * Synchronously returns a View object that represents an existing view.
16131
+ * Synchronously returns an API handle for the given View identity.
16132
+ *
16133
+ * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
16134
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
16135
+ * for a View throughout its entire lifecycle.
16111
16136
  *
16112
16137
  * @example
16113
16138
  * ```js
@@ -18555,7 +18580,11 @@ declare type WindowInitializedEvent = InitializedEvent_2;
18555
18580
  */
18556
18581
  declare class _WindowModule extends Base {
18557
18582
  /**
18558
- * Asynchronously returns a Window object that represents an existing window.
18583
+ * Asynchronously returns an API handle for the given Window identity.
18584
+ *
18585
+ * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
18586
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
18587
+ * for a Window throughout its entire lifecycle.
18559
18588
  *
18560
18589
  * @example
18561
18590
  * ```js
@@ -18575,7 +18604,11 @@ declare class _WindowModule extends Base {
18575
18604
  */
18576
18605
  wrap(identity: OpenFin.Identity): Promise<OpenFin.Window>;
18577
18606
  /**
18578
- * Synchronously returns a Window object that represents an existing window.
18607
+ * Synchronously returns an API handle for the given Window identity.
18608
+ *
18609
+ * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
18610
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
18611
+ * for a Window throughout its entire lifecycle.
18579
18612
  *
18580
18613
  * @example
18581
18614
  * ```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
  *
@@ -3867,7 +3875,7 @@ declare type ConstWindowOptions = {
3867
3875
  */
3868
3876
  viewVisibility?: ViewVisibilityOptions;
3869
3877
  /**
3870
- * 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."
3878
+ * 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.
3871
3879
  */
3872
3880
  inheritance?: Partial<InheritableOptions>;
3873
3881
  };
@@ -5973,6 +5981,8 @@ declare class _Frame extends EmitterBase<OpenFin.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() {
@@ -6040,8 +6050,11 @@ declare type FrameInfo = {
6040
6050
  */
6041
6051
  declare class _FrameModule extends Base {
6042
6052
  /**
6043
- * Asynchronously returns a reference to the specified frame. The frame does not have to exist
6044
- * @param identity - the identity of the frame you want to wrap
6053
+ * Asynchronously returns an API handle for the given Frame identity.
6054
+ *
6055
+ * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
6056
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
6057
+ * for a Frame throughout its entire lifecycle.
6045
6058
  *
6046
6059
  * @example
6047
6060
  * ```js
@@ -6052,8 +6065,11 @@ declare class _FrameModule extends Base {
6052
6065
  */
6053
6066
  wrap(identity: OpenFin.Identity): Promise<OpenFin.Frame>;
6054
6067
  /**
6055
- * Synchronously returns a reference to the specified frame. The frame does not have to exist
6056
- * @param identity - the identity of the frame you want to wrap
6068
+ * Synchronously returns an API handle for the given Frame identity.
6069
+ *
6070
+ * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
6071
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
6072
+ * for a Frame throughout its entire lifecycle.
6057
6073
  *
6058
6074
  * @example
6059
6075
  * ```js
@@ -6111,14 +6127,6 @@ declare type GetLogRequestType_2 = {
6111
6127
  * The name of the running application
6112
6128
  */
6113
6129
  name: string;
6114
- /**
6115
- * The file length of the log file
6116
- */
6117
- endFile?: string;
6118
- /**
6119
- * The size limit of the log file.
6120
- */
6121
- sizeLimit?: number;
6122
6130
  };
6123
6131
 
6124
6132
  declare type GetterCall<T> = ApiCall<void, T>;
@@ -8457,6 +8465,7 @@ declare type LaunchExternalProcessRule = {
8457
8465
  */
8458
8466
  declare type LaunchIntoPlatformPayload = {
8459
8467
  manifest: any;
8468
+ manifestUrl?: string;
8460
8469
  };
8461
8470
 
8462
8471
  /**
@@ -11536,6 +11545,14 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11536
11545
  * The provider url.
11537
11546
  */
11538
11547
  providerUrl?: string;
11548
+ /**
11549
+ * @defaultValue true
11550
+ *
11551
+ * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11552
+ *
11553
+ * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11554
+ */
11555
+ allowLaunchIntoPlatform?: boolean;
11539
11556
  };
11540
11557
 
11541
11558
  /**
@@ -16556,7 +16573,11 @@ declare class ViewModule extends Base {
16556
16573
  */
16557
16574
  create(options: OpenFin.ViewCreationOptions): Promise<OpenFin.View>;
16558
16575
  /**
16559
- * Asynchronously returns a View object that represents an existing view.
16576
+ * Asynchronously returns an API handle for the given View identity.
16577
+ *
16578
+ * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
16579
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
16580
+ * for a View throughout its entire lifecycle.
16560
16581
  *
16561
16582
  * @example
16562
16583
  * ```js
@@ -16568,7 +16589,11 @@ declare class ViewModule extends Base {
16568
16589
  */
16569
16590
  wrap(identity: OpenFin.Identity): Promise<OpenFin.View>;
16570
16591
  /**
16571
- * Synchronously returns a View object that represents an existing view.
16592
+ * Synchronously returns an API handle for the given View identity.
16593
+ *
16594
+ * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
16595
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
16596
+ * for a View throughout its entire lifecycle.
16572
16597
  *
16573
16598
  * @example
16574
16599
  * ```js
@@ -19023,7 +19048,11 @@ declare type WindowInitializedEvent = InitializedEvent_2;
19023
19048
  */
19024
19049
  declare class _WindowModule extends Base {
19025
19050
  /**
19026
- * Asynchronously returns a Window object that represents an existing window.
19051
+ * Asynchronously returns an API handle for the given Window identity.
19052
+ *
19053
+ * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
19054
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
19055
+ * for a Window throughout its entire lifecycle.
19027
19056
  *
19028
19057
  * @example
19029
19058
  * ```js
@@ -19043,7 +19072,11 @@ declare class _WindowModule extends Base {
19043
19072
  */
19044
19073
  wrap(identity: OpenFin.Identity): Promise<OpenFin.Window>;
19045
19074
  /**
19046
- * Synchronously returns a Window object that represents an existing window.
19075
+ * Synchronously returns an API handle for the given Window identity.
19076
+ *
19077
+ * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
19078
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
19079
+ * for a Window throughout its entire lifecycle.
19047
19080
  *
19048
19081
  * @example
19049
19082
  * ```js
@@ -516,7 +516,11 @@ function requireFactory$3 () {
516
516
  return this.wrapSync({ uuid, name: options.name });
517
517
  }
518
518
  /**
519
- * Asynchronously returns a View object that represents an existing view.
519
+ * Asynchronously returns an API handle for the given View identity.
520
+ *
521
+ * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
522
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
523
+ * for a View throughout its entire lifecycle.
520
524
  *
521
525
  * @example
522
526
  * ```js
@@ -535,7 +539,11 @@ function requireFactory$3 () {
535
539
  return new index_1.View(this.wire, identity);
536
540
  }
537
541
  /**
538
- * Synchronously returns a View object that represents an existing view.
542
+ * Synchronously returns an API handle for the given View identity.
543
+ *
544
+ * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
545
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
546
+ * for a View throughout its entire lifecycle.
539
547
  *
540
548
  * @example
541
549
  * ```js
@@ -3827,7 +3835,11 @@ function requireFactory$2 () {
3827
3835
  */
3828
3836
  class ApplicationModule extends base_1.Base {
3829
3837
  /**
3830
- * Asynchronously returns an Application object that represents an existing application.
3838
+ * Asynchronously returns an API handle for the given Application identity.
3839
+ *
3840
+ * @remarks Wrapping an Application identity that does not yet exist will *not* throw an error, and instead
3841
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
3842
+ * for an Application throughout its entire lifecycle.
3831
3843
  *
3832
3844
  * @example
3833
3845
  *
@@ -3850,7 +3862,11 @@ function requireFactory$2 () {
3850
3862
  return new Instance_1.Application(this.wire, identity);
3851
3863
  }
3852
3864
  /**
3853
- * Synchronously returns an Application object that represents an existing application.
3865
+ * Synchronously returns an API handle for the given Application identity.
3866
+ *
3867
+ * @remarks Wrapping an Application identity that does not yet exist will *not* throw an error, and instead
3868
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
3869
+ * for an Aplication throughout its entire lifecycle.
3854
3870
  *
3855
3871
  * @example
3856
3872
  *
@@ -5415,7 +5431,11 @@ function requireFactory$1 () {
5415
5431
  */
5416
5432
  class _WindowModule extends base_1.Base {
5417
5433
  /**
5418
- * Asynchronously returns a Window object that represents an existing window.
5434
+ * Asynchronously returns an API handle for the given Window identity.
5435
+ *
5436
+ * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
5437
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
5438
+ * for a Window throughout its entire lifecycle.
5419
5439
  *
5420
5440
  * @example
5421
5441
  * ```js
@@ -5444,7 +5464,11 @@ function requireFactory$1 () {
5444
5464
  return new Instance_1._Window(this.wire, identity);
5445
5465
  }
5446
5466
  /**
5447
- * Synchronously returns a Window object that represents an existing window.
5467
+ * Synchronously returns an API handle for the given Window identity.
5468
+ *
5469
+ * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
5470
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
5471
+ * for a Window throughout its entire lifecycle.
5448
5472
  *
5449
5473
  * @example
5450
5474
  * ```js
@@ -10246,6 +10270,8 @@ class _Frame extends base_1$a.EmitterBase {
10246
10270
  * Returns a frame info object representing the window that the referenced iframe is
10247
10271
  * currently embedded in.
10248
10272
  *
10273
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
10274
+ *
10249
10275
  * @example
10250
10276
  * ```js
10251
10277
  * async function getParentWindow() {
@@ -10271,8 +10297,11 @@ const Instance_1$3 = Instance$3;
10271
10297
  */
10272
10298
  class _FrameModule extends base_1$9.Base {
10273
10299
  /**
10274
- * Asynchronously returns a reference to the specified frame. The frame does not have to exist
10275
- * @param identity - the identity of the frame you want to wrap
10300
+ * Asynchronously returns an API handle for the given Frame identity.
10301
+ *
10302
+ * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
10303
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
10304
+ * for a Frame throughout its entire lifecycle.
10276
10305
  *
10277
10306
  * @example
10278
10307
  * ```js
@@ -10292,8 +10321,11 @@ class _FrameModule extends base_1$9.Base {
10292
10321
  return new Instance_1$3._Frame(this.wire, identity);
10293
10322
  }
10294
10323
  /**
10295
- * Synchronously returns a reference to the specified frame. The frame does not have to exist
10296
- * @param identity - the identity of the frame you want to wrap
10324
+ * Synchronously returns an API handle for the given Frame identity.
10325
+ *
10326
+ * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
10327
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
10328
+ * for a Frame throughout its entire lifecycle.
10297
10329
  *
10298
10330
  * @example
10299
10331
  * ```js
@@ -11174,12 +11206,12 @@ class Platform extends base_1$7.EmitterBase {
11174
11206
  * @experimental
11175
11207
  */
11176
11208
  async launchContentManifest(manifestUrl) {
11177
- this.wire.sendAction('platform-launch-content-manifest', this.identity).catch((e) => {
11209
+ this.wire.sendAction('platform-launch-content-manifest', this.identity).catch(() => {
11178
11210
  // don't expose
11179
11211
  });
11180
11212
  const client = await this.getClient();
11181
11213
  const manifest = await this.fetchManifest(manifestUrl);
11182
- client.dispatch('launch-into-platform', { manifest });
11214
+ client.dispatch('launch-into-platform', { manifest, manifestUrl });
11183
11215
  return this;
11184
11216
  }
11185
11217
  /**
@@ -11836,16 +11868,16 @@ class LayoutModule extends base_1$5.Base {
11836
11868
  __classPrivateFieldSet$4(this, _LayoutModule_layoutManager, await this.wire.environment.initLayoutManager(this.fin, this.wire, options), "f");
11837
11869
  await this.wire.environment.applyLayoutSnapshot(this.fin, __classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f"), options);
11838
11870
  if (!options.layoutManagerOverride) {
11839
- // in single-layout case, we return the undocumented layoutManager type (deprecate with CORE-1081)
11871
+ // CORE-1081 to be removed when we actually delete the `layoutManager` prop
11872
+ // in single-layout case, we return the undocumented layoutManager type
11840
11873
  const layoutIdentity = { layoutName: layout_constants_1.DEFAULT_LAYOUT_KEY, ...this.fin.me.identity };
11841
- const layoutManager = await this.wire.environment.resolveLayout(__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f"), layoutIdentity);
11842
- return __classPrivateFieldGet$4(this, _LayoutModule_getLayoutManagerSpy, "f").call(this, layoutIdentity, layoutManager);
11874
+ return __classPrivateFieldGet$4(this, _LayoutModule_getLayoutManagerSpy, "f").call(this, layoutIdentity);
11843
11875
  }
11844
11876
  return this.wrapSync(this.fin.me.identity);
11845
11877
  };
11846
- _LayoutModule_getLayoutManagerSpy.set(this, (layoutIdentity, layoutManager) => {
11878
+ _LayoutModule_getLayoutManagerSpy.set(this, (layoutIdentity) => {
11847
11879
  const msg = '[Layout] You are using a deprecated property `layoutManager` - it will throw if you access it starting in v37.';
11848
- const managerProxy = new Proxy(layoutManager, {
11880
+ const managerProxy = new Proxy({}, {
11849
11881
  get(target, key) {
11850
11882
  console.warn(`[Layout-mgr-proxy] accessing ${key.toString()}`);
11851
11883
  throw new Error(msg);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/node-adapter",
3
- "version": "37.80.25",
3
+ "version": "37.80.34",
4
4
  "description": "See README.md",
5
5
  "main": "out/node-adapter.js",
6
6
  "types": "out/node-adapter.d.ts",