From d3175aa9978a8bd3fc93af4d0bdeda9c8600578a Mon Sep 17 00:00:00 2001 From: licui Date: Tue, 30 Oct 2018 14:41:40 -0400 Subject: [PATCH] update LogInfo, ProxyInfo and RVMInfo shapes --- types/openfin/_v2/api/system/proxy.d.ts | 13 ++++---- types/openfin/_v2/api/system/rvm.d.ts | 3 ++ types/openfin/_v2/api/system/system.d.ts | 37 ++++++++++++++++++++-- types/openfin/index.d.ts | 40 +++--------------------- 4 files changed, 48 insertions(+), 45 deletions(-) diff --git a/types/openfin/_v2/api/system/proxy.d.ts b/types/openfin/_v2/api/system/proxy.d.ts index 597afa6548..2f8a945903 100644 --- a/types/openfin/_v2/api/system/proxy.d.ts +++ b/types/openfin/_v2/api/system/proxy.d.ts @@ -1,14 +1,15 @@ export interface ProxyInfo { config: ProxyConfig; - system: { - autoConfigUrl: string; - bypass: ''; - enabled: boolean; - proxy: string; - }; + system: ProxySystemInfo; } export interface ProxyConfig { proxyAddress: string; proxyPort: number; type: string; } +export interface ProxySystemInfo { + autoConfigUrl: string; + bypass: string; + enabled: boolean; + proxy: string; +} diff --git a/types/openfin/_v2/api/system/rvm.d.ts b/types/openfin/_v2/api/system/rvm.d.ts index 42fc0b94db..fb8737a081 100644 --- a/types/openfin/_v2/api/system/rvm.d.ts +++ b/types/openfin/_v2/api/system/rvm.d.ts @@ -1,5 +1,8 @@ export interface RVMInfo { action: string; + appLogDirectory: string; + path: string; 'start-time': string; version: string; + 'working-dir': string; } diff --git a/types/openfin/_v2/api/system/system.d.ts b/types/openfin/_v2/api/system/system.d.ts index aa0467f340..24c6ed7ff7 100644 --- a/types/openfin/_v2/api/system/system.d.ts +++ b/types/openfin/_v2/api/system/system.d.ts @@ -149,6 +149,13 @@ import { SystemEvents } from '../events/system'; * @property { string } name The name of the application * @property { string } uuid The uuid of the application */ +/** + * LogInfo interface + * @typedef { Object } LogInfo + * @property { string } name The filename of the log + * @property { number } size The size of the log in bytes + * @property { string } date The unix time at which the log was created "Thu Jan 08 2015 14:40:30 GMT-0500 (Eastern Standard Time)"" + */ /** * @typedef { verbose | info | warning | error | fatal } LogLevel * @summary Log verbosity levels. @@ -180,9 +187,23 @@ import { SystemEvents } from '../events/system'; /** * ProxyConfig interface * @typedef { Object } ProxyConfig - * @property { numder } proxyPort The port number of the running application - * @property { string } proxyAddress The address of the running application - * @property { string } type + * @property { string } proxyAddress The configured proxy address + * @property { numder } proxyPort The configured proxy port + * @property { string } type The proxy Type + */ +/** + * ProxyInfo interface + * @typedef { Object } ProxyInfo + * @property { ProxyConfig } config The proxy config + * @property { ProxySystemInfo } system The proxy system info + */ +/** + * ProxySystemInfo interface + * @typedef { Object } ProxySystemInfo + * @property { string } autoConfigUrl The auto configuration url + * @property { string } bypass The proxy bypass info + * @property { boolean } enabled Value to check if a proxy is enabled + * @property { string } proxy The proxy info */ /** * RegistryInfo interface @@ -199,6 +220,16 @@ import { SystemEvents } from '../events/system'; * @desc These are the options object required by the downloadRuntime function. * @property { string } version The given version to download */ +/** + * RVMInfo interface + * @typedef { Object } RVMInfo + * @property { string } action The name of action: "get-rvm-info" + * @property { string } appLogDirectory The app log directory + * @property { string } path The path of OpenfinRVM.exe + * @property { string } 'start-time' The start time of RVM + * @property { string } version The version of RVM + * @property { string } 'working-dir' The working directory + */ /** * TerminateExternalRequestType interface * @typedef { Object } TerminateExternalRequestType diff --git a/types/openfin/index.d.ts b/types/openfin/index.d.ts index fbde514cb0..7bee14463a 100644 --- a/types/openfin/index.d.ts +++ b/types/openfin/index.d.ts @@ -34,8 +34,11 @@ import { AppAssetInfo, AppAssetRequest, RuntimeDownloadOptions, RuntimeDownloadP import { DownloadPreloadInfo, DownloadPreloadOption } from './_v2/api/system/download-preload'; import { EntityInfo } from './_v2/api/system/entity'; import { HostSpecs } from './_v2/api/system/host-specs'; +import { LogInfo } from './_v2/api/system/log'; import { ProcessInfo } from './_v2/api/system/process'; +import { ProxyInfo } from './_v2/api/system/proxy'; import { RegistryInfo } from './_v2/api/system/registry-info'; +import { RVMInfo} from './_v2/api/system/rvm'; import { WindowDetail, WindowInfo } from './_v2/api/system/window'; // tslint:disable-next-line:export-just-namespace @@ -752,7 +755,7 @@ declare namespace fin { /** * Returns information about the running RVM in an object. */ - getRvmInfo(callback?: (rvmInfo: RvmInfo) => void, errorCallback?: (reason: string) => void): void; + getRvmInfo(callback?: (rvmInfo: RVMInfo) => void, errorCallback?: (reason: string) => void): void; /** * Returns the version of the runtime. The version contains the major, minor, build and revision numbers. */ @@ -833,41 +836,6 @@ declare namespace fin { updateProxySettings(type: string, address: string, port: number, callback?: () => void, errorCallback?: (reason: string) => void): void; } - interface LogInfo { - /** - * the filename of the log - */ - name?: string; - /** - * the size of the log in bytes - */ - size?: number; - /** - * the unix time at which the log was created "Thu Jan 08 2015 14:40:30 GMT-0500 (Eastern Standard Time)" - */ - date?: string; - } - - interface ProxyInfo { - /** - * the configured Proxy Address - */ - proxyAddress?: string; - /** - * the configured Proxy port - */ - proxyPort?: number; - /** - * Proxy Type - */ - type?: string; - } - - interface RvmInfo { - version?: string; - "start-time"?: string; - } - interface ExternalProcessLaunchInfo { path?: string; /**