edinburgh 0.4.1 → 0.4.2

package/LICENSE

@@ -1,6 +1,6 @@
 ISC License
 
-Copyright (c) 2025 Frank van Viegen
+Copyright (c) 2026 Frank van Viegen
 
 Permission to use, copy, modify, and/or distribute this software for any
 purpose with or without fee is hereby granted, provided that the above

package/README.md

@@ -70,7 +70,9 @@ await E.transact(() => {
 });    
 ```
 
-## TypeScript Configuration
+## Tutorial
+
+### TypeScript Configuration
 
 When using TypeScript to transpile to JavaScript, make sure to enable the following options in your `tsconfig.json`:
 
@@ -83,15 +85,322 @@ When using TypeScript to transpile to JavaScript, make sure to enable the follow
 }
 ```
 
-## Logging
+### Defining Models
+
+Models are classes that extend `E.Model<Self>` and use the `@E.registerModel` decorator:
+
+```typescript
+import * as E from "edinburgh";
+
+@E.registerModel
+class User extends E.Model<User> {
+  static pk = E.primary(User, "id");
+
+  id = E.field(E.identifier);
+  name = E.field(E.string);
+  email = E.field(E.string);
+  age = E.field(E.number);
+}
+```
+
+Instance fields are declared with `E.field(type, options?)`. Available types:
+
+| Type | TypeScript type | Notes |
+|------|----------------|-------|
+| `E.string` | `string` | |
+| `E.orderedString` | `string` | Lexicographic sort in indexes; no null bytes |
+| `E.number` | `number` | |
+| `E.boolean` | `boolean` | |
+| `E.dateTime` | `Date` | Defaults to `new Date()` |
+| `E.identifier` | `string` | Auto-generated 8-char unique ID |
+| `E.opt(T)` | `T \| undefined` | Makes any type optional |
+| `E.or(A, B, ...)` | `A \| B \| ...` | Union type; args can be types or literal values |
+| `E.literal(v)` | literal type | Constant value; defaults to that value |
+| `E.array(T)` | `T[]` | Optional `{min, max}` constraints |
+| `E.link(Model)` | `Model` | Foreign key, lazy-loaded on access |
+
+#### Defaults
+
+```typescript
+@E.registerModel
+class Post extends E.Model<Post> {
+  static pk = E.primary(Post, "id");
+
+  id = E.field(E.identifier);  // auto-generated
+  title = E.field(E.string);
+  status = E.field(E.or("draft", "published"), {default: "draft"});
+  tags = E.field(E.array(E.string), {default: () => []});  // use function for mutable defaults
+  createdAt = E.field(E.dateTime);  // dateTime defaults to new Date()
+}
+```
+
+### Transactions
+
+All database operations must run inside `E.transact()`:
+
+```typescript
+// Initialize (optional — defaults to ".edinburgh" directory)
+E.init("./my-database");
+
+// Create
+await E.transact(() => {
+  const user = new User({name: "Alice", email: "alice@example.com", age: 30});
+  // user.id is auto-generated
+});
+
+// Read + Update
+await E.transact(() => {
+  const user = User.byEmail.get("alice@example.com");
+  if (user) user.age++;
+});
+
+// Return values from transactions
+const name = await E.transact(() => {
+  const user = User.byEmail.get("alice@example.com");
+  return user?.name;
+});
+```
+
+Transactions auto-retry on conflict (up to 6 times by default). Keep transaction functions idempotent.
+
+### Indexes
+
+Edinburgh supports three index types:
+
+```typescript
+@E.registerModel
+class Product extends E.Model<Product> {
+  static pk = E.primary(Product, "sku");           // primary: one per model, stores data
+  static byName = E.unique(Product, "name");       // unique: enforces uniqueness + fast lookup
+  static byCategory = E.index(Product, "category");// secondary: non-unique, for queries
+
+  sku = E.field(E.string);
+  name = E.field(E.string);
+  category = E.field(E.string);
+  price = E.field(E.number);
+}
+```
+
+If no `E.primary()` is declared, Edinburgh auto-creates one on an `id` field (adding `E.identifier` if missing).
+
+#### Lookups
+
+```typescript
+await E.transact(() => {
+  // Primary key lookup
+  const p = Product.pk.get("SKU-001");
+
+  // Unique index lookup
+  const p2 = Product.byName.get("Widget");
+
+  // All return undefined if not found
+});
+```
+
+#### Range Queries
+
+All index types support `.find()` for range iteration:
+
+```typescript
+await E.transact(() => {
+  // Exact match
+  for (const p of Product.byCategory.find({is: "electronics"})) {
+    console.log(p.name);
+  }
+
+  // Range (inclusive)
+  for (const p of Product.pk.find({from: "A", to: "M"})) {
+    console.log(p.sku);
+  }
+
+  // Exclusive bounds
+  for (const p of Product.pk.find({after: "A", before: "M"})) { ... }
+
+  // Open-ended
+  for (const p of Product.pk.find({from: "M"})) { ... }
+
+  // Reverse
+  for (const p of Product.pk.find({reverse: true})) { ... }
+
+  // Count and fetch helpers
+  const count = Product.byCategory.find({is: "electronics"}).count();
+  const first = Product.byCategory.find({is: "electronics"}).fetch(); // first match or undefined
+});
+```
+
+#### Composite Indexes
+
+```typescript
+@E.registerModel
+class Event extends E.Model<Event> {
+  static pk = E.primary(Event, ["year", "month", "id"]);
+
+  year = E.field(E.number);
+  month = E.field(E.number);
+  id = E.field(E.identifier);
+  title = E.field(E.string);
+}
+
+await E.transact(() => {
+  // Prefix matching — find all events in 2025
+  for (const e of Event.pk.find({is: [2025]})) { ... }
+
+  // Find events in March 2025
+  for (const e of Event.pk.find({is: [2025, 3]})) { ... }
+});
+```
+
+### Relationships (Links)
+
+Use `E.link(Model)` for foreign keys:
+
+```typescript
+@E.registerModel
+class Author extends E.Model<Author> {
+  static pk = E.primary(Author, "id");
+  id = E.field(E.identifier);
+  name = E.field(E.string);
+}
+
+@E.registerModel
+class Book extends E.Model<Book> {
+  static pk = E.primary(Book, "id");
+  id = E.field(E.identifier);
+  title = E.field(E.string);
+  author = E.field(E.link(Author));
+}
+
+await E.transact(() => {
+  const author = new Author({name: "Tolkien"});
+  const book = new Book({title: "The Hobbit", author});
+
+  // Later: linked models are lazy-loaded on property access
+  const b = Book.pk.get(book.id)!;
+  console.log(b.author.name);  // loads Author automatically (~1µs)
+});
+```
+
+### Deleting
+
+```typescript
+await E.transact(() => {
+  const user = User.pk.get(someId);
+  if (user) user.delete();
+});
+```
+
+### Model Utilities
+
+```typescript
+await E.transact(() => {
+  const user = new User({name: "Bob", email: "bob@example.com", age: 25});
+
+  user.validate();     // returns Error[]
+  user.isValid();      // returns boolean
+  user.getState();     // "created" | "loaded" | "lazy" | "deleted"
+  user.getPrimaryKey(); // Uint8Array
+  user.preventPersist(); // exclude from commit
+});
+
+// findAll iterates all instances
+await E.transact(() => {
+  for (const user of User.findAll()) { ... }
+  for (const user of User.findAll({reverse: true})) { ... }
+});
+
+// replaceInto: upsert by primary key
+await E.transact(() => {
+  User.replaceInto({id: existingId, name: "Updated Name", email: "new@example.com", age: 30});
+});
+```
+
+### Batch Processing
+
+For large datasets, `batchProcess` auto-commits in batches:
+
+```typescript
+await Product.byCategory.batchProcess({is: "old"}, (product) => {
+  product.category = "archived";
+});
+// Commits every ~1 second or 4096 rows (configurable via limitSeconds, limitRows)
+```
+
+### Schema Evolution
 
