@openfin/fdc3-api 38.82.60 → 38.82.62

package/out/fdc3-api-alpha.d.ts

@@ -3702,6 +3702,7 @@ declare type ContainerCreatedEvent = LayoutDOMEvent & {
 
 /**
  * Generated when content navigation or redirection is blocked by {@link OpenFin.DomainSettings}.
+ * @interface
  */
 declare type ContentBlockedEvent = NamedEvent & {
     type: 'content-blocked';
@@ -9247,6 +9248,34 @@ declare type NavigationRules = {
 
 declare type NewConnectConfig = ConfigWithUuid & ConfigWithRuntime;
 
+declare interface NodeNetworkInterfaceBase {
+    address: string;
+    netmask: string;
+    mac: string;
+    internal: boolean;
+    cidr: string | null;
+}
+
+declare type NodeNetworkInterfaceInfo = NodeNetworkInterfaceInfoIPv4 | NodeNetworkInterfaceInfoIPv6;
+
+declare interface NodeNetworkInterfaceInfoIPv4 extends NodeNetworkInterfaceBase {
+    family: 'IPv4';
+    scopeid?: undefined;
+}
+
+declare interface NodeNetworkInterfaceInfoIPv6 extends NodeNetworkInterfaceBase {
+    family: 'IPv6';
+    scopeid: number;
+}
+
+declare interface NodeUserInfo {
+    username: string;
+    uid: number;
+    gid: number;
+    shell: string | null;
+    homedir: string;
+}
+
 /**
  * @interface
  */
@@ -9476,6 +9505,7 @@ declare namespace OpenFin {
         Time,
         CpuInfo,
         GpuInfo,
+        OSInfo,
         HostSpecs,
         PrinterInfo_2 as PrinterInfo,
         Dpi,
@@ -9683,6 +9713,25 @@ declare type OptionsChangedEvent = BaseEvent_5 & {
     diff: OpenFin.WindowOptionDiff;
 };
 
+/**
+ * @interface
+ * The keys represent the output from calling individual Node `os` APIs.
+ * For example, `userInfo` will have the output of calling `os.userInfo()`. For more information
+ * see [Node `os` API docs](https://nodejs.org/docs/latest-v20.x/api/os.html)
+ */
+declare type OSInfo = {
+    platform: string;
+    release: string;
+    version: string;
+    /**
+     * Throws if a user has no username or homedir.
+     * See [Node os.userInfo docs for more info](https://nodejs.org/docs/latest-v20.x/api/os.html#osuserinfooptions)
+     */
+    userInfo: NodeUserInfo;
+    hostname: string;
+    networkInterfaces: Record<string, NodeNetworkInterfaceInfo[] | undefined>;
+};
+
 declare type OverrideCallback<T extends any = PlatformProvider, U extends T = T> = (arg: Constructor<T>) => U | Promise<U>;
 
 /**
@@ -11944,6 +11993,8 @@ declare interface ProtocolMap extends ProtocolMapBase {
         };
         response: void;
     };
+    'get-host-specs': GetterCall<OpenFin.HostSpecs>;
+    'get-os-info': GetterCall<OpenFin.OSInfo>;
     'system-get-printers': GetterCall<OpenFin.PrinterInfo[]>;
     'system-register-shutdown-handler': VoidCall;
     'get-domain-settings': ApiCall<OpenFin.ApplicationIdentity, OpenFin.DefaultDomainSettings>;
@@ -13284,7 +13335,8 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
      */
     getRvmInfo(): Promise<OpenFin.RVMInfo>;
     /**
-     * Retrieves system information.
+     * Retrieves general system information. If you need more detailed information about the
+     * OS and the currently logged in user, use `fin.System.getOSInfo()` instead.
      *
      * @example
      * ```js
@@ -13292,6 +13344,15 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
      * ```
      */
     getHostSpecs(): Promise<OpenFin.HostSpecs>;
+    /**
+     * Retrieves information about the OS and the currently logged in user.
+     *
+     * @example
+     * ```js
+     * fin.System.getOSInfo().then(specs => console.log(specs)).catch(err => console.log(err));
+     * ```
+     */
+    getOSInfo(): Promise<OpenFin.OSInfo>;
     /**
      * Runs an executable or batch file. A path to the file must be included in options.
      * <br> A uuid may be optionally provided. If not provided, OpenFin will create a uuid for the new process.
@@ -14419,6 +14480,7 @@ declare type SystemEventType = EventType_8;
  * @interface
  */
 declare type SystemPermissions = {
+    getOSInfo: boolean;
     getAllExternalWindows: boolean;
     launchExternalProcess: boolean | {
         enabled: boolean;

package/out/fdc3-api-beta.d.ts

@@ -3702,6 +3702,7 @@ declare type ContainerCreatedEvent = LayoutDOMEvent & {
 
 /**
  * Generated when content navigation or redirection is blocked by {@link OpenFin.DomainSettings}.
+ * @interface
  */
 declare type ContentBlockedEvent = NamedEvent & {
     type: 'content-blocked';
@@ -9247,6 +9248,34 @@ declare type NavigationRules = {
 
 declare type NewConnectConfig = ConfigWithUuid & ConfigWithRuntime;
 
+declare interface NodeNetworkInterfaceBase {
+    address: string;
+    netmask: string;
+    mac: string;
+    internal: boolean;
+    cidr: string | null;
+}
+
+declare type NodeNetworkInterfaceInfo = NodeNetworkInterfaceInfoIPv4 | NodeNetworkInterfaceInfoIPv6;
+
+declare interface NodeNetworkInterfaceInfoIPv4 extends NodeNetworkInterfaceBase {
+    family: 'IPv4';
+    scopeid?: undefined;
+}
+
+declare interface NodeNetworkInterfaceInfoIPv6 extends NodeNetworkInterfaceBase {
+    family: 'IPv6';
+    scopeid: number;
+}
+
+declare interface NodeUserInfo {
+    username: string;
+    uid: number;
+    gid: number;
+    shell: string | null;
+    homedir: string;
+}
+
 /**
  * @interface
  */
@@ -9476,6 +9505,7 @@ declare namespace OpenFin {
         Time,
         CpuInfo,
         GpuInfo,
+        OSInfo,
         HostSpecs,
         PrinterInfo_2 as PrinterInfo,
         Dpi,
@@ -9683,6 +9713,25 @@ declare type OptionsChangedEvent = BaseEvent_5 & {
     diff: OpenFin.WindowOptionDiff;
 };
 
+/**
+ * @interface
+ * The keys represent the output from calling individual Node `os` APIs.
+ * For example, `userInfo` will have the output of calling `os.userInfo()`. For more information
+ * see [Node `os` API docs](https://nodejs.org/docs/latest-v20.x/api/os.html)
+ */
+declare type OSInfo = {
+    platform: string;
+    release: string;
+    version: string;
+    /**
+     * Throws if a user has no username or homedir.
+     * See [Node os.userInfo docs for more info](https://nodejs.org/docs/latest-v20.x/api/os.html#osuserinfooptions)
+     */
+    userInfo: NodeUserInfo;
+    hostname: string;
+    networkInterfaces: Record<string, NodeNetworkInterfaceInfo[] | undefined>;
+};
+
 declare type OverrideCallback<T extends any = PlatformProvider, U extends T = T> = (arg: Constructor<T>) => U | Promise<U>;
 
 /**
@@ -11944,6 +11993,8 @@ declare interface ProtocolMap extends ProtocolMapBase {
         };
         response: void;
     };
+    'get-host-specs': GetterCall<OpenFin.HostSpecs>;
+    'get-os-info': GetterCall<OpenFin.OSInfo>;
     'system-get-printers': GetterCall<OpenFin.PrinterInfo[]>;
     'system-register-shutdown-handler': VoidCall;
     'get-domain-settings': ApiCall<OpenFin.ApplicationIdentity, OpenFin.DefaultDomainSettings>;
@@ -13284,7 +13335,8 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
      */
     getRvmInfo(): Promise<OpenFin.RVMInfo>;
     /**
-     * Retrieves system information.
+     * Retrieves general system information. If you need more detailed information about the
+     * OS and the currently logged in user, use `fin.System.getOSInfo()` instead.
      *
      * @example
      * ```js
@@ -13292,6 +13344,15 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
      * ```
      */
     getHostSpecs(): Promise<OpenFin.HostSpecs>;
+    /**
+     * Retrieves information about the OS and the currently logged in user.
+     *
+     * @example
+     * ```js
+     * fin.System.getOSInfo().then(specs => console.log(specs)).catch(err => console.log(err));
+     * ```
+     */
+    getOSInfo(): Promise<OpenFin.OSInfo>;
     /**
      * Runs an executable or batch file. A path to the file must be included in options.
      * <br> A uuid may be optionally provided. If not provided, OpenFin will create a uuid for the new process.
@@ -14419,6 +14480,7 @@ declare type SystemEventType = EventType_8;
  * @interface
  */
 declare type SystemPermissions = {
+    getOSInfo: boolean;
     getAllExternalWindows: boolean;
     launchExternalProcess: boolean | {
         enabled: boolean;

package/out/fdc3-api-public.d.ts

@@ -3702,6 +3702,7 @@ declare type ContainerCreatedEvent = LayoutDOMEvent & {
 
 /**
  * Generated when content navigation or redirection is blocked by {@link OpenFin.DomainSettings}.
+ * @interface
  */
 declare type ContentBlockedEvent = NamedEvent & {
     type: 'content-blocked';
@@ -9247,6 +9248,34 @@ declare type NavigationRules = {
 
 declare type NewConnectConfig = ConfigWithUuid & ConfigWithRuntime;
 
+declare interface NodeNetworkInterfaceBase {
+    address: string;
+    netmask: string;
+    mac: string;
+    internal: boolean;
+    cidr: string | null;
+}
+
+declare type NodeNetworkInterfaceInfo = NodeNetworkInterfaceInfoIPv4 | NodeNetworkInterfaceInfoIPv6;
+
+declare interface NodeNetworkInterfaceInfoIPv4 extends NodeNetworkInterfaceBase {
+    family: 'IPv4';
+    scopeid?: undefined;
+}
+
+declare interface NodeNetworkInterfaceInfoIPv6 extends NodeNetworkInterfaceBase {
+    family: 'IPv6';
+    scopeid: number;
+}
+
+declare interface NodeUserInfo {
+    username: string;
+    uid: number;
+    gid: number;
+    shell: string | null;
+    homedir: string;
+}
+
 /**
  * @interface
  */
@@ -9476,6 +9505,7 @@ declare namespace OpenFin {
         Time,
         CpuInfo,
         GpuInfo,
+        OSInfo,
         HostSpecs,
         PrinterInfo_2 as PrinterInfo,
         Dpi,
@@ -9683,6 +9713,25 @@ declare type OptionsChangedEvent = BaseEvent_5 & {
     diff: OpenFin.WindowOptionDiff;
 };
 
+/**
+ * @interface
+ * The keys represent the output from calling individual Node `os` APIs.
+ * For example, `userInfo` will have the output of calling `os.userInfo()`. For more information
+ * see [Node `os` API docs](https://nodejs.org/docs/latest-v20.x/api/os.html)
+ */
+declare type OSInfo = {
+    platform: string;
+    release: string;
+    version: string;
+    /**
+     * Throws if a user has no username or homedir.
+     * See [Node os.userInfo docs for more info](https://nodejs.org/docs/latest-v20.x/api/os.html#osuserinfooptions)
+     */
+    userInfo: NodeUserInfo;
+    hostname: string;
+    networkInterfaces: Record<string, NodeNetworkInterfaceInfo[] | undefined>;
+};
+
 declare type OverrideCallback<T extends any = PlatformProvider, U extends T = T> = (arg: Constructor<T>) => U | Promise<U>;
 
 /**
@@ -11944,6 +11993,8 @@ declare interface ProtocolMap extends ProtocolMapBase {
         };
         response: void;
     };
+    'get-host-specs': GetterCall<OpenFin.HostSpecs>;
+    'get-os-info': GetterCall<OpenFin.OSInfo>;
     'system-get-printers': GetterCall<OpenFin.PrinterInfo[]>;
     'system-register-shutdown-handler': VoidCall;
     'get-domain-settings': ApiCall<OpenFin.ApplicationIdentity, OpenFin.DefaultDomainSettings>;
@@ -13284,7 +13335,8 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
      */
     getRvmInfo(): Promise<OpenFin.RVMInfo>;
     /**
-     * Retrieves system information.
+     * Retrieves general system information. If you need more detailed information about the
+     * OS and the currently logged in user, use `fin.System.getOSInfo()` instead.
      *
      * @example
      * ```js
@@ -13292,6 +13344,15 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
      * ```
      */
     getHostSpecs(): Promise<OpenFin.HostSpecs>;
+    /**
+     * Retrieves information about the OS and the currently logged in user.
+     *
+     * @example
+     * ```js
+     * fin.System.getOSInfo().then(specs => console.log(specs)).catch(err => console.log(err));
+     * ```
+     */
+    getOSInfo(): Promise<OpenFin.OSInfo>;
     /**
      * Runs an executable or batch file. A path to the file must be included in options.
      * <br> A uuid may be optionally provided. If not provided, OpenFin will create a uuid for the new process.
@@ -14419,6 +14480,7 @@ declare type SystemEventType = EventType_8;
  * @interface
  */
 declare type SystemPermissions = {
+    getOSInfo: boolean;
     getAllExternalWindows: boolean;
     launchExternalProcess: boolean | {
         enabled: boolean;

package/out/fdc3-api.d.ts

@@ -3761,6 +3761,7 @@ declare type ContainerCreatedEvent = LayoutDOMEvent & {
 
 /**
  * Generated when content navigation or redirection is blocked by {@link OpenFin.DomainSettings}.
+ * @interface
  */
 declare type ContentBlockedEvent = NamedEvent & {
     type: 'content-blocked';
@@ -9552,6 +9553,34 @@ declare type NavigationRules = {
 
 declare type NewConnectConfig = ConfigWithUuid & ConfigWithRuntime;
 
+declare interface NodeNetworkInterfaceBase {
+    address: string;
+    netmask: string;
+    mac: string;
+    internal: boolean;
+    cidr: string | null;
+}
+
+declare type NodeNetworkInterfaceInfo = NodeNetworkInterfaceInfoIPv4 | NodeNetworkInterfaceInfoIPv6;
+
+declare interface NodeNetworkInterfaceInfoIPv4 extends NodeNetworkInterfaceBase {
+    family: 'IPv4';
+    scopeid?: undefined;
+}
+
+declare interface NodeNetworkInterfaceInfoIPv6 extends NodeNetworkInterfaceBase {
+    family: 'IPv6';
+    scopeid: number;
+}
+
+declare interface NodeUserInfo {
+    username: string;
+    uid: number;
+    gid: number;
+    shell: string | null;
+    homedir: string;
+}
+
 /**
  * @interface
  */
@@ -9791,6 +9820,7 @@ declare namespace OpenFin {
         Time,
         CpuInfo,
         GpuInfo,
+        OSInfo,
         HostSpecs,
         PrinterInfo_2 as PrinterInfo,
         Dpi,
@@ -9998,6 +10028,25 @@ declare type OptionsChangedEvent = BaseEvent_5 & {
     diff: OpenFin.WindowOptionDiff;
 };
 
+/**
+ * @interface
+ * The keys represent the output from calling individual Node `os` APIs.
+ * For example, `userInfo` will have the output of calling `os.userInfo()`. For more information
+ * see [Node `os` API docs](https://nodejs.org/docs/latest-v20.x/api/os.html)
+ */
+declare type OSInfo = {
+    platform: string;
+    release: string;
+    version: string;
+    /**
+     * Throws if a user has no username or homedir.
+     * See [Node os.userInfo docs for more info](https://nodejs.org/docs/latest-v20.x/api/os.html#osuserinfooptions)
+     */
+    userInfo: NodeUserInfo;
+    hostname: string;
+    networkInterfaces: Record<string, NodeNetworkInterfaceInfo[] | undefined>;
+};
+
 declare type OverrideCallback<T extends any = PlatformProvider, U extends T = T> = (arg: Constructor<T>) => U | Promise<U>;
 
 /**
@@ -12337,6 +12386,8 @@ declare interface ProtocolMap extends ProtocolMapBase {
         };
         response: void;
     };
+    'get-host-specs': GetterCall<OpenFin.HostSpecs>;
+    'get-os-info': GetterCall<OpenFin.OSInfo>;
     'system-get-printers': GetterCall<OpenFin.PrinterInfo[]>;
     'system-register-shutdown-handler': VoidCall;
     'get-domain-settings': ApiCall<OpenFin.ApplicationIdentity, OpenFin.DefaultDomainSettings>;
@@ -13683,7 +13734,8 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
      */
     getRvmInfo(): Promise<OpenFin.RVMInfo>;
     /**
-     * Retrieves system information.
+     * Retrieves general system information. If you need more detailed information about the
+     * OS and the currently logged in user, use `fin.System.getOSInfo()` instead.
      *
      * @example
      * ```js
@@ -13691,6 +13743,15 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
      * ```
      */
     getHostSpecs(): Promise<OpenFin.HostSpecs>;
+    /**
+     * Retrieves information about the OS and the currently logged in user.
+     *
+     * @example
+     * ```js
+     * fin.System.getOSInfo().then(specs => console.log(specs)).catch(err => console.log(err));
+     * ```
+     */
+    getOSInfo(): Promise<OpenFin.OSInfo>;
     /**
      * Runs an executable or batch file. A path to the file must be included in options.
      * <br> A uuid may be optionally provided. If not provided, OpenFin will create a uuid for the new process.
@@ -14818,6 +14879,7 @@ declare type SystemEventType = EventType_8;
  * @interface
  */
 declare type SystemPermissions = {
+    getOSInfo: boolean;
     getAllExternalWindows: boolean;
     launchExternalProcess: boolean | {
         enabled: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/fdc3-api",
-    "version": "38.82.60",
+    "version": "38.82.62",
     "description": "OpenFin fdc3 module utilities and types.",
     "license": "SEE LICENSE IN LICENSE.MD",
     "private": false,