@finsemble/finsemble-ui 7.3.9 → 7.3.10

package/common/system.d.ts

@@ -0,0 +1,309 @@
+/**
+ * Important note: These classes make use of "getters". Don't confuse these with function calls.
+ */
+import { SDServerInfo, MonitorInfo, VirtualScreenCoordinates } from "../FEA";
+import { StandardErrorCallback, Manifest, StandardPromise } from "../types";
+import { FEAWindow, NotificationOptions, FEAInfo } from "../FEA";
+declare class SystemWindow {
+    static createNew(params: any, cb: StandardErrorCallback<FEAWindow>): void;
+    static getCurrent(): FEAWindow;
+    static wrap(windowName: string): FEAWindow;
+}
+/**
+ * <h2>Clipboard</h2>
+ * @param {object} params
+ */
+declare class Clipboard {
+    constructor();
+    /**
+     * Write Text to Clipboard
+     */
+    static writeText(data: any, type: any, callback: any, errorCallback: any): void;
+    static writeHTML(data: any, type: any, callback: any, errorCallback: any): void;
+    static writeRTF(data: any, type: any, callback: any, errorCallback: any): void;
+    static readText(type: any, callback: any, errorCallback: any): void;
+    static readHTML(type: any, callback: any, errorCallback: any): void;
+    static readRTF(type: any, callback: any, errorCallback: any): void;
+}
+/**
+ * <h2>The Finsemble System API </h2>
+ * ----------
+ * The Finsemble System API is a set private and experimental of APIs for exposing operating system and electron-based functionality, including the clipboard, mouse position, monitor info, and others.
+ * @private
+ */
+export declare class System {
+    /**
+     * Application is deprecated. getCurrent().restart() continues to be used by LTS seed so this must
+     * stay until we can remove SDD permanently from seed.
+     *
+     * The other functions can be removed once clients are confirmed not to be using them.
+     */
+    static get Application(): {
+        getCurrent: () => {
+            restart: () => void;
+            getWindow: () => FEAWindow;
+            addEventListener: (type: any, listener: (event: any) => void, callback?: () => void, errorCallback?: ((reason: string) => void) | undefined) => void;
+            close: (force?: boolean, callback?: () => void, errorCallback?: ((reason: string) => void) | undefined) => void;
+            getChildWindows: (callback?: ((children: FEAWindow[]) => void) | undefined, errorCallback?: ((reason: string) => void) | undefined) => void;
+            getGroups: (callback?: ((groups: FEAWindow[][]) => void) | undefined, errorCallback?: ((reason: string) => void) | undefined) => void;
+            getManifest: (callback?: ((manifest: Manifest) => void) | undefined, errorCallback?: ((reason: string) => void) | undefined) => void;
+            getParentUuid: (callback?: ((uuid: string) => void) | undefined, errorCallback?: ((reason: string) => void) | undefined) => void;
+            getInfo: (callback?: ((info: any) => void) | undefined, errorCallback?: ((reason: string) => void) | undefined) => void;
+            getTrayIconInfo: (callback?: ((trayInfo: any) => void) | undefined, errorCallback?: ((reason: string) => void) | undefined) => void;
+            isRunning: (callback?: ((running: boolean) => void) | undefined, errorCallback?: ((reason: string) => void) | undefined) => void;
+            registerUser: (userName: string, appName: string, callback?: () => void, errorCallback?: ((reason: string) => void) | undefined) => void;
+            removeEventListener: (type: any, previouslyRegisteredListener: (event: any) => any, callback?: () => void, errorCallback?: ((reason: string) => void) | undefined) => void;
+            removeTrayIcon: (callback?: () => void, errorCallback?: ((reason: string) => void) | undefined) => void;
+            run: (callback?: ((successObj: any) => void) | undefined, errorCallback?: ((reason: string, errorObj: any) => void) | undefined) => void;
+            scheduleRestart: (callback?: () => void, errorCallback?: ((reason: string) => void) | undefined) => void;
+            setTrayIcon: (iconUrl: string, listener: {
+                [key: string]: Function;
+            }, callback?: () => void, errorCallback?: ((reason: string) => void) | undefined) => void;
+            terminate: (callback?: () => void, errorCallback?: ((reason: string) => void) | undefined) => void;
+            wait: (callback?: () => void, errorCallback?: ((reason: string) => void) | undefined) => void;
+            window: {
+                name: string;
+            };
+            uuid: string;
+        };
+    };
+    /**
+     * Determines if the current window was launched through finsemble, or is external or freestanding
+     * @private
+     * @returns boolean True if freestanding
+     */
+    static isFreestanding(): boolean;
+    /**
+     * Window
+     * @private
+     * @returns Window
+     */
+    static get Window(): typeof SystemWindow;
+    /**
+     * Notification
+     * @private
+     * @returns Notification
+     */
+    static get Notification(): {
+        send: (params: NotificationOptions) => void;
+    };
+    /**
+     * Clipboard
+     * @private
+     * @returns Clipboard
+     */
+    static get Clipboard(): typeof Clipboard;
+    static getManifest(cb?: (manifest: Manifest) => void): Promise<Manifest>;
+    /**
+     * (experimental) Gets current mouse position
+     * @experimental
+     * @param cb
+     */
+    static getMousePosition(cb?: StandardErrorCallback<VirtualScreenCoordinates>): Promise<VirtualScreenCoordinates>;
+    /**
+     * Deletes assets downloaded via the manifest's `appAssets` config
+     * @param alias - If set then delete that specific asset, otherwise delete them all
+     * @returns A golang style promise that resolves after the delete is complete
+     */
+    static deleteAssets(alias?: string | null): StandardPromise<void>;
+    /**
+     * Asynchronous method that passes the SmartDesktopDesigner's Server Information to the provided callback
+     * @private
+     * @returns Clipboard
+     */
+    static getSDServerInfo(cb?: Function): Promise<SDServerInfo>;
+    /**
+     * Get all monitors
+     * @private
+     * @param cb Callback with monitorInfo type
+     */
+    static getMonitorInfo(cb?: (monitorInfo: MonitorInfo) => void): Promise<MonitorInfo>;
+    /**
+     * Returns a boolean that is true when the webcontents are running within an electron browserView
+     * @private
+     * @returns boolean
+     */
+    static isBrowserView(): boolean;
+    /**
+     * Returns the BrowserViewId.  See  isBrowserView method.
+     * @private
+     * @returns number The browserViewId
+     * @deprecated use getWebContentsId
+     */
+    static getViewId(): number | null;
+    /**
+     * Returns the Electron WebContents ID for the current WebContents (view or window)
+     * @private
+     * @returns number The WebContents ID
+     */
+    static getWebContentsId(): number | null;
+    /**
+     * Does the current webcontents contain browserviews
+     * @deprecated - use isTitlebarWindow() instead
+     * @private
+     * @returns boolean True when the current webcontents are a browserwindow that contains associated browserviews
+     */
+    static hasBrowserView(): boolean;
+    /**
+     * Is the current webcontents a title bar shell
+     * @private
+     * @returns boolean True when the current webcontents is a title bar shell
+     */
+    static isTitlebarWindow(): boolean;
+    /**
+     * Returns the fin object
+     * @private
+     * @returns fin
+     */
+    static get fin(): import("../FEA").FEA;
+    /**
+     * Invokes optional callback and resolves promise when FEA is ready.
+     *
+     * @param {Function} [cb] Optional callback for system ready
+     * @private
+     * @returns Promise<void>
+     * @deprecated It is no longer necessary to wait on ready
+     */
+    static ready(cb?: () => void): Promise<void>;
+    /**
+     * Sets the icon for the system tray
+     * @param url The url of the icon to use in the system tray
+     */
+    static setTrayIcon(url: string, cb?: () => void): void;
+    /**
+     * Asynchronous method that passes the host specs of the system to the provided callback
+     * @private
+     * @param cb callback
+     */
+    static getHostSpecs(cb?: Function): Promise<any>;
+    /**
+     * Returns the InterApplicationBus
+     * @private
+     * @returns IAB
+     */
+    static get InterApplicationBus(): import("../FEA").FEAInterApplicationBus;
+    /**
+     * Launches an external application
+     * @private
+     */
+    static get launchExternalProcess(): (options: import("../FEA").ExternalProcessLaunchInfo, callback?: ((payload: {
+        uuid: string;
+    }) => void) | undefined, errorCallback?: ((reason: string) => void) | undefined) => void;
+    /**
+     * Terminates an external application
+     * @private
+     */
+    static get terminateExternalProcess(): (processUuid: string, timeout: number, callback?: ((info: {
+        result: "failed" | "clean" | "terminated";
+    }) => void) | undefined, errorCallback?: ((reason: string) => void) | undefined) => void;
+    /**
+     * Hard terminates Finsemble.
+     *
+     * (deprecated) Use `FSBL.shutdownApplication()`
+     * @private
+     */
+    static get exit(): (callback?: (() => void) | undefined, errorCallback?: ((reason: string) => void) | undefined) => void;
+    /**
+     * Clears finsemble cache
+     * @private
+     */
+    static get clearCache(): (options: import("../FEA").CacheOptions, callback?: (() => void) | undefined, errorCallback?: ((reason: string) => void) | undefined) => void;
+    /**
+     * Shows the chromium developer tools for the current window
+     * @private
+     * @returns IAB
+     */
+    static get showDeveloperTools(): (name: string, isView?: number | boolean | null | undefined, callback?: (() => void) | undefined, errorCallback?: ((reason: string) => void) | undefined) => void;
+    /**
+     * Returns runtime information
+     * @private
+     * @returns RunTimeInfo
+     */
+    /**
+     * Adds an event listener
+     * @private
+     * @returns RunTimeInfo
+     */
+    static get addEventListener(): ({
+        <K extends keyof WindowEventMap>(type: K, listener: (this: Window, ev: WindowEventMap[K]) => any, options?: boolean | AddEventListenerOptions | undefined): void;
+        (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions | undefined): void;
+    } & typeof addEventListener) | ((type: "application-closed" | "application-crashed" | "application-created" | "application-started" | "apply-update-requested" | "desktop-icon-clicked" | "idle-state-changed" | "monitor-info-changed" | "new-window-created" | "session-changed" | "system-tray-click" | "system-tray-right-click" | "system-tray-mouse-enter" | "protocol-handler-triggered" | "log-fea" | "download-update", listener: (event: import("../FEA").SystemBaseEvent | import("../FEA").DesktopIconClickedEvent | import("../FEA").IdleStateChangedEvent | import("../FEA").MonitorInfoChangedEvent | import("../FEA").SessionChangedEvent | import("../FEA").ProtocolHandlerEvent | import("../FEA").UpdateDownloadEvent) => void, callback?: (() => void) | undefined, errorCallback?: ((reason: string) => void) | undefined) => void);
+    static get addSelectClientCertificateListener(): () => any;
+    static get addCertificateErrorListener(): () => any;
+    static getFEAInfo(cb?: (info: FEAInfo) => void): Promise<FEAInfo>;
+    /**
+     * getVersion
+     * @private
+     * @deprecated Use getFEAInfo instead.
+     * @returns getVersion function
+     */
+    static get getVersion(): (callback?: ((version: string) => void) | undefined, errorCallback?: ((reason: string) => void) | undefined) => void;
+    /**
+     * getUpdateAvailable
+     * @private
+     * @returns getUpdateAvailable function
+     */
+    static get getUpdateAvailable(): (cb: (isUpdateAvailable: boolean) => void) => void;
+    /**
+     * (deprecated) Opens website with external browser
+     * @returns openUrlWithBrowser function
+     */
+    static get openUrlWithBrowser(): (url: string, callback?: (() => void) | undefined, errorCallback?: ((reason: string) => void) | undefined) => void;
+    /**
+     * getProcessList
+     * @private
+     * @returns getProcessList function
+     */
+    static get getProcessList(): (callback?: ((processInfoList: import("../FEA").Metric[]) => void) | undefined, errorCallback?: ((reason: string) => void) | undefined) => void;
+    /**
+     * getProtocolString
+     * @private
+     * @returns getProtocolString function
+     */
+    static get getProtocolString(): (cb?: ((data: string) => void) | undefined) => Promise<string>;
+    /**
+     * hideSplashScreen
+     * @private
+     * @returns hideSplashScreen function
+     */
+    static get hideSplashScreen(): () => void;
+    /**
+     * notifyLoggerReady
+     * @private
+     */
+    static notifyLoggerReady(): void;
+    /**
+     * updateCentralLoggerState
+     * @private
+     */
+    static updateCentralLoggerState(loggerState: any): void;
+    /**
+     * Performs handshake with FEA to indicate the primary application started successfully
+     * @private
+     */
+    static startupApplicationHandshake(): void;
+    /**
+     * Hard terminates the application.
+     * This is called only by Finsemble's ShutdownManager to stop the entire application
+     * after it has gracefully closed services. Do not call this directly. Use `FSBL.shutdownApplication()`.
+     * @private
+     */
+    static terminate(): void;
+    /**
+     * Hard resets the application.
+     * This is called only by Finsemble's ShutdownManager to restart the entire application
+     * after it has gracefully closed services. Do not call this directly. Use `FSBL.restartApplication()`.
+     * @private
+     */
+    static restart(): void;
+    /**
+     * Gets an environment variable by name
+     * @param envVar The name of the environment variable to fetch
+     * @param cb the optional callback
+     * @returns a Promise that resolves to the environment variable value
+     * @private
+     */
+    static getEnvironmentVariable(envVar: string, cb?: (variable: string) => void): Promise<string>;
+}
+export {};
+//# sourceMappingURL=system.d.ts.map

