edinburgh 0.4.6 → 0.5.0

package/src/types.ts

@@ -2,7 +2,6 @@ import DataPack from "./datapack.js";
 import { DatabaseError } from "olmdb/lowlevel";
 import { Model, modelRegistry, FieldConfig, currentTxn } from "./models.js";
 import { assert, addErrorPath, dbGet } from "./utils.js";
-import { PrimaryIndex, BaseIndex, IndexRangeIterator } from "./indexes.js";
 
 
 /**
@@ -71,7 +70,7 @@ export abstract class TypeWrapper<const T> {
         return value1 === value2;
     }
 
-    getLinkedModel(): (typeof Model<unknown>) | undefined {
+    getLinkedModel(): undefined | typeof Model<unknown> {
         return;
     }
 }
@@ -355,7 +354,7 @@ class RecordType<T> extends TypeWrapper<Record<string | number, T>> {
 
     serialize(value: Record<string | number, T>, pack: DataPack) {
         pack.writeCollectionBoundary('object');
-        for (const key of Object.keys(value)) {
+        for (const key in value) {
             pack.writeObjectKey(key);
             this.inner.serialize(value[key], pack);
         }
@@ -374,7 +373,7 @@ class RecordType<T> extends TypeWrapper<Record<string | number, T>> {
     }
 
     getError(value: Record<string | number, T>) {
-        if (typeof value !== 'object' || value === null || Array.isArray(value)) {
+        if (typeof value !== 'object' || value === null || Array.isArray(value) || (typeof value.length === 'number' && typeof value[Symbol.iterator as any] === 'function')) {
             return new DatabaseError(`Expected object, got ${typeof value}`, 'INVALID_TYPE');
         }
         for (const key of Object.keys(value)) {
@@ -605,17 +604,22 @@ class IdentifierType extends TypeWrapper<string> {
 * @internal Type wrapper for model relationships (foreign keys).
 * @template T - The target model class type.
 */
