@routier/core 0.0.1-alpha.1 → 0.0.1-alpha.2

package/readme.md

@@ -0,0 +1,95 @@
+# Routier
+
+<p align="center">
+  <img src="docs/assets/routier.svg" alt="Routier" width="140" height="140" />
+</p>
+
+> **⚠️ Alpha Release** - This project is currently in alpha. APIs may change between versions. Use with caution in production.
+
+A reactive data toolkit for building fast, local-first apps. Define schemas, create collections, use live queries, and make optimistic mutations with a plugin model for any storage.
+
+**[📖 View Full Documentation](https://agrejus.github.io/routier/)** - Complete guides, API reference, and tutorials
+
+## Features
+
+- **Schema-first**: Type-safe entity definitions with indexes and modifiers
+- **Live queries**: Reactive queries across one or more collections
+- **Optimistic mutations**: Instant UI updates with automatic rollback
+- **Pluggable storage**: Memory, Local Storage, Dexie, SQLite, PouchDB, File System, and more
+- **Change tracking**: Automatic tracking of entity modifications
+- **Performance**: Database-backed filters when possible, in-memory for computed properties
+
+## Quick Start
+
+```bash
+npm install @routier/core @routier/datastore @routier/memory-plugin
+```
+
+```ts
+import { DataStore } from "@routier/datastore";
+import { MemoryPlugin } from "@routier/memory-plugin";
+import { s } from "@routier/core/schema";
+
+// Define a schema
+const userSchema = s
+  .define("users", {
+    id: s.string().key().identity(),
+    name: s.string(),
+    email: s.string().distinct(),
+  })
+  .compile();
+
+// Create a datastore with a plugin
+class AppContext extends DataStore {
+  constructor() {
+    super(new MemoryPlugin("routier-app"));
+  }
+  users = this.collection(userSchema).create();
+}
+
+const ctx = new AppContext();
+
+// Add data
+await ctx.users.addAsync({ name: "Ada", email: "ada@example.com" });
+await ctx.saveChangesAsync();
+
+// Query with live updates
+ctx.users
+  .subscribe()
+  .where((u) => u.name.startsWith("A"))
+  .toArray((result) => {
+    console.log("Live query result:", result);
+  });
+```
+
+## Why Routier?
+
+Choosing storage for local-first apps is hard—and the landscape moves fast. Routier separates your domain model from persistence through a small plugin interface:
+
+- **Swap storage backends** without changing schemas, queries, or UI
+- **Use any framework/ORM/data store** you want via plugins
+- **Experiment safely**: try a new store by writing a plugin
+- **Fill ORM gaps**: feature-rich and easily extended
+
+## Built-in Plugins
+
+- **Memory**: In-memory storage for development and testing
+- **Local Storage**: Browser localStorage/sessionStorage
+- **Dexie**: IndexedDB with Dexie.js
+- **PouchDB**: CouchDB sync and replication
+- **SQLite**: Node.js SQLite integration
+- **File System**: Node.js file-based storage
+
+## Examples
+
+- **[Basic Examples](examples/)** - Vite, Rspack, Node.js setups
+- **[Performance Benchmarks](docs/demos/performance-benchmarks/)** - Speed comparisons
+- **[Real-world Apps](docs/examples/real-world/)** - Complete applications
+
+## Contributing
+
+Issues and PRs welcome! Please see our [Contributing Guide](docs/CONTRIBUTING.md) or open an issue to discuss changes.
+
+## License
+
+MIT

package/CHANGELOG.md

@@ -1,8 +0,0 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
-
-## 0.0.1-alpha.1 (2025-09-18)
-
-**Note:** Version bump only for package @routier/core

package/rspack.config.mjs

@@ -1,65 +0,0 @@
-import { dirname, resolve } from "node:path";
-import { fileURLToPath } from "node:url";
-import { defineConfig } from "@rspack/cli";
-
-const __dirname = dirname(fileURLToPath(import.meta.url));
-
-export default defineConfig({
-    entry: {
-        index: "./src/index.ts",
-        "utilities/index": "./src/utilities/index.ts",
-        "results/index": "./src/results/index.ts",
-        "schema/index": "./src/schema/index.ts",
-        "pipeline/index": "./src/pipeline/index.ts",
-        "collections/index": "./src/collections/index.ts",
-        "assertions/index": "./src/assertions/index.ts",
-        "plugins/index": "./src/plugins/index.ts",
-        "expressions/index": "./src/expressions/index.ts",
-        "errors/index": "./src/errors/index.ts",
-        "performance/index": "./src/performance/index.ts",
-        "types/index": "./src/types/index.ts"
-    },
-    output: {
-        path: resolve(__dirname, "dist"),
-        filename: "[name].js",
-        library: {
-            type: "module"
-        },
-        globalObject: "this", // Ensures compatibility with both browser and Node.js
-        clean: true, // Cleans the output directory before each build
-    },
-    experiments: {
-        outputModule: true
-    },
-    module: {
-        rules: [
-            {
-                test: /\.ts$/, // Match TypeScript files
-                use: {
-                    loader: "ts-loader",
-                    options: {
-                        transpileOnly: false, // Ensure type-checking is performed
-                    },
-                },
-                exclude: [
-                    /node_modules/,
-                    /\.test\.ts$/, // Exclude test files
-                ],
-            },
-        ],
-    },
-    resolve: {
-        extensions: [".ts", ".js"], // Resolve TypeScript and JavaScript files
-        fallback: {
-            "perf_hooks": false
-        }
-    },
-    target: "web", // Compile for both browser and Node.js
-    externals: {
-        // Define external dependencies to avoid bundling them
-        // e.g., for lodash: "lodash": "lodash"
-        "perf_hooks": "perf_hooks"
-    },
-    mode: "development", // Set production mode
-    devtool: "source-map"
-});

package/src/assertions/index.ts

@@ -1,37 +0,0 @@
-import { isDate } from "../utilities";
-
-export function assertDate(data: unknown): asserts data is Date {
-    if (isDate(data) === false) {
-        throw new TypeError('Value is not a Date');
-    }
-}
-
-export function assertIsNotNull<T>(data: T | null | undefined, message?: string): asserts data is NonNullable<T> {
-    if (data == null) {
-        throw new TypeError(message ?? 'Assertion failed, data is null');
-    }
-}
-
-export function assertIsArray<T>(data: unknown, message?: string): asserts data is T[] {
-    if (!Array.isArray(data)) {
-        throw new TypeError(message ?? 'Assertion failed, data is not of type Array');
-    }
-}
-
-export function assertString(data: unknown, message?: string): asserts data is string {
-    if (typeof data !== "string") {
-        throw new TypeError(message ?? 'Assertion failed, data is not of type String');
-    }
-}
-
-export function assertInstanceOf<T extends new (...args: any[]) => any>(value: unknown, Instance: T): asserts value is T {
-    if (value instanceof Instance) {
-        return;
-    }
-
-    if (value != null && typeof value === "object" && "constructor" in value) {
-        throw new TypeError(`Value is not instance of type.  Type: ${value.constructor.name}`);
-    }
-
-    throw new TypeError(`Value is not instance of type`);
-}

package/src/codegen/SlotPath.ts

@@ -1,20 +0,0 @@
-export class SlotPath {
-
-    private _path: string[];
-
-    get path() {
-        return [...this._path]
-    }
-
-    constructor(...pathLike: string[]) {
-        this._path = pathLike;
-    }
-
-    push(...pathLike: string[]) {
-        this._path.push(...pathLike);
-    }
-
-    get(up: number = 0) {
-        return this._path.slice(0, this._path.length - up).join(".")
-    }
-}