Compare commits
18 Commits
52af81b079
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
| 88326c4992 | |||
| 4e2bc5b8dc | |||
| 9da3df6ad7 | |||
| 9d8a38a4c4 | |||
| cd7448c3b3 | |||
| 58d7a453b6 | |||
| afc3b66efa | |||
| 3c97e9c3eb | |||
| 58620b4d4b | |||
| 04b8dedb3e | |||
| 02bdfffe79 | |||
| 0cd8b57d24 | |||
| 0438b52c93 | |||
| fd9478d64e | |||
| 73614204f7 | |||
| 61e7a1b621 | |||
| 5ccde0a121 | |||
| 0553347bfe |
1
.vscode/extensions.json
vendored
1
.vscode/extensions.json
vendored
@@ -2,7 +2,6 @@
|
|||||||
"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",
|
||||||
"tamasfe.even-better-toml"
|
"tamasfe.even-better-toml"
|
||||||
|
|||||||
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
|
||||||
},
|
},
|
||||||
|
|||||||
117
AGENTS.md
117
AGENTS.md
@@ -4,7 +4,7 @@ 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**
|
||||||
@@ -12,63 +12,63 @@ Guidelines for AI agents working in this Bun monorepo.
|
|||||||
- **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` - Electron desktop shell, sidecar server pattern (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 compile # Compile server to standalone binary (current platform, depends on build)
|
bun run compile # Compile server to standalone binary (current platform)
|
||||||
bun compile:linux # Compile server for Linux binaries (x64 + arm64)
|
bun run compile:darwin # Compile server for macOS (arm64 + x64)
|
||||||
bun compile:darwin # Compile server for macOS binaries (arm64 + x64)
|
bun run compile:linux # Compile server for Linux (x64 + arm64)
|
||||||
bun compile:windows # Compile server for Windows x64 binary
|
bun run compile:windows # Compile server for Windows x64
|
||||||
bun dist # Full packaging pipeline: server build → compile → desktop distributable (current platform)
|
bun run dist # Package desktop distributable (current platform)
|
||||||
bun dist:linux # Full pipeline → Linux distributables (x64 + arm64)
|
bun run dist:linux # Package desktop for Linux (x64 + arm64)
|
||||||
bun dist:mac # Full pipeline → macOS distributables (arm64 + x64)
|
bun run dist:mac # Package desktop for macOS (arm64 + x64)
|
||||||
bun dist:win # Full pipeline → Windows distributable
|
bun run dist:win # Package desktop for Windows x64
|
||||||
bun fix # Lint + format (Biome auto-fix)
|
bun run fix # Lint + format (Biome auto-fix)
|
||||||
bun typecheck # TypeScript check across monorepo
|
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 (current platform)
|
bun run compile # Compile to standalone binary (current platform)
|
||||||
bun compile:darwin # Compile for macOS (arm64 + x64)
|
bun run compile:darwin # Compile for macOS (arm64 + x64)
|
||||||
bun compile:darwin:arm64 # Compile for macOS arm64
|
bun run compile:darwin:arm64 # Compile for macOS arm64
|
||||||
bun compile:darwin:x64 # Compile for macOS x64
|
bun run compile:darwin:x64 # Compile for macOS x64
|
||||||
bun compile:linux # Compile for Linux (x64 + arm64)
|
bun run compile:linux # Compile for Linux (x64 + arm64)
|
||||||
bun compile:linux:arm64 # Compile for Linux arm64
|
bun run compile:linux:arm64 # Compile for Linux arm64
|
||||||
bun compile:linux:x64 # Compile for Linux x64
|
bun run compile:linux:x64 # Compile for Linux x64
|
||||||
bun compile:windows # Compile for Windows (default: x64)
|
bun run compile:windows # Compile for Windows (default: x64)
|
||||||
bun compile:windows:x64 # Compile for Windows x64
|
bun run compile:windows:x64 # Compile for Windows x64
|
||||||
bun fix # Biome auto-fix
|
bun run fix # Biome auto-fix
|
||||||
bun typecheck # TypeScript check
|
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 # electron-vite dev mode (requires server dev running)
|
bun run dev # electron-vite dev mode (requires server dev running)
|
||||||
bun build # electron-vite build (main + preload)
|
bun run build # electron-vite build (main + preload)
|
||||||
bun dist # Build + package for current platform
|
bun run dist # Build + package for current platform
|
||||||
bun dist:linux # Build + package for Linux (x64 + arm64)
|
bun run dist:linux # Build + package for Linux (x64 + arm64)
|
||||||
bun dist:linux:x64 # Build + package for Linux x64
|
bun run dist:linux:x64 # Build + package for Linux x64
|
||||||
bun dist:linux:arm64 # Build + package for Linux arm64
|
bun run dist:linux:arm64 # Build + package for Linux arm64
|
||||||
bun dist:mac # Build + package for macOS (arm64 + x64)
|
bun run dist:mac # Build + package for macOS (arm64 + x64)
|
||||||
bun dist:mac:arm64 # Build + package for macOS arm64
|
bun run dist:mac:arm64 # Build + package for macOS arm64
|
||||||
bun dist:mac:x64 # Build + package for macOS x64
|
bun run dist:mac:x64 # Build + package for macOS x64
|
||||||
bun dist:win # Build + package for Windows x64
|
bun run dist:win # Build + package for Windows x64
|
||||||
bun fix # Biome auto-fix
|
bun run fix # Biome auto-fix
|
||||||
bun typecheck # TypeScript check
|
bun run typecheck # TypeScript check
|
||||||
```
|
```
|
||||||
|
|
||||||
### Testing
|
### Testing
|
||||||
@@ -120,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', {
|
||||||
@@ -143,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`
|
||||||
@@ -158,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
|
||||||
@@ -174,7 +190,7 @@ 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
|
||||||
@@ -191,8 +207,7 @@ export const myTable = pgTable('my_table', {
|
|||||||
│ ├── electron-builder.yml # Packaging config
|
│ ├── 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
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ Thin Electron shell hosting the fullstack server app.
|
|||||||
|
|
||||||
## Tech Stack
|
## Tech Stack
|
||||||
|
|
||||||
> **⚠️ This project uses Bun as the package manager. Runtime is Electron (Node.js). Never use `npm`, `npx`, `yarn`, or `pnpm`.**
|
> **⚠️ 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**: Electron 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)
|
||||||
@@ -22,18 +22,18 @@ Thin Electron shell hosting the fullstack server app.
|
|||||||
## Commands
|
## Commands
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
bun dev # electron-vite dev (requires server dev running)
|
bun run dev # electron-vite dev (requires server dev running)
|
||||||
bun build # electron-vite build (main + preload)
|
bun run build # electron-vite build (main + preload)
|
||||||
bun dist # Build + package for current platform
|
bun run dist # Build + package for current platform
|
||||||
bun dist:linux # Build + package for Linux (x64 + arm64)
|
bun run dist:linux # Build + package for Linux (x64 + arm64)
|
||||||
bun dist:linux:x64 # Build + package for Linux x64
|
bun run dist:linux:x64 # Build + package for Linux x64
|
||||||
bun dist:linux:arm64 # Build + package for Linux arm64
|
bun run dist:linux:arm64 # Build + package for Linux arm64
|
||||||
bun dist:mac # Build + package for macOS (arm64 + x64)
|
bun run dist:mac # Build + package for macOS (arm64 + x64)
|
||||||
bun dist:mac:arm64 # Build + package for macOS arm64
|
bun run dist:mac:arm64 # Build + package for macOS arm64
|
||||||
bun dist:mac:x64 # Build + package for macOS x64
|
bun run dist:mac:x64 # Build + package for macOS x64
|
||||||
bun dist:win # Build + package for Windows x64
|
bun run dist:win # Build + package for Windows x64
|
||||||
bun fix # Biome auto-fix
|
bun run fix # Biome auto-fix
|
||||||
bun typecheck # TypeScript check
|
bun run typecheck # TypeScript check
|
||||||
```
|
```
|
||||||
|
|
||||||
## Directory Structure
|
## Directory Structure
|
||||||
@@ -56,13 +56,13 @@ bun typecheck # TypeScript check
|
|||||||
|
|
||||||
## Development Workflow
|
## Development Workflow
|
||||||
|
|
||||||
1. **Start server**: `bun dev` in `apps/server` (or use root `bun dev` via Turbo).
|
1. **Start server**: `bun run dev` in `apps/server` (or use root `bun run dev` via Turbo).
|
||||||
2. **Start desktop**: `bun dev` in `apps/desktop`.
|
2. **Start desktop**: `bun run dev` in `apps/desktop`.
|
||||||
3. **Connection**: Main process polls `localhost:3000` until responsive, then opens BrowserWindow.
|
3. **Connection**: Main process polls `localhost:3000` until responsive, then opens BrowserWindow.
|
||||||
|
|
||||||
## Production Build Workflow
|
## Production Build Workflow
|
||||||
|
|
||||||
From monorepo root, run `bun dist` to execute the full pipeline automatically (via Turbo task dependencies):
|
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/`
|
1. **Build server**: `apps/server` → `vite build` → `.output/`
|
||||||
2. **Compile server**: `apps/server` → `bun compile.ts --target ...` → `out/server-{os}-{arch}`
|
2. **Compile server**: `apps/server` → `bun compile.ts --target ...` → `out/server-{os}-{arch}`
|
||||||
@@ -70,8 +70,16 @@ From monorepo root, run `bun dist` to execute the full pipeline automatically (v
|
|||||||
|
|
||||||
The `electron-builder.yml` `extraResources` config reads binaries directly from `../server/out/`, no manual copy needed.
|
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 dist:linux` / `bun dist:mac` / `bun dist:win` in `apps/desktop`.
|
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 dist:linux:x64`, `bun dist:linux:arm64`, `bun dist:mac:x64`, or `bun dist:mac:arm64`.
|
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
|
||||||
|
|
||||||
@@ -84,3 +92,4 @@ For single-arch output, use `bun dist:linux:x64`, `bun dist:linux:arm64`, `bun d
|
|||||||
- Use `npm`, `npx`, `yarn`, or `pnpm`. Use `bun` for package management.
|
- Use `npm`, `npx`, `yarn`, or `pnpm`. Use `bun` for package management.
|
||||||
- Include UI components or business logic in the desktop app.
|
- 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.
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
import { join } from 'node:path'
|
import { join } from 'node:path'
|
||||||
import { app, BrowserWindow, dialog, shell } from 'electron'
|
import { app, BrowserWindow, dialog, session, shell } from 'electron'
|
||||||
import { createSidecarRuntime } from './sidecar'
|
import { createSidecarRuntime } from './sidecar'
|
||||||
|
|
||||||
const DEV_SERVER_URL = 'http://localhost:3000'
|
const DEV_SERVER_URL = 'http://localhost:3000'
|
||||||
@@ -28,8 +28,7 @@ const sidecar = createSidecarRuntime({
|
|||||||
},
|
},
|
||||||
})
|
})
|
||||||
|
|
||||||
const toErrorMessage = (error: unknown): string =>
|
const toErrorMessage = (error: unknown): string => (error instanceof Error ? error.message : String(error))
|
||||||
error instanceof Error ? error.message : String(error)
|
|
||||||
|
|
||||||
const canOpenExternally = (url: string): boolean => {
|
const canOpenExternally = (url: string): boolean => {
|
||||||
try {
|
try {
|
||||||
@@ -62,6 +61,8 @@ const createWindow = async () => {
|
|||||||
webPreferences: {
|
webPreferences: {
|
||||||
preload: join(__dirname, '../preload/index.js'),
|
preload: join(__dirname, '../preload/index.js'),
|
||||||
sandbox: true,
|
sandbox: true,
|
||||||
|
contextIsolation: true,
|
||||||
|
nodeIntegration: false,
|
||||||
},
|
},
|
||||||
})
|
})
|
||||||
mainWindow = windowRef
|
mainWindow = windowRef
|
||||||
@@ -79,6 +80,21 @@ const createWindow = async () => {
|
|||||||
return { action: 'deny' }
|
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', () => {
|
windowRef.on('closed', () => {
|
||||||
if (mainWindow === windowRef) {
|
if (mainWindow === windowRef) {
|
||||||
mainWindow = null
|
mainWindow = null
|
||||||
@@ -152,7 +168,13 @@ const handleWindowCreationError = (error: unknown, context: string) => {
|
|||||||
|
|
||||||
app
|
app
|
||||||
.whenReady()
|
.whenReady()
|
||||||
.then(() => ensureWindow())
|
.then(() => {
|
||||||
|
session.defaultSession.setPermissionRequestHandler((_webContents, _permission, callback) => {
|
||||||
|
callback(false)
|
||||||
|
})
|
||||||
|
|
||||||
|
return ensureWindow()
|
||||||
|
})
|
||||||
.catch((error) => {
|
.catch((error) => {
|
||||||
handleWindowCreationError(error, 'Failed to create window')
|
handleWindowCreationError(error, 'Failed to create window')
|
||||||
})
|
})
|
||||||
|
|||||||
@@ -27,14 +27,12 @@ type SidecarRuntimeOptions = {
|
|||||||
type SidecarRuntime = {
|
type SidecarRuntime = {
|
||||||
resolveUrl: () => Promise<string>
|
resolveUrl: () => Promise<string>
|
||||||
stop: () => void
|
stop: () => void
|
||||||
|
lastResolvedUrl: string | null
|
||||||
}
|
}
|
||||||
|
|
||||||
const sleep = (ms: number): Promise<void> =>
|
const sleep = (ms: number): Promise<void> => new Promise((resolve) => setTimeout(resolve, ms))
|
||||||
new Promise((resolve) => setTimeout(resolve, ms))
|
|
||||||
|
|
||||||
const isProcessAlive = (
|
const isProcessAlive = (processToCheck: ChildProcess | null): processToCheck is ChildProcess => {
|
||||||
processToCheck: ChildProcess | null,
|
|
||||||
): processToCheck is ChildProcess => {
|
|
||||||
if (!processToCheck || !processToCheck.pid) {
|
if (!processToCheck || !processToCheck.pid) {
|
||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
@@ -75,17 +73,15 @@ const isServerReady = async (url: string): Promise<boolean> => {
|
|||||||
|
|
||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
} catch {}
|
} catch {
|
||||||
|
// Expected: probe request fails while server is still starting up
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
|
|
||||||
const waitForServer = async (
|
const waitForServer = async (url: string, isQuitting: () => boolean, processRef?: ChildProcess): Promise<boolean> => {
|
||||||
url: string,
|
|
||||||
isQuitting: () => boolean,
|
|
||||||
processRef?: ChildProcess,
|
|
||||||
): Promise<boolean> => {
|
|
||||||
const start = Date.now()
|
const start = Date.now()
|
||||||
while (Date.now() - start < SERVER_READY_TIMEOUT_MS && !isQuitting()) {
|
while (Date.now() - start < SERVER_READY_TIMEOUT_MS && !isQuitting()) {
|
||||||
if (processRef && processRef.exitCode !== null) {
|
if (processRef && processRef.exitCode !== null) {
|
||||||
@@ -119,9 +115,7 @@ const formatUnexpectedStopMessage = (
|
|||||||
return `Server process exited unexpectedly (code ${code ?? 'unknown'}, signal ${signal ?? 'none'}).`
|
return `Server process exited unexpectedly (code ${code ?? 'unknown'}, signal ${signal ?? 'none'}).`
|
||||||
}
|
}
|
||||||
|
|
||||||
export const createSidecarRuntime = (
|
export const createSidecarRuntime = (options: SidecarRuntimeOptions): SidecarRuntime => {
|
||||||
options: SidecarRuntimeOptions,
|
|
||||||
): SidecarRuntime => {
|
|
||||||
const state: SidecarState = {
|
const state: SidecarState = {
|
||||||
process: null,
|
process: null,
|
||||||
startup: null,
|
startup: null,
|
||||||
@@ -162,9 +156,7 @@ export const createSidecarRuntime = (
|
|||||||
resetState(processRef)
|
resetState(processRef)
|
||||||
|
|
||||||
if (!options.isQuitting() && hadReadyServer) {
|
if (!options.isQuitting() && hadReadyServer) {
|
||||||
options.onUnexpectedStop(
|
options.onUnexpectedStop('The background service crashed unexpectedly. Please restart the app.')
|
||||||
'The background service crashed unexpectedly. Please restart the app.',
|
|
||||||
)
|
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -180,9 +172,7 @@ export const createSidecarRuntime = (
|
|||||||
resetState(processRef)
|
resetState(processRef)
|
||||||
|
|
||||||
if (!options.isQuitting() && hadReadyServer) {
|
if (!options.isQuitting() && hadReadyServer) {
|
||||||
options.onUnexpectedStop(
|
options.onUnexpectedStop(formatUnexpectedStopMessage(options.isPackaged, code, signal))
|
||||||
formatUnexpectedStopMessage(options.isPackaged, code, signal),
|
|
||||||
)
|
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
@@ -222,11 +212,7 @@ export const createSidecarRuntime = (
|
|||||||
state.process = processRef
|
state.process = processRef
|
||||||
attachLifecycleHandlers(processRef)
|
attachLifecycleHandlers(processRef)
|
||||||
|
|
||||||
const ready = await waitForServer(
|
const ready = await waitForServer(nextServerUrl, options.isQuitting, processRef)
|
||||||
nextServerUrl,
|
|
||||||
options.isQuitting,
|
|
||||||
processRef,
|
|
||||||
)
|
|
||||||
if (ready && isProcessAlive(processRef)) {
|
if (ready && isProcessAlive(processRef)) {
|
||||||
state.url = nextServerUrl
|
state.url = nextServerUrl
|
||||||
return nextServerUrl
|
return nextServerUrl
|
||||||
@@ -253,16 +239,18 @@ export const createSidecarRuntime = (
|
|||||||
|
|
||||||
const ready = await waitForServer(options.devServerUrl, options.isQuitting)
|
const ready = await waitForServer(options.devServerUrl, options.isQuitting)
|
||||||
if (!ready) {
|
if (!ready) {
|
||||||
throw new Error(
|
throw new Error('Dev server not responding. Run `bun dev` in apps/server first.')
|
||||||
'Dev server not responding. Run `bun dev` in apps/server first.',
|
|
||||||
)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
state.url = options.devServerUrl
|
||||||
return options.devServerUrl
|
return options.devServerUrl
|
||||||
}
|
}
|
||||||
|
|
||||||
return {
|
return {
|
||||||
resolveUrl,
|
resolveUrl,
|
||||||
stop,
|
stop,
|
||||||
|
get lastResolvedUrl() {
|
||||||
|
return state.url
|
||||||
|
},
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -13,12 +13,7 @@ export const SplashApp = () => {
|
|||||||
ease: [0.16, 1, 0.3, 1],
|
ease: [0.16, 1, 0.3, 1],
|
||||||
}}
|
}}
|
||||||
>
|
>
|
||||||
<img
|
<img alt="Logo" className="h-20 w-auto object-contain" draggable={false} src={logoImage} />
|
||||||
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">
|
<div className="relative h-[4px] w-36 overflow-hidden rounded-full bg-zinc-100">
|
||||||
<motion.div
|
<motion.div
|
||||||
|
|||||||
@@ -10,11 +10,7 @@
|
|||||||
"outputs": ["dist/**"]
|
"outputs": ["dist/**"]
|
||||||
},
|
},
|
||||||
"dist:linux": {
|
"dist:linux": {
|
||||||
"dependsOn": [
|
"dependsOn": ["build", "@furtherverse/server#compile:linux:arm64", "@furtherverse/server#compile:linux:x64"],
|
||||||
"build",
|
|
||||||
"@furtherverse/server#compile:linux:arm64",
|
|
||||||
"@furtherverse/server#compile:linux:x64"
|
|
||||||
],
|
|
||||||
"outputs": ["dist/**"]
|
"outputs": ["dist/**"]
|
||||||
},
|
},
|
||||||
"dist:linux:arm64": {
|
"dist:linux:arm64": {
|
||||||
@@ -26,11 +22,7 @@
|
|||||||
"outputs": ["dist/**"]
|
"outputs": ["dist/**"]
|
||||||
},
|
},
|
||||||
"dist:mac": {
|
"dist:mac": {
|
||||||
"dependsOn": [
|
"dependsOn": ["build", "@furtherverse/server#compile:darwin:arm64", "@furtherverse/server#compile:darwin:x64"],
|
||||||
"build",
|
|
||||||
"@furtherverse/server#compile:darwin:arm64",
|
|
||||||
"@furtherverse/server#compile:darwin:x64"
|
|
||||||
],
|
|
||||||
"outputs": ["dist/**"]
|
"outputs": ["dist/**"]
|
||||||
},
|
},
|
||||||
"dist:mac:arm64": {
|
"dist:mac:arm64": {
|
||||||
|
|||||||
@@ -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,33 +20,33 @@ 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 (current platform, depends on build)
|
bun run compile # Compile to standalone binary (current platform, depends on build)
|
||||||
bun compile:darwin # Compile for macOS (arm64 + x64)
|
bun run compile:darwin # Compile for macOS (arm64 + x64)
|
||||||
bun compile:darwin:arm64 # Compile for macOS arm64
|
bun run compile:darwin:arm64 # Compile for macOS arm64
|
||||||
bun compile:darwin:x64 # Compile for macOS x64
|
bun run compile:darwin:x64 # Compile for macOS x64
|
||||||
bun compile:linux # Compile for Linux (x64 + arm64)
|
bun run compile:linux # Compile for Linux (x64 + arm64)
|
||||||
bun compile:linux:arm64 # Compile for Linux arm64
|
bun run compile:linux:arm64 # Compile for Linux arm64
|
||||||
bun compile:linux:x64 # Compile for Linux x64
|
bun run compile:linux:x64 # Compile for Linux x64
|
||||||
bun compile:windows # Compile for Windows (default: x64)
|
bun run compile:windows # Compile for Windows (default: x64)
|
||||||
bun compile:windows:x64 # Compile for Windows 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
|
||||||
bun test -t "pattern" # Run tests matching pattern
|
bun test -t "pattern" # Run tests matching pattern
|
||||||
```
|
```
|
||||||
|
|
||||||
## Directory Structure
|
## Directory Structure
|
||||||
@@ -54,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)
|
||||||
@@ -84,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'
|
||||||
|
|
||||||
@@ -101,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' },
|
||||||
|
})
|
||||||
})
|
})
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -119,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'
|
||||||
@@ -139,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)
|
||||||
@@ -197,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`
|
||||||
@@ -211,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
|
||||||
|
|||||||
@@ -24,9 +24,7 @@ const { values } = parseArgs({
|
|||||||
const resolveTarget = (): Bun.Build.CompileTarget => {
|
const resolveTarget = (): Bun.Build.CompileTarget => {
|
||||||
if (values.target !== undefined) {
|
if (values.target !== undefined) {
|
||||||
if (!isSupportedTarget(values.target)) {
|
if (!isSupportedTarget(values.target)) {
|
||||||
throw new Error(
|
throw new Error(`Invalid target: ${values.target}\nAllowed: ${SUPPORTED_TARGETS.join(', ')}`)
|
||||||
`Invalid target: ${values.target}\nAllowed: ${SUPPORTED_TARGETS.join(', ')}`,
|
|
||||||
)
|
|
||||||
}
|
}
|
||||||
return values.target
|
return values.target
|
||||||
}
|
}
|
||||||
@@ -45,10 +43,7 @@ const main = async () => {
|
|||||||
const outfile = `server-${suffix}`
|
const outfile = `server-${suffix}`
|
||||||
|
|
||||||
await mkdir(OUTDIR, { recursive: true })
|
await mkdir(OUTDIR, { recursive: true })
|
||||||
await Promise.all([
|
await Promise.all([rm(`${OUTDIR}/${outfile}`, { force: true }), rm(`${OUTDIR}/${outfile}.exe`, { force: true })])
|
||||||
rm(`${OUTDIR}/${outfile}`, { force: true }),
|
|
||||||
rm(`${OUTDIR}/${outfile}.exe`, { force: true }),
|
|
||||||
])
|
|
||||||
|
|
||||||
const result = await Bun.build({
|
const result = await Bun.build({
|
||||||
entrypoints: [ENTRYPOINT],
|
entrypoints: [ENTRYPOINT],
|
||||||
|
|||||||
@@ -35,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:",
|
||||||
@@ -55,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() })
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
})
|
|
||||||
@@ -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,21 +46,23 @@ function RootDocument({ children }: Readonly<{ children: ReactNode }>) {
|
|||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
{children}
|
{children}
|
||||||
<TanStackDevtools
|
{import.meta.env.DEV && (
|
||||||
config={{
|
<TanStackDevtools
|
||||||
position: 'bottom-right',
|
config={{
|
||||||
}}
|
position: 'bottom-right',
|
||||||
plugins={[
|
}}
|
||||||
{
|
plugins={[
|
||||||
name: 'TanStack Router',
|
{
|
||||||
render: <TanStackRouterDevtoolsPanel />,
|
name: 'TanStack Router',
|
||||||
},
|
render: <TanStackRouterDevtoolsPanel />,
|
||||||
{
|
},
|
||||||
name: 'TanStack Query',
|
{
|
||||||
render: <ReactQueryDevtoolsPanel />,
|
name: 'TanStack Query',
|
||||||
},
|
render: <ReactQueryDevtoolsPanel />,
|
||||||
]}
|
},
|
||||||
/>
|
]}
|
||||||
|
/>
|
||||||
|
)}
|
||||||
<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/$')({
|
||||||
|
|||||||
@@ -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/$')({
|
||||||
|
|||||||
@@ -2,7 +2,7 @@ import { useMutation, useSuspenseQuery } from '@tanstack/react-query'
|
|||||||
import { createFileRoute } from '@tanstack/react-router'
|
import { createFileRoute } from '@tanstack/react-router'
|
||||||
import type { ChangeEventHandler, SubmitEventHandler } 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,
|
||||||
@@ -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,44 +6,35 @@ 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')
|
||||||
}
|
}
|
||||||
|
|
||||||
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/bun-sql'
|
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,6 +4,7 @@
|
|||||||
"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": {
|
||||||
|
|||||||
@@ -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,
|
||||||
|
|||||||
67
package.json
67
package.json
@@ -9,55 +9,58 @@
|
|||||||
],
|
],
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "turbo run build",
|
"build": "turbo run build",
|
||||||
|
"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.4.2",
|
"@biomejs/biome": "^2.4.8",
|
||||||
"turbo": "^2.8.9",
|
"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.5",
|
"@orpc/contract": "^1.13.9",
|
||||||
"@orpc/contract": "^1.13.5",
|
"@orpc/openapi": "^1.13.9",
|
||||||
"@orpc/openapi": "^1.13.5",
|
"@orpc/server": "^1.13.9",
|
||||||
"@orpc/server": "^1.13.5",
|
"@orpc/tanstack-query": "^1.13.9",
|
||||||
"@orpc/tanstack-query": "^1.13.5",
|
"@orpc/zod": "^1.13.9",
|
||||||
"@orpc/zod": "^1.13.5",
|
|
||||||
"@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.21",
|
"@tanstack/react-query": "^5.94.4",
|
||||||
"@tanstack/react-query-devtools": "^5.91.3",
|
"@tanstack/react-query-devtools": "^5.94.4",
|
||||||
"@tanstack/react-router": "^1.160.2",
|
"@tanstack/react-router": "^1.168.1",
|
||||||
"@tanstack/react-router-devtools": "^1.160.2",
|
"@tanstack/react-router-devtools": "^1.166.10",
|
||||||
"@tanstack/react-router-ssr-query": "^1.160.2",
|
"@tanstack/react-router-ssr-query": "^1.166.10",
|
||||||
"@tanstack/react-start": "^1.160.2",
|
"@tanstack/react-start": "^1.167.2",
|
||||||
"@types/bun": "^1.3.9",
|
"@types/bun": "^1.3.11",
|
||||||
"@types/node": "^24.10.13",
|
"@types/node": "^24.12.0",
|
||||||
"@vitejs/plugin-react": "^5.1.4",
|
"@vitejs/plugin-react": "^5.2.0",
|
||||||
"babel-plugin-react-compiler": "^1.0.0",
|
"babel-plugin-react-compiler": "^1.0.0",
|
||||||
"drizzle-kit": "^0.31.9",
|
"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",
|
"electron": "^34.0.0",
|
||||||
"electron-builder": "^26.0.0",
|
"electron-builder": "^26.8.1",
|
||||||
"electron-vite": "^5.0.0",
|
"electron-vite": "^5.0.0",
|
||||||
"motion": "^12.34.0",
|
"motion": "^12.38.0",
|
||||||
"nitro": "npm:nitro-nightly@3.0.1-20260217-092337-b28fa21a",
|
"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",
|
||||||
"tailwindcss": "^4.1.18",
|
"tailwindcss": "^4.2.2",
|
||||||
"tree-kill": "^1.2.2",
|
"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.14",
|
"vite": "^8.0.1",
|
||||||
"vite-tsconfig-paths": "^6.1.1",
|
|
||||||
"zod": "^4.3.6"
|
"zod": "^4.3.6"
|
||||||
},
|
},
|
||||||
"overrides": {
|
"overrides": {
|
||||||
|
|||||||
@@ -1,16 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "@furtherverse/utils",
|
|
||||||
"version": "1.0.0",
|
|
||||||
"private": true,
|
|
||||||
"type": "module",
|
|
||||||
"imports": {
|
|
||||||
"#*": "./src/*"
|
|
||||||
},
|
|
||||||
"exports": {
|
|
||||||
".": "./src/index.ts",
|
|
||||||
"./*": "./src/*.ts"
|
|
||||||
},
|
|
||||||
"devDependencies": {
|
|
||||||
"@furtherverse/tsconfig": "workspace:*"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
export {}
|
|
||||||
@@ -14,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