@idfkit/core 0.0.1

package/dist/shape.js

@@ -0,0 +1,114 @@
+import { DATA, OWNER, SHAPE } from './internal.js';
+/**
+ * Per-object-type prototype carrying real accessors for every field.
+ *
+ * The Python library resolves `zone.ceiling_height` through `__getattr__`. The
+ * mechanical translation of that is a `Proxy`, which we deliberately do not use:
+ * proxies defeat V8's inline caches, and more importantly they are invisible to
+ * TypeScript, so nothing would autocomplete. Instead each object type gets one
+ * prototype with `Object.defineProperty` accessors, built once and shared by
+ * every instance of that type. Property access is then an ordinary monomorphic
+ * lookup, and the generated `.d.ts` interfaces describe it statically.
+ *
+ * Shapes are keyed by the schema definition object rather than by type name.
+ * Because the schema bundle is content-addressed, `Zone` in 9.4.0 and `Zone` in
+ * 26.1.0 are the same frozen definition, so they share one shape and one
+ * prototype. Cross-version documents stay monomorphic for free.
+ */
+export class ObjectShape {
+    typeName;
+    type;
+    proto;
+    /** Field names in IDF positional order, excluding the name field. */
+    fields;
+    /** Fields that point into a reference list, i.e. foreign keys. */
+    refFields;
+    /**
+     * Fields *inside* the extensible group that point into a reference list.
+     *
+     * Kept separate from `refFields` because these live in `type.x.fields`, not
+     * the positional field list, and so need the repeat index to address them.
+     * Ignoring them is not cosmetic: `ZoneList`, `Branch`, and the supply/return
+     * paths carry all of their references here, so leaving them out of the graph
+     * makes `rename()` silently produce a broken model.
+     */
+    extensibleRefFields;
+    /** Fields whose value declares a name other objects may reference. */
+    keyFields;
+    /** Extensible array key (`vertices`), if this type has one. */
+    extensibleKey;
+    /** Whether the object carries a name (most do; `Version` does not). */
+    named;
+    constructor(typeName, type, base) {
+        this.typeName = typeName;
+        this.type = type;
+        this.named = type.anon !== 1;
+        const fields = type.f.filter((f) => f !== 'name');
+        this.fields = fields;
+        this.extensibleKey = type.x?.key;
+        this.refFields = fields.filter((f) => (type.p[f]?.ol?.length ?? 0) > 0);
+        this.keyFields = fields.filter((f) => (type.p[f]?.ref?.length ?? 0) > 0);
+        const extensible = type.x;
+        this.extensibleRefFields =
+            extensible === undefined
+                ? []
+                : extensible.fields.filter((f) => (extensible.p[f]?.ol?.length ?? 0) > 0);
+        const proto = Object.create(base);
+        for (const field of fields) {
+            defineFieldAccessor(proto, field);
+        }
+        // The extensible array lives under its own epJSON key (`vertices`) rather
+        // than in the positional field list, so it needs an accessor of its own.
+        if (this.extensibleKey !== undefined && !fields.includes(this.extensibleKey)) {
+            defineFieldAccessor(proto, this.extensibleKey);
+        }
+        this.proto = Object.freeze(proto);
+    }
+}
+function defineFieldAccessor(proto, field) {
+    Object.defineProperty(proto, field, {
+        enumerable: true,
+        configurable: false,
+        get() {
+            return this[DATA][field];
+        },
+        set(value) {
+            const previous = this[DATA][field];
+            if (previous === value)
+                return;
+            if (value === undefined || value === null)
+                delete this[DATA][field];
+            else
+                this[DATA][field] = value;
+            // The document keeps the reference graph live. Routing writes through a
+            // real setter is what lets us do that without a Proxy and without asking
+            // callers to mutate via an explicit `update()` call.
+            this[OWNER]?.onFieldChanged(this, field, previous, value);
+        },
+    });
+}
+const shapeCache = new WeakMap();
+/**
+ * Get (or build) the shape for an object type.
+ *
+ * `base` is `IdfObject.prototype`, threaded in rather than imported to keep
+ * this module free of a cycle with `object.ts`.
+ */
+export function shapeFor(typeName, type, base) {
+    let byName = shapeCache.get(type);
+    if (byName === undefined) {
+        byName = new Map();
+        shapeCache.set(type, byName);
+    }
+    let shape = byName.get(typeName);
+    if (shape === undefined) {
+        shape = new ObjectShape(typeName, type, base);
+        byName.set(typeName, shape);
+    }
+    return shape;
+}
+/** Number of distinct shapes built, for tests and diagnostics. */
+export function shapeOf(obj) {
+    return obj[SHAPE];
+}
+//# sourceMappingURL=shape.js.map

