@awesome-ecs/abstract 0.21.1 → 0.22.0

package/dist/factories/index.d.cts

@@ -3,7 +3,7 @@ import "../types-DvzdpbLu.cjs";
 import "../index-DLm-DKAk.cjs";
 import { IPipeline, IPipelineContext } from "../index-D81Fo9XN.cjs";
 import "../index-ChV4Q5j6.cjs";
-import { ISystemContext, ISystemsRuntimeContext } from "../index-CKh4A7mH.cjs";
+import { ISystemContext, ISystemsRuntimeContext } from "../index-CjNeb3ML.cjs";
 
 //#region src/factories/context-factory.d.ts
 /**

package/dist/factories/index.d.ts

@@ -3,7 +3,7 @@ import "../types-yh4pOGEm.js";
 import "../index-C3UGZqUG.js";
 import { IPipeline, IPipelineContext } from "../index-Cm-YSPhK.js";
 import "../index-oenqxDCa.js";
-import { ISystemContext, ISystemsRuntimeContext } from "../index-zpj0YApu.js";
+import { ISystemContext, ISystemsRuntimeContext } from "../index-CH8ucsKZ.js";
 
 //#region src/factories/context-factory.d.ts
 /**

package/dist/{index-zpj0YApu.d.ts → index-CH8ucsKZ.d.ts}

@@ -1,7 +1,7 @@
 import { EntityProxy, EntityTypeUid, IEntity, IEntityModel, IEntityProxy } from "./identity-component-CR1ULadR.js";
 import { Immutable } from "./types-yh4pOGEm.js";
 import { EntityEventUid, IEntityEvent, IEntityRepository, IEntitySnapshot, IEntityUpdate, IEventData } from "./index-C3UGZqUG.js";
-import { IMiddleware, IPipeline, IPipelineContext, PipelineResult } from "./index-Cm-YSPhK.js";
+import { IMiddleware, IPipeline, IPipelineContext, PipelineResult, PipelineRuntime } from "./index-Cm-YSPhK.js";
 import { IJsonSerializer, ILogger } from "./index-oenqxDCa.js";
 
 //#region src/systems/module/system-type.d.ts
@@ -15,22 +15,22 @@ declare enum SystemType {
    * The initialization phase of the Module pipeline.
    * This phase is typically used for setting up initial state and resources.
    */
-  initialize = "initialize",
+  initialize = 0,
   /**
    * The update phase of the Module pipeline.
    * This phase is responsible for updating the game logic and state of entities.
    */
-  update = "update",
+  update = 1,
   /**
    * The render phase of the Module pipeline.
    * This phase is used for rendering the game to the screen.
    */
-  render = "render",
+  render = 2,
   /**
    * The synchronization phase of the Module pipeline.
    * This phase is used for synchronizing game state with external systems or other components.
    */
-  sync = "sync",
+  sync = 3,
 }
 //#endregion
 //#region src/systems/pipeline/system-context-events.d.ts
@@ -242,6 +242,9 @@ interface ISystemContextSnapshot {
 }
 //#endregion
 //#region src/systems/pipeline/system-context.d.ts
+type SystemRuntime = PipelineRuntime & {
+  enabledSteps: ReadonlySet<SystemType>;
+};
 /**
  * The ISystemContext is the Context passed to a SystemMiddleware as part of the Pipeline Dispatch.
  * It's an abstraction layer so that the Middleware code won't have explicit dependencies on other parts of the ECS.
@@ -288,6 +291,10 @@ interface ISystemContext<TEntity extends IEntity> extends IPipelineContext {
    * The logger API for the SystemMiddleware to log messages.
    */
   readonly logger: Immutable<ILogger>;
+  /**
+   * The runtime API for the SystemMiddleware to interact with the ECS runtime system.
+   */
+  readonly runtime: SystemRuntime;
 }
 //#endregion
 //#region src/systems/pipeline/system-context-entity.d.ts
