archetype-ecs 1.4.0 → 1.4.2

package/README.md

@@ -130,7 +130,7 @@ Two ways to work with entities in bulk. Pick the right one for the job:
 Iterates over matching archetypes. You get the backing TypedArrays directly.
 
 ```ts
-function movementSystem(dt) {
+function movementSystem(dt: number) {
   em.forEach([Position, Velocity], (arch) => {
     const px = arch.field(Position.x)  // Float32Array
     const py = arch.field(Position.y)
@@ -183,7 +183,7 @@ const total = em.count([Position])
 Class-based systems with decorators for component lifecycle hooks:
 
 ```ts
-import { System, OnAdded, OnRemoved, createSystems } from 'archetype-ecs'
+import { System, OnAdded, OnRemoved, createSystems, type EntityId } from 'archetype-ecs'
 
 class MovementSystem extends System {
   tick() {
@@ -202,12 +202,12 @@ class MovementSystem extends System {
 
 class DeathSystem extends System {
   @OnAdded(Health)
-  onSpawn(id) {
+  onSpawn(id: EntityId) {
     console.log(`Entity ${id} spawned with ${this.em.get(id, Health.hp)} HP`)
   }
 
   @OnRemoved(Health)
-  onDeath(id) {
+  onDeath(id: EntityId) {
     this.em.addComponent(id, Dead)
   }
 }
@@ -228,8 +228,8 @@ A functional API is also available:
 import { createSystem } from 'archetype-ecs'
 
 const deathSystem = createSystem(em, (sys) => {
-  sys.onAdded(Health, (id) => console.log(`${id} spawned`))
-  sys.onRemoved(Health, (id) => console.log(`${id} died`))
+  sys.onAdded(Health, (id: EntityId) => console.log(`${id} spawned`))
+  sys.onRemoved(Health, (id: EntityId) => console.log(`${id} died`))
 })
 
 em.flushHooks()
@@ -261,32 +261,16 @@ Supports stripping components, skipping entities, and custom serializers.
 Component types are inferred from their definition. Field names autocomplete, wrong fields are compile errors.
 
 ```ts
-// Schema is inferred — Position becomes ComponentDef<{ x: number; y: number }>
+// Fields are typed as FieldRef — Position becomes ComponentDef & { x: FieldRef; y: FieldRef }
 const Position = component('Position', 'f32', ['x', 'y'])
 
-Position.x                // autocompletes to .x and .y
-Position.z                // Property 'z' does not exist
+Position.x                // FieldRef — autocompletes to .x and .y
+Position.z                // compile error: Property 'z' does not exist
 
-em.get(id, Position.x)    // number | undefined
-em.set(id, Position.z, 5) // Property 'z' does not exist
+em.get(id, Position.x)    // zero-alloc field access
+em.set(id, Position.x, 5) // zero-alloc field write
 
-em.addComponent(id, Position, { x: 1, y: 2 })  // ok
-em.addComponent(id, Position, { x: 1 })         // Property 'y' is missing
-
-em.getComponent(id, Position)  // { x: number; y: number } | undefined
-```
-
-String fields are fully typed too:
-
-```ts
-const Name = component('Name', 'string', ['name', 'title'])
-
-em.get(id, Name.name)    // string | undefined
-em.set(id, Name.name, 'Hero')    // ok
-em.set(id, Name.name, 42)        // number not assignable to string
-
-em.addComponent(id, Name, { name: 'Hero', title: 'Sir' })  // ok
-em.addComponent(id, Name, { foo: 'bar' })                   // type error
+arch.field(Position.x)    // Float32Array — direct TypedArray access
 ```
 
 ---

package/dist/src/System.d.ts

@@ -1,7 +1,7 @@
 import type { ComponentDef } from './ComponentRegistry.js';
 import type { EntityId, EntityManager, ArchetypeView } from './EntityManager.js';
-export declare function OnAdded(...types: ComponentDef[]): (_method: Function, context: ClassMethodDecoratorContext) => void;
-export declare function OnRemoved(...types: ComponentDef[]): (_method: Function, context: ClassMethodDecoratorContext) => void;
+export declare function OnAdded(...types: ComponentDef[]): (method: (id: EntityId) => void, _context: ClassMethodDecoratorContext) => void;
+export declare function OnRemoved(...types: ComponentDef[]): (method: (id: EntityId) => void, _context: ClassMethodDecoratorContext) => void;
 interface Hook {
     buffer: Set<EntityId>;
     handler: (id: EntityId) => void;

package/dist/src/System.js

@@ -1,17 +1,17 @@
 // ── Decorators (TC39 Stage 3) ────────────────────────────
 export function OnAdded(...types) {
-    return function (_method, context) {
-        context.addInitializer(function () {
+    return function (method, _context) {
+        _context.addInitializer(function () {
             const self = this;
-            self._registerHook('add', types, self[context.name].bind(self));
+            self._registerHook('add', types, method.bind(self));
         });
     };
 }
 export function OnRemoved(...types) {
-    return function (_method, context) {
-        context.addInitializer(function () {
+    return function (method, _context) {
+        _context.addInitializer(function () {
             const self = this;
-            self._registerHook('remove', types, self[context.name].bind(self));
+            self._registerHook('remove', types, method.bind(self));
         });
     };
 }
@@ -121,7 +121,7 @@ export function createSystem(em, constructor) {
 }
 export function createSystems(em, entries) {
     const systems = entries.map(Entry => {
-        if (Entry.prototype instanceof System) {
+        if ('prototype' in Entry && Entry.prototype instanceof System) {
             return new Entry(em);
         }
         const sys = createSystem(em, Entry);

package/dist/src/index.d.ts

@@ -7,4 +7,11 @@ export type { Profiler, ProfilerEntry } from './Profiler.js';
 export { TYPED, componentSchemas, parseTypeSpec } from './ComponentRegistry.js';
 export type { ComponentDef, TypeSpec } from './ComponentRegistry.js';
 import { type ComponentDef } from './ComponentRegistry.js';
-export declare function component(name: string, typeOrSchema?: string | Record<string, string>, fields?: string[]): ComponentDef;
+import type { FieldRef } from './EntityManager.js';
+export declare function component(name: string): ComponentDef;
+export declare function component<F extends readonly string[]>(name: string, type: string, fields: F): ComponentDef & {
+    readonly [K in F[number]]: FieldRef;
+};
+export declare function component<S extends Record<string, string>>(name: string, schema: S): ComponentDef & {
+    readonly [K in keyof S]: FieldRef;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "archetype-ecs",
-  "version": "1.4.0",
+  "version": "1.4.2",
   "description": "Lightweight archetype-based Entity Component System",
   "type": "module",
   "main": "dist/src/index.js",

package/src/System.ts

@@ -4,19 +4,19 @@ import type { EntityId, EntityManager, ArchetypeView } from './EntityManager.js'
 // ── Decorators (TC39 Stage 3) ────────────────────────────
 
 export function OnAdded(...types: ComponentDef[]) {
-  return function (_method: Function, context: ClassMethodDecoratorContext) {
-    context.addInitializer(function () {
+  return function (method: (id: EntityId) => void, _context: ClassMethodDecoratorContext) {
+    _context.addInitializer(function () {
       const self = this as unknown as System;
-      self._registerHook('add', types, (self as any)[context.name].bind(self));
+      self._registerHook('add', types, method.bind(self));
     });
   };
 }
 
 export function OnRemoved(...types: ComponentDef[]) {
-  return function (_method: Function, context: ClassMethodDecoratorContext) {
-    context.addInitializer(function () {
+  return function (method: (id: EntityId) => void, _context: ClassMethodDecoratorContext) {
+    _context.addInitializer(function () {
       const self = this as unknown as System;
-      self._registerHook('remove', types, (self as any)[context.name].bind(self));
+      self._registerHook('remove', types, method.bind(self));
     });
   };
 }
@@ -182,7 +182,7 @@ export interface Pipeline {
 
 export function createSystems(em: EntityManager, entries: (FunctionalSystemConstructor | (new (em: EntityManager) => System))[]): Pipeline {
   const systems: Runnable[] = entries.map(Entry => {
-    if ((Entry as any).prototype instanceof System) {
+    if ('prototype' in Entry && Entry.prototype instanceof System) {
       return new (Entry as new (em: EntityManager) => System)(em);
     }
     const sys = createSystem(em, Entry as FunctionalSystemConstructor);

package/src/index.ts

@@ -8,7 +8,11 @@ export { TYPED, componentSchemas, parseTypeSpec } from './ComponentRegistry.js';
 export type { ComponentDef, TypeSpec } from './ComponentRegistry.js';
 
 import { parseTypeSpec, componentSchemas, type ComponentDef, type TypeSpec } from './ComponentRegistry.js';
+import type { FieldRef } from './EntityManager.js';
 
+export function component(name: string): ComponentDef;
+export function component<F extends readonly string[]>(name: string, type: string, fields: F): ComponentDef & { readonly [K in F[number]]: FieldRef };
+export function component<S extends Record<string, string>>(name: string, schema: S): ComponentDef & { readonly [K in keyof S]: FieldRef };
 export function component(name: string, typeOrSchema?: string | Record<string, string>, fields?: string[]): ComponentDef {
   const sym = Symbol(name);
   const comp: any = { _sym: sym, _name: name };

package/tests/EntityManager.test.ts

@@ -300,10 +300,10 @@ describe('Typed Components (SoA)', () => {
     }
 
     em.forEach([Pos, Vel], (arch) => {
-      const px = arch.field(Pos.x as any);
-      const py = arch.field(Pos.y as any);
-      const vx = arch.field(Vel.vx as any);
-      const vy = arch.field(Vel.vy as any);
+      const px = arch.field(Pos.x);
+      const py = arch.field(Pos.y);
+      const vx = arch.field(Vel.vx);
+      const vy = arch.field(Vel.vy);
       for (let i = 0; i < arch.count; i++) {
         px[i] += vx[i];
         py[i] += vy[i];
@@ -367,16 +367,16 @@ describe('Typed Components (SoA)', () => {
     const Pos = component('PosGS', 'f32', ['x', 'y']);
     const id = em.createEntity();
     em.addComponent(id, Pos, { x: 3.5, y: 7.5 });
-    assert.ok(Math.abs(em.get(id, Pos.x as any) - 3.5) < 0.001);
-    em.set(id, Pos.x as any, 42);
-    assert.ok(Math.abs(em.get(id, Pos.x as any) - 42) < 0.001);
+    assert.ok(Math.abs(em.get(id, Pos.x) - 3.5) < 0.001);
+    em.set(id, Pos.x, 42);
+    assert.ok(Math.abs(em.get(id, Pos.x) - 42) < 0.001);
   });
 
   it('get returns undefined for missing entity/component', () => {
     const Pos = component('PosGFM', 'f32', ['x', 'y']);
-    assert.equal(em.get(999, Pos.x as any), undefined);
+    assert.equal(em.get(999, Pos.x), undefined);
     const id = em.createEntity();
-    assert.equal(em.get(id, Pos.x as any), undefined);
+    assert.equal(em.get(id, Pos.x), undefined);
   });
 
   it('forEach field returns undefined for tag component', () => {
@@ -387,7 +387,7 @@ describe('Typed Components (SoA)', () => {
     em.addComponent(id, Tag, {});
 
     em.forEach([Pos, Tag], (arch) => {
-      assert.ok(arch.field(Pos.x as any) instanceof Float32Array);
+      assert.ok(arch.field(Pos.x) instanceof Float32Array);
     });
   });
 
@@ -396,11 +396,11 @@ describe('Typed Components (SoA)', () => {
     const id = em.createEntity();
     em.addComponent(id, Name, { name: 'Hero', title: 'Sir' });
 
-    assert.equal(em.get(id, Name.name as any), 'Hero');
-    assert.equal(em.get(id, Name.title as any), 'Sir');
+    assert.equal(em.get(id, Name.name), 'Hero');
+    assert.equal(em.get(id, Name.title), 'Sir');
 
-    em.set(id, Name.name as any, 'Villain');
-    assert.equal(em.get(id, Name.name as any), 'Villain');
+    em.set(id, Name.name, 'Villain');
+    assert.equal(em.get(id, Name.name), 'Villain');
 
     const obj = em.getComponent(id, Name);
     assert.deepEqual(obj, { name: 'Villain', title: 'Sir' });
@@ -411,8 +411,8 @@ describe('Typed Components (SoA)', () => {
     const id = em.createEntity();
     em.addComponent(id, Label, { text: 'hello', color: 'red' });
 
-    assert.equal(em.get(id, Label.text as any), 'hello');
-    assert.equal(em.get(id, Label.color as any), 'red');
+    assert.equal(em.get(id, Label.text), 'hello');
+    assert.equal(em.get(id, Label.color), 'red');
   });
 
   it('string component growth past capacity', () => {
@@ -423,8 +423,8 @@ describe('Typed Components (SoA)', () => {
     }
     const ids = em.query([Name]);
     assert.equal(ids.length, 100);
-    assert.equal(em.get(ids[0], Name.value as any), 'entity_0');
-    assert.equal(em.get(ids[99], Name.value as any), 'entity_99');
+    assert.equal(em.get(ids[0], Name.value), 'entity_0');
+    assert.equal(em.get(ids[99], Name.value), 'entity_99');
   });
 
   it('string component swap-remove preserves data', () => {
@@ -437,8 +437,8 @@ describe('Typed Components (SoA)', () => {
     em.addComponent(c, Name, { value: 'ccc' });
 
     em.destroyEntity(a);
-    assert.equal(em.get(b, Name.value as any), 'bbb');
-    assert.equal(em.get(c, Name.value as any), 'ccc');
+    assert.equal(em.get(b, Name.value), 'bbb');
+    assert.equal(em.get(c, Name.value), 'ccc');
   });
 
   it('mixed string + numeric fields in one component', () => {
@@ -446,8 +446,8 @@ describe('Typed Components (SoA)', () => {
     const id = em.createEntity();
     em.addComponent(id, Item, { name: 'Sword', weight: 3.5 });
 
-    assert.equal(em.get(id, Item.name as any), 'Sword');
-    assert.ok(Math.abs(em.get(id, Item.weight as any) - 3.5) < 0.01);
+    assert.equal(em.get(id, Item.name), 'Sword');
+    assert.ok(Math.abs(em.get(id, Item.weight) - 3.5) < 0.01);
   });
 
   it('string component forEach field access', () => {
@@ -458,7 +458,7 @@ describe('Typed Components (SoA)', () => {
     }
 
     em.forEach([Name], (arch) => {
-      const values = arch.field(Name.value as any);
+      const values = arch.field(Name.value);
       assert.ok(Array.isArray(values));
       assert.equal(values[0], 'e0');
       assert.equal(values[4], 'e4');
@@ -539,7 +539,7 @@ describe('Deferred Structural Changes during forEach', () => {
     em.addComponent(a, Pos, { x: 1, y: 2 });
 
     em.forEach([Pos], (arch) => {
-      const px = arch.field(Pos.x as any);
+      const px = arch.field(Pos.x);
       // Overwrite via addComponent — same archetype, should be immediate
       em.addComponent(a, Pos, { x: 99, y: 88 });
       // The array should reflect the change immediately
@@ -615,9 +615,9 @@ describe('Deferred Structural Changes during forEach', () => {
     em.addComponent(a, Pos, { x: 1, y: 2 });
 
     em.forEach([Pos], (arch) => {
-      em.set(a, Pos.x as any, 42);
+      em.set(a, Pos.x, 42);
       // Should be immediately visible
-      const px = arch.field(Pos.x as any);
+      const px = arch.field(Pos.x);
       assert.ok(Math.abs(px[0] - 42) < 0.001);
     });
   });

package/tests/types.ts

@@ -33,14 +33,14 @@ em.addComponent(id, Name, { name: 'Hero', title: 'Sir' });
 const pos = em.getComponent(id, Position);
 
 // get/set: field descriptor access
-const px: any = em.get(id, Position.x as any);
-em.set(id, Position.x as any, 10);
+const px: any = em.get(id, Position.x);
+em.set(id, Position.x, 10);
 
 // forEach + field: accepts FieldRef
 em.forEach([Position, Velocity], (arch) => {
   const count: number = arch.count;
   const ids: EntityId[] = arch.entityIds;
-  const arrX = arch.field(Position.x as any);
+  const arrX = arch.field(Position.x);
 });
 
 // createEntityWith: alternating type, data