-export class LinkType<T extends typeof Model<unknown>> extends TypeWrapper<InstanceType<T>> {
+export class LinkType<T extends new (...args: any[]) => Model<any>> extends TypeWrapper<InstanceType<T>> {
     kind = 'link';
-    tableName: string;
+    private TargetModel: T | (() => T);
 
     /**
     * Create a new LinkType.
-    * @param TargetModel - The model class this link points to.
+    * @param TargetModel - The model class this link points to, or a thunk for forward references.
     */
-    constructor(TargetModel: T) {
+    constructor(TargetModel: T | (() => T)) {
         super();
-        this.tableName = (TargetModel as any).tableName || TargetModel.name;
+        this.TargetModel = TargetModel;
+    }
+
+    getLinkedModel(): typeof Model<unknown> {
+        if (!('getLazy' in this.TargetModel)) this.TargetModel = (this.TargetModel as unknown as () => T)();
+        return this.TargetModel as any;
     }
     
     serialize(model: InstanceType<T>, pack: DataPack) {
@@ -623,31 +627,28 @@ export class LinkType<T extends typeof Model<unknown>> extends TypeWrapper<Insta
     }
     
     deserialize(pack: DataPack) {
-        return modelRegistry[this.tableName]._primary!._get(currentTxn(), pack.readUint8Array(), false);
+        return this.getLinkedModel()._primary._get(currentTxn(), pack.readUint8Array(), false);
     }
     
     getError(value: InstanceType<T>) {
-        if (!(value instanceof modelRegistry[this.tableName])) {
-            return new DatabaseError(`Expected instance of ${this.tableName}, got ${typeof value}`, 'VALUE_ERROR');
+        const TargetModel = this.getLinkedModel();
+        if (!((value as any) instanceof TargetModel)) {
+            return new DatabaseError(`Expected instance of ${TargetModel.tableName}, got ${typeof value}`, 'VALUE_ERROR');
         }
     }
     
     serializeType(pack: DataPack): void {
-        pack.write(this.tableName);
+        pack.write(this.getLinkedModel().tableName);
     }
     
     static deserializeType(pack: DataPack, featureFlags: number): LinkType<any> {
         const tableName = pack.readString();
         const targetModel = modelRegistry[tableName];
         if (!targetModel) throw new DatabaseError(`Could not deserialize undefined model ${tableName}`, 'DESERIALIZATION_ERROR');
-        return new LinkType(targetModel);
+        return new LinkType(targetModel as any);
     }
 
-    toString() { return `link<${this.tableName}>`; }
-
-    getLinkedModel(): T {
-        return modelRegistry[this.tableName] as T;
-    }
+    toString() { return `link<${this.getLinkedModel().tableName}>`; }
 }
 
 /** Type wrapper instance for the string type. */
@@ -781,16 +782,20 @@ export function record<const T>(inner: TypeWrapper<T>): TypeWrapper<Record<strin
 * 
 * @example
 * ```typescript
-* class User extends E.Model<User> {
-*   posts = E.field(E.array(E.link(Post, 'author')));
-* }
+* const Author = E.defineModel(class {
+*   id = E.field(E.identifier);
+*   posts = E.field(E.array(E.link(() => Book)));
+* }, { pk: "id" });
 * 
-* class Post extends E.Model<Post> {
-*   author = E.field(E.link(User));
-* }
+* const Book = E.defineModel(class {
+*   id = E.field(E.identifier);
+*   author = E.field(E.link(Author));
+* }, { pk: "id" });
 * ```
 */
-export function link<const T extends typeof Model<any>>(TargetModel: T): TypeWrapper<InstanceType<T>> {
+export function link<const T extends new (...args: any[]) => Model<any>>(TargetModel: T): TypeWrapper<InstanceType<T>>;
+export function link<const T extends new (...args: any[]) => Model<any>>(TargetModel: () => T): TypeWrapper<InstanceType<T>>;
+export function link(TargetModel: any): TypeWrapper<any> {
     return new LinkType(TargetModel);
 }
 

package/skill/Model_findAll.md

@@ -1,12 +0,0 @@
-#### Model.findAll · static method
-
-Find all instances of this model in the database, ordered by primary key.
-
-**Signature:** `<T extends typeof Model<unknown>>(this: T, opts?: { reverse?: boolean; }) => IndexRangeIterator<T>`
-
-**Parameters:**
-
-- `this: T`
-- `opts?: {reverse?: boolean}` - - Optional parameters.
-
-**Returns:** An iterator.

package/skill/PrimaryIndex.md

@@ -1,8 +0,0 @@
-### PrimaryIndex · class
-
-Primary index that stores the actual model data.
-
-**Type Parameters:**
-
-- `M extends typeof Model` - The model class this index belongs to.
-- `F extends readonly (keyof InstanceType<M> & string)[]` - The field names that make up this index.

package/skill/PrimaryIndex_get.md

@@ -1,17 +0,0 @@
-#### primaryIndex.get · method
-
-Get a model instance by primary key values.
-
-**Signature:** `(...args: IndexArgTypes<M, F>) => InstanceType<M>`
-
-**Parameters:**
-
-- `args: IndexArgTypes<M, F>` - - The primary key values.
-
-**Returns:** The model instance if found, undefined otherwise.
-
-**Examples:**
-
-```typescript
-const user = User.pk.get("john_doe");
-```

package/skill/PrimaryIndex_getLazy.md

@@ -1,13 +0,0 @@
-#### primaryIndex.getLazy · method
-
-Does the same as as `get()`, but will delay loading the instance from disk until the first
-property access. In case it turns out the instance doesn't exist, an error will be thrown
-at that time.
-
-**Signature:** `(...args: IndexArgTypes<M, F>) => InstanceType<M>`
-
-**Parameters:**
-
-- `args: IndexArgTypes<M, F>` - Primary key field values. (Or a single Uint8Array containing the key.)
-
-**Returns:** The (lazily loaded) model instance.

package/skill/UniqueIndex_get.md

@@ -1,17 +0,0 @@
-#### uniqueIndex.get · method
-
-Get a model instance by unique index key values.
-
-**Signature:** `(...args: ARGS) => InstanceType<M>`
-
-**Parameters:**
-
-- `args: ARGS` - - The unique index key values.
-
-**Returns:** The model instance if found, undefined otherwise.
-
-**Examples:**
-
-```typescript
-const userByEmail = User.byEmail.get("john@example.com");
-```

package/skill/index.md

@@ -1,32 +0,0 @@
-### index · function
-
-Create a secondary index on model fields, or a computed secondary index using a function.
-
-For field-based indexes, pass a field name or array of field names.
-For computed indexes, pass a function that takes a model instance and returns an array of
-index keys. Return `[]` to skip indexing for that instance. Each array element creates a
-separate index entry, enabling multi-value indexes (e.g., indexing by each word in a name).
-
-**Signature:** `{ <M extends typeof Model, V>(MyModel: M, fn: (instance: InstanceType<M>) => V[]): SecondaryIndex<M, [], [V]>; <M extends typeof Model, const F extends (keyof InstanceType<M> & string)>(MyModel: M, field: F): SecondaryIndex<...>; <M extends typeof Model, const FS extends readonly (keyof InstanceType<M> & string)[]>(...`
-
-**Type Parameters:**
-
-- `M extends typeof Model` - The model class.
-- `V` - The computed index value type (for function-based indexes).
-
-**Parameters:**
-
-- `MyModel: M` - - The model class to create the index for.
-- `fn: (instance: InstanceType<M>) => V[]`
-
-**Returns:** A new SecondaryIndex instance.
-
-**Examples:**
-
-```typescript
-class User extends E.Model<User> {
-  static byAge = E.index(User, "age");
-  static byTagsDate = E.index(User, ["tags", "createdAt"]);
-  static byWord = E.index(User, (u: User) => u.name.split(" "));
-}
-```

package/skill/primary.md

@@ -1,26 +0,0 @@
-### primary · function
-
-Create a primary index on model fields.
-
-**Signature:** `{ <M extends typeof Model, const F extends (keyof InstanceType<M> & string)>(MyModel: M, field: F): PrimaryIndex<M, [F]>; <M extends typeof Model, const FS extends readonly (keyof InstanceType<M> & string)[]>(MyModel: M, fields: FS): PrimaryIndex<...>; }`
-
-**Type Parameters:**
-
-- `M extends typeof Model` - The model class.
-- `F extends (keyof InstanceType<M> & string)` - The field name (for single field index).
-
-**Parameters:**
-
-- `MyModel: M` - - The model class to create the index for.
-- `field: F` - - Single field name for simple indexes.
-
-**Returns:** A new PrimaryIndex instance.
-
-**Examples:**
-
-```typescript
-class User extends E.Model<User> {
-  static pk = E.primary(User, ["id"]);
-  static pkSingle = E.primary(User, "id");
-}
-```

package/skill/registerModel.md

@@ -1,26 +0,0 @@
-### registerModel · function
-
-Register a model class with the Edinburgh ORM system.
-
-**Signature:** `<T extends typeof Model<unknown>>(MyModel: T) => T`
-
-**Type Parameters:**
-
-- `T extends typeof Model<unknown>` - The model class type.
-
-**Parameters:**
-
-- `MyModel: T` - - The model class to register.
-
-**Returns:** The enhanced model class with ORM capabilities.
-
-**Examples:**
-
-```typescript
-⁣@E.registerModel
-class User extends E.Model<User> {
-  static pk = E.index(User, ["id"], "primary");
-  id = E.field(E.identifier);
-  name = E.field(E.string);
-}
-```

package/skill/unique.md

@@ -1,32 +0,0 @@
-### unique · function
-
-Create a unique index on model fields, or a computed unique index using a function.
-
-For field-based indexes, pass a field name or array of field names.
-For computed indexes, pass a function that takes a model instance and returns an array of
-index keys. Return `[]` to skip indexing for that instance. Each array element creates a
-separate index entry, enabling multi-value indexes (e.g., indexing by each word in a name).
-
-**Signature:** `{ <M extends typeof Model, V>(MyModel: M, fn: (instance: InstanceType<M>) => V[]): UniqueIndex<M, [], [V]>; <M extends typeof Model, const F extends (keyof InstanceType<M> & string)>(MyModel: M, field: F): UniqueIndex<...>; <M extends typeof Model, const FS extends readonly (keyof InstanceType<M> & string)[]>(MyMode...`
-
-**Type Parameters:**
-
-- `M extends typeof Model` - The model class.
-- `V` - The computed index value type (for function-based indexes).
-
-**Parameters:**
-
-- `MyModel: M` - - The model class to create the index for.
-- `fn: (instance: InstanceType<M>) => V[]`
-
-**Returns:** A new UniqueIndex instance.
-
-**Examples:**
-
-```typescript
-class User extends E.Model<User> {
-  static byEmail = E.unique(User, "email");
-  static byNameAge = E.unique(User, ["name", "age"]);
-  static byFullName = E.unique(User, (u: User) => [`${u.firstName} ${u.lastName}`]);
-}
-```