@@ -325,9 +332,9 @@ interface ISystemContextEntity {
  */
 interface ISystemsRuntimeContext<TEntity extends IEntity> extends IPipelineContext {
   /**
-   * A Set of allowed steps for the SystemPipelines.
+   * A Set of enabled steps for the SystemPipelines.
    */
-  readonly allowedSteps: Set<SystemType>;
+  readonly enabledSteps: Set<SystemType>;
   /**
    * An entity provider for the SystemPipelines.
    */
@@ -372,7 +379,6 @@ type ISystemMiddleware<TEntity extends IEntity> = IMiddleware<ISystemContext<TEn
  * It can be used as building blocks for SystemsModules as a way to register common SystemMiddlewares and share across different Entities.
  */
 interface ISystemsModuleDefinition<TEntity extends IEntity> {
-  readonly systems: Map<SystemType, IPipeline<ISystemContext<TEntity>>>;
   /**
    * Registers SystemMiddlewares to the specified SystemPipelineType.
    *
@@ -382,10 +388,16 @@ interface ISystemsModuleDefinition<TEntity extends IEntity> {
    */
   registerSystems?(type: SystemType, systems: Immutable<ISystemMiddleware<TEntity>[]>): void;
   /**
-   * Registers the middleware of the provided SystemsModule in the current SystemsModule. Keeps the same system types.
+   * Registers the middleware of the provided SystemsModule in the current SystemsModule.
+   * Keeps the same system types and order.
+   * Systems will be appended to the current SystemsModule steps.
+   *
+   * Use multiple calls to `registerModule` using the `type` parameter to register only a step of the SystemsModule.
+   *
    * @param module - The SystemsModule to be registered.
+   * @template TModuleEntity - The entity type that the module works on.
    */
-  registerModule?(module: Immutable<ISystemsModuleDefinition<TEntity>>): void;
+  registerModule?<TModuleEntity extends IEntity>(module: TEntity extends TModuleEntity ? Immutable<ISystemsModuleDefinition<TModuleEntity>> : TModuleEntity, type?: SystemType): void;
 }
 //#endregion
 //#region src/systems/module/systems-module.d.ts
@@ -456,5 +468,5 @@ interface ISystemsRuntime {
   runTick(update?: IEntityUpdate): PipelineResult;
 }
 //#endregion
-export { ISystemContext, ISystemContextEntity, ISystemContextEvents, ISystemContextProxies, ISystemContextRepository, ISystemContextScheduler, ISystemContextSnapshot, ISystemMiddleware, ISystemsModule, ISystemsModuleDefinition, ISystemsModuleRepository, ISystemsRuntime, ISystemsRuntimeContext, ISystemsRuntimeMiddleware, SystemType };
-//# sourceMappingURL=index-zpj0YApu.d.ts.map
+export { ISystemContext, ISystemContextEntity, ISystemContextEvents, ISystemContextProxies, ISystemContextRepository, ISystemContextScheduler, ISystemContextSnapshot, ISystemMiddleware, ISystemsModule, ISystemsModuleDefinition, ISystemsModuleRepository, ISystemsRuntime, ISystemsRuntimeContext, ISystemsRuntimeMiddleware, SystemRuntime, SystemType };
+//# sourceMappingURL=index-CH8ucsKZ.d.ts.map

package/dist/{index-CKh4A7mH.d.cts → index-CjNeb3ML.d.cts}

@@ -1,7 +1,7 @@
 import { EntityProxy, EntityTypeUid, IEntity, IEntityModel, IEntityProxy } from "./identity-component-BDWEtAXA.cjs";
 import { Immutable } from "./types-DvzdpbLu.cjs";
 import { EntityEventUid, IEntityEvent, IEntityRepository, IEntitySnapshot, IEntityUpdate, IEventData } from "./index-DLm-DKAk.cjs";
-import { IMiddleware, IPipeline, IPipelineContext, PipelineResult } from "./index-D81Fo9XN.cjs";
+import { IMiddleware, IPipeline, IPipelineContext, PipelineResult, PipelineRuntime } from "./index-D81Fo9XN.cjs";
 import { IJsonSerializer, ILogger } from "./index-ChV4Q5j6.cjs";
 
 //#region src/systems/module/system-type.d.ts
@@ -15,22 +15,22 @@ declare enum SystemType {
    * The initialization phase of the Module pipeline.
    * This phase is typically used for setting up initial state and resources.
    */
-  initialize = "initialize",
+  initialize = 0,
   /**
    * The update phase of the Module pipeline.
    * This phase is responsible for updating the game logic and state of entities.
    */
-  update = "update",
+  update = 1,
   /**
    * The render phase of the Module pipeline.
    * This phase is used for rendering the game to the screen.
    */
-  render = "render",
+  render = 2,
   /**
    * The synchronization phase of the Module pipeline.
    * This phase is used for synchronizing game state with external systems or other components.
    */
-  sync = "sync",
+  sync = 3,
 }
 //#endregion
 //#region src/systems/pipeline/system-context-events.d.ts
@@ -242,6 +242,9 @@ interface ISystemContextSnapshot {
 }
 //#endregion
 //#region src/systems/pipeline/system-context.d.ts
+type SystemRuntime = PipelineRuntime & {
+  enabledSteps: ReadonlySet<SystemType>;
+};
 /**
  * The ISystemContext is the Context passed to a SystemMiddleware as part of the Pipeline Dispatch.
  * It's an abstraction layer so that the Middleware code won't have explicit dependencies on other parts of the ECS.
@@ -288,6 +291,10 @@ interface ISystemContext<TEntity extends IEntity> extends IPipelineContext {
    * The logger API for the SystemMiddleware to log messages.
    */
   readonly logger: Immutable<ILogger>;
+  /**
+   * The runtime API for the SystemMiddleware to interact with the ECS runtime system.
+   */
+  readonly runtime: SystemRuntime;
 }
 //#endregion
 //#region src/systems/pipeline/system-context-entity.d.ts
@@ -325,9 +332,9 @@ interface ISystemContextEntity {
  */
 interface ISystemsRuntimeContext<TEntity extends IEntity> extends IPipelineContext {
   /**
-   * A Set of allowed steps for the SystemPipelines.
+   * A Set of enabled steps for the SystemPipelines.
    */
-  readonly allowedSteps: Set<SystemType>;
+  readonly enabledSteps: Set<SystemType>;
   /**
    * An entity provider for the SystemPipelines.
    */
@@ -372,7 +379,6 @@ type ISystemMiddleware<TEntity extends IEntity> = IMiddleware<ISystemContext<TEn
  * It can be used as building blocks for SystemsModules as a way to register common SystemMiddlewares and share across different Entities.
  */
 interface ISystemsModuleDefinition<TEntity extends IEntity> {
-  readonly systems: Map<SystemType, IPipeline<ISystemContext<TEntity>>>;
   /**
    * Registers SystemMiddlewares to the specified SystemPipelineType.
    *
@@ -382,10 +388,16 @@ interface ISystemsModuleDefinition<TEntity extends IEntity> {
    */
   registerSystems?(type: SystemType, systems: Immutable<ISystemMiddleware<TEntity>[]>): void;
   /**
-   * Registers the middleware of the provided SystemsModule in the current SystemsModule. Keeps the same system types.
+   * Registers the middleware of the provided SystemsModule in the current SystemsModule.
+   * Keeps the same system types and order.
+   * Systems will be appended to the current SystemsModule steps.
+   *
+   * Use multiple calls to `registerModule` using the `type` parameter to register only a step of the SystemsModule.
+   *
    * @param module - The SystemsModule to be registered.
+   * @template TModuleEntity - The entity type that the module works on.
    */
-  registerModule?(module: Immutable<ISystemsModuleDefinition<TEntity>>): void;
+  registerModule?<TModuleEntity extends IEntity>(module: TEntity extends TModuleEntity ? Immutable<ISystemsModuleDefinition<TModuleEntity>> : TModuleEntity, type?: SystemType): void;
 }
 //#endregion
 //#region src/systems/module/systems-module.d.ts
@@ -456,5 +468,5 @@ interface ISystemsRuntime {
   runTick(update?: IEntityUpdate): PipelineResult;
 }
 //#endregion
-export { ISystemContext, ISystemContextEntity, ISystemContextEvents, ISystemContextProxies, ISystemContextRepository, ISystemContextScheduler, ISystemContextSnapshot, ISystemMiddleware, ISystemsModule, ISystemsModuleDefinition, ISystemsModuleRepository, ISystemsRuntime, ISystemsRuntimeContext, ISystemsRuntimeMiddleware, SystemType };
-//# sourceMappingURL=index-CKh4A7mH.d.cts.map
+export { ISystemContext, ISystemContextEntity, ISystemContextEvents, ISystemContextProxies, ISystemContextRepository, ISystemContextScheduler, ISystemContextSnapshot, ISystemMiddleware, ISystemsModule, ISystemsModuleDefinition, ISystemsModuleRepository, ISystemsRuntime, ISystemsRuntimeContext, ISystemsRuntimeMiddleware, SystemRuntime, SystemType };
+//# sourceMappingURL=index-CjNeb3ML.d.cts.map

package/dist/systems/index.cjs

@@ -10,22 +10,22 @@ let SystemType = /* @__PURE__ */ function(SystemType$1) {
 	* The initialization phase of the Module pipeline.
 	* This phase is typically used for setting up initial state and resources.
 	*/
-	SystemType$1["initialize"] = "initialize";
+	SystemType$1[SystemType$1["initialize"] = 0] = "initialize";
 	/**
 	* The update phase of the Module pipeline.
 	* This phase is responsible for updating the game logic and state of entities.
 	*/
-	SystemType$1["update"] = "update";
+	SystemType$1[SystemType$1["update"] = 1] = "update";
 	/**
 	* The render phase of the Module pipeline.
 	* This phase is used for rendering the game to the screen.
 	*/
-	SystemType$1["render"] = "render";
+	SystemType$1[SystemType$1["render"] = 2] = "render";
 	/**
 	* The synchronization phase of the Module pipeline.
 	* This phase is used for synchronizing game state with external systems or other components.
 	*/
-	SystemType$1["sync"] = "sync";
+	SystemType$1[SystemType$1["sync"] = 3] = "sync";
 	return SystemType$1;
 }({});
 

package/dist/systems/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","names":[],"sources":["../../src/systems/module/system-type.ts"],"sourcesContent":["/**\n * Enum representing the built-in System pipeline types.\n * These types can be extended to introduce more types, and the System Runtime Pipeline should\n * add Middleware to handle the newly added types.\n */\nexport enum SystemType {\n  /**\n   * The initialization phase of the Module pipeline.\n   * This phase is typically used for setting up initial state and resources.\n   */\n  initialize = 'initialize',\n\n  /**\n   * The update phase of the Module pipeline.\n   * This phase is responsible for updating the game logic and state of entities.\n   */\n  update = 'update',\n\n  /**\n   * The render phase of the Module pipeline.\n   * This phase is used for rendering the game to the screen.\n   */\n  render = 'render',\n\n  /**\n   * The synchronization phase of the Module pipeline.\n   * This phase is used for synchronizing game state with external systems or other components.\n   */\n  sync = 'sync'\n}\n"],"mappings":";;;;;;;AAKA,IAAY,oDAAL;;;;;AAKL;;;;;AAMA;;;;;AAMA;;;;;AAMA;;AACD"}
+{"version":3,"file":"index.cjs","names":[],"sources":["../../src/systems/module/system-type.ts"],"sourcesContent":["/**\n * Enum representing the built-in System pipeline types.\n * These types can be extended to introduce more types, and the System Runtime Pipeline should\n * add Middleware to handle the newly added types.\n */\nexport enum SystemType {\n  /**\n   * The initialization phase of the Module pipeline.\n   * This phase is typically used for setting up initial state and resources.\n   */\n  initialize = 0,\n\n  /**\n   * The update phase of the Module pipeline.\n   * This phase is responsible for updating the game logic and state of entities.\n   */\n  update = 1,\n\n  /**\n   * The render phase of the Module pipeline.\n   * This phase is used for rendering the game to the screen.\n   */\n  render = 2,\n\n  /**\n   * The synchronization phase of the Module pipeline.\n   * This phase is used for synchronizing game state with external systems or other components.\n   */\n  sync = 3\n}\n"],"mappings":";;;;;;;AAKA,IAAY,oDAAL;;;;;AAKL;;;;;AAMA;;;;;AAMA;;;;;AAMA;;AACD"}

package/dist/systems/index.d.cts

@@ -3,5 +3,5 @@ import "../types-DvzdpbLu.cjs";
 import "../index-DLm-DKAk.cjs";
 import "../index-D81Fo9XN.cjs";
 import "../index-ChV4Q5j6.cjs";
-import { ISystemContext, ISystemContextEntity, ISystemContextEvents, ISystemContextProxies, ISystemContextRepository, ISystemContextScheduler, ISystemContextSnapshot, ISystemMiddleware, ISystemsModule, ISystemsModuleDefinition, ISystemsModuleRepository, ISystemsRuntime, ISystemsRuntimeContext, ISystemsRuntimeMiddleware, SystemType } from "../index-CKh4A7mH.cjs";
-export { ISystemContext, ISystemContextEntity, ISystemContextEvents, ISystemContextProxies, ISystemContextRepository, ISystemContextScheduler, ISystemContextSnapshot, ISystemMiddleware, ISystemsModule, ISystemsModuleDefinition, ISystemsModuleRepository, ISystemsRuntime, ISystemsRuntimeContext, ISystemsRuntimeMiddleware, SystemType };
+import { ISystemContext, ISystemContextEntity, ISystemContextEvents, ISystemContextProxies, ISystemContextRepository, ISystemContextScheduler, ISystemContextSnapshot, ISystemMiddleware, ISystemsModule, ISystemsModuleDefinition, ISystemsModuleRepository, ISystemsRuntime, ISystemsRuntimeContext, ISystemsRuntimeMiddleware, SystemRuntime, SystemType } from "../index-CjNeb3ML.cjs";
+export { ISystemContext, ISystemContextEntity, ISystemContextEvents, ISystemContextProxies, ISystemContextRepository, ISystemContextScheduler, ISystemContextSnapshot, ISystemMiddleware, ISystemsModule, ISystemsModuleDefinition, ISystemsModuleRepository, ISystemsRuntime, ISystemsRuntimeContext, ISystemsRuntimeMiddleware, SystemRuntime, SystemType };

package/dist/systems/index.d.ts

@@ -3,5 +3,5 @@ import "../types-yh4pOGEm.js";
 import "../index-C3UGZqUG.js";
 import "../index-Cm-YSPhK.js";
 import "../index-oenqxDCa.js";
-import { ISystemContext, ISystemContextEntity, ISystemContextEvents, ISystemContextProxies, ISystemContextRepository, ISystemContextScheduler, ISystemContextSnapshot, ISystemMiddleware, ISystemsModule, ISystemsModuleDefinition, ISystemsModuleRepository, ISystemsRuntime, ISystemsRuntimeContext, ISystemsRuntimeMiddleware, SystemType } from "../index-zpj0YApu.js";
-export { ISystemContext, ISystemContextEntity, ISystemContextEvents, ISystemContextProxies, ISystemContextRepository, ISystemContextScheduler, ISystemContextSnapshot, ISystemMiddleware, ISystemsModule, ISystemsModuleDefinition, ISystemsModuleRepository, ISystemsRuntime, ISystemsRuntimeContext, ISystemsRuntimeMiddleware, SystemType };
+import { ISystemContext, ISystemContextEntity, ISystemContextEvents, ISystemContextProxies, ISystemContextRepository, ISystemContextScheduler, ISystemContextSnapshot, ISystemMiddleware, ISystemsModule, ISystemsModuleDefinition, ISystemsModuleRepository, ISystemsRuntime, ISystemsRuntimeContext, ISystemsRuntimeMiddleware, SystemRuntime, SystemType } from "../index-CH8ucsKZ.js";
+export { ISystemContext, ISystemContextEntity, ISystemContextEvents, ISystemContextProxies, ISystemContextRepository, ISystemContextScheduler, ISystemContextSnapshot, ISystemMiddleware, ISystemsModule, ISystemsModuleDefinition, ISystemsModuleRepository, ISystemsRuntime, ISystemsRuntimeContext, ISystemsRuntimeMiddleware, SystemRuntime, SystemType };

package/dist/systems/index.js

@@ -9,22 +9,22 @@ let SystemType = /* @__PURE__ */ function(SystemType$1) {
 	* The initialization phase of the Module pipeline.
 	* This phase is typically used for setting up initial state and resources.
 	*/
-	SystemType$1["initialize"] = "initialize";
+	SystemType$1[SystemType$1["initialize"] = 0] = "initialize";
 	/**
 	* The update phase of the Module pipeline.
 	* This phase is responsible for updating the game logic and state of entities.
 	*/
-	SystemType$1["update"] = "update";
+	SystemType$1[SystemType$1["update"] = 1] = "update";
 	/**
 	* The render phase of the Module pipeline.
 	* This phase is used for rendering the game to the screen.
 	*/
-	SystemType$1["render"] = "render";
+	SystemType$1[SystemType$1["render"] = 2] = "render";
 	/**
 	* The synchronization phase of the Module pipeline.
 	* This phase is used for synchronizing game state with external systems or other components.
 	*/
-	SystemType$1["sync"] = "sync";
+	SystemType$1[SystemType$1["sync"] = 3] = "sync";
 	return SystemType$1;
 }({});
 

package/dist/systems/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../../src/systems/module/system-type.ts"],"sourcesContent":["/**\n * Enum representing the built-in System pipeline types.\n * These types can be extended to introduce more types, and the System Runtime Pipeline should\n * add Middleware to handle the newly added types.\n */\nexport enum SystemType {\n  /**\n   * The initialization phase of the Module pipeline.\n   * This phase is typically used for setting up initial state and resources.\n   */\n  initialize = 'initialize',\n\n  /**\n   * The update phase of the Module pipeline.\n   * This phase is responsible for updating the game logic and state of entities.\n   */\n  update = 'update',\n\n  /**\n   * The render phase of the Module pipeline.\n   * This phase is used for rendering the game to the screen.\n   */\n  render = 'render',\n\n  /**\n   * The synchronization phase of the Module pipeline.\n   * This phase is used for synchronizing game state with external systems or other components.\n   */\n  sync = 'sync'\n}\n"],"mappings":";;;;;;AAKA,IAAY,oDAAL;;;;;AAKL;;;;;AAMA;;;;;AAMA;;;;;AAMA;;AACD"}
+{"version":3,"file":"index.js","names":[],"sources":["../../src/systems/module/system-type.ts"],"sourcesContent":["/**\n * Enum representing the built-in System pipeline types.\n * These types can be extended to introduce more types, and the System Runtime Pipeline should\n * add Middleware to handle the newly added types.\n */\nexport enum SystemType {\n  /**\n   * The initialization phase of the Module pipeline.\n   * This phase is typically used for setting up initial state and resources.\n   */\n  initialize = 0,\n\n  /**\n   * The update phase of the Module pipeline.\n   * This phase is responsible for updating the game logic and state of entities.\n   */\n  update = 1,\n\n  /**\n   * The render phase of the Module pipeline.\n   * This phase is used for rendering the game to the screen.\n   */\n  render = 2,\n\n  /**\n   * The synchronization phase of the Module pipeline.\n   * This phase is used for synchronizing game state with external systems or other components.\n   */\n  sync = 3\n}\n"],"mappings":";;;;;;AAKA,IAAY,oDAAL;;;;;AAKL;;;;;AAMA;;;;;AAMA;;;;;AAMA;;AACD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@awesome-ecs/abstract",
-  "version": "0.21.1",
+  "version": "0.22.0",
   "description": "A comprehensive Entity-Component-System (ECS) Architecture implementation. Abstract components.",
   "type": "module",
   "scripts": {
@@ -97,5 +97,5 @@
     "url": "https://github.com/privatebytes/awesome-ecs/issues"
   },
   "homepage": "https://github.com/privatebytes/awesome-ecs#readme",
-  "gitHead": "bff600ad3987cfdf6a2a81122069a137efa50085"
+  "gitHead": "9e875e10e5191853fb48c20b3ebb3eafc8c002b1"
 }