WIP

Author: jeeanribeiro

packages/desktop/electron/electronApi.js renamed to packages/desktop/electron/electron.api.ts

@@ -1,27 +1,24 @@
-const { ipcRenderer } = require('electron')
+import { ipcRenderer } from 'electron'
+import fs from 'fs'
+import { PincodeManager, DeepLinkManager, NotificationManager } from './lib/managers'
+import { kdbx } from './lib'
+import { menuState } from './lib/menu'
+import { hookErrorLogger } from 'shared/lib/shell/errorLogger'
 
-const fs = require('fs')
-const PincodeManager = require('./lib/pincodeManager')
-const DeepLinkManager = require('./lib/deepLinkManager')
-const NotificationManager = require('./lib/notificationManager')
-const { menuState } = require('./lib/menuState')
-const kdbx = require('./lib/kdbx')
-const { hookErrorLogger } = require('shared/lib/shell/errorLogger')
-
-let activeProfileId = null
+let activeProfileId: string | null = null
 const eventListeners = {}
 
-const ElectronApi = {
+export const ElectronApi = {
     updateAppSettings(settings) {
         return ipcRenderer.invoke('update-app-settings', settings)
     },
     getActiveProfile() {
         return activeProfileId
     },
-    updateActiveProfile(id) {
+    updateActiveProfile(id: string) {
         activeProfileId = id
     },
-    async renameProfileFolder(oldPath, newPath) {
+    async renameProfileFolder(oldPath: string, newPath: string): Promise<void> {
         return ipcRenderer.invoke('get-path', 'userData').then((userDataPath) => {
             if (oldPath.startsWith(userDataPath)) {
                 try {
@@ -32,7 +29,7 @@ const ElectronApi = {
             }
         })
     },
-    async removeProfileFolder(profilePath) {
+    async removeProfileFolder(profilePath): Promise<void> {
         return ipcRenderer.invoke('get-path', 'userData').then((userDataPath) => {
             // Check that the removing profile path matches the user data path
             // so that we don't try and remove things outside our scope
@@ -47,7 +44,7 @@ const ElectronApi = {
             }
         })
     },
-    async listProfileFolders(profileStoragePath) {
+    async listProfileFolders(profileStoragePath): Promise<void | string[]> {
         return ipcRenderer.invoke('get-path', 'userData').then((userDataPath) => {
             // Check that the profile path matches the user data path
             // so that we don't try and remove things outside our scope
@@ -68,7 +65,7 @@ const ElectronApi = {
     PincodeManager: PincodeManager,
     DeepLinkManager: DeepLinkManager,
     NotificationManager: NotificationManager,
-    async getStrongholdBackupDestination(defaultPath) {
+    async getStrongholdBackupDestination(defaultPath: string): Promise<null | string> {
         return ipcRenderer
             .invoke('show-save-dialog', {
                 properties: ['createDirectory', 'showOverwriteConfirmation'],
@@ -83,7 +80,7 @@ const ElectronApi = {
                 return result.filePath
             })
     },
-    async exportTransactionHistory(defaultPath, contents) {
+    async exportTransactionHistory(defaultPath, contents): Promise<null | string> {
         return ipcRenderer
             .invoke('show-save-dialog', {
                 properties: ['createDirectory', 'showOverwriteConfirmation'],
@@ -105,16 +102,7 @@ const ElectronApi = {
             })
     },
 
-    /**
-     * Validates Seed Vault
-     *
-     * @method validateSeedVault
-     *
-     * @param {Buffer} buffer
-     *
-     * @returns {boolean}
-     */
-    validateSeedVault(buffer) {
+    validateSeedVault(buffer: Buffer): boolean {
         return kdbx.checkFormat(buffer)
     },
     /**
@@ -124,7 +112,7 @@ const ElectronApi = {
      *
      * @returns {Promise}
      */
-    getUserDataPath() {
+    getUserDataPath(): Promise<string> {
         return ipcRenderer.invoke('get-path', 'userData')
     },
     /**
@@ -134,7 +122,7 @@ const ElectronApi = {
      *
      * @returns {Promise}
      */
-    getDiagnostics() {
+    getDiagnostics(): Promise<string> {
         return ipcRenderer.invoke('diagnostics')
     },
     /**
@@ -144,7 +132,7 @@ const ElectronApi = {
      *
      * @returns {Promise}
      */
-    getOS() {
+    getOS(): Promise<string> {
         return ipcRenderer.invoke('get-os')
     },
     /**
@@ -154,57 +142,22 @@ const ElectronApi = {
      *
      * @returns {Promise}
      */
-    getMachineId() {
+    getMachineId(): Promise<string> {
         return ipcRenderer.invoke('get-machine-id')
     },
-    /**
-     * Starts an update of the application
-     *
-     * @method updateDownload
-     *
-     * @returns void
-     */
-    updateDownload() {
+    updateDownload(): Promise<void> {
         return ipcRenderer.invoke('update-download')
     },
-    /**
-     * Cancels an update of the application
-     *
-     * @method updateCancel
-     *
-     * @returns void
-     */
-    updateCancel() {
+    updateCancel(): Promise<void> {
         return ipcRenderer.invoke('update-cancel')
     },
-    /**
-     * Install an update of the application
-     *
-     * @method updateInstall
-     *
-     * @returns void
-     */
-    updateInstall() {
+    updateInstall(): Promise<void> {
         return ipcRenderer.invoke('update-install')
     },
-    /**
-     * Check for an update of the application
-     *
-     * @method updateCheck
-     *
-     * @returns void
-     */
-    updateCheck() {
+    updateCheck(): Promise<void> {
         return ipcRenderer.invoke('update-check')
     },
-    /**
-     * Get version details
-     *
-     * @method getVersionDetails
-     *
-     * @returns void
-     */
-    getVersionDetails() {
+    getVersionDetails(): Promise<void> {
         return ipcRenderer.invoke('get-version-details')
     },
     /**
@@ -220,58 +173,38 @@ const ElectronApi = {
             })
         }
     },
-    /**
-     * Show the popup menu
-     * @returns {undefined}
-     */
-    popupMenu() {
+    popupMenu(): Promise<void> {
         return ipcRenderer.invoke('menu-popup')
     },
-    /**
-     * Minimize the app
-     * @returns {undefined}
-     */
-    minimize() {
+    minimize(): Promise<void> {
         return ipcRenderer.invoke('minimize')
     },
-    /**
-     * Maximize the app
-     * @returns {undefined}
-     */
-    maximize() {
+    maximize(): Promise<void> {
         return ipcRenderer.invoke('maximize')
     },
-    /**
-     * Is the app maximized
-     * @returns {boolean}
-     */
-    isMaximized() {
+    isMaximized(): Promise<boolean> {
         return ipcRenderer.invoke('isMaximized')
     },
-    /**
-     * Close the app
-     * @returns {undefined}
-     */
-    close() {
+    close(): Promise<void> {
         return ipcRenderer.invoke('close')
     },
     /*
      * Opens url and checks against acceptlist
      * @param {string} url - Target url
-     * @returns {undefined}
+     * @returns {Promise<void>}
      */
-    openUrl(url) {
+    openUrl(url: string): Promise<void> {
         return ipcRenderer.invoke('open-url', url)
     },
-    copyFile(sourceFilePath, destinationFilePath) {
+    copyFile(sourceFilePath: string, destinationFilePath: string): Promise<void> {
         return ipcRenderer.invoke('copy-file', sourceFilePath, destinationFilePath)
     },
     /**
      * Log unhandled exception
      * @param {string} errorType The type of eerror
      * @param {Errir} error The error
      */
-    unhandledException(errorType, error) {
+    unhandledException(errorType: string, error: Error): Promise<void> {
         return ipcRenderer.invoke('handle-error', errorType, error)
     },
     /**
@@ -280,7 +213,7 @@ const ElectronApi = {
      * @param {function} callback - Event trigger callback
      * @returns {undefined}
      */
-    onEvent(event, callback) {
+    onEvent(event: string, callback: () => unknown) {
         let listeners = eventListeners[event]
         if (!listeners) {
             listeners = eventListeners[event] = []
@@ -299,15 +232,15 @@ const ElectronApi = {
      * @param {function} callback - Event trigger callback
      * @returns {undefined}
      */
-    removeListenersForEvent(event) {
+    removeListenersForEvent(event: string): void {
         eventListeners[event] = []
-        return ipcRenderer.removeAllListeners(event)
+        return void ipcRenderer.removeAllListeners(event)
     },
     /**
      * Save the recovery kit
      * @returns
      */
-    async saveRecoveryKit(recoverKitData) {
+    async saveRecoveryKit(recoveryKitData: ArrayBuffer): Promise<void> {
         return ipcRenderer
             .invoke('show-save-dialog', {
                 properties: ['createDirectory', 'showOverwriteConfirmation'],
@@ -323,7 +256,7 @@ const ElectronApi = {
                 }
 
                 try {
-                    fs.writeFileSync(result.filePath, Buffer.from(recoverKitData))
+                    fs.writeFileSync(result.filePath, Buffer.from(recoveryKitData))
                 } catch (err) {
                     console.error(err)
                 }
@@ -335,5 +268,3 @@ const ElectronApi = {
      */
     hookErrorLogger,
 }
-
-module.exports = ElectronApi