@forgeax/engine-ecs 0.0.0-dev.8d955ade1c79

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,278 @@
+# `@forgeax/engine-ecs`
+
+Archetype ECS for ForgeaX. The package owns the hot path shared by every
+domain: entity identity, component storage, relationships, queries, structural
+mutation, two schedules, resources, time, and optional shared numeric kernels.
+
+> [!IMPORTANT]
+> `World` is the state authority. Scene instances, render extraction, physics
+> backends, asset ownership, input collection, and application lifecycle stay
+> in their owning packages. Do not add a second ECS facade for one of those
+> domains.
+
+```mermaid
+flowchart LR
+  HOST["App host"] --> WORLD["World.update(delta)"]
+  WORLD --> FIXED["FixedUpdate"]
+  FIXED --> UPDATE["Update + command flush"]
+  UPDATE --> PUBLISH["Scene / render projections"]
+  WORLD --> QUERY["Query row / span"]
+  WORLD --> JOURNAL["Bounded change journal"]
+  JOURNAL --> PROJECTION["ecs/projection"]
+```
+
+## The smallest useful journey
+
+```ts
+import type { Result } from '@forgeax/engine-types';
+import {
+  type EcsError,
+  FixedTime,
+  Update,
+  World,
+  defineComponent,
+  defineSystem,
+} from '@forgeax/engine-ecs';
+
+const Position = defineComponent('Position', {
+  x: { type: 'f32', default: 0 },
+  y: { type: 'f32', default: 0 },
+});
+
+const Move = defineSystem({
+  name: 'move',
+  queries: [{ write: [Position] }],
+  fn: (_world, [positions]) => {
+    for (const row of positions) {
+      const position = row.mut(Position);
+      position.x += 1;
+    }
+  },
+});
+
+const world = new World();
+const spawned = world.spawn({ component: Position, data: { x: 0, y: 0 } });
+if (!spawned.ok) throw spawned.error;
+const registered = world.addSystem(Update, Move);
+if (!registered.ok) throw registered.error;
+const stepped: Result<void, EcsError> = world.update(1 / 60);
+if (!stepped.ok) console.error(stepped.error.code, stepped.error.hint);
+```
+
+The normal data path is `world.query(descriptor)` with a row iterator or a
+packed `QuerySpan`. Success-path row access is direct and allocation-free;
+expected boundary failures use the shared `Result` carrier from
+`@forgeax/engine-types`.
+
+## Components and schema
+
+`defineComponent` accepts one closed storage vocabulary. The token exposes only
+the schema facts needed by a consumer: `name`, frozen `fields`, and `storage`.
+Authoring metadata, lifecycle callbacks, render policy, simulation policy, and
+open-ended metadata do not belong on a component token.
+
+| Shape | Use | Example |
+|:--|:--|:--|
+| scalar | numeric, boolean, or enum data | `{ type: 'f32', default: 0 }` |
+| `string` | managed text value | `{ type: 'string', default: '' }` |
+| `entity` | raw entity reference | `{ type: 'entity' }` |
+| `shared<Tag>` | externally owned shared payload handle | `{ type: 'shared<MeshAsset>' }` |
+| `array<T>` | variable array replaced as one value | `{ type: 'array<f32>' }` |
+| `array<T,N>` | fixed-size inline array | `{ type: 'array<f32, 4>' }` |
+| sparse tag | presence-only marker | `defineComponent('Disabled', {})` |
+
+The `fields` object is deeply frozen at definition time. A value replacement
+uses the ordinary mutation path:
+
+```ts
+const Trail = defineComponent('Trail', { points: { type: 'array<f32>' } });
+const entity = world.spawn({ component: Trail, data: { points: new Float32Array([0, 1]) } }).unwrap();
+const current = world.get(entity, Trail).unwrap();
+world.set(entity, Trail, { points: new Float32Array([...current.points, 2]) });
+```
+
+The Scene package may define a single-field `Name { value: 'string' }` token
+for authoring. ECS stores the value through the same closed `string` schema
+vocabulary, but does not own the Scene component or its authoring policy.
+
+Scene and Render own their domain schemas, for example `Instances { transforms`
+is a Render-owned projection whose array payload still follows ECS replacement
+semantics.
+
+There is no public `push`, `pop`, `capacity`, `reserveArrayCapacity`, view
+class, or user-managed target-array mutation API. A replacement is one bounded
+mutation, so an invalid value leaves the previous column and reference counts
+unchanged.
+
+Object-shaped numeric writes reject `NaN` before touching the column. The
+returned `component-numeric-value-invalid` error carries the component, field,
+entity, received value, and optional array index in `detail`; `Infinity` remains
+valid when the schema accepts it. Branch on `error.code` and use `error.hint` to
+choose the correction instead of parsing a message.
+
+## Relationships: one source, one materialized index
+
+Relationships preserve the reverse index because lookup complexity is part of
+the contract. Reading a parent's children is $O(1 + k)$ for $k$ direct children,
+not an $O(N)$ scan of every entity. The source is the only writable fact; the
+target is an engine-maintained, read-only materialized vector with a
+source-to-slot backpointer for amortized $O(1)$ attach, detach, and reparent.
+
+```ts
+import { defineRelationship } from '@forgeax/engine-ecs';
+
+const { source: ChildOf, target: Children } = defineRelationship({
+  sourceName: 'ChildOf',
+  sourceField: 'parent',
+  targetName: 'Children',
+  targetField: 'entities',
+  exclusive: true,
+  linkedSpawn: true,
+});
+
+const parent = world.spawn().unwrap();
+const child = world.spawn({ component: ChildOf, data: { parent } }).unwrap();
+const children = world.get(parent, Children).unwrap().entities;
+```
+
+`Children` and `AnimationTargets` are read projections, not a second write
+authority. `Children { entities` is a materialized target owned by ECS; the
+Scene package owns the `ChildOf` vocabulary and chooses where to use it. The
+same rule applies to `AnimationTargets`. Direct target writes are rejected by
+`World` at both the type and runtime boundaries.
+
+## Queries and projections
+
+Queries are the only public data-plane API. A row is the flexible path; a span
+is the packed numeric path and includes entity handles for owner-side identity.
+Raw `Table`, `Archetype`, `Column`, and `FieldView` values are package-private.
+
+```ts
+const query = world.query({ read: [Position] }).unwrap();
+for (const row of query) console.log(row.entity, row.get(Position).x);
+const writable = world.query({ write: [Position] }).unwrap();
+for (const span of writable.spans().unwrap()) {
+  const positions = span.mut(Position);
+  for (let i = 0; i < span.length; i += 1) positions.x[i] += 1;
+}
+```
+
+Incremental owners use the explicitly named projection subpath. It carries
+bounded change evidence only; a full rebuild uses the ordinary query path.
+
+```ts
+import { createWorldProjection } from '@forgeax/engine-ecs/projection';
+
+const projection = createWorldProjection(world, { components: [Position] });
+const next = projection.poll();
+if (next.status === 'rebuild') {
+  // Rebuild the owner's cache with world.query(...).spans().
+} else {
+  for (const change of next.changes) console.log(change.entity, change.kind);
+}
+```
+
+Projection output never contains table ids, rows, columns, or a duplicate
+snapshot data plane.
+
+## Schedules, time, and resources
+
+Only `Update` and `FixedUpdate` are user schedules. Registration is token-first;
+there is no frame-end schedule, system-parameter DSL, terminal render hook, or
+severity/error-handler registry.
+
+```ts
+world.addSystem(Update, Move).unwrap();
+world.addSystem(FixedUpdate, {
+  name: 'fixed-step',
+  queries: [],
+  fn: (fixedWorld) => {
+    const fixed = fixedWorld.getResource(FixedTime);
+    void fixed.tick;
+  },
+}).unwrap();
+```
+
+`world.update(deltaSeconds)` advances the clock, runs zero or more fixed steps,
+runs one update step, and flushes each system's command buffer. Clock readers
+receive a stable read view; the scheduler owns writes. Resources are non-owning
+values: Cordis/plugin owners dispose external payloads, not `World`.
+
+## Failure and recovery
+
+Branch on `error.code`, never on a message string. The closed ECS error union
+preserves `code`, `expected`, `hint`, `detail`, and `cause` where applicable.
+
+```ts
+const result = world.update(1 / 60);
+if (!result.ok) {
+  switch (result.error.code) {
+    case 'world-poisoned':
+      // Stop the frame and ask the App execution owner to rebuild.
+      break;
+    default:
+      console.error(result.error.code, result.error.hint);
+  }
+}
+```
+
+Expected command failures are reported before structural commit and leave the
+World unchanged. A system throw or an unknown post-write failure cannot prove
+that no row was mutated: the World becomes poisoned and must be rebuilt by the
+App execution owner. Shared-kernel partial writes follow the same fail-closed
+rule.
+
+```mermaid
+stateDiagram-v2
+  [*] --> Healthy
+  Healthy --> Healthy: expected failure / zero delta
+  Healthy --> Poisoned: system throw or partial write
+  Poisoned --> Rebuilt: App stops frame and replaces World
+  Rebuilt --> Healthy
+```
+
+## Inspection
+
+`world.inspect()` is an explicit, detached, deeply frozen POD snapshot for
+diagnostics. It is not a live registry and is not a storage escape hatch.
+Consumers should use entity counts, active component names, schedule summaries,
+and resource keys; gameplay code should use queries.
+
+## Public surface and subpaths
+
+The root barrel is intentionally small. Advanced capabilities are named by
+their owner instead of being forwarded through the root.
+
+| Entry | Purpose |
+|:--|:--|
+| `@forgeax/engine-ecs` | World, components, relationships, queries, schedules, resources, errors |
+| `@forgeax/engine-ecs/projection` | Bounded change cursor and rebuild signal |
+| `@forgeax/engine-ecs/shared` | Shared numeric kernel contracts |
+| `@forgeax/engine-ecs/externalization` | Generic component projection and entity remap |
+
+`Result`, `ok`, `err`, and `Handle` come from `@forgeax/engine-types`; ECS does
+not forward them. There is no ECS remote bin, simulation record/restore
+protocol, scene-instance resolver, or compatibility alias for removed APIs.
+
+<details>
+<summary>Removed concepts</summary>
+
+The one-cut surface deliberately removes `FrameEnd`, `setErrorHandler`,
+`defineSystemParam`, `ParamValidation`, simulation record/restore/trace APIs,
+scene lifecycle methods, raw storage exports, relationship metadata lookup,
+root `Result`/`Handle` forwarding, and array convenience commands. When a
+consumer needs one of those concerns, move the owner to App, Scene, Render,
+Physics, or the explicitly named ECS subpath.
+</details>
+
+## Verification
+
+- [x] Entity and component mutation use one World authority.
+- [x] Relationship targets remain materialized for $O(1 + k)$ reads.
+- [x] Query row/span are the only public data plane.
+- [x] `Update` and `FixedUpdate` are the only schedules.
+- [x] Expected failures are structured; unknown partial writes poison the World.
+- [x] Advanced projection/shared/externalization APIs are named subpaths.
+
+For the full migration rationale and acceptance matrix, see the canonical
+[ECS 80% architecture design](../../.forgeax-harness/docs/specs/2026-08-22-ecs-core-80-percent-architecture-reduction-design.md).