@korajs/cli 0.5.0 → 0.6.0

package/templates/svelte-basic/src/modules/todos/todo.mutations.ts

@@ -0,0 +1,25 @@
+import type { CollectionAccessor } from 'korajs'
+
+export interface CreateTodoInput {
+	title: string
+}
+
+export interface UpdateTodoStatusInput {
+	completed: boolean
+}
+
+export function createTodo(todos: CollectionAccessor, data: CreateTodoInput) {
+	return todos.insert({ title: data.title })
+}
+
+export function updateTodoStatus(
+	todos: CollectionAccessor,
+	id: string,
+	data: UpdateTodoStatusInput,
+) {
+	return todos.update(id, { completed: data.completed })
+}
+
+export function deleteTodo(todos: CollectionAccessor, id: string) {
+	return todos.delete(id)
+}

package/templates/svelte-basic/src/modules/todos/todo.queries.ts

@@ -0,0 +1,5 @@
+import type { CollectionAccessor } from 'korajs'
+
+export function orderedTodos(todos: CollectionAccessor) {
+	return todos.where({}).orderBy('createdAt', 'desc')
+}

package/templates/svelte-basic/src/modules/todos/todo.schema.ts

@@ -0,0 +1,10 @@
+import { t } from 'korajs'
+
+export const todos = {
+	fields: {
+		title: t.string(),
+		completed: t.boolean().default(false),
+		createdAt: t.timestamp().auto(),
+	},
+	indexes: ['completed', 'createdAt'],
+}

package/templates/svelte-basic/src/modules/todos/useTodos.ts

@@ -0,0 +1,25 @@
+import { getCollection, createMutation, createQueryStore } from '@korajs/svelte'
+import { derived } from 'svelte/store'
+import {
+	type CreateTodoInput,
+	type UpdateTodoStatusInput,
+	createTodo,
+	deleteTodo,
+	updateTodoStatus,
+} from './todo.mutations'
+import { orderedTodos } from './todo.queries'
+
+export function createTodosStores() {
+	const todos = getCollection('todos')
+	const allTodos = createQueryStore(orderedTodos(todos))
+	const addTodo = createMutation((data: CreateTodoInput) => createTodo(todos, data))
+	const toggleTodo = createMutation((id: string, data: UpdateTodoStatusInput) =>
+		updateTodoStatus(todos, id, data),
+	)
+	const removeTodo = createMutation((id: string) => deleteTodo(todos, id))
+
+	const activeTodos = derived(allTodos, ($all) => $all.filter((todo) => !todo.completed))
+	const completedTodos = derived(allTodos, ($all) => $all.filter((todo) => !!todo.completed))
+
+	return { allTodos, activeTodos, completedTodos, addTodo, toggleTodo, deleteTodo: removeTodo }
+}

package/templates/svelte-basic/src/schema.ts

@@ -0,0 +1,9 @@
+import { defineSchema } from 'korajs'
+import { todos } from './modules/todos/todo.schema'
+
+export default defineSchema({
+	version: 1,
+	collections: {
+		todos,
+	},
+})

package/templates/svelte-basic/src/vite-env.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="svelte" />
+/// <reference types="vite/client" />
+
+declare module '*?worker&url' {
+	const url: string
+	export default url
+}
+
+declare module '*?url' {
+	const url: string
+	export default url
+}

package/templates/svelte-basic/svelte.config.js

@@ -0,0 +1,5 @@
+import { vitePreprocess } from '@sveltejs/vite-plugin-svelte'
+
+export default {
+	preprocess: vitePreprocess(),
+}

package/templates/svelte-basic/tsconfig.json.hbs

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "strict": true,
+    "noUncheckedIndexedAccess": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "types": ["vite/client"]
+  },
+  "include": ["src/**/*.ts", "src/**/*.svelte"],
+  "exclude": ["node_modules"]
+}

package/templates/svelte-basic/vite.config.ts