package/dist/shape.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shape.js","sourceRoot":"","sources":["../src/shape.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AAGnD;;;;;;;;;;;;;;;GAeG;AACH,MAAM,OAAO,WAAW;IACb,QAAQ,CAAS;IACjB,IAAI,CAAW;IACf,KAAK,CAAS;IAEvB,qEAAqE;IAC5D,MAAM,CAAoB;IACnC,kEAAkE;IACzD,SAAS,CAAoB;IACtC;;;;;;;;OAQG;IACM,mBAAmB,CAAoB;IAChD,sEAAsE;IAC7D,SAAS,CAAoB;IACtC,+DAA+D;IACtD,aAAa,CAAqB;IAC3C,uEAAuE;IAC9D,KAAK,CAAU;IAExB,YAAY,QAAgB,EAAE,IAAc,EAAE,IAAY;QACxD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,IAAI,KAAK,CAAC,CAAC;QAE7B,MAAM,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC;QAClD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,CAAC,EAAE,GAAG,CAAC;QACjC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QACxE,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QAEzE,MAAM,UAAU,GAAG,IAAI,CAAC,CAAC,CAAC;QAC1B,IAAI,CAAC,mBAAmB;YACtB,UAAU,KAAK,SAAS;gBACtB,CAAC,CAAC,EAAE;gBACJ,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QAE9E,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAW,CAAC;QAC5C,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,mBAAmB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QACpC,CAAC;QACD,0EAA0E;QAC1E,yEAAyE;QACzE,IAAI,IAAI,CAAC,aAAa,KAAK,SAAS,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC;YAC7E,mBAAmB,CAAC,KAAK,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QACjD,CAAC;QACD,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC;CACF;AAED,SAAS,mBAAmB,CAAC,KAAa,EAAE,KAAa;IACvD,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,KAAK,EAAE;QAClC,UAAU,EAAE,IAAI;QAChB,YAAY,EAAE,KAAK;QACnB,GAAG;YACD,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC;QAC3B,CAAC;QACD,GAAG,CAAkB,KAAc;YACjC,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC;YACnC,IAAI,QAAQ,KAAK,KAAK;gBAAE,OAAO;YAE/B,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI;gBAAE,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC;;gBAC/D,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,GAAG,KAAoB,CAAC;YAE9C,wEAAwE;YACxE,yEAAyE;YACzE,qDAAqD;YACrD,IAAI,CAAC,KAAK,CAAC,EAAE,cAAc,CAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;QAC5D,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,GAAG,IAAI,OAAO,EAAsC,CAAC;AAErE;;;;;GAKG;AACH,MAAM,UAAU,QAAQ,CAAC,QAAgB,EAAE,IAAc,EAAE,IAAY;IACrE,IAAI,MAAM,GAAG,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAClC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,MAAM,GAAG,IAAI,GAAG,EAAE,CAAC;QACnB,UAAU,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC/B,CAAC;IACD,IAAI,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACjC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,KAAK,GAAG,IAAI,WAAW,CAAC,QAAQ,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QAC9C,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IAC9B,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,kEAAkE;AAClE,MAAM,UAAU,OAAO,CAAC,GAAc;IACpC,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;AACpB,CAAC"}

