@openfin/core 30.73.26 → 30.73.28

package/src/api/platform/Factory.js

@@ -145,6 +145,8 @@ class PlatformModule extends base_1.Base {
                 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
                 // @ts-ignore using private variable.
                 const app = await this.fin.Application._create({ ...platformOptions, isPlatformController: true });
+                // TODO: fix typing (internal)
+                // @ts-expect-error
                 app.once('platform-api-ready', () => resolve(this.wrapSync({ uuid })));
                 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
                 // @ts-ignore using private variable.
@@ -174,6 +176,8 @@ class PlatformModule extends base_1.Base {
                 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
                 // @ts-ignore using private variable.
                 const app = await this.fin.Application._createFromManifest(manifestUrl);
+                // TODO: fix typing (internal)
+                // @ts-expect-error
                 app.once('platform-api-ready', () => resolve(this.wrapSync({ uuid: app.identity.uuid })));
                 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
                 // @ts-ignore using private method without warning.

package/src/api/platform/Instance.d.ts

@@ -4,14 +4,14 @@ import { EmitterBase } from '../base';
 import { Channel } from '../interappbus/channel/index';
 import ChannelClient from '../interappbus/channel/client';
 import { LayoutModule } from './layout';
-declare type PlatformEvents = OpenFin.PlatformEvents;
 /** Manages the life cycle of windows and views in the application.
  *
- * Enables taking snapshots of itself and applying them to restore a previous configuration
+ * Enables taking snapshots of itself and applyi
+ * ng them to restore a previous configuration
  * as well as listen to <a href="tutorial-Platform.EventEmitter.html">platform events</a>.
  * @namespace
  */
-export declare class Platform extends EmitterBase<PlatformEvents> {
+export declare class Platform extends EmitterBase<OpenFin.PlatformEvent> {
     #private;
     Layout: LayoutModule;
     private _channel;
@@ -145,4 +145,3 @@ export declare class Platform extends EmitterBase<PlatformEvents> {
         skipBeforeUnload: boolean;
     }): Promise<void>;
 }
-export {};

package/src/api/platform/Instance.js

@@ -13,7 +13,8 @@ const validate_1 = require("../../util/validate");
 const clientMap = new Map();
 /** Manages the life cycle of windows and views in the application.
  *
- * Enables taking snapshots of itself and applying them to restore a previous configuration
+ * Enables taking snapshots of itself and applyi
+ * ng them to restore a previous configuration
  * as well as listen to <a href="tutorial-Platform.EventEmitter.html">platform events</a>.
  * @namespace
  */

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

@@ -4,7 +4,6 @@ import Transport from '../../transport/transport';
 declare type Identity = OpenFin.Identity;
 declare type ProxyInfo = OpenFin.ProxyInfo;
 declare type ProxyConfig = OpenFin.ProxyConfig;
-declare type SystemEvents = OpenFin.SystemEvents;
 declare type InstalledApps = OpenFin.InstalledApps;
 declare type LogInfo = OpenFin.LogInfo;
 declare type LogLevel = OpenFin.LogLevel;
@@ -15,13 +14,483 @@ declare type Entity = OpenFin.ApplicationType;
 declare type ApplicationState = OpenFin.ApplicationState;
 declare type ApplicationWindowInfo = OpenFin.ApplicationWindowInfo;
 declare type PrinterInfo = OpenFin.PrinterInfo;
+/**
+ * AppAssetInfo interface
+ * @typedef { object } AppAssetInfo
+ * @property { string } src  The URL to a zip file containing the package files (executables, dlls, etc…)
+ * @property { string } alias The name of the asset
+ * @property { string } version The version of the package
+ * @property { string } target Specify default executable to launch. This option can be overridden in launchExternalProcess
+ * @property { string } args The default command line arguments for the aforementioned target.
+ * @property { boolean } mandatory When set to true, the app will fail to load if the asset cannot be downloaded.
+ * When set to false, the app will continue to load if the asset cannot be downloaded. (Default: true)
+ */
+/**
+ * AppAssetRequest interface
+ * @typedef { object } AppAssetRequest
+ * @property { string } alias The name of the asset
+ */
+/**
+ * ApplicationState interface
+ * @typedef { object } ApplicationState
+ * @property { boolean } isPlatform true when the application is a Platform controller
+ * @property { boolean } isRunning  true when the application is running
+ * @property { string } uuid uuid of the application
+ * @property { string } parentUuid uuid of the application that launches this application
+ */
+/**
+ * @typedef { object } ClearCacheOption
+ * @summary Clear cache options.
+ * @desc These are the options required by the clearCache function.
+ *
+ * @property {boolean} appcache html5 application cache
+ * @property {boolean} cache browser data cache for html files and images
+ * @property {boolean} cookies browser cookies
+ * @property {boolean} localStorage browser data that can be used across sessions
+ */
+/**
+ * CookieInfo interface
+ * @typedef { object } CookieInfo
+ * @property { string } name  The name of the cookie
+ * @property { string } domain The domain of the cookie
+ * @property { string } path The path of the cookie
+ */
+/**
+ * CookieOption interface
+ * @typedef { object } CookieOption
+ * @property { string } name The name of the cookie
+ */
+/**
+ * CpuInfo interface
+ * @typedef { object } CpuInfo
+ * @property { string } model The model of the cpu
+ * @property { number } speed The number in MHz
+ * @property { Time } times The numbers of milliseconds the CPU has spent in different modes.
+ */
+/**
+ * CrashReporterState interface
+ * @typedef { object } CrashReporterState
+ * @property { boolean } diagnosticsMode In diagnostics mode the crash reporter will send diagnostic logs to
+ *  the OpenFin reporting service on runtime shutdown
+ * @property { boolean } isRunning check if it's running
+ */
+/**
+ * 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
+ */
+/**
+ * DipRect interface
+ * @typedef { object } DipRect
+ * @property { Rect } dipRect The DIP coordinates
+ * @property { Rect } scaledRect The scale coordinates
+ */
+/**
+ * DipScaleRects interface
+ * @typedef { object } DipScaleRects
+ * @property { Rect } dipRect The DIP coordinates
+ * @property { Rect } scaledRect The scale coordinates
+ */
+/**
+ * DownloadPreloadInfo interface
+ * @typedef { object } DownloadPreloadInfo
+ * @desc downloadPreloadScripts function return value
+ * @property { string } url url to the preload script
+ * @property { string } error error during preload script acquisition
+ * @property { boolean } succeess download operation success
+ */
+/**
+ * DownloadPreloadOption interface
+ * @typedef { object } DownloadPreloadOption
+ * @desc These are the options object required by the downloadPreloadScripts function
+ * @property { string } url url to the preload script
+ */
+/**
+ * ApplicationType interface
+ * @typedef { object } ApplicationType
+ * @property { string } type The type of the entity
+ * @property { string } uuid The uuid of the entity
+ */
+/**
+ * EntityInfo interface
+ * @typedef { object } EntityInfo
+ * @property { string } name The name of the entity
+ * @property { string } uuid The uuid of the entity
+ * @property { Identity } parent The parent of the entity
+ * @property { string } entityType The type of the entity
+ */
+/**
+ * ExternalApplicationInfo interface
+ * @typedef { object } ExternalApplicationInfo
+ * @property { Identity } parent The parent identity
+ */
+/**
+ * ExternalConnection interface
+ * @typedef { object } ExternalConnection
+ * @property { string } token The token to broker an external connection
+ * @property { string } uuid The uuid of the external connection
+ */
+/**
+ * ExternalProcessRequestType interface
+ * @typedef { object } ExternalProcessRequestType
+ * @property { string } path The file path to where the running application resides
+ * @property { string } arguments The argument passed to the running application
+ * @property { LaunchExternalProcessListener } listener This is described in the {LaunchExternalProcessListner} type definition
+ * @property { string } initialWindowState Initial window state after launching: 'normal' (default), 'minimized', 'maximized'
+ * @property { string } cwd current working directory
+ */
+/**
+ * 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
+ */
+/**
+ * GetLogRequestType interface
+ * @typedef { object } GetLogRequestType
+ * @property { string } name The name of the running application
+ * @property { number } endFile The file length of the log file
+ * @property { number } sizeLimit The set size limit of the log file
+ */
+/**
+ * GpuInfo interface
+ * @typedef { object } GpuInfo
+ * @property { string } name The graphics card name
+ */
+/**
+ * HostSpecs interface
+ * @typedef { object } HostSpecs
+ * @property { boolean } aeroGlassEnabled Value to check if Aero Glass theme is supported on Windows platforms
+ * @property { string } arch "x86" for 32-bit or "x86_64" for 64-bit
+ * @property { Array<CpuInfo> } cpus The same payload as Node's os.cpus()
+ * @property { GpuInfo } gpu The graphics card name
+ * @property { number } memory The same payload as Node's os.totalmem()
+ * @property { string } name The OS name and version/edition
+ * @property { boolean } screenSaver Value to check if screensaver is running. Supported on Windows only
+ */
+/**
+ * Identity interface
+ * @typedef { object } Identity
+ * @property { string } name Optional - the name of the component
+ * @property { string } uuid Universally unique identifier 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)"
+ */
+/**
+ * ManifestInfo interface
+ * @typedef { object } ManifestInfo
+ * @property { string } uuid The uuid of the application
+ * @property { string } manifestUrl The runtime manifest URL
+ */
+/**
+ * MonitorDetails interface
+ * @typedef { object } MonitorDetails
+ * @property { DipScaleRects } available The available DIP scale coordinates
+ * @property { Rect } availableRect The available monitor coordinates
+ * @property { string } deviceId The device id of the display
+ * @property { boolean } displayDeviceActive true if the display is active
+ * @property { number } deviceScaleFactor The device scale factor
+ * @property { Rect } monitorRect The monitor coordinates
+ * @property { string } name The name of the display
+ * @property { Point } dpi The dots per inch
+ * @property { DipScaleRects } monitor The monitor coordinates
+ */
+/**
+ * MonitorInfo interface
+ * @typedef { object } MonitorInfo
+ * @property { number } deviceScaleFactor The device scale factor
+ * @property { Point } dpi The dots per inch
+ * @property { Array<MonitorDetails> } nonPrimaryMonitors The array of monitor details
+ * @property { MonitorDetails } primaryMonitor The monitor details
+ * @property { string } reason always "api-query"
+ * @property { TaskBar } taskBar The taskbar on monitor
+ * @property { DipRect } virtualScreen The virtual display screen coordinates
+ */
+/**
+ * @typedef { verbose | info | warning | error | fatal } LogLevel
+ * @summary Log verbosity levels.
+ * @desc Describes the minimum level (inclusive) above which logs will be written
+ *
+ * @property { string } verbose all logs written
+ * @property { string } info info and above
+ * @property { string } warning warning and above
+ * @property { string } error error and above
+ * @property { string } fatal fatal only, indicates a crash is imminent
+ */
+/**
+ * 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
+ */
+/**
+ * Point interface
+ * @typedef { object } Point
+ * @property { number } x The mouse x position
+ * @property { number } y The mouse y position
+ */
+/**
+ * ProcessInfo interface
+ * @typedef { object } ProcessInfo
+ * @property { number } cpuUsage The percentage of total CPU usage
+ * @property { string } name The application name
+ * @property { number } nonPagedPoolUsage The current nonpaged pool usage in bytes
+ * @property { number } pageFaultCount The number of page faults
+ * @property { number } pagedPoolUsage The current paged pool usage in bytes
+ * @property { number } pagefileUsage The total amount of memory in bytes that the memory manager has committed
+ * @property { number } peakNonPagedPoolUsage The peak nonpaged pool usage in bytes
+ * @property { number } peakPagedPoolUsage The peak paged pool usage in bytes
+ * @property { number } peakPagefileUsage The peak value in bytes of pagefileUsage during the lifetime of this process
+ * @property { number } peakWorkingSetSize The peak working set size in bytes
+ * @property { number } processId The native process identifier
+ * @property { string } uuid The application UUID
+ * @property { number } workingSetSize The current working set size (both shared and private data) in bytes
+ */
+/**
+ * SystemProcessInfo interface
+ * @typedef { object } SystemProcessInfo
+ * @property { ProcessDetails } browserProcess Info on browser process
+ * @property { Array<AppProcessInfo> } apps Array of apps and their process info
+ */
+/**
+ * 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
+ */
+/**
+ * EntityProcessDetails interface
+ * @typedef { object } EntityProcessDetails
+ * @property { string } uuid The uuid for the entity
+ * @property { string } name The name for the entity
+ * @property { string } url URL associated with the entity
+ * @property { string } entityType Type for the entity: window or view
+ * @property { number } cpuUsage The percentage of total CPU usage
+ * @property { number } nonPagedPoolUsage The current nonpaged pool usage in bytes
+ * @property { number } pageFaultCount The number of page faults
+ * @property { number } pagedPoolUsage The current paged pool usage in bytes
+ * @property { number } pagefileUsage The total amount of memory in bytes that the memory manager has committed
+ * @property { number } peakNonPagedPoolUsage The peak nonpaged pool usage in bytes
+ * @property { number } peakPagedPoolUsage The peak paged pool usage in bytes
+ * @property { number } peakPagefileUsage The peak value in bytes of pagefileUsage during the lifetime of this process
+ * @property { number } peakWorkingSetSize The peak working set size in bytes
+ * @property { number } privateSetSize The current working set size (not shared)
+ * @property { number } workingSetSize The current working set size (both shared and private data) in bytes
+ * @property { number } pid The native process identifier
+ * @property { Array<FrameProcessDetails> } frames Array of process info for each iframe corresponeding to the entity
+ */
+/**
+ * FrameProcessDetails interface
+ * @typedef { object } FrameProcessDetails
+ * @property { string } url Current URL associated with the process
+ * @property { string } entityType Type for the frame
+ * @property { number } cpuUsage The percentage of total CPU usage
+ * @property { number } nonPagedPoolUsage The current nonpaged pool usage in bytes
+ * @property { number } pageFaultCount The number of page faults
+ * @property { number } pagedPoolUsage The current paged pool usage in bytes
+ * @property { number } pagefileUsage The total amount of memory in bytes that the memory manager has committed
+ * @property { number } peakNonPagedPoolUsage The peak nonpaged pool usage in bytes
+ * @property { number } peakPagedPoolUsage The peak paged pool usage in bytes
+ * @property { number } peakPagefileUsage The peak value in bytes of pagefileUsage during the lifetime of this process
+ * @property { number } peakWorkingSetSize The peak working set size in bytes
+ * @property { number } workingSetSize The current working set size (both shared and private data) in bytes
+ * @property { number } pid The native process identifier
+ */
+/**
+ * ProcessDetails interface
+ * @typedef { object } ProcessDetails
+ * @property { number } cpuUsage The percentage of total CPU usage
+ * @property { number } nonPagedPoolUsage The current nonpaged pool usage in bytes
+ * @property { number } pageFaultCount The number of page faults
+ * @property { number } pagedPoolUsage The current paged pool usage in bytes
+ * @property { number } pagefileUsage The total amount of memory in bytes that the memory manager has committed
+ * @property { number } peakNonPagedPoolUsage The peak nonpaged pool usage in bytes
+ * @property { number } peakPagedPoolUsage The peak paged pool usage in bytes
+ * @property { number } peakPagefileUsage The peak value in bytes of pagefileUsage during the lifetime of this process
+ * @property { number } peakWorkingSetSize The peak working set size in bytes
+ * @property { number } workingSetSize The current working set size (both shared and private data) in bytes
+ * @property { number } pid The native process identifier
+ */
+/**
+ * ProxyConfig interface
+ * @typedef { object } ProxyConfig
+ * @property { string } proxyAddress The configured proxy address
+ * @property { number } 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
+ */
+/**
+ * QueryPermissionResult interface
+ * @typedef { object } QueryPermissionResult
+ * @property { string } permission The full name of a secured API
+ * @property { string } state 'granted' | 'denied' | 'unavailable'
+ * @property { boolean } granted true if permission is granted
+ * @property { object } [rawValue] The value of permission
+ */
+/**
+ * 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
+ */
+/**
+ * Rect interface
+ * @typedef { object } Rect
+ * @property { number } bottom The bottom-most coordinate
+ * @property { number } left The left-most coordinate
+ * @property { number } right The right-most coordinate
+ * @property { number } top The top-most coordinate
+ */
+/**
+ * RegistryInfo interface
+ * @typedef { object } RegistryInfo
+ * @property { any } data The registry data
+ * @property { string } rootKey The registry root key
+ * @property { string } subkey The registry key
+ * @property { string } type The registry type
+ * @property { string } value The registry value name
+ */
+/**
+ * RuntimeDownloadOptions interface
+ * @typedef { object } RuntimeDownloadOptions
+ * @desc These are the options object required by the downloadRuntime function.
+ * @property { string } version The given version to download
+ */
+/**
+ * RuntimeInfo interface
+ * @typedef { object } RuntimeInfo
+ * @property { string } architecture The runtime build architecture
+ * @property { string } manifestUrl The runtime manifest URL
+ * @property { number } port The runtime websocket port
+ * @property { string } securityRealm The runtime security realm
+ * @property { string } version The runtime version
+ * @property { object } args the command line argument used to start the Runtime
+ * @property { string } chromeVersion The chrome version
+ * @property { string } electronVersion The electron version
+ */
+/**
+ * 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
+ */
+/**
+ * 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.
+ */
+/**
+ * ServiceIdentifier interface
+ * @typedef { object } ServiceIdentifier
+ * @property { string } name The name of the service
+ */
+/**
+ * ServiceConfiguration interface
+ * @typedef { object } ServiceConfiguration
+ * @property { object } config The service configuration
+ * @property { string } name The name of the service
+ */
+/**
+ * ShortCutConfig interface
+ * @typedef { object } ShortCutConfig
+ * @property { boolean } desktop true if application has a shortcut on the desktop
+ * @property { boolean } startMenu true if application has shortcut in the start menu
+ * @property { boolean } systemStartup true if application will be launched on system startup
+ */
+/**
+ * SubOptions interface
+ * @typedef { Object } SubOptions
+ * @property { number } timestamp The event timestamp
+ */
+/**
+ * TaskBar interface
+ * @typedef { object } TaskBar
+ * @property { string } edge which edge of a monitor the taskbar is on
+ * @property { Rect } rect The taskbar coordinates
+ */
+/**
+ * TerminateExternalRequestType interface
+ * @typedef { object } TerminateExternalRequestType
+ * @property { string } uuid The uuid of the running application
+ * @property { number } timeout Time out period before the running application terminates
+ * @property { boolean } killtree Value to terminate the running application
+ */
+/**
+ * Time interface
+ * @typedef { object } Time
+ * @property { number } user The number of milliseconds the CPU has spent in user mode
+ * @property { number } nice The number of milliseconds the CPU has spent in nice mode
+ * @property { number } sys The number of milliseconds the CPU has spent in sys mode
+ * @property { number } idle The number of milliseconds the CPU has spent in idle mode
+ * @property { number } irq The number of milliseconds the CPU has spent in irq mode
+ */
+/**
+ * TrayInfo interface
+ * @typedef { object } TrayInfo
+ * @property { Bounds } bounds The bound of tray icon in virtual screen pixels
+ * @property { MonitorInfo } monitorInfo Please see fin.System.getMonitorInfo for more information
+ * @property { number } x copy of bounds.x
+ * @property { number } y copy of bounds.y
+ */
+/**
+ * WindowDetail interface
+ * @typedef { object } WindowDetail
+ * @property { number } bottom The bottom-most coordinate of the window
+ * @property { number } height The height of the window
+ * @property { boolean } isShowing Value to check if the window is showing
+ * @property { number } left The left-most coordinate of the window
+ * @property { string } name The name of the window
+ * @property { number } right The right-most coordinate of the window
+ * @property { string } state The window state
+ * @property { number } top The top-most coordinate of the window
+ * @property { number } width The width of the window
+ */
+/**
+ * ApplicationWindowInfo interface
+ * @typedef { object } ApplicationWindowInfo
+ * @property { Array<WindowDetail> } childWindows The array of child windows details
+ * @property { WindowDetail } mainWindow The main window detail
+ * @property { string } uuid The uuid of the application
+ */
+/**
+ * CertifiedAppInfo interface
+ * @typedef { object } CertifiedAppInfo
+ * @property { boolean } isRunning true if the app is running
+ * @property { boolean } [isOptedIntoCertfiedApp] true if the app has opted into certification
+ * @property { boolean } [isCertified] true if the app is certified
+ * @property { boolean } [isSSLCertified] true if the app manifest's SSL certificate is valid
+ * @property { boolean } [isPresentInAppDirectory] true if the app is present in the OpenFin app directory
+ */
 /**
  * An object representing the core of OpenFin Runtime. Allows the developer
  * to perform system-level actions, such as accessing logs, viewing processes,
  * 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;
     /**