@@ -0,0 +1,52 @@
+import { svelte } from '@sveltejs/vite-plugin-svelte'
+import { copyFileSync, existsSync, readdirSync } from 'node:fs'
+import { join, resolve } from 'node:path'
+import type { Plugin } from 'vite'
+import { defineConfig } from 'vite'
+
+function crossOriginIsolation(): Plugin {
+	return {
+		name: 'cross-origin-isolation',
+		configureServer(server) {
+			server.middlewares.use((_req, res, next) => {
+				res.setHeader('Cross-Origin-Opener-Policy', 'same-origin')
+				res.setHeader('Cross-Origin-Embedder-Policy', 'require-corp')
+				next()
+			})
+		},
+		configurePreviewServer(server) {
+			server.middlewares.use((_req, res, next) => {
+				res.setHeader('Cross-Origin-Opener-Policy', 'same-origin')
+				res.setHeader('Cross-Origin-Embedder-Policy', 'require-corp')
+				next()
+			})
+		},
+	}
+}
+
+function sqliteWasmHotfix(): Plugin {
+	return {
+		name: 'sqlite-wasm-hotfix',
+		apply: 'build',
+		closeBundle() {
+			const assetsDir = resolve('dist', 'assets')
+			if (!existsSync(assetsDir)) return
+			for (const file of readdirSync(assetsDir)) {
+				if (/^sqlite3-.+\.wasm$/.test(file)) {
+					copyFileSync(join(assetsDir, file), join(assetsDir, 'sqlite3.wasm'))
+					break
+				}
+			}
+		},
+	}
+}
+
+export default defineConfig({
+	plugins: [svelte(), crossOriginIsolation(), sqliteWasmHotfix()],
+	worker: { format: 'es' },
+	optimizeDeps: {
+		exclude: ['@sqlite.org/sqlite-wasm', '@korajs/store'],
+		include: ['yjs'],
+	},
+	resolve: { dedupe: ['yjs'] },
+})

package/templates/svelte-sync/.env.example

@@ -0,0 +1,25 @@
+# Kora Sync Server
+# WebSocket URL for the sync server (used by the client)
+VITE_SYNC_URL=ws://localhost:3001
+
+# Sync server port
+PORT=3001
+
+# Server database
+# Leave DATABASE_URL empty to use SQLite at KORA_SERVER_DB.
+KORA_SERVER_DB=./kora-server.db
+DATABASE_URL=
+
+# Operational endpoints (/__kora, /__kora/status, /__kora/events, /__kora/metrics, backups)
+# Set these in production. Use Authorization: Bearer <token> when calling protected endpoints.
+KORA_ADMIN_TOKEN=
+KORA_METRICS_TOKEN=
+KORA_BACKUP_TOKEN=
+
+# Optional sync path
+KORA_SYNC_PATH=/kora-sync
+
+# Auth
+# Set this to enable built-in /auth/* routes and authenticated sync.
+# Generate with: node -e "console.log(require('node:crypto').randomBytes(32).toString('hex'))"
+KORA_AUTH_SECRET=

package/templates/svelte-sync/README.md.hbs

