@openfin/core 30.73.6 → 30.73.7

package/src/api/system/index.d.ts

@@ -1,20 +1,21 @@
+import type * as OpenFin from '../../OpenFin';
 import { EmitterBase } from '../base';
 import Transport from '../../transport/transport';
-import Identity = OpenFin.Identity;
-import ProxyInfo = OpenFin.ProxyInfo;
-import ProxyConfig = OpenFin.ProxyConfig;
-import SystemEvents = OpenFin.SystemEvents;
-import InstalledApps = OpenFin.InstalledApps;
-import LogInfo = OpenFin.LogInfo;
-import LogLevel = OpenFin.LogLevel;
-import GetLogRequestType = OpenFin.GetLogRequestType;
-import RegistryInfo = OpenFin.RegistryInfo;
-import EntityInfo = OpenFin.EntityInfo;
-import Entity = OpenFin.ApplicationType;
-import ApplicationState = OpenFin.ApplicationState;
-import ApplicationWindowInfo = OpenFin.ApplicationWindowInfo;
-import PrinterInfo = OpenFin.PrinterInfo;
+declare type Identity = OpenFin.Identity;
+declare type ProxyInfo = OpenFin.ProxyInfo;
+declare type ProxyConfig = OpenFin.ProxyConfig;
+declare type InstalledApps = OpenFin.InstalledApps;
+declare type LogInfo = OpenFin.LogInfo;
+declare type LogLevel = OpenFin.LogLevel;
+declare type GetLogRequestType = OpenFin.GetLogRequestType;
+declare type RegistryInfo = OpenFin.RegistryInfo;
+declare type EntityInfo = OpenFin.EntityInfo;
+declare type Entity = OpenFin.ApplicationType;
+declare type ApplicationState = OpenFin.ApplicationState;
+declare type ApplicationWindowInfo = OpenFin.ApplicationWindowInfo;
+declare type PrinterInfo = OpenFin.PrinterInfo;
 /**
+ * @PORTED
  * AppAssetInfo interface
  * @typedef { object } AppAssetInfo
  * @property { string } src  The URL to a zip file containing the package files (executables, dlls, etc…)
@@ -26,11 +27,13 @@ import PrinterInfo = OpenFin.PrinterInfo;
  * When set to false, the app will continue to load if the asset cannot be downloaded. (Default: true)
  */
 /**
+ * @PORTED
  * AppAssetRequest interface
  * @typedef { object } AppAssetRequest
  * @property { string } alias The name of the asset
  */
 /**
+ * @PORTED
  * ApplicationState interface
  * @typedef { object } ApplicationState
  * @property { boolean } isPlatform true when the application is a Platform controller
@@ -39,6 +42,7 @@ import PrinterInfo = OpenFin.PrinterInfo;
  * @property { string } parentUuid uuid of the application that launches this application
  */
 /**
+ * @PORTED
  * @typedef { object } ClearCacheOption
  * @summary Clear cache options.
  * @desc These are the options required by the clearCache function.
@@ -49,6 +53,7 @@ import PrinterInfo = OpenFin.PrinterInfo;
  * @property {boolean} localStorage browser data that can be used across sessions
  */
 /**
+ * @REMOVED
  * CookieInfo interface
  * @typedef { object } CookieInfo
  * @property { string } name  The name of the cookie
@@ -56,11 +61,13 @@ import PrinterInfo = OpenFin.PrinterInfo;
  * @property { string } path The path of the cookie
  */
 /**
+ * @REMOVED
  * CookieOption interface
  * @typedef { object } CookieOption
  * @property { string } name The name of the cookie
  */
 /**
+ * @PORTED
  * CpuInfo interface
  * @typedef { object } CpuInfo
  * @property { string } model The model of the cpu
@@ -68,6 +75,7 @@ import PrinterInfo = OpenFin.PrinterInfo;
  * @property { Time } times The numbers of milliseconds the CPU has spent in different modes.
  */
 /**
+ * @PORTED
  * CrashReporterState interface
  * @typedef { object } CrashReporterState
  * @property { boolean } diagnosticsMode In diagnostics mode the crash reporter will send diagnostic logs to
@@ -75,24 +83,28 @@ import PrinterInfo = OpenFin.PrinterInfo;
  * @property { boolean } isRunning check if it's running
  */
 /**
+ * @PORTED
  * CrashReporterOptions interface
  * @typedef { object } CrashReporterOptions
  * @property { boolean } diagnosticsMode In diagnostics mode the crash reporter will send diagnostic logs to
  *  the OpenFin reporting service on runtime shutdown
  */
 /**
+ * @REMOVED
  * DipRect interface
  * @typedef { object } DipRect
  * @property { Rect } dipRect The DIP coordinates
  * @property { Rect } scaledRect The scale coordinates
  */
 /**
+ * @REMOVED
  * DipScaleRects interface
  * @typedef { object } DipScaleRects
  * @property { Rect } dipRect The DIP coordinates
  * @property { Rect } scaledRect The scale coordinates
  */
 /**
+ * @PORTED
  * DownloadPreloadInfo interface
  * @typedef { object } DownloadPreloadInfo
  * @desc downloadPreloadScripts function return value
@@ -101,18 +113,21 @@ import PrinterInfo = OpenFin.PrinterInfo;
  * @property { boolean } succeess download operation success
  */
 /**
+ * @PORTED
  * DownloadPreloadOption interface
  * @typedef { object } DownloadPreloadOption
  * @desc These are the options object required by the downloadPreloadScripts function
  * @property { string } url url to the preload script
  */
 /**
+ * @REMOVED
  * ApplicationType interface
  * @typedef { object } ApplicationType
  * @property { string } type The type of the entity
  * @property { string } uuid The uuid of the entity
  */
 /**
+ * @REMOVED
  * EntityInfo interface
  * @typedef { object } EntityInfo
  * @property { string } name The name of the entity
@@ -121,17 +136,20 @@ import PrinterInfo = OpenFin.PrinterInfo;
  * @property { string } entityType The type of the entity
  */
 /**
+ * @REMOVED
  * ExternalApplicationInfo interface
  * @typedef { object } ExternalApplicationInfo
  * @property { Identity } parent The parent identity
  */
 /**
+ * @PORTED
  * ExternalConnection interface
  * @typedef { object } ExternalConnection
  * @property { string } token The token to broker an external connection
  * @property { string } uuid The uuid of the external connection
  */
 /**
+ * @PORTED
  * ExternalProcessRequestType interface
  * @typedef { object } ExternalProcessRequestType
  * @property { string } path The file path to where the running application resides
@@ -141,14 +159,17 @@ import PrinterInfo = OpenFin.PrinterInfo;
  * @property { string } cwd current working directory
  */
 /**
+ * @REMOVED
  * FrameInfo interface
  * @typedef { object } FrameInfo
  * @property { string } name The name of the frame
  * @property { string } uuid The uuid of the frame
  * @property { EntityType } entityType The entity type, could be 'window', 'iframe', 'external connection' or 'unknown'
  * @property { Identity } parent The parent identity
+ * @property { string } url URL
  */
 /**
+ * @PORTED
  * GetLogRequestType interface
  * @typedef { object } GetLogRequestType
  * @property { string } name The name of the running application
@@ -156,11 +177,13 @@ import PrinterInfo = OpenFin.PrinterInfo;
  * @property { number } sizeLimit The set size limit of the log file
  */
 /**
+ * @REMOVED
  * GpuInfo interface
  * @typedef { object } GpuInfo
  * @property { string } name The graphics card name
  */
 /**
+ * @PORTED
  * HostSpecs interface
  * @typedef { object } HostSpecs
  * @property { boolean } aeroGlassEnabled Value to check if Aero Glass theme is supported on Windows platforms
@@ -172,12 +195,14 @@ import PrinterInfo = OpenFin.PrinterInfo;
  * @property { boolean } screenSaver Value to check if screensaver is running. Supported on Windows only
  */
 /**
+ * @PORTED
  * Identity interface
  * @typedef { object } Identity
  * @property { string } name Optional - the name of the component
  * @property { string } uuid Universally unique identifier of the application
  */
 /**
+ * @PORTED
  * LogInfo interface
  * @typedef { object } LogInfo
  * @property { string } name The filename of the log
@@ -185,12 +210,14 @@ import PrinterInfo = OpenFin.PrinterInfo;
  * @property { string } date The unix time at which the log was created "Thu Jan 08 2015 14:40:30 GMT-0500 (Eastern Standard Time)"
  */
 /**
+ * @PORTED
  * ManifestInfo interface
  * @typedef { object } ManifestInfo
  * @property { string } uuid The uuid of the application
  * @property { string } manifestUrl The runtime manifest URL
  */
 /**
+ * @PORTED
  * MonitorDetails interface
  * @typedef { object } MonitorDetails
  * @property { DipScaleRects } available The available DIP scale coordinates
@@ -204,6 +231,7 @@ import PrinterInfo = OpenFin.PrinterInfo;
  * @property { DipScaleRects } monitor The monitor coordinates
  */
 /**
+ * @PORTED
  * MonitorInfo interface
  * @typedef { object } MonitorInfo
  * @property { number } deviceScaleFactor The device scale factor
@@ -215,6 +243,7 @@ import PrinterInfo = OpenFin.PrinterInfo;
  * @property { DipRect } virtualScreen The virtual display screen coordinates
  */
 /**
+ * @PORTED
  * @typedef { verbose | info | warning | error | fatal } LogLevel
  * @summary Log verbosity levels.
  * @desc Describes the minimum level (inclusive) above which logs will be written
@@ -226,18 +255,21 @@ import PrinterInfo = OpenFin.PrinterInfo;
  * @property { string } fatal fatal only, indicates a crash is imminent
  */
 /**
+ * @PORTED
  * PointTopLeft interface
  * @typedef { object } PointTopLeft
  * @property { number } top The mouse top position in virtual screen coordinates
  * @property { number } left The mouse left position in virtual screen coordinates
  */
 /**
+ * @PORTED
  * Point interface
  * @typedef { object } Point
  * @property { number } x The mouse x position
  * @property { number } y The mouse y position
  */
 /**
+ * @REMOVED
  * ProcessInfo interface
  * @typedef { object } ProcessInfo
  * @property { number } cpuUsage The percentage of total CPU usage
@@ -255,18 +287,21 @@ import PrinterInfo = OpenFin.PrinterInfo;
  * @property { number } workingSetSize The current working set size (both shared and private data) in bytes
  */
 /**
+ * @REMOVED
  * SystemProcessInfo interface
  * @typedef { object } SystemProcessInfo
  * @property { ProcessDetails } browserProcess Info on browser process
  * @property { Array<AppProcessInfo> } apps Array of apps and their process info
  */
 /**
+ * @PORTED
  * AppProcessInfo interface
  * @typedef { object } AppProcessInfo
  * @property { string } uuid The uuid of the application
  * @property { Array<EntityProcessDetails> } entities  Array of process info for each window and view for the application
  */
 /**
+ * @REMOVED
  * EntityProcessDetails interface
  * @typedef { object } EntityProcessDetails
  * @property { string } uuid The uuid for the entity
@@ -288,6 +323,7 @@ import PrinterInfo = OpenFin.PrinterInfo;
  * @property { Array<FrameProcessDetails> } frames Array of process info for each iframe corresponeding to the entity
  */
 /**
+ * @PORTED
  * FrameProcessDetails interface
  * @typedef { object } FrameProcessDetails
  * @property { string } url Current URL associated with the process
@@ -305,6 +341,7 @@ import PrinterInfo = OpenFin.PrinterInfo;
  * @property { number } pid The native process identifier
  */
 /**
+ * @PORTED
  * ProcessDetails interface
  * @typedef { object } ProcessDetails
  * @property { number } cpuUsage The percentage of total CPU usage
@@ -320,6 +357,7 @@ import PrinterInfo = OpenFin.PrinterInfo;
  * @property { number } pid The native process identifier
  */
 /**
+ * @PORTED
  * ProxyConfig interface
  * @typedef { object } ProxyConfig
  * @property { string } proxyAddress The configured proxy address
@@ -327,12 +365,14 @@ import PrinterInfo = OpenFin.PrinterInfo;
  * @property { string } type The proxy Type
  */
 /**
+ * @REMOVED
  * ProxyInfo interface
  * @typedef { object } ProxyInfo
  * @property { ProxyConfig } config The proxy config
  * @property { ProxySystemInfo } system The proxy system info
  */
 /**
+ * @PORTED
  * QueryPermissionResult interface
  * @typedef { object } QueryPermissionResult
  * @property { string } permission The full name of a secured API
@@ -341,6 +381,7 @@ import PrinterInfo = OpenFin.PrinterInfo;
  * @property { object } [rawValue] The value of permission
  */
 /**
+ * @PORTED
  * ProxySystemInfo interface
  * @typedef { object } ProxySystemInfo
  * @property { string } autoConfigUrl The auto configuration url
@@ -349,6 +390,7 @@ import PrinterInfo = OpenFin.PrinterInfo;
  * @property { string } proxy The proxy info
  */
 /**
+ * @REMOVED
  * Rect interface
  * @typedef { object } Rect
  * @property { number } bottom The bottom-most coordinate
@@ -357,6 +399,7 @@ import PrinterInfo = OpenFin.PrinterInfo;
  * @property { number } top The top-most coordinate
  */
 /**
+ * @REMOVED
  * RegistryInfo interface
  * @typedef { object } RegistryInfo
  * @property { any } data The registry data
@@ -366,12 +409,14 @@ import PrinterInfo = OpenFin.PrinterInfo;
  * @property { string } value The registry value name
  */
 /**
+ * @PORTED
  * RuntimeDownloadOptions interface
  * @typedef { object } RuntimeDownloadOptions
  * @desc These are the options object required by the downloadRuntime function.
  * @property { string } version The given version to download
  */
 /**
+ * @PORTED
  * RuntimeInfo interface
  * @typedef { object } RuntimeInfo
  * @property { string } architecture The runtime build architecture
@@ -384,6 +429,7 @@ import PrinterInfo = OpenFin.PrinterInfo;
  * @property { string } electronVersion The electron version
  */
 /**
+ * @PORTED
  * RVMInfo interface
  * @typedef { object } RVMInfo
  * @property { string } action The name of action: "get-rvm-info"
@@ -394,24 +440,29 @@ import PrinterInfo = OpenFin.PrinterInfo;
  * @property { string } 'working-dir' The working directory
  */
 /**
+ * @PORTED
  * RvmLaunchOptions interface
  * @typedef { object } RvmLaunchOptions
  * @property { boolean } [noUi] true if no UI when launching
  * @property { object } [userAppConfigArgs] The user app configuration args
  * @property { number } [timeToLive] Timeout in seconds until RVM launch request expires
+ * @property { Function } [subscribe] Called whenever app version resolver events occur.
  */
 /**
+ * @PORTED
  * ServiceIdentifier interface
  * @typedef { object } ServiceIdentifier
  * @property { string } name The name of the service
  */
 /**
+ * @PORTED
  * ServiceConfiguration interface
  * @typedef { object } ServiceConfiguration
  * @property { object } config The service configuration
  * @property { string } name The name of the service
  */
 /**
+ * @PORTED
  * ShortCutConfig interface
  * @typedef { object } ShortCutConfig
  * @property { boolean } desktop true if application has a shortcut on the desktop
@@ -419,17 +470,20 @@ import PrinterInfo = OpenFin.PrinterInfo;
  * @property { boolean } systemStartup true if application will be launched on system startup
  */
 /**
+ * @PORTED
  * SubOptions interface
  * @typedef { Object } SubOptions
  * @property { number } timestamp The event timestamp
  */
 /**
+ * @PORTED
  * TaskBar interface
  * @typedef { object } TaskBar
  * @property { string } edge which edge of a monitor the taskbar is on
  * @property { Rect } rect The taskbar coordinates
  */
 /**
+ * @PORTED
  * TerminateExternalRequestType interface
  * @typedef { object } TerminateExternalRequestType
  * @property { string } uuid The uuid of the running application
@@ -437,6 +491,7 @@ import PrinterInfo = OpenFin.PrinterInfo;
  * @property { boolean } killtree Value to terminate the running application
  */
 /**
+ * @PORTED
  * Time interface
  * @typedef { object } Time
  * @property { number } user The number of milliseconds the CPU has spent in user mode
@@ -446,6 +501,7 @@ import PrinterInfo = OpenFin.PrinterInfo;
  * @property { number } irq The number of milliseconds the CPU has spent in irq mode
  */
 /**
+ * @PORTED
  * TrayInfo interface
  * @typedef { object } TrayInfo
  * @property { Bounds } bounds The bound of tray icon in virtual screen pixels
@@ -454,6 +510,7 @@ import PrinterInfo = OpenFin.PrinterInfo;
  * @property { number } y copy of bounds.y
  */
 /**
+ * @PORTED
  * WindowDetail interface
  * @typedef { object } WindowDetail
  * @property { number } bottom The bottom-most coordinate of the window
@@ -467,6 +524,7 @@ import PrinterInfo = OpenFin.PrinterInfo;
  * @property { number } width The width of the window
  */
 /**
+ * @PORTED
  * ApplicationWindowInfo interface
  * @typedef { object } ApplicationWindowInfo
  * @property { Array<WindowDetail> } childWindows The array of child windows details
@@ -474,6 +532,7 @@ import PrinterInfo = OpenFin.PrinterInfo;
  * @property { string } uuid The uuid of the application
  */
 /**
+ * @REMOVED
  * CertifiedAppInfo interface
  * @typedef { object } CertifiedAppInfo
  * @property { boolean } isRunning true if the app is running
@@ -488,7 +547,7 @@ import PrinterInfo = OpenFin.PrinterInfo;
  * clearing the cache and exiting the runtime as well as listen to <a href="tutorial-System.EventEmitter.html">system events</a>.
  * @namespace
  */
-export default class System extends EmitterBase<SystemEvents> {
+export default class System extends EmitterBase<OpenFin.SystemEvent> {
     constructor(wire: Transport);
     private sendExternalProcessRequest;
     /**
@@ -769,7 +828,7 @@ export default class System extends EmitterBase<SystemEvents> {
      * 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.
      * <br> Note: This method is restricted by default and must be enabled via
-     * <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
+     * <a href="https://developers.openfin.co/docs/api-security">API security settings</a>. Also, this api has an enhanced permission set to make it less dangerous. So application owners can only allow to launch the assets owned by the application, the enabled downloaded files or the restricted executables.
      * @param { ExternalProcessRequestType } options A object that is defined in the ExternalProcessRequestType interface
      * @return {Promise.<Identity>}
      * @tutorial System.launchExternalProcess
@@ -966,3 +1025,4 @@ export default class System extends EmitterBase<SystemEvents> {
      */
     getPrinters(): Promise<PrinterInfo[]>;
 }
+export {};