-You can enable debug logging to stdout by setting the `EDINBURGH_LOG_LEVEL` environment variable to a number from 0 to 3. Higher numbers produce more verbose logs, including model-level operations, updates, and reads.
+Edinburgh handles schema changes automatically:
+
+- **Adding/removing fields**: Old rows are lazily migrated on read. New fields use their default value.
+- **Changing field types**: Requires a `static migrate()` function.
+- **Adding/removing indexes**: Requires running `npx migrate-edinburgh`.
+
+```typescript
+@E.registerModel
+class User extends E.Model<User> {
+  static pk = E.primary(User, "id");
+  id = E.field(E.identifier);
+  name = E.field(E.string);
+  role = E.field(E.string, {default: "user"});  // new field
+
+  static migrate(record: Record<string, any>) {
+    record.role ??= "user";  // provide value for old rows
+  }
+}
+```
+
+Run `npx migrate-edinburgh` (or call `E.runMigration()`) after adding/removing indexes, changing index field types, or when a `migrate()` function affects indexed fields.
+
+### preCommit Hook
+
+Compute derived fields before data is written:
+
+```typescript
+@E.registerModel
+class Article extends E.Model<Article> {
+  static pk = E.primary(Article, "id");
+  id = E.field(E.identifier);
+  title = E.field(E.string);
+  slug = E.field(E.string);
+
+  preCommit() {
+    this.slug = this.title.toLowerCase().replace(/\s+/g, "-");
+  }
+}
+```
+
+### Change Tracking
+
+Monitor commits with `setOnSaveCallback`:
+
+```typescript
+E.setOnSaveCallback((commitId, items) => {
+  for (const [instance, change] of items) {
+    if (change === "created") { /* new record */ }
+    else if (change === "deleted") { /* removed */ }
+    else { /* change is an object with old values of modified fields */ }
+  }
+});
+```
+
+### Logging
+
+Enable debug logging by setting the `EDINBURGH_LOG_LEVEL` environment variable (0–3). Higher numbers produce more verbose logs.
 
 - 0: no logging (default)
 - 1: model-level logs
 - 2: + update logs
 - 3: + read logs
 