@@ -0,0 +1,105 @@
+# {{projectName}}
+
+An offline-first application built with [Kora.js](https://ehoneahobed.github.io/kora/).
+
+## Getting Started
+
+```bash
+npm run dev
+```
+
+This starts both the Vite dev server and the Kora sync server.
+
+- **App**: http://localhost:5173
+- **Sync server**: ws://localhost:3001
+
+## Project Structure
+
+```
+src/
+  schema.ts        # Schema entry point
+  auth.ts          # Auth client and OAuth callback handling
+  main.tsx         # App initialization and Kora setup
+  App.tsx          # Main application component
+  modules/
+    todos/
+      todo.schema.ts     # Todo collection definition
+      todo.queries.ts    # Reusable todo query builders
+      todo.mutations.ts  # Todo mutation helpers
+      useTodos.ts        # React hook connecting todos to the UI
+  kora-worker.ts   # SQLite WASM web worker
+  index.css        # Styles
+server.ts          # Kora sync server
+kora.config.ts     # Kora configuration
+```
+
+In a feature module, `schema` defines data shape, `queries` contain reads only, `mutations` contain
+writes, and `useTodos.ts` is the React binding that exposes todo data and actions to components.
+
+## Environment Variables
+
+| Variable | Default | Description |
+|----------|---------|-------------|
+| `VITE_SYNC_URL` | `ws://localhost:3001` | WebSocket URL for the sync server |
+| `VITE_AUTH_URL` | current origin | HTTP URL for `/auth/*` routes |
+| `PORT` | `3001` | Sync server port |
+| `KORA_SERVER_DB` | `./kora-server.db` | SQLite file used by the sync server when `DATABASE_URL` is empty |
+| `KORA_AUTH_DB` | `./kora-auth.db` | SQLite file used by OAuth state and linked identities when `DATABASE_URL` is empty |
+| `DATABASE_URL` | (none) | PostgreSQL connection string for production sync server deployments |
+| `KORA_SYNC_PATH` | `/kora-sync` | WebSocket path exposed by the sync server |
+| `KORA_AUTH_SECRET` | (none) | Enables built-in `/auth/*` routes and authenticated sync when set |
+| `KORA_GOOGLE_CLIENT_ID` | (none) | Enables Google OAuth when set with `KORA_GOOGLE_REDIRECT_URI` |
+| `KORA_GOOGLE_CLIENT_SECRET` | (none) | Google OAuth client secret for confidential web clients |
+| `KORA_GOOGLE_REDIRECT_URI` | (none) | OAuth callback URL, usually your app URL that handles `code` and `state` |
+| `KORA_OAUTH_PKCE` | `true` when no client secret | Enables PKCE for public desktop/mobile OAuth clients |
+| `KORA_ADMIN_TOKEN` | (none) | Protects `/__kora`, `/__kora/status`, and `/__kora/events` |
+| `KORA_METRICS_TOKEN` | (none) | Protects `/__kora/metrics` |
+| `KORA_BACKUP_TOKEN` | (none) | Protects server backup and restore endpoints |
+
+## Authentication
+
+Set `KORA_AUTH_SECRET` to enable built-in auth on the sync server. Generate a secret with:
+
+```bash
+node -e "console.log(require('node:crypto').randomBytes(32).toString('hex'))"
+```
+
+The template already creates `src/auth.ts`, wraps the app in `AuthProvider`, and wires sync with `createKoraAuthSync({ authClient, schema })`. To enable Google OAuth, set:
+
+```bash
+KORA_AUTH_SECRET=...
+KORA_GOOGLE_CLIENT_ID=...
+KORA_GOOGLE_CLIENT_SECRET=...
+KORA_GOOGLE_REDIRECT_URI=http://localhost:5173
+```
+
+Use `authClient.signInWithOAuth('google')` for web redirect sign-in, or `authClient.getOAuthAuthorizationUrl('google')` plus `authClient.completeOAuthSignIn('google', { code, state })` for custom handoff flows. See the [Authentication Guide](https://ehoneahobed.github.io/kora/guide/authentication).
+
+## Scripts
+
+| Script | Description |
+|--------|-------------|
+| `npm run dev` | Start dev server + sync server |
+| `npm run dev:server` | Start sync server only |
+| `npm run build` | Build for production |
+| `npm run preview` | Preview production build |
+
+## Deployment
+
+The client and sync server must be deployed separately:
+
+- **Client**: Any static host (Vercel, Netlify, Cloudflare Pages)
+- **Sync server**: Any Node.js host with WebSocket support (Railway, Render, Fly.io)
+
+Set `VITE_SYNC_URL` to your deployed sync server URL when building:
+
+```bash
+VITE_SYNC_URL=wss://your-server.example.com npm run build
+```
+
+## Learn More
+
+- [Documentation](https://ehoneahobed.github.io/kora/)
+- [Storage Configuration](https://ehoneahobed.github.io/kora/guide/storage-configuration)
+- [Sync Configuration](https://ehoneahobed.github.io/kora/guide/sync-configuration)
+- [Deployment Guide](https://ehoneahobed.github.io/kora/guide/deployment)

package/templates/svelte-sync/index.html.hbs

@@ -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>{{projectName}}</title>
+  </head>
+  <body>
+    <div id="app"></div>
+    <script type="module" src="/src/main.ts"></script>
+  </body>
+</html>

package/templates/svelte-sync/kora.config.ts

@@ -0,0 +1,17 @@
+import { defineConfig } from 'korajs/config'
+
+export default defineConfig({
+	schema: './src/schema.ts',
+	dev: {
+		port: 5173,
+		sync: {
+			enabled: true,
+			port: 3001,
+			store: 'sqlite',
+		},
+		watch: {
+			enabled: true,
+			debounceMs: 300,
+		},
+	},
+})

package/templates/svelte-sync/package.json.hbs

@@ -0,0 +1,43 @@
+{
+  "name": "{{projectName}}",
+  "version": "0.0.1",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "dev": "kora dev",
+    "dev:server": "tsx server.ts",
+    "build": "vite build",
+    "check": "svelte-check --tsconfig ./tsconfig.json",
+    "start": "node --import tsx server.ts",
+    "preview": "vite preview"
+  },
+  "dependencies": {
+    "korajs": "{{koraVersion}}",
+    "@korajs/auth": "{{koraVersion}}",
+    "@korajs/svelte": "{{koraVersion}}",
+    "@korajs/store": "{{koraVersion}}",
+    "@sqlite.org/sqlite-wasm": ">=3.51.0-build1",
+    "svelte": "^5.0.0",
+    "ws": "^8.18.0",
+    "yjs": "^13.6.30"
+  },
+  "pnpm": {
+    "onlyBuiltDependencies": [
+      "better-sqlite3",
+      "esbuild",
+      "protobufjs"
+    ]
+  },
+  "devDependencies": {
+    "@korajs/cli": "{{koraVersion}}",
+    "@korajs/server": "{{koraVersion}}",
+    "@sveltejs/vite-plugin-svelte": "^5.0.0",
+    "@types/ws": "^8.5.0",
+    "better-sqlite3": "^12.9.0",
+    "postgres": "^3.4.0",
+    "svelte-check": "^4.1.0",
+    "tsx": "^4.19.0",
+    "typescript": "^5.7.0",
+    "vite": "^6.0.0"
+  }
+}

package/templates/svelte-sync/server.ts

@@ -0,0 +1,90 @@
+import {
+	type CreateKoraAuthServerOptions,
+	createKoraAuthServer,
+	createPostgresOAuthStores,
+	createSqliteOAuthStores,
+	googleProvider,
+} from '@korajs/auth/server'
+import {
+	createPostgresServerStore,
+	createProductionServer,
+	createSqliteServerStore,
+} from '@korajs/server'
+import schema from './src/schema'
+
+async function createStore() {
+	if (process.env.DATABASE_URL) {
+		return createPostgresServerStore({
+			connectionString: process.env.DATABASE_URL,
+		})
+	}
+
+	return createSqliteServerStore({
+		filename: process.env.KORA_SERVER_DB || './kora-server.db',
+	})
+}
+
+async function start() {
+	const store = await createStore()
+	await store.setSchema(schema)
+
+	const syncPath = process.env.KORA_SYNC_PATH || '/kora-sync'
+	const auth = await createAuth()
+	const server = createProductionServer({
+		store,
+		port: Number(process.env.PORT) || 3001,
+		staticDir: './dist',
+		syncPath,
+		httpRoutes: auth ? [{ path: '/auth', handle: auth.handleRequest }] : undefined,
+		syncOptions: auth ? { auth: auth.auth } : undefined,
+		operationalAuth: {
+			adminToken: process.env.KORA_ADMIN_TOKEN,
+			metricsToken: process.env.KORA_METRICS_TOKEN,
+			backupToken: process.env.KORA_BACKUP_TOKEN,
+		},
+	})
+
+	const url = await server.start()
+	console.log(`Kora app running at ${url}`)
+	console.log(`  Sync endpoint: ${url.replace('http', 'ws')}${syncPath}`)
+	if (auth) console.log(`  Auth endpoint: ${url}/auth`)
+}
+
+void start()
+
+async function createAuth() {
+	if (!process.env.KORA_AUTH_SECRET) {
+		return null
+	}
+
+	const oauth = await createOAuthConfig()
+	return createKoraAuthServer({
+		jwtSecret: process.env.KORA_AUTH_SECRET,
+		...(oauth ? { oauth } : {}),
+	})
+}
+
+async function createOAuthConfig(): Promise<CreateKoraAuthServerOptions['oauth'] | undefined> {
+	if (!process.env.KORA_GOOGLE_CLIENT_ID || !process.env.KORA_GOOGLE_REDIRECT_URI) {
+		return undefined
+	}
+
+	const oauthStores = process.env.DATABASE_URL
+		? await createPostgresOAuthStores({ connectionString: process.env.DATABASE_URL })
+		: await createSqliteOAuthStores({
+				filename: process.env.KORA_AUTH_DB || './kora-auth.db',
+			})
+
+	return {
+		providers: [
+			googleProvider({
+				clientId: process.env.KORA_GOOGLE_CLIENT_ID,
+				clientSecret: process.env.KORA_GOOGLE_CLIENT_SECRET,
+				redirectUri: process.env.KORA_GOOGLE_REDIRECT_URI,
+				pkce: process.env.KORA_OAUTH_PKCE === 'true' || !process.env.KORA_GOOGLE_CLIENT_SECRET,
+			}),
+		],
+		stateStore: oauthStores.stateStore,
+		linkedIdentityStore: oauthStores.linkedIdentityStore,
+	}
+}

package/templates/svelte-sync/src/App.svelte

@@ -0,0 +1,154 @@
+<script lang="ts">
+	import { createAuthStore } from '@korajs/auth/svelte'
+	import { createSyncStatusStore } from '@korajs/svelte'
+	import { createTodosStores } from './modules/todos/useTodos'
+
+	type Filter = 'all' | 'active' | 'completed'
+
+	const syncStatus = createSyncStatusStore()
+	const auth = createAuthStore()
+	const todos = createTodosStores()
+	const { allTodos, activeTodos, completedTodos, addTodo, toggleTodo, deleteTodo } = todos
+
+	let filter = $state<Filter>('all')
+	let input = $state('')
+
+	const filteredTodos = $derived(
+		filter === 'active'
+			? $activeTodos
+			: filter === 'completed'
+				? $completedTodos
+				: $allTodos,
+	)
+
+	function handleSubmit(event: SubmitEvent): void {
+		event.preventDefault()
+		const title = input.trim()
+		if (!title) return
+		addTodo.mutate({ title })
+		input = ''
+	}
+
+	function clearCompleted(): void {
+		for (const todo of $completedTodos) {
+			deleteTodo.mutate(todo.id)
+		}
+	}
+
+	function formatTime(timestamp: number): string {
+		const date = new Date(timestamp)
+		const now = new Date()
+		if (date.toDateString() === now.toDateString()) {
+			return date.toLocaleTimeString([], { hour: '2-digit', minute: '2-digit' })
+		}
+		return date.toLocaleDateString([], { month: 'short', day: 'numeric' })
+	}
+</script>
+
+<div class="app">
+	<div class="header">
+		<h1>My Tasks</h1>
+		<div class="header-actions">
+			<div class="sync-badge">
+				<span class="sync-dot {$syncStatus.status}"></span>
+				<span>{$syncStatus.status}</span>
+			</div>
+			{#if $auth.isAuthenticated}
+				<button type="button" class="auth-button" onclick={() => $auth.signOut()}>
+					{$auth.user?.email || 'Sign out'}
+				</button>
+			{:else}
+				<button type="button" class="auth-button" onclick={() => $auth.signInWithOAuth('google')}>
+					Sign in
+				</button>
+			{/if}
+		</div>
+	</div>
+
+	{#if $auth.error}
+		<div class="auth-error">{$auth.error}</div>
+	{/if}
+
+	<div class="stats">
+		<div class="stat-card">
+			<div class="label">Total</div>
+			<div class="value muted">{$allTodos.length}</div>
+		</div>
+		<div class="stat-card">
+			<div class="label">Remaining</div>
+			<div class="value warning">{$activeTodos.length}</div>
+		</div>
+		<div class="stat-card">
+			<div class="label">Done</div>
+			<div class="value success">{$completedTodos.length}</div>
+		</div>
+	</div>
+
+	<form class="add-form" onsubmit={handleSubmit}>
+		<input bind:value={input} type="text" placeholder="What needs to be done?" />
+		<button type="submit" disabled={!input.trim()}>Add</button>
+	</form>
+
+	<div class="filters">
+		{#each ['all', 'active', 'completed'] as const as f}
+			<button
+				type="button"
+				class="filter-btn {filter === f ? 'active' : ''}"
+				onclick={() => (filter = f)}
+			>
+				{f.charAt(0).toUpperCase() + f.slice(1)}
+				<span class="badge">
+					{f === 'all'
+						? $allTodos.length
+						: f === 'active'
+							? $activeTodos.length
+							: $completedTodos.length}
+				</span>
+			</button>
+		{/each}
+	</div>
+
+	<div class="todo-list">
+		{#if filteredTodos.length === 0}
+			<div class="empty-state">
+				{#if filter === 'all'}
+					No tasks yet. Add one above!
+				{:else if filter === 'active'}
+					All caught up! No active tasks.
+				{:else}
+					No completed tasks yet.
+				{/if}
+			</div>
+		{:else}
+			{#each filteredTodos as todo (todo.id)}
+				<div class="todo-item">
+					<button
+						type="button"
+						class="toggle {todo.completed ? 'checked' : ''}"
+						onclick={() => toggleTodo.mutate(todo.id, { completed: !todo.completed })}
+					>
+						{todo.completed ? '✓' : ''}
+					</button>
+					<span class="title {todo.completed ? 'done' : ''}">{String(todo.title)}</span>
+					{#if todo.createdAt}
+						<span class="time">{formatTime(Number(todo.createdAt))}</span>
+					{/if}
+					<button type="button" class="delete-btn" onclick={() => deleteTodo.mutate(todo.id)}>
+						×
+					</button>
+				</div>
+			{/each}
+		{/if}
+	</div>
+
+	{#if $allTodos.length > 0}
+		<div class="footer">
+			<span>{$activeTodos.length} item{$activeTodos.length !== 1 ? 's' : ''} left</span>
+			{#if $completedTodos.length > 0}
+				<button type="button" onclick={clearCompleted}>Clear completed</button>
+			{/if}
+		</div>
+	{/if}
+
+	<p class="branding">Powered by Kora — offline-first, real-time sync</p>
+</div>

package/templates/svelte-sync/src/Root.svelte

@@ -0,0 +1,22 @@
+<script lang="ts">
+	import type { AuthClient } from '@korajs/auth'
+	import type { KoraAppLike } from '@korajs/svelte'
+	import AuthProvider from '@korajs/auth/svelte/AuthProvider.svelte'
+	import KoraProvider from '@korajs/svelte/KoraProvider.svelte'
+	import App from './App.svelte'
+
+	let { kora, authClient }: { kora: KoraAppLike; authClient: AuthClient } = $props()
+</script>
+
+<AuthProvider client={authClient}>
+	{#snippet fallback()}
+		<div>Restoring session...</div>
+	{/snippet}
+
+	<KoraProvider app={kora}>
+		{#snippet fallback()}
+			<div>Loading...</div>
+		{/snippet}
+		<App />
+	</KoraProvider>
+</AuthProvider>

package/templates/svelte-sync/src/auth.ts

@@ -0,0 +1,25 @@
+import { createKoraAuth } from '@korajs/auth'
+
+export const authServerUrl =
+	import.meta.env.VITE_AUTH_URL || `${window.location.protocol}//${window.location.host}`
+
+export const authClient = createKoraAuth({
+	serverUrl: authServerUrl,
+})
+
+export async function completeOAuthCallbackFromLocation(): Promise<void> {
+	const url = new URL(window.location.href)
+	const code = url.searchParams.get('code')
+	const state = url.searchParams.get('state')
+	const provider = url.searchParams.get('provider') || 'google'
+
+	if (!code || !state) {
+		return
+	}
+
+	await authClient.completeOAuthSignIn(provider, { code, state })
+	url.searchParams.delete('code')
+	url.searchParams.delete('state')
+	url.searchParams.delete('provider')
+	window.history.replaceState({}, document.title, `${url.pathname}${url.search}${url.hash}`)
+}