qti-clockwork-ecs 0.1.0

package/LICENSE

@@ -0,0 +1,173 @@
+Clockwork Engine
+Copyright (C) 2026 Quiet Terminal Interactive LTD
+
+This project is licensed under the GNU Lesser General Public License v3.0.
+See the license text below.
+
+-----------------------------------------------------------------------
+
+                  GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

package/dist/index.cjs

@@ -0,0 +1,532 @@
+"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, {
+  BuiltinResourceTypes: () => BuiltinResourceTypes,
+  CommandBuffer: () => CommandBuffer,
+  ComponentStore: () => ComponentStore,
+  DeferredEntityBuilder: () => DeferredEntityBuilder,
+  EntityBuilder: () => EntityBuilder,
+  EntityManager: () => EntityManager,
+  ObjectPool: () => ObjectPool,
+  Query: () => Query,
+  ResourceMap: () => ResourceMap,
+  ResourceType: () => ResourceType,
+  World: () => World,
+  collectWorldStats: () => collectWorldStats,
+  packageId: () => packageId
+});
+module.exports = __toCommonJS(index_exports);
+var packageId = "qti-clockwork-ecs";
+var ResourceType = class _ResourceType {
+  static symbolIds = /* @__PURE__ */ new Map();
+  static ctorIds = /* @__PURE__ */ new WeakMap();
+  static nextId = 0;
+  id;
+  version;
+  dependencies;
+  constructor(id, options) {
+    this.id = id;
+    this.version = options?.version ?? 1;
+    this.dependencies = options?.dependencies ?? [];
+  }
+  static fromToken(token) {
+    if (typeof token === "string") {
+      return new _ResourceType(`string:${token}`);
+    }
+    if (typeof token === "symbol") {
+      let symbolId = this.symbolIds.get(token);
+      if (symbolId === void 0) {
+        symbolId = this.nextId++;
+        this.symbolIds.set(token, symbolId);
+      }
+      return new _ResourceType(`symbol:${symbolId}`);
+    }
+    let ctorId = this.ctorIds.get(token);
+    if (ctorId === void 0) {
+      ctorId = this.nextId++;
+      this.ctorIds.set(token, ctorId);
+    }
+    return new _ResourceType(`ctor:${ctorId}`);
+  }
+};
+var ResourceMap = class {
+  values = /* @__PURE__ */ new Map();
+  revision = 0;
+  insert(type, resource) {
+    for (const dependency of type.dependencies) {
+      const installed = this.values.get(dependency.id);
+      if (!installed) {
+        throw new Error(
+          `Resource "${type.id}" depends on missing "${dependency.id}"`
+        );
+      }
+      if (installed.type.version < dependency.version) {
+        throw new Error(
+          `Resource "${type.id}" requires "${dependency.id}" version ${dependency.version}+, found ${installed.type.version}`
+        );
+      }
+    }
+    this.revision += 1;
+    this.values.set(type.id, {
+      type,
+      value: resource,
+      revision: this.revision
+    });
+  }
+  get(type) {
+    const resource = this.tryGet(type);
+    if (resource === void 0) {
+      throw new Error(
+        `Resource "${type.id}" is not registered (required version ${type.version})`
+      );
+    }
+    return resource;
+  }
+  tryGet(type) {
+    const stored = this.values.get(type.id);
+    if (!stored) {
+      return void 0;
+    }
+    return stored.value;
+  }
+  remove(type) {
+    this.values.delete(type.id);
+  }
+  has(type) {
+    return this.values.has(type.id);
+  }
+  getInstalledVersion(type) {
+    return this.values.get(type.id)?.type.version;
+  }
+  getRevision(type) {
+    return this.values.get(type.id)?.revision;
+  }
+};
+var BuiltinResourceTypes = {
+  Time: new ResourceType("builtin:Time"),
+  Input: new ResourceType("builtin:Input"),
+  Assets: new ResourceType("builtin:Assets"),
+  Renderer: new ResourceType("builtin:Renderer"),
+  AudioContext: new ResourceType("builtin:AudioContext"),
+  Rng: new ResourceType("builtin:Rng"),
+  Config: new ResourceType("builtin:Config"),
+  Profiler: new ResourceType("builtin:Profiler")
+};
+var EntityManager = class {
+  generations = [];
+  alive = [];
+  freeIndices = [];
+  aliveCount = 0;
+  create() {
+    this.aliveCount += 1;
+    const index = this.freeIndices.pop();
+    if (index === void 0) {
+      const newIndex = this.generations.length;
+      this.generations.push(0);
+      this.alive.push(true);
+      return { index: newIndex, generation: 0 };
+    }
+    this.alive[index] = true;
+    return { index, generation: this.generations[index] };
+  }
+  destroy(entity) {
+    if (!this.isAlive(entity)) {
+      return;
+    }
+    this.aliveCount -= 1;
+    const { index } = entity;
+    this.alive[index] = false;
+    this.generations[index] = this.generations[index] + 1 >>> 0;
+    this.freeIndices.push(index);
+  }
+  isAlive(entity) {
+    const { index, generation } = entity;
+    if (index < 0 || index >= this.generations.length) {
+      return false;
+    }
+    return this.alive[index] === true && this.generations[index] === generation;
+  }
+  getGeneration(entity) {
+    if (entity.index < 0 || entity.index >= this.generations.length) {
+      return 0;
+    }
+    return this.generations[entity.index];
+  }
+  *iterAlive() {
+    for (let index = 0; index < this.alive.length; index += 1) {
+      if (!this.alive[index]) {
+        continue;
+      }
+      yield { index, generation: this.generations[index] };
+    }
+  }
+};
+var ComponentStore = class {
+  values = /* @__PURE__ */ new Map();
+  add(entity, component, changeTick = 0) {
+    this.values.set(entity.index, {
+      generation: entity.generation,
+      value: component,
+      changedAt: changeTick
+    });
+  }
+  remove(entity) {
+    const current = this.values.get(entity.index);
+    if (!current || current.generation !== entity.generation) {
+      return;
+    }
+    this.values.delete(entity.index);
+  }
+  removeByIndex(index) {
+    this.values.delete(index);
+  }
+  get(entity) {
+    const current = this.values.get(entity.index);
+    if (!current || current.generation !== entity.generation) {
+      return void 0;
+    }
+    return current.value;
+  }
+  has(entity) {
+    const current = this.values.get(entity.index);
+    return Boolean(current && current.generation === entity.generation);
+  }
+  getChangedAt(entity) {
+    const current = this.values.get(entity.index);
+    if (!current || current.generation !== entity.generation) {
+      return void 0;
+    }
+    return current.changedAt;
+  }
+  *iter() {
+    const keys = [...this.values.keys()].sort((a, b) => a - b);
+    for (const index of keys) {
+      const stored = this.values.get(index);
+      yield [{ index, generation: stored.generation }, stored.value];
+    }
+  }
+  sortedEntities() {
+    const keys = [...this.values.keys()].sort((a, b) => a - b);
+    const result = new Array(keys.length);
+    for (let i = 0; i < keys.length; i += 1) {
+      const index = keys[i];
+      const stored = this.values.get(index);
+      result[i] = { index, generation: stored.generation };
+    }
+    return result;
+  }
+};
+var Query = class {
+  constructor(world) {
+    this.world = world;
+  }
+  withTypes = /* @__PURE__ */ new Set();
+  withoutTypes = /* @__PURE__ */ new Set();
+  optionalTypes = /* @__PURE__ */ new Set();
+  changedTypes = /* @__PURE__ */ new Set();
+  lastIteratedTick = -1;
+  with(...components) {
+    for (const type of components) {
+      this.withTypes.add(type);
+    }
+    return this;
+  }
+  without(...components) {
+    for (const type of components) {
+      this.withoutTypes.add(type);
+    }
+    return this;
+  }
+  optional(component) {
+    this.optionalTypes.add(component);
+    return this;
+  }
+  changed(component) {
+    this.changedTypes.add(component);
+    return this;
+  }
+  *iter() {
+    const candidates = this.collectCandidates();
+    for (const entity of candidates) {
+      if (!this.matches(entity)) {
+        continue;
+      }
+      const components = /* @__PURE__ */ new Map();
+      for (const type of this.withTypes) {
+        components.set(type, this.world.getComponent(entity, type));
+      }
+      for (const type of this.optionalTypes) {
+        components.set(type, this.world.getComponent(entity, type));
+      }
+      yield { entity, components };
+    }
+    this.lastIteratedTick = this.world.currentTick;
+  }
+  collectCandidates() {
+    const withTypes = [...this.withTypes];
+    if (withTypes.length === 0) {
+      return [...this.world.entities.iterAlive()];
+    }
+    const seedStore = this.world.getStore(withTypes[0]);
+    if (!seedStore) {
+      return [];
+    }
+    return seedStore.sortedEntities();
+  }
+  matches(entity) {
+    if (!this.world.entities.isAlive(entity)) {
+      return false;
+    }
+    for (const type of this.withTypes) {
+      if (!this.world.hasComponent(entity, type)) {
+        return false;
+      }
+    }
+    for (const type of this.withoutTypes) {
+      if (this.world.hasComponent(entity, type)) {
+        return false;
+      }
+    }
+    for (const type of this.changedTypes) {
+      const changedAt = this.world.getComponentChangedAt(entity, type);
+      if (changedAt === void 0 || changedAt <= this.lastIteratedTick) {
+        return false;
+      }
+    }
+    return true;
+  }
+};
+var EntityBuilder = class {
+  constructor(world, entity) {
+    this.world = world;
+    this.entity = entity;
+  }
+  with(type, component) {
+    this.world.addComponent(this.entity, type, component);
+    return this;
+  }
+  build() {
+    return this.entity;
+  }
+};
+var DeferredEntityBuilder = class {
+  constructor(deferred) {
+    this.deferred = deferred;
+  }
+  with(type, component) {
+    this.deferred.initialComponents.push({ type, component });
+    return this;
+  }
+};
+var CommandBuffer = class {
+  constructor(world) {
+    this.world = world;
+  }
+  operations = [];
+  spawn() {
+    const deferred = { initialComponents: [] };
+    this.operations.push({ kind: "spawn", deferred });
+    return new DeferredEntityBuilder(deferred);
+  }
+  destroy(entity) {
+    this.operations.push({ kind: "destroy", entity });
+  }
+  addComponent(entity, type, component) {
+    this.operations.push({ kind: "add", entity, type, component });
+  }
+  removeComponent(entity, type) {
+    this.operations.push({ kind: "remove", entity, type });
+  }
+  flush() {
+    for (const operation of this.operations) {
+      switch (operation.kind) {
+        case "spawn": {
+          const entity = this.world.spawnEntity();
+          operation.deferred.resolved = entity;
+          for (const entry of operation.deferred.initialComponents) {
+            this.world.addComponent(entity, entry.type, entry.component);
+          }
+          break;
+        }
+        case "destroy": {
+          const entity = this.resolveEntity(operation.entity);
+          if (entity) {
+            this.world.destroy(entity);
+          }
+          break;
+        }
+        case "add": {
+          const entity = this.resolveEntity(operation.entity);
+          if (entity) {
+            this.world.addComponent(entity, operation.type, operation.component);
+          }
+          break;
+        }
+        case "remove": {
+          const entity = this.resolveEntity(operation.entity);
+          if (entity) {
+            this.world.removeComponent(entity, operation.type);
+          }
+          break;
+        }
+      }
+    }
+    this.operations.length = 0;
+  }
+  resolveEntity(entity) {
+    if ("initialComponents" in entity) {
+      return entity.resolved;
+    }
+    return entity;
+  }
+};
+var World = class {
+  entities = new EntityManager();
+  components = /* @__PURE__ */ new Map();
+  resources = new ResourceMap();
+  changeTick = 0;
+  get currentTick() {
+    return this.changeTick;
+  }
+  spawn() {
+    return new EntityBuilder(this, this.spawnEntity());
+  }
+  spawnEntity() {
+    this.changeTick += 1;
+    return this.entities.create();
+  }
+  destroy(entity) {
+    if (!this.entities.isAlive(entity)) {
+      return;
+    }
+    for (const store of this.components.values()) {
+      store.removeByIndex(entity.index);
+    }
+    this.entities.destroy(entity);
+    this.changeTick += 1;
+  }
+  commands() {
+    return new CommandBuffer(this);
+  }
+  query() {
+    return new Query(this);
+  }
+  getStore(type) {
+    return this.components.get(type);
+  }
+  addComponent(entity, type, component) {
+    if (!this.entities.isAlive(entity)) {
+      return;
+    }
+    const store = this.ensureStore(type);
+    this.changeTick += 1;
+    store.add(entity, component, this.changeTick);
+  }
+  removeComponent(entity, type) {
+    if (!this.entities.isAlive(entity)) {
+      return;
+    }
+    const store = this.components.get(type);
+    if (!store) {
+      return;
+    }
+    store.remove(entity);
+    this.changeTick += 1;
+  }
+  getComponent(entity, type) {
+    return this.getStore(type)?.get(entity);
+  }
+  hasComponent(entity, type) {
+    return this.components.get(type)?.has(entity) ?? false;
+  }
+  getComponentChangedAt(entity, type) {
+    return this.components.get(type)?.getChangedAt(entity);
+  }
+  insertResource(type, resource) {
+    this.resources.insert(ResourceType.fromToken(type), resource);
+  }
+  getResource(type) {
+    return this.resources.get(ResourceType.fromToken(type));
+  }
+  tryGetResource(type) {
+    return this.resources.tryGet(ResourceType.fromToken(type));
+  }
+  removeResource(type) {
+    this.resources.remove(ResourceType.fromToken(type));
+  }
+  hasResource(type) {
+    return this.resources.has(ResourceType.fromToken(type));
+  }
+  ensureStore(type) {
+    let store = this.components.get(type);
+    if (!store) {
+      store = new ComponentStore();
+      this.components.set(type, store);
+    }
+    return store;
+  }
+};
+var ObjectPool = class {
+  constructor(factory, reset) {
+    this.factory = factory;
+    this.reset = reset;
+  }
+  free = [];
+  acquire() {
+    return this.free.pop() ?? this.factory();
+  }
+  release(item) {
+    this.reset?.(item);
+    this.free.push(item);
+  }
+  size() {
+    return this.free.length;
+  }
+};
+function collectWorldStats(world) {
+  const entityCount = world.entities.aliveCount;
+  let componentInstanceCount = 0;
+  for (const store of world.components.values()) {
+    componentInstanceCount += [...store.iter()].length;
+  }
+  return {
+    entityCount,
+    componentStoreCount: world.components.size,
+    componentInstanceCount
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  BuiltinResourceTypes,
+  CommandBuffer,
+  ComponentStore,
+  DeferredEntityBuilder,
+  EntityBuilder,
+  EntityManager,
+  ObjectPool,
+  Query,
+  ResourceMap,
+  ResourceType,
+  World,
+  collectWorldStats,
+  packageId
+});