package/dist/typemap.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Version-specific static typing, with no runtime cost at all.
+ *
+ * A generated module (`@idfkit/core/types/v26-1`) exports one interface per
+ * object type plus a `TypeMap` joining type name to interface. A document
+ * parameterized by that map resolves `doc.all('Zone')` to a collection of
+ * objects with `Zone`'s fields, and the editor completes among all 858 type
+ * names as you type the string.
+ *
+ * This is where JavaScript beats the Python original rather than imitating it.
+ * `__getattr__` resolves names at runtime, so an editor cannot see them and a
+ * typo surfaces as `None` at simulation time. Here the schema is compiled into
+ * the type system, so `doc.all('Zone').first.celing_height` is a compile error,
+ * and none of it exists once the code is running: the maps are types, erased at
+ * build time, and the argument really is just a string.
+ */
+import type { FieldValues } from './object.js';
+/** Base constraint: any map from object type name to its field interface. */
+export type AnyTypeMap = Record<string, object>;
+/** A document with no version types attached. */
+export type UntypedMap = Record<never, never>;
+/**
+ * Accepted type names for a map.
+ *
+ * The `string & {}` arm is what keeps literal completion alive while still
+ * accepting arbitrary strings: without it TypeScript widens the parameter to
+ * `string` and the suggestions disappear.
+ */
+export type TypeNameOf<M extends AnyTypeMap> = (keyof M & string) | (string & {});
+/** Field interface for a type name, or an empty object for unknown names. */
+export type ObjectOf<M extends AnyTypeMap, K extends string> = K extends keyof M ? M[K] : UntypedMap;
+/**
+ * Field values accepted when creating an object of a given type.
+ *
+ * Deliberately not `ObjectOf`. For a known type name this is the exact field
+ * interface, so TypeScript's excess-property check rejects a misspelled field
+ * in an object literal. For anything else it widens to the permissive
+ * `FieldValues`, which is what version-generic code and untyped documents need.
+ * Using one type for both would force a choice between catching typos and
+ * allowing dynamic field names; using two costs nothing and gives both.
+ */
+export type ValuesOf<M extends AnyTypeMap, K extends string> = K extends keyof M ? Partial<M[K]> : FieldValues;
+//# sourceMappingURL=typemap.d.ts.map

package/dist/typemap.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typemap.d.ts","sourceRoot":"","sources":["../src/typemap.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE/C,6EAA6E;AAC7E,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAEhD,iDAAiD;AACjD,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;AAE9C;;;;;;GAMG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,UAAU,IAAI,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;AAElF,6EAA6E;AAC7E,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,SAAS,MAAM,IAAI,CAAC,SAAS,MAAM,CAAC,GAC5E,CAAC,CAAC,CAAC,CAAC,GACJ,UAAU,CAAC;AAEf;;;;;;;;;GASG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,SAAS,MAAM,IAAI,CAAC,SAAS,MAAM,CAAC,GAC5E,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACb,WAAW,CAAC"}

package/dist/typemap.js

@@ -0,0 +1,18 @@
+/**
+ * Version-specific static typing, with no runtime cost at all.
+ *
+ * A generated module (`@idfkit/core/types/v26-1`) exports one interface per
+ * object type plus a `TypeMap` joining type name to interface. A document
+ * parameterized by that map resolves `doc.all('Zone')` to a collection of
+ * objects with `Zone`'s fields, and the editor completes among all 858 type
+ * names as you type the string.
+ *
+ * This is where JavaScript beats the Python original rather than imitating it.
+ * `__getattr__` resolves names at runtime, so an editor cannot see them and a
+ * typo surfaces as `None` at simulation time. Here the schema is compiled into
+ * the type system, so `doc.all('Zone').first.celing_height` is a compile error,
+ * and none of it exists once the code is running: the maps are types, erased at
+ * build time, and the argument really is just a string.
+ */
+export {};
+//# sourceMappingURL=typemap.js.map

package/dist/typemap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typemap.js","sourceRoot":"","sources":["../src/typemap.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG"}