+### AI Integration
+
+If you use Claude Code, GitHub Copilot or another AI agent that supports Skills, Edinburgh includes a `skill/` directory in its npm package that provides specialized knowledge to the AI about how to use the library effectively.
+
+Symlink the skill into your project's `.claude/skills` directory:
+
+```bash
+mkdir -p .claude/skills
+ln -s ../../node_modules/edinburgh/skill .claude/skills/edinburgh
+```
+
 ## API Reference
 
 The following is auto-generated from `src/edinburgh.ts`:
@@ -219,19 +528,19 @@ class User extends E.Model<User> {
 }
 ```
 
-#### Model.tableName · [static property](https://github.com/vanviegen/edinburgh/blob/main/src/edinburgh.ts#L226)
+#### Model.tableName · [static property](https://github.com/vanviegen/edinburgh/blob/main/src/edinburgh.ts#L225)
 
 The database table name (defaults to class name).
 
 **Type:** `string`
 
-#### Model.override · [static property](https://github.com/vanviegen/edinburgh/blob/main/src/edinburgh.ts#L230)
+#### Model.override · [static property](https://github.com/vanviegen/edinburgh/blob/main/src/edinburgh.ts#L229)
 
 When true, registerModel replaces an existing model with the same tableName.
 
 **Type:** `boolean`
 
-#### Model.fields · [static property](https://github.com/vanviegen/edinburgh/blob/main/src/edinburgh.ts#L231)
+#### Model.fields · [static property](https://github.com/vanviegen/edinburgh/blob/main/src/edinburgh.ts#L230)
 
 Field configuration metadata.
 
@@ -772,7 +1081,7 @@ This is primarily useful for development and debugging purposes.
 
 **Signature:** `() => void`
 
-### BaseIndex · [abstract class](https://github.com/vanviegen/edinburgh/blob/main/src/edinburgh.ts#L128)
+### BaseIndex · [abstract class](https://github.com/vanviegen/edinburgh/blob/main/src/edinburgh.ts#L127)
 
 Base class for database indexes for efficient lookups on model fields.
 

package/build/src/edinburgh.js

@@ -1,7 +1,7 @@
 import * as lowlevel from "olmdb/lowlevel";
 import { init as olmdbInit, DatabaseError } from "olmdb/lowlevel";
 import { modelRegistry, txnStorage, currentTxn } from "./models.js";
-let initNeeded = false;
+let initNeeded = true;
 export function scheduleInit() { initNeeded = true; }
 // Re-export public API from models
 export { Model, registerModel, field, } from "./models.js";
@@ -90,8 +90,9 @@ export async function transact(fn) {
                 for (const model of Object.values(modelRegistry)) {
                     await model._delayedInit();
                 }
-                pendingInit = undefined;
             })();
+            await pendingInit;
+            pendingInit = undefined;
         }
     }
     // try {

package/build/src/edinburgh.js.map

@@ -1 +1 @@
-{"version":3,"file":"edinburgh.js","sourceRoot":"","sources":["../../src/edinburgh.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,QAAQ,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,IAAI,IAAI,SAAS,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAClE,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAEpE,IAAI,UAAU,GAAG,KAAK,CAAC;AACvB,MAAM,UAAU,YAAY,KAAK,UAAU,GAAG,IAAI,CAAC,CAAC,CAAC;AAGrD,mCAAmC;AACnC,OAAO,EACH,KAAK,EACL,aAAa,EACb,KAAK,GACR,MAAM,aAAa,CAAC;AAIrB,yEAAyE;AACzE,OAAO;AACH,6BAA6B;AAC7B,MAAM,EACN,aAAa,EACb,MAAM,EACN,QAAQ,EACR,OAAO,EACP,UAAU,EACV,KAAK;AACL,yBAAyB;AACzB,GAAG,EACH,EAAE,EACF,KAAK,EACL,OAAO,EACP,IAAI,GACP,MAAM,YAAY,CAAC;AAEpB,oCAAoC;AACpC,OAAO,EACH,KAAK,EACL,OAAO,EACP,MAAM,EACN,IAAI,GACP,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAIpF,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAG5C,IAAI,UAAU,GAAG,KAAK,CAAC;AACvB,IAAI,aAAa,GAAG,CAAC,CAAC;AAEtB;;;;;;;;;GASG;AACH,MAAM,UAAU,IAAI,CAAC,KAAa;IAC9B,UAAU,GAAG,IAAI,CAAC;IAClB,SAAS,CAAC,KAAK,CAAC,CAAC;AACrB,CAAC;AAED,IAAI,WAAsC,CAAC;AAG3C,MAAM,yBAAyB,GAAG;IAC9B,GAAG;QACC,MAAM,IAAI,aAAa,CAAC,mDAAmD,EAAE,gBAAgB,CAAC,CAAC;IACnG,CAAC;CACJ,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAoCE;AACF,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAI,EAAW;IACzC,OAAO,UAAU,IAAI,WAAW,EAAE,CAAC;QAC/B,gFAAgF;QAChF,IAAI,WAAW,EAAE,CAAC;YACd,MAAM,WAAW,CAAC;QACtB,CAAC;aAAM,CAAC;YACJ,WAAW,GAAG,CAAC,KAAK,IAAI,EAAE;gBACtB,IAAI,CAAC,UAAU;oBAAE,SAAS,CAAC,YAAY,CAAC,CAAC;gBACzC,UAAU,GAAG,IAAI,CAAC;gBAElB,UAAU,GAAG,KAAK,CAAC;gBACnB,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC;oBAC/C,MAAM,KAAK,CAAC,YAAY,EAAE,CAAC;gBAC/B,CAAC;gBACD,WAAW,GAAG,SAAS,CAAC;YAC5B,CAAC,CAAC,EAAE,CAAC;QACT,CAAC;IACL,CAAC;IAED,QAAQ;IACJ,KAAK,IAAI,UAAU,GAAG,CAAC,EAAE,UAAU,GAAG,aAAa,EAAE,UAAU,EAAE,EAAE,CAAC;QAChE,MAAM,KAAK,GAAG,QAAQ,CAAC,gBAAgB,EAAE,CAAC;QAC1C,MAAM,GAAG,GAAgB,EAAE,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,GAAG,EAAE,EAAE,aAAa,EAAE,IAAI,GAAG,EAAE,EAAE,CAAC;QACvF,MAAM,WAAW,GAA4C,cAAc,CAAC,CAAC,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QAEpG,IAAI,MAAqB,CAAC;QAC1B,IAAI,CAAC;YACD,MAAM,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK;gBAC3B,MAAM,GAAG,MAAM,EAAE,EAAE,CAAC;gBAEpB,oDAAoD;gBACpD,wEAAwE;gBACxE,sCAAsC;gBACtC,KAAK,MAAM,QAAQ,IAAI,GAAG,CAAC,SAAS,EAAE,CAAC;oBACnC,QAAQ,CAAC,SAAS,EAAE,EAAE,CAAC;gBAC3B,CAAC;gBAED,gDAAgD;gBAChD,+EAA+E;gBAC/E,4CAA4C;gBAC5C,KAAK,MAAM,QAAQ,IAAI,GAAG,CAAC,SAAS,EAAE,CAAC;oBACnC,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;oBACpC,IAAI,WAAW,IAAI,MAAM,EAAE,CAAC;wBACxB,WAAW,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;oBACtC,CAAC;gBACL,CAAC;YACL,CAAC,CAAC,CAAC;QACP,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YACd,IAAI,CAAC;gBAAC,QAAQ,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;YAAC,CAAC;YAAC,MAAM,CAAC,CAAA,CAAC;YAClD,MAAM,CAAC,CAAC;QACZ,CAAC;gBAAS,CAAC;YACP,kFAAkF;YAClF,KAAK,MAAM,QAAQ,IAAI,GAAG,CAAC,SAAS,EAAE,CAAC;gBACnC,OAAO,QAAQ,CAAC,UAAU,CAAC;gBAC3B,MAAM,CAAC,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,yBAAyB,CAAC,CAAC;gBACnE,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAC5B,CAAC;YACD,mFAAmF;YACnF,iDAAiD;YACjD,GAAG,CAAC,EAAE,GAAG,GAAG,CAAC,SAAS,GAAG,GAAG,CAAC,aAAa,GAAG,SAAgB,CAAC;QAClE,CAAC;QAED,MAAM,YAAY,GAAG,QAAQ,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;QACvD,MAAM,SAAS,GAAG,OAAO,YAAY,KAAK,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,MAAM,YAAY,CAAC;QAEvF,IAAI,SAAS,GAAG,CAAC,EAAE,CAAC;YAChB,UAAU;YACV,IAAI,WAAW,EAAE,IAAI,EAAE,CAAC;gBACpB,cAAe,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;YAC5C,CAAC;YACD,OAAO,MAAW,CAAC;QACvB,CAAC;QAED,yBAAyB;IAC7B,CAAC;IACD,MAAM,IAAI,aAAa,CAAC,iCAAiC,EAAE,oBAAoB,CAAC,CAAC;IACrF,6BAA6B;IAC7B,kEAAkE;IAClE,oEAAoE;IACpE,gDAAgD;IAChD,eAAe;IACf,IAAI;AACR,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAa;IAC1C,aAAa,GAAG,KAAK,CAAC;AAC1B,CAAC;AAED,IAAI,cAAwF,CAAC;AAE7F;;;;;;;GAOG;AACH,MAAM,UAAU,iBAAiB,CAAC,QAAkF;IAChH,cAAc,GAAG,QAAQ,CAAC;AAC9B,CAAC;AAGD,MAAM,CAAC,KAAK,UAAU,gBAAgB;IAClC,IAAI,IAAI,GAAG,KAAK,CAAC;IACjB,OAAO,CAAC,IAAI,EAAE,CAAC;QACX,MAAM,QAAQ,CAAC,GAAG,EAAE;YAChB,MAAM,GAAG,GAAG,UAAU,EAAE,CAAC;YACzB,MAAM,UAAU,GAAG,QAAQ,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,EAAE,SAAS,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;YAChF,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,GAAG,CAAC;YAClC,IAAI,KAAK,GAAG,CAAC,CAAC;YACd,IAAI,CAAC;gBACD,OAAO,IAAI,EAAE,CAAC;oBACV,MAAM,GAAG,GAAG,QAAQ,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;oBAC9C,IAAI,CAAC,GAAG,EAAE,CAAC;wBAAC,IAAI,GAAG,IAAI,CAAC;wBAAC,MAAM;oBAAC,CAAC;oBACjC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;oBAC9B,IAAI,EAAE,KAAK,IAAI,IAAI,IAAI,IAAI,CAAC,GAAG,EAAE,IAAI,QAAQ;wBAAE,MAAM;gBACzD,CAAC;YACL,CAAC;oBAAS,CAAC;gBACP,QAAQ,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;YACvC,CAAC;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IACD,6CAA6C;IAC7C,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC;QAC/C,IAAI,CAAC,KAAK,CAAC,MAAM;YAAE,SAAS;QAC5B,MAAM,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;AACL,CAAC"}
+{"version":3,"file":"edinburgh.js","sourceRoot":"","sources":["../../src/edinburgh.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,QAAQ,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,IAAI,IAAI,SAAS,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAClE,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAEpE,IAAI,UAAU,GAAG,IAAI,CAAC;AACtB,MAAM,UAAU,YAAY,KAAK,UAAU,GAAG,IAAI,CAAC,CAAC,CAAC;AAGrD,mCAAmC;AACnC,OAAO,EACH,KAAK,EACL,aAAa,EACb,KAAK,GACR,MAAM,aAAa,CAAC;AAIrB,yEAAyE;AACzE,OAAO;AACH,6BAA6B;AAC7B,MAAM,EACN,aAAa,EACb,MAAM,EACN,QAAQ,EACR,OAAO,EACP,UAAU,EACV,KAAK;AACL,yBAAyB;AACzB,GAAG,EACH,EAAE,EACF,KAAK,EACL,OAAO,EACP,IAAI,GACP,MAAM,YAAY,CAAC;AAEpB,oCAAoC;AACpC,OAAO,EACH,KAAK,EACL,OAAO,EACP,MAAM,EACN,IAAI,GACP,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAIpF,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAG5C,IAAI,UAAU,GAAG,KAAK,CAAC;AACvB,IAAI,aAAa,GAAG,CAAC,CAAC;AAEtB;;;;;;;;;GASG;AACH,MAAM,UAAU,IAAI,CAAC,KAAa;IAC9B,UAAU,GAAG,IAAI,CAAC;IAClB,SAAS,CAAC,KAAK,CAAC,CAAC;AACrB,CAAC;AAED,IAAI,WAAsC,CAAC;AAG3C,MAAM,yBAAyB,GAAG;IAC9B,GAAG;QACC,MAAM,IAAI,aAAa,CAAC,mDAAmD,EAAE,gBAAgB,CAAC,CAAC;IACnG,CAAC;CACJ,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAoCE;AACF,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAI,EAAW;IACzC,OAAO,UAAU,IAAI,WAAW,EAAE,CAAC;QAC/B,gFAAgF;QAChF,IAAI,WAAW,EAAE,CAAC;YACd,MAAM,WAAW,CAAC;QACtB,CAAC;aAAM,CAAC;YACJ,WAAW,GAAG,CAAC,KAAK,IAAI,EAAE;gBACtB,IAAI,CAAC,UAAU;oBAAE,SAAS,CAAC,YAAY,CAAC,CAAC;gBACzC,UAAU,GAAG,IAAI,CAAC;gBAClB,UAAU,GAAG,KAAK,CAAC;gBACnB,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC;oBAC/C,MAAM,KAAK,CAAC,YAAY,EAAE,CAAC;gBAC/B,CAAC;YACL,CAAC,CAAC,EAAE,CAAC;YACL,MAAM,WAAW,CAAC;YAClB,WAAW,GAAG,SAAS,CAAC;QAC5B,CAAC;IACL,CAAC;IAED,QAAQ;IACJ,KAAK,IAAI,UAAU,GAAG,CAAC,EAAE,UAAU,GAAG,aAAa,EAAE,UAAU,EAAE,EAAE,CAAC;QAChE,MAAM,KAAK,GAAG,QAAQ,CAAC,gBAAgB,EAAE,CAAC;QAC1C,MAAM,GAAG,GAAgB,EAAE,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,GAAG,EAAE,EAAE,aAAa,EAAE,IAAI,GAAG,EAAE,EAAE,CAAC;QACvF,MAAM,WAAW,GAA4C,cAAc,CAAC,CAAC,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QAEpG,IAAI,MAAqB,CAAC;QAC1B,IAAI,CAAC;YACD,MAAM,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK;gBAC3B,MAAM,GAAG,MAAM,EAAE,EAAE,CAAC;gBAEpB,oDAAoD;gBACpD,wEAAwE;gBACxE,sCAAsC;gBACtC,KAAK,MAAM,QAAQ,IAAI,GAAG,CAAC,SAAS,EAAE,CAAC;oBACnC,QAAQ,CAAC,SAAS,EAAE,EAAE,CAAC;gBAC3B,CAAC;gBAED,gDAAgD;gBAChD,+EAA+E;gBAC/E,4CAA4C;gBAC5C,KAAK,MAAM,QAAQ,IAAI,GAAG,CAAC,SAAS,EAAE,CAAC;oBACnC,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;oBACpC,IAAI,WAAW,IAAI,MAAM,EAAE,CAAC;wBACxB,WAAW,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;oBACtC,CAAC;gBACL,CAAC;YACL,CAAC,CAAC,CAAC;QACP,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YACd,IAAI,CAAC;gBAAC,QAAQ,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;YAAC,CAAC;YAAC,MAAM,CAAC,CAAA,CAAC;YAClD,MAAM,CAAC,CAAC;QACZ,CAAC;gBAAS,CAAC;YACP,kFAAkF;YAClF,KAAK,MAAM,QAAQ,IAAI,GAAG,CAAC,SAAS,EAAE,CAAC;gBACnC,OAAO,QAAQ,CAAC,UAAU,CAAC;gBAC3B,MAAM,CAAC,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,yBAAyB,CAAC,CAAC;gBACnE,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAC5B,CAAC;YACD,mFAAmF;YACnF,iDAAiD;YACjD,GAAG,CAAC,EAAE,GAAG,GAAG,CAAC,SAAS,GAAG,GAAG,CAAC,aAAa,GAAG,SAAgB,CAAC;QAClE,CAAC;QAED,MAAM,YAAY,GAAG,QAAQ,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;QACvD,MAAM,SAAS,GAAG,OAAO,YAAY,KAAK,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,MAAM,YAAY,CAAC;QAEvF,IAAI,SAAS,GAAG,CAAC,EAAE,CAAC;YAChB,UAAU;YACV,IAAI,WAAW,EAAE,IAAI,EAAE,CAAC;gBACpB,cAAe,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;YAC5C,CAAC;YACD,OAAO,MAAW,CAAC;QACvB,CAAC;QAED,yBAAyB;IAC7B,CAAC;IACD,MAAM,IAAI,aAAa,CAAC,iCAAiC,EAAE,oBAAoB,CAAC,CAAC;IACrF,6BAA6B;IAC7B,kEAAkE;IAClE,oEAAoE;IACpE,gDAAgD;IAChD,eAAe;IACf,IAAI;AACR,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAa;IAC1C,aAAa,GAAG,KAAK,CAAC;AAC1B,CAAC;AAED,IAAI,cAAwF,CAAC;AAE7F;;;;;;;GAOG;AACH,MAAM,UAAU,iBAAiB,CAAC,QAAkF;IAChH,cAAc,GAAG,QAAQ,CAAC;AAC9B,CAAC;AAGD,MAAM,CAAC,KAAK,UAAU,gBAAgB;IAClC,IAAI,IAAI,GAAG,KAAK,CAAC;IACjB,OAAO,CAAC,IAAI,EAAE,CAAC;QACX,MAAM,QAAQ,CAAC,GAAG,EAAE;YAChB,MAAM,GAAG,GAAG,UAAU,EAAE,CAAC;YACzB,MAAM,UAAU,GAAG,QAAQ,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,EAAE,SAAS,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;YAChF,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,GAAG,CAAC;YAClC,IAAI,KAAK,GAAG,CAAC,CAAC;YACd,IAAI,CAAC;gBACD,OAAO,IAAI,EAAE,CAAC;oBACV,MAAM,GAAG,GAAG,QAAQ,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;oBAC9C,IAAI,CAAC,GAAG,EAAE,CAAC;wBAAC,IAAI,GAAG,IAAI,CAAC;wBAAC,MAAM;oBAAC,CAAC;oBACjC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;oBAC9B,IAAI,EAAE,KAAK,IAAI,IAAI,IAAI,IAAI,CAAC,GAAG,EAAE,IAAI,QAAQ;wBAAE,MAAM;gBACzD,CAAC;YACL,CAAC;oBAAS,CAAC;gBACP,QAAQ,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;YACvC,CAAC;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IACD,6CAA6C;IAC7C,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC;QAC/C,IAAI,CAAC,KAAK,CAAC,MAAM;YAAE,SAAS;QAC5B,MAAM,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;AACL,CAAC"}

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "edinburgh",
-  "version": "0.4.1",
+  "version": "0.4.2",
   "author": "Frank van Viegen",
   "devDependencies": {
     "@types/bun": "^1.2.16",
     "@types/node": "^22.10.6",
+    "readme-tsdoc": "^1.1.4",
     "typescript": "^5.8.3",
-    "vitest": "^3.2.4",
-    "readme-tsdoc": "^1.1.4"
+    "vitest": "^3.2.4"
   },
   "exports": {
     ".": {
@@ -27,7 +27,8 @@
   },
   "files": [
     "src",
-    "build/src"
+    "build/src",
+    "skill"
   ],
   "keywords": [
     "orm",
@@ -41,13 +42,13 @@
   ],
   "license": "ISC",
   "scripts": {
-    "build": "rm -rf build && tsc",
+    "build": "rm -rf build skill && tsc && bun run build:docs",
     "test": "npm run test:bun && npm run test:node",
     "test:watch": "bun x vitest --bail 1 --watch --silent=passed-only",
     "test:bun": "bun test --bail",
     "test:node": "bun x vitest --bail 1 --watch=false --silent=passed-only",
-    "prepack": "npm run build && npm run test && npm run readme-tsdoc",
-    "readme-tsdoc": "readme-tsdoc --repo-url https://github.com/vanviegen/edinburgh"
+    "prepack": "npm run build && npm run test && npm run build:docs",
+    "build:docs": "readme-tsdoc && mkdir -p skill && cat skill-header.md README.md > skill/SKILL.md && readme-tsdoc --repo-url https://github.com/vanviegen/edinburgh"
   },
   "trustedDependencies": [
     "olmdb"