@korajs/store 0.1.0 → 0.1.2

package/README.md

@@ -0,0 +1,75 @@
+# @korajs/store
+
+Local storage engine for Kora.js. Supports SQLite WASM with OPFS persistence, IndexedDB fallback, and native SQLite for server-side use. Provides CRUD operations, reactive queries, and subscriptions.
+
+> Most developers don't install this directly. Use [`korajs`](https://www.npmjs.com/package/korajs) instead.
+
+## Install
+
+```bash
+pnpm add @korajs/store
+```
+
+## Usage
+
+### Create a Store
+
+```typescript
+import { createStore } from '@korajs/store'
+import { defineSchema, t } from '@korajs/core'
+
+const schema = defineSchema({
+  version: 1,
+  collections: {
+    todos: {
+      fields: {
+        title: t.string(),
+        completed: t.boolean().default(false),
+        createdAt: t.timestamp().auto(),
+      },
+    },
+  },
+})
+
+const store = await createStore({ schema, adapter: 'sqlite-wasm' })
+```
+
+### Insert and Query
+
+```typescript
+await store.insert('todos', { title: 'Ship Kora v1' })
+
+const active = await store.query('todos', {
+  where: { completed: false },
+  orderBy: { createdAt: 'desc' },
+  limit: 10,
+})
+```
+
+### Reactive Subscriptions
+
+```typescript
+const unsubscribe = store.subscribe(
+  { collection: 'todos', where: { completed: false }, orderBy: { createdAt: 'asc' } },
+  (todos) => {
+    // Called immediately with current data, then on every change
+    console.log(todos)
+  }
+)
+```
+
+## Storage Adapters
+
+| Adapter | Environment | Persistence |
+|---------|-------------|-------------|
+| `sqlite-wasm` | Browser (default) | OPFS |
+| `indexeddb` | Browser (fallback) | IndexedDB |
+| `sqlite-native` | Node.js / Electron | Filesystem |
+
+The adapter is selected automatically based on environment. SQLite WASM runs in a Web Worker to avoid blocking the main thread.
+
+## License
+
+MIT
+
+See the [full documentation](https://github.com/ehoneahobed/kora) for guides, API reference, and examples.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@korajs/store",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Kora.js store package",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -63,7 +63,7 @@
   ],
   "dependencies": {
     "yjs": "^13.6.30",
-    "@korajs/core": "0.1.0"
+    "@korajs/core": "0.1.2"
   },
   "peerDependencies": {
     "@sqlite.org/sqlite-wasm": ">=3.51.0-build1"