@ste_tisci/ecs 0.1.6 → 0.1.8

package/src/types/IEcs.d.ts

@@ -1,64 +0,0 @@
-import type { QueryResult, StoreDataMap } from './index.js';
-
-/**
- * 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
- */
-export 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>>;
-
-  components: StoreDataMap<T>;
-}

package/src/types/IEntityManager.d.ts

@@ -1,65 +0,0 @@
-/**
- * Interface for managing entities and their component associations.
- * Uses bitmasks to efficiently track which components each entity has,
- * enabling fast component checks and queries.
- */
-export interface IEntityManager<K extends string> {
-  /**
-   * Checks if an entity exists in the system.
-   * @param eid - The entity ID to check
-   * @returns True if the entity exists, false otherwise
-   */
-  exists: (eid: number) => boolean;
-
-  /**
-   * Checks if an entity has a specific component.
-   * Uses bitwise operations on the entity's bitmask for fast lookups.
-   * @param eid - The entity ID
-   * @param name - The component name
-   * @returns True if the entity has the component, false otherwise
-   */
-  hasComponent: (eid: number, name: K) => boolean;
-
-  /**
-   * Creates a new entity.
-   * Recycles entity IDs when possible, otherwise assigns a new incremental ID.
-   * @returns The ID of the newly created entity
-   */
-  create: () => number;
-
-  /**
-   * Removes an entity from the system.
-   * Marks the entity ID for recycling.
-   * @param eid - The entity ID to remove
-   * @throws Error if the entity doesn't exist
-   */
-  remove: (eid: number) => void;
-
-  /**
-   * Adds a component flag to an entity's bitmask.
-   * Updates the entity's bitmask to indicate it has the specified component.
-   * @param eid - The entity ID
-   * @param name - The component name
-   * @throws Error if the entity doesn't exist or already has the component
-   */
-  addComponent: (eid: number, name: K) => void;
-
-  /**
-   * Removes a component flag from an entity's bitmask.
-   * Updates the entity's bitmask to indicate it no longer has the specified component.
-   * @param eid - The entity ID
-   * @param name - The component name
-   * @throws Error if the entity doesn't exist
-   */
-  removeComponent: (eid: number, name: K) => void;
-
-  /**
-   * Retrieves the complete bitmask for an entity.
-   * The bitmask represents all components the entity has,
-   * with each bit corresponding to a component ID.
-   * @param eid - The entity ID
-   * @returns The entity's component bitmask
-   * @throws Error if the entity doesn't exist
-   */
-  getMask: (eid: number) => bigint;
-}

package/src/types/ISparseSet.d.ts

@@ -1,49 +0,0 @@
-/**
- * Interface used for fast entity lookups, insertion and removal.
- *
- * Maintain two parallel arrays:
- *
- * - sparse: a direct lookup table that maps an entity ID (eid) to its index in the dense array.
- * - dense: a compact array that stores all active entity IDs contiguously.
- */
-export interface ISparseSet {
-  /**
-   * Check if an entity ID exists in the set
-   * @param eid The entity ID to check
-   * @returns True if the entity ID exists, false otherwise
-   */
-  has: (eid: number) => boolean;
-
-  /**
-   * Add the entity ID to the set
-   * @param eid The entity ID to add
-   * @thows Error if the entity ID is already been added
-   */
-  add: (eid: number) => void;
-
-  /**
-   * Remove an Entity ID from the set
-   * @param eid The entity ID to remove
-   * @throws Error if the ID does not exists in the set
-   */
-  remove: (eid: number) => void;
-
-  /**
-   * Retrive the index of the entity ID in the set
-   * @param eid The entity ID
-   * @returns The index corresponding to an entity ID in the set
-   */
-  getIndex: (eid: number) => number;
-
-  /**
-   * Retrive the full dense array that contain all the entity IDs of the set
-   * @returns an Array with all the current entity IDs
-   */
-  getDense: () => number[];
-
-  /**
-   * Retrive the size representing the number of active entities in the set.
-   * @returns The current size of the Dense array
-   */
-  getSize: () => number;
-}

package/src/types/index.d.ts

