From 71c8e32b2f3022619f9d8d01528cbd874efeb21a Mon Sep 17 00:00:00 2001 From: Anton Bracke Date: Tue, 22 Feb 2022 12:02:56 +0100 Subject: [PATCH] improve types --- desktop/README.md | 18 ++--- desktop/electron/src/ipc.ts | 11 ++- desktop/electron/src/preload-app/preload.ts | 7 +- .../electron/src/preload-local-app/preload.ts | 15 ++-- .../electron/src/preload-local-app/types.ts | 11 ++- desktop/electron/src/settings.ts | 19 ++++- desktop/electron/tsconfig.json | 77 ++++--------------- desktop/local-app/src/App.svelte | 4 +- desktop/local-app/src/lib/Link.svelte | 3 +- desktop/local-app/src/lib/Sidebar.svelte | 5 +- desktop/local-app/src/lib/ipc.ts | 5 ++ desktop/local-app/src/store.ts | 18 ++--- desktop/local-app/src/views/AddServer.svelte | 1 - desktop/local-app/src/views/Home.svelte | 3 +- desktop/local-app/src/views/Settings.svelte | 26 +++++-- desktop/local-app/tsconfig.json | 3 +- 16 files changed, 105 insertions(+), 121 deletions(-) create mode 100644 desktop/local-app/src/lib/ipc.ts diff --git a/desktop/README.md b/desktop/README.md index 4fac65f5..3838a52c 100644 --- a/desktop/README.md +++ b/desktop/README.md @@ -1,23 +1,23 @@ # Desktop app -The desktop component is an electron app. It uses a hybrid setup based of two main components: -- A `local-app` bundled into the electron app. It has two main parts: +The desktop component is an electron app inside `./electron/`. It uses a hybrid setup based of two main components: +- A `local-app` bundled into the electron app with two main parts: - A sidebar to show the server list, with the currently selected server - - A main page which is used to manage servers and to show other "local" pages like the options + - A main page which is used to manage servers and to show other "local" pages like the desktop-app settings - A BrowserView (often called `appView` or `app`) showing the actual frontend of an external WorkAdventure deployment. - If a server is selected the BrowserView / `appView` is overlaying the main part right to the sidebar. + If a server is selected the BrowserView / `appView` is overlaying the whole main part right to the sidebar. ## Development ```bash -# start local-app -yarn dev:local-app +# start local-app in watch mode +cd local-app && yarn dev -# start electron app -LOCAL_APP_URL=http://localhost:3000 yarn dev +# start electron app in watch mode +cd electron && LOCAL_APP_URL=http://localhost:3000 yarn dev # or create an executable by running: -yarn bundle +cd electron && yarn bundle ``` ## API for front diff --git a/desktop/electron/src/ipc.ts b/desktop/electron/src/ipc.ts index 08a40dd0..2f6e7813 100644 --- a/desktop/electron/src/ipc.ts +++ b/desktop/electron/src/ipc.ts @@ -2,8 +2,8 @@ import { ipcMain, app } from "electron"; import electronIsDev from "electron-is-dev"; import { createAndShowNotification } from "./notification"; import { Server } from "./preload-local-app/types"; -import settings from "./settings"; -import { saveShortcut } from "./shortcuts"; +import settings, { SettingsData } from "./settings"; +import { loadShortcuts, saveShortcut } from "./shortcuts"; import { getWindow, hideAppView, showAppView } from "./window"; export function emitMuteToggle() { @@ -92,7 +92,10 @@ export default () => { return true; }); - ipcMain.handle("local-app:saveShortcut", (event, shortcut, key) => saveShortcut(shortcut, key)); + ipcMain.handle("local-app:reloadShortcuts", (event, shortcut, key) => loadShortcuts()); - ipcMain.handle("local-app:getShortcuts", (event) => settings.get("shortcuts") || {}); + ipcMain.handle("local-app:getSettings", (event) => settings.get() || {}); + ipcMain.handle("local-app:saveSetting", (event, key: T, value: SettingsData[T]) => + settings.set(key, value) + ); }; diff --git a/desktop/electron/src/preload-app/preload.ts b/desktop/electron/src/preload-app/preload.ts index 13ea7105..d72516e3 100644 --- a/desktop/electron/src/preload-app/preload.ts +++ b/desktop/electron/src/preload-app/preload.ts @@ -1,14 +1,13 @@ import { contextBridge, ipcRenderer, IpcRendererEvent } from "electron"; -import { SettingsData } from "src/settings"; import type { WorkAdventureDesktopApi } from "./types"; const api: WorkAdventureDesktopApi = { desktop: true, isDevelopment: () => ipcRenderer.invoke("is-development"), getVersion: () => ipcRenderer.invoke("get-version"), - notify: (txt: string) => ipcRenderer.send("app:notify", txt), - onMuteToggle: (callback: (event: IpcRendererEvent) => void) => ipcRenderer.on("app:on-mute-toggle", callback), - onCameraToggle: (callback: (event: IpcRendererEvent) => void) => ipcRenderer.on("app:on-camera-toggle", callback), + notify: (txt) => ipcRenderer.send("app:notify", txt), + onMuteToggle: (callback) => ipcRenderer.on("app:on-mute-toggle", callback), + onCameraToggle: (callback) => ipcRenderer.on("app:on-camera-toggle", callback), }; contextBridge.exposeInMainWorld("WorkAdventureDesktopApi", api); diff --git a/desktop/electron/src/preload-local-app/preload.ts b/desktop/electron/src/preload-local-app/preload.ts index 48145a96..b9570845 100644 --- a/desktop/electron/src/preload-local-app/preload.ts +++ b/desktop/electron/src/preload-local-app/preload.ts @@ -1,6 +1,5 @@ import { contextBridge, ipcRenderer } from "electron"; -import { SettingsData } from "src/settings"; -import type { Server, WorkAdventureLocalAppApi } from "./types"; +import type { WorkAdventureLocalAppApi } from "./types"; const api: WorkAdventureLocalAppApi = { desktop: true, @@ -8,12 +7,12 @@ const api: WorkAdventureLocalAppApi = { getVersion: () => ipcRenderer.invoke("get-version"), showLocalApp: () => ipcRenderer.invoke("local-app:showLocalApp"), getServers: () => ipcRenderer.invoke("local-app:getServers"), - selectServer: (serverId: string) => ipcRenderer.invoke("local-app:selectServer", serverId), - addServer: (server: Omit) => ipcRenderer.invoke("local-app:addServer", server), - removeServer: (serverId: Server["_id"]) => ipcRenderer.invoke("local-app:removeServer", serverId), - saveShortcut: (shortcut: keyof SettingsData["shortcuts"], key: string | null) => - ipcRenderer.invoke("local-app:saveShortcut", shortcut, key), - getShortcuts: () => ipcRenderer.invoke("local-app:getShortcuts"), + selectServer: (serverId) => ipcRenderer.invoke("local-app:selectServer", serverId), + addServer: (server) => ipcRenderer.invoke("local-app:addServer", server), + removeServer: (serverId) => ipcRenderer.invoke("local-app:removeServer", serverId), + reloadShortcuts: () => ipcRenderer.invoke("local-app:reloadShortcuts"), + getSettings: () => ipcRenderer.invoke("local-app:getSettings"), + saveSetting: (key, value) => ipcRenderer.invoke("local-app:setSetting", key, value), }; contextBridge.exposeInMainWorld("WorkAdventureDesktopApi", api); diff --git a/desktop/electron/src/preload-local-app/types.ts b/desktop/electron/src/preload-local-app/types.ts index 04a58342..c8da0d73 100644 --- a/desktop/electron/src/preload-local-app/types.ts +++ b/desktop/electron/src/preload-local-app/types.ts @@ -1,4 +1,4 @@ -import { SettingsData } from "src/settings"; +import { SettingsData } from "../settings"; export type Server = { _id: string; @@ -6,6 +6,8 @@ export type Server = { url: string; }; +export { SettingsData }; + export type WorkAdventureLocalAppApi = { desktop: boolean; isDevelopment: () => Promise; @@ -13,8 +15,9 @@ export type WorkAdventureLocalAppApi = { showLocalApp: () => Promise; getServers: () => Promise; selectServer: (serverId: string) => Promise; - addServer: (server: Omit) => Promise; + addServer: (server: Omit) => Promise; removeServer: (serverId: Server["_id"]) => Promise; - saveShortcut: (shortcut: keyof SettingsData["shortcuts"], key: string | null) => Promise; - getShortcuts: () => Promise; + reloadShortcuts: () => Promise; + getSettings: () => Promise; + saveSetting: (key: T, value: SettingsData[T]) => Promise; }; diff --git a/desktop/electron/src/settings.ts b/desktop/electron/src/settings.ts index 83c35c2a..97a8e67a 100644 --- a/desktop/electron/src/settings.ts +++ b/desktop/electron/src/settings.ts @@ -15,20 +15,33 @@ async function init() { settings = (await Settings.get()) as SettingsData; } -function get(key: T): SettingsData[T] | undefined { +function get(): SettingsData; +function get(key: T): SettingsData[T] | undefined; +function get(key?: T): SettingsData | SettingsData[T] | undefined { if (settings === undefined) { throw new Error("Settings not initialized"); } + if (key === undefined) { + return settings; + } + return settings?.[key]; } -export function set(key: T, value: SettingsData[T]) { +function set(key: SettingsData): void; +function set(key: T, value: SettingsData[T]): void; +function set(key: T | SettingsData, value?: SettingsData[T]) { if (settings === undefined) { throw new Error("Settings not initialized"); } - settings[key] = value; + if (typeof key === "string") { + settings[key] = value; + } else { + Object.assign(settings, key); + } + void Settings.set(settings); } diff --git a/desktop/electron/tsconfig.json b/desktop/electron/tsconfig.json index b617ea42..d356ed64 100644 --- a/desktop/electron/tsconfig.json +++ b/desktop/electron/tsconfig.json @@ -1,70 +1,21 @@ { "compilerOptions": { "experimentalDecorators": true, - /* Basic Options */ - // "incremental": true, /* Enable incremental compilation */ - "target": "es5", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */ + "target": "es5", "downlevelIteration": true, - "module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */ - // "lib": [], /* Specify library files to be included in the compilation. */ - "allowJs": true, /* Allow javascript files to be compiled. */ - // "checkJs": true, /* Report errors in .js files. */ - // "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */ - // "declaration": true, /* Generates corresponding '.d.ts' file. */ - // "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */ - "sourceMap": true, /* Generates corresponding '.map' file. */ - // "outFile": "./", /* Concatenate and emit output to single file. */ - "outDir": "./dist", /* Redirect output structure to the directory. */ - // "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */ - // "composite": true, /* Enable project compilation */ - // "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */ - // "removeComments": true, /* Do not emit comments to output. */ - // "noEmit": true, /* Do not emit outputs. */ - // "importHelpers": true, /* Import emit helpers from 'tslib'. */ - // "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */ - // "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */ - - /* Strict Type-Checking Options */ - "strict": true, /* Enable all strict type-checking options. */ - // "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */ - // "strictNullChecks": true, /* Enable strict null checks. */ - // "strictFunctionTypes": true, /* Enable strict checking of function types. */ - // "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */ - // "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */ - "noImplicitThis": false, /* Raise error on 'this' expressions with an implied 'any' type. */ // Disabled because of sifrr server that is monkey patching HttpResponse - // "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */ - - /* Additional Checks */ - // "noUnusedLocals": true, /* Report errors on unused locals. */ - // "noUnusedParameters": true, /* Report errors on unused parameters. */ - "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */ - "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */ - - /* Module Resolution Options */ - "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */ - "baseUrl": ".", /* Base directory to resolve non-absolute module names. */ - "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */ - // "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */ - // "typeRoots": [], /* List of folders to include type definitions from. */ - // "types": [], /* Type declaration files to be included in compilation. */ - // "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */ - "esModuleInterop": true, /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */ - // "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */ - // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ - - /* Source Map Options */ - // "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */ - // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ - // "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */ - // "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */ - - /* Experimental Options */ - // "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */ - // "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */ - - /* Advanced Options */ - "forceConsistentCasingInFileNames": true, /* Disallow inconsistently-cased references to the same file. */ - + "module": "commonjs", + "allowJs": true, + "sourceMap": true, + "outDir": "./dist", + "strict": true, + "noImplicitThis": false, + "noImplicitReturns": true, + "noFallthroughCasesInSwitch": true, + "moduleResolution": "node", + "baseUrl": ".", + "paths": {}, + "esModuleInterop": true, + "forceConsistentCasingInFileNames": true, "skipLibCheck": true } } diff --git a/desktop/local-app/src/App.svelte b/desktop/local-app/src/App.svelte index 0e6e4a43..5a2e92c9 100644 --- a/desktop/local-app/src/App.svelte +++ b/desktop/local-app/src/App.svelte @@ -2,14 +2,14 @@ import { Router, Route } from "svelte-navigator"; import Sidebar from "~/lib/Sidebar.svelte"; - import LazyRoute from "~/lib/LazyRoute.svelte"; + import { api } from "~/lib/ipc"; const Home = () => import("~/views/Home.svelte"); const AddServer = () => import("~/views/AddServer.svelte"); const Settings = () => import("~/views/Settings.svelte"); - let insideElectron = window?.WorkAdventureDesktopApi?.desktop; + let insideElectron = api.desktop; {#if insideElectron} diff --git a/desktop/local-app/src/lib/Link.svelte b/desktop/local-app/src/lib/Link.svelte index 41f1de79..d5d9ff46 100644 --- a/desktop/local-app/src/lib/Link.svelte +++ b/desktop/local-app/src/lib/Link.svelte @@ -1,5 +1,6 @@ diff --git a/desktop/local-app/src/lib/Sidebar.svelte b/desktop/local-app/src/lib/Sidebar.svelte index b0ec6333..d1e1929b 100644 --- a/desktop/local-app/src/lib/Sidebar.svelte +++ b/desktop/local-app/src/lib/Sidebar.svelte @@ -2,8 +2,9 @@ import { onMount } from "svelte"; import Link from "~/lib/Link.svelte"; - import { servers, selectedServer, selectServer, loadServers, Server } from "../store"; + import { servers, selectedServer, selectServer, loadServers } from "~/store"; import CogIcon from "~/assets/nes.icons/cog.svg"; + import { api } from "~/lib/ipc"; let isDevelopment = false; @@ -26,7 +27,7 @@ onMount(async () => { await loadServers(); - isDevelopment = await window?.WorkAdventureDesktopApi?.isDevelopment(); + isDevelopment = await api.isDevelopment(); }); diff --git a/desktop/local-app/src/lib/ipc.ts b/desktop/local-app/src/lib/ipc.ts new file mode 100644 index 00000000..217120b2 --- /dev/null +++ b/desktop/local-app/src/lib/ipc.ts @@ -0,0 +1,5 @@ +import type { WorkAdventureLocalAppApi, SettingsData, Server } from "@wa-preload-local-app"; + +export { WorkAdventureLocalAppApi, SettingsData, Server }; +// TODO fix type +export const api = (window as any)?.WorkAdventureDesktopApi as WorkAdventureLocalAppApi; diff --git a/desktop/local-app/src/store.ts b/desktop/local-app/src/store.ts index 76f9de20..fb1f27ff 100644 --- a/desktop/local-app/src/store.ts +++ b/desktop/local-app/src/store.ts @@ -1,10 +1,5 @@ import { writable, get } from "svelte/store"; - -export type Server = { - _id: string; - name: string; - url: string; -}; +import { api, Server } from "~/lib/ipc"; export const newServer = writable>({ name: "", @@ -14,15 +9,14 @@ export const servers = writable([]); export const selectedServer = writable(""); export async function selectServer(server: Server) { - await window.WorkAdventureDesktopApi.selectServer(server._id); + await api.selectServer(server._id); selectedServer.set(server._id); } export async function addServer() { - const addedServer = await window?.WorkAdventureDesktopApi?.addServer(get(newServer)); - if (!addedServer?._id) { - console.log(addedServer); - throw new Error(addedServer); + const addedServer = await api.addServer(get(newServer)); + if (addedServer instanceof Error) { + throw new Error(addedServer as unknown as string); } newServer.set({ name: "", url: "" }); servers.update((s) => [...s, addedServer]); @@ -30,5 +24,5 @@ export async function addServer() { } export async function loadServers() { - servers.set(await window.WorkAdventureDesktopApi.getServers()); + servers.set(await api.getServers()); } diff --git a/desktop/local-app/src/views/AddServer.svelte b/desktop/local-app/src/views/AddServer.svelte index 673452a1..9b7b0fe7 100644 --- a/desktop/local-app/src/views/AddServer.svelte +++ b/desktop/local-app/src/views/AddServer.svelte @@ -17,7 +17,6 @@
- diff --git a/desktop/local-app/src/views/Home.svelte b/desktop/local-app/src/views/Home.svelte index 3175be49..1fbacb0f 100644 --- a/desktop/local-app/src/views/Home.svelte +++ b/desktop/local-app/src/views/Home.svelte @@ -2,11 +2,12 @@ import { onMount } from "svelte"; import Logo from "~/../../electron/assets/icons/logo.svg"; + import { api } from "~/lib/ipc"; let version = ""; onMount(async () => { - version = await window?.WorkAdventureDesktopApi?.getVersion(); + version = await api.getVersion(); }); diff --git a/desktop/local-app/src/views/Settings.svelte b/desktop/local-app/src/views/Settings.svelte index 1d77c9e8..ca246b51 100644 --- a/desktop/local-app/src/views/Settings.svelte +++ b/desktop/local-app/src/views/Settings.svelte @@ -1,19 +1,33 @@ diff --git a/desktop/local-app/tsconfig.json b/desktop/local-app/tsconfig.json index 95b38cca..29d24a5f 100644 --- a/desktop/local-app/tsconfig.json +++ b/desktop/local-app/tsconfig.json @@ -15,7 +15,8 @@ "allowJs": true, "checkJs": true, "paths": { - "~/*": ["./*"] + "~/*": ["./src/*"], + "@wa-preload-local-app": ["../electron/src/preload-local-app/types.ts"], } }, "include": ["src/**/*.d.ts", "src/**/*.ts", "src/**/*.js", "src/**/*.svelte"],