@korajs/cli 0.4.0 → 0.6.0

package/templates/tauri-react/src/sync-config.ts

@@ -16,26 +16,26 @@ const SYNC_CONFIGURED_KEY = 'kora-sync-configured'
  * Priority: localStorage → VITE_SYNC_URL env var → null (needs setup).
  */
 export function getSyncUrl(): string | null {
-  const stored = localStorage.getItem(SYNC_URL_KEY)
-  if (stored) return stored
+	const stored = localStorage.getItem(SYNC_URL_KEY)
+	if (stored) return stored
 
-  // Compile-time default (set via VITE_SYNC_URL when building)
-  const envUrl = import.meta.env.VITE_SYNC_URL
-  if (envUrl) return envUrl
+	// Compile-time default (set via VITE_SYNC_URL when building)
+	const envUrl = import.meta.env.VITE_SYNC_URL
+	if (envUrl) return envUrl
 
-  return null
+	return null
 }
 
 /** Save a sync server URL to persistent local config. */
 export function setSyncUrl(url: string): void {
-  localStorage.setItem(SYNC_URL_KEY, url)
-  localStorage.setItem(SYNC_CONFIGURED_KEY, 'true')
+	localStorage.setItem(SYNC_URL_KEY, url)
+	localStorage.setItem(SYNC_CONFIGURED_KEY, 'true')
 }
 
 /** Clear the stored sync server URL (returns to setup screen). */
 export function clearSyncUrl(): void {
-  localStorage.removeItem(SYNC_URL_KEY)
-  localStorage.removeItem(SYNC_CONFIGURED_KEY)
+	localStorage.removeItem(SYNC_URL_KEY)
+	localStorage.removeItem(SYNC_CONFIGURED_KEY)
 }
 
 /**
@@ -43,14 +43,14 @@ export function clearSyncUrl(): void {
  * This is separate from getSyncUrl() — a user who skipped still completed setup.
  */
 export function hasCompletedSetup(): boolean {
-  // If there's a compile-time URL, setup is not needed
-  if (import.meta.env.VITE_SYNC_URL) return true
-  return localStorage.getItem(SYNC_CONFIGURED_KEY) === 'true'
+	// If there's a compile-time URL, setup is not needed
+	if (import.meta.env.VITE_SYNC_URL) return true
+	return localStorage.getItem(SYNC_CONFIGURED_KEY) === 'true'
 }
 
 /** Mark setup as completed (used when user skips sync). */
 export function markSetupComplete(): void {
-  localStorage.setItem(SYNC_CONFIGURED_KEY, 'true')
+	localStorage.setItem(SYNC_CONFIGURED_KEY, 'true')
 }
 
 /**
@@ -58,46 +58,46 @@ export function markSetupComplete(): void {
  * The app reloads with a fresh state, showing the setup screen.
  */
 export function factoryReset(): void {
-  // Clear sync config
-  clearSyncUrl()
-  localStorage.removeItem(SYNC_CONFIGURED_KEY)
+	// Clear sync config
+	clearSyncUrl()
+	localStorage.removeItem(SYNC_CONFIGURED_KEY)
 
-  // Clear all Kora local data by removing IndexedDB databases
-  // and any other localStorage keys the app may have set.
-  const keysToRemove: string[] = []
-  for (let i = 0; i < localStorage.length; i++) {
-    const key = localStorage.key(i)
-    if (key && key.startsWith('kora-')) {
-      keysToRemove.push(key)
-    }
-  }
-  for (const key of keysToRemove) {
-    localStorage.removeItem(key)
-  }
+	// Clear all Kora local data by removing IndexedDB databases
+	// and any other localStorage keys the app may have set.
+	const keysToRemove: string[] = []
+	for (let i = 0; i < localStorage.length; i++) {
+		const key = localStorage.key(i)
+		if (key?.startsWith('kora-')) {
+			keysToRemove.push(key)
+		}
+	}
+	for (const key of keysToRemove) {
+		localStorage.removeItem(key)
+	}
 
-  // Reload to reinitialize everything from scratch
-  window.location.reload()
+	// Reload to reinitialize everything from scratch
+	window.location.reload()
 }
 
 /** Test if a WebSocket URL is reachable by attempting a brief connection. */
 export function testConnection(url: string, timeoutMs = 5000): Promise<boolean> {
-  return new Promise((resolve) => {
-    const timeout = setTimeout(() => {
-      ws.close()
-      resolve(false)
-    }, timeoutMs)
+	return new Promise((resolve) => {
+		const timeout = setTimeout(() => {
+			ws.close()
+			resolve(false)
+		}, timeoutMs)
 
-    const ws = new WebSocket(url)
+		const ws = new WebSocket(url)
 
-    ws.onopen = () => {
-      clearTimeout(timeout)
-      ws.close()
-      resolve(true)
-    }
+		ws.onopen = () => {
+			clearTimeout(timeout)
+			ws.close()
+			resolve(true)
+		}
 
-    ws.onerror = () => {
-      clearTimeout(timeout)
-      resolve(false)
-    }
-  })
+		ws.onerror = () => {
+			clearTimeout(timeout)
+			resolve(false)
+		}
+	})
 }