@@ -1,43 +0,0 @@
-import type { IComponentStore } from './IComponentStore.js';
-
-/**
- * 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 }
- */
-export type ComponentDataArrays<T> = {
-  [K in keyof T]: T[K] extends number ? Float32Array : T[K][];
-};
-
-/**
- * Maps component names to their corresponding ComponentStore instances.
- * Used internally by CreateWorld to manage all component stores.
- * @template T - Record type defining all component types
- */
-export type StoreMap<T> = {
-  [K in keyof T]: IComponentStore<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
- */
-export type StoreDataMap<T> = {
-  [K in keyof T]: ComponentDataArrays<T[K]>;
-};
-
-/**
- * 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.
- */
-export type QueryResult<C extends readonly PropertyKey[]> = {
-  [K in C[number]]: { id: number };
-};

package/src/utils/ComponentRegistry.ts

@@ -1,32 +0,0 @@
-import type { IComponentRegistry } from '../types/IComponentRegistry.js';
-
-export function createComponentRegistry<K extends string>(): IComponentRegistry<K> {
-  const nameToID = new Map<K, number>();
-  const IDtoName = new Map<number, K>();
-  let nextID: number = 0;
-
-  function register(name: K): void {
-    if (!nameToID.has(name)) {
-      const eid = nextID++;
-
-      nameToID.set(name, eid);
-      IDtoName.set(eid, name);
-    }
-  }
-
-  function getID(name: K): number {
-    const eid = nameToID.get(name);
-    if (eid === undefined) throw new Error(`Component ${name} not registered`);
-
-    return eid;
-  }
-
-  function getName(cid: number): K {
-    const name = IDtoName.get(cid);
-    if (!name) throw new Error(`Component ID ${cid} not registered`);
-
-    return name;
-  }
-
-  return { register, getID, getName };
-}

package/src/utils/SparseSet.ts

@@ -1,54 +0,0 @@
-import type { ISparseSet } from '../types/ISparseSet.js';
-
-export function SparseSet(): ISparseSet {
-  const sparse: number[] = [];
-  const dense: number[] = [];
-  let size = 0;
-
-  function has(eid: number): boolean {
-    const ID = getIndex(eid);
-
-    const exist = ID !== undefined && dense[ID] === eid;
-    const isWhitinBounds = ID >= 0 && ID < size;
-
-    return exist && isWhitinBounds;
-  }
-
-  function add(eid: number): void {
-    if (has(eid)) throw new Error(`ID ${eid} already present in the set`);
-
-    sparse[eid] = size;
-    dense[size] = eid;
-    size++;
-  }
-
-  function remove(eid: number): void {
-    if (!has(eid)) throw new Error(`Cannot remove ID ${eid} because does not exists`);
-
-    const ID = getIndex(eid);
-    const last = dense[size - 1];
-
-    // Swap with the last element inserted
-    dense[ID] = last;
-    sparse[last] = ID;
-
-    // Remove the element
-    dense.pop();
-    size--;
-    delete sparse[eid];
-  }
-
-  function getIndex(eid: number): number {
-    return sparse[eid];
-  }
-
-  function getDense(): number[] {
-    return dense;
-  }
-
-  function getSize(): number {
-    return size;
-  }
-
-  return { has, add, remove, getIndex, getDense, getSize };
-}

package/tsconfig.json

@@ -1,17 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "es2024",
-    "allowSyntheticDefaultImports": true,
-    "esModuleInterop": true,
-    "outDir": "dist",
-    "forceConsistentCasingInFileNames": true,
-    "resolveJsonModule": true,
-    "strict": true,
-    "sourceMap": true,
-    "rootDir": "src",
-    "moduleResolution": "nodenext",
-    "module": "node20"
-  },
-  "exclude": ["node_modules/"],
-  "include": ["src"]
-}

package/tsup.config.ts

@@ -1,10 +0,0 @@
-import { defineConfig } from 'tsup';
-
-export default defineConfig({
-  format: ['cjs', 'esm'],
-  entry: ['./src/index.ts'],
-  dts: true,
-  shims: true,
-  skipNodeModulesBundle: true,
-  clean: true,
-});