├── .eslintignore ├── .vscode ├── extensions.json ├── tasks.json ├── settings.json └── launch.json ├── src ├── renderer │ ├── src │ │ ├── lib │ │ │ ├── components │ │ │ │ ├── Statusbar.svelte │ │ │ │ ├── Header.svelte │ │ │ │ ├── Footer.svelte │ │ │ │ ├── LogRow.svelte │ │ │ │ ├── NetworkRequestRow.svelte │ │ │ │ ├── NetworkRequestDetail.svelte │ │ │ │ └── Sidebar.svelte │ │ │ ├── ui-components │ │ │ │ ├── view │ │ │ │ │ ├── ViewContent.svelte │ │ │ │ │ ├── ViewTabs.svelte │ │ │ │ │ ├── View.svelte │ │ │ │ │ ├── ViewHeader.svelte │ │ │ │ │ └── ViewTab.svelte │ │ │ │ ├── Code.svelte │ │ │ │ ├── form │ │ │ │ │ ├── InlineInput.svelte │ │ │ │ │ ├── Input.svelte │ │ │ │ │ └── Select.svelte │ │ │ │ ├── buttons │ │ │ │ │ └── IconButton.svelte │ │ │ │ ├── icons │ │ │ │ │ └── Icon.svelte │ │ │ │ └── Scroller.svelte │ │ │ ├── stores │ │ │ │ ├── device.ts │ │ │ │ ├── appStore.ts │ │ │ │ ├── devTools.ts │ │ │ │ └── settings.ts │ │ │ ├── utils │ │ │ │ └── storage.ts │ │ │ └── themes.ts │ │ ├── assets │ │ │ ├── images │ │ │ │ ├── icon_256.png │ │ │ │ └── default-app-icon.png │ │ │ └── main.css │ │ ├── routes │ │ │ ├── Redirect.svelte │ │ │ ├── About.svelte │ │ │ ├── Device.svelte │ │ │ ├── Dashboard.svelte │ │ │ ├── Settings.svelte │ │ │ ├── Logs.svelte │ │ │ ├── Network.svelte │ │ │ ├── Storage.svelte │ │ │ ├── Console.svelte │ │ │ ├── DevTools.svelte │ │ │ ├── AppStore.svelte │ │ │ └── Elements.svelte │ │ ├── renderer.d.ts │ │ ├── main.ts │ │ └── App.svelte │ └── index.html ├── shared │ ├── enums │ │ ├── iconSize.ts │ │ ├── animations.ts │ │ ├── density.ts │ │ ├── textSize.ts │ │ ├── color.ts │ │ └── channel.ts │ ├── utils │ │ ├── delay.ts │ │ ├── formatCode.ts │ │ └── formatBytes.ts │ └── types │ │ ├── DeviceStorage.ts │ │ ├── StoreCategory.ts │ │ ├── DeviceInfo.ts │ │ ├── Log.ts │ │ ├── cliqz-oss__firefox-client.d.ts │ │ ├── StoreApp.ts │ │ └── Settings.ts ├── main │ ├── lib │ │ ├── isJson.ts │ │ ├── bridge.ts │ │ ├── server.ts │ │ └── database.ts │ ├── migrations │ │ └── 20240403042349_testing.js │ └── index.ts └── preload │ ├── preload.d.ts │ └── preload.ts ├── .gitignore ├── resources └── icon.png ├── .prettierignore ├── screenshots └── screenshot-elements.png ├── svelte.config.mjs ├── knexfile.js ├── .prettierrc ├── tsconfig.node.json ├── .eslintrc.cjs ├── tsconfig.json ├── electron.vite.config.ts ├── electron-builder.yml ├── README.md ├── package.json └── LICENSE /.eslintignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | dist 3 | out 4 | .gitignore 5 | -------------------------------------------------------------------------------- /.vscode/extensions.json: -------------------------------------------------------------------------------- 1 | { 2 | "recommendations": ["dbaeumer.vscode-eslint"] 3 | } 4 | -------------------------------------------------------------------------------- /src/renderer/src/lib/components/Statusbar.svelte: -------------------------------------------------------------------------------- 1 |
statusbar
2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | dist 3 | out 4 | .DS_Store 5 | *.log* 6 | .env 7 | *.sqlite 8 | -------------------------------------------------------------------------------- /resources/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NotSpecCo/kaiware/HEAD/resources/icon.png -------------------------------------------------------------------------------- /.prettierignore: -------------------------------------------------------------------------------- 1 | out 2 | dist 3 | pnpm-lock.yaml 4 | package-lock.json 5 | LICENSE 6 | **/*.md 7 | -------------------------------------------------------------------------------- /screenshots/screenshot-elements.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NotSpecCo/kaiware/HEAD/screenshots/screenshot-elements.png -------------------------------------------------------------------------------- /src/shared/enums/iconSize.ts: -------------------------------------------------------------------------------- 1 | export enum IconSize { 2 | Smallest = 15, 3 | Small = 18, 4 | Medium = 28, 5 | Large = 38 6 | } 7 | -------------------------------------------------------------------------------- /src/renderer/src/assets/images/icon_256.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NotSpecCo/kaiware/HEAD/src/renderer/src/assets/images/icon_256.png -------------------------------------------------------------------------------- /src/shared/enums/animations.ts: -------------------------------------------------------------------------------- 1 | export enum Animations { 2 | Instant = 0, 3 | Fast = 150, 4 | Normal = 300, 5 | Slow = 500, 6 | } 7 | -------------------------------------------------------------------------------- /src/shared/enums/density.ts: -------------------------------------------------------------------------------- 1 | export enum Density { 2 | Compact = 'compact', 3 | Normal = 'normal', 4 | Spacious = 'spacious', 5 | } 6 | -------------------------------------------------------------------------------- /src/shared/utils/delay.ts: -------------------------------------------------------------------------------- 1 | export function delay(ms: number): Promise { 2 | return new Promise((resolve) => setTimeout(resolve, ms)); 3 | } 4 | -------------------------------------------------------------------------------- /src/renderer/src/assets/images/default-app-icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NotSpecCo/kaiware/HEAD/src/renderer/src/assets/images/default-app-icon.png -------------------------------------------------------------------------------- /src/shared/types/DeviceStorage.ts: -------------------------------------------------------------------------------- 1 | export type DeviceStorage = { 2 | type: 'local' | 'session'; 3 | data?: { [key: string | number]: unknown }; 4 | }; 5 | -------------------------------------------------------------------------------- /src/shared/types/StoreCategory.ts: -------------------------------------------------------------------------------- 1 | export type StoreCategory = { 2 | id: string; 3 | name: string; 4 | description?: string; 5 | icon?: string; 6 | }; 7 | -------------------------------------------------------------------------------- /src/renderer/src/routes/Redirect.svelte: -------------------------------------------------------------------------------- 1 | 6 | -------------------------------------------------------------------------------- /src/shared/types/DeviceInfo.ts: -------------------------------------------------------------------------------- 1 | // export interface DeviceInfo { 2 | // id: string; 3 | // name: string; 4 | // connectionType: 'wifi' | 'usb' | 'none'; 5 | // } 6 | -------------------------------------------------------------------------------- /src/main/lib/isJson.ts: -------------------------------------------------------------------------------- 1 | export function isJson(str: string): boolean { 2 | try { 3 | JSON.parse(str); 4 | return true; 5 | } catch (e) { 6 | return false; 7 | } 8 | } 9 | -------------------------------------------------------------------------------- /src/shared/enums/textSize.ts: -------------------------------------------------------------------------------- 1 | export enum TextSize { 2 | Smallest = 'smallest', 3 | Small = 'small', 4 | Medium = 'medium', 5 | Large = 'large', 6 | Largest = 'largest', 7 | } 8 | -------------------------------------------------------------------------------- /src/shared/enums/color.ts: -------------------------------------------------------------------------------- 1 | export enum Color { 2 | Primary = 'var(--text-color)', 3 | Secondary = 'var(--secondary-text-color)', 4 | Tertiary = 'var(--divider-color)', 5 | Accent = 'var(--accent-color)' 6 | } 7 | -------------------------------------------------------------------------------- /.vscode/tasks.json: -------------------------------------------------------------------------------- 1 | { 2 | "version": "2.0.0", 3 | "tasks": [ 4 | { 5 | "type": "npm", 6 | "script": "dev", 7 | "problemMatcher": [], 8 | "label": "npm: dev", 9 | "detail": "electron-vite dev" 10 | } 11 | ] 12 | } 13 | -------------------------------------------------------------------------------- /src/preload/preload.d.ts: -------------------------------------------------------------------------------- 1 | import { ElectronAPI } from '@electron-toolkit/preload'; 2 | import { api } from './preload'; 3 | 4 | declare global { 5 | interface Window { 6 | electron: ElectronAPI; 7 | api: typeof api; 8 | } 9 | } 10 | -------------------------------------------------------------------------------- /src/shared/types/Log.ts: -------------------------------------------------------------------------------- 1 | // import { LogLevel } from '@nothing-special/kaiware-lib/enums'; 2 | 3 | // export type Log = { 4 | // id: number; 5 | // level: LogLevel; 6 | // source?: string; 7 | // data: string; 8 | // timestamp: string; 9 | // }; 10 | -------------------------------------------------------------------------------- /src/renderer/src/lib/ui-components/view/ViewContent.svelte: -------------------------------------------------------------------------------- 1 |
2 | 3 |
4 | 5 | 13 | -------------------------------------------------------------------------------- /svelte.config.mjs: -------------------------------------------------------------------------------- 1 | import { vitePreprocess } from '@sveltejs/vite-plugin-svelte'; 2 | 3 | export default { 4 | // Consult https://svelte.dev/docs#compile-time-svelte-preprocess 5 | // for more information about preprocessors 6 | preprocess: vitePreprocess() 7 | }; 8 | -------------------------------------------------------------------------------- /knexfile.js: -------------------------------------------------------------------------------- 1 | /** @type {import('knex').Knex.Config} */ 2 | export default { 3 | client: 'sqlite3', 4 | connection: { 5 | filename: './db-test.sqlite' 6 | }, 7 | migrations: { 8 | directory: './src/main/migrations' 9 | }, 10 | useNullAsDefault: true 11 | }; 12 | -------------------------------------------------------------------------------- /src/renderer/src/lib/components/Header.svelte: -------------------------------------------------------------------------------- 1 |
2 | 3 | 15 | -------------------------------------------------------------------------------- /src/renderer/src/lib/ui-components/view/ViewTabs.svelte: -------------------------------------------------------------------------------- 1 | 4 | 5 |
6 | 7 | 8 | 9 |
10 | 11 | 17 | -------------------------------------------------------------------------------- /src/renderer/src/routes/About.svelte: -------------------------------------------------------------------------------- 1 | 6 | 7 | 8 | 9 | About 10 | 11 | -------------------------------------------------------------------------------- /src/renderer/src/routes/Device.svelte: -------------------------------------------------------------------------------- 1 | 6 | 7 | 8 | 9 | Device 10 | 11 | -------------------------------------------------------------------------------- /src/renderer/src/routes/Dashboard.svelte: -------------------------------------------------------------------------------- 1 | 6 | 7 | 8 | 9 | Dashboard 10 | 11 | -------------------------------------------------------------------------------- /.prettierrc: -------------------------------------------------------------------------------- 1 | { 2 | "useTabs": true, 3 | "tabWidth": 4, 4 | "singleQuote": true, 5 | "trailingComma": "none", 6 | "printWidth": 100, 7 | "htmlWhitespaceSensitivity": "ignore", 8 | "bracketSpacing": true, 9 | "plugins": ["prettier-plugin-svelte"], 10 | "overrides": [ 11 | { 12 | "files": "*.yml", 13 | "options": { 14 | "tabWidth": 2 15 | } 16 | } 17 | ] 18 | } 19 | -------------------------------------------------------------------------------- /src/shared/utils/formatCode.ts: -------------------------------------------------------------------------------- 1 | import prettierHtml from 'prettier/plugins/html'; 2 | import prettier from 'prettier/standalone'; 3 | 4 | export function formatCode(code: string, language: 'html' | 'json', spaces = 2): Promise { 5 | return prettier.format(code, { 6 | parser: language, 7 | useTabs: false, 8 | tabWidth: spaces, 9 | plugins: language === 'html' ? [prettierHtml] : [] 10 | }); 11 | } 12 | -------------------------------------------------------------------------------- /src/renderer/src/lib/ui-components/view/View.svelte: -------------------------------------------------------------------------------- 1 |
2 | 3 |
4 | 5 | 17 | -------------------------------------------------------------------------------- /src/shared/utils/formatBytes.ts: -------------------------------------------------------------------------------- 1 | export function formatBytes(bytes?: number, decimals = 2): string { 2 | if (!bytes) return '0 B'; 3 | 4 | const k = 1024; 5 | const dm = decimals < 0 ? 0 : decimals; 6 | const sizes = ['B', 'KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB']; 7 | 8 | const i = Math.floor(Math.log(bytes) / Math.log(k)); 9 | 10 | return parseFloat((bytes / Math.pow(k, i)).toFixed(dm)) + ' ' + sizes[i]; 11 | } 12 | -------------------------------------------------------------------------------- /src/renderer/src/routes/Settings.svelte: -------------------------------------------------------------------------------- 1 | 9 | 10 | 11 | 12 | Settings 13 | 14 | -------------------------------------------------------------------------------- /src/renderer/src/renderer.d.ts: -------------------------------------------------------------------------------- 1 | /// 2 | /// 3 | /// 4 | 5 | import { api } from '$preload/preload'; 6 | 7 | declare global { 8 | interface Window { 9 | // see preload.ts for implementation 10 | electron: { 11 | ipcRenderer: IpcRenderer; 12 | webFrame: WebFrame; 13 | process: NodeProcess; 14 | }; 15 | api: typeof api; 16 | } 17 | } 18 | 19 | export {}; 20 | -------------------------------------------------------------------------------- /src/renderer/src/lib/ui-components/Code.svelte: -------------------------------------------------------------------------------- 1 | 4 | 5 |
6 | 7 | 21 | -------------------------------------------------------------------------------- /src/shared/types/cliqz-oss__firefox-client.d.ts: -------------------------------------------------------------------------------- 1 | declare module '@cliqz-oss/firefox-client' { 2 | export default class FirefoxClient { 3 | // constructor(); 4 | // connect(port: number, host: string, callback: (err: unknown) => void): void; 5 | // on(event: string, callback: (err: unknown) => void): void; 6 | // disconnect(): void; 7 | // getDevice(callback: (err: unknown, result: DeviceActor) => void): void; 8 | // getWebapps(callback: (err: unknown, result: AppsActor) => void): void; 9 | } 10 | } 11 | -------------------------------------------------------------------------------- /src/renderer/src/lib/ui-components/view/ViewHeader.svelte: -------------------------------------------------------------------------------- 1 | 4 | 5 |
6 | {#if title} 7 |
{title}
8 | {/if} 9 | 10 |
11 | 12 | 26 | -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | "[typescript]": { 3 | "editor.defaultFormatter": "esbenp.prettier-vscode" 4 | }, 5 | "[javascript]": { 6 | "editor.defaultFormatter": "esbenp.prettier-vscode" 7 | }, 8 | "[json]": { 9 | "editor.defaultFormatter": "esbenp.prettier-vscode" 10 | }, 11 | "[svelte]": { 12 | "editor.defaultFormatter": "svelte.svelte-vscode" 13 | }, 14 | "svelte.enable-ts-plugin": true, 15 | "eslint.validate": ["javascript", "javascriptreact", "svelte"], 16 | "typescript.preferences.importModuleSpecifier": "non-relative" 17 | } 18 | -------------------------------------------------------------------------------- /src/renderer/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Kaiware 6 | 7 | 11 | 12 | 13 | 14 |
15 | 16 | 17 | 18 | -------------------------------------------------------------------------------- /src/shared/types/StoreApp.ts: -------------------------------------------------------------------------------- 1 | export type StoreApp = { 2 | name: string; 3 | description: string; 4 | icon: string; 5 | screenshots: string[]; 6 | license: string; 7 | website: string; 8 | git_repo: string; 9 | download: { 10 | url: string; 11 | manifest: string; 12 | }; 13 | author: string[]; 14 | maintainer: string[]; 15 | has_tracking: boolean; 16 | has_ads: boolean; 17 | donation: string; 18 | meta: { 19 | tags: string; 20 | categories: string[]; 21 | }; 22 | type: string; 23 | slug: string; 24 | people: [{ name: string; role: 'author' | 'maintainer'; email?: string; website?: string }]; 25 | }; 26 | -------------------------------------------------------------------------------- /tsconfig.node.json: -------------------------------------------------------------------------------- 1 | { 2 | "include": ["electron.vite.config.*", "src/main/**/*", "src/preload/**/*", "src/shared/**/*"], 3 | "compilerOptions": { 4 | "composite": true, 5 | "types": ["electron-vite/node"], 6 | "esModuleInterop": true, 7 | "module": "ESNext", 8 | "moduleResolution": "Bundler", 9 | "strict": true, 10 | "strictNullChecks": true, 11 | "baseUrl": ".", 12 | "paths": { 13 | "$main": ["./src/main"], 14 | "$main/*": ["./src/main/*"], 15 | "$preload": ["./src/preload"], 16 | "$preload/*": ["./src/preload/*"], 17 | "$shared": ["./src/shared"], 18 | "$shared/*": ["./src/shared/*"] 19 | } 20 | } 21 | } 22 | -------------------------------------------------------------------------------- /.eslintrc.cjs: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | root: true, 3 | extends: [ 4 | 'eslint:recommended', 5 | 'plugin:@typescript-eslint/recommended', 6 | 'plugin:svelte/recommended' 7 | ], 8 | parser: '@typescript-eslint/parser', 9 | plugins: ['@typescript-eslint'], 10 | parserOptions: { 11 | sourceType: 'module', 12 | ecmaVersion: 2020, 13 | extraFileExtensions: ['.svelte'] 14 | }, 15 | env: { 16 | browser: true, 17 | es2022: true, 18 | node: true 19 | }, 20 | overrides: [ 21 | { 22 | files: ['*.svelte'], 23 | parser: 'svelte-eslint-parser', 24 | parserOptions: { 25 | parser: '@typescript-eslint/parser' 26 | } 27 | } 28 | ] 29 | }; 30 | -------------------------------------------------------------------------------- /src/renderer/src/main.ts: -------------------------------------------------------------------------------- 1 | import 'highlight.js/styles/stackoverflow-dark.css'; 2 | import './assets/main.css'; 3 | 4 | import dayjs from 'dayjs'; 5 | import localizedFormat from 'dayjs/plugin/localizedFormat'; 6 | import hljs from 'highlight.js'; 7 | import hljsJson from 'highlight.js/lib/languages/json'; 8 | import hljsXml from 'highlight.js/lib/languages/xml'; 9 | import App from './App.svelte'; 10 | 11 | hljs.registerLanguage('json', hljsJson); 12 | hljs.registerLanguage('html', hljsXml); 13 | 14 | dayjs.extend(localizedFormat); 15 | 16 | const app = new App({ 17 | target: document.getElementById('app') as HTMLElement 18 | }); 19 | 20 | export default app; 21 | -------------------------------------------------------------------------------- /src/renderer/src/routes/Logs.svelte: -------------------------------------------------------------------------------- 1 | 10 | 11 |
12 | 13 |
14 | {#each $logs as row (row.id)} 15 | 16 | {/each} 17 |
18 |
19 | 20 | 32 | -------------------------------------------------------------------------------- /src/renderer/src/lib/stores/device.ts: -------------------------------------------------------------------------------- 1 | import type { DeviceInfo } from '@nothing-special/kaiware-lib/types'; 2 | import { writable } from 'svelte/store'; 3 | 4 | function createStore() { 5 | const { subscribe, set } = writable(null); 6 | 7 | async function refresh() { 8 | await window.api 9 | .getDeviceInfo() 10 | .then((res) => set(res)) 11 | .catch((err) => console.log(err)); 12 | } 13 | 14 | window.api.onDeviceInfoChange((device) => set(device)); 15 | 16 | function reset() { 17 | set(null); 18 | } 19 | 20 | return { 21 | subscribe, 22 | set, 23 | refresh, 24 | reset 25 | }; 26 | } 27 | 28 | export const device = createStore(); 29 | -------------------------------------------------------------------------------- /src/renderer/src/lib/ui-components/form/InlineInput.svelte: -------------------------------------------------------------------------------- 1 | 6 | 7 | 17 | 18 | 33 | -------------------------------------------------------------------------------- /src/renderer/src/lib/utils/storage.ts: -------------------------------------------------------------------------------- 1 | type StorageKey = 'settings' | 'store-db'; 2 | 3 | export class Storage { 4 | static local = { 5 | get(key: StorageKey): T { 6 | const data = localStorage.getItem(key); 7 | return data ? JSON.parse(data) : null; 8 | }, 9 | set(key: StorageKey, value: T): void { 10 | localStorage.setItem(key, JSON.stringify(value)); 11 | } 12 | }; 13 | 14 | static session = { 15 | get(key: StorageKey): T { 16 | const data = sessionStorage.getItem(key); 17 | return data ? JSON.parse(data) : null; 18 | }, 19 | set(key: StorageKey, value: T): void { 20 | sessionStorage.setItem(key, JSON.stringify(value)); 21 | } 22 | }; 23 | } 24 | -------------------------------------------------------------------------------- /src/renderer/src/lib/ui-components/view/ViewTab.svelte: -------------------------------------------------------------------------------- 1 | 7 | 8 | 9 | 10 | 11 | 12 | 37 | -------------------------------------------------------------------------------- /src/renderer/src/lib/ui-components/form/Input.svelte: -------------------------------------------------------------------------------- 1 | 6 | 7 | 18 | 19 | 38 | -------------------------------------------------------------------------------- /src/shared/enums/channel.ts: -------------------------------------------------------------------------------- 1 | export enum Channel { 2 | GetLogs = 'get-logs', 3 | ClearLogs = 'clear-logs', 4 | NewLog = 'new-log', 5 | 6 | GetElements = 'get-elements', 7 | RefreshElements = 'refresh-elements', 8 | 9 | GetElementStyles = 'get-element-styles', 10 | SetElementStyles = 'set-element-styles', 11 | RefreshElementStyles = 'refresh-element-styles', 12 | 13 | GetElementData = 'get-element-data', 14 | SetElementData = 'set-element-data', 15 | RefreshElementData = 'refresh-element-data', 16 | 17 | GetDeviceInfo = 'get-device-info', 18 | RefreshDeviceInfo = 'refresh-device-info', 19 | 20 | GetStorage = 'get-storage', 21 | RefreshStorage = 'refresh-storage', 22 | 23 | GetNetworkRequests = 'get-network-requests', 24 | NetworkRequestUpdate = 'network-request-update', 25 | ClearNetworkRequests = 'clear-network-requests', 26 | GetNetworkRequestById = 'get-network-request-by-id', 27 | 28 | ExecuteConsoleCommand = 'execute-console-command' 29 | } 30 | -------------------------------------------------------------------------------- /src/renderer/src/lib/ui-components/buttons/IconButton.svelte: -------------------------------------------------------------------------------- 1 | 12 | 13 | 16 | 17 | 32 | -------------------------------------------------------------------------------- /.vscode/launch.json: -------------------------------------------------------------------------------- 1 | { 2 | "version": "0.2.0", 3 | "configurations": [ 4 | { 5 | "name": "Debug Main Process", 6 | "type": "node", 7 | "request": "launch", 8 | "cwd": "${workspaceRoot}", 9 | "runtimeExecutable": "${workspaceRoot}/node_modules/.bin/electron-vite", 10 | "windows": { 11 | "runtimeExecutable": "${workspaceRoot}/node_modules/.bin/electron-vite.cmd" 12 | }, 13 | "runtimeArgs": ["--sourcemap"], 14 | "env": { 15 | "REMOTE_DEBUGGING_PORT": "9222" 16 | } 17 | }, 18 | { 19 | "name": "Debug Renderer Process", 20 | "port": 9222, 21 | "request": "attach", 22 | "type": "chrome", 23 | "webRoot": "${workspaceFolder}/src/renderer", 24 | "timeout": 60000, 25 | "presentation": { 26 | "hidden": true 27 | } 28 | } 29 | ], 30 | "compounds": [ 31 | { 32 | "name": "Debug All", 33 | "configurations": ["Debug Main Process", "Debug Renderer Process"], 34 | "presentation": { 35 | "order": 1 36 | } 37 | } 38 | ] 39 | } 40 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "@tsconfig/svelte/tsconfig.json", 3 | "include": [ 4 | "src/renderer/src/*.d.ts", 5 | "src/renderer/src/**/*", 6 | "src/renderer/src/**/*.svelte", 7 | "src/preload/*.d.ts", 8 | "src/types/**/*", 9 | "src/shared/**/*" 10 | ], 11 | "compilerOptions": { 12 | "verbatimModuleSyntax": true, 13 | "useDefineForClassFields": true, 14 | "strict": true, 15 | "strictNullChecks": true, 16 | "allowJs": true, 17 | "checkJs": true, 18 | "lib": ["ESNext", "DOM", "DOM.Iterable"], 19 | "esModuleInterop": true, 20 | "noImplicitAny": false, 21 | "module": "ESNext", 22 | "moduleResolution": "Bundler", 23 | "baseUrl": ".", 24 | "paths": { 25 | "$lib": ["./src/renderer/src/lib"], 26 | "$lib/*": ["./src/renderer/src/lib/*"], 27 | "$": ["./src/renderer/src"], 28 | "$/*": ["./src/renderer/src/*"], 29 | "$shared": ["./src/shared"], 30 | "$shared/*": ["./src/shared/*"], 31 | "$preload": ["./src/preload"], 32 | "$preload/*": ["./src/preload/*"] 33 | } 34 | }, 35 | "references": [{ "path": "./tsconfig.node.json" }] 36 | } 37 | -------------------------------------------------------------------------------- /src/renderer/src/lib/ui-components/icons/Icon.svelte: -------------------------------------------------------------------------------- 1 | 28 | 29 |
30 | 31 |
32 | 33 | 43 | -------------------------------------------------------------------------------- /electron.vite.config.ts: -------------------------------------------------------------------------------- 1 | import { svelte } from '@sveltejs/vite-plugin-svelte'; 2 | import { defineConfig, externalizeDepsPlugin } from 'electron-vite'; 3 | import path from 'node:path'; 4 | import Icons from 'unplugin-icons/vite'; 5 | 6 | export default defineConfig({ 7 | main: { 8 | plugins: [externalizeDepsPlugin()], 9 | resolve: { 10 | alias: { 11 | $main: path.resolve(__dirname, './src/main'), 12 | $preload: path.resolve(__dirname, './src/preload'), 13 | $shared: path.resolve(__dirname, './src/shared') 14 | } 15 | } 16 | }, 17 | preload: { 18 | plugins: [externalizeDepsPlugin()], 19 | resolve: { 20 | alias: { 21 | $preload: path.resolve(__dirname, './src/preload'), 22 | $shared: path.resolve(__dirname, './src/shared') 23 | } 24 | } 25 | }, 26 | renderer: { 27 | plugins: [svelte(), Icons({ compiler: 'svelte' })], 28 | resolve: { 29 | alias: { 30 | $: path.resolve(__dirname, './src/renderer/src'), 31 | $lib: path.resolve(__dirname, './src/renderer/src/lib'), 32 | $assets: path.resolve(__dirname, './src/renderer/assets'), 33 | $shared: path.resolve(__dirname, './src/shared') 34 | } 35 | } 36 | } 37 | }); 38 | -------------------------------------------------------------------------------- /src/renderer/src/routes/Network.svelte: -------------------------------------------------------------------------------- 1 | 18 | 19 |
20 |
21 | {#each $networkRequests as row (row.id)} 22 | handleRowClick(row.id)} /> 23 | {/each} 24 |
25 | {#if selectedNetworkRequestId !== null} 26 | (selectedNetworkRequestId = null)} 29 | /> 30 | {/if} 31 |
32 | 33 | 45 | -------------------------------------------------------------------------------- /src/renderer/src/routes/Storage.svelte: -------------------------------------------------------------------------------- 1 | 26 | 27 |
28 |
Local Storage
29 | 30 | {@html localHtmlContent} 31 |
Session Storage
32 | 33 | {@html sessionHtmlContent} 34 |
35 | 36 | 49 | -------------------------------------------------------------------------------- /src/main/migrations/20240403042349_testing.js: -------------------------------------------------------------------------------- 1 | /** 2 | * @param { import("knex").Knex } knex 3 | * @returns { Promise } 4 | */ 5 | export const up = function (knex) { 6 | console.log('20240403042349_testing.js up'); 7 | return knex.schema 8 | .createTable('logs', (table) => { 9 | table.increments('id').primary(); 10 | table.string('data').notNullable(); 11 | table.string('level').notNullable(); 12 | table.string('source').nullable(); 13 | table.string('timestamp').notNullable(); 14 | }) 15 | .createTable('network_requests', (table) => { 16 | table.increments('id').primary(); 17 | table.string('requestId').notNullable(); 18 | table.string('url').nullable(); 19 | table.string('method').nullable(); 20 | table.string('lifecycleStatus').nullable(); 21 | table.string('headers').nullable(); 22 | table.string('body').nullable(); 23 | table.integer('startTime').nullable(); 24 | table.integer('endTime').nullable(); 25 | table.integer('duration').nullable(); 26 | table.integer('responseStatus').nullable(); 27 | table.string('responseHeaders').nullable(); 28 | table.string('responseBody').nullable(); 29 | table.integer('responseSize').nullable(); 30 | }); 31 | }; 32 | 33 | /** 34 | * @param { import("knex").Knex } knex 35 | * @returns { Promise } 36 | */ 37 | export const down = function (knex) { 38 | console.log('20240403042349_testing.js down'); 39 | return knex.schema.dropTable('logs'); 40 | }; 41 | -------------------------------------------------------------------------------- /src/renderer/src/lib/themes.ts: -------------------------------------------------------------------------------- 1 | import type { ThemeConfig } from '$shared/types/Settings'; 2 | 3 | export const themes: ThemeConfig[] = [ 4 | { 5 | id: 'dark', 6 | values: { 7 | // Main 8 | mainBackgroundColorH: 219, 9 | mainBackgroundColorS: 23, 10 | mainBackgroundColorL: 12, 11 | mainBackgroundColorA: 100, 12 | 13 | // Panel 14 | panelBackgroundColorH: 219, 15 | panelBackgroundColorS: 24, 16 | panelBackgroundColorL: 16, 17 | panelBackgroundColorA: 100, 18 | 19 | // Accent Color 20 | accentColorH: 179, 21 | accentColorS: 51, 22 | accentColorL: 59, 23 | accentColorA: 100, 24 | 25 | errorColorH: 358, 26 | errorColorS: 65, 27 | errorColorL: 55, 28 | errorColorA: 100, 29 | 30 | warningColorH: 45, 31 | warningColorS: 93, 32 | warningColorL: 58, 33 | warningColorA: 100, 34 | 35 | successColorH: 118, 36 | successColorS: 49, 37 | successColorL: 48, 38 | successColorA: 100, 39 | 40 | // Text 41 | primaryTextColorH: 0, 42 | primaryTextColorS: 0, 43 | primaryTextColorL: 100, 44 | primaryTextColorA: 88, 45 | 46 | secondaryTextColorH: 0, 47 | secondaryTextColorS: 0, 48 | secondaryTextColorL: 100, 49 | secondaryTextColorA: 50, 50 | 51 | tertiaryTextColorH: 0, 52 | tertiaryTextColorS: 0, 53 | tertiaryTextColorL: 100, 54 | tertiaryTextColorA: 30, 55 | 56 | // Other 57 | dividerColorH: 0, 58 | dividerColorS: 0, 59 | dividerColorL: 100, 60 | dividerColorA: 10 61 | } 62 | } 63 | ]; 64 | -------------------------------------------------------------------------------- /electron-builder.yml: -------------------------------------------------------------------------------- 1 | appId: com.electron.app 2 | productName: kaiware 3 | directories: 4 | buildResources: build 5 | files: 6 | - '!**/.vscode/*' 7 | - '!src/*' 8 | - '!electron.vite.config.{js,ts,mjs,cjs}' 9 | - '!{.eslintignore,.eslintrc.cjs,.prettierignore,.prettierrc.yaml,dev-app-update.yml,CHANGELOG.md,README.md}' 10 | - '!{.env,.env.*,.npmrc,pnpm-lock.yaml}' 11 | - '!{tsconfig.json,tsconfig.node.json,tsconfig.web.json}' 12 | extraFiles: 'src/main/migrations' 13 | asarUnpack: 14 | - resources/** 15 | win: 16 | executableName: kaiware 17 | nsis: 18 | artifactName: ${name}-${version}-setup.${ext} 19 | shortcutName: ${productName} 20 | uninstallDisplayName: ${productName} 21 | createDesktopShortcut: always 22 | mac: 23 | entitlementsInherit: build/entitlements.mac.plist 24 | extendInfo: 25 | - NSCameraUsageDescription: Application requests access to the device's camera. 26 | - NSMicrophoneUsageDescription: Application requests access to the device's microphone. 27 | - NSDocumentsFolderUsageDescription: Application requests access to the user's Documents folder. 28 | - NSDownloadsFolderUsageDescription: Application requests access to the user's Downloads folder. 29 | notarize: false 30 | dmg: 31 | artifactName: ${name}-${version}.${ext} 32 | linux: 33 | target: 34 | - AppImage 35 | - snap 36 | - deb 37 | maintainer: electronjs.org 38 | category: Utility 39 | appImage: 40 | artifactName: ${name}-${version}.${ext} 41 | npmRebuild: false 42 | publish: 43 | provider: generic 44 | url: https://example.com/auto-updates 45 | -------------------------------------------------------------------------------- /src/renderer/src/lib/components/Footer.svelte: -------------------------------------------------------------------------------- 1 | 10 | 11 |
12 |
13 | {#if $device?.connectionType === 'usb'} 14 | 15 | {:else if $device?.connectionType === 'wifi'} 16 | 17 | {:else} 18 | 19 | {/if} 20 |
{$device?.name ?? 'No device connected'}
21 |
22 |
23 | {`Kaiware v${pkg.version}`} 24 |
25 | 26 | 55 | -------------------------------------------------------------------------------- /src/renderer/src/routes/Console.svelte: -------------------------------------------------------------------------------- 1 | 32 | 33 |
34 |
35 | 36 |
37 |
38 | 39 | {@html responseHtml} 40 |
41 |
42 | 43 | 59 | -------------------------------------------------------------------------------- /src/renderer/src/assets/main.css: -------------------------------------------------------------------------------- 1 | :root { 2 | --main-background-color: hsla(219, 23%, 12%, 100%); 3 | --panel-background-color: hsla(219, 24%, 16%, 100%); 4 | 5 | --accent-color: hsla(179, 51%, 59%, 100%); 6 | --error-color: hsla(358, 65%, 55%, 100%); 7 | --warning-color: hsla(45, 93%, 58%, 100%); 8 | --success-color: hsla(118, 49%, 48%, 100%); 9 | --divider-color: hsla(0, 0%, 100%, 10%); 10 | 11 | --primary-text-color: hsla(0, 0%, 100%, 88%); 12 | --secondary-text-color: hsla(0, 0%, 100%, 50%); 13 | --tertiary-text-color: hsla(0, 0%, 100%, 30%); 14 | --accent-text-color: hsla(179, 51%, 59%, 100%); 15 | 16 | --radius: 6px; 17 | --animation-speed: 300ms; 18 | --regular-font-weight: 400; 19 | --bold-font-weight: 600; 20 | --base-font-size: 10px; 21 | 22 | font-size: var(--base-font-size); 23 | font-weight: var(--regular-font-weight); 24 | color: var(--primary-text-color); 25 | } 26 | 27 | html { 28 | font-size: var(--base-font-size); 29 | } 30 | body { 31 | font-size: 1.4rem; 32 | min-height: 100vh; 33 | min-width: 100vw; 34 | color: var(--primary-text-color); 35 | background: var(--main-background-color); 36 | line-height: 1.4; 37 | font-family: 38 | 'SF Pro', 39 | Inter, 40 | -apple-system, 41 | BlinkMacSystemFont, 42 | 'Segoe UI', 43 | Roboto, 44 | Oxygen, 45 | Ubuntu, 46 | Cantarell, 47 | 'Fira Sans', 48 | 'Droid Sans', 49 | 'Helvetica Neue', 50 | sans-serif; 51 | text-rendering: optimizeLegibility; 52 | -webkit-font-smoothing: antialiased; 53 | -moz-osx-font-smoothing: grayscale; 54 | } 55 | 56 | *, 57 | *::before, 58 | *::after { 59 | box-sizing: border-box; 60 | margin: 0; 61 | min-width: 0; /* This helps with flexbox and grid */ 62 | font-weight: normal; 63 | } 64 | 65 | ul { 66 | list-style: none; 67 | } 68 | 69 | a { 70 | text-decoration: none; 71 | color: inherit; 72 | } 73 | a:hover { 74 | text-decoration: underline; 75 | } 76 | -------------------------------------------------------------------------------- /src/renderer/src/App.svelte: -------------------------------------------------------------------------------- 1 | 49 | 50 |
51 |
52 |
53 | 54 | 55 |
56 |
57 |
58 | 59 | 73 | -------------------------------------------------------------------------------- /src/renderer/src/lib/ui-components/form/Select.svelte: -------------------------------------------------------------------------------- 1 | 22 | 23 |
24 |
25 |
{displayText}
26 | 27 |
28 | 34 |
35 | 36 | 74 | -------------------------------------------------------------------------------- /src/shared/types/Settings.ts: -------------------------------------------------------------------------------- 1 | import { Animations } from '$shared/enums/animations'; 2 | import { Density } from '$shared/enums/density'; 3 | import { TextSize } from '$shared/enums/textSize'; 4 | 5 | export declare type ThemeConfig = { 6 | id: string; 7 | values: ThemeSettings; 8 | }; 9 | 10 | export type ThemeSettings = { 11 | // Main 12 | mainBackgroundColorH: number; 13 | mainBackgroundColorS: number; 14 | mainBackgroundColorL: number; 15 | mainBackgroundColorA: number; 16 | 17 | // Panel 18 | panelBackgroundColorH: number; 19 | panelBackgroundColorS: number; 20 | panelBackgroundColorL: number; 21 | panelBackgroundColorA: number; 22 | 23 | // General Colors 24 | accentColorH: number; 25 | accentColorS: number; 26 | accentColorL: number; 27 | accentColorA: number; 28 | 29 | errorColorH: number; 30 | errorColorS: number; 31 | errorColorL: number; 32 | errorColorA: number; 33 | 34 | warningColorH: number; 35 | warningColorS: number; 36 | warningColorL: number; 37 | warningColorA: number; 38 | 39 | successColorH: number; 40 | successColorS: number; 41 | successColorL: number; 42 | successColorA: number; 43 | 44 | // Text 45 | primaryTextColorH: number; 46 | primaryTextColorS: number; 47 | primaryTextColorL: number; 48 | primaryTextColorA: number; 49 | 50 | secondaryTextColorH: number; 51 | secondaryTextColorS: number; 52 | secondaryTextColorL: number; 53 | secondaryTextColorA: number; 54 | 55 | tertiaryTextColorH: number; 56 | tertiaryTextColorS: number; 57 | tertiaryTextColorL: number; 58 | tertiaryTextColorA: number; 59 | 60 | // Other 61 | dividerColorH: number; 62 | dividerColorS: number; 63 | dividerColorL: number; 64 | dividerColorA: number; 65 | }; 66 | 67 | export type Settings = { 68 | textSize: TextSize; 69 | displayDensity: Density; 70 | borderRadius: number; 71 | animationSpeed: Animations; 72 | themeId: string; 73 | 74 | // Toaster 75 | toasterLocation: 'top' | 'bottom'; 76 | toasterDuration: number; 77 | 78 | showHelpText: boolean; 79 | }; 80 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Kaiware 2 | 3 | A desktop application that lets you remotely debug apps on your KaiOS device. Still in the exploration and experimentation phase, so expect bugs and changes. 4 | 5 | ![Screenshot](/screenshots/screenshot-elements.png?raw=true) 6 | 7 | ### Features 8 | 9 | The purpose of Kaiware is to provide remote debugging tools for platforms that may not have access to them. 10 | 11 | - **HTML Element Inspector:** Inspect HTML elements and computed CSS styles within your application. Supports real-time editing of CSS styles, with immediate reflection on your running application. 12 | - **Logging:** Display debug, info, warning, and error logs from your app. The Kaiware client shims the global `console` object to capture log events and sends them to the app on your desktop. This functionality can be disabled, and you can instead use the dedicated Kaiware logger. 13 | - **Network Requests:** Monitor and analyze network requests made from your device, including all the information and stats you'd expect to see. 14 | - **Storage:** View what's in your app's session and local storage. Future updates will include support for IndexedDB and other storage types. 15 | - **Console:** Direct interaction with the global `window` object, enabling data manipulation, function execution, and other JavaScript operations directly from the console. 16 | 17 | *Note: Some features are currently in basic form but are actively being improved.* 18 | 19 | ### Demo 20 | 21 | 1. Launch Kaiware. It also starts a http server on port 3000 for your phone to connect to. 22 | 2. Ensure your computer and KaiOS phone are on the same network. 23 | 3. Find your computer's local IP address. It should be something like 192.168.x.x. 24 | 4. Clone [Kaiware Test Client](https://github.com/nothingspecialdev/kaiware-test-client) and follow the instructions in the README. 25 | 5. Install Kaiware Test Client on your phone. 26 | 6. Click buttons to send data from your phone to Kaiware. 27 | 28 | ### Development 29 | 30 | ```bash 31 | npm run dev 32 | ``` -------------------------------------------------------------------------------- /src/renderer/src/lib/components/LogRow.svelte: -------------------------------------------------------------------------------- 1 | 11 | 12 |
(expanded = !expanded)} 17 | on:keydown={() => (expanded = !expanded)} 18 | > 19 |
25 |
26 |
27 | {label} 28 |
29 |
30 | {#each logItem.data as data} 31 | {typeof data === 'object' ? JSON.stringify(data) : data} 32 | {/each} 33 |
34 |
35 |
36 | 37 | 95 | -------------------------------------------------------------------------------- /src/renderer/src/lib/components/NetworkRequestRow.svelte: -------------------------------------------------------------------------------- 1 | 10 | 11 |
12 |
{displayDate}
13 |
{networkRequest.method}
14 |
{networkRequest.url}
15 |
{formatBytes(networkRequest.responseSize)}
16 | {#if networkRequest.duration} 17 |
{`${networkRequest.duration} ms`}
18 | {/if} 19 |
26 | {networkRequest.lifecycleStatus} 27 |
28 |
= 200 && 32 | networkRequest.responseStatus < 300} 33 | class:warning={networkRequest.responseStatus && 34 | networkRequest.responseStatus >= 300 && 35 | networkRequest.responseStatus < 400} 36 | class:error={networkRequest.responseStatus && networkRequest.responseStatus >= 400} 37 | > 38 | {networkRequest.responseStatus} 39 |
40 |
41 | 42 | 83 | -------------------------------------------------------------------------------- /src/renderer/src/routes/DevTools.svelte: -------------------------------------------------------------------------------- 1 | 26 | 27 | 28 | 29 | 35 | Logs 36 | 37 | 44 | Elements 45 | 46 | 52 | Network 53 | 54 | 61 | Storage 62 | 63 | 70 | Console 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 95 | -------------------------------------------------------------------------------- /src/renderer/src/lib/components/NetworkRequestDetail.svelte: -------------------------------------------------------------------------------- 1 | 36 | 37 |
38 |
39 | 40 |
41 | {#if request === null} 42 |
No request.
43 | {:else} 44 |
45 |
{dayjs(request.startTime).format('LTS')}
46 |
{request.method}
47 |
{request.url}
48 |
{formatBytes(request.responseSize)}
49 | {#if request.duration} 50 |
{`${request.duration} ms`}
51 | {/if} 52 |
59 | {request.lifecycleStatus} 60 |
61 |
= 200 && 65 | request.responseStatus < 300} 66 | class:warning={request.responseStatus && 67 | request.responseStatus >= 300 && 68 | request.responseStatus < 400} 69 | class:error={request.responseStatus && request.responseStatus >= 400} 70 | > 71 | {request.responseStatus} 72 |
73 |
74 | {/if} 75 |
76 | 77 | 83 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "kaiware", 3 | "version": "0.1.0", 4 | "description": "A desktop application that lets you remotely debug apps on your KaiOS device.", 5 | "main": "./out/main/index.js", 6 | "author": { 7 | "name": "Garrett Downs", 8 | "url": "https://nothingspecial.io" 9 | }, 10 | "homepage": "https://github.com/nothingspecialdev/kaiware", 11 | "repository": { 12 | "type": "git", 13 | "url": "https://github.com/nothingspecialdev/kaiware" 14 | }, 15 | "type": "module", 16 | "scripts": { 17 | "format": "prettier --check .", 18 | "format:fix": "prettier --check --write .", 19 | "lint:all": "npm run lint && npm run typecheck && npm run svelte-check", 20 | "lint": "eslint . --ext .js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts,.svelte", 21 | "lint:fix": "eslint . --ext .js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts,.svelte --fix", 22 | "typecheck:node": "tsc --noEmit -p tsconfig.node.json --composite false", 23 | "svelte-check": "svelte-check --tsconfig ./tsconfig.json", 24 | "typecheck": "npm run typecheck:node && npm run svelte-check", 25 | "start": "electron-vite preview", 26 | "dev": "electron-vite dev", 27 | "build": "npm run typecheck && electron-vite build", 28 | "postinstall": "electron-builder install-app-deps", 29 | "build:unpack": "npm run build && electron-builder --dir", 30 | "build:win": "npm run build && electron-builder --win", 31 | "build:mac": "npm run build && electron-builder --mac", 32 | "build:linux": "npm run build && electron-builder --linux" 33 | }, 34 | "dependencies": { 35 | "@cliqz-oss/firefox-client": "^0.3.1", 36 | "@electron-toolkit/preload": "^3.0.0", 37 | "@electron-toolkit/utils": "^3.0.0", 38 | "@nothing-special/kaiware-lib": "^0.11.0", 39 | "dayjs": "^1.11.10", 40 | "express": "^4.19.2", 41 | "express-ws": "^5.0.2", 42 | "highlight.js": "^11.9.0", 43 | "knex": "^3.1.0", 44 | "prettier": "^3.2.5", 45 | "sqlite3": "5.1.6", 46 | "svelte-spa-router": "^4.0.1", 47 | "ws": "^8.16.0", 48 | "zod": "^3.22.4" 49 | }, 50 | "devDependencies": { 51 | "@iconify-json/ion": "^1.1.17", 52 | "@iconify-json/mdi": "^1.1.65", 53 | "@sveltejs/vite-plugin-svelte": "^3.0.1", 54 | "@swc/core": "^1.4.11", 55 | "@tsconfig/svelte": "^5.0.4", 56 | "@types/express": "^4.17.21", 57 | "@types/express-ws": "^3.0.4", 58 | "@types/node": "^18.19.9", 59 | "@types/ws": "^8.5.10", 60 | "@typescript-eslint/eslint-plugin": "^7.5.0", 61 | "electron": "^29.1.6", 62 | "electron-builder": "^24.9.1", 63 | "electron-vite": "^2.0.0", 64 | "eslint": "^8.56.0", 65 | "eslint-plugin-svelte": "^2.35.1", 66 | "prettier-plugin-svelte": "^3.2.2", 67 | "svelte": "^4.2.9", 68 | "svelte-check": "^3.6.3", 69 | "ts-node": "^10.9.2", 70 | "tslib": "^2.6.2", 71 | "typescript": "^5.3.3", 72 | "unplugin-icons": "^0.18.5", 73 | "vite": "^5.0.12" 74 | } 75 | } 76 | -------------------------------------------------------------------------------- /src/main/index.ts: -------------------------------------------------------------------------------- 1 | import { registerChannelHandlers } from '$main/lib/bridge.js'; 2 | import { initDatabase } from '$main/lib/database.js'; 3 | import { server } from '$main/lib/server.js'; 4 | import { electronApp, is, optimizer } from '@electron-toolkit/utils'; 5 | import { BrowserWindow, app, shell } from 'electron'; 6 | import { join } from 'path'; 7 | import icon from '../../resources/icon.png?asset'; 8 | 9 | function createWindow(): void { 10 | // Create the browser window. 11 | const mainWindow = new BrowserWindow({ 12 | width: 1100, 13 | height: 800, 14 | show: false, 15 | autoHideMenuBar: false, 16 | title: 'Kaiware', 17 | ...(process.platform === 'linux' ? { icon } : {}), 18 | webPreferences: { 19 | preload: join(__dirname, '../preload/preload.mjs'), 20 | sandbox: false 21 | }, 22 | titleBarStyle: 'hidden', 23 | acceptFirstMouse: true 24 | }); 25 | 26 | mainWindow.show; 27 | 28 | mainWindow.on('ready-to-show', () => { 29 | mainWindow.show(); 30 | }); 31 | 32 | mainWindow.webContents.setWindowOpenHandler((details) => { 33 | shell.openExternal(details.url); 34 | return { action: 'deny' }; 35 | }); 36 | 37 | // HMR for renderer base on electron-vite cli. 38 | // Load the remote URL for development or the local html file for production. 39 | if (is.dev && process.env['ELECTRON_RENDERER_URL']) { 40 | mainWindow.loadURL(process.env['ELECTRON_RENDERER_URL']); 41 | } else { 42 | mainWindow.loadFile(join(__dirname, '../renderer/index.html')); 43 | } 44 | } 45 | 46 | // This method will be called when Electron has finished 47 | // initialization and is ready to create browser windows. 48 | // Some APIs can only be used after this event occurs. 49 | app.whenReady().then(() => { 50 | initDatabase(); 51 | server.startServer(); 52 | 53 | // Set app user model id for windows 54 | electronApp.setAppUserModelId('com.electron'); 55 | 56 | // Default open or close DevTools by F12 in development 57 | // and ignore CommandOrControl + R in production. 58 | // see https://github.com/alex8088/electron-toolkit/tree/master/packages/utils 59 | app.on('browser-window-created', (_, window) => { 60 | optimizer.watchWindowShortcuts(window); 61 | }); 62 | 63 | // IPC handlers 64 | registerChannelHandlers(); 65 | 66 | createWindow(); 67 | 68 | app.on('activate', function () { 69 | // On macOS it's common to re-create a window in the app when the 70 | // dock icon is clicked and there are no other windows open. 71 | if (BrowserWindow.getAllWindows().length === 0) createWindow(); 72 | }); 73 | }); 74 | 75 | // Quit when all windows are closed, except on macOS. There, it's common 76 | // for applications and their menu bar to stay active until the user quits 77 | // explicitly with Cmd + Q. 78 | app.on('window-all-closed', () => { 79 | if (process.platform !== 'darwin') { 80 | app.quit(); 81 | } 82 | }); 83 | 84 | // In this file you can include the rest of your app"s specific main process 85 | // code. You can also put them in separate files and require them here. 86 | -------------------------------------------------------------------------------- /src/renderer/src/lib/components/Sidebar.svelte: -------------------------------------------------------------------------------- 1 | 5 | 6 |
7 |
8 | 9 |
Kaiware
10 |
11 |
12 |
13 | Dashboard 14 | 15 |
Dev Tools
16 | Logs 17 | 23 | Elements 24 | 25 | 26 | Network 27 | 28 | 34 | Storage 35 | 36 | 42 | Console 43 | 44 | 45 |
Apps
46 | App Store 47 | 48 | 49 |
Misc
50 | Settings 51 |
52 |
53 | 54 | 116 | -------------------------------------------------------------------------------- /src/renderer/src/lib/ui-components/Scroller.svelte: -------------------------------------------------------------------------------- 1 | 37 | 38 |
47 |
handleScroll(ev.target)}> 48 | 49 |
50 |
51 | 52 | 115 | -------------------------------------------------------------------------------- /src/preload/preload.ts: -------------------------------------------------------------------------------- 1 | import { Channel } from '$shared/enums/channel.js'; 2 | import type { DeviceStorage } from '$shared/types/DeviceStorage.js'; 3 | import { electronAPI } from '@electron-toolkit/preload'; 4 | import type { 5 | ConsoleCommandResPayload, 6 | GetDeviceInfoResPayload, 7 | GetElementDataResPayload, 8 | GetElementStylesResPayload, 9 | Log, 10 | NetworkRequest 11 | } from '@nothing-special/kaiware-lib/types'; 12 | import { contextBridge, ipcRenderer } from 'electron'; 13 | 14 | export const api = { 15 | // Methods 16 | async getLogs(): Promise { 17 | return ipcRenderer.invoke(Channel.GetLogs); 18 | }, 19 | clearLogs(): Promise { 20 | return ipcRenderer.invoke(Channel.ClearLogs); 21 | }, 22 | async getDeviceInfo(): Promise { 23 | return ipcRenderer.invoke(Channel.GetDeviceInfo); 24 | }, 25 | async getElements(): Promise { 26 | return ipcRenderer.invoke(Channel.GetElements); 27 | }, 28 | async getElementStyles(index: number): Promise { 29 | return ipcRenderer.invoke(Channel.GetElementStyles, index); 30 | }, 31 | async setElementStyles(index: number, styles: { [key: string]: string }): Promise { 32 | return ipcRenderer.invoke(Channel.SetElementStyles, index, styles); 33 | }, 34 | async getElementData(index: number): Promise { 35 | return ipcRenderer.invoke(Channel.GetElementData, index); 36 | }, 37 | async setElementData(index: number, data: { [key: string]: unknown }): Promise { 38 | return ipcRenderer.invoke(Channel.SetElementData, index, data); 39 | }, 40 | async getStorage(storageType: 'local' | 'session'): Promise { 41 | return ipcRenderer.invoke(Channel.GetStorage, storageType); 42 | }, 43 | async getNetworkRequests(): Promise { 44 | return ipcRenderer.invoke(Channel.GetNetworkRequests); 45 | }, 46 | async clearNetworkRequests(): Promise { 47 | return ipcRenderer.invoke(Channel.ClearNetworkRequests); 48 | }, 49 | async getNetworkRequestById(id: number): Promise { 50 | return ipcRenderer.invoke(Channel.GetNetworkRequestById, id); 51 | }, 52 | async executeConsoleCommand( 53 | command: string, 54 | parseDepth = 0 55 | ): Promise { 56 | return ipcRenderer.invoke(Channel.ExecuteConsoleCommand, command, parseDepth); 57 | }, 58 | 59 | // Events 60 | onNewLog(callback: (log: Log) => void) { 61 | ipcRenderer.on(Channel.NewLog, (_, log) => callback(log)); 62 | }, 63 | onClearLogs(callback: () => void) { 64 | ipcRenderer.on(Channel.ClearLogs, callback); 65 | }, 66 | onDeviceInfoChange(callback: (device: GetDeviceInfoResPayload | null) => void) { 67 | ipcRenderer.on(Channel.RefreshDeviceInfo, (_, device) => callback(device)); 68 | }, 69 | onNetworkRequestUpdate(callback: (request: NetworkRequest) => void) { 70 | ipcRenderer.on(Channel.NetworkRequestUpdate, (_, request) => callback(request)); 71 | } 72 | }; 73 | 74 | // Use `contextBridge` APIs to expose Electron APIs to 75 | // renderer only if context isolation is enabled, otherwise 76 | // just add to the DOM global. 77 | if (process.contextIsolated) { 78 | try { 79 | contextBridge.exposeInMainWorld('api', api); 80 | contextBridge.exposeInMainWorld('electron', electronAPI); 81 | } catch (error) { 82 | console.error(error); 83 | } 84 | } else { 85 | // eslint-disable-next-line @typescript-eslint/no-explicit-any 86 | (window as any).electron = electronAPI; 87 | // eslint-disable-next-line @typescript-eslint/no-explicit-any 88 | (window as any).api = api; 89 | } 90 | -------------------------------------------------------------------------------- /src/renderer/src/lib/stores/appStore.ts: -------------------------------------------------------------------------------- 1 | import { Storage } from '$lib/utils/storage'; 2 | import type { StoreApp } from '$shared/types/StoreApp'; 3 | import type { StoreCategory } from '$shared/types/StoreCategory'; 4 | import { get, writable } from 'svelte/store'; 5 | 6 | type StoreDb = { 7 | categories: StoreCategory[]; 8 | apps: StoreApp[]; 9 | fetchedAt: number; 10 | generatedAt: number; 11 | }; 12 | 13 | function createStore() { 14 | const store = writable(null); 15 | 16 | async function load() { 17 | const result = await fetchStoreData(); 18 | store.set(result); 19 | } 20 | 21 | async function fetchStoreData(forceRefresh = false): Promise { 22 | const cachedStoreData = Storage.local.get('store-db'); 23 | 24 | if ( 25 | cachedStoreData && 26 | !forceRefresh && 27 | new Date().valueOf() - cachedStoreData.fetchedAt < 1_800_000 28 | ) { 29 | return cachedStoreData; 30 | } 31 | 32 | const data = await fetch('https://banana-hackers.gitlab.io/store-db/data.json') 33 | .then((res) => res.json()) 34 | .then((res) => { 35 | // eslint-disable-next-line @typescript-eslint/no-explicit-any 36 | res.apps = res.apps.map((a: any) => { 37 | const people = [ 38 | ...a.author.map((person: string) => { 39 | const emailMatch = person.match(/(.*)[ ]?<(.*@.*)>/); 40 | const urlMatch = person.match(/(.*)[ ]?<(http.*)>/); 41 | return { 42 | name: emailMatch?.[1] || urlMatch?.[1] || person, 43 | email: emailMatch?.[2] || undefined, 44 | website: urlMatch?.[2] || undefined, 45 | role: 'author' 46 | }; 47 | }), 48 | ...a.maintainer.map((person: string) => { 49 | const emailMatch = person.match(/(.*)[ ]?<(.*@.*)>/); 50 | const urlMatch = person.match(/(.*)[ ]?<(http.*)>/); 51 | return { 52 | name: emailMatch?.[1] || urlMatch?.[1] || person, 53 | email: emailMatch?.[2] || undefined, 54 | website: urlMatch?.[2] || undefined, 55 | role: 'maintainer' 56 | }; 57 | }) 58 | ]; 59 | 60 | return { 61 | ...a, 62 | people 63 | }; 64 | }); 65 | 66 | return res; 67 | }); 68 | const categories: StoreCategory[] = Object.keys(data.categories).map((key) => ({ 69 | ...(data.categories as unknown as { [key: string]: Omit })[key], 70 | id: key 71 | })); 72 | const storeData = { 73 | categories, 74 | apps: data.apps, 75 | fetchedAt: new Date().valueOf(), 76 | generatedAt: data.generated_at 77 | }; 78 | 79 | Storage.local.set('store-db', storeData); 80 | return storeData; 81 | } 82 | 83 | async function getAppBySlug(slug: string): Promise { 84 | const data = get(store); 85 | if (!data) { 86 | await load(); 87 | } 88 | 89 | const app = data?.apps.find((a) => a.slug === slug); 90 | return app || null; 91 | } 92 | 93 | async function fetchAppVersion(manifestUrl: string): Promise { 94 | const res = await fetch(manifestUrl) 95 | .then((res) => res.json() as { version?: string }) 96 | .catch((err) => { 97 | console.log('Failed to get app version', err); 98 | return null; 99 | }); 100 | 101 | return res?.version || ''; 102 | } 103 | 104 | function reset() { 105 | store.set(null); 106 | } 107 | 108 | return { 109 | subscribe: store.subscribe, 110 | set: store.set, 111 | reset, 112 | load, 113 | getAppBySlug, 114 | fetchAppVersion 115 | }; 116 | } 117 | 118 | export const appStore = createStore(); 119 | -------------------------------------------------------------------------------- /src/renderer/src/lib/stores/devTools.ts: -------------------------------------------------------------------------------- 1 | import { device } from '$lib/stores/device'; 2 | import type { DeviceStorage } from '$shared/types/DeviceStorage'; 3 | import type { Log, NetworkRequest } from '@nothing-special/kaiware-lib/types'; 4 | 5 | import { writable } from 'svelte/store'; 6 | 7 | export const logs = createLogsStore(); 8 | export const elements = createElementsStore(); 9 | export const localStorage = createLocalStorageStore(); 10 | export const sessionStorage = createSessionStorageStore(); 11 | export const networkRequests = createNetworkRequestsStore(); 12 | 13 | function createLogsStore() { 14 | const { subscribe, set, update } = writable([]); 15 | 16 | async function load(): Promise { 17 | await window.api 18 | .getLogs() 19 | .then((res) => set(res)) 20 | .catch((err) => console.log(err)); 21 | } 22 | 23 | function clear(): void { 24 | set([]); 25 | } 26 | 27 | window.api.onNewLog((log) => { 28 | update((previous) => [log, ...previous]); 29 | }); 30 | 31 | window.api.onClearLogs(() => { 32 | clear(); 33 | }); 34 | 35 | return { 36 | subscribe, 37 | set, 38 | load, 39 | clear 40 | }; 41 | } 42 | 43 | function createLocalStorageStore() { 44 | const { subscribe, set } = writable(null); 45 | 46 | device.subscribe((device) => { 47 | if (device === null) set(null); 48 | }); 49 | 50 | async function refresh(): Promise { 51 | await window.api 52 | .getStorage('local') 53 | .then((res) => set(res)) 54 | .catch((err) => console.log(err)); 55 | } 56 | 57 | // TODO: Add methods to update storage 58 | 59 | return { 60 | subscribe, 61 | set, 62 | refresh 63 | }; 64 | } 65 | function createSessionStorageStore() { 66 | const { subscribe, set } = writable(null); 67 | 68 | device.subscribe((device) => { 69 | if (device === null) set(null); 70 | }); 71 | 72 | async function refresh(): Promise { 73 | await window.api 74 | .getStorage('session') 75 | .then((res) => set(res)) 76 | .catch((err) => console.log(err)); 77 | } 78 | 79 | // TODO: Add methods to update storage 80 | 81 | return { 82 | subscribe, 83 | set, 84 | refresh 85 | }; 86 | } 87 | 88 | function createElementsStore() { 89 | const { subscribe, set } = writable(''); 90 | 91 | device.subscribe((device) => { 92 | if (device === null) set(''); 93 | }); 94 | 95 | async function refresh(): Promise { 96 | await window.api 97 | .getElements() 98 | .then((res) => set(res)) 99 | .catch((err) => console.log(err)); 100 | } 101 | 102 | function clear(): void { 103 | set(''); 104 | } 105 | 106 | return { 107 | subscribe, 108 | set, 109 | refresh, 110 | clear 111 | }; 112 | } 113 | 114 | function createNetworkRequestsStore() { 115 | const { subscribe, set, update } = writable([]); 116 | 117 | async function load(): Promise { 118 | await window.api 119 | .getNetworkRequests() 120 | .then((res) => set(res)) 121 | .catch((err) => console.log(err)); 122 | } 123 | 124 | async function clear(): Promise { 125 | await window.api.clearNetworkRequests(); 126 | set([]); 127 | } 128 | 129 | window.api.onNetworkRequestUpdate((request) => { 130 | update((previous) => { 131 | const index = previous.findIndex((a) => a.requestId === request.requestId); 132 | if (index === -1) return [request, ...previous]; 133 | previous[index] = request; 134 | return [...previous]; 135 | }); 136 | }); 137 | 138 | return { 139 | subscribe, 140 | set, 141 | load, 142 | clear 143 | }; 144 | } 145 | -------------------------------------------------------------------------------- /src/renderer/src/routes/AppStore.svelte: -------------------------------------------------------------------------------- 1 | 53 | 54 | 55 | 56 |
57 | 66 |
67 | 68 | 69 | 70 |
71 | {#each apps as app (app.slug)} 72 |
73 |
74 |
75 | {app.name} 82 |
83 |
84 |
{app.name}
85 |
{app.people[0]?.name}
86 |
87 |
88 |
89 | {app.description.length > 300 90 | ? `${app.description.slice(0, 300)}...` 91 | : app.description} 92 |
93 |
94 | {/each} 95 |
96 | 97 | 98 | 99 | 152 | -------------------------------------------------------------------------------- /src/main/lib/bridge.ts: -------------------------------------------------------------------------------- 1 | import { database } from '$main/lib/database.js'; 2 | import { server } from '$main/lib/server'; 3 | import { Channel } from '$shared/enums/channel.js'; 4 | import { formatCode } from '$shared/utils/formatCode.js'; 5 | import { MessageType } from '@nothing-special/kaiware-lib/enums'; 6 | import { 7 | ConsoleCommandResPayload, 8 | DeviceInfo, 9 | GetElementDataResPayload, 10 | GetElementStylesResPayload, 11 | GetElementsResPayload, 12 | GetLogResPayload, 13 | GetStorageResPayload, 14 | NetworkRequest 15 | } from '@nothing-special/kaiware-lib/types'; 16 | import { BrowserWindow, ipcMain } from 'electron'; 17 | 18 | export function registerChannelHandlers() { 19 | ipcMain.handle(Channel.GetLogs, database.logs.getLogs); 20 | ipcMain.handle(Channel.ClearLogs, database.logs.clear); 21 | 22 | ipcMain.handle(Channel.GetDeviceInfo, () => 23 | server.sendRequest({ 24 | type: MessageType.GetDeviceInfo, 25 | data: null 26 | }) 27 | ); 28 | 29 | ipcMain.handle(Channel.GetElements, async () => { 30 | const response = await server.sendRequest({ 31 | type: MessageType.GetElements, 32 | data: null 33 | }); 34 | 35 | return formatCode(response, 'html'); 36 | }); 37 | 38 | ipcMain.handle(Channel.GetElementStyles, (_, index: number) => 39 | server.sendRequest({ 40 | type: MessageType.GetElementStyles, 41 | data: { index } 42 | }) 43 | ); 44 | 45 | ipcMain.handle( 46 | Channel.SetElementStyles, 47 | (_, index: number, styles: { [key: string]: string }) => 48 | server.sendRequest({ 49 | type: MessageType.SetElementStyles, 50 | data: { index, styles } 51 | }) 52 | ); 53 | 54 | ipcMain.handle(Channel.GetElementData, (_, index: number) => 55 | server.sendRequest({ 56 | type: MessageType.GetElementData, 57 | data: { index } 58 | }) 59 | ); 60 | 61 | ipcMain.handle(Channel.SetElementData, (_, index: number, data: { [key: string]: unknown }) => 62 | server.sendRequest({ 63 | type: MessageType.SetElementData, 64 | data: { index, data } 65 | }) 66 | ); 67 | 68 | ipcMain.handle(Channel.GetStorage, (_, storageType: 'local' | 'session') => 69 | server.sendRequest({ 70 | type: MessageType.GetStorage, 71 | data: { storageType } 72 | }) 73 | ); 74 | 75 | ipcMain.handle(Channel.GetNetworkRequests, database.networkRequests.getRequests); 76 | ipcMain.handle(Channel.ClearNetworkRequests, database.networkRequests.clear); 77 | ipcMain.handle(Channel.GetNetworkRequestById, (_, id: number) => 78 | database.networkRequests.getRequestById(id) 79 | ); 80 | 81 | ipcMain.handle(Channel.ExecuteConsoleCommand, (_, command: string, parseDepth = 0) => 82 | server.sendRequest({ 83 | type: MessageType.ExecuteConsoleCommand, 84 | data: { command, parseDepth } 85 | }) 86 | ); 87 | } 88 | 89 | // Listen for new logs 90 | server.onReceiveMessage(MessageType.NewLog, async (message) => { 91 | const createdLog = await database.logs.addLog(message.data as GetLogResPayload); 92 | BrowserWindow.getAllWindows()[0]?.webContents.send(Channel.NewLog, createdLog); 93 | }); 94 | 95 | // Listen for clear logs 96 | server.onReceiveMessage(MessageType.ClearLogs, async () => { 97 | await database.logs.clear(); 98 | BrowserWindow.getAllWindows()[0]?.webContents.send(Channel.ClearLogs); 99 | }); 100 | 101 | // Listen for network requests 102 | server.onReceiveMessage(MessageType.NetworkRequestUpdate, async (message) => { 103 | const createdRequest = await database.networkRequests.updateRequest( 104 | message.data as NetworkRequest 105 | ); 106 | BrowserWindow.getAllWindows()[0]?.webContents.send( 107 | Channel.NetworkRequestUpdate, 108 | createdRequest 109 | ); 110 | }); 111 | 112 | export const Browser = { 113 | updateDeviceInfo(device: DeviceInfo | null) { 114 | BrowserWindow.getAllWindows()[0]?.webContents.send(Channel.RefreshDeviceInfo, device); 115 | } 116 | }; 117 | -------------------------------------------------------------------------------- /src/main/lib/server.ts: -------------------------------------------------------------------------------- 1 | import { Browser } from '$main/lib/bridge'; 2 | import { MessageType } from '@nothing-special/kaiware-lib/enums'; 3 | import { 4 | GetDeviceInfoResPayload, 5 | Message, 6 | MessageWithId, 7 | rawMessageSchema 8 | } from '@nothing-special/kaiware-lib/types'; 9 | import { isJson } from '@nothing-special/kaiware-lib/utils'; 10 | import { createServer } from 'http'; 11 | import { RawData, WebSocket, WebSocketServer } from 'ws'; 12 | 13 | export const server = { 14 | startServer: () => httpServer.listen(3000), 15 | stopServer: () => { 16 | httpServer.closeAllConnections(); 17 | Browser.updateDeviceInfo(null); 18 | }, 19 | sendRequest, 20 | onReceiveMessage( 21 | messageType: MessageType, 22 | callback: (message: MessageWithId) => Promise 23 | ) { 24 | // eslint-disable-next-line @typescript-eslint/no-explicit-any 25 | listeners.set(messageType, callback as any); 26 | } 27 | }; 28 | 29 | const listeners = new Map Promise>(); 30 | 31 | const socketServer = { 32 | server: new WebSocketServer({ noServer: true }), 33 | hasActiveConnection(): boolean { 34 | return this.server.clients.size > 0; 35 | }, 36 | getActiveSocket(): ExtendedWebSocket | undefined { 37 | return this.server.clients.values().next()?.value; 38 | } 39 | }; 40 | 41 | const httpServer = createServer(); 42 | httpServer.on('upgrade', async (request, socket, head) => { 43 | // Only allow one connection at a time 44 | if (socketServer.hasActiveConnection()) { 45 | socket.write('HTTP/1.1 401 Unauthorized\r\n\r\n'); 46 | socket.destroy(); 47 | return; 48 | } 49 | 50 | socketServer.server.handleUpgrade(request, socket, head, (ws) => { 51 | socketServer.server.emit('connection', ws, request); 52 | }); 53 | }); 54 | 55 | socketServer.server.on('connection', async (ws: WebSocket) => { 56 | console.log('Device connected'); 57 | 58 | const socket = ws as ExtendedWebSocket; 59 | socket.device = { 60 | id: 'unknown-device', 61 | name: 'Unknown Device' 62 | }; 63 | 64 | Browser.updateDeviceInfo({ 65 | ...socket.device, 66 | connectionType: 'wifi' 67 | }); 68 | 69 | // Get real device info 70 | server 71 | .sendRequest({ 72 | type: MessageType.GetDeviceInfo, 73 | data: null 74 | }) 75 | .then((info) => { 76 | Browser.updateDeviceInfo({ 77 | ...info, 78 | connectionType: 'wifi' 79 | }); 80 | }) 81 | .catch((err) => { 82 | console.error('Failed to get device info:', err); 83 | }); 84 | 85 | socket.on('error', (err) => { 86 | console.error('Device error:', err); 87 | }); 88 | 89 | socket.on('close', () => { 90 | console.log('Device disconnected'); 91 | server.stopServer(); 92 | Browser.updateDeviceInfo(null); 93 | }); 94 | 95 | // Handle incoming messages that we didn't request 96 | socket.on('message', async (rawMessage: RawData) => { 97 | const messageType = isJson(rawMessage.toString()) 98 | ? (JSON.parse(rawMessage.toString()).type as MessageType) 99 | : null; 100 | 101 | if (!messageType) return; 102 | 103 | const listener = listeners.get(messageType); 104 | if (listener) { 105 | try { 106 | const message = validateMessage(rawMessage); 107 | await listener(message); 108 | } catch (err) { 109 | console.log('Listener encountered an error:', err); 110 | } 111 | } 112 | }); 113 | }); 114 | 115 | function validateMessage(rawMessage: RawData): MessageWithId { 116 | const message = rawMessageSchema.safeParse(rawMessage.toString()); 117 | if (!message.success) { 118 | console.error('Invalid message:', { 119 | name: 'ValidationError', 120 | input: rawMessage.toString(), 121 | errors: message.error.issues.map( 122 | // eslint-disable-next-line @typescript-eslint/no-explicit-any 123 | (issue: any) => `${issue.path.join('.')}: ${issue.message}` 124 | ) 125 | }); 126 | throw new Error('Invalid message'); 127 | } 128 | 129 | return message.data as MessageWithId; 130 | } 131 | 132 | // TODO: Infer TRequest and TResponse from the message type 133 | // TODO: Better solution than caller passsing in the response message type 134 | async function sendRequest(message: Message): Promise { 135 | const socket = socketServer.getActiveSocket(); 136 | if (!socket) { 137 | throw new Error('No device connected'); 138 | } 139 | 140 | return new Promise((resolve) => { 141 | const requestId = crypto.randomUUID(); 142 | 143 | socket.send(JSON.stringify({ requestId, type: message.type, data: message.data })); 144 | 145 | const listener = (rawMessage: RawData) => { 146 | const response = validateMessage(rawMessage); 147 | 148 | if (response.requestId === requestId) { 149 | resolve(response.data as TResponse); 150 | socket.off('message', listener); 151 | } 152 | }; 153 | 154 | socket.on('message', listener); 155 | }); 156 | } 157 | 158 | type ExtendedWebSocket = WebSocket & { 159 | device: { 160 | id: string; 161 | name: string; 162 | }; 163 | }; 164 | -------------------------------------------------------------------------------- /src/main/lib/database.ts: -------------------------------------------------------------------------------- 1 | import { LogLevel } from '@nothing-special/kaiware-lib/enums'; 2 | import type { Log, NetworkRequest } from '@nothing-special/kaiware-lib/types'; 3 | import { isJson } from '@nothing-special/kaiware-lib/utils'; 4 | import knex from 'knex'; 5 | 6 | export async function initDatabase() { 7 | await db.migrate.latest(); 8 | 9 | const existingLogs = (await db('logs').count({ count: '*' })).at(0); 10 | if (existingLogs?.count !== 0) return; 11 | 12 | const logs: Omit[] = Array.from({ length: 1 }, (_, i) => ({ 13 | source: 'my-app', 14 | level: i % 3 === 0 ? LogLevel.Error : i % 3 === 1 ? LogLevel.Warn : LogLevel.Info, 15 | data: JSON.stringify([ 16 | { 17 | name: 'Error', 18 | message: 'some not so bad error happend', 19 | stack: `Error: some not so bad error happend\n at :1:16` 20 | } 21 | ]), 22 | timestamp: new Date().toISOString() 23 | })); 24 | 25 | await db('logs').insert(logs); 26 | } 27 | 28 | const db = knex({ 29 | client: 'sqlite3', 30 | connection: { 31 | filename: 'db-test.sqlite' 32 | }, 33 | useNullAsDefault: true, 34 | migrations: { 35 | directory: './src/main/migrations' 36 | }, 37 | debug: false 38 | }); 39 | 40 | export const database = { 41 | logs: { 42 | getLogs: async (): Promise => { 43 | const logs = await db('logs').select('*').orderBy('timestamp', 'desc'); 44 | 45 | return logs.map(mappers.logEntityToLog); 46 | }, 47 | addLog: async (log: Omit): Promise => { 48 | const newLog = ( 49 | await db('logs').insert(mappers.logToLogEntity(log), '*') 50 | ).at(0) as LogEntity; 51 | 52 | return mappers.logEntityToLog(newLog); 53 | }, 54 | clear: async () => { 55 | await db('logs').delete(); 56 | } 57 | }, 58 | networkRequests: { 59 | getRequests: async ( 60 | _: Electron.IpcMainInvokeEvent, 61 | returnFullObject = false 62 | ): Promise => { 63 | const requests = await db('network_requests') 64 | .select(returnFullObject ? '*' : '*') // TODO: Implement returnFullObject 65 | .orderBy('startTime', 'desc'); 66 | 67 | return requests.map(mappers.networkRequestEntityToNetworkRequest); 68 | }, 69 | getRequestById: async (id: number): Promise => { 70 | const request = await db('network_requests') 71 | .where('id', id) 72 | .first(); 73 | 74 | return request ? mappers.networkRequestEntityToNetworkRequest(request) : null; 75 | }, 76 | updateRequest: async (requestData: NetworkRequest): Promise => { 77 | const mappedRequest = mappers.networkRequestToNetworkRequestEntity(requestData); 78 | const existingRequest = (await db('network_requests')).find( 79 | (a) => a.requestId === requestData.requestId 80 | ); 81 | 82 | const startTime = mappedRequest.startTime ?? existingRequest?.startTime; 83 | const endTime = mappedRequest.endTime ?? existingRequest?.endTime; 84 | if (startTime && endTime) { 85 | mappedRequest.duration = endTime - startTime; 86 | } 87 | 88 | let response: NetworkRequestEntity; 89 | 90 | if (existingRequest) { 91 | response = ( 92 | await db('network_requests') 93 | .where('id', existingRequest.id) 94 | .update(mappedRequest, '*') 95 | ).at(0) as NetworkRequestEntity; 96 | } else { 97 | response = ( 98 | await db('network_requests').insert(mappedRequest, '*') 99 | ).at(0) as NetworkRequestEntity; 100 | } 101 | 102 | return mappers.networkRequestEntityToNetworkRequest(response); 103 | }, 104 | clear: async () => { 105 | await db('network_requests').delete(); 106 | } 107 | } 108 | }; 109 | 110 | const mappers = { 111 | logEntityToLog: (log: LogEntity): Log => { 112 | const data: string[] = JSON.parse(log.data).map((a: string) => 113 | isJson(a) ? JSON.parse(a) : a 114 | ); 115 | 116 | return { ...log, data }; 117 | }, 118 | logToLogEntity: (log: Omit): Omit => { 119 | const data = JSON.stringify(log.data); 120 | 121 | return { ...log, data }; 122 | }, 123 | networkRequestEntityToNetworkRequest: (request: NetworkRequestEntity): NetworkRequest => { 124 | return { 125 | ...request, 126 | headers: request.headers ? JSON.parse(request.headers) : [], 127 | responseHeaders: request.responseHeaders ? JSON.parse(request.responseHeaders) : [] 128 | }; 129 | }, 130 | networkRequestToNetworkRequestEntity: ( 131 | request: NetworkRequest 132 | ): Omit => { 133 | return { 134 | ...request, 135 | headers: JSON.stringify(request.headers ?? []), 136 | responseHeaders: JSON.stringify(request.responseHeaders ?? []) 137 | }; 138 | } 139 | }; 140 | 141 | type LogEntity = Omit & { data: string }; 142 | type NetworkRequestEntity = Omit & { 143 | id: number; 144 | headers: string; 145 | responseHeaders: string; 146 | }; 147 | -------------------------------------------------------------------------------- /src/renderer/src/lib/stores/settings.ts: -------------------------------------------------------------------------------- 1 | import { themes } from '$lib/themes'; 2 | import { Storage } from '$lib/utils/storage'; 3 | import { Animations } from '$shared/enums/animations'; 4 | import { Density } from '$shared/enums/density'; 5 | import { TextSize } from '$shared/enums/textSize'; 6 | import type { Settings } from '$shared/types/Settings'; 7 | import { writable } from 'svelte/store'; 8 | 9 | function createStore() { 10 | const { subscribe, set, update } = writable(load()); 11 | 12 | // Save settings to storage whenever they change 13 | subscribe((val) => { 14 | Storage.local.set('settings', val); 15 | }); 16 | 17 | function load(): Settings { 18 | const defaultSettings: Settings = { 19 | textSize: TextSize.Small, 20 | displayDensity: Density.Normal, 21 | borderRadius: 12, 22 | animationSpeed: Animations.Normal, 23 | toasterLocation: 'bottom', 24 | toasterDuration: 3000, 25 | showHelpText: true, 26 | themeId: themes[0].id 27 | }; 28 | const existingSettings = Storage.local.get('settings') ?? {}; 29 | 30 | const initialSettings = { 31 | ...defaultSettings, 32 | ...existingSettings 33 | }; 34 | 35 | applySettings(initialSettings); 36 | 37 | return initialSettings; 38 | } 39 | 40 | function applySettings(settings: Partial): void { 41 | // Text Size 42 | if (settings.textSize) { 43 | const textSize = { 44 | [TextSize.Smallest]: 8, 45 | [TextSize.Small]: 9, 46 | [TextSize.Medium]: 10, 47 | [TextSize.Large]: 11, 48 | [TextSize.Largest]: 12 49 | }; 50 | document.documentElement.style.setProperty( 51 | '--base-font-size', 52 | `${textSize[settings.textSize]}px` 53 | ); 54 | } 55 | 56 | // Display Density 57 | if (settings.displayDensity) { 58 | document.body.dataset.density = settings.displayDensity; 59 | } 60 | 61 | // Border Radius 62 | if (settings.borderRadius) { 63 | document.documentElement.style.setProperty('--radius', `${settings.borderRadius}px`); 64 | } 65 | 66 | // Animations 67 | if (settings.animationSpeed) { 68 | document.documentElement.style.setProperty( 69 | '--animation-speed', 70 | `${settings.animationSpeed}ms` 71 | ); 72 | } 73 | 74 | // Theme 75 | if (settings.themeId) { 76 | const theme = themes.find((t) => t.id === settings.themeId)?.values; 77 | if (!theme) return; 78 | 79 | document.documentElement.style.setProperty( 80 | '--main-background-color', 81 | `hsla(${theme.mainBackgroundColorH}, ${theme.mainBackgroundColorS}%, ${theme.mainBackgroundColorL}%, ${theme.mainBackgroundColorA}%)` 82 | ); 83 | 84 | document.documentElement.style.setProperty( 85 | '--panel-background-color', 86 | `hsla(${theme.panelBackgroundColorH}, ${theme.panelBackgroundColorS}%, ${theme.panelBackgroundColorL}%, ${theme.panelBackgroundColorA}%)` 87 | ); 88 | 89 | document.documentElement.style.setProperty( 90 | '--panel-border-color', 91 | `hsla(${theme.panelBackgroundColorH}, ${theme.panelBackgroundColorS}%, ${theme.panelBackgroundColorL * 1.2}%, ${theme.panelBackgroundColorA}%)` 92 | ); 93 | 94 | document.documentElement.style.setProperty( 95 | '--accent-color', 96 | `hsla(${theme.accentColorH}, ${theme.accentColorS}%, ${theme.accentColorL}%, ${theme.accentColorA}%)` 97 | ); 98 | 99 | document.documentElement.style.setProperty( 100 | '--error-color', 101 | `hsla(${theme.errorColorH}, ${theme.errorColorS}%, ${theme.errorColorL}%, ${theme.errorColorA}%)` 102 | ); 103 | 104 | document.documentElement.style.setProperty( 105 | '--warning-color', 106 | `hsla(${theme.warningColorH}, ${theme.warningColorS}%, ${theme.warningColorL}%, ${theme.warningColorA}%)` 107 | ); 108 | 109 | document.documentElement.style.setProperty( 110 | '--success-color', 111 | `hsla(${theme.successColorH}, ${theme.successColorS}%, ${theme.successColorL}%, ${theme.successColorA}%)` 112 | ); 113 | 114 | document.documentElement.style.setProperty( 115 | '--divider-color', 116 | `hsla(${theme.dividerColorH}, ${theme.dividerColorS}%, ${theme.dividerColorL}%, ${theme.dividerColorA}%)` 117 | ); 118 | 119 | document.documentElement.style.setProperty( 120 | '--primary-text-color', 121 | `hsla(${theme.primaryTextColorH}, ${theme.primaryTextColorS}%, ${theme.primaryTextColorL}%, ${theme.primaryTextColorA}%)` 122 | ); 123 | 124 | document.documentElement.style.setProperty( 125 | '--secondary-text-color', 126 | `hsla(${theme.secondaryTextColorH}, ${theme.secondaryTextColorS}%, ${theme.secondaryTextColorL}%, ${theme.secondaryTextColorA}%)` 127 | ); 128 | 129 | document.documentElement.style.setProperty( 130 | '--tertiary-text-color', 131 | `hsla(${theme.tertiaryTextColorH}, ${theme.tertiaryTextColorS}%, ${theme.tertiaryTextColorL}%, ${theme.tertiaryTextColorA}%)` 132 | ); 133 | } 134 | } 135 | 136 | function updateSettings(data: Partial) { 137 | update((previous) => ({ ...previous, ...data })); 138 | applySettings(data); 139 | } 140 | 141 | return { 142 | subscribe, 143 | set, 144 | update: updateSettings, 145 | updateOne: function (key: T, value: Settings[T]) { 146 | updateSettings({ [key]: value }); 147 | } 148 | }; 149 | } 150 | 151 | export const settings = createStore(); 152 | -------------------------------------------------------------------------------- /src/renderer/src/routes/Elements.svelte: -------------------------------------------------------------------------------- 1 | 85 | 86 |
87 |
88 | 89 | {@html htmlContent} 90 |
91 | {#if elementStyles} 92 |
93 |
94 |
Computed Styles
95 | 96 |
97 | 98 |
99 | {#each Object.entries(elementStyles).filter( (a) => (styleQuery ? a[0].includes(styleQuery) : true) ) as style (style[0])} 100 |
101 |
{`${style[0]}:`}
102 | updateStyle(ev, style[0])} 105 | /> 106 |
107 | {/each} 108 |
109 |
110 | {/if} 111 |
112 | 113 | 179 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------