Compare commits
69 Commits
e8e473b357
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
| 88326c4992 | |||
| 4e2bc5b8dc | |||
| 9da3df6ad7 | |||
| 9d8a38a4c4 | |||
| cd7448c3b3 | |||
| 58d7a453b6 | |||
| afc3b66efa | |||
| 3c97e9c3eb | |||
| 58620b4d4b | |||
| 04b8dedb3e | |||
| 02bdfffe79 | |||
| 0cd8b57d24 | |||
| 0438b52c93 | |||
| fd9478d64e | |||
| 73614204f7 | |||
| 61e7a1b621 | |||
| 5ccde0a121 | |||
| 0553347bfe | |||
| 52af81b079 | |||
| 527c1d1020 | |||
| 4ed961760a | |||
| c54b7d27a6 | |||
| d478b94c13 | |||
| 908b369732 | |||
| 51724a7936 | |||
| 93a2519012 | |||
| 5edab0ba1d | |||
| a451e08209 | |||
| e76a03d0f4 | |||
| aa1e2c81c6 | |||
| 7e2621ae37 | |||
| 94a9122f34 | |||
| 275c8e4795 | |||
| 8245abe217 | |||
| 627e6f9dd3 | |||
| e59e085217 | |||
| cd9826ded3 | |||
| 2efc57d9ee | |||
| 1f5940438a | |||
| 0bab6372ac | |||
| 5f0c9d33cb | |||
| 73982939a8 | |||
| 10c2d61523 | |||
| 18ce05854a | |||
| 7eccef5d8f | |||
| 41667cb33b | |||
| 00c944e1b5 | |||
| f9edfd0058 | |||
| 9aea89e16d | |||
| 26b74b25f2 | |||
| ccf220fc29 | |||
| a585069cdc | |||
| b149cc5dc0 | |||
| 9f38636d76 | |||
| 63906ec09b | |||
| 8c4e4ad150 | |||
| e171db8196 | |||
| dac6bb1643 | |||
| 8c0ea632d7 | |||
| db23ee42fc | |||
| 0784546e50 | |||
| 2fe3e15659 | |||
| ed02993350 | |||
| e4e5ff2211 | |||
| d69a573a33 | |||
| 6cc1bc6834 | |||
| 894fd17d1a | |||
| 888f20fdab | |||
| 7318600e20 |
5
.vscode/extensions.json
vendored
5
.vscode/extensions.json
vendored
@@ -2,11 +2,8 @@
|
|||||||
"recommendations": [
|
"recommendations": [
|
||||||
"biomejs.biome",
|
"biomejs.biome",
|
||||||
"hverlin.mise-vscode",
|
"hverlin.mise-vscode",
|
||||||
"mikestead.dotenv",
|
|
||||||
"oven.bun-vscode",
|
"oven.bun-vscode",
|
||||||
"redhat.vscode-yaml",
|
"redhat.vscode-yaml",
|
||||||
"rust-lang.rust-analyzer",
|
"tamasfe.even-better-toml"
|
||||||
"tamasfe.even-better-toml",
|
|
||||||
"tauri-apps.tauri-vscode"
|
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
43
.vscode/settings.json
vendored
43
.vscode/settings.json
vendored
@@ -1,49 +1,42 @@
|
|||||||
{
|
{
|
||||||
// Disable the default formatter & linter, use biome instead
|
|
||||||
"prettier.enable": false,
|
|
||||||
"eslint.enable": false,
|
|
||||||
|
|
||||||
// Auto fix
|
|
||||||
"editor.codeActionsOnSave": {
|
|
||||||
"source.fixAll.biome": "explicit",
|
|
||||||
"source.organizeImports.biome": "explicit"
|
|
||||||
},
|
|
||||||
"editor.defaultFormatter": "biomejs.biome",
|
|
||||||
"editor.formatOnSave": true,
|
|
||||||
"[javascript]": {
|
"[javascript]": {
|
||||||
"editor.defaultFormatter": "biomejs.biome"
|
"editor.defaultFormatter": "biomejs.biome"
|
||||||
},
|
},
|
||||||
"[javascriptreact]": {
|
"[javascriptreact]": {
|
||||||
"editor.defaultFormatter": "biomejs.biome"
|
"editor.defaultFormatter": "biomejs.biome"
|
||||||
},
|
},
|
||||||
"[typescript]": {
|
|
||||||
"editor.defaultFormatter": "biomejs.biome"
|
|
||||||
},
|
|
||||||
"[typescriptreact]": {
|
|
||||||
"editor.defaultFormatter": "biomejs.biome"
|
|
||||||
},
|
|
||||||
"[json]": {
|
"[json]": {
|
||||||
"editor.defaultFormatter": "biomejs.biome"
|
"editor.defaultFormatter": "biomejs.biome"
|
||||||
},
|
},
|
||||||
"[jsonc]": {
|
"[jsonc]": {
|
||||||
"editor.defaultFormatter": "biomejs.biome"
|
"editor.defaultFormatter": "biomejs.biome"
|
||||||
},
|
},
|
||||||
"[yaml]": {
|
|
||||||
"editor.defaultFormatter": "redhat.vscode-yaml"
|
|
||||||
},
|
|
||||||
"[toml]": {
|
"[toml]": {
|
||||||
"editor.defaultFormatter": "tamasfe.even-better-toml"
|
"editor.defaultFormatter": "tamasfe.even-better-toml"
|
||||||
},
|
},
|
||||||
|
"[typescript]": {
|
||||||
|
"editor.defaultFormatter": "biomejs.biome"
|
||||||
|
},
|
||||||
|
"[typescriptreact]": {
|
||||||
|
"editor.defaultFormatter": "biomejs.biome"
|
||||||
|
},
|
||||||
|
"[yaml]": {
|
||||||
|
"editor.defaultFormatter": "redhat.vscode-yaml"
|
||||||
|
},
|
||||||
|
"editor.codeActionsOnSave": {
|
||||||
|
"source.fixAll.biome": "explicit",
|
||||||
|
"source.organizeImports.biome": "explicit"
|
||||||
|
},
|
||||||
|
"editor.defaultFormatter": "biomejs.biome",
|
||||||
|
"editor.formatOnSave": true,
|
||||||
"files.associations": {
|
"files.associations": {
|
||||||
".env": "dotenv",
|
".env": "dotenv",
|
||||||
".env.*": "dotenv",
|
".env.*": "dotenv",
|
||||||
"**/tsconfig.json": "jsonc",
|
|
||||||
"**/tsconfig.*.json": "jsonc",
|
|
||||||
"**/biome.json": "jsonc",
|
"**/biome.json": "jsonc",
|
||||||
"**/opencode.json": "jsonc"
|
"**/opencode.json": "jsonc",
|
||||||
|
"**/tsconfig.*.json": "jsonc",
|
||||||
|
"**/tsconfig.json": "jsonc"
|
||||||
},
|
},
|
||||||
|
|
||||||
// TanStack Router
|
|
||||||
"files.readonlyInclude": {
|
"files.readonlyInclude": {
|
||||||
"**/routeTree.gen.ts": true
|
"**/routeTree.gen.ts": true
|
||||||
},
|
},
|
||||||
|
|||||||
109
AGENTS.md
109
AGENTS.md
@@ -4,48 +4,71 @@ Guidelines for AI agents working in this Bun monorepo.
|
|||||||
|
|
||||||
## Project Overview
|
## Project Overview
|
||||||
|
|
||||||
> **This project uses [Bun](https://bun.sh) exclusively as both the JavaScript runtime and package manager. Do NOT use Node.js / npm / yarn / pnpm. All commands start with `bun` — use `bun install` for dependencies and `bun run` / `bun <script>` for scripts. Never use `npm`, `npx`, or `node`.**
|
> **This project uses [Bun](https://bun.sh) exclusively as both the JavaScript runtime and package manager. Do NOT use Node.js / npm / yarn / pnpm. All commands start with `bun` — use `bun install` for dependencies and `bun run <script>` for scripts. Always prefer `bun run <script>` over `bun <script>` to avoid conflicts with Bun built-in subcommands (e.g. `bun build` invokes Bun's bundler, NOT your package.json script). Never use `npm`, `npx`, or `node`.**
|
||||||
|
|
||||||
- **Monorepo**: Bun workspaces + Turborepo orchestration
|
- **Monorepo**: Bun workspaces + Turborepo orchestration
|
||||||
- **Runtime**: Bun (see `mise.toml` for version) — **NOT Node.js**
|
- **Runtime**: Bun (see `mise.toml` for version) — **NOT Node.js**
|
||||||
- **Package Manager**: Bun — **NOT npm / yarn / pnpm**
|
- **Package Manager**: Bun — **NOT npm / yarn / pnpm**
|
||||||
- **Apps**:
|
- **Apps**:
|
||||||
- `apps/server` - TanStack Start fullstack web app (see `apps/server/AGENTS.md`)
|
- `apps/server` - TanStack Start fullstack web app (see `apps/server/AGENTS.md`)
|
||||||
- `apps/desktop` - Electrobun desktop shell, loads server in native window (see `apps/desktop/AGENTS.md`)
|
- `apps/desktop` - Electron desktop shell, sidecar server pattern (see `apps/desktop/AGENTS.md`)
|
||||||
- **Packages**: `packages/utils`, `packages/tsconfig` (shared configs)
|
- **Packages**: `packages/tsconfig` (shared TS configs)
|
||||||
|
|
||||||
## Build / Lint / Test Commands
|
## Build / Lint / Test Commands
|
||||||
|
|
||||||
### Root Commands (via Turbo)
|
### Root Commands (via Turbo)
|
||||||
```bash
|
```bash
|
||||||
bun dev # Start all apps in dev mode
|
bun run dev # Start all apps in dev mode
|
||||||
bun build # Build all apps
|
bun run build # Build all apps
|
||||||
bun fix # Lint + format (Biome auto-fix)
|
bun run compile # Compile server to standalone binary (current platform)
|
||||||
bun typecheck # TypeScript check across monorepo
|
bun run compile:darwin # Compile server for macOS (arm64 + x64)
|
||||||
|
bun run compile:linux # Compile server for Linux (x64 + arm64)
|
||||||
|
bun run compile:windows # Compile server for Windows x64
|
||||||
|
bun run dist # Package desktop distributable (current platform)
|
||||||
|
bun run dist:linux # Package desktop for Linux (x64 + arm64)
|
||||||
|
bun run dist:mac # Package desktop for macOS (arm64 + x64)
|
||||||
|
bun run dist:win # Package desktop for Windows x64
|
||||||
|
bun run fix # Lint + format (Biome auto-fix)
|
||||||
|
bun run typecheck # TypeScript check across monorepo
|
||||||
```
|
```
|
||||||
|
|
||||||
### Server App (`apps/server`)
|
### Server App (`apps/server`)
|
||||||
```bash
|
```bash
|
||||||
bun dev # Vite dev server (localhost:3000)
|
bun run dev # Vite dev server (localhost:3000)
|
||||||
bun build # Production build -> .output/
|
bun run build # Production build -> .output/
|
||||||
bun compile # Compile to standalone binary
|
bun run compile # Compile to standalone binary (current platform)
|
||||||
bun fix # Biome auto-fix
|
bun run compile:darwin # Compile for macOS (arm64 + x64)
|
||||||
bun typecheck # TypeScript check
|
bun run compile:darwin:arm64 # Compile for macOS arm64
|
||||||
|
bun run compile:darwin:x64 # Compile for macOS x64
|
||||||
|
bun run compile:linux # Compile for Linux (x64 + arm64)
|
||||||
|
bun run compile:linux:arm64 # Compile for Linux arm64
|
||||||
|
bun run compile:linux:x64 # Compile for Linux x64
|
||||||
|
bun run compile:windows # Compile for Windows (default: x64)
|
||||||
|
bun run compile:windows:x64 # Compile for Windows x64
|
||||||
|
bun run fix # Biome auto-fix
|
||||||
|
bun run typecheck # TypeScript check
|
||||||
|
|
||||||
# Database (Drizzle)
|
# Database (Drizzle)
|
||||||
bun db:generate # Generate migrations from schema
|
bun run db:generate # Generate migrations from schema
|
||||||
bun db:migrate # Run migrations
|
bun run db:migrate # Run migrations
|
||||||
bun db:push # Push schema (dev only)
|
bun run db:push # Push schema (dev only)
|
||||||
bun db:studio # Open Drizzle Studio
|
bun run db:studio # Open Drizzle Studio
|
||||||
```
|
```
|
||||||
|
|
||||||
### Desktop App (`apps/desktop`)
|
### Desktop App (`apps/desktop`)
|
||||||
```bash
|
```bash
|
||||||
bun dev # Start Electrobun dev mode (requires server dev running)
|
bun run dev # electron-vite dev mode (requires server dev running)
|
||||||
bun build # Build canary release
|
bun run build # electron-vite build (main + preload)
|
||||||
bun build:stable # Build stable release
|
bun run dist # Build + package for current platform
|
||||||
bun fix # Biome auto-fix
|
bun run dist:linux # Build + package for Linux (x64 + arm64)
|
||||||
bun typecheck # TypeScript check
|
bun run dist:linux:x64 # Build + package for Linux x64
|
||||||
|
bun run dist:linux:arm64 # Build + package for Linux arm64
|
||||||
|
bun run dist:mac # Build + package for macOS (arm64 + x64)
|
||||||
|
bun run dist:mac:arm64 # Build + package for macOS arm64
|
||||||
|
bun run dist:mac:x64 # Build + package for macOS x64
|
||||||
|
bun run dist:win # Build + package for Windows x64
|
||||||
|
bun run fix # Biome auto-fix
|
||||||
|
bun run typecheck # TypeScript check
|
||||||
```
|
```
|
||||||
|
|
||||||
### Testing
|
### Testing
|
||||||
@@ -97,7 +120,13 @@ import type { ReactNode } from 'react'
|
|||||||
- ORPC: Use `ORPCError` with proper codes (`NOT_FOUND`, `INPUT_VALIDATION_FAILED`)
|
- ORPC: Use `ORPCError` with proper codes (`NOT_FOUND`, `INPUT_VALIDATION_FAILED`)
|
||||||
- Never use empty catch blocks
|
- Never use empty catch blocks
|
||||||
|
|
||||||
## Database (Drizzle ORM)
|
## Database (Drizzle ORM v1 beta + postgres-js)
|
||||||
|
|
||||||
|
- **ORM**: Drizzle ORM `1.0.0-beta` (RQBv2)
|
||||||
|
- **Driver**: `drizzle-orm/postgres-js` (NOT `bun-sql`)
|
||||||
|
- **Validation**: `drizzle-orm/zod` (built-in, NOT separate `drizzle-zod` package)
|
||||||
|
- **Relations**: Defined via `defineRelations()` in `src/server/db/relations.ts` (contains schema info, so `drizzle()` only needs `{ relations }`)
|
||||||
|
- **Query style**: RQBv2 object syntax (`orderBy: { createdAt: 'desc' }`, `where: { id: 1 }`)
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
export const myTable = pgTable('my_table', {
|
export const myTable = pgTable('my_table', {
|
||||||
@@ -120,13 +149,22 @@ export const myTable = pgTable('my_table', {
|
|||||||
- Workspace packages use `"catalog:"` — never hardcode versions
|
- Workspace packages use `"catalog:"` — never hardcode versions
|
||||||
- Internal packages use `"workspace:*"` references
|
- Internal packages use `"workspace:*"` references
|
||||||
|
|
||||||
|
## Development Principles
|
||||||
|
|
||||||
|
> **These principles apply to ALL code changes. Agents MUST follow them on every task.**
|
||||||
|
|
||||||
|
1. **No backward compatibility** — This project is in rapid iteration. Always use the latest API and patterns. Never keep deprecated code paths or old API fallbacks "just in case".
|
||||||
|
2. **Always sync documentation** — When code changes, immediately update all related documentation (`AGENTS.md`, `README.md`, inline code examples). Code and docs must never drift apart. This includes updating code snippets in docs when imports, APIs, or patterns change.
|
||||||
|
3. **Forward-only migration** — When upgrading dependencies, fully adopt the new API. Don't mix old and new patterns in the same codebase.
|
||||||
|
|
||||||
## Critical Rules
|
## Critical Rules
|
||||||
|
|
||||||
**DO:**
|
**DO:**
|
||||||
- Run `bun fix` before committing
|
- Run `bun run fix` before committing
|
||||||
- Use `@/*` path aliases (not relative imports)
|
- Use `@/*` path aliases (not relative imports)
|
||||||
- Include `createdAt`/`updatedAt` on all tables
|
- Include `createdAt`/`updatedAt` on all tables
|
||||||
- Use `catalog:` for dependency versions
|
- Use `catalog:` for dependency versions
|
||||||
|
- Update `AGENTS.md` and other docs whenever code patterns change
|
||||||
|
|
||||||
**DON'T:**
|
**DON'T:**
|
||||||
- Use `npm`, `npx`, `node`, `yarn`, `pnpm` — always use `bun` / `bunx`
|
- Use `npm`, `npx`, `node`, `yarn`, `pnpm` — always use `bun` / `bunx`
|
||||||
@@ -135,13 +173,14 @@ export const myTable = pgTable('my_table', {
|
|||||||
- Commit `.env` files
|
- Commit `.env` files
|
||||||
- Use empty catch blocks `catch(e) {}`
|
- Use empty catch blocks `catch(e) {}`
|
||||||
- Hardcode dependency versions in workspace packages
|
- Hardcode dependency versions in workspace packages
|
||||||
|
- Leave docs out of sync with code changes
|
||||||
|
|
||||||
## Git Workflow
|
## Git Workflow
|
||||||
|
|
||||||
1. Make changes following style guide
|
1. Make changes following style guide
|
||||||
2. `bun fix` - auto-format and lint
|
2. `bun run fix` - auto-format and lint
|
||||||
3. `bun typecheck` - verify types
|
3. `bun run typecheck` - verify types
|
||||||
4. `bun dev` - test locally
|
4. `bun run dev` - test locally
|
||||||
5. Commit with descriptive message
|
5. Commit with descriptive message
|
||||||
|
|
||||||
## Directory Structure
|
## Directory Structure
|
||||||
@@ -151,22 +190,24 @@ export const myTable = pgTable('my_table', {
|
|||||||
├── apps/
|
├── apps/
|
||||||
│ ├── server/ # TanStack Start fullstack app
|
│ ├── server/ # TanStack Start fullstack app
|
||||||
│ │ ├── src/
|
│ │ ├── src/
|
||||||
│ │ │ ├── client/ # ORPC client, Query client
|
│ │ │ ├── client/ # ORPC client + TanStack Query utils
|
||||||
│ │ │ ├── components/
|
│ │ │ ├── components/
|
||||||
│ │ │ ├── routes/ # File-based routing
|
│ │ │ ├── routes/ # File-based routing
|
||||||
│ │ │ └── server/ # API layer + database
|
│ │ │ └── server/ # API layer + database
|
||||||
│ │ │ ├── api/ # ORPC contracts, routers, middlewares
|
│ │ │ ├── api/ # ORPC contracts, routers, middlewares
|
||||||
│ │ │ └── db/ # Drizzle schema
|
│ │ │ └── db/ # Drizzle schema
|
||||||
│ │ └── AGENTS.md
|
│ │ └── AGENTS.md
|
||||||
│ └── desktop/ # Electrobun desktop shell
|
│ └── desktop/ # Electron desktop shell
|
||||||
│ ├── src/
|
│ ├── src/
|
||||||
│ │ └── bun/
|
│ │ ├── main/
|
||||||
│ │ └── index.ts # Main process entry
|
│ │ │ └── index.ts # Main process entry
|
||||||
│ ├── electrobun.config.ts # Electrobun configuration
|
│ │ └── preload/
|
||||||
|
│ │ └── index.ts # Preload script
|
||||||
|
│ ├── electron.vite.config.ts
|
||||||
|
│ ├── electron-builder.yml # Packaging config
|
||||||
│ └── AGENTS.md
|
│ └── AGENTS.md
|
||||||
├── packages/
|
├── packages/
|
||||||
│ ├── tsconfig/ # Shared TS configs
|
│ └── tsconfig/ # Shared TS configs
|
||||||
│ └── utils/ # Shared utilities
|
|
||||||
├── biome.json # Linting/formatting config
|
├── biome.json # Linting/formatting config
|
||||||
├── turbo.json # Turbo task orchestration
|
├── turbo.json # Turbo task orchestration
|
||||||
└── package.json # Workspace root + dependency catalog
|
└── package.json # Workspace root + dependency catalog
|
||||||
@@ -175,4 +216,4 @@ export const myTable = pgTable('my_table', {
|
|||||||
## See Also
|
## See Also
|
||||||
|
|
||||||
- `apps/server/AGENTS.md` - Detailed TanStack Start / ORPC patterns
|
- `apps/server/AGENTS.md` - Detailed TanStack Start / ORPC patterns
|
||||||
- `apps/desktop/AGENTS.md` - Electrobun desktop development guide
|
- `apps/desktop/AGENTS.md` - Electron desktop development guide
|
||||||
|
|||||||
7
apps/desktop/.gitignore
vendored
7
apps/desktop/.gitignore
vendored
@@ -1,4 +1,3 @@
|
|||||||
# WebUI native libraries (auto-downloaded)
|
# electron-vite build output
|
||||||
*.dll
|
out/
|
||||||
*.so
|
dist/
|
||||||
*.dylib
|
|
||||||
|
|||||||
@@ -1,29 +1,39 @@
|
|||||||
# AGENTS.md - Desktop App Guidelines
|
# AGENTS.md - Desktop App Guidelines
|
||||||
|
|
||||||
Thin WebUI shell hosting the fullstack server app.
|
Thin Electron shell hosting the fullstack server app.
|
||||||
|
|
||||||
## Tech Stack
|
## Tech Stack
|
||||||
|
|
||||||
> **⚠️ This project uses Bun — NOT Node.js / npm. All commands use `bun`. Never use `npm`, `npx`, or `node`.**
|
> **⚠️ This project uses Bun as the package manager. Runtime is Electron (Node.js). Always use `bun run <script>` (not `bun <script>`) to avoid conflicts with Bun built-in subcommands. Never use `npm`, `npx`, `yarn`, or `pnpm`.**
|
||||||
|
|
||||||
- **Type**: WebUI desktop shell
|
- **Type**: Electron desktop shell
|
||||||
- **Design**: Server-driven desktop (thin native window hosting web app)
|
- **Design**: Server-driven desktop (thin native window hosting web app)
|
||||||
- **Runtime**: Bun (Main process) + System browser / WebView (via WebUI)
|
- **Runtime**: Electron (Main/Renderer) + Sidecar server binary (Bun-compiled)
|
||||||
- **Window Library**: [webui-dev/webui](https://github.com/webui-dev/webui) — opens installed browser or native WebView as GUI
|
- **Build Tool**: electron-vite (Vite-based, handles main + preload builds)
|
||||||
- **Build**: Turborepo
|
- **Packager**: electron-builder (installers, signing, auto-update)
|
||||||
|
- **Orchestration**: Turborepo
|
||||||
|
|
||||||
## Architecture
|
## Architecture
|
||||||
|
|
||||||
- **Server-driven design**: The desktop app is a "thin" native shell. It does not contain UI or business logic; it opens a browser window pointing to the `apps/server` TanStack Start application.
|
- **Server-driven design**: The desktop app is a "thin" native shell. It does not contain UI or business logic; it opens a BrowserWindow pointing to the `apps/server` TanStack Start application.
|
||||||
- **Dev mode**: Waits for the Vite dev server at `localhost:3000`, then opens a WebUI window. Requires `apps/server` to be running separately.
|
- **Dev mode**: Opens a BrowserWindow pointing to `localhost:3000`. Requires `apps/server` to be running separately (Turbo handles this).
|
||||||
- **WebUI**: Uses `@webui-dev/bun-webui` (FFI-based C library binding). Auto-detects and opens the best available browser in a private profile, or uses the system WebView.
|
- **Production mode**: Spawns a compiled server binary (from `resources/`) as a sidecar process, waits for readiness, then loads its URL.
|
||||||
|
|
||||||
## Commands
|
## Commands
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
bun dev # Open WebUI window (requires server dev running)
|
bun run dev # electron-vite dev (requires server dev running)
|
||||||
bun fix # Biome auto-fix
|
bun run build # electron-vite build (main + preload)
|
||||||
bun typecheck # TypeScript check
|
bun run dist # Build + package for current platform
|
||||||
|
bun run dist:linux # Build + package for Linux (x64 + arm64)
|
||||||
|
bun run dist:linux:x64 # Build + package for Linux x64
|
||||||
|
bun run dist:linux:arm64 # Build + package for Linux arm64
|
||||||
|
bun run dist:mac # Build + package for macOS (arm64 + x64)
|
||||||
|
bun run dist:mac:arm64 # Build + package for macOS arm64
|
||||||
|
bun run dist:mac:x64 # Build + package for macOS x64
|
||||||
|
bun run dist:win # Build + package for Windows x64
|
||||||
|
bun run fix # Biome auto-fix
|
||||||
|
bun run typecheck # TypeScript check
|
||||||
```
|
```
|
||||||
|
|
||||||
## Directory Structure
|
## Directory Structure
|
||||||
@@ -31,27 +41,55 @@ bun typecheck # TypeScript check
|
|||||||
```
|
```
|
||||||
.
|
.
|
||||||
├── src/
|
├── src/
|
||||||
│ └── bun/
|
│ ├── main/
|
||||||
│ └── index.ts # Main process entry (server readiness check + WebUI window)
|
│ │ └── index.ts # Main process (server lifecycle + BrowserWindow)
|
||||||
├── package.json # Scripts and dependencies
|
│ └── preload/
|
||||||
├── turbo.json # Dev pipeline (depends on server dev)
|
│ └── index.ts # Preload script (security isolation)
|
||||||
└── AGENTS.md # Desktop guidelines (this file)
|
├── resources/ # Sidecar binaries (gitignored, copied from server build)
|
||||||
|
├── out/ # electron-vite build output (gitignored)
|
||||||
|
├── electron.vite.config.ts
|
||||||
|
├── electron-builder.yml # Packaging configuration
|
||||||
|
├── package.json
|
||||||
|
├── turbo.json
|
||||||
|
└── AGENTS.md
|
||||||
```
|
```
|
||||||
|
|
||||||
## Development Workflow
|
## Development Workflow
|
||||||
|
|
||||||
1. **Start server**: In `apps/server`, run `bun dev`.
|
1. **Start server**: `bun run dev` in `apps/server` (or use root `bun run dev` via Turbo).
|
||||||
2. **Start desktop**: In `apps/desktop`, run `bun dev`.
|
2. **Start desktop**: `bun run dev` in `apps/desktop`.
|
||||||
3. **Connection**: The desktop app polls `localhost:3000` until responsive, then opens the browser window.
|
3. **Connection**: Main process polls `localhost:3000` until responsive, then opens BrowserWindow.
|
||||||
|
|
||||||
|
## Production Build Workflow
|
||||||
|
|
||||||
|
From monorepo root, run `bun run dist` to execute the full pipeline automatically (via Turbo task dependencies):
|
||||||
|
|
||||||
|
1. **Build server**: `apps/server` → `vite build` → `.output/`
|
||||||
|
2. **Compile server**: `apps/server` → `bun compile.ts --target ...` → `out/server-{os}-{arch}`
|
||||||
|
3. **Package desktop**: `apps/desktop` → `electron-vite build` + `electron-builder` → distributable
|
||||||
|
|
||||||
|
The `electron-builder.yml` `extraResources` config reads binaries directly from `../server/out/`, no manual copy needed.
|
||||||
|
|
||||||
|
To build for a specific platform explicitly, use `bun run dist:linux` / `bun run dist:mac` / `bun run dist:win` in `apps/desktop`.
|
||||||
|
For single-arch output, use `bun run dist:linux:x64`, `bun run dist:linux:arm64`, `bun run dist:mac:x64`, or `bun run dist:mac:arm64`.
|
||||||
|
|
||||||
|
## Development Principles
|
||||||
|
|
||||||
|
> **These principles apply to ALL code changes. Agents MUST follow them on every task.**
|
||||||
|
|
||||||
|
1. **No backward compatibility** — This project is in rapid iteration. Always use the latest API and patterns. Never keep deprecated code paths or old API fallbacks.
|
||||||
|
2. **Always sync documentation** — When code changes, immediately update all related documentation (`AGENTS.md`, `README.md`, inline code examples). Code and docs must never drift apart.
|
||||||
|
3. **Forward-only migration** — When upgrading dependencies, fully adopt the new API. Don't mix old and new patterns.
|
||||||
|
|
||||||
## Critical Rules
|
## Critical Rules
|
||||||
|
|
||||||
**DO:**
|
**DO:**
|
||||||
- Use arrow functions for all utility functions.
|
- Use arrow functions for all utility functions.
|
||||||
- Ensure `apps/server` dev server is running before starting desktop.
|
- Keep the desktop app as a thin shell — no UI or business logic.
|
||||||
- Use `catalog:` for all dependency versions in `package.json`.
|
- Use `catalog:` for all dependency versions in `package.json`.
|
||||||
|
|
||||||
**DON'T:**
|
**DON'T:**
|
||||||
- Use `npm`, `npx`, `node`, `yarn`, or `pnpm`. Always use `bun`.
|
- Use `npm`, `npx`, `yarn`, or `pnpm`. Use `bun` for package management.
|
||||||
- Include UI components or business logic in the desktop app (keep it thin).
|
- Include UI components or business logic in the desktop app.
|
||||||
- Use `as any` or `@ts-ignore`.
|
- Use `as any` or `@ts-ignore`.
|
||||||
|
- Leave docs out of sync with code changes.
|
||||||
|
|||||||
9
apps/desktop/biome.json
Normal file
9
apps/desktop/biome.json
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
{
|
||||||
|
"$schema": "../../node_modules/@biomejs/biome/configuration_schema.json",
|
||||||
|
"extends": "//",
|
||||||
|
"css": {
|
||||||
|
"parser": {
|
||||||
|
"tailwindDirectives": true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
BIN
apps/desktop/build/icon.png
Normal file
BIN
apps/desktop/build/icon.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 83 KiB |
48
apps/desktop/electron-builder.yml
Normal file
48
apps/desktop/electron-builder.yml
Normal file
@@ -0,0 +1,48 @@
|
|||||||
|
# yaml-language-server: $schema=https://raw.githubusercontent.com/electron-userland/electron-builder/refs/heads/master/packages/app-builder-lib/scheme.json
|
||||||
|
appId: com.furtherverse.desktop
|
||||||
|
productName: Furtherverse
|
||||||
|
executableName: furtherverse
|
||||||
|
|
||||||
|
npmRebuild: false
|
||||||
|
asarUnpack:
|
||||||
|
- resources/**
|
||||||
|
|
||||||
|
files:
|
||||||
|
- "!**/.vscode/*"
|
||||||
|
- "!src/*"
|
||||||
|
- "!electron.vite.config.{js,ts,mjs,cjs}"
|
||||||
|
- "!{.env,.env.*,bun.lock}"
|
||||||
|
- "!{tsconfig.json,tsconfig.node.json}"
|
||||||
|
- "!{AGENTS.md,README.md,CHANGELOG.md}"
|
||||||
|
|
||||||
|
# macOS
|
||||||
|
mac:
|
||||||
|
target:
|
||||||
|
- dmg
|
||||||
|
category: public.app-category.productivity
|
||||||
|
extraResources:
|
||||||
|
- from: ../server/out/server-darwin-${arch}
|
||||||
|
to: server
|
||||||
|
dmg:
|
||||||
|
artifactName: ${productName}-${version}-${os}-${arch}.${ext}
|
||||||
|
|
||||||
|
# Windows
|
||||||
|
win:
|
||||||
|
target:
|
||||||
|
- portable
|
||||||
|
extraResources:
|
||||||
|
- from: ../server/out/server-windows-${arch}.exe
|
||||||
|
to: server.exe
|
||||||
|
portable:
|
||||||
|
artifactName: ${productName}-${version}-${os}-${arch}-Portable.${ext}
|
||||||
|
|
||||||
|
# Linux
|
||||||
|
linux:
|
||||||
|
target:
|
||||||
|
- AppImage
|
||||||
|
category: Utility
|
||||||
|
extraResources:
|
||||||
|
- from: ../server/out/server-linux-${arch}
|
||||||
|
to: server
|
||||||
|
appImage:
|
||||||
|
artifactName: ${productName}-${version}-${os}-${arch}.${ext}
|
||||||
11
apps/desktop/electron.vite.config.ts
Normal file
11
apps/desktop/electron.vite.config.ts
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
import tailwindcss from '@tailwindcss/vite'
|
||||||
|
import react from '@vitejs/plugin-react'
|
||||||
|
import { defineConfig } from 'electron-vite'
|
||||||
|
|
||||||
|
export default defineConfig({
|
||||||
|
main: {},
|
||||||
|
preload: {},
|
||||||
|
renderer: {
|
||||||
|
plugins: [react(), tailwindcss()],
|
||||||
|
},
|
||||||
|
})
|
||||||
@@ -2,17 +2,36 @@
|
|||||||
"name": "@furtherverse/desktop",
|
"name": "@furtherverse/desktop",
|
||||||
"version": "1.0.0",
|
"version": "1.0.0",
|
||||||
"private": true,
|
"private": true,
|
||||||
"type": "module",
|
"main": "out/main/index.js",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"dev": "bun src/bun/index.ts",
|
"build": "electron-vite build",
|
||||||
|
"dev": "electron-vite dev --watch",
|
||||||
|
"dist": "electron-builder",
|
||||||
|
"dist:linux": "bun run dist:linux:x64 && bun run dist:linux:arm64",
|
||||||
|
"dist:linux:arm64": "electron-builder --linux --arm64",
|
||||||
|
"dist:linux:x64": "electron-builder --linux --x64",
|
||||||
|
"dist:mac": "bun run dist:mac:arm64 && bun run dist:mac:x64",
|
||||||
|
"dist:mac:arm64": "electron-builder --mac --arm64",
|
||||||
|
"dist:mac:x64": "electron-builder --mac --x64",
|
||||||
|
"dist:win": "electron-builder --win --x64",
|
||||||
"fix": "biome check --write",
|
"fix": "biome check --write",
|
||||||
"typecheck": "tsc --noEmit"
|
"typecheck": "tsc -b"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@webui-dev/bun-webui": "catalog:"
|
"motion": "catalog:",
|
||||||
|
"react": "catalog:",
|
||||||
|
"react-dom": "catalog:",
|
||||||
|
"tree-kill": "catalog:"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@furtherverse/tsconfig": "workspace:*",
|
"@furtherverse/tsconfig": "workspace:*",
|
||||||
"@types/bun": "catalog:"
|
"@tailwindcss/vite": "catalog:",
|
||||||
|
"@types/node": "catalog:",
|
||||||
|
"@vitejs/plugin-react": "catalog:",
|
||||||
|
"electron": "catalog:",
|
||||||
|
"electron-builder": "catalog:",
|
||||||
|
"electron-vite": "catalog:",
|
||||||
|
"tailwindcss": "catalog:",
|
||||||
|
"vite": "catalog:"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
0
apps/desktop/resources/.gitkeep
Normal file
0
apps/desktop/resources/.gitkeep
Normal file
@@ -1,55 +0,0 @@
|
|||||||
import { WebUI } from '@webui-dev/bun-webui'
|
|
||||||
|
|
||||||
const DEV_SERVER_URL = 'http://localhost:3000'
|
|
||||||
const SERVER_READY_TIMEOUT_MS = 10_000
|
|
||||||
|
|
||||||
const isServerReady = async (url: string): Promise<boolean> => {
|
|
||||||
try {
|
|
||||||
const response = await fetch(url, { method: 'HEAD' })
|
|
||||||
return response.ok
|
|
||||||
} catch {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
const waitForServer = async (
|
|
||||||
url: string,
|
|
||||||
timeoutMs = SERVER_READY_TIMEOUT_MS,
|
|
||||||
): Promise<boolean> => {
|
|
||||||
const start = Date.now()
|
|
||||||
while (Date.now() - start < timeoutMs) {
|
|
||||||
if (await isServerReady(url)) return true
|
|
||||||
await Bun.sleep(100)
|
|
||||||
}
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
const main = async () => {
|
|
||||||
console.log('Starting Furtherverse Desktop...')
|
|
||||||
|
|
||||||
console.log('Waiting for server at', DEV_SERVER_URL)
|
|
||||||
const ready = await waitForServer(DEV_SERVER_URL)
|
|
||||||
if (!ready) {
|
|
||||||
console.error(
|
|
||||||
'Dev server not responding. Run `bun dev` in apps/server first.',
|
|
||||||
)
|
|
||||||
process.exit(1)
|
|
||||||
}
|
|
||||||
|
|
||||||
console.log('Opening window at', DEV_SERVER_URL)
|
|
||||||
|
|
||||||
const win = new WebUI()
|
|
||||||
win.setSize(1200, 800)
|
|
||||||
win.setCenter()
|
|
||||||
await win.show(DEV_SERVER_URL)
|
|
||||||
|
|
||||||
console.log('Window opened. Waiting for close...')
|
|
||||||
await WebUI.wait()
|
|
||||||
|
|
||||||
process.exit(0)
|
|
||||||
}
|
|
||||||
|
|
||||||
main().catch((error) => {
|
|
||||||
console.error('Failed to start:', error)
|
|
||||||
process.exit(1)
|
|
||||||
})
|
|
||||||
198
apps/desktop/src/main/index.ts
Normal file
198
apps/desktop/src/main/index.ts
Normal file
@@ -0,0 +1,198 @@
|
|||||||
|
import { join } from 'node:path'
|
||||||
|
import { app, BrowserWindow, dialog, session, shell } from 'electron'
|
||||||
|
import { createSidecarRuntime } from './sidecar'
|
||||||
|
|
||||||
|
const DEV_SERVER_URL = 'http://localhost:3000'
|
||||||
|
const SAFE_EXTERNAL_PROTOCOLS = new Set(['https:', 'http:', 'mailto:'])
|
||||||
|
|
||||||
|
let mainWindow: BrowserWindow | null = null
|
||||||
|
let windowCreationPromise: Promise<void> | null = null
|
||||||
|
let isQuitting = false
|
||||||
|
|
||||||
|
const showErrorAndQuit = (title: string, detail: string) => {
|
||||||
|
if (isQuitting) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
dialog.showErrorBox(title, detail)
|
||||||
|
app.quit()
|
||||||
|
}
|
||||||
|
|
||||||
|
const sidecar = createSidecarRuntime({
|
||||||
|
devServerUrl: DEV_SERVER_URL,
|
||||||
|
isPackaged: app.isPackaged,
|
||||||
|
resourcesPath: process.resourcesPath,
|
||||||
|
isQuitting: () => isQuitting,
|
||||||
|
onUnexpectedStop: (detail) => {
|
||||||
|
showErrorAndQuit('Service Stopped', detail)
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
const toErrorMessage = (error: unknown): string => (error instanceof Error ? error.message : String(error))
|
||||||
|
|
||||||
|
const canOpenExternally = (url: string): boolean => {
|
||||||
|
try {
|
||||||
|
const parsed = new URL(url)
|
||||||
|
return SAFE_EXTERNAL_PROTOCOLS.has(parsed.protocol)
|
||||||
|
} catch {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const loadSplash = async (windowRef: BrowserWindow) => {
|
||||||
|
if (process.env.ELECTRON_RENDERER_URL) {
|
||||||
|
await windowRef.loadURL(process.env.ELECTRON_RENDERER_URL)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
await windowRef.loadFile(join(__dirname, '../renderer/index.html'))
|
||||||
|
}
|
||||||
|
|
||||||
|
const createWindow = async () => {
|
||||||
|
if (mainWindow && !mainWindow.isDestroyed()) {
|
||||||
|
mainWindow.focus()
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
const windowRef = new BrowserWindow({
|
||||||
|
width: 1200,
|
||||||
|
height: 800,
|
||||||
|
show: false,
|
||||||
|
webPreferences: {
|
||||||
|
preload: join(__dirname, '../preload/index.js'),
|
||||||
|
sandbox: true,
|
||||||
|
contextIsolation: true,
|
||||||
|
nodeIntegration: false,
|
||||||
|
},
|
||||||
|
})
|
||||||
|
mainWindow = windowRef
|
||||||
|
|
||||||
|
windowRef.webContents.setWindowOpenHandler(({ url }) => {
|
||||||
|
if (!canOpenExternally(url)) {
|
||||||
|
if (!app.isPackaged) {
|
||||||
|
console.warn(`Blocked external URL: ${url}`)
|
||||||
|
}
|
||||||
|
|
||||||
|
return { action: 'deny' }
|
||||||
|
}
|
||||||
|
|
||||||
|
void shell.openExternal(url)
|
||||||
|
return { action: 'deny' }
|
||||||
|
})
|
||||||
|
|
||||||
|
windowRef.webContents.on('will-navigate', (event, url) => {
|
||||||
|
const allowed = [DEV_SERVER_URL, sidecar.lastResolvedUrl].filter((v): v is string => v != null)
|
||||||
|
const isAllowed = allowed.some((origin) => url.startsWith(origin))
|
||||||
|
|
||||||
|
if (!isAllowed) {
|
||||||
|
event.preventDefault()
|
||||||
|
|
||||||
|
if (canOpenExternally(url)) {
|
||||||
|
void shell.openExternal(url)
|
||||||
|
} else if (!app.isPackaged) {
|
||||||
|
console.warn(`Blocked navigation to: ${url}`)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
windowRef.on('closed', () => {
|
||||||
|
if (mainWindow === windowRef) {
|
||||||
|
mainWindow = null
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
try {
|
||||||
|
await loadSplash(windowRef)
|
||||||
|
} catch (error) {
|
||||||
|
if (mainWindow === windowRef) {
|
||||||
|
mainWindow = null
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!windowRef.isDestroyed()) {
|
||||||
|
windowRef.destroy()
|
||||||
|
}
|
||||||
|
|
||||||
|
throw error
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!windowRef.isDestroyed()) {
|
||||||
|
windowRef.show()
|
||||||
|
}
|
||||||
|
|
||||||
|
const targetUrl = await sidecar.resolveUrl()
|
||||||
|
if (isQuitting || windowRef.isDestroyed()) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
await windowRef.loadURL(targetUrl)
|
||||||
|
} catch (error) {
|
||||||
|
if (mainWindow === windowRef) {
|
||||||
|
mainWindow = null
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!windowRef.isDestroyed()) {
|
||||||
|
windowRef.destroy()
|
||||||
|
}
|
||||||
|
|
||||||
|
throw error
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const ensureWindow = async () => {
|
||||||
|
if (windowCreationPromise) {
|
||||||
|
return windowCreationPromise
|
||||||
|
}
|
||||||
|
|
||||||
|
windowCreationPromise = createWindow().finally(() => {
|
||||||
|
windowCreationPromise = null
|
||||||
|
})
|
||||||
|
|
||||||
|
return windowCreationPromise
|
||||||
|
}
|
||||||
|
|
||||||
|
const beginQuit = () => {
|
||||||
|
isQuitting = true
|
||||||
|
sidecar.stop()
|
||||||
|
}
|
||||||
|
|
||||||
|
const handleWindowCreationError = (error: unknown, context: string) => {
|
||||||
|
console.error(`${context}:`, error)
|
||||||
|
showErrorAndQuit(
|
||||||
|
"App Couldn't Start",
|
||||||
|
app.isPackaged
|
||||||
|
? 'A required component failed to start. Please reinstall the app.'
|
||||||
|
: `${context}: ${toErrorMessage(error)}`,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
app
|
||||||
|
.whenReady()
|
||||||
|
.then(() => {
|
||||||
|
session.defaultSession.setPermissionRequestHandler((_webContents, _permission, callback) => {
|
||||||
|
callback(false)
|
||||||
|
})
|
||||||
|
|
||||||
|
return ensureWindow()
|
||||||
|
})
|
||||||
|
.catch((error) => {
|
||||||
|
handleWindowCreationError(error, 'Failed to create window')
|
||||||
|
})
|
||||||
|
|
||||||
|
app.on('window-all-closed', () => {
|
||||||
|
if (process.platform !== 'darwin') {
|
||||||
|
app.quit()
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
app.on('activate', () => {
|
||||||
|
if (isQuitting || BrowserWindow.getAllWindows().length > 0) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
ensureWindow().catch((error) => {
|
||||||
|
handleWindowCreationError(error, 'Failed to re-create window')
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
app.on('before-quit', beginQuit)
|
||||||
256
apps/desktop/src/main/sidecar.ts
Normal file
256
apps/desktop/src/main/sidecar.ts
Normal file
@@ -0,0 +1,256 @@
|
|||||||
|
import { type ChildProcess, spawn } from 'node:child_process'
|
||||||
|
import { existsSync } from 'node:fs'
|
||||||
|
import { createServer } from 'node:net'
|
||||||
|
import { join } from 'node:path'
|
||||||
|
import killProcessTree from 'tree-kill'
|
||||||
|
|
||||||
|
const SERVER_HOST = '127.0.0.1'
|
||||||
|
const SERVER_READY_TIMEOUT_MS = 10_000
|
||||||
|
const SERVER_REQUEST_TIMEOUT_MS = 1_500
|
||||||
|
const SERVER_POLL_INTERVAL_MS = 250
|
||||||
|
const SERVER_PROBE_PATHS = ['/api/health', '/']
|
||||||
|
|
||||||
|
type SidecarState = {
|
||||||
|
process: ChildProcess | null
|
||||||
|
startup: Promise<string> | null
|
||||||
|
url: string | null
|
||||||
|
}
|
||||||
|
|
||||||
|
type SidecarRuntimeOptions = {
|
||||||
|
devServerUrl: string
|
||||||
|
isPackaged: boolean
|
||||||
|
resourcesPath: string
|
||||||
|
isQuitting: () => boolean
|
||||||
|
onUnexpectedStop: (detail: string) => void
|
||||||
|
}
|
||||||
|
|
||||||
|
type SidecarRuntime = {
|
||||||
|
resolveUrl: () => Promise<string>
|
||||||
|
stop: () => void
|
||||||
|
lastResolvedUrl: string | null
|
||||||
|
}
|
||||||
|
|
||||||
|
const sleep = (ms: number): Promise<void> => new Promise((resolve) => setTimeout(resolve, ms))
|
||||||
|
|
||||||
|
const isProcessAlive = (processToCheck: ChildProcess | null): processToCheck is ChildProcess => {
|
||||||
|
if (!processToCheck || !processToCheck.pid) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
return processToCheck.exitCode === null && !processToCheck.killed
|
||||||
|
}
|
||||||
|
|
||||||
|
const getAvailablePort = (): Promise<number> =>
|
||||||
|
new Promise((resolve, reject) => {
|
||||||
|
const server = createServer()
|
||||||
|
server.listen(0, () => {
|
||||||
|
const addr = server.address()
|
||||||
|
if (!addr || typeof addr === 'string') {
|
||||||
|
server.close()
|
||||||
|
reject(new Error('Failed to resolve port'))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
server.close(() => resolve(addr.port))
|
||||||
|
})
|
||||||
|
server.on('error', reject)
|
||||||
|
})
|
||||||
|
|
||||||
|
const isServerReady = async (url: string): Promise<boolean> => {
|
||||||
|
for (const probePath of SERVER_PROBE_PATHS) {
|
||||||
|
try {
|
||||||
|
const probeUrl = new URL(probePath, `${url}/`)
|
||||||
|
const response = await fetch(probeUrl, {
|
||||||
|
method: 'GET',
|
||||||
|
cache: 'no-store',
|
||||||
|
signal: AbortSignal.timeout(SERVER_REQUEST_TIMEOUT_MS),
|
||||||
|
})
|
||||||
|
|
||||||
|
if (response.status < 500) {
|
||||||
|
if (probePath === '/api/health' && response.status === 404) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
} catch {
|
||||||
|
// Expected: probe request fails while server is still starting up
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
const waitForServer = async (url: string, isQuitting: () => boolean, processRef?: ChildProcess): Promise<boolean> => {
|
||||||
|
const start = Date.now()
|
||||||
|
while (Date.now() - start < SERVER_READY_TIMEOUT_MS && !isQuitting()) {
|
||||||
|
if (processRef && processRef.exitCode !== null) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
if (await isServerReady(url)) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
await sleep(SERVER_POLL_INTERVAL_MS)
|
||||||
|
}
|
||||||
|
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
const resolveBinaryPath = (resourcesPath: string): string => {
|
||||||
|
const binaryName = process.platform === 'win32' ? 'server.exe' : 'server'
|
||||||
|
return join(resourcesPath, binaryName)
|
||||||
|
}
|
||||||
|
|
||||||
|
const formatUnexpectedStopMessage = (
|
||||||
|
isPackaged: boolean,
|
||||||
|
code: number | null,
|
||||||
|
signal: NodeJS.Signals | null,
|
||||||
|
): string => {
|
||||||
|
if (isPackaged) {
|
||||||
|
return 'The background service stopped unexpectedly. Please restart the app.'
|
||||||
|
}
|
||||||
|
|
||||||
|
return `Server process exited unexpectedly (code ${code ?? 'unknown'}, signal ${signal ?? 'none'}).`
|
||||||
|
}
|
||||||
|
|
||||||
|
export const createSidecarRuntime = (options: SidecarRuntimeOptions): SidecarRuntime => {
|
||||||
|
const state: SidecarState = {
|
||||||
|
process: null,
|
||||||
|
startup: null,
|
||||||
|
url: null,
|
||||||
|
}
|
||||||
|
|
||||||
|
const resetState = (processRef?: ChildProcess) => {
|
||||||
|
if (processRef && state.process !== processRef) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
state.process = null
|
||||||
|
state.url = null
|
||||||
|
}
|
||||||
|
|
||||||
|
const stop = () => {
|
||||||
|
const runningServer = state.process
|
||||||
|
resetState()
|
||||||
|
|
||||||
|
if (!runningServer?.pid || runningServer.exitCode !== null) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
killProcessTree(runningServer.pid, 'SIGTERM', (error?: Error) => {
|
||||||
|
if (error) {
|
||||||
|
console.error('Failed to stop server process:', error)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
const attachLifecycleHandlers = (processRef: ChildProcess) => {
|
||||||
|
processRef.on('error', (error) => {
|
||||||
|
if (state.process !== processRef) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
const hadReadyServer = state.url !== null
|
||||||
|
resetState(processRef)
|
||||||
|
|
||||||
|
if (!options.isQuitting() && hadReadyServer) {
|
||||||
|
options.onUnexpectedStop('The background service crashed unexpectedly. Please restart the app.')
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
console.error('Failed to start server process:', error)
|
||||||
|
})
|
||||||
|
|
||||||
|
processRef.on('exit', (code, signal) => {
|
||||||
|
if (state.process !== processRef) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
const hadReadyServer = state.url !== null
|
||||||
|
resetState(processRef)
|
||||||
|
|
||||||
|
if (!options.isQuitting() && hadReadyServer) {
|
||||||
|
options.onUnexpectedStop(formatUnexpectedStopMessage(options.isPackaged, code, signal))
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
const startPackagedServer = async (): Promise<string> => {
|
||||||
|
if (state.url && isProcessAlive(state.process)) {
|
||||||
|
return state.url
|
||||||
|
}
|
||||||
|
|
||||||
|
if (state.startup) {
|
||||||
|
return state.startup
|
||||||
|
}
|
||||||
|
|
||||||
|
state.startup = (async () => {
|
||||||
|
const binaryPath = resolveBinaryPath(options.resourcesPath)
|
||||||
|
if (!existsSync(binaryPath)) {
|
||||||
|
throw new Error(`Sidecar server binary is missing: ${binaryPath}`)
|
||||||
|
}
|
||||||
|
|
||||||
|
if (options.isQuitting()) {
|
||||||
|
throw new Error('Application is shutting down.')
|
||||||
|
}
|
||||||
|
|
||||||
|
const port = await getAvailablePort()
|
||||||
|
const nextServerUrl = `http://${SERVER_HOST}:${port}`
|
||||||
|
const processRef = spawn(binaryPath, [], {
|
||||||
|
env: {
|
||||||
|
...process.env,
|
||||||
|
HOST: SERVER_HOST,
|
||||||
|
PORT: String(port),
|
||||||
|
},
|
||||||
|
stdio: 'ignore',
|
||||||
|
windowsHide: true,
|
||||||
|
})
|
||||||
|
|
||||||
|
processRef.unref()
|
||||||
|
state.process = processRef
|
||||||
|
attachLifecycleHandlers(processRef)
|
||||||
|
|
||||||
|
const ready = await waitForServer(nextServerUrl, options.isQuitting, processRef)
|
||||||
|
if (ready && isProcessAlive(processRef)) {
|
||||||
|
state.url = nextServerUrl
|
||||||
|
return nextServerUrl
|
||||||
|
}
|
||||||
|
|
||||||
|
const failureReason =
|
||||||
|
processRef.exitCode !== null
|
||||||
|
? `The service exited early (code ${processRef.exitCode}).`
|
||||||
|
: `The service did not respond at ${nextServerUrl} within 10 seconds.`
|
||||||
|
|
||||||
|
stop()
|
||||||
|
throw new Error(failureReason)
|
||||||
|
})().finally(() => {
|
||||||
|
state.startup = null
|
||||||
|
})
|
||||||
|
|
||||||
|
return state.startup
|
||||||
|
}
|
||||||
|
|
||||||
|
const resolveUrl = async (): Promise<string> => {
|
||||||
|
if (options.isPackaged) {
|
||||||
|
return startPackagedServer()
|
||||||
|
}
|
||||||
|
|
||||||
|
const ready = await waitForServer(options.devServerUrl, options.isQuitting)
|
||||||
|
if (!ready) {
|
||||||
|
throw new Error('Dev server not responding. Run `bun dev` in apps/server first.')
|
||||||
|
}
|
||||||
|
|
||||||
|
state.url = options.devServerUrl
|
||||||
|
return options.devServerUrl
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
resolveUrl,
|
||||||
|
stop,
|
||||||
|
get lastResolvedUrl() {
|
||||||
|
return state.url
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
1
apps/desktop/src/preload/index.ts
Normal file
1
apps/desktop/src/preload/index.ts
Normal file
@@ -0,0 +1 @@
|
|||||||
|
export {}
|
||||||
BIN
apps/desktop/src/renderer/assets/logo.png
Normal file
BIN
apps/desktop/src/renderer/assets/logo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 83 KiB |
33
apps/desktop/src/renderer/components/SplashApp.tsx
Normal file
33
apps/desktop/src/renderer/components/SplashApp.tsx
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
import { motion } from 'motion/react'
|
||||||
|
import logoImage from '../assets/logo.png'
|
||||||
|
|
||||||
|
export const SplashApp = () => {
|
||||||
|
return (
|
||||||
|
<main className="m-0 flex h-screen w-screen cursor-default select-none items-center justify-center overflow-hidden bg-white font-sans antialiased">
|
||||||
|
<motion.section
|
||||||
|
animate={{ opacity: 1, y: 0 }}
|
||||||
|
className="flex flex-col items-center gap-8"
|
||||||
|
initial={{ opacity: 0, y: 4 }}
|
||||||
|
transition={{
|
||||||
|
duration: 1,
|
||||||
|
ease: [0.16, 1, 0.3, 1],
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
<img alt="Logo" className="h-20 w-auto object-contain" draggable={false} src={logoImage} />
|
||||||
|
|
||||||
|
<div className="relative h-[4px] w-36 overflow-hidden rounded-full bg-zinc-100">
|
||||||
|
<motion.div
|
||||||
|
animate={{ x: '100%' }}
|
||||||
|
className="h-full w-full bg-zinc-800"
|
||||||
|
initial={{ x: '-100%' }}
|
||||||
|
transition={{
|
||||||
|
duration: 2,
|
||||||
|
ease: [0.4, 0, 0.2, 1],
|
||||||
|
repeat: Infinity,
|
||||||
|
}}
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
</motion.section>
|
||||||
|
</main>
|
||||||
|
)
|
||||||
|
}
|
||||||
12
apps/desktop/src/renderer/index.html
Normal file
12
apps/desktop/src/renderer/index.html
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
<!doctype html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
|
<title>Furtherverse</title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div id="root"></div>
|
||||||
|
<script type="module" src="./main.tsx"></script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
11
apps/desktop/src/renderer/main.tsx
Normal file
11
apps/desktop/src/renderer/main.tsx
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
import { StrictMode } from 'react'
|
||||||
|
import { createRoot } from 'react-dom/client'
|
||||||
|
import { SplashApp } from './components/SplashApp'
|
||||||
|
import './styles.css'
|
||||||
|
|
||||||
|
// biome-ignore lint/style/noNonNullAssertion: 一定存在
|
||||||
|
createRoot(document.getElementById('root')!).render(
|
||||||
|
<StrictMode>
|
||||||
|
<SplashApp />
|
||||||
|
</StrictMode>,
|
||||||
|
)
|
||||||
1
apps/desktop/src/renderer/styles.css
Normal file
1
apps/desktop/src/renderer/styles.css
Normal file
@@ -0,0 +1 @@
|
|||||||
|
@import "tailwindcss";
|
||||||
8
apps/desktop/tsconfig.app.json
Normal file
8
apps/desktop/tsconfig.app.json
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
{
|
||||||
|
"extends": "@furtherverse/tsconfig/react.json",
|
||||||
|
"compilerOptions": {
|
||||||
|
"composite": true,
|
||||||
|
"types": ["vite/client"]
|
||||||
|
},
|
||||||
|
"include": ["src/renderer/**/*"]
|
||||||
|
}
|
||||||
@@ -1,6 +1,11 @@
|
|||||||
{
|
{
|
||||||
"extends": "@furtherverse/tsconfig/bun.json",
|
"files": [],
|
||||||
"compilerOptions": {
|
"references": [
|
||||||
"lib": ["ESNext", "DOM", "DOM.Iterable"]
|
{
|
||||||
|
"path": "./tsconfig.app.json"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"path": "./tsconfig.node.json"
|
||||||
}
|
}
|
||||||
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
8
apps/desktop/tsconfig.node.json
Normal file
8
apps/desktop/tsconfig.node.json
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
{
|
||||||
|
"extends": "@furtherverse/tsconfig/base.json",
|
||||||
|
"compilerOptions": {
|
||||||
|
"composite": true,
|
||||||
|
"types": ["node"]
|
||||||
|
},
|
||||||
|
"include": ["src/main/**/*", "src/preload/**/*", "electron.vite.config.ts"]
|
||||||
|
}
|
||||||
@@ -1,5 +1,41 @@
|
|||||||
{
|
{
|
||||||
"$schema": "../../node_modules/turbo/schema.json",
|
"$schema": "../../node_modules/turbo/schema.json",
|
||||||
"extends": ["//"],
|
"extends": ["//"],
|
||||||
"tasks": {}
|
"tasks": {
|
||||||
|
"build": {
|
||||||
|
"outputs": ["out/**"]
|
||||||
|
},
|
||||||
|
"dist": {
|
||||||
|
"dependsOn": ["build", "@furtherverse/server#compile"],
|
||||||
|
"outputs": ["dist/**"]
|
||||||
|
},
|
||||||
|
"dist:linux": {
|
||||||
|
"dependsOn": ["build", "@furtherverse/server#compile:linux:arm64", "@furtherverse/server#compile:linux:x64"],
|
||||||
|
"outputs": ["dist/**"]
|
||||||
|
},
|
||||||
|
"dist:linux:arm64": {
|
||||||
|
"dependsOn": ["build", "@furtherverse/server#compile:linux:arm64"],
|
||||||
|
"outputs": ["dist/**"]
|
||||||
|
},
|
||||||
|
"dist:linux:x64": {
|
||||||
|
"dependsOn": ["build", "@furtherverse/server#compile:linux:x64"],
|
||||||
|
"outputs": ["dist/**"]
|
||||||
|
},
|
||||||
|
"dist:mac": {
|
||||||
|
"dependsOn": ["build", "@furtherverse/server#compile:darwin:arm64", "@furtherverse/server#compile:darwin:x64"],
|
||||||
|
"outputs": ["dist/**"]
|
||||||
|
},
|
||||||
|
"dist:mac:arm64": {
|
||||||
|
"dependsOn": ["build", "@furtherverse/server#compile:darwin:arm64"],
|
||||||
|
"outputs": ["dist/**"]
|
||||||
|
},
|
||||||
|
"dist:mac:x64": {
|
||||||
|
"dependsOn": ["build", "@furtherverse/server#compile:darwin:x64"],
|
||||||
|
"outputs": ["dist/**"]
|
||||||
|
},
|
||||||
|
"dist:win": {
|
||||||
|
"dependsOn": ["build", "@furtherverse/server#compile:windows:x64"],
|
||||||
|
"outputs": ["dist/**"]
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -4,14 +4,14 @@ TanStack Start fullstack web app with ORPC (contract-first RPC).
|
|||||||
|
|
||||||
## Tech Stack
|
## Tech Stack
|
||||||
|
|
||||||
> **⚠️ This project uses Bun — NOT Node.js / npm. All commands use `bun`. Never use `npm`, `npx`, or `node`.**
|
> **⚠️ This project uses Bun — NOT Node.js / npm. All commands use `bun`. Always use `bun run <script>` (not `bun <script>`) to avoid conflicts with Bun built-in subcommands. Never use `npm`, `npx`, or `node`.**
|
||||||
|
|
||||||
- **Framework**: TanStack Start (React 19 SSR, file-based routing)
|
- **Framework**: TanStack Start (React 19 SSR, file-based routing)
|
||||||
- **Runtime**: Bun — **NOT Node.js**
|
- **Runtime**: Bun — **NOT Node.js**
|
||||||
- **Package Manager**: Bun — **NOT npm / yarn / pnpm**
|
- **Package Manager**: Bun — **NOT npm / yarn / pnpm**
|
||||||
- **Language**: TypeScript (strict mode)
|
- **Language**: TypeScript (strict mode)
|
||||||
- **Styling**: Tailwind CSS v4
|
- **Styling**: Tailwind CSS v4
|
||||||
- **Database**: PostgreSQL + Drizzle ORM
|
- **Database**: PostgreSQL + Drizzle ORM v1 beta (`drizzle-orm/postgres-js`, RQBv2)
|
||||||
- **State**: TanStack Query v5
|
- **State**: TanStack Query v5
|
||||||
- **RPC**: ORPC (contract-first, type-safe)
|
- **RPC**: ORPC (contract-first, type-safe)
|
||||||
- **Build**: Vite + Nitro
|
- **Build**: Vite + Nitro
|
||||||
@@ -20,21 +20,29 @@ TanStack Start fullstack web app with ORPC (contract-first RPC).
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Development
|
# Development
|
||||||
bun dev # Vite dev server (localhost:3000)
|
bun run dev # Vite dev server (localhost:3000)
|
||||||
bun db:studio # Drizzle Studio GUI
|
bun run db:studio # Drizzle Studio GUI
|
||||||
|
|
||||||
# Build
|
# Build
|
||||||
bun build # Production build → .output/
|
bun run build # Production build → .output/
|
||||||
bun compile # Compile to standalone binary
|
bun run compile # Compile to standalone binary (current platform, depends on build)
|
||||||
|
bun run compile:darwin # Compile for macOS (arm64 + x64)
|
||||||
|
bun run compile:darwin:arm64 # Compile for macOS arm64
|
||||||
|
bun run compile:darwin:x64 # Compile for macOS x64
|
||||||
|
bun run compile:linux # Compile for Linux (x64 + arm64)
|
||||||
|
bun run compile:linux:arm64 # Compile for Linux arm64
|
||||||
|
bun run compile:linux:x64 # Compile for Linux x64
|
||||||
|
bun run compile:windows # Compile for Windows (default: x64)
|
||||||
|
bun run compile:windows:x64 # Compile for Windows x64
|
||||||
|
|
||||||
# Code Quality
|
# Code Quality
|
||||||
bun fix # Biome auto-fix
|
bun run fix # Biome auto-fix
|
||||||
bun typecheck # TypeScript check
|
bun run typecheck # TypeScript check
|
||||||
|
|
||||||
# Database
|
# Database
|
||||||
bun db:generate # Generate migrations from schema
|
bun run db:generate # Generate migrations from schema
|
||||||
bun db:migrate # Run migrations
|
bun run db:migrate # Run migrations
|
||||||
bun db:push # Push schema directly (dev only)
|
bun run db:push # Push schema directly (dev only)
|
||||||
|
|
||||||
# Testing (not yet configured)
|
# Testing (not yet configured)
|
||||||
bun test path/to/test.ts # Run single test
|
bun test path/to/test.ts # Run single test
|
||||||
@@ -46,25 +54,29 @@ bun test -t "pattern" # Run tests matching pattern
|
|||||||
```
|
```
|
||||||
src/
|
src/
|
||||||
├── client/ # Client-side code
|
├── client/ # Client-side code
|
||||||
│ ├── orpc.client.ts # ORPC isomorphic client
|
│ └── orpc.ts # ORPC client + TanStack Query utils (single entry point)
|
||||||
│ └── query-client.ts # TanStack Query client
|
|
||||||
├── components/ # React components
|
├── components/ # React components
|
||||||
├── routes/ # TanStack Router file routes
|
├── routes/ # TanStack Router file routes
|
||||||
│ ├── __root.tsx # Root layout
|
│ ├── __root.tsx # Root layout
|
||||||
│ ├── index.tsx # Home page
|
│ ├── index.tsx # Home page
|
||||||
│ └── api/
|
│ └── api/
|
||||||
│ └── rpc.$.ts # ORPC HTTP endpoint
|
│ ├── $.ts # OpenAPI handler + Scalar docs
|
||||||
|
│ ├── health.ts # Health check endpoint
|
||||||
|
│ └── rpc.$.ts # ORPC RPC handler
|
||||||
├── server/ # Server-side code
|
├── server/ # Server-side code
|
||||||
│ ├── api/ # ORPC layer
|
│ ├── api/ # ORPC layer
|
||||||
│ │ ├── contracts/ # Input/output schemas (Zod)
|
│ │ ├── contracts/ # Input/output schemas (Zod)
|
||||||
│ │ ├── middlewares/ # Middleware (db provider, auth)
|
│ │ ├── middlewares/ # Middleware (db provider, auth)
|
||||||
│ │ ├── routers/ # Handler implementations
|
│ │ ├── routers/ # Handler implementations
|
||||||
|
│ │ ├── interceptors.ts # Shared error interceptors
|
||||||
│ │ ├── context.ts # Request context
|
│ │ ├── context.ts # Request context
|
||||||
│ │ ├── server.ts # ORPC server instance
|
│ │ ├── server.ts # ORPC server instance
|
||||||
│ │ └── types.ts # Type exports
|
│ │ └── types.ts # Type exports
|
||||||
│ └── db/
|
│ └── db/
|
||||||
│ ├── schema/ # Drizzle table definitions
|
│ ├── schema/ # Drizzle table definitions
|
||||||
│ └── index.ts # Database instance
|
│ ├── fields.ts # Shared field builders (id, createdAt, updatedAt)
|
||||||
|
│ ├── relations.ts # Drizzle relations (defineRelations, RQBv2)
|
||||||
|
│ └── index.ts # Database instance (postgres-js driver)
|
||||||
├── env.ts # Environment variable validation
|
├── env.ts # Environment variable validation
|
||||||
├── router.tsx # Router configuration
|
├── router.tsx # Router configuration
|
||||||
├── routeTree.gen.ts # Auto-generated (DO NOT EDIT)
|
├── routeTree.gen.ts # Auto-generated (DO NOT EDIT)
|
||||||
@@ -76,7 +88,7 @@ src/
|
|||||||
### 1. Define Contract (`src/server/api/contracts/feature.contract.ts`)
|
### 1. Define Contract (`src/server/api/contracts/feature.contract.ts`)
|
||||||
```typescript
|
```typescript
|
||||||
import { oc } from '@orpc/contract'
|
import { oc } from '@orpc/contract'
|
||||||
import { createSelectSchema } from 'drizzle-zod'
|
import { createSelectSchema } from 'drizzle-orm/zod'
|
||||||
import { z } from 'zod'
|
import { z } from 'zod'
|
||||||
import { featureTable } from '@/server/db/schema'
|
import { featureTable } from '@/server/db/schema'
|
||||||
|
|
||||||
@@ -93,7 +105,9 @@ import { db } from '../middlewares'
|
|||||||
import { os } from '../server'
|
import { os } from '../server'
|
||||||
|
|
||||||
export const list = os.feature.list.use(db).handler(async ({ context }) => {
|
export const list = os.feature.list.use(db).handler(async ({ context }) => {
|
||||||
return await context.db.query.featureTable.findMany()
|
return await context.db.query.featureTable.findMany({
|
||||||
|
orderBy: { createdAt: 'desc' },
|
||||||
|
})
|
||||||
})
|
})
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -111,14 +125,20 @@ export const router = os.router({ feature })
|
|||||||
### 4. Use in Components
|
### 4. Use in Components
|
||||||
```typescript
|
```typescript
|
||||||
import { useSuspenseQuery, useMutation } from '@tanstack/react-query'
|
import { useSuspenseQuery, useMutation } from '@tanstack/react-query'
|
||||||
import { orpc } from '@/client/orpc.client'
|
import { orpc } from '@/client/orpc'
|
||||||
|
|
||||||
const { data } = useSuspenseQuery(orpc.feature.list.queryOptions())
|
const { data } = useSuspenseQuery(orpc.feature.list.queryOptions())
|
||||||
const mutation = useMutation(orpc.feature.create.mutationOptions())
|
const mutation = useMutation(orpc.feature.create.mutationOptions())
|
||||||
```
|
```
|
||||||
|
|
||||||
## Database Schema (Drizzle)
|
## Database (Drizzle ORM v1 beta)
|
||||||
|
|
||||||
|
- **Driver**: `drizzle-orm/postgres-js` (NOT `bun-sql`)
|
||||||
|
- **Validation**: `drizzle-orm/zod` (built-in, NOT separate `drizzle-zod` package)
|
||||||
|
- **Relations**: Defined via `defineRelations()` in `src/server/db/relations.ts`
|
||||||
|
- **Query**: RQBv2 — use `db.query.tableName.findMany()` with object-style `orderBy` and `where`
|
||||||
|
|
||||||
|
### Schema Definition
|
||||||
```typescript
|
```typescript
|
||||||
import { pgTable, text, timestamp, uuid } from 'drizzle-orm/pg-core'
|
import { pgTable, text, timestamp, uuid } from 'drizzle-orm/pg-core'
|
||||||
import { sql } from 'drizzle-orm'
|
import { sql } from 'drizzle-orm'
|
||||||
@@ -131,6 +151,43 @@ export const myTable = pgTable('my_table', {
|
|||||||
})
|
})
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Relations (RQBv2)
|
||||||
|
```typescript
|
||||||
|
// src/server/db/relations.ts
|
||||||
|
import { defineRelations } from 'drizzle-orm'
|
||||||
|
import * as schema from './schema'
|
||||||
|
|
||||||
|
export const relations = defineRelations(schema, (r) => ({
|
||||||
|
// Define relations here using r.one / r.many / r.through
|
||||||
|
}))
|
||||||
|
```
|
||||||
|
|
||||||
|
### DB Instance
|
||||||
|
```typescript
|
||||||
|
// src/server/db/index.ts
|
||||||
|
import { drizzle } from 'drizzle-orm/postgres-js'
|
||||||
|
import { relations } from '@/server/db/relations'
|
||||||
|
// In RQBv2, relations already contain schema info — no separate schema import needed
|
||||||
|
|
||||||
|
const db = drizzle({
|
||||||
|
connection: env.DATABASE_URL,
|
||||||
|
relations,
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
### RQBv2 Query Examples
|
||||||
|
```typescript
|
||||||
|
// Object-style orderBy (NOT callback style)
|
||||||
|
const todos = await db.query.todoTable.findMany({
|
||||||
|
orderBy: { createdAt: 'desc' },
|
||||||
|
})
|
||||||
|
|
||||||
|
// Object-style where
|
||||||
|
const todo = await db.query.todoTable.findFirst({
|
||||||
|
where: { id: someId },
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
## Code Style
|
## Code Style
|
||||||
|
|
||||||
### Formatting (Biome)
|
### Formatting (Biome)
|
||||||
@@ -189,13 +246,24 @@ export const env = createEnv({
|
|||||||
})
|
})
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Development Principles
|
||||||
|
|
||||||
|
> **These principles apply to ALL code changes. Agents MUST follow them on every task.**
|
||||||
|
|
||||||
|
1. **No backward compatibility** — This project is in rapid iteration. Always use the latest API and patterns. Never keep deprecated code paths or old API fallbacks.
|
||||||
|
2. **Always sync documentation** — When code changes, immediately update all related documentation (`AGENTS.md`, `README.md`, inline code examples). Code and docs must never drift apart.
|
||||||
|
3. **Forward-only migration** — When upgrading dependencies, fully adopt the new API. Don't mix old and new patterns.
|
||||||
|
|
||||||
## Critical Rules
|
## Critical Rules
|
||||||
|
|
||||||
**DO:**
|
**DO:**
|
||||||
- Run `bun fix` before committing
|
- Run `bun run fix` before committing
|
||||||
- Use `@/*` path aliases
|
- Use `@/*` path aliases
|
||||||
- Include `createdAt`/`updatedAt` on all tables
|
- Include `createdAt`/`updatedAt` on all tables
|
||||||
- Use `ORPCError` with proper codes
|
- Use `ORPCError` with proper codes
|
||||||
|
- Use `drizzle-orm/zod` (NOT `drizzle-zod`) for schema validation
|
||||||
|
- Use RQBv2 object syntax for `orderBy` and `where`
|
||||||
|
- Update `AGENTS.md` and other docs whenever code patterns change
|
||||||
|
|
||||||
**DON'T:**
|
**DON'T:**
|
||||||
- Use `npm`, `npx`, `node`, `yarn`, `pnpm` — always use `bun` / `bunx`
|
- Use `npm`, `npx`, `node`, `yarn`, `pnpm` — always use `bun` / `bunx`
|
||||||
@@ -203,3 +271,9 @@ export const env = createEnv({
|
|||||||
- Use `as any`, `@ts-ignore`, `@ts-expect-error`
|
- Use `as any`, `@ts-ignore`, `@ts-expect-error`
|
||||||
- Commit `.env` files
|
- Commit `.env` files
|
||||||
- Use empty catch blocks
|
- Use empty catch blocks
|
||||||
|
- Import from `drizzle-zod` (use `drizzle-orm/zod` instead)
|
||||||
|
- Use RQBv1 callback-style `orderBy` / old `relations()` API
|
||||||
|
- Use `drizzle-orm/bun-sql` driver (use `drizzle-orm/postgres-js`)
|
||||||
|
- Pass `schema` to `drizzle()` constructor (only `relations` is needed in RQBv2)
|
||||||
|
- Import `os` from `@orpc/server` in middleware — use `@/server/api/server` (the local typed instance)
|
||||||
|
- Leave docs out of sync with code changes
|
||||||
|
|||||||
@@ -3,5 +3,10 @@
|
|||||||
"extends": "//",
|
"extends": "//",
|
||||||
"files": {
|
"files": {
|
||||||
"includes": ["**", "!**/routeTree.gen.ts"]
|
"includes": ["**", "!**/routeTree.gen.ts"]
|
||||||
|
},
|
||||||
|
"css": {
|
||||||
|
"parser": {
|
||||||
|
"tailwindDirectives": true
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,111 +0,0 @@
|
|||||||
import { rm } from 'node:fs/promises'
|
|
||||||
import path from 'node:path'
|
|
||||||
import process from 'node:process'
|
|
||||||
|
|
||||||
const ALL_TARGETS = [
|
|
||||||
'bun-windows-x64',
|
|
||||||
'bun-darwin-arm64',
|
|
||||||
'bun-darwin-x64',
|
|
||||||
'bun-linux-x64',
|
|
||||||
'bun-linux-arm64',
|
|
||||||
] as const
|
|
||||||
|
|
||||||
type BunTarget = (typeof ALL_TARGETS)[number]
|
|
||||||
|
|
||||||
const ENTRYPOINT = '.output/server/index.mjs'
|
|
||||||
const OUTDIR = 'out'
|
|
||||||
const OUTFILE_BASE = 'server'
|
|
||||||
|
|
||||||
const DEFAULT_TARGETS: BunTarget[] = [
|
|
||||||
'bun-windows-x64',
|
|
||||||
'bun-darwin-arm64',
|
|
||||||
'bun-linux-x64',
|
|
||||||
]
|
|
||||||
|
|
||||||
const suffixFor = (target: BunTarget) => target.replace('bun-', '')
|
|
||||||
|
|
||||||
const isTarget = (value: string): value is BunTarget =>
|
|
||||||
(ALL_TARGETS as readonly string[]).includes(value)
|
|
||||||
|
|
||||||
const parseTargets = (): BunTarget[] => {
|
|
||||||
const args = process.argv.slice(2)
|
|
||||||
const targets: string[] = []
|
|
||||||
|
|
||||||
for (let i = 0; i < args.length; i++) {
|
|
||||||
const arg = args[i]
|
|
||||||
const next = args[i + 1]
|
|
||||||
if (arg === '--target' && next) {
|
|
||||||
targets.push(next)
|
|
||||||
i++
|
|
||||||
} else if (arg === '--targets' && next) {
|
|
||||||
targets.push(...next.split(','))
|
|
||||||
i++
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if (targets.length === 0) return DEFAULT_TARGETS
|
|
||||||
|
|
||||||
const invalid = targets.filter((t) => !isTarget(t))
|
|
||||||
if (invalid.length) {
|
|
||||||
throw new Error(
|
|
||||||
`Unknown target(s): ${invalid.join(', ')}\nAllowed: ${ALL_TARGETS.join(', ')}`,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
return targets as BunTarget[]
|
|
||||||
}
|
|
||||||
|
|
||||||
const buildOne = async (target: BunTarget) => {
|
|
||||||
const suffix = suffixFor(target)
|
|
||||||
const outfile = `${OUTFILE_BASE}-${suffix}`
|
|
||||||
|
|
||||||
const result = await Bun.build({
|
|
||||||
entrypoints: [ENTRYPOINT],
|
|
||||||
outdir: OUTDIR,
|
|
||||||
compile: {
|
|
||||||
outfile,
|
|
||||||
target,
|
|
||||||
},
|
|
||||||
})
|
|
||||||
|
|
||||||
if (!result.success) {
|
|
||||||
throw new Error(
|
|
||||||
`Build failed for ${target}:\n${result.logs.map(String).join('\n')}`,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
return {
|
|
||||||
target,
|
|
||||||
outputs: result.outputs.map((o) => path.relative('.', o.path)),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
const main = async () => {
|
|
||||||
const targets = parseTargets()
|
|
||||||
|
|
||||||
await rm(OUTDIR, { recursive: true, force: true })
|
|
||||||
console.log(`✓ 已清理输出目录: ${OUTDIR}`)
|
|
||||||
|
|
||||||
// Bun cross-compile 不支持真正并行,逐目标串行构建
|
|
||||||
const results: Awaited<ReturnType<typeof buildOne>>[] = []
|
|
||||||
for (const target of targets) {
|
|
||||||
const start = Date.now()
|
|
||||||
process.stdout.write(`🔨 构建 ${target}... `)
|
|
||||||
const result = await buildOne(target)
|
|
||||||
results.push(result)
|
|
||||||
console.log(`完成 (${Date.now() - start}ms)`)
|
|
||||||
}
|
|
||||||
|
|
||||||
console.log('\n📦 构建完成:')
|
|
||||||
for (const r of results) {
|
|
||||||
console.log(` ${r.target}:`)
|
|
||||||
for (const p of r.outputs) {
|
|
||||||
console.log(` - ${p}`)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
main().catch((err) => {
|
|
||||||
console.error('\n❌ 构建失败:')
|
|
||||||
console.error(err instanceof Error ? err.message : err)
|
|
||||||
process.exit(1)
|
|
||||||
})
|
|
||||||
64
apps/server/compile.ts
Normal file
64
apps/server/compile.ts
Normal file
@@ -0,0 +1,64 @@
|
|||||||
|
import { mkdir, rm } from 'node:fs/promises'
|
||||||
|
import { parseArgs } from 'node:util'
|
||||||
|
|
||||||
|
const ENTRYPOINT = '.output/server/index.mjs'
|
||||||
|
const OUTDIR = 'out'
|
||||||
|
|
||||||
|
const SUPPORTED_TARGETS: readonly Bun.Build.CompileTarget[] = [
|
||||||
|
'bun-windows-x64',
|
||||||
|
'bun-darwin-arm64',
|
||||||
|
'bun-darwin-x64',
|
||||||
|
'bun-linux-x64',
|
||||||
|
'bun-linux-arm64',
|
||||||
|
]
|
||||||
|
|
||||||
|
const isSupportedTarget = (value: string): value is Bun.Build.CompileTarget =>
|
||||||
|
(SUPPORTED_TARGETS as readonly string[]).includes(value)
|
||||||
|
|
||||||
|
const { values } = parseArgs({
|
||||||
|
options: { target: { type: 'string' } },
|
||||||
|
strict: true,
|
||||||
|
allowPositionals: false,
|
||||||
|
})
|
||||||
|
|
||||||
|
const resolveTarget = (): Bun.Build.CompileTarget => {
|
||||||
|
if (values.target !== undefined) {
|
||||||
|
if (!isSupportedTarget(values.target)) {
|
||||||
|
throw new Error(`Invalid target: ${values.target}\nAllowed: ${SUPPORTED_TARGETS.join(', ')}`)
|
||||||
|
}
|
||||||
|
return values.target
|
||||||
|
}
|
||||||
|
|
||||||
|
const os = process.platform === 'win32' ? 'windows' : process.platform
|
||||||
|
const candidate = `bun-${os}-${process.arch}`
|
||||||
|
if (!isSupportedTarget(candidate)) {
|
||||||
|
throw new Error(`Unsupported host: ${process.platform}-${process.arch}`)
|
||||||
|
}
|
||||||
|
return candidate
|
||||||
|
}
|
||||||
|
|
||||||
|
const main = async () => {
|
||||||
|
const target = resolveTarget()
|
||||||
|
const suffix = target.replace('bun-', '')
|
||||||
|
const outfile = `server-${suffix}`
|
||||||
|
|
||||||
|
await mkdir(OUTDIR, { recursive: true })
|
||||||
|
await Promise.all([rm(`${OUTDIR}/${outfile}`, { force: true }), rm(`${OUTDIR}/${outfile}.exe`, { force: true })])
|
||||||
|
|
||||||
|
const result = await Bun.build({
|
||||||
|
entrypoints: [ENTRYPOINT],
|
||||||
|
outdir: OUTDIR,
|
||||||
|
compile: { outfile, target },
|
||||||
|
})
|
||||||
|
|
||||||
|
if (!result.success) {
|
||||||
|
throw new Error(result.logs.map(String).join('\n'))
|
||||||
|
}
|
||||||
|
|
||||||
|
console.log(`✓ ${target} → ${OUTDIR}/${outfile}`)
|
||||||
|
}
|
||||||
|
|
||||||
|
main().catch((err) => {
|
||||||
|
console.error('❌', err instanceof Error ? err.message : err)
|
||||||
|
process.exit(1)
|
||||||
|
})
|
||||||
@@ -4,18 +4,25 @@
|
|||||||
"private": true,
|
"private": true,
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "vite build",
|
"build": "bunx --bun vite build",
|
||||||
"compile": "bun build.ts",
|
"compile": "bun compile.ts",
|
||||||
|
"compile:darwin": "bun run compile:darwin:arm64 && bun run compile:darwin:x64",
|
||||||
|
"compile:darwin:arm64": "bun compile.ts --target bun-darwin-arm64",
|
||||||
|
"compile:darwin:x64": "bun compile.ts --target bun-darwin-x64",
|
||||||
|
"compile:linux": "bun run compile:linux:x64 && bun run compile:linux:arm64",
|
||||||
|
"compile:linux:arm64": "bun compile.ts --target bun-linux-arm64",
|
||||||
|
"compile:linux:x64": "bun compile.ts --target bun-linux-x64",
|
||||||
|
"compile:windows": "bun run compile:windows:x64",
|
||||||
|
"compile:windows:x64": "bun compile.ts --target bun-windows-x64",
|
||||||
"db:generate": "drizzle-kit generate",
|
"db:generate": "drizzle-kit generate",
|
||||||
"db:migrate": "drizzle-kit migrate",
|
"db:migrate": "drizzle-kit migrate",
|
||||||
"db:push": "drizzle-kit push",
|
"db:push": "drizzle-kit push",
|
||||||
"db:studio": "drizzle-kit studio",
|
"db:studio": "drizzle-kit studio",
|
||||||
"dev": "vite dev",
|
"dev": "bunx --bun vite dev",
|
||||||
"fix": "biome check --write",
|
"fix": "biome check --write",
|
||||||
"typecheck": "tsc --noEmit"
|
"typecheck": "tsc --noEmit"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@furtherverse/utils": "workspace:*",
|
|
||||||
"@orpc/client": "catalog:",
|
"@orpc/client": "catalog:",
|
||||||
"@orpc/contract": "catalog:",
|
"@orpc/contract": "catalog:",
|
||||||
"@orpc/openapi": "catalog:",
|
"@orpc/openapi": "catalog:",
|
||||||
@@ -28,7 +35,6 @@
|
|||||||
"@tanstack/react-router-ssr-query": "catalog:",
|
"@tanstack/react-router-ssr-query": "catalog:",
|
||||||
"@tanstack/react-start": "catalog:",
|
"@tanstack/react-start": "catalog:",
|
||||||
"drizzle-orm": "catalog:",
|
"drizzle-orm": "catalog:",
|
||||||
"drizzle-zod": "catalog:",
|
|
||||||
"postgres": "catalog:",
|
"postgres": "catalog:",
|
||||||
"react": "catalog:",
|
"react": "catalog:",
|
||||||
"react-dom": "catalog:",
|
"react-dom": "catalog:",
|
||||||
@@ -48,7 +54,6 @@
|
|||||||
"drizzle-kit": "catalog:",
|
"drizzle-kit": "catalog:",
|
||||||
"nitro": "catalog:",
|
"nitro": "catalog:",
|
||||||
"tailwindcss": "catalog:",
|
"tailwindcss": "catalog:",
|
||||||
"vite": "catalog:",
|
"vite": "catalog:"
|
||||||
"vite-tsconfig-paths": "catalog:"
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,24 +0,0 @@
|
|||||||
import { createORPCClient } from '@orpc/client'
|
|
||||||
import { RPCLink } from '@orpc/client/fetch'
|
|
||||||
import { createRouterClient } from '@orpc/server'
|
|
||||||
import { createIsomorphicFn } from '@tanstack/react-start'
|
|
||||||
import { getRequestHeaders } from '@tanstack/react-start/server'
|
|
||||||
import { router } from '@/server/api/routers'
|
|
||||||
import type { RouterClient } from '@/server/api/types'
|
|
||||||
|
|
||||||
const getORPCClient = createIsomorphicFn()
|
|
||||||
.server(() =>
|
|
||||||
createRouterClient(router, {
|
|
||||||
context: () => ({
|
|
||||||
headers: getRequestHeaders(),
|
|
||||||
}),
|
|
||||||
}),
|
|
||||||
)
|
|
||||||
.client(() => {
|
|
||||||
const link = new RPCLink({
|
|
||||||
url: `${window.location.origin}/api/rpc`,
|
|
||||||
})
|
|
||||||
return createORPCClient<RouterClient>(link)
|
|
||||||
})
|
|
||||||
|
|
||||||
export const orpc: RouterClient = getORPCClient()
|
|
||||||
53
apps/server/src/client/orpc.ts
Normal file
53
apps/server/src/client/orpc.ts
Normal file
@@ -0,0 +1,53 @@
|
|||||||
|
import { createORPCClient } from '@orpc/client'
|
||||||
|
import { RPCLink } from '@orpc/client/fetch'
|
||||||
|
import { createRouterClient } from '@orpc/server'
|
||||||
|
import { createTanstackQueryUtils } from '@orpc/tanstack-query'
|
||||||
|
import { createIsomorphicFn } from '@tanstack/react-start'
|
||||||
|
import { getRequestHeaders } from '@tanstack/react-start/server'
|
||||||
|
import { router } from '@/server/api/routers'
|
||||||
|
import type { RouterClient } from '@/server/api/types'
|
||||||
|
|
||||||
|
const getORPCClient = createIsomorphicFn()
|
||||||
|
.server(() =>
|
||||||
|
createRouterClient(router, {
|
||||||
|
context: () => ({
|
||||||
|
headers: getRequestHeaders(),
|
||||||
|
}),
|
||||||
|
}),
|
||||||
|
)
|
||||||
|
.client(() => {
|
||||||
|
const link = new RPCLink({
|
||||||
|
url: `${window.location.origin}/api/rpc`,
|
||||||
|
})
|
||||||
|
return createORPCClient<RouterClient>(link)
|
||||||
|
})
|
||||||
|
|
||||||
|
const client: RouterClient = getORPCClient()
|
||||||
|
|
||||||
|
export const orpc = createTanstackQueryUtils(client, {
|
||||||
|
experimental_defaults: {
|
||||||
|
todo: {
|
||||||
|
create: {
|
||||||
|
mutationOptions: {
|
||||||
|
onSuccess: (_, __, ___, ctx) => {
|
||||||
|
ctx.client.invalidateQueries({ queryKey: orpc.todo.list.key() })
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
update: {
|
||||||
|
mutationOptions: {
|
||||||
|
onSuccess: (_, __, ___, ctx) => {
|
||||||
|
ctx.client.invalidateQueries({ queryKey: orpc.todo.list.key() })
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
remove: {
|
||||||
|
mutationOptions: {
|
||||||
|
onSuccess: (_, __, ___, ctx) => {
|
||||||
|
ctx.client.invalidateQueries({ queryKey: orpc.todo.list.key() })
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
})
|
||||||
@@ -1,30 +0,0 @@
|
|||||||
import { createTanstackQueryUtils } from '@orpc/tanstack-query'
|
|
||||||
import { orpc as orpcClient } from './orpc.client'
|
|
||||||
|
|
||||||
export const orpc = createTanstackQueryUtils(orpcClient, {
|
|
||||||
experimental_defaults: {
|
|
||||||
todo: {
|
|
||||||
create: {
|
|
||||||
mutationOptions: {
|
|
||||||
onSuccess: (_, __, ___, ctx) => {
|
|
||||||
ctx.client.invalidateQueries({ queryKey: orpc.todo.list.key() })
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
update: {
|
|
||||||
mutationOptions: {
|
|
||||||
onSuccess: (_, __, ___, ctx) => {
|
|
||||||
ctx.client.invalidateQueries({ queryKey: orpc.todo.list.key() })
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
remove: {
|
|
||||||
mutationOptions: {
|
|
||||||
onSuccess: (_, __, ___, ctx) => {
|
|
||||||
ctx.client.invalidateQueries({ queryKey: orpc.todo.list.key() })
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
})
|
|
||||||
@@ -10,6 +10,7 @@
|
|||||||
|
|
||||||
import { Route as rootRouteImport } from './routes/__root'
|
import { Route as rootRouteImport } from './routes/__root'
|
||||||
import { Route as IndexRouteImport } from './routes/index'
|
import { Route as IndexRouteImport } from './routes/index'
|
||||||
|
import { Route as ApiHealthRouteImport } from './routes/api/health'
|
||||||
import { Route as ApiSplatRouteImport } from './routes/api/$'
|
import { Route as ApiSplatRouteImport } from './routes/api/$'
|
||||||
import { Route as ApiRpcSplatRouteImport } from './routes/api/rpc.$'
|
import { Route as ApiRpcSplatRouteImport } from './routes/api/rpc.$'
|
||||||
|
|
||||||
@@ -18,6 +19,11 @@ const IndexRoute = IndexRouteImport.update({
|
|||||||
path: '/',
|
path: '/',
|
||||||
getParentRoute: () => rootRouteImport,
|
getParentRoute: () => rootRouteImport,
|
||||||
} as any)
|
} as any)
|
||||||
|
const ApiHealthRoute = ApiHealthRouteImport.update({
|
||||||
|
id: '/api/health',
|
||||||
|
path: '/api/health',
|
||||||
|
getParentRoute: () => rootRouteImport,
|
||||||
|
} as any)
|
||||||
const ApiSplatRoute = ApiSplatRouteImport.update({
|
const ApiSplatRoute = ApiSplatRouteImport.update({
|
||||||
id: '/api/$',
|
id: '/api/$',
|
||||||
path: '/api/$',
|
path: '/api/$',
|
||||||
@@ -32,30 +38,34 @@ const ApiRpcSplatRoute = ApiRpcSplatRouteImport.update({
|
|||||||
export interface FileRoutesByFullPath {
|
export interface FileRoutesByFullPath {
|
||||||
'/': typeof IndexRoute
|
'/': typeof IndexRoute
|
||||||
'/api/$': typeof ApiSplatRoute
|
'/api/$': typeof ApiSplatRoute
|
||||||
|
'/api/health': typeof ApiHealthRoute
|
||||||
'/api/rpc/$': typeof ApiRpcSplatRoute
|
'/api/rpc/$': typeof ApiRpcSplatRoute
|
||||||
}
|
}
|
||||||
export interface FileRoutesByTo {
|
export interface FileRoutesByTo {
|
||||||
'/': typeof IndexRoute
|
'/': typeof IndexRoute
|
||||||
'/api/$': typeof ApiSplatRoute
|
'/api/$': typeof ApiSplatRoute
|
||||||
|
'/api/health': typeof ApiHealthRoute
|
||||||
'/api/rpc/$': typeof ApiRpcSplatRoute
|
'/api/rpc/$': typeof ApiRpcSplatRoute
|
||||||
}
|
}
|
||||||
export interface FileRoutesById {
|
export interface FileRoutesById {
|
||||||
__root__: typeof rootRouteImport
|
__root__: typeof rootRouteImport
|
||||||
'/': typeof IndexRoute
|
'/': typeof IndexRoute
|
||||||
'/api/$': typeof ApiSplatRoute
|
'/api/$': typeof ApiSplatRoute
|
||||||
|
'/api/health': typeof ApiHealthRoute
|
||||||
'/api/rpc/$': typeof ApiRpcSplatRoute
|
'/api/rpc/$': typeof ApiRpcSplatRoute
|
||||||
}
|
}
|
||||||
export interface FileRouteTypes {
|
export interface FileRouteTypes {
|
||||||
fileRoutesByFullPath: FileRoutesByFullPath
|
fileRoutesByFullPath: FileRoutesByFullPath
|
||||||
fullPaths: '/' | '/api/$' | '/api/rpc/$'
|
fullPaths: '/' | '/api/$' | '/api/health' | '/api/rpc/$'
|
||||||
fileRoutesByTo: FileRoutesByTo
|
fileRoutesByTo: FileRoutesByTo
|
||||||
to: '/' | '/api/$' | '/api/rpc/$'
|
to: '/' | '/api/$' | '/api/health' | '/api/rpc/$'
|
||||||
id: '__root__' | '/' | '/api/$' | '/api/rpc/$'
|
id: '__root__' | '/' | '/api/$' | '/api/health' | '/api/rpc/$'
|
||||||
fileRoutesById: FileRoutesById
|
fileRoutesById: FileRoutesById
|
||||||
}
|
}
|
||||||
export interface RootRouteChildren {
|
export interface RootRouteChildren {
|
||||||
IndexRoute: typeof IndexRoute
|
IndexRoute: typeof IndexRoute
|
||||||
ApiSplatRoute: typeof ApiSplatRoute
|
ApiSplatRoute: typeof ApiSplatRoute
|
||||||
|
ApiHealthRoute: typeof ApiHealthRoute
|
||||||
ApiRpcSplatRoute: typeof ApiRpcSplatRoute
|
ApiRpcSplatRoute: typeof ApiRpcSplatRoute
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -68,6 +78,13 @@ declare module '@tanstack/react-router' {
|
|||||||
preLoaderRoute: typeof IndexRouteImport
|
preLoaderRoute: typeof IndexRouteImport
|
||||||
parentRoute: typeof rootRouteImport
|
parentRoute: typeof rootRouteImport
|
||||||
}
|
}
|
||||||
|
'/api/health': {
|
||||||
|
id: '/api/health'
|
||||||
|
path: '/api/health'
|
||||||
|
fullPath: '/api/health'
|
||||||
|
preLoaderRoute: typeof ApiHealthRouteImport
|
||||||
|
parentRoute: typeof rootRouteImport
|
||||||
|
}
|
||||||
'/api/$': {
|
'/api/$': {
|
||||||
id: '/api/$'
|
id: '/api/$'
|
||||||
path: '/api/$'
|
path: '/api/$'
|
||||||
@@ -88,6 +105,7 @@ declare module '@tanstack/react-router' {
|
|||||||
const rootRouteChildren: RootRouteChildren = {
|
const rootRouteChildren: RootRouteChildren = {
|
||||||
IndexRoute: IndexRoute,
|
IndexRoute: IndexRoute,
|
||||||
ApiSplatRoute: ApiSplatRoute,
|
ApiSplatRoute: ApiSplatRoute,
|
||||||
|
ApiHealthRoute: ApiHealthRoute,
|
||||||
ApiRpcSplatRoute: ApiRpcSplatRoute,
|
ApiRpcSplatRoute: ApiRpcSplatRoute,
|
||||||
}
|
}
|
||||||
export const routeTree = rootRouteImport
|
export const routeTree = rootRouteImport
|
||||||
|
|||||||
@@ -5,7 +5,14 @@ import type { RouterContext } from './routes/__root'
|
|||||||
import { routeTree } from './routeTree.gen'
|
import { routeTree } from './routeTree.gen'
|
||||||
|
|
||||||
export const getRouter = () => {
|
export const getRouter = () => {
|
||||||
const queryClient = new QueryClient()
|
const queryClient = new QueryClient({
|
||||||
|
defaultOptions: {
|
||||||
|
queries: {
|
||||||
|
staleTime: 30 * 1000,
|
||||||
|
retry: 1,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
const router = createRouter({
|
const router = createRouter({
|
||||||
routeTree,
|
routeTree,
|
||||||
|
|||||||
@@ -1,15 +1,11 @@
|
|||||||
import { TanStackDevtools } from '@tanstack/react-devtools'
|
import { TanStackDevtools } from '@tanstack/react-devtools'
|
||||||
import type { QueryClient } from '@tanstack/react-query'
|
import type { QueryClient } from '@tanstack/react-query'
|
||||||
import { ReactQueryDevtoolsPanel } from '@tanstack/react-query-devtools'
|
import { ReactQueryDevtoolsPanel } from '@tanstack/react-query-devtools'
|
||||||
import {
|
import { createRootRouteWithContext, HeadContent, Scripts } from '@tanstack/react-router'
|
||||||
createRootRouteWithContext,
|
|
||||||
HeadContent,
|
|
||||||
Scripts,
|
|
||||||
} from '@tanstack/react-router'
|
|
||||||
import { TanStackRouterDevtoolsPanel } from '@tanstack/react-router-devtools'
|
import { TanStackRouterDevtoolsPanel } from '@tanstack/react-router-devtools'
|
||||||
import type { ReactNode } from 'react'
|
import type { ReactNode } from 'react'
|
||||||
import { ErrorComponent } from '@/components/Error'
|
import { ErrorComponent } from '@/components/Error'
|
||||||
import { NotFoundComponent } from '@/components/NotFount'
|
import { NotFoundComponent } from '@/components/NotFound'
|
||||||
import appCss from '@/styles.css?url'
|
import appCss from '@/styles.css?url'
|
||||||
|
|
||||||
export interface RouterContext {
|
export interface RouterContext {
|
||||||
@@ -50,6 +46,7 @@ function RootDocument({ children }: Readonly<{ children: ReactNode }>) {
|
|||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
{children}
|
{children}
|
||||||
|
{import.meta.env.DEV && (
|
||||||
<TanStackDevtools
|
<TanStackDevtools
|
||||||
config={{
|
config={{
|
||||||
position: 'bottom-right',
|
position: 'bottom-right',
|
||||||
@@ -65,6 +62,7 @@ function RootDocument({ children }: Readonly<{ children: ReactNode }>) {
|
|||||||
},
|
},
|
||||||
]}
|
]}
|
||||||
/>
|
/>
|
||||||
|
)}
|
||||||
<Scripts />
|
<Scripts />
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
||||||
|
|||||||
@@ -1,10 +1,10 @@
|
|||||||
import { OpenAPIHandler } from '@orpc/openapi/fetch'
|
import { OpenAPIHandler } from '@orpc/openapi/fetch'
|
||||||
import { OpenAPIReferencePlugin } from '@orpc/openapi/plugins'
|
import { OpenAPIReferencePlugin } from '@orpc/openapi/plugins'
|
||||||
import { ORPCError, onError, ValidationError } from '@orpc/server'
|
import { onError } from '@orpc/server'
|
||||||
import { ZodToJsonSchemaConverter } from '@orpc/zod/zod4'
|
import { ZodToJsonSchemaConverter } from '@orpc/zod/zod4'
|
||||||
import { createFileRoute } from '@tanstack/react-router'
|
import { createFileRoute } from '@tanstack/react-router'
|
||||||
import { z } from 'zod'
|
|
||||||
import { name, version } from '@/../package.json'
|
import { name, version } from '@/../package.json'
|
||||||
|
import { handleValidationError, logError } from '@/server/api/interceptors'
|
||||||
import { router } from '@/server/api/routers'
|
import { router } from '@/server/api/routers'
|
||||||
|
|
||||||
const handler = new OpenAPIHandler(router, {
|
const handler = new OpenAPIHandler(router, {
|
||||||
@@ -17,55 +17,13 @@ const handler = new OpenAPIHandler(router, {
|
|||||||
title: name,
|
title: name,
|
||||||
version,
|
version,
|
||||||
},
|
},
|
||||||
// components: {
|
|
||||||
// securitySchemes: {
|
|
||||||
// bearerAuth: {
|
|
||||||
// type: 'http',
|
|
||||||
// scheme: 'bearer',
|
|
||||||
// },
|
|
||||||
// },
|
|
||||||
// },
|
|
||||||
},
|
},
|
||||||
docsPath: '/docs',
|
docsPath: '/docs',
|
||||||
specPath: '/spec.json',
|
specPath: '/spec.json',
|
||||||
}),
|
}),
|
||||||
],
|
],
|
||||||
interceptors: [
|
interceptors: [onError(logError)],
|
||||||
onError((error) => {
|
clientInterceptors: [onError(handleValidationError)],
|
||||||
console.error(error)
|
|
||||||
}),
|
|
||||||
],
|
|
||||||
clientInterceptors: [
|
|
||||||
onError((error) => {
|
|
||||||
if (
|
|
||||||
error instanceof ORPCError &&
|
|
||||||
error.code === 'BAD_REQUEST' &&
|
|
||||||
error.cause instanceof ValidationError
|
|
||||||
) {
|
|
||||||
// If you only use Zod you can safely cast to ZodIssue[]
|
|
||||||
const zodError = new z.ZodError(
|
|
||||||
error.cause.issues as z.core.$ZodIssue[],
|
|
||||||
)
|
|
||||||
|
|
||||||
throw new ORPCError('INPUT_VALIDATION_FAILED', {
|
|
||||||
status: 422,
|
|
||||||
message: z.prettifyError(zodError),
|
|
||||||
data: z.flattenError(zodError),
|
|
||||||
cause: error.cause,
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
if (
|
|
||||||
error instanceof ORPCError &&
|
|
||||||
error.code === 'INTERNAL_SERVER_ERROR' &&
|
|
||||||
error.cause instanceof ValidationError
|
|
||||||
) {
|
|
||||||
throw new ORPCError('OUTPUT_VALIDATION_FAILED', {
|
|
||||||
cause: error.cause,
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}),
|
|
||||||
],
|
|
||||||
})
|
})
|
||||||
|
|
||||||
export const Route = createFileRoute('/api/$')({
|
export const Route = createFileRoute('/api/$')({
|
||||||
|
|||||||
27
apps/server/src/routes/api/health.ts
Normal file
27
apps/server/src/routes/api/health.ts
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
import { createFileRoute } from '@tanstack/react-router'
|
||||||
|
import { name, version } from '@/../package.json'
|
||||||
|
|
||||||
|
const createHealthResponse = (): Response =>
|
||||||
|
Response.json(
|
||||||
|
{
|
||||||
|
status: 'ok',
|
||||||
|
service: name,
|
||||||
|
version,
|
||||||
|
timestamp: new Date().toISOString(),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
status: 200,
|
||||||
|
headers: {
|
||||||
|
'cache-control': 'no-store',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
export const Route = createFileRoute('/api/health')({
|
||||||
|
server: {
|
||||||
|
handlers: {
|
||||||
|
GET: async () => createHealthResponse(),
|
||||||
|
HEAD: async () => new Response(null, { status: 200 }),
|
||||||
|
},
|
||||||
|
},
|
||||||
|
})
|
||||||
@@ -1,46 +1,12 @@
|
|||||||
import { ORPCError, onError, ValidationError } from '@orpc/server'
|
import { onError } from '@orpc/server'
|
||||||
import { RPCHandler } from '@orpc/server/fetch'
|
import { RPCHandler } from '@orpc/server/fetch'
|
||||||
import { createFileRoute } from '@tanstack/react-router'
|
import { createFileRoute } from '@tanstack/react-router'
|
||||||
import { z } from 'zod'
|
import { handleValidationError, logError } from '@/server/api/interceptors'
|
||||||
import { router } from '@/server/api/routers'
|
import { router } from '@/server/api/routers'
|
||||||
|
|
||||||
const handler = new RPCHandler(router, {
|
const handler = new RPCHandler(router, {
|
||||||
interceptors: [
|
interceptors: [onError(logError)],
|
||||||
onError((error) => {
|
clientInterceptors: [onError(handleValidationError)],
|
||||||
console.error(error)
|
|
||||||
}),
|
|
||||||
],
|
|
||||||
clientInterceptors: [
|
|
||||||
onError((error) => {
|
|
||||||
if (
|
|
||||||
error instanceof ORPCError &&
|
|
||||||
error.code === 'BAD_REQUEST' &&
|
|
||||||
error.cause instanceof ValidationError
|
|
||||||
) {
|
|
||||||
// If you only use Zod you can safely cast to ZodIssue[]
|
|
||||||
const zodError = new z.ZodError(
|
|
||||||
error.cause.issues as z.core.$ZodIssue[],
|
|
||||||
)
|
|
||||||
|
|
||||||
throw new ORPCError('INPUT_VALIDATION_FAILED', {
|
|
||||||
status: 422,
|
|
||||||
message: z.prettifyError(zodError),
|
|
||||||
data: z.flattenError(zodError),
|
|
||||||
cause: error.cause,
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
if (
|
|
||||||
error instanceof ORPCError &&
|
|
||||||
error.code === 'INTERNAL_SERVER_ERROR' &&
|
|
||||||
error.cause instanceof ValidationError
|
|
||||||
) {
|
|
||||||
throw new ORPCError('OUTPUT_VALIDATION_FAILED', {
|
|
||||||
cause: error.cause,
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}),
|
|
||||||
],
|
|
||||||
})
|
})
|
||||||
|
|
||||||
export const Route = createFileRoute('/api/rpc/$')({
|
export const Route = createFileRoute('/api/rpc/$')({
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
import { useMutation, useSuspenseQuery } from '@tanstack/react-query'
|
import { useMutation, useSuspenseQuery } from '@tanstack/react-query'
|
||||||
import { createFileRoute } from '@tanstack/react-router'
|
import { createFileRoute } from '@tanstack/react-router'
|
||||||
import type { ChangeEventHandler, FormEventHandler } from 'react'
|
import type { ChangeEventHandler, SubmitEventHandler } from 'react'
|
||||||
import { useState } from 'react'
|
import { useState } from 'react'
|
||||||
import { orpc } from '@/client/query-client'
|
import { orpc } from '@/client/orpc'
|
||||||
|
|
||||||
export const Route = createFileRoute('/')({
|
export const Route = createFileRoute('/')({
|
||||||
component: Todos,
|
component: Todos,
|
||||||
@@ -19,7 +19,7 @@ function Todos() {
|
|||||||
const updateMutation = useMutation(orpc.todo.update.mutationOptions())
|
const updateMutation = useMutation(orpc.todo.update.mutationOptions())
|
||||||
const deleteMutation = useMutation(orpc.todo.remove.mutationOptions())
|
const deleteMutation = useMutation(orpc.todo.remove.mutationOptions())
|
||||||
|
|
||||||
const handleCreateTodo: FormEventHandler<HTMLFormElement> = (e) => {
|
const handleCreateTodo: SubmitEventHandler<HTMLFormElement> = (e) => {
|
||||||
e.preventDefault()
|
e.preventDefault()
|
||||||
if (newTodoTitle.trim()) {
|
if (newTodoTitle.trim()) {
|
||||||
createMutation.mutate({ title: newTodoTitle.trim() })
|
createMutation.mutate({ title: newTodoTitle.trim() })
|
||||||
@@ -53,9 +53,7 @@ function Todos() {
|
|||||||
{/* Header */}
|
{/* Header */}
|
||||||
<div className="flex items-end justify-between">
|
<div className="flex items-end justify-between">
|
||||||
<div>
|
<div>
|
||||||
<h1 className="text-3xl font-bold text-slate-900 tracking-tight">
|
<h1 className="text-3xl font-bold text-slate-900 tracking-tight">我的待办</h1>
|
||||||
我的待办
|
|
||||||
</h1>
|
|
||||||
<p className="text-slate-500 mt-1">保持专注,逐个击破</p>
|
<p className="text-slate-500 mt-1">保持专注,逐个击破</p>
|
||||||
</div>
|
</div>
|
||||||
<div className="text-right">
|
<div className="text-right">
|
||||||
@@ -63,9 +61,7 @@ function Todos() {
|
|||||||
{completedCount}
|
{completedCount}
|
||||||
<span className="text-slate-400 text-lg">/{totalCount}</span>
|
<span className="text-slate-400 text-lg">/{totalCount}</span>
|
||||||
</div>
|
</div>
|
||||||
<div className="text-xs font-medium text-slate-400 uppercase tracking-wider">
|
<div className="text-xs font-medium text-slate-400 uppercase tracking-wider">已完成</div>
|
||||||
已完成
|
|
||||||
</div>
|
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@@ -112,18 +108,11 @@ function Todos() {
|
|||||||
stroke="currentColor"
|
stroke="currentColor"
|
||||||
aria-hidden="true"
|
aria-hidden="true"
|
||||||
>
|
>
|
||||||
<path
|
<path strokeLinecap="round" strokeLinejoin="round" strokeWidth={1.5} d="M12 6v6m0 0v6m0-6h6m-6 0H6" />
|
||||||
strokeLinecap="round"
|
|
||||||
strokeLinejoin="round"
|
|
||||||
strokeWidth={1.5}
|
|
||||||
d="M12 6v6m0 0v6m0-6h6m-6 0H6"
|
|
||||||
/>
|
|
||||||
</svg>
|
</svg>
|
||||||
</div>
|
</div>
|
||||||
<p className="text-slate-500 text-lg font-medium">没有待办事项</p>
|
<p className="text-slate-500 text-lg font-medium">没有待办事项</p>
|
||||||
<p className="text-slate-400 text-sm mt-1">
|
<p className="text-slate-400 text-sm mt-1">输入上方内容添加您的第一个任务</p>
|
||||||
输入上方内容添加您的第一个任务
|
|
||||||
</p>
|
|
||||||
</div>
|
</div>
|
||||||
) : (
|
) : (
|
||||||
todos.map((todo) => (
|
todos.map((todo) => (
|
||||||
@@ -151,11 +140,7 @@ function Todos() {
|
|||||||
strokeWidth={3}
|
strokeWidth={3}
|
||||||
aria-hidden="true"
|
aria-hidden="true"
|
||||||
>
|
>
|
||||||
<path
|
<path strokeLinecap="round" strokeLinejoin="round" d="M5 13l4 4L19 7" />
|
||||||
strokeLinecap="round"
|
|
||||||
strokeLinejoin="round"
|
|
||||||
d="M5 13l4 4L19 7"
|
|
||||||
/>
|
|
||||||
</svg>
|
</svg>
|
||||||
)}
|
)}
|
||||||
</button>
|
</button>
|
||||||
|
|||||||
@@ -1,25 +1,14 @@
|
|||||||
import { oc } from '@orpc/contract'
|
import { oc } from '@orpc/contract'
|
||||||
import {
|
import { createInsertSchema, createSelectSchema, createUpdateSchema } from 'drizzle-orm/zod'
|
||||||
createInsertSchema,
|
|
||||||
createSelectSchema,
|
|
||||||
createUpdateSchema,
|
|
||||||
} from 'drizzle-zod'
|
|
||||||
import { z } from 'zod'
|
import { z } from 'zod'
|
||||||
|
import { generatedFieldKeys } from '@/server/db/fields'
|
||||||
import { todoTable } from '@/server/db/schema'
|
import { todoTable } from '@/server/db/schema'
|
||||||
|
|
||||||
const selectSchema = createSelectSchema(todoTable)
|
const selectSchema = createSelectSchema(todoTable)
|
||||||
|
|
||||||
const insertSchema = createInsertSchema(todoTable).omit({
|
const insertSchema = createInsertSchema(todoTable).omit(generatedFieldKeys)
|
||||||
id: true,
|
|
||||||
createdAt: true,
|
|
||||||
updatedAt: true,
|
|
||||||
})
|
|
||||||
|
|
||||||
const updateSchema = createUpdateSchema(todoTable).omit({
|
const updateSchema = createUpdateSchema(todoTable).omit(generatedFieldKeys)
|
||||||
id: true,
|
|
||||||
createdAt: true,
|
|
||||||
updatedAt: true,
|
|
||||||
})
|
|
||||||
|
|
||||||
export const list = oc.input(z.void()).output(z.array(selectSchema))
|
export const list = oc.input(z.void()).output(z.array(selectSchema))
|
||||||
|
|
||||||
|
|||||||
26
apps/server/src/server/api/interceptors.ts
Normal file
26
apps/server/src/server/api/interceptors.ts
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
import { ORPCError, ValidationError } from '@orpc/server'
|
||||||
|
import { z } from 'zod'
|
||||||
|
|
||||||
|
export const logError = (error: unknown) => {
|
||||||
|
console.error(error)
|
||||||
|
}
|
||||||
|
|
||||||
|
export const handleValidationError = (error: unknown) => {
|
||||||
|
if (error instanceof ORPCError && error.code === 'BAD_REQUEST' && error.cause instanceof ValidationError) {
|
||||||
|
// If you only use Zod you can safely cast to ZodIssue[] (per ORPC official docs)
|
||||||
|
const zodError = new z.ZodError(error.cause.issues as z.core.$ZodIssue[])
|
||||||
|
|
||||||
|
throw new ORPCError('INPUT_VALIDATION_FAILED', {
|
||||||
|
status: 422,
|
||||||
|
message: z.prettifyError(zodError),
|
||||||
|
data: z.flattenError(zodError),
|
||||||
|
cause: error.cause,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
if (error instanceof ORPCError && error.code === 'INTERNAL_SERVER_ERROR' && error.cause instanceof ValidationError) {
|
||||||
|
throw new ORPCError('OUTPUT_VALIDATION_FAILED', {
|
||||||
|
cause: error.cause,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
import { os } from '@orpc/server'
|
import { os } from '@/server/api/server'
|
||||||
import { getDB } from '@/server/db'
|
import { getDB } from '@/server/db'
|
||||||
|
|
||||||
export const db = os.middleware(async ({ context, next }) => {
|
export const db = os.middleware(async ({ context, next }) => {
|
||||||
|
|||||||
@@ -6,34 +6,23 @@ import { os } from '../server'
|
|||||||
|
|
||||||
export const list = os.todo.list.use(db).handler(async ({ context }) => {
|
export const list = os.todo.list.use(db).handler(async ({ context }) => {
|
||||||
const todos = await context.db.query.todoTable.findMany({
|
const todos = await context.db.query.todoTable.findMany({
|
||||||
orderBy: (todos, { desc }) => [desc(todos.createdAt)],
|
orderBy: { createdAt: 'desc' },
|
||||||
})
|
})
|
||||||
return todos
|
return todos
|
||||||
})
|
})
|
||||||
|
|
||||||
export const create = os.todo.create
|
export const create = os.todo.create.use(db).handler(async ({ context, input }) => {
|
||||||
.use(db)
|
const [newTodo] = await context.db.insert(todoTable).values(input).returning()
|
||||||
.handler(async ({ context, input }) => {
|
|
||||||
const [newTodo] = await context.db
|
|
||||||
.insert(todoTable)
|
|
||||||
.values(input)
|
|
||||||
.returning()
|
|
||||||
|
|
||||||
if (!newTodo) {
|
if (!newTodo) {
|
||||||
throw new ORPCError('NOT_FOUND')
|
throw new ORPCError('INTERNAL_SERVER_ERROR', { message: 'Failed to create todo' })
|
||||||
}
|
}
|
||||||
|
|
||||||
return newTodo
|
return newTodo
|
||||||
})
|
})
|
||||||
|
|
||||||
export const update = os.todo.update
|
export const update = os.todo.update.use(db).handler(async ({ context, input }) => {
|
||||||
.use(db)
|
const [updatedTodo] = await context.db.update(todoTable).set(input.data).where(eq(todoTable.id, input.id)).returning()
|
||||||
.handler(async ({ context, input }) => {
|
|
||||||
const [updatedTodo] = await context.db
|
|
||||||
.update(todoTable)
|
|
||||||
.set(input.data)
|
|
||||||
.where(eq(todoTable.id, input.id))
|
|
||||||
.returning()
|
|
||||||
|
|
||||||
if (!updatedTodo) {
|
if (!updatedTodo) {
|
||||||
throw new ORPCError('NOT_FOUND')
|
throw new ORPCError('NOT_FOUND')
|
||||||
@@ -42,8 +31,10 @@ export const update = os.todo.update
|
|||||||
return updatedTodo
|
return updatedTodo
|
||||||
})
|
})
|
||||||
|
|
||||||
export const remove = os.todo.remove
|
export const remove = os.todo.remove.use(db).handler(async ({ context, input }) => {
|
||||||
.use(db)
|
const [deleted] = await context.db.delete(todoTable).where(eq(todoTable.id, input.id)).returning({ id: todoTable.id })
|
||||||
.handler(async ({ context, input }) => {
|
|
||||||
await context.db.delete(todoTable).where(eq(todoTable.id, input.id))
|
if (!deleted) {
|
||||||
|
throw new ORPCError('NOT_FOUND')
|
||||||
|
}
|
||||||
})
|
})
|
||||||
|
|||||||
@@ -1,8 +1,4 @@
|
|||||||
import type {
|
import type { ContractRouterClient, InferContractRouterInputs, InferContractRouterOutputs } from '@orpc/contract'
|
||||||
ContractRouterClient,
|
|
||||||
InferContractRouterInputs,
|
|
||||||
InferContractRouterOutputs,
|
|
||||||
} from '@orpc/contract'
|
|
||||||
import type { Contract } from './contracts'
|
import type { Contract } from './contracts'
|
||||||
|
|
||||||
export type RouterClient = ContractRouterClient<Contract>
|
export type RouterClient = ContractRouterClient<Contract>
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ import { v7 as uuidv7 } from 'uuid'
|
|||||||
|
|
||||||
// id
|
// id
|
||||||
|
|
||||||
export const id = (name: string) => uuid(name)
|
const id = (name: string) => uuid(name)
|
||||||
export const pk = (name: string, strategy?: 'native' | 'extension') => {
|
export const pk = (name: string, strategy?: 'native' | 'extension') => {
|
||||||
switch (strategy) {
|
switch (strategy) {
|
||||||
// PG 18+
|
// PG 18+
|
||||||
@@ -25,8 +25,7 @@ export const pk = (name: string, strategy?: 'native' | 'extension') => {
|
|||||||
|
|
||||||
// timestamp
|
// timestamp
|
||||||
|
|
||||||
export const createdAt = (name = 'created_at') =>
|
export const createdAt = (name = 'created_at') => timestamp(name, { withTimezone: true }).notNull().defaultNow()
|
||||||
timestamp(name, { withTimezone: true }).notNull().defaultNow()
|
|
||||||
|
|
||||||
export const updatedAt = (name = 'updated_at') =>
|
export const updatedAt = (name = 'updated_at') =>
|
||||||
timestamp(name, { withTimezone: true })
|
timestamp(name, { withTimezone: true })
|
||||||
@@ -43,9 +42,7 @@ export const generatedFields = {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Helper to create omit keys from generatedFields
|
// Helper to create omit keys from generatedFields
|
||||||
const createGeneratedFieldKeys = <T extends Record<string, unknown>>(
|
const createGeneratedFieldKeys = <T extends Record<string, unknown>>(fields: T): Record<keyof T, true> => {
|
||||||
fields: T,
|
|
||||||
): Record<keyof T, true> => {
|
|
||||||
return Object.keys(fields).reduce(
|
return Object.keys(fields).reduce(
|
||||||
(acc, key) => {
|
(acc, key) => {
|
||||||
acc[key as keyof T] = true
|
acc[key as keyof T] = true
|
||||||
@@ -1,14 +1,11 @@
|
|||||||
import { drizzle } from 'drizzle-orm/postgres-js'
|
import { drizzle } from 'drizzle-orm/postgres-js'
|
||||||
import { env } from '@/env'
|
import { env } from '@/env'
|
||||||
import * as schema from '@/server/db/schema'
|
import { relations } from '@/server/db/relations'
|
||||||
|
|
||||||
export const createDB = () =>
|
export const createDB = () =>
|
||||||
drizzle({
|
drizzle({
|
||||||
connection: {
|
connection: env.DATABASE_URL,
|
||||||
url: env.DATABASE_URL,
|
relations,
|
||||||
prepare: true,
|
|
||||||
},
|
|
||||||
schema,
|
|
||||||
})
|
})
|
||||||
|
|
||||||
export type DB = ReturnType<typeof createDB>
|
export type DB = ReturnType<typeof createDB>
|
||||||
|
|||||||
4
apps/server/src/server/db/relations.ts
Normal file
4
apps/server/src/server/db/relations.ts
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
import { defineRelations } from 'drizzle-orm'
|
||||||
|
import * as schema from './schema'
|
||||||
|
|
||||||
|
export const relations = defineRelations(schema, (_r) => ({}))
|
||||||
@@ -1,5 +1,5 @@
|
|||||||
import { boolean, pgTable, text } from 'drizzle-orm/pg-core'
|
import { boolean, pgTable, text } from 'drizzle-orm/pg-core'
|
||||||
import { generatedFields } from './utils/field'
|
import { generatedFields } from '../fields'
|
||||||
|
|
||||||
export const todoTable = pgTable('todo', {
|
export const todoTable = pgTable('todo', {
|
||||||
...generatedFields,
|
...generatedFields,
|
||||||
|
|||||||
@@ -4,9 +4,43 @@
|
|||||||
"tasks": {
|
"tasks": {
|
||||||
"build": {
|
"build": {
|
||||||
"env": ["NODE_ENV", "VITE_*"],
|
"env": ["NODE_ENV", "VITE_*"],
|
||||||
|
"inputs": ["src/**", "public/**", "package.json", "tsconfig.json", "vite.config.ts"],
|
||||||
"outputs": [".output/**"]
|
"outputs": [".output/**"]
|
||||||
},
|
},
|
||||||
"compile": {
|
"compile": {
|
||||||
|
"dependsOn": ["build"],
|
||||||
|
"outputs": ["out/**"]
|
||||||
|
},
|
||||||
|
"compile:darwin": {
|
||||||
|
"dependsOn": ["build"],
|
||||||
|
"outputs": ["out/**"]
|
||||||
|
},
|
||||||
|
"compile:darwin:arm64": {
|
||||||
|
"dependsOn": ["build"],
|
||||||
|
"outputs": ["out/**"]
|
||||||
|
},
|
||||||
|
"compile:darwin:x64": {
|
||||||
|
"dependsOn": ["build"],
|
||||||
|
"outputs": ["out/**"]
|
||||||
|
},
|
||||||
|
"compile:linux": {
|
||||||
|
"dependsOn": ["build"],
|
||||||
|
"outputs": ["out/**"]
|
||||||
|
},
|
||||||
|
"compile:linux:arm64": {
|
||||||
|
"dependsOn": ["build"],
|
||||||
|
"outputs": ["out/**"]
|
||||||
|
},
|
||||||
|
"compile:linux:x64": {
|
||||||
|
"dependsOn": ["build"],
|
||||||
|
"outputs": ["out/**"]
|
||||||
|
},
|
||||||
|
"compile:windows": {
|
||||||
|
"dependsOn": ["build"],
|
||||||
|
"outputs": ["out/**"]
|
||||||
|
},
|
||||||
|
"compile:windows:x64": {
|
||||||
|
"dependsOn": ["build"],
|
||||||
"outputs": ["out/**"]
|
"outputs": ["out/**"]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -4,14 +4,12 @@ import { tanstackStart } from '@tanstack/react-start/plugin/vite'
|
|||||||
import react from '@vitejs/plugin-react'
|
import react from '@vitejs/plugin-react'
|
||||||
import { nitro } from 'nitro/vite'
|
import { nitro } from 'nitro/vite'
|
||||||
import { defineConfig } from 'vite'
|
import { defineConfig } from 'vite'
|
||||||
import tsconfigPaths from 'vite-tsconfig-paths'
|
|
||||||
|
|
||||||
export default defineConfig({
|
export default defineConfig({
|
||||||
clearScreen: false,
|
clearScreen: false,
|
||||||
plugins: [
|
plugins: [
|
||||||
tanstackDevtools(),
|
tanstackDevtools(),
|
||||||
tailwindcss(),
|
tailwindcss(),
|
||||||
tsconfigPaths(),
|
|
||||||
tanstackStart(),
|
tanstackStart(),
|
||||||
react({
|
react({
|
||||||
babel: {
|
babel: {
|
||||||
@@ -23,6 +21,9 @@ export default defineConfig({
|
|||||||
serveStatic: 'inline',
|
serveStatic: 'inline',
|
||||||
}),
|
}),
|
||||||
],
|
],
|
||||||
|
resolve: {
|
||||||
|
tsconfigPaths: true,
|
||||||
|
},
|
||||||
server: {
|
server: {
|
||||||
port: 3000,
|
port: 3000,
|
||||||
strictPort: true,
|
strictPort: true,
|
||||||
|
|||||||
@@ -11,7 +11,8 @@
|
|||||||
"formatter": {
|
"formatter": {
|
||||||
"enabled": true,
|
"enabled": true,
|
||||||
"indentStyle": "space",
|
"indentStyle": "space",
|
||||||
"lineEnding": "lf"
|
"lineEnding": "lf",
|
||||||
|
"lineWidth": 120
|
||||||
},
|
},
|
||||||
"linter": {
|
"linter": {
|
||||||
"enabled": true,
|
"enabled": true,
|
||||||
|
|||||||
70
package.json
70
package.json
@@ -10,53 +10,57 @@
|
|||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "turbo run build",
|
"build": "turbo run build",
|
||||||
"compile": "turbo run compile",
|
"compile": "turbo run compile",
|
||||||
|
"compile:darwin": "turbo run compile:darwin",
|
||||||
|
"compile:linux": "turbo run compile:linux",
|
||||||
|
"compile:windows": "turbo run compile:windows",
|
||||||
"dev": "turbo run dev",
|
"dev": "turbo run dev",
|
||||||
|
"dist": "turbo run dist",
|
||||||
|
"dist:linux": "turbo run dist:linux",
|
||||||
|
"dist:mac": "turbo run dist:mac",
|
||||||
|
"dist:win": "turbo run dist:win",
|
||||||
"fix": "turbo run fix",
|
"fix": "turbo run fix",
|
||||||
"typecheck": "turbo run typecheck"
|
"typecheck": "turbo run typecheck"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@biomejs/biome": "^2.3.14",
|
"@biomejs/biome": "^2.4.8",
|
||||||
"turbo": "^2.8.3",
|
"turbo": "^2.8.20",
|
||||||
"typescript": "^5.9.3"
|
"typescript": "^5.9.3"
|
||||||
},
|
},
|
||||||
"catalog": {
|
"catalog": {
|
||||||
"@biomejs/biome": "^2.3.11",
|
"@orpc/client": "^1.13.9",
|
||||||
"@orpc/client": "^1.13.4",
|
"@orpc/contract": "^1.13.9",
|
||||||
"@orpc/contract": "^1.13.4",
|
"@orpc/openapi": "^1.13.9",
|
||||||
"@orpc/openapi": "^1.13.4",
|
"@orpc/server": "^1.13.9",
|
||||||
"@orpc/server": "^1.13.4",
|
"@orpc/tanstack-query": "^1.13.9",
|
||||||
"@orpc/tanstack-query": "^1.13.4",
|
"@orpc/zod": "^1.13.9",
|
||||||
"@orpc/zod": "^1.13.4",
|
|
||||||
"@t3-oss/env-core": "^0.13.10",
|
"@t3-oss/env-core": "^0.13.10",
|
||||||
"@tailwindcss/vite": "^4.1.18",
|
"@tailwindcss/vite": "^4.2.2",
|
||||||
"@tanstack/devtools-vite": "^0.5.1",
|
"@tanstack/devtools-vite": "^0.5.5",
|
||||||
"@tanstack/react-devtools": "^0.9.5",
|
"@tanstack/react-devtools": "^0.9.13",
|
||||||
"@tanstack/react-query": "^5.90.20",
|
"@tanstack/react-query": "^5.94.4",
|
||||||
"@tanstack/react-query-devtools": "^5.91.3",
|
"@tanstack/react-query-devtools": "^5.94.4",
|
||||||
"@tanstack/react-router": "^1.158.4",
|
"@tanstack/react-router": "^1.168.1",
|
||||||
"@tanstack/react-router-devtools": "^1.158.4",
|
"@tanstack/react-router-devtools": "^1.166.10",
|
||||||
"@tanstack/react-router-ssr-query": "^1.158.4",
|
"@tanstack/react-router-ssr-query": "^1.166.10",
|
||||||
"@tanstack/react-start": "^1.159.0",
|
"@tanstack/react-start": "^1.167.2",
|
||||||
"@types/bun": "^1.3.8",
|
"@types/bun": "^1.3.11",
|
||||||
"@types/node": "^24.3.0",
|
"@types/node": "^24.12.0",
|
||||||
"@vitejs/plugin-react": "^5.1.3",
|
"@vitejs/plugin-react": "^5.2.0",
|
||||||
"babel-plugin-react-compiler": "^1.0.0",
|
"babel-plugin-react-compiler": "^1.0.0",
|
||||||
"drizzle-kit": "^0.31.8",
|
"drizzle-kit": "1.0.0-beta.15-859cf75",
|
||||||
"drizzle-orm": "^0.45.1",
|
"drizzle-orm": "1.0.0-beta.15-859cf75",
|
||||||
"drizzle-zod": "^0.8.3",
|
"electron": "^34.0.0",
|
||||||
"@webui-dev/bun-webui": "^2.5.4",
|
"electron-builder": "^26.8.1",
|
||||||
"nitro": "npm:nitro-nightly@3.0.1-20260206-171553-bc737c0c",
|
"electron-vite": "^5.0.0",
|
||||||
"ohash": "^2.0.11",
|
"motion": "^12.38.0",
|
||||||
|
"nitro": "npm:nitro-nightly@3.0.1-20260320-182900-2218d454",
|
||||||
"postgres": "^3.4.8",
|
"postgres": "^3.4.8",
|
||||||
"react": "^19.2.4",
|
"react": "^19.2.4",
|
||||||
"react-dom": "^19.2.4",
|
"react-dom": "^19.2.4",
|
||||||
"systeminformation": "^5.30.7",
|
"tailwindcss": "^4.2.2",
|
||||||
"tailwindcss": "^4.1.18",
|
"tree-kill": "^1.2.2",
|
||||||
"turbo": "^2.7.5",
|
|
||||||
"typescript": "^5.9.3",
|
|
||||||
"uuid": "^13.0.0",
|
"uuid": "^13.0.0",
|
||||||
"vite": "^8.0.0-beta.13",
|
"vite": "^8.0.1",
|
||||||
"vite-tsconfig-paths": "^6.1.0",
|
|
||||||
"zod": "^4.3.6"
|
"zod": "^4.3.6"
|
||||||
},
|
},
|
||||||
"overrides": {
|
"overrides": {
|
||||||
|
|||||||
@@ -1,20 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "@furtherverse/utils",
|
|
||||||
"version": "1.0.0",
|
|
||||||
"private": true,
|
|
||||||
"type": "module",
|
|
||||||
"imports": {
|
|
||||||
"#*": "./src/*"
|
|
||||||
},
|
|
||||||
"exports": {
|
|
||||||
".": "./src/index.ts",
|
|
||||||
"./*": "./src/*.ts"
|
|
||||||
},
|
|
||||||
"dependencies": {
|
|
||||||
"ohash": "catalog:",
|
|
||||||
"systeminformation": "catalog:"
|
|
||||||
},
|
|
||||||
"devDependencies": {
|
|
||||||
"@furtherverse/tsconfig": "workspace:*"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,29 +0,0 @@
|
|||||||
import { hash } from 'ohash'
|
|
||||||
import si from 'systeminformation'
|
|
||||||
|
|
||||||
async function getSystemInfo() {
|
|
||||||
const [uuid, baseboard, bios, system, diskLayout, networkInterfaces] =
|
|
||||||
await Promise.all([
|
|
||||||
si.uuid(),
|
|
||||||
si.baseboard(),
|
|
||||||
si.bios(),
|
|
||||||
si.system(),
|
|
||||||
si.diskLayout(),
|
|
||||||
si.networkInterfaces(),
|
|
||||||
])
|
|
||||||
|
|
||||||
return {
|
|
||||||
uuid,
|
|
||||||
baseboard,
|
|
||||||
bios,
|
|
||||||
system,
|
|
||||||
diskLayout,
|
|
||||||
networkInterfaces,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
export async function getHardwareFingerprint() {
|
|
||||||
const systemInfo = await getSystemInfo()
|
|
||||||
|
|
||||||
return hash(systemInfo)
|
|
||||||
}
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
export * from './fingerprint'
|
|
||||||
10
turbo.json
10
turbo.json
@@ -6,9 +6,6 @@
|
|||||||
"build": {
|
"build": {
|
||||||
"dependsOn": ["^build"]
|
"dependsOn": ["^build"]
|
||||||
},
|
},
|
||||||
"compile": {
|
|
||||||
"dependsOn": ["build"]
|
|
||||||
},
|
|
||||||
"dev": {
|
"dev": {
|
||||||
"cache": false,
|
"cache": false,
|
||||||
"persistent": true
|
"persistent": true
|
||||||
@@ -17,12 +14,7 @@
|
|||||||
"cache": false
|
"cache": false
|
||||||
},
|
},
|
||||||
"typecheck": {
|
"typecheck": {
|
||||||
"inputs": [
|
"inputs": ["package.json", "tsconfig.json", "tsconfig.*.json", "**/*.{ts,tsx,d.ts}"],
|
||||||
"package.json",
|
|
||||||
"tsconfig.json",
|
|
||||||
"tsconfig.*.json",
|
|
||||||
"**/*.{ts,tsx,d.ts}"
|
|
||||||
],
|
|
||||||
"outputs": []
|
"outputs": []
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|||||||
Reference in New Issue
Block a user