@openfin/fdc3-api 40.82.2 → 40.82.4

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.
@@ -42,6 +42,15 @@ declare type Accelerator = {
42
42
  zoom: boolean;
43
43
  };
44
44
 
45
+ /**
46
+ * Generated when a View is added to a layout.
47
+ * @interface
48
+ */
49
+ declare type AddedToLayoutEvent = BaseEvent_4 & {
50
+ type: 'added-to-layout';
51
+ layoutIdentity: OpenFin.LayoutIdentity;
52
+ };
53
+
45
54
  /**
46
55
  * Options to use when adding a view to a {@link TabStack}.
47
56
  *
@@ -3699,6 +3708,7 @@ declare type ContainerCreatedEvent = LayoutDOMEvent & {
3699
3708
 
3700
3709
  /**
3701
3710
  * Generated when content navigation or redirection is blocked by {@link OpenFin.DomainSettings}.
3711
+ * @interface
3702
3712
  */
3703
3713
  declare type ContentBlockedEvent = NamedEvent & {
3704
3714
  type: 'content-blocked';
@@ -4706,6 +4716,7 @@ declare type ErrorPlainObject = {
4706
4716
  stack?: string;
4707
4717
  message: string;
4708
4718
  name?: string;
4719
+ cause?: Error | ErrorPlainObject;
4709
4720
  toString(): string;
4710
4721
  };
4711
4722
 
@@ -4754,7 +4765,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
4754
4765
  */
4755
4766
  declare type Event_4 = (WebContentsEvents.Event<'view'> & {
4756
4767
  target: OpenFin.Identity;
4757
- }) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
4768
+ }) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent | AddedToLayoutEvent | RemovedFromLayoutEvent;
4758
4769
 
4759
4770
  /**
4760
4771
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
@@ -8562,6 +8573,23 @@ declare type LogLevel = OpenFin.LogLevel;
8562
8573
  */
8563
8574
  declare type LogLevel_2 = 'verbose' | 'info' | 'warning' | 'error' | 'fatal';
8564
8575
 
8576
+ declare type LogUploaderUIOptions = {
8577
+ title?: string;
8578
+ icon?: string;
8579
+ header?: string;
8580
+ description?: string;
8581
+ email?: string;
8582
+ website?: string;
8583
+ websiteDescription?: string;
8584
+ };
8585
+
8586
+ declare type LogUploadOptions = {
8587
+ endpoint: string;
8588
+ manifests?: string[];
8589
+ logs?: string[];
8590
+ ui?: LogUploaderUIOptions;
8591
+ };
8592
+
8565
8593
  /**
8566
8594
  * @interface
8567
8595
  */
@@ -8620,6 +8648,7 @@ declare type Manifest = {
8620
8648
  enableErrorReporting?: boolean;
8621
8649
  };
8622
8650
  interopBrokerConfiguration: InteropBrokerOptions;
8651
+ logUpload?: LogUploadOptions;
8623
8652
  };
8624
8653
 
8625
8654
  /**
@@ -9251,6 +9280,34 @@ declare type NavigationRules = {
9251
9280
 
9252
9281
  declare type NewConnectConfig = ConfigWithUuid & ConfigWithRuntime;
9253
9282
 
9283
+ declare interface NodeNetworkInterfaceBase {
9284
+ address: string;
9285
+ netmask: string;
9286
+ mac: string;
9287
+ internal: boolean;
9288
+ cidr: string | null;
9289
+ }
9290
+
9291
+ declare type NodeNetworkInterfaceInfo = NodeNetworkInterfaceInfoIPv4 | NodeNetworkInterfaceInfoIPv6;
9292
+
9293
+ declare interface NodeNetworkInterfaceInfoIPv4 extends NodeNetworkInterfaceBase {
9294
+ family: 'IPv4';
9295
+ scopeid?: undefined;
9296
+ }
9297
+
9298
+ declare interface NodeNetworkInterfaceInfoIPv6 extends NodeNetworkInterfaceBase {
9299
+ family: 'IPv6';
9300
+ scopeid: number;
9301
+ }
9302
+
9303
+ declare interface NodeUserInfo {
9304
+ username: string;
9305
+ uid: number;
9306
+ gid: number;
9307
+ shell: string | null;
9308
+ homedir: string;
9309
+ }
9310
+
9254
9311
  /**
9255
9312
  * @interface
9256
9313
  */
