@ste_tisci/ecs 0.1.6 → 0.1.8

package/README.md

@@ -75,6 +75,39 @@ function gameLoop() {
 gameLoop();
 ```
 
+## Hot systems: `queryIds`
+
+`query` yields one result object plus one `{ id }` object per component per entity, which is
+convenient but allocates on every iteration. For systems that run every frame over many
+entities, `queryIds` returns the matching entity IDs instead, and `indices` translates an
+entity ID into its slot in the SoA arrays:
+
+```typescript
+function movementSystem(World) {
+  const { Position, Velocity } = World.components;
+  const pos = World.indices.Position;
+  const vel = World.indices.Velocity;
+
+  for (const eid of World.queryIds('Position', 'Velocity')) {
+    Position.x[pos[eid]] += Velocity.x[vel[eid]];
+    Position.y[pos[eid]] += Velocity.y[vel[eid]];
+  }
+}
+```
+
+Both APIs return the same entities; `queryIds` is roughly 3x faster on a packed query and 5x
+on a fragmented one, at the cost of resolving indices yourself.
+
+## Iteration and mutation
+
+`query` iterates a snapshot taken when the generator starts, so calling `removeComponent` or
+`destroyEntity` from inside the loop cannot skip an entity. Entities created mid-iteration are
+not visited by the query in flight; the next call picks them up.
+
+`queryIds` builds its whole result before returning, so the same guarantee holds. Note that
+destroying an entity invalidates its entry in `indices`, so if a loop destroys entities it
+must not read their storage index afterwards.
+
 ## Error Handling
 
 Every operation validates its inputs and throws a descriptive `Error` instead of failing silently or corrupting state:

package/dist/index.cjs

@@ -0,0 +1,309 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  ECS: () => ECS
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/utils/SparseSet.ts
+function SparseSet() {
+  const sparse = [];
+  const dense = [];
+  let size = 0;
+  function has(eid) {
+    const ID = getIndex(eid);
+    const exist = ID !== void 0 && dense[ID] === eid;
+    const isWhitinBounds = ID >= 0 && ID < size;
+    return exist && isWhitinBounds;
+  }
+  function add(eid) {
+    if (has(eid)) throw new Error(`ID ${eid} already present in the set`);
+    sparse[eid] = size;
+    dense[size] = eid;
+    size++;
+  }
+  function remove(eid) {
+    if (!has(eid)) throw new Error(`Cannot remove ID ${eid} because does not exists`);
+    const ID = getIndex(eid);
+    const last = dense[size - 1];
+    dense[ID] = last;
+    sparse[last] = ID;
+    dense.pop();
+    size--;
+    delete sparse[eid];
+  }
+  function getIndex(eid) {
+    return sparse[eid];
+  }
+  function getDense() {
+    return dense;
+  }
+  function getSize() {
+    return size;
+  }
+  function getSparse() {
+    return sparse;
+  }
+  return { has, add, remove, getIndex, getDense, getSize, getSparse };
+}
+
+// src/ComponentStore.ts
+var INITIAL_CAPACITY = 8;
+function grow(buffer, requiredIndex) {
+  let capacity = buffer.length || INITIAL_CAPACITY;
+  while (capacity <= requiredIndex) capacity *= 2;
+  const grown = new Float32Array(capacity);
+  grown.set(buffer);
+  return grown;
+}
+function ComponentStore() {
+  const componentSet = SparseSet();
+  const componentData = /* @__PURE__ */ Object.create(null);
+  const isNumeric = /* @__PURE__ */ Object.create(null);
+  function add(eid, data) {
+    if (componentSet.has(eid)) throw new Error(`Entity ${eid} already has this component`);
+    const ID = componentSet.getSize();
+    componentSet.add(eid);
+    for (const key in data) {
+      const value = data[key];
+      if (!(key in componentData)) {
+        isNumeric[key] = typeof value === "number";
+        componentData[key] = isNumeric[key] ? new Float32Array(INITIAL_CAPACITY) : [];
+      }
+      if (isNumeric[key] && ID >= componentData[key].length) {
+        componentData[key] = grow(componentData[key], ID);
+      }
+      componentData[key][ID] = value;
+    }
+  }
+  function remove(eid) {
+    if (!componentSet.has(eid)) throw new Error(`Entity ${eid} does not have this component`);
+    const ID = componentSet.getIndex(eid);
+    const lastID = componentSet.getSize() - 1;
+    if (ID !== lastID) {
+      for (const key of Object.keys(componentData)) {
+        componentData[key][ID] = componentData[key][lastID];
+      }
+    }
+    componentSet.remove(eid);
+    for (const key in componentData) {
+      if (!isNumeric[key]) {
+        componentData[key].pop();
+      }
+    }
+  }
+  function getDense() {
+    return componentSet.getDense();
+  }
+  function getData() {
+    return componentData;
+  }
+  function getIndex(eid) {
+    return componentSet.getIndex(eid);
+  }
+  function getSize() {
+    return componentSet.getSize();
+  }
+  function getSparse() {
+    return componentSet.getSparse();
+  }
+  return { add, remove, getIndex, getDense, getData, getSize, getSparse };
+}
+
+// src/EntityManager.ts
+function EntityManager(registry) {
+  let nextID = 0;
+  const recycledIDs = [];
+  const bitMasks = [];
+  function exists(eid) {
+    const isWithinBounds = eid >= 0 && eid < nextID;
+    const hasMask = bitMasks[eid] !== void 0;
+    return isWithinBounds && hasMask;
+  }
+  function hasComponent(eid, name) {
+    if (!exists(eid)) throw new Error(`Entity ${eid} does not exist`);
+    const cid = registry.getID(name);
+    return (bitMasks[eid] & 1n << BigInt(cid)) !== 0n;
+  }
+  function create() {
+    const ID = recycledIDs.length > 0 ? recycledIDs.pop() : nextID++;
+    bitMasks[ID] = 0n;
+    return ID;
+  }
+  function remove(eid) {
+    if (!exists(eid)) throw new Error(`Entity ${eid} does not exist`);
+    bitMasks[eid] = void 0;
+    recycledIDs.push(eid);
+  }
+  function addComponent(eid, name) {
+    if (!exists(eid)) throw new Error(`Entity ${eid} does not exists`);
+    if (hasComponent(eid, name)) throw new Error(`Entity ${eid} already has component ${name}`);
+    const cid = registry.getID(name);
+    bitMasks[eid] |= 1n << BigInt(cid);
+  }
+  function removeComponent(eid, name) {
+    if (!exists(eid)) throw new Error(`Entity ${eid} does not exists`);
+    if (!hasComponent(eid, name)) throw new Error(`Entity ${eid} does not have component ${name}`);
+    const cid = registry.getID(name);
+    bitMasks[eid] &= ~(1n << BigInt(cid));
+  }
+  function getMask(eid) {
+    if (!exists(eid)) throw new Error(`Entity ${eid} does not exist`);
+    return bitMasks[eid];
+  }
+  function tryGetMask(eid) {
+    return eid >= 0 && eid < nextID ? bitMasks[eid] : void 0;
+  }
+  return { exists, hasComponent, create, remove, addComponent, removeComponent, getMask, tryGetMask };
+}
+
+// src/utils/ComponentRegistry.ts
+function createComponentRegistry() {
+  const nameToID = /* @__PURE__ */ new Map();
+  const IDtoName = /* @__PURE__ */ new Map();
+  let nextID = 0;
+  function register(name) {
+    if (!nameToID.has(name)) {
+      const eid = nextID++;
+      nameToID.set(name, eid);
+      IDtoName.set(eid, name);
+    }
+  }
+  function getID(name) {
+    const eid = nameToID.get(name);
+    if (eid === void 0) throw new Error(`Component ${name} not registered`);
+    return eid;
+  }
+  function getName(cid) {
+    const name = IDtoName.get(cid);
+    if (!name) throw new Error(`Component ID ${cid} not registered`);
+    return name;
+  }
+  return { register, getID, getName };
+}
+
+// src/Ecs.ts
+function ECS() {
+  const ComponentRegistry = createComponentRegistry();
+  const Entities = EntityManager(ComponentRegistry);
+  const internalStores = /* @__PURE__ */ Object.create(null);
+  const components = /* @__PURE__ */ Object.create(null);
+  const indices = /* @__PURE__ */ Object.create(null);
+  function defineComponents(...names) {
+    for (const name of names) {
+      if (Object.hasOwn(internalStores, name))
+        throw new Error(`Component ${String(name)} is already defined`);
+      ComponentRegistry.register(name);
+      internalStores[name] = ComponentStore();
+      components[name] = internalStores[name].getData();
+      indices[name] = internalStores[name].getSparse();
+    }
+  }
+  function createEntity() {
+    return Entities.create();
+  }
+  function destroyEntity(eid) {
+    const entityMask = Entities.getMask(eid);
+    let cid = 0;
+    let tempMask = entityMask;
+    while (tempMask !== 0n) {
+      if ((tempMask & 1n) !== 0n) {
+        const name = ComponentRegistry.getName(cid);
+        internalStores[name].remove(eid);
+      }
+      tempMask >>= 1n;
+      cid++;
+    }
+    Entities.remove(eid);
+  }
+  function addComponent(eid, name, data) {
+    Entities.addComponent(eid, name);
+    internalStores[name].add(eid, data);
+  }
+  function removeComponent(eid, name) {
+    Entities.removeComponent(eid, name);
+    internalStores[name].remove(eid);
+  }
+  function planQuery(componentName) {
+    let targetMask = 0n;
+    for (const name of componentName) {
+      targetMask |= 1n << BigInt(ComponentRegistry.getID(name));
+    }
+    let pivot = internalStores[componentName[0]];
+    let pivotSize = pivot.getSize();
+    for (let i = 1; i < componentName.length; i++) {
+      const store = internalStores[componentName[i]];
+      const size = store.getSize();
+      if (size < pivotSize) {
+        pivot = store;
+        pivotSize = size;
+      }
+    }
+    return { targetMask, pivot };
+  }
+  function* query(...componentName) {
+    if (componentName.length === 0) return;
+    const { targetMask, pivot } = planQuery(componentName);
+    const count = componentName.length;
+    const sparses = new Array(count);
+    for (let i = 0; i < count; i++) sparses[i] = internalStores[componentName[i]].getSparse();
+    const entities = [...pivot.getDense()];
+    for (let i = 0; i < entities.length; i++) {
+      const eid = entities[i];
+      const mask = Entities.tryGetMask(eid);
+      if (mask === void 0 || (mask & targetMask) !== targetMask) continue;
+      const result = {};
+      for (let c = 0; c < count; c++) {
+        result[componentName[c]] = { id: sparses[c][eid] };
+      }
+      yield result;
+    }
+  }
+  function queryIds(...componentName) {
+    const matches = [];
+    if (componentName.length === 0) return matches;
+    const { targetMask, pivot } = planQuery(componentName);
+    const dense = pivot.getDense();
+    for (let i = 0; i < dense.length; i++) {
+      const eid = dense[i];
+      const mask = Entities.tryGetMask(eid);
+      if (mask === void 0 || (mask & targetMask) !== targetMask) continue;
+      matches.push(eid);
+    }
+    return matches;
+  }
+  return {
+    defineComponents,
+    createEntity,
+    destroyEntity,
+    addComponent,
+    removeComponent,
+    query,
+    queryIds,
+    components,
+    indices
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ECS
+});

package/dist/index.d.cts

@@ -0,0 +1,142 @@
+/**
+ * Represents component data in Structure of Arrays (SoA) format.
+ * Each property of the component is stored in a separate array,
+ * enabling cache-efficient iteration and SIMD operations.
+ * Numeric properties are backed by a Float32Array for a compact, homogeneous
+ * memory layout; non-numeric properties fall back to a plain JS array.
+ * @template T - The component data type
+ * @example
+ * // For Position component: { x: number, y: number }
+ * // ComponentDataArrays would be: { x: Float32Array, y: Float32Array }
+ */
+type ComponentDataArrays<T> = {
+  [K in keyof T]: T[K] extends number ? Float32Array : T[K][];
+};
+
+/**
+ * Maps component names to their data arrays for direct access.
+ * Used to expose component data to the user without store methods.
+ * @template T - Record type defining all component types
+ */
+type StoreDataMap<T> = {
+  [K in keyof T]: ComponentDataArrays<T[K]>;
+};
+
+/**
+ * Maps component names to their raw sparse lookup table.
+ * Each table translates an entity ID into that entity's index in the component's
+ * data arrays, which is what queryIds callers need to read the SoA storage.
+ * @template T - Record type defining all component types
+ */
+type IndexMap<T> = {
+  [K in keyof T]: number[];
+};
+
+/**
+ * Type helper for the query result.
+ * Creates an object with an entry for each requested component, holding its store index.
+ * @template C - Array of the component names requested in the query.
+ */
+type QueryResult<C extends readonly PropertyKey[]> = {
+  [K in C[number]]: { id: number };
+};
+
+/**
+ * Interface for the main ECS registry.
+ * Provides high-level API for entity-component management,
+ * coordinating between EntityManager and ComponentStores.
+ * @template T - Record type defining all component types in the ECS
+ */
+interface IECS<T> {
+  /**
+   * Initializes the ECS with component definitions.
+   * Registers all components and creates their corresponding stores.
+   * Must be called before any other operations.
+   * @param names -component names
+   * @throws Error if a component name is already defined
+   */
+  defineComponents<K extends readonly (keyof T)[]>(...names: K): void;
+
+  /**
+   * Creates a new entity in the ECS.
+   * @returns The ID of the newly created entity
+   */
+  createEntity: () => number;
+
+  /**
+   * Completely removes an entity and all its components from the ECS.
+   * Cleans up all component data and entity records.
+   * @param eid - The entity ID to destroy
+   */
+  destroyEntity: (eid: number) => void;
+
+  /**
+   * Adds a component to an entity with the provided data.
+   * Updates both the entity's bitmask and the component store.
+   * @template K - The component name type (key of T)
+   * @param eid - The entity ID
+   * @param name - The component name
+   * @param data - The component data to store
+   */
+  addComponent: <K extends keyof T>(eid: number, name: K, data: T[K]) => void;
+
+  /**
+   * Removes a component from an entity.
+   * Updates both the entity's bitmask and the component store.
+   * @template K - The component name type (key of T)
+   * @param eid - The entity ID
+   * @param name - The component name
+   */
+  removeComponent: <K extends keyof T>(eid: number, name: K) => void;
+
+  /**
+   * Retrieves all entities that contain the specified set of components.
+   * Performs a filtered search across component stores and yields each matching entity.
+   * The returned generator allows efficient iteration without allocating large arrays.
+   *
+   * @template C - Array of component names to query for
+   * @param components - List of component names that the entity must include
+   * @returns A generator that yields an object for each matching entity,
+   *          containing the entity ID and the related component data
+   */
+  query: <C extends (keyof T)[]>(...componentName: C) => Generator<QueryResult<C>>;
+
+  /**
+   * Allocation-free counterpart to query, for hot systems.
+   * Returns the IDs of every entity holding all the specified components, instead of
+   * yielding one result object plus one { id } object per component per entity.
+   * Translate an entity ID into a storage index through `indices`:
+   *
+   * ```ts
+   * const { Position, Velocity } = World.components;
+   * const pos = World.indices.Position;
+   * const vel = World.indices.Velocity;
+   *
+   * for (const eid of World.queryIds('Position', 'Velocity')) {
+   *   Position.x[pos[eid]] += Velocity.x[vel[eid]];
+   * }
+   * ```
+   *
+   * The array is complete before it is returned, so adding or removing components while
+   * looping over it cannot skip an entity. Destroying an entity mid-loop does invalidate
+   * its storage index, so guard that case yourself.
+   *
+   * @template C - Array of component names to query for
+   * @param componentName - List of component names that the entity must include
+   * @returns A fresh array of matching entity IDs
+   */
+  queryIds: <C extends (keyof T)[]>(...componentName: C) => number[];
+
+  components: StoreDataMap<T>;
+
+  /**
+   * Maps each component name to its sparse lookup table, translating an entity ID into
+   * that entity's index in the component's data arrays. Needed to read `components`
+   * when iterating the output of queryIds.
+   */
+  indices: IndexMap<T>;
+}
+
+declare function ECS<T extends Record<string, Record<string, any>>>(): IECS<T>;
+
+export { ECS };

package/dist/index.d.ts

@@ -0,0 +1,142 @@
+/**
+ * Represents component data in Structure of Arrays (SoA) format.
+ * Each property of the component is stored in a separate array,
+ * enabling cache-efficient iteration and SIMD operations.
+ * Numeric properties are backed by a Float32Array for a compact, homogeneous
+ * memory layout; non-numeric properties fall back to a plain JS array.
+ * @template T - The component data type
+ * @example
+ * // For Position component: { x: number, y: number }
+ * // ComponentDataArrays would be: { x: Float32Array, y: Float32Array }
+ */
+type ComponentDataArrays<T> = {
+  [K in keyof T]: T[K] extends number ? Float32Array : T[K][];
+};
+
+/**
+ * Maps component names to their data arrays for direct access.
+ * Used to expose component data to the user without store methods.
+ * @template T - Record type defining all component types
+ */
+type StoreDataMap<T> = {
+  [K in keyof T]: ComponentDataArrays<T[K]>;
+};
+
+/**
+ * Maps component names to their raw sparse lookup table.
+ * Each table translates an entity ID into that entity's index in the component's
+ * data arrays, which is what queryIds callers need to read the SoA storage.
+ * @template T - Record type defining all component types
+ */
+type IndexMap<T> = {
+  [K in keyof T]: number[];
+};
+
+/**
+ * Type helper for the query result.
+ * Creates an object with an entry for each requested component, holding its store index.
+ * @template C - Array of the component names requested in the query.
+ */
+type QueryResult<C extends readonly PropertyKey[]> = {
+  [K in C[number]]: { id: number };
+};
+
+/**
+ * Interface for the main ECS registry.
+ * Provides high-level API for entity-component management,
+ * coordinating between EntityManager and ComponentStores.
+ * @template T - Record type defining all component types in the ECS
+ */
+interface IECS<T> {
+  /**
+   * Initializes the ECS with component definitions.
+   * Registers all components and creates their corresponding stores.
+   * Must be called before any other operations.
+   * @param names -component names
+   * @throws Error if a component name is already defined
+   */
+  defineComponents<K extends readonly (keyof T)[]>(...names: K): void;
+
+  /**
+   * Creates a new entity in the ECS.
+   * @returns The ID of the newly created entity
+   */
+  createEntity: () => number;
+
+  /**
+   * Completely removes an entity and all its components from the ECS.
+   * Cleans up all component data and entity records.
+   * @param eid - The entity ID to destroy
+   */
+  destroyEntity: (eid: number) => void;
+
+  /**
+   * Adds a component to an entity with the provided data.
+   * Updates both the entity's bitmask and the component store.
+   * @template K - The component name type (key of T)
+   * @param eid - The entity ID
+   * @param name - The component name
+   * @param data - The component data to store
+   */
+  addComponent: <K extends keyof T>(eid: number, name: K, data: T[K]) => void;
+
+  /**
+   * Removes a component from an entity.
+   * Updates both the entity's bitmask and the component store.
+   * @template K - The component name type (key of T)
+   * @param eid - The entity ID
+   * @param name - The component name
+   */
+  removeComponent: <K extends keyof T>(eid: number, name: K) => void;
+
+  /**
+   * Retrieves all entities that contain the specified set of components.
+   * Performs a filtered search across component stores and yields each matching entity.
+   * The returned generator allows efficient iteration without allocating large arrays.
+   *
+   * @template C - Array of component names to query for
+   * @param components - List of component names that the entity must include
+   * @returns A generator that yields an object for each matching entity,
+   *          containing the entity ID and the related component data
+   */
+  query: <C extends (keyof T)[]>(...componentName: C) => Generator<QueryResult<C>>;
+
+  /**
+   * Allocation-free counterpart to query, for hot systems.
+   * Returns the IDs of every entity holding all the specified components, instead of
+   * yielding one result object plus one { id } object per component per entity.
+   * Translate an entity ID into a storage index through `indices`:
+   *
+   * ```ts
+   * const { Position, Velocity } = World.components;
+   * const pos = World.indices.Position;
+   * const vel = World.indices.Velocity;
+   *
+   * for (const eid of World.queryIds('Position', 'Velocity')) {
+   *   Position.x[pos[eid]] += Velocity.x[vel[eid]];
+   * }
+   * ```
+   *
+   * The array is complete before it is returned, so adding or removing components while
+   * looping over it cannot skip an entity. Destroying an entity mid-loop does invalidate
+   * its storage index, so guard that case yourself.
+   *
+   * @template C - Array of component names to query for
+   * @param componentName - List of component names that the entity must include
+   * @returns A fresh array of matching entity IDs
+   */
+  queryIds: <C extends (keyof T)[]>(...componentName: C) => number[];
+
+  components: StoreDataMap<T>;
+
+  /**
+   * Maps each component name to its sparse lookup table, translating an entity ID into
+   * that entity's index in the component's data arrays. Needed to read `components`
+   * when iterating the output of queryIds.
+   */
+  indices: IndexMap<T>;
+}
+
+declare function ECS<T extends Record<string, Record<string, any>>>(): IECS<T>;
+
+export { ECS };