package/common/system.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"system.d.ts","sourceRoot":"","sources":["../../../src/common/system.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,wBAAwB,EAAE,MAAM,QAAQ,CAAC;AAG7E,OAAO,EAAE,qBAAqB,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAC5E,OAAO,EAAE,SAAS,EAAiB,mBAAmB,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAC;AAIhF,cAAM,YAAY;IACjB,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE,EAAE,qBAAqB,CAAC,SAAS,CAAC;IAIlE,MAAM,CAAC,UAAU;IAIjB,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS;CAG1C;AA8CD;;;GAGG;AACH,cAAM,SAAS;;IAKd;;OAEG;IACH,MAAM,CAAC,SAAS,CAAC,IAAI,KAAA,EAAE,IAAI,KAAA,EAAE,QAAQ,KAAA,EAAE,aAAa,KAAA;IAKpD,MAAM,CAAC,SAAS,CAAC,IAAI,KAAA,EAAE,IAAI,KAAA,EAAE,QAAQ,KAAA,EAAE,aAAa,KAAA;IAKpD,MAAM,CAAC,QAAQ,CAAC,IAAI,KAAA,EAAE,IAAI,KAAA,EAAE,QAAQ,KAAA,EAAE,aAAa,KAAA;IAKnD,MAAM,CAAC,QAAQ,CAAC,IAAI,KAAA,EAAE,QAAQ,KAAA,EAAE,aAAa,KAAA;IAK7C,MAAM,CAAC,QAAQ,CAAC,IAAI,KAAA,EAAE,QAAQ,KAAA,EAAE,aAAa,KAAA;IAK7C,MAAM,CAAC,OAAO,CAAC,IAAI,KAAA,EAAE,QAAQ,KAAA,EAAE,aAAa,KAAA;CAI5C;AAED;;;;;GAKG;AACH,qBAAa,MAAM;IAClB;;;;;OAKG;IACH,MAAM,KAAK,WAAW;;;;qCAUX,GAAG,oBACS,GAAG,KAAK,IAAI,aACnB,MAAM,IAAI,4BACI,MAAM,KAAK,IAAI;4BAIzB,OAAO,aAAa,MAAM,IAAI,4BAA2B,MAAM,KAAK,IAAI;qDAGhD,SAAS,EAAE,KAAK,IAAI,yCAA2B,MAAM,KAAK,IAAI;6CAGtE,SAAS,EAAE,EAAE,KAAK,IAAI,yCAA2B,MAAM,KAAK,IAAI;iDAG5D,QAAQ,KAAK,IAAI,yCAA2B,MAAM,KAAK,IAAI;+CAG7D,MAAM,KAAK,IAAI,yCAA2B,MAAM,KAAK,IAAI;yCAG/D,GAAG,KAAK,IAAI,yCAA2B,MAAM,KAAK,IAAI;qDAG1C,GAAG,KAAK,IAAI,yCAA2B,MAAM,KAAK,IAAI;8CAG7D,OAAO,KAAK,IAAI,yCAA2B,MAAM,KAAK,IAAI;qCAIhF,MAAM,WACP,MAAM,aACJ,MAAM,IAAI,4BACI,MAAM,KAAK,IAAI;wCAKlC,GAAG,wCAC6B,GAAG,KAAK,GAAG,aACtC,MAAM,IAAI,4BACI,MAAM,KAAK,IAAI;wCAIb,MAAM,IAAI,4BAA2B,MAAM,KAAK,IAAI;2CAGlD,GAAG,KAAK,IAAI,yCAA2B,MAAM,YAAY,GAAG,KAAK,IAAI;yCACtE,MAAM,IAAI,4BAA2B,MAAM,KAAK,IAAI;mCAIvE,MAAM;;0BAEJ,MAAM,IAAI,4BACI,MAAM,KAAK,IAAI;mCAIlB,MAAM,IAAI,4BAA2B,MAAM,KAAK,IAAI;8BAGzD,MAAM,IAAI,4BAA2B,MAAM,KAAK,IAAI;;;;;;MAUzE;IAED;;;;OAIG;IACH,MAAM,CAAC,cAAc;IAIrB;;;;OAIG;IACH,MAAM,KAAK,MAAM,wBAEhB;IAED;;;;OAIG;IACH,MAAM,KAAK,YAAY;uBAEN,mBAAmB;MAInC;IAED;;;;OAIG;IACH,MAAM,KAAK,SAAS,qBAEnB;IAED,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,IAAI,GAAG,OAAO,CAAC,QAAQ,CAAC;IASxE;;;;OAIG;WACU,gBAAgB,CAC5B,EAAE,CAAC,EAAE,qBAAqB,CAAC,wBAAwB,CAAC,GAClD,OAAO,CAAC,wBAAwB,CAAC;IAiBpC;;;;OAIG;WACU,YAAY,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,eAAe,CAAC,IAAI,CAAC;IAIvE;;;;OAIG;IACH,MAAM,CAAC,eAAe,CAAC,EAAE,WAAqB,GAAG,OAAO,CAAC,YAAY,CAAC;IAStE;;;;OAIG;IACH,MAAM,CAAC,cAAc,CAAC,EAAE,CAAC,EAAE,CAAC,WAAW,EAAE,WAAW,KAAK,IAAI,GAAG,OAAO,CAAC,WAAW,CAAC;IASpF;;;;OAIG;IACH,MAAM,CAAC,aAAa;IAIpB;;;;;OAKG;IACH,MAAM,CAAC,SAAS,IAAI,MAAM,GAAG,IAAI;IAKjC;;;;OAIG;IACH,MAAM,CAAC,gBAAgB,IAAI,MAAM,GAAG,IAAI;IAIxC;;;;;OAKG;IACH,MAAM,CAAC,cAAc;IAKrB;;;;OAIG;IACH,MAAM,CAAC,gBAAgB;IAIvB;;;;OAIG;IACH,MAAM,KAAK,GAAG,yBAEb;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,MAAM,IAAI;IAS5B;;;OAGG;IACH,MAAM,CAAC,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,IAAI,GAAG,IAAI;IAItD;;;;OAIG;IACH,MAAM,CAAC,YAAY,CAAC,EAAE,WAAqB;IAS3C;;;;OAIG;IACH,MAAM,KAAK,mBAAmB,4CAE7B;IAED;;;OAGG;IACH,MAAM,KAAK,qBAAqB;;6FAE/B;IAED;;;OAGG;IACH,MAAM,KAAK,wBAAwB;;6FAElC;IAED;;;;;OAKG;IACH,MAAM,KAAK,IAAI,0GAEd;IAED;;;OAGG;IACH,MAAM,KAAK,UAAU,kJAEpB;IAED;;;;OAIG;IACH,MAAM,KAAK,kBAAkB,sKAE5B;IAED;;;;OAIG;IACH;;;;OAIG;IACH,MAAM,KAAK,gBAAgB;;;6zBAO1B;IAED,MAAM,KAAK,kCAAkC,cAE5C;IAED,MAAM,KAAK,2BAA2B,cAErC;IAED,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC;IASjE;;;;;OAKG;IACH,MAAM,KAAK,UAAU,yHAEpB;IAED;;;;OAIG;IACH,MAAM,KAAK,kBAAkB,uDAE5B;IAED;;;OAGG;IACH,MAAM,KAAK,kBAAkB,uHAE5B;IAED;;;;OAIG;IACH,MAAM,KAAK,cAAc,oJAExB;IAED;;;;OAIG;IACH,MAAM,KAAK,iBAAiB,mEAE3B;IAED;;;;OAIG;IACH,MAAM,KAAK,gBAAgB,eAE1B;IAED;;;OAGG;IACH,MAAM,CAAC,iBAAiB;IAIxB;;;OAGG;IACH,MAAM,CAAC,wBAAwB,CAAC,WAAW,EAAE,GAAG;IAIhD;;;OAGG;IACH,MAAM,CAAC,2BAA2B;IAMlC;;;;;OAKG;IACH,MAAM,CAAC,SAAS;IAIhB;;;;;OAKG;IACH,MAAM,CAAC,OAAO;IAId;;;;;;OAMG;IACH,MAAM,CAAC,sBAAsB,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC;CAQ/F"}