package/templates/tauri-react/src/updater.ts

@@ -19,20 +19,20 @@ let updateChecked = false
  * Silently skips if the updater is not configured (empty endpoints/pubkey).
  */
 export async function checkForUpdates(): Promise<void> {
-  if (updateChecked) return
-  updateChecked = true
+	if (updateChecked) return
+	updateChecked = true
 
-  try {
-    const { check } = await import('@tauri-apps/plugin-updater')
-    const update = await check()
-    if (update) {
-      console.log(`Update available: v${update.version}`)
-      // Download and install — the app will restart automatically
-      await update.downloadAndInstall()
-    }
-  } catch (err) {
-    // Updater not configured or network unavailable — this is fine.
-    // The app works fully offline; updates are best-effort.
-    console.debug('Update check skipped:', err)
-  }
+	try {
+		const { check } = await import('@tauri-apps/plugin-updater')
+		const update = await check()
+		if (update) {
+			console.log(`Update available: v${update.version}`)
+			// Download and install — the app will restart automatically
+			await update.downloadAndInstall()
+		}
+	} catch (err) {
+		// Updater not configured or network unavailable — this is fine.
+		// The app works fully offline; updates are best-effort.
+		console.debug('Update check skipped:', err)
+	}
 }

package/templates/tauri-react/src/vite-env.d.ts

@@ -0,0 +1,17 @@
+interface ImportMetaEnv {
+	readonly VITE_SYNC_URL?: string
+}
+
+interface ImportMeta {
+	readonly env: ImportMetaEnv
+}
+
+declare module '*?worker&url' {
+	const url: string
+	export default url
+}
+
+declare module '*?url' {
+	const url: string
+	export default url
+}

package/templates/tauri-react/src-tauri/tauri.conf.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://raw.githubusercontent.com/nicholasgriffintn/tauri/refs/heads/dev/crates/tauri-config-schema/schema.json",
+  "$schema": "https://raw.githubusercontent.com/tauri-apps/tauri/dev/crates/tauri-config-schema/schema.json",
   "productName": "kora-app",
   "version": "0.0.1",
   "identifier": "com.kora.app",

package/templates/tauri-react/tsconfig.json.hbs

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "jsx": "react-jsx",
+    "strict": true,
+    "noUncheckedIndexedAccess": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "outDir": "dist"
+  },
+  "include": ["src"]
+}

package/templates/tauri-react/vite.config.ts

@@ -3,13 +3,13 @@ import { defineConfig } from 'vite'
 
 // Tauri apps use native SQLite — no WASM, no OPFS, no cross-origin isolation needed.
 export default defineConfig({
-  plugins: [react()],
-  // Prevent Vite from obscuring Rust compilation errors
-  clearScreen: false,
-  server: {
-    // Tauri expects a fixed port; fail if it's not available
-    strictPort: true,
-  },
-  // Environment variables with this prefix are exposed to the app
-  envPrefix: ['VITE_', 'TAURI_'],
+	plugins: [react()],
+	// Prevent Vite from obscuring Rust compilation errors
+	clearScreen: false,
+	server: {
+		// Tauri expects a fixed port; fail if it's not available
+		strictPort: true,
+	},
+	// Environment variables with this prefix are exposed to the app
+	envPrefix: ['VITE_', 'TAURI_'],
 })

package/templates/vue-basic/README.md.hbs