@@ -9453,6 +9510,8 @@ declare namespace OpenFin {
9453
9510
  PlatformViewCreationOptions,
9454
9511
  ProcessAffinityStrategy,
9455
9512
  PlatformOptions,
9513
+ LogUploaderUIOptions,
9514
+ LogUploadOptions,
9456
9515
  Manifest,
9457
9516
  LayoutContent,
9458
9517
  LayoutItemConfig,
@@ -9480,6 +9539,7 @@ declare namespace OpenFin {
9480
9539
  Time,
9481
9540
  CpuInfo,
9482
9541
  GpuInfo,
9542
+ OSInfo,
9483
9543
  HostSpecs,
9484
9544
  PrinterInfo_2 as PrinterInfo,
9485
9545
  Dpi,
@@ -9687,6 +9747,25 @@ declare type OptionsChangedEvent = BaseEvent_5 & {
9687
9747
  diff: OpenFin.WindowOptionDiff;
9688
9748
  };
9689
9749
 
9750
+ /**
9751
+ * @interface
9752
+ * The keys represent the output from calling individual Node `os` APIs.
9753
+ * For example, `userInfo` will have the output of calling `os.userInfo()`. For more information
9754
+ * see [Node `os` API docs](https://nodejs.org/docs/latest-v20.x/api/os.html)
9755
+ */
9756
+ declare type OSInfo = {
9757
+ platform: string;
9758
+ release: string;
9759
+ version: string;
9760
+ /**
9761
+ * Throws if a user has no username or homedir.
9762
+ * See [Node os.userInfo docs for more info](https://nodejs.org/docs/latest-v20.x/api/os.html#osuserinfooptions)
9763
+ */
9764
+ userInfo: NodeUserInfo;
9765
+ hostname: string;
9766
+ networkInterfaces: Record<string, NodeNetworkInterfaceInfo[] | undefined>;
9767
+ };
9768
+
9690
9769
  declare type OverrideCallback<T extends any = PlatformProvider, U extends T = T> = (arg: Constructor<T>) => U | Promise<U>;
9691
9770
 
9692
9771
  /**
@@ -11948,6 +12027,8 @@ declare interface ProtocolMap extends ProtocolMapBase {
11948
12027
  };
11949
12028
  response: void;
11950
12029
  };
12030
+ 'get-host-specs': GetterCall<OpenFin.HostSpecs>;
12031
+ 'get-os-info': GetterCall<OpenFin.OSInfo>;
11951
12032
  'system-get-printers': GetterCall<OpenFin.PrinterInfo[]>;
11952
12033
  'system-register-shutdown-handler': VoidCall;
11953
12034
  'get-domain-settings': ApiCall<OpenFin.ApplicationIdentity, OpenFin.DefaultDomainSettings>;
@@ -12175,6 +12256,15 @@ declare interface RemoteConfig extends ExistingConnectConfig {
12175
12256
  token: string;
12176
12257
  }
12177
12258
 
12259
+ /**
12260
+ * Generated when a View is removed from a layout.
12261
+ * @interface
12262
+ */
12263
+ declare type RemovedFromLayoutEvent = BaseEvent_4 & {
12264
+ type: 'removed-from-layout';
12265
+ layoutIdentity: OpenFin.LayoutIdentity;
12266
+ };
12267
+
12178
12268
  /**
12179
12269
  * @interface
12180
12270
  */
@@ -13288,7 +13378,8 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
13288
13378
  */
13289
13379
  getRvmInfo(): Promise<OpenFin.RVMInfo>;
13290
13380
  /**
13291
- * Retrieves system information.
13381
+ * Retrieves general system information. If you need more detailed information about the
13382
+ * OS and the currently logged in user, use `fin.System.getOSInfo()` instead.
13292
13383
  *
13293
13384
  * @example
13294
13385
  * ```js
@@ -13296,6 +13387,15 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
13296
13387
  * ```
13297
13388
  */
13298
13389
  getHostSpecs(): Promise<OpenFin.HostSpecs>;
13390
+ /**
13391
+ * Retrieves information about the OS and the currently logged in user.
13392
+ *
13393
+ * @example
13394
+ * ```js
13395
+ * fin.System.getOSInfo().then(specs => console.log(specs)).catch(err => console.log(err));
13396
+ * ```
13397
+ */
13398
+ getOSInfo(): Promise<OpenFin.OSInfo>;
13299
13399
  /**
13300
13400
  * Runs an executable or batch file. A path to the file must be included in options.
13301
13401
  * <br> A uuid may be optionally provided. If not provided, OpenFin will create a uuid for the new process.
@@ -14423,6 +14523,7 @@ declare type SystemEventType = EventType_8;
14423
14523
  * @interface
14424
14524
  */
14425
14525
  declare type SystemPermissions = {
14526
+ getOSInfo: boolean;
14426
14527
  getAllExternalWindows: boolean;
14427
14528
  launchExternalProcess: boolean | {
14428
14529
  enabled: boolean;
@@ -15520,6 +15621,8 @@ declare namespace ViewEvents {
15520
15621
  BaseEvent_4 as BaseEvent,
15521
15622
  BaseViewEvent,
15522
15623
  TargetChangedEvent,
15624
+ AddedToLayoutEvent,
15625
+ RemovedFromLayoutEvent,
15523
15626
  NonPropagatedViewEvent,
15524
15627
  CreatedEvent,
15525
15628
  DestroyedEvent,
@@ -42,6 +42,15 @@ declare type Accelerator = {
42
42
  zoom: boolean;
43
43
  };
44
44
 
45
+ /**
46
+ * Generated when a View is added to a layout.
47
+ * @interface
48
+ */
49
+ declare type AddedToLayoutEvent = BaseEvent_4 & {
50
+ type: 'added-to-layout';
51
+ layoutIdentity: OpenFin.LayoutIdentity;
52
+ };
53
+
45
54
  /**
46
55
  * Options to use when adding a view to a {@link TabStack}.
47
56
  *
@@ -3699,6 +3708,7 @@ declare type ContainerCreatedEvent = LayoutDOMEvent & {
3699
3708
 
3700
3709
  /**
3701
3710
  * Generated when content navigation or redirection is blocked by {@link OpenFin.DomainSettings}.
3711
+ * @interface
3702
3712
  */
3703
3713
  declare type ContentBlockedEvent = NamedEvent & {
3704
3714
  type: 'content-blocked';
@@ -4706,6 +4716,7 @@ declare type ErrorPlainObject = {
4706
4716
  stack?: string;
4707
4717
  message: string;
4708
4718
  name?: string;
4719
+ cause?: Error | ErrorPlainObject;
4709
4720
  toString(): string;
4710
4721
  };
4711
4722
 
@@ -4754,7 +4765,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
4754
4765
  */
4755
4766
  declare type Event_4 = (WebContentsEvents.Event<'view'> & {
4756
4767
  target: OpenFin.Identity;
4757
- }) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
4768
+ }) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent | AddedToLayoutEvent | RemovedFromLayoutEvent;
4758
4769
 
4759
4770
  /**
4760
4771
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
@@ -8562,6 +8573,23 @@ declare type LogLevel = OpenFin.LogLevel;
8562
8573
  */
8563
8574
  declare type LogLevel_2 = 'verbose' | 'info' | 'warning' | 'error' | 'fatal';
8564
8575
 
8576
+ declare type LogUploaderUIOptions = {
8577
+ title?: string;
8578
+ icon?: string;
8579
+ header?: string;
8580
+ description?: string;
8581
+ email?: string;
8582
+ website?: string;
8583
+ websiteDescription?: string;
8584
+ };
8585
+
8586
+ declare type LogUploadOptions = {
8587
+ endpoint: string;
8588
+ manifests?: string[];
8589
+ logs?: string[];
8590
+ ui?: LogUploaderUIOptions;
8591
+ };
8592
+
8565
8593
  /**
8566
8594
  * @interface
8567
8595
  */
@@ -8620,6 +8648,7 @@ declare type Manifest = {
8620
8648
  enableErrorReporting?: boolean;
8621
8649
  };
8622
8650
  interopBrokerConfiguration: InteropBrokerOptions;
8651
+ logUpload?: LogUploadOptions;
8623
8652
  };
8624
8653
 
8625
8654
  /**
@@ -9251,6 +9280,34 @@ declare type NavigationRules = {
9251
9280
 
9252
9281
  declare type NewConnectConfig = ConfigWithUuid & ConfigWithRuntime;
9253
9282
 
9283
+ declare interface NodeNetworkInterfaceBase {
9284
+ address: string;
9285
+ netmask: string;
9286
+ mac: string;
9287
+ internal: boolean;
9288
+ cidr: string | null;
9289
+ }
9290
+
9291
+ declare type NodeNetworkInterfaceInfo = NodeNetworkInterfaceInfoIPv4 | NodeNetworkInterfaceInfoIPv6;
9292
+
9293
+ declare interface NodeNetworkInterfaceInfoIPv4 extends NodeNetworkInterfaceBase {
9294
+ family: 'IPv4';
9295
+ scopeid?: undefined;
9296
+ }
9297
+
9298
+ declare interface NodeNetworkInterfaceInfoIPv6 extends NodeNetworkInterfaceBase {
9299
+ family: 'IPv6';
9300
+ scopeid: number;
9301
+ }
9302
+
9303
+ declare interface NodeUserInfo {
9304
+ username: string;
9305
+ uid: number;
9306
+ gid: number;
9307
+ shell: string | null;
9308
+ homedir: string;
9309
+ }
9310
+
9254
9311
  /**
9255
9312
  * @interface
9256
9313
  */
@@ -9453,6 +9510,8 @@ declare namespace OpenFin {
9453
9510
  PlatformViewCreationOptions,
9454
9511
  ProcessAffinityStrategy,
9455
9512
  PlatformOptions,
9513
+ LogUploaderUIOptions,
9514
+ LogUploadOptions,
9456
9515
  Manifest,
9457
9516
  LayoutContent,
9458
9517
  LayoutItemConfig,
@@ -9480,6 +9539,7 @@ declare namespace OpenFin {
9480
9539
  Time,
9481
9540
  CpuInfo,
9482
9541
  GpuInfo,
9542
+ OSInfo,
9483
9543
  HostSpecs,
9484
9544
  PrinterInfo_2 as PrinterInfo,
9485
9545
  Dpi,
@@ -9687,6 +9747,25 @@ declare type OptionsChangedEvent = BaseEvent_5 & {
9687
9747
  diff: OpenFin.WindowOptionDiff;
9688
9748
  };
9689
9749
 
9750
+ /**
9751
+ * @interface
9752
+ * The keys represent the output from calling individual Node `os` APIs.
9753
+ * For example, `userInfo` will have the output of calling `os.userInfo()`. For more information
9754
+ * see [Node `os` API docs](https://nodejs.org/docs/latest-v20.x/api/os.html)
9755
+ */
9756
+ declare type OSInfo = {
9757
+ platform: string;
9758
+ release: string;
9759
+ version: string;
9760
+ /**
9761
+ * Throws if a user has no username or homedir.
9762
+ * See [Node os.userInfo docs for more info](https://nodejs.org/docs/latest-v20.x/api/os.html#osuserinfooptions)
9763
+ */
9764
+ userInfo: NodeUserInfo;
9765
+ hostname: string;
9766
+ networkInterfaces: Record<string, NodeNetworkInterfaceInfo[] | undefined>;
9767
+ };
9768
+
9690
9769
  declare type OverrideCallback<T extends any = PlatformProvider, U extends T = T> = (arg: Constructor<T>) => U | Promise<U>;
9691
9770
 
9692
9771
  /**
@@ -11948,6 +12027,8 @@ declare interface ProtocolMap extends ProtocolMapBase {
11948
12027
  };
11949
12028
  response: void;
11950
12029
  };
12030
+ 'get-host-specs': GetterCall<OpenFin.HostSpecs>;
12031
+ 'get-os-info': GetterCall<OpenFin.OSInfo>;
11951
12032
  'system-get-printers': GetterCall<OpenFin.PrinterInfo[]>;
11952
12033
  'system-register-shutdown-handler': VoidCall;
11953
12034
  'get-domain-settings': ApiCall<OpenFin.ApplicationIdentity, OpenFin.DefaultDomainSettings>;
@@ -12175,6 +12256,15 @@ declare interface RemoteConfig extends ExistingConnectConfig {
12175
12256
  token: string;
12176
12257
  }
12177
12258
 
12259
+ /**
12260
+ * Generated when a View is removed from a layout.
12261
+ * @interface
12262
+ */
12263
+ declare type RemovedFromLayoutEvent = BaseEvent_4 & {
12264
+ type: 'removed-from-layout';
12265
+ layoutIdentity: OpenFin.LayoutIdentity;
12266
+ };
12267
+
12178
12268
  /**
12179
12269
  * @interface
12180
12270
  */
@@ -13288,7 +13378,8 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
13288
13378
  */
13289
13379
  getRvmInfo(): Promise<OpenFin.RVMInfo>;
13290
13380
  /**
13291
- * Retrieves system information.
13381
+ * Retrieves general system information. If you need more detailed information about the
13382
+ * OS and the currently logged in user, use `fin.System.getOSInfo()` instead.
13292
13383
  *
13293
13384
  * @example
13294
13385
  * ```js
@@ -13296,6 +13387,15 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
13296
13387
  * ```
13297
13388
  */
13298
13389
  getHostSpecs(): Promise<OpenFin.HostSpecs>;
13390
+ /**
13391
+ * Retrieves information about the OS and the currently logged in user.
13392
+ *
13393
+ * @example
13394
+ * ```js
13395
+ * fin.System.getOSInfo().then(specs => console.log(specs)).catch(err => console.log(err));
13396
+ * ```
13397
+ */
13398
+ getOSInfo(): Promise<OpenFin.OSInfo>;
13299
13399
  /**
13300
13400
  * Runs an executable or batch file. A path to the file must be included in options.
13301
13401
  * <br> A uuid may be optionally provided. If not provided, OpenFin will create a uuid for the new process.
@@ -14423,6 +14523,7 @@ declare type SystemEventType = EventType_8;
14423
14523
  * @interface
14424
14524
  */
14425
14525
  declare type SystemPermissions = {
14526
+ getOSInfo: boolean;
14426
14527
  getAllExternalWindows: boolean;
14427
14528
  launchExternalProcess: boolean | {
14428
14529
  enabled: boolean;
@@ -15520,6 +15621,8 @@ declare namespace ViewEvents {
15520
15621
  BaseEvent_4 as BaseEvent,
15521
15622
  BaseViewEvent,
15522
15623
  TargetChangedEvent,
15624
+ AddedToLayoutEvent,
15625
+ RemovedFromLayoutEvent,
15523
15626
  NonPropagatedViewEvent,
15524
15627
  CreatedEvent,
15525
15628
  DestroyedEvent,
@@ -42,6 +42,15 @@ declare type Accelerator = {
42
42
  zoom: boolean;
43
43
  };
44
44
 
45
+ /**
46
+ * Generated when a View is added to a layout.
47
+ * @interface
48
+ */
49
+ declare type AddedToLayoutEvent = BaseEvent_4 & {
50
+ type: 'added-to-layout';
51
+ layoutIdentity: OpenFin.LayoutIdentity;
52
+ };
53
+
45
54
  /**
46
55
  * Options to use when adding a view to a {@link TabStack}.
47
56
  *
@@ -3699,6 +3708,7 @@ declare type ContainerCreatedEvent = LayoutDOMEvent & {
3699
3708
 
3700
3709
  /**
3701
3710
  * Generated when content navigation or redirection is blocked by {@link OpenFin.DomainSettings}.
3711
+ * @interface
3702
3712
  */
3703
3713
  declare type ContentBlockedEvent = NamedEvent & {
3704
3714
  type: 'content-blocked';
@@ -4706,6 +4716,7 @@ declare type ErrorPlainObject = {
4706
4716
  stack?: string;
4707
4717
  message: string;
4708
4718
  name?: string;
4719
+ cause?: Error | ErrorPlainObject;
4709
4720
  toString(): string;
4710
4721
  };
4711
4722
 
@@ -4754,7 +4765,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
4754
4765
  */
4755
4766
  declare type Event_4 = (WebContentsEvents.Event<'view'> & {
4756
4767
  target: OpenFin.Identity;
4757
- }) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
4768
+ }) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent | AddedToLayoutEvent | RemovedFromLayoutEvent;
4758
4769
 
4759
4770
  /**
4760
4771
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
@@ -8562,6 +8573,23 @@ declare type LogLevel = OpenFin.LogLevel;
8562
8573
  */
8563
8574
  declare type LogLevel_2 = 'verbose' | 'info' | 'warning' | 'error' | 'fatal';
8564
8575
 
8576
+ declare type LogUploaderUIOptions = {
8577
+ title?: string;
8578
+ icon?: string;
8579
+ header?: string;
8580
+ description?: string;
8581
+ email?: string;
8582
+ website?: string;
8583
+ websiteDescription?: string;
8584
+ };
8585
+
8586
+ declare type LogUploadOptions = {
8587
+ endpoint: string;
8588
+ manifests?: string[];
8589
+ logs?: string[];
8590
+ ui?: LogUploaderUIOptions;
8591
+ };
8592
+
8565
8593
  /**
8566
8594
  * @interface
8567
8595
  */
@@ -8620,6 +8648,7 @@ declare type Manifest = {
8620
8648
  enableErrorReporting?: boolean;
8621
8649
  };
8622
8650
  interopBrokerConfiguration: InteropBrokerOptions;
8651
+ logUpload?: LogUploadOptions;
8623
8652
  };
8624
8653
 
8625
8654
  /**
@@ -9251,6 +9280,34 @@ declare type NavigationRules = {
9251
9280
 
9252
9281
  declare type NewConnectConfig = ConfigWithUuid & ConfigWithRuntime;
9253
9282
 
9283
+ declare interface NodeNetworkInterfaceBase {
9284
+ address: string;
9285
+ netmask: string;
9286
+ mac: string;
9287
+ internal: boolean;
9288
+ cidr: string | null;
9289
+ }
9290
+
9291
+ declare type NodeNetworkInterfaceInfo = NodeNetworkInterfaceInfoIPv4 | NodeNetworkInterfaceInfoIPv6;
9292
+
9293
+ declare interface NodeNetworkInterfaceInfoIPv4 extends NodeNetworkInterfaceBase {
9294
+ family: 'IPv4';
9295
+ scopeid?: undefined;
9296
+ }
9297
+
9298
+ declare interface NodeNetworkInterfaceInfoIPv6 extends NodeNetworkInterfaceBase {
9299
+ family: 'IPv6';
9300
+ scopeid: number;
9301
+ }
9302
+
9303
+ declare interface NodeUserInfo {
9304
+ username: string;
9305
+ uid: number;
9306
+ gid: number;
9307
+ shell: string | null;
9308
+ homedir: string;
9309
+ }
9310
+
9254
9311
  /**
9255
9312
  * @interface
9256
9313
  */
@@ -9453,6 +9510,8 @@ declare namespace OpenFin {
9453
9510
  PlatformViewCreationOptions,
9454
9511
  ProcessAffinityStrategy,
9455
9512
  PlatformOptions,
9513
+ LogUploaderUIOptions,
9514
+ LogUploadOptions,
9456
9515
  Manifest,
9457
9516
  LayoutContent,
9458
9517
  LayoutItemConfig,
@@ -9480,6 +9539,7 @@ declare namespace OpenFin {
9480
9539
  Time,
9481
9540
  CpuInfo,
9482
9541
  GpuInfo,
9542
+ OSInfo,
9483
9543
  HostSpecs,
9484
9544
  PrinterInfo_2 as PrinterInfo,
9485
9545
  Dpi,
@@ -9687,6 +9747,25 @@ declare type OptionsChangedEvent = BaseEvent_5 & {
9687
9747
  diff: OpenFin.WindowOptionDiff;
9688
9748
  };
9689
9749
 
9750
+ /**
9751
+ * @interface
9752
+ * The keys represent the output from calling individual Node `os` APIs.
9753
+ * For example, `userInfo` will have the output of calling `os.userInfo()`. For more information
9754
+ * see [Node `os` API docs](https://nodejs.org/docs/latest-v20.x/api/os.html)
9755
+ */
9756
+ declare type OSInfo = {
9757
+ platform: string;
9758
+ release: string;
9759
+ version: string;
9760
+ /**
9761
+ * Throws if a user has no username or homedir.
9762
+ * See [Node os.userInfo docs for more info](https://nodejs.org/docs/latest-v20.x/api/os.html#osuserinfooptions)
9763
+ */
9764
+ userInfo: NodeUserInfo;
9765
+ hostname: string;
9766
+ networkInterfaces: Record<string, NodeNetworkInterfaceInfo[] | undefined>;
9767
+ };
9768
+
9690
9769
  declare type OverrideCallback<T extends any = PlatformProvider, U extends T = T> = (arg: Constructor<T>) => U | Promise<U>;
9691
9770
 
9692
9771
  /**
@@ -11948,6 +12027,8 @@ declare interface ProtocolMap extends ProtocolMapBase {
11948
12027
  };
11949
12028
  response: void;
11950
12029
  };
12030
+ 'get-host-specs': GetterCall<OpenFin.HostSpecs>;
12031
+ 'get-os-info': GetterCall<OpenFin.OSInfo>;
11951
12032
  'system-get-printers': GetterCall<OpenFin.PrinterInfo[]>;
11952
12033
  'system-register-shutdown-handler': VoidCall;
11953
12034
  'get-domain-settings': ApiCall<OpenFin.ApplicationIdentity, OpenFin.DefaultDomainSettings>;
@@ -12175,6 +12256,15 @@ declare interface RemoteConfig extends ExistingConnectConfig {
12175
12256
  token: string;
12176
12257
  }
12177
12258
 
12259
+ /**
12260
+ * Generated when a View is removed from a layout.
12261
+ * @interface
12262
+ */
12263
+ declare type RemovedFromLayoutEvent = BaseEvent_4 & {
12264
+ type: 'removed-from-layout';
12265
+ layoutIdentity: OpenFin.LayoutIdentity;
12266
+ };
12267
+
12178
12268
  /**
12179
12269
  * @interface
12180
12270
  */
@@ -13288,7 +13378,8 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
13288
13378
  */
13289
13379
  getRvmInfo(): Promise<OpenFin.RVMInfo>;
13290
13380
  /**
13291
- * Retrieves system information.
13381
+ * Retrieves general system information. If you need more detailed information about the
13382
+ * OS and the currently logged in user, use `fin.System.getOSInfo()` instead.
13292
13383
  *
13293
13384
  * @example
13294
13385
  * ```js
@@ -13296,6 +13387,15 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
13296
13387
  * ```
13297
13388
  */
13298
13389
  getHostSpecs(): Promise<OpenFin.HostSpecs>;
13390
+ /**
13391
+ * Retrieves information about the OS and the currently logged in user.
13392
+ *
13393
+ * @example
13394
+ * ```js
13395
+ * fin.System.getOSInfo().then(specs => console.log(specs)).catch(err => console.log(err));
13396
+ * ```
13397
+ */
13398
+ getOSInfo(): Promise<OpenFin.OSInfo>;
13299
13399
  /**
13300
13400
  * Runs an executable or batch file. A path to the file must be included in options.
13301
13401
  * <br> A uuid may be optionally provided. If not provided, OpenFin will create a uuid for the new process.
@@ -14423,6 +14523,7 @@ declare type SystemEventType = EventType_8;
14423
14523
  * @interface
14424
14524
  */
14425
14525
  declare type SystemPermissions = {
14526
+ getOSInfo: boolean;
14426
14527
  getAllExternalWindows: boolean;
14427
14528
  launchExternalProcess: boolean | {
14428
14529
  enabled: boolean;
@@ -15520,6 +15621,8 @@ declare namespace ViewEvents {
15520
15621
  BaseEvent_4 as BaseEvent,
15521
15622
  BaseViewEvent,
15522
15623
  TargetChangedEvent,
15624
+ AddedToLayoutEvent,
15625
+ RemovedFromLayoutEvent,
15523
15626
  NonPropagatedViewEvent,
15524
15627
  CreatedEvent,
15525
15628
  DestroyedEvent,
package/out/fdc3-api.d.ts CHANGED
@@ -42,6 +42,15 @@ declare type Accelerator = {
42
42
  zoom: boolean;
43
43
  };
44
44
 
45
+ /**
46
+ * Generated when a View is added to a layout.
47
+ * @interface
48
+ */
49
+ declare type AddedToLayoutEvent = BaseEvent_4 & {
50
+ type: 'added-to-layout';
51
+ layoutIdentity: OpenFin.LayoutIdentity;
52
+ };
53
+
45
54
  /**
46
55
  * Options to use when adding a view to a {@link TabStack}.
47
56
  *
@@ -3758,6 +3767,7 @@ declare type ContainerCreatedEvent = LayoutDOMEvent & {
3758
3767
 
3759
3768
  /**
3760
3769
  * Generated when content navigation or redirection is blocked by {@link OpenFin.DomainSettings}.
3770
+ * @interface
3761
3771
  */
3762
3772
  declare type ContentBlockedEvent = NamedEvent & {
3763
3773
  type: 'content-blocked';
@@ -4770,6 +4780,7 @@ declare type ErrorPlainObject = {
4770
4780
  stack?: string;
4771
4781
  message: string;
4772
4782
  name?: string;
4783
+ cause?: Error | ErrorPlainObject;
4773
4784
  toString(): string;
4774
4785
  };
4775
4786
 
@@ -4818,7 +4829,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
4818
4829
  */
4819
4830
  declare type Event_4 = (WebContentsEvents.Event<'view'> & {
4820
4831
  target: OpenFin.Identity;
4821
- }) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
4832
+ }) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent | AddedToLayoutEvent | RemovedFromLayoutEvent;
4822
4833
 
4823
4834
  /**
4824
4835
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
@@ -8855,6 +8866,23 @@ declare type LogLevel = OpenFin.LogLevel;
8855
8866
  */
8856
8867
  declare type LogLevel_2 = 'verbose' | 'info' | 'warning' | 'error' | 'fatal';
8857
8868
 
8869
+ declare type LogUploaderUIOptions = {
8870
+ title?: string;
8871
+ icon?: string;
8872
+ header?: string;
8873
+ description?: string;
8874
+ email?: string;
8875
+ website?: string;
8876
+ websiteDescription?: string;
8877
+ };
8878
+
8879
+ declare type LogUploadOptions = {
8880
+ endpoint: string;
8881
+ manifests?: string[];
8882
+ logs?: string[];
8883
+ ui?: LogUploaderUIOptions;
8884
+ };
8885
+
8858
8886
  /**
8859
8887
  * @interface
8860
8888
  */
@@ -8913,6 +8941,7 @@ declare type Manifest = {
8913
8941
  enableErrorReporting?: boolean;
8914
8942
  };
8915
8943
  interopBrokerConfiguration: InteropBrokerOptions;
8944
+ logUpload?: LogUploadOptions;
8916
8945
  };
8917
8946
 
8918
8947
  /**
@@ -9556,6 +9585,34 @@ declare type NavigationRules = {
9556
9585
 
9557
9586
  declare type NewConnectConfig = ConfigWithUuid & ConfigWithRuntime;
9558
9587
 
9588
+ declare interface NodeNetworkInterfaceBase {
9589
+ address: string;
9590
+ netmask: string;
9591
+ mac: string;
9592
+ internal: boolean;
9593
+ cidr: string | null;
9594
+ }
9595
+
9596
+ declare type NodeNetworkInterfaceInfo = NodeNetworkInterfaceInfoIPv4 | NodeNetworkInterfaceInfoIPv6;
9597
+
9598
+ declare interface NodeNetworkInterfaceInfoIPv4 extends NodeNetworkInterfaceBase {
9599
+ family: 'IPv4';
9600
+ scopeid?: undefined;
9601
+ }
9602
+
9603
+ declare interface NodeNetworkInterfaceInfoIPv6 extends NodeNetworkInterfaceBase {
9604
+ family: 'IPv6';
9605
+ scopeid: number;
9606
+ }
9607
+
9608
+ declare interface NodeUserInfo {
9609
+ username: string;
9610
+ uid: number;
9611
+ gid: number;
9612
+ shell: string | null;
9613
+ homedir: string;
9614
+ }
9615
+
9559
9616
  /**
9560
9617
  * @interface
9561
9618
  */
@@ -9768,6 +9825,8 @@ declare namespace OpenFin {
9768
9825
  PlatformViewCreationOptions,
9769
9826
  ProcessAffinityStrategy,
9770
9827
  PlatformOptions,
9828
+ LogUploaderUIOptions,
9829
+ LogUploadOptions,
9771
9830
  Manifest,
9772
9831
  LayoutContent,
9773
9832
  LayoutItemConfig,
@@ -9795,6 +9854,7 @@ declare namespace OpenFin {
9795
9854
  Time,
9796
9855
  CpuInfo,
9797
9856
  GpuInfo,
9857
+ OSInfo,
9798
9858
  HostSpecs,
9799
9859
  PrinterInfo_2 as PrinterInfo,
9800
9860
  Dpi,
@@ -10002,6 +10062,25 @@ declare type OptionsChangedEvent = BaseEvent_5 & {
10002
10062
  diff: OpenFin.WindowOptionDiff;
10003
10063
  };
10004
10064
 
10065
+ /**
10066
+ * @interface
10067
+ * The keys represent the output from calling individual Node `os` APIs.
10068
+ * For example, `userInfo` will have the output of calling `os.userInfo()`. For more information
10069
+ * see [Node `os` API docs](https://nodejs.org/docs/latest-v20.x/api/os.html)
10070
+ */
10071
+ declare type OSInfo = {
10072
+ platform: string;
10073
+ release: string;
10074
+ version: string;
10075
+ /**
10076
+ * Throws if a user has no username or homedir.
10077
+ * See [Node os.userInfo docs for more info](https://nodejs.org/docs/latest-v20.x/api/os.html#osuserinfooptions)
10078
+ */
10079
+ userInfo: NodeUserInfo;
10080
+ hostname: string;
10081
+ networkInterfaces: Record<string, NodeNetworkInterfaceInfo[] | undefined>;
10082
+ };
10083
+
10005
10084
  declare type OverrideCallback<T extends any = PlatformProvider, U extends T = T> = (arg: Constructor<T>) => U | Promise<U>;
10006
10085
 
10007
10086
  /**
@@ -12341,6 +12420,8 @@ declare interface ProtocolMap extends ProtocolMapBase {
12341
12420
  };
12342
12421
  response: void;
12343
12422
  };
12423
+ 'get-host-specs': GetterCall<OpenFin.HostSpecs>;
12424
+ 'get-os-info': GetterCall<OpenFin.OSInfo>;
12344
12425
  'system-get-printers': GetterCall<OpenFin.PrinterInfo[]>;
12345
12426
  'system-register-shutdown-handler': VoidCall;
12346
12427
  'get-domain-settings': ApiCall<OpenFin.ApplicationIdentity, OpenFin.DefaultDomainSettings>;
@@ -12568,6 +12649,15 @@ declare interface RemoteConfig extends ExistingConnectConfig {
12568
12649
  token: string;
12569
12650
  }
12570
12651
 
12652
+ /**
12653
+ * Generated when a View is removed from a layout.
12654
+ * @interface
12655
+ */
12656
+ declare type RemovedFromLayoutEvent = BaseEvent_4 & {
12657
+ type: 'removed-from-layout';
12658
+ layoutIdentity: OpenFin.LayoutIdentity;
12659
+ };
12660
+
12571
12661
  /**
12572
12662
  * @interface
12573
12663
  */
@@ -13687,7 +13777,8 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
13687
13777
  */
13688
13778
  getRvmInfo(): Promise<OpenFin.RVMInfo>;
13689
13779
  /**
13690
- * Retrieves system information.
13780
+ * Retrieves general system information. If you need more detailed information about the
13781
+ * OS and the currently logged in user, use `fin.System.getOSInfo()` instead.
13691
13782
  *
13692
13783
  * @example
13693
13784
  * ```js
@@ -13695,6 +13786,15 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
13695
13786
  * ```
13696
13787
  */
13697
13788
  getHostSpecs(): Promise<OpenFin.HostSpecs>;
13789
+ /**
13790
+ * Retrieves information about the OS and the currently logged in user.
13791
+ *
13792
+ * @example
13793
+ * ```js
13794
+ * fin.System.getOSInfo().then(specs => console.log(specs)).catch(err => console.log(err));
13795
+ * ```
13796
+ */
13797
+ getOSInfo(): Promise<OpenFin.OSInfo>;
13698
13798
  /**
13699
13799
  * Runs an executable or batch file. A path to the file must be included in options.
13700
13800
  * <br> A uuid may be optionally provided. If not provided, OpenFin will create a uuid for the new process.
@@ -14822,6 +14922,7 @@ declare type SystemEventType = EventType_8;
14822
14922
  * @interface
14823
14923
  */
14824
14924
  declare type SystemPermissions = {
14925
+ getOSInfo: boolean;
14825
14926
  getAllExternalWindows: boolean;
14826
14927
  launchExternalProcess: boolean | {
14827
14928
  enabled: boolean;
@@ -15963,6 +16064,8 @@ declare namespace ViewEvents {
15963
16064
  BaseEvent_4 as BaseEvent,
15964
16065
  BaseViewEvent,
15965
16066
  TargetChangedEvent,
16067
+ AddedToLayoutEvent,
16068
+ RemovedFromLayoutEvent,
15966
16069
  NonPropagatedViewEvent,
15967
16070
  CreatedEvent,
15968
16071
  DestroyedEvent,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/fdc3-api",
3
- "version": "40.82.2",
3
+ "version": "40.82.4",
4
4
  "description": "OpenFin fdc3 module utilities and types.",
5
5
  "license": "SEE LICENSE IN LICENSE.MD",
6
6
  "private": false,