@sedrino/db-schema 0.1.1

package/README.md

@@ -0,0 +1,69 @@
+# @sedrino/db-schema
+
+Migration-first schema planning for AI-authored SQLite/libSQL databases.
+
+This package is aimed at a workflow where:
+
+1. AI or humans author migrations in a deterministic TypeScript DSL
+2. the planner materializes the next schema snapshot JSON
+3. the compiler emits generated artifacts such as Drizzle schema code
+
+## Current scope
+
+The first version focuses on the planning layer:
+
+- versioned schema document types
+- migration DSL with deterministic operation recording
+- schema materialization from migration history
+- SQLite DDL emission
+- Drizzle source generation for a narrow SQLite + Temporal-aware subset
+- a libSQL-compatible apply runner with migration/state metadata tables
+- a Bun-first CLI for planning migrations, applying them, and emitting schema artifacts
+
+## Install
+
+```bash
+bun add @sedrino/db-schema
+```
+
+## Example
+
+```ts
+import {
+  compileSchemaToDrizzle,
+  createMigration,
+  planMigration,
+} from "@sedrino/db-schema";
+
+const migration = createMigration(
+  {
+    id: "2026-04-08-001-create-account",
+    name: "Create account table",
+  },
+  (m) => {
+    m.createTable("account", (t) => {
+      t.id("accountId", { prefix: "acct" });
+      t.string("name").required();
+      t.temporalInstant("createdAt").required().defaultNow();
+    });
+  },
+);
+
+const plan = planMigration({ migration });
+const drizzleSource = compileSchemaToDrizzle(plan.nextSchema);
+```
+
+## Docs
+
+- `docs/index.md`
+- `docs/schema-document.md`
+- `docs/migrations.md`
+
+## CLI
+
+```bash
+sedrino-db migrate plan --dir db
+sedrino-db migrate apply --dir db --url file:./local.db
+sedrino-db schema print --dir db
+sedrino-db schema drizzle --dir db --out db/schema/schema.generated.ts
+```