@@ -0,0 +1,62 @@
+# {{projectName}}
+
+An offline-first application built with [Kora.js](https://ehoneahobed.github.io/kora/).
+
+## Getting Started
+
+```bash
+npm run dev
+```
+
+- **App**: http://localhost:5173
+
+## Project Structure
+
+```
+src/
+  schema.ts        # Schema entry point
+  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
+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.
+
+## Scripts
+
+| Script | Description |
+|--------|-------------|
+| `npm run dev` | Start dev server |
+| `npm run build` | Build for production |
+| `npm run preview` | Preview production build |
+
+## Adding Sync
+
+To enable real-time sync across devices, update `src/main.tsx`:
+
+```typescript
+const app = createApp({
+  schema,
+  sync: {
+    url: import.meta.env.VITE_SYNC_URL || 'ws://localhost:3001',
+  },
+  // ...
+})
+```
+
+Then create a `server.ts` and install `@korajs/server`. See the [Sync Configuration guide](https://ehoneahobed.github.io/kora/guide/sync-configuration).
+
+## Learn More
+
+- [Documentation](https://ehoneahobed.github.io/kora/)
+- [Storage Configuration](https://ehoneahobed.github.io/kora/guide/storage-configuration)
+- [Schema Design](https://ehoneahobed.github.io/kora/guide/schema-design)

package/templates/vue-basic/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/vue-basic/kora.config.ts

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

package/templates/vue-basic/package.json.hbs

@@ -0,0 +1,26 @@
+{
+  "name": "{{projectName}}",
+  "version": "0.0.1",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "dev": "kora dev",
+    "build": "vue-tsc --noEmit && vite build",
+    "preview": "vite preview"
+  },
+  "dependencies": {
+    "korajs": "{{koraVersion}}",
+    "@korajs/vue": "{{koraVersion}}",
+    "@korajs/store": "{{koraVersion}}",
+    "@sqlite.org/sqlite-wasm": ">=3.51.0-build1",
+    "vue": "^3.5.0",
+    "yjs": "^13.6.30"
+  },
+  "devDependencies": {
+    "@korajs/cli": "{{koraVersion}}",
+    "@vitejs/plugin-vue": "^5.2.0",
+    "typescript": "^5.7.0",
+    "vite": "^6.0.0",
+    "vue-tsc": "^2.2.0"
+  }
+}

package/templates/vue-basic/src/App.vue

@@ -0,0 +1,117 @@
+<script setup lang="ts">
+import { computed, ref } from 'vue'
+import { useTodos } from './modules/todos/useTodos'
+
+type Filter = 'all' | 'active' | 'completed'
+
+const { allTodos, activeTodos, completedTodos, addTodo, toggleTodo, deleteTodo } = useTodos()
+
+const filter = ref<Filter>('all')
+const input = ref('')
+
+const filteredTodos = computed(() => {
+	if (filter.value === 'active') return activeTodos.value
+	if (filter.value === 'completed') return completedTodos.value
+	return allTodos.value
+})
+
+function handleSubmit(): void {
+	const title = input.value.trim()
+	if (!title) return
+	addTodo.mutate({ title })
+	input.value = ''
+}
+
+function clearCompleted(): void {
+	for (const todo of completedTodos.value) {
+		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>
+
+<template>
+	<div class="app">
+		<div class="header">
+			<h1>My Tasks</h1>
+		</div>
+
+		<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" @submit.prevent="handleSubmit">
+			<input v-model="input" type="text" placeholder="What needs to be done?" />
+			<button type="submit" :disabled="!input.trim()">Add</button>
+		</form>
+
+		<div class="filters">
+			<button
+				v-for="f in (['all', 'active', 'completed'] as const)"
+				:key="f"
+				type="button"
+				:class="['filter-btn', { active: filter === f }]"
+				@click="filter = f"
+			>
+				{{ f.charAt(0).toUpperCase() + f.slice(1) }}
+				<span class="badge">
+					{{
+						f === 'all'
+							? allTodos.length
+							: f === 'active'
+								? activeTodos.length
+								: completedTodos.length
+					}}
+				</span>
+			</button>
+		</div>
+
+		<div class="todo-list">
+			<div v-if="filteredTodos.length === 0" class="empty-state">
+				<template v-if="filter === 'all'">No tasks yet. Add one above!</template>
+				<template v-else-if="filter === 'active'">All caught up! No active tasks.</template>
+				<template v-else>No completed tasks yet.</template>
+			</div>
+			<div v-for="todo in filteredTodos" v-else :key="todo.id" class="todo-item">
+				<button
+					type="button"
+					:class="['toggle', { checked: todo.completed }]"
+					@click="toggleTodo.mutate(todo.id, { completed: !todo.completed })"
+				>
+					{{ todo.completed ? '✓' : '' }}
+				</button>
+				<span :class="['title', { done: todo.completed }]">{{ String(todo.title) }}</span>
+				<span v-if="todo.createdAt" class="time">{{ formatTime(Number(todo.createdAt)) }}</span>
+				<button type="button" class="delete-btn" @click="deleteTodo.mutate(todo.id)">×</button>
+			</div>
+		</div>
+
+		<div v-if="allTodos.length > 0" class="footer">
+			<span>{{ activeTodos.length }} item{{ activeTodos.length !== 1 ? 's' : '' }} left</span>
+			<button v-if="completedTodos.length > 0" type="button" @click="clearCompleted">
+				Clear completed
+			</button>
+		</div>
+
+		<p class="branding">Powered by Kora — offline-first</p>
+	</div>
+</template>