@awesome-ecs/abstract 0.7.0 → 0.8.2

package/dist/components/identity-component.d.ts

@@ -16,4 +16,8 @@ export interface IdentityComponent<TModel extends IEntityModel> extends ICompone
      * It provides a first snapshot of information needed for the successful creation of an Entity instance.
      */
     readonly model: TModel;
+    /**
+     * Keeps track when it was the last time the Entity's systems have ran. Useful to calculate the DeltaTime between runs.
+     */
+    readonly lastUpdated: Date;
 }

package/dist/entities/entity-repository.d.ts

@@ -1,24 +1,15 @@
-import { EntityUid, EntityTypeUid, IEntity } from "./entity";
-/**
- * The Entity Repository internal structure. Holds the Entity as well as LastUpdate time.
- */
-export interface StoredEntity<TEntity extends IEntity> {
-    entity: TEntity;
-    lastUpdate: Date;
-}
+import { EntityTypeUid, IEntity } from "./entity";
+import { IEntityProxy } from "./entity-proxy";
 /**
  * The Entity Repository is the main storage for keeping track of existing Entities.
  * It provides basic CRUD functionality.
  */
 export interface IEntityRepository {
-    has(type: EntityTypeUid, uid: EntityUid): boolean;
-    get<TEntity extends IEntity>(type: EntityTypeUid, uid: EntityUid): TEntity;
-    getWithTime<TEntity extends IEntity>(type: EntityTypeUid, uid: EntityUid): StoredEntity<TEntity>;
-    getAll<TEntity extends IEntity>(type: EntityTypeUid): TEntity[];
-    listAll(): StoredEntity<IEntity>[];
+    has(proxy: IEntityProxy): boolean;
+    get<TEntity extends IEntity>(proxy: IEntityProxy): TEntity;
+    getAll<TEntity extends IEntity>(entityType: EntityTypeUid): TEntity[];
+    listAll(): IEntity[];
     set(entity: IEntity): void;
-    delete(type: EntityTypeUid, uid: EntityUid): void;
+    delete(proxy: IEntityProxy): void;
     clear(entityType: EntityTypeUid): void;
-    onEntitySetCallback?: (entity: IEntity) => void;
-    onEntityDeletedCallback?: (entity: IEntity) => void;
 }

package/dist/entities/entity.d.ts

@@ -4,14 +4,14 @@ import { IEntityProxy } from "./entity-proxy";
 export declare type EntityTypeUid = string | number;
 export declare type EntityUid = string | number;
 export interface IEntityModel {
-    uid: EntityUid;
+    readonly uid: EntityUid;
 }
 /**
  * An Entity is a container of Components and Entity Proxies. Only Systems can manipulate the internal state of the Entity.
  */
 export interface IEntity {
-    readonly components: Map<ComponentTypeUid, IComponent>;
+    readonly components: ReadonlyMap<ComponentTypeUid, IComponent>;
     readonly proxies: Map<EntityTypeUid, Map<EntityUid, IEntityProxy>>;
-    readonly identity: IdentityComponent<IEntityModel>;
-    readonly myProxy: IEntityProxy;
+    readonly identity: Readonly<IdentityComponent<IEntityModel>>;
+    readonly myProxy: Readonly<IEntityProxy>;
 }

package/dist/factories/context-factory.d.ts

@@ -0,0 +1,9 @@
+import { IEntity } from "../entities/entity";
+import { ISystemPipelineContext } from "../systems/system-pipeline-context";
+/**
+ * The IContextFactory can be used as an abstraction layer to quickly create SystemPipelineContext objects,
+ * without having to manually resolve all of their dependencies.
+ */
+export interface IContextFactory {
+    createPipelineContext<TEntity extends IEntity>(entity: TEntity): ISystemPipelineContext<TEntity>;
+}

package/dist/{systems/system-middleware.js → factories/context-factory.js}

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=system-middleware.js.map
+//# sourceMappingURL=context-factory.js.map

package/dist/factories/context-factory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context-factory.js","sourceRoot":"","sources":["../../src/factories/context-factory.ts"],"names":[],"mappings":""}

package/dist/factories/pipeline-factory.d.ts

@@ -0,0 +1,11 @@
+import { IPipeline } from "../pipelines/pipeline";
+import { PipelineType } from "../pipelines/pipeline-type";
+/**
+ * The PipelineFactory can be used as an abstraction layer to quickly create IPipeline objects,
+ * without having to manually resolve all of their dependencies.
+ */
+export interface IPipelineFactory {
+    createPipeline<TContext>(type: PipelineType): IPipeline<TContext>;
+    createAsyncPipeline<TContext>(): IPipeline<TContext>;
+    createSyncPipeline<TContext>(): IPipeline<TContext>;
+}

package/dist/factories/pipeline-factory.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=pipeline-factory.js.map

package/dist/factories/pipeline-factory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pipeline-factory.js","sourceRoot":"","sources":["../../src/factories/pipeline-factory.ts"],"names":[],"mappings":""}

package/dist/factories/runtime-factory.d.ts

@@ -0,0 +1,10 @@
+import { IEntity } from "../entities/entity";
+import { PipelineType } from "../pipelines/pipeline-type";
+import { IRuntimePipeline } from "../runtime/runtime-pipeline";
+/**
+ * The RuntimeFactory can be used as an abstraction layer to quickly create IRuntimePipeline objects,
+ * without having to manually resolve all of their dependencies.
+ */
+export interface IRuntimeFactory {
+    createRuntimePipeline<TEntity extends IEntity>(type: PipelineType): IRuntimePipeline<TEntity>;
+}

package/dist/factories/runtime-factory.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=runtime-factory.js.map

package/dist/factories/runtime-factory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runtime-factory.js","sourceRoot":"","sources":["../../src/factories/runtime-factory.ts"],"names":[],"mappings":""}

package/dist/index.d.ts

@@ -6,11 +6,27 @@ export * from './entities/entity-proxy';
 export * from './entities/entity-queue';
 export * from './entities/entity-repository';
 export * from './entities/entity-scheduler';
+export * from './factories/context-factory';
+export * from './factories/pipeline-factory';
+export * from './factories/runtime-factory';
+export * from './runtime/runtime-pipeline';
+export * from './runtime/runtime-result';
+export * from './runtime/runtime-status';
 export * from './pipelines/middleware';
+export * from './pipelines/middleware-result';
+export * from './pipelines/middleware-stop';
 export * from './pipelines/pipeline';
-export * from './systems/system-middleware';
-export * from './systems/systems-module';
+export * from './pipelines/pipeline-type';
+export * from './systems/context/system-context-events';
+export * from './systems/context/system-context-proxies';
+export * from './systems/context/system-context-repository';
+export * from './systems/context/system-context-scheduler';
+export * from './systems/runtime/systems-runtime-context';
+export * from './systems/runtime/systems-runtime-middleware';
+export * from './systems/system-pipeline-middleware';
 export * from './systems/system-pipeline-context';
 export * from './systems/system-pipeline-type';
+export * from './systems/systems-module';
 export * from './systems/systems-runtime';
 export * from './utils/performance-timer';
+export * from './utils/types';

package/dist/index.js

@@ -22,12 +22,28 @@ __exportStar(require("./entities/entity-proxy"), exports);
 __exportStar(require("./entities/entity-queue"), exports);
 __exportStar(require("./entities/entity-repository"), exports);
 __exportStar(require("./entities/entity-scheduler"), exports);
+__exportStar(require("./factories/context-factory"), exports);
+__exportStar(require("./factories/pipeline-factory"), exports);
+__exportStar(require("./factories/runtime-factory"), exports);
+__exportStar(require("./runtime/runtime-pipeline"), exports);
+__exportStar(require("./runtime/runtime-result"), exports);
+__exportStar(require("./runtime/runtime-status"), exports);
 __exportStar(require("./pipelines/middleware"), exports);
+__exportStar(require("./pipelines/middleware-result"), exports);
+__exportStar(require("./pipelines/middleware-stop"), exports);
 __exportStar(require("./pipelines/pipeline"), exports);
-__exportStar(require("./systems/system-middleware"), exports);
-__exportStar(require("./systems/systems-module"), exports);
+__exportStar(require("./pipelines/pipeline-type"), exports);
+__exportStar(require("./systems/context/system-context-events"), exports);
+__exportStar(require("./systems/context/system-context-proxies"), exports);
+__exportStar(require("./systems/context/system-context-repository"), exports);
+__exportStar(require("./systems/context/system-context-scheduler"), exports);
+__exportStar(require("./systems/runtime/systems-runtime-context"), exports);
+__exportStar(require("./systems/runtime/systems-runtime-middleware"), exports);
+__exportStar(require("./systems/system-pipeline-middleware"), exports);
 __exportStar(require("./systems/system-pipeline-context"), exports);
 __exportStar(require("./systems/system-pipeline-type"), exports);
+__exportStar(require("./systems/systems-module"), exports);
 __exportStar(require("./systems/systems-runtime"), exports);
 __exportStar(require("./utils/performance-timer"), exports);
+__exportStar(require("./utils/types"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yDAAsC;AACtC,kEAA+C;AAE/C,oDAAiC;AACjC,2DAAwC;AACxC,0DAAuC;AACvC,0DAAuC;AACvC,+DAA4C;AAC5C,8DAA2C;AAE3C,yDAAsC;AACtC,uDAAoC;AAEpC,8DAA2C;AAC3C,2DAAwC;AACxC,oEAAiD;AACjD,iEAA8C;AAC9C,4DAAyC;AAEzC,4DAAyC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yDAAsC;AACtC,kEAA+C;AAE/C,oDAAiC;AACjC,2DAAwC;AACxC,0DAAuC;AACvC,0DAAuC;AACvC,+DAA4C;AAC5C,8DAA2C;AAE3C,8DAA2C;AAC3C,+DAA4C;AAC5C,8DAA2C;AAE3C,6DAA0C;AAC1C,2DAAwC;AACxC,2DAAwC;AAExC,yDAAsC;AACtC,gEAA6C;AAC7C,8DAA2C;AAC3C,uDAAoC;AACpC,4DAAyC;AAEzC,0EAAuD;AACvD,2EAAwD;AACxD,8EAA2D;AAC3D,6EAA0D;AAE1D,4EAAyD;AACzD,+EAA4D;AAE5D,uEAAoD;AACpD,oEAAiD;AACjD,iEAA8C;AAC9C,2DAAwC;AACxC,4DAAyC;AAEzC,4DAAyC;AACzC,gDAA6B"}

package/dist/pipelines/middleware-result.d.ts

@@ -0,0 +1,5 @@
+import { IRuntimeResult } from "../runtime/runtime-result";
+/**
+ * The Middleware could potentially run another Pipeline inside, and so we can propagate that result.
+ */
+export declare type MiddlewareResult = void | IRuntimeResult;

package/dist/pipelines/middleware-result.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=middleware-result.js.map

package/dist/pipelines/middleware-result.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"middleware-result.js","sourceRoot":"","sources":["../../src/pipelines/middleware-result.ts"],"names":[],"mappings":""}

package/dist/pipelines/middleware-stop.d.ts

@@ -0,0 +1,4 @@
+/**
+ * 'Stop' function, passed to a middleware. Call it to break the pipeline execution.
+ */
+export declare type Stop = () => void;

package/dist/pipelines/middleware-stop.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=middleware-stop.js.map

package/dist/pipelines/middleware-stop.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"middleware-stop.js","sourceRoot":"","sources":["../../src/pipelines/middleware-stop.ts"],"names":[],"mappings":""}

package/dist/pipelines/middleware.d.ts

@@ -1,11 +1,9 @@
-/**
- * 'Stop' function, passed to a middleware. Call it to break the pipeline execution.
- */
-export declare type Stop = () => void;
+import { Stop } from "./middleware-stop";
+import { MiddlewareResult } from "./middleware-result";
 /**
  * A middleware, the building block of a Pipeline. The middlewares will get called in the same order they get registered in the Pipeline.
  */
-export interface IMiddleware<TContext> {
+export interface IMiddleware<TContext, TResult = MiddlewareResult> {
     /**
      * This (optional) function gets called before executing the middleware. It acts as a boolean gateway whether enough conditions are
      * being met so this middleware's action should run.
@@ -17,10 +15,10 @@ export interface IMiddleware<TContext> {
      * @param context The Context can be read or updated. The Context holds all the state necessary for the execution of the middleware.
      * @param stop The function to halt the execution of the Pipeline. The next Middlewares won't be called anymore.
      */
-    action(context: TContext, stop: Stop): Promise<void> | void;
+    action(context: TContext, stop: Stop): Promise<TResult> | TResult;
     /**
      * This (optional) function gets called when the cleanup of the Pipeline is necessary, based on reverse order of Middleware registration.
      * @param context Part of the Context should be cleaned, and any allocated resources in the Action, should be disposed.
      */
-    cleanup?(context: TContext): Promise<void> | void;
+    cleanup?(context: TContext): Promise<TResult> | TResult;
 }

package/dist/pipelines/pipeline-type.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Specify how the runtime of the Pipeline should be handled.
+ */
+export declare enum PipelineType {
+    sync = 0,
+    async = 1
+}

package/dist/pipelines/pipeline-type.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PipelineType = void 0;
+/**
+ * Specify how the runtime of the Pipeline should be handled.
+ */
+var PipelineType;
+(function (PipelineType) {
+    PipelineType[PipelineType["sync"] = 0] = "sync";
+    PipelineType[PipelineType["async"] = 1] = "async";
+})(PipelineType = exports.PipelineType || (exports.PipelineType = {}));
+//# sourceMappingURL=pipeline-type.js.map

package/dist/pipelines/pipeline-type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pipeline-type.js","sourceRoot":"","sources":["../../src/pipelines/pipeline-type.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,IAAY,YAGX;AAHD,WAAY,YAAY;IACtB,+CAAI,CAAA;IACJ,iDAAK,CAAA;AACP,CAAC,EAHW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAGvB"}

package/dist/pipelines/pipeline.d.ts

@@ -1,27 +1,22 @@
-import { PerformanceTimeEntry } from "../utils/performance-timer";
+import { IRuntimeResult } from "../runtime/runtime-result";
 import { IMiddleware } from "./middleware";
-export declare enum PipelineStatus {
-    completed = 0,
-    halted = 1
-}
-export interface IPipelineResult {
-    readonly status: PipelineStatus;
-    readonly metrics: PerformanceTimeEntry[];
-}
+import { MiddlewareResult } from "./middleware-result";
+import { PipelineType } from "./pipeline-type";
 /**
  * A middleware container and dispatcher.
  */
-export interface IPipeline<TContext> {
+export interface IPipeline<TContext, TMiddlewareResult = MiddlewareResult> {
+    readonly type: PipelineType;
     /**
      * Register middlewares for this pipeline, in order.
      */
-    use(...middleware: IMiddleware<TContext>[]): void;
+    use(...middleware: IMiddleware<TContext, TMiddlewareResult>[]): void;
     /**
      * Execute the chain of middlewares, in the order they were added on a given Context.
      */
-    dispatch(context: TContext): IPipelineResult | Promise<IPipelineResult>;
+    dispatch(context: TContext): IRuntimeResult<TMiddlewareResult> | Promise<IRuntimeResult<TMiddlewareResult>>;
     /**
      * Runs the Cleanup function on all middlewares.
      */
-    cleanup(context: TContext): IPipelineResult | Promise<IPipelineResult>;
+    cleanup(context: TContext): IRuntimeResult<TMiddlewareResult> | Promise<IRuntimeResult<TMiddlewareResult>>;
 }

package/dist/pipelines/pipeline.js

@@ -1,9 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PipelineStatus = void 0;
-var PipelineStatus;
-(function (PipelineStatus) {
-    PipelineStatus[PipelineStatus["completed"] = 0] = "completed";
-    PipelineStatus[PipelineStatus["halted"] = 1] = "halted";
-})(PipelineStatus = exports.PipelineStatus || (exports.PipelineStatus = {}));
 //# sourceMappingURL=pipeline.js.map

package/dist/pipelines/pipeline.js.map

@@ -1 +1 @@
-{"version":3,"file":"pipeline.js","sourceRoot":"","sources":["../../src/pipelines/pipeline.ts"],"names":[],"mappings":";;;AAGA,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,6DAAS,CAAA;IACT,uDAAM,CAAA;AACR,CAAC,EAHW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAGzB"}
+{"version":3,"file":"pipeline.js","sourceRoot":"","sources":["../../src/pipelines/pipeline.ts"],"names":[],"mappings":""}

package/dist/runtime/runtime-pipeline.d.ts

@@ -0,0 +1,11 @@
+import { IEntity } from "../entities/entity";
+import { ISystemsRuntimeContext } from "../systems/runtime/systems-runtime-context";
+import { IRuntimeResult } from "./runtime-result";
+/**
+ * The RuntimePipeline is the main way of orchestrating the steps taken on a System Tick.
+ * It should provide a way to make the runtime SYNC or ASYNC by setting the PipelineType flag.
+ */
+export interface IRuntimePipeline<TEntity extends IEntity> {
+    dispatch(context: ISystemsRuntimeContext<TEntity>): IRuntimeResult | Promise<IRuntimeResult>;
+    cleanup(context: ISystemsRuntimeContext<TEntity>): IRuntimeResult | Promise<IRuntimeResult>;
+}

package/dist/runtime/runtime-pipeline.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=runtime-pipeline.js.map

package/dist/runtime/runtime-pipeline.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runtime-pipeline.js","sourceRoot":"","sources":["../../src/runtime/runtime-pipeline.ts"],"names":[],"mappings":""}

package/dist/runtime/runtime-result.d.ts

@@ -0,0 +1,20 @@
+import { MiddlewareResult } from "../pipelines/middleware-result";
+import { RuntimeStatus } from "./runtime-status";
+import { PerformanceTimeEntry } from "../utils/performance-timer";
+/**
+ * The IRuntimeResult contains the RuntimeStatus of the completed runtime operation.
+ * Can provide Performance metrics collected from inner runtime calls.
+ */
+export interface IRuntimeResult<TMiddlewareResult = MiddlewareResult> {
+    readonly status: RuntimeStatus;
+    readonly performance?: IRuntimeResultPerformance<TMiddlewareResult>[];
+}
+/**
+ * The IRuntimeResultPerformance contains the PerformanceTimeEntry for the runtime operation.
+ * Can also contain a nested structure of Performance metrics that contain the metrics captured from
+ * inner runtime calls.
+ */
+export interface IRuntimeResultPerformance<TResult = MiddlewareResult> {
+    performance: PerformanceTimeEntry;
+    result?: TResult;
+}

package/dist/runtime/runtime-result.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=runtime-result.js.map

package/dist/runtime/runtime-result.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runtime-result.js","sourceRoot":"","sources":["../../src/runtime/runtime-result.ts"],"names":[],"mappings":""}

package/dist/runtime/runtime-status.d.ts

@@ -0,0 +1,7 @@
+/**
+ * The RuntimeStatus tells whether the Runtime components have ran to completion or not.
+ */
+export declare enum RuntimeStatus {
+    completed = "completed",
+    halted = "halted"
+}

package/dist/runtime/runtime-status.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RuntimeStatus = void 0;
+/**
+ * The RuntimeStatus tells whether the Runtime components have ran to completion or not.
+ */
+var RuntimeStatus;
+(function (RuntimeStatus) {
+    RuntimeStatus["completed"] = "completed";
+    RuntimeStatus["halted"] = "halted";
+})(RuntimeStatus = exports.RuntimeStatus || (exports.RuntimeStatus = {}));
+//# sourceMappingURL=runtime-status.js.map

package/dist/runtime/runtime-status.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runtime-status.js","sourceRoot":"","sources":["../../src/runtime/runtime-status.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,wCAAuB,CAAA;IACvB,kCAAiB,CAAA;AACnB,CAAC,EAHW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAGxB"}

package/dist/systems/context/system-context-events.d.ts

@@ -0,0 +1,19 @@
+import { EntityEventUid, IEntityEvent, IEventData } from "../../entities/entity-events";
+import { IEntityProxy } from "../../entities/entity-proxy";
+/**
+ * The ISystemContextEvents is the access point for Event related APIs.
+ * The access is made in a SystemMiddleware through the provided ISystemPipelineContext.
+ */
+export interface ISystemContextEvents {
+    dispatchEvent<TEventData extends IEventData>(data: TEventData, ...targets: IEntityProxy[]): void;
+    dispatchEvents<TEventData extends IEventData>(data: TEventData[], ...targets: IEntityProxy[]): void;
+    getEvent<TEventData extends IEventData>(uid: EntityEventUid): IEntityEvent<TEventData>;
+    listEvents<TEventData extends IEventData>(): IEntityEvent<TEventData>[];
+    hasEvent(uid?: EntityEventUid): boolean;
+    subscribeTo<TEventData extends IEventData>(uid: EntityEventUid, filter?: (event: IEntityEvent<TEventData>) => boolean): void;
+    unsubscribeFrom(uid: EntityEventUid): void;
+    clearSubscriptions(uid?: EntityEventUid): void;
+    setContextEvents(events: IEntityEvent<IEventData>[]): void;
+    setContextEvent(event: IEntityEvent<IEventData>): void;
+    clearContextEvents(): void;
+}

package/dist/systems/context/system-context-events.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=system-context-events.js.map

package/dist/systems/context/system-context-events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"system-context-events.js","sourceRoot":"","sources":["../../../src/systems/context/system-context-events.ts"],"names":[],"mappings":""}

package/dist/systems/context/system-context-proxies.d.ts

@@ -0,0 +1,12 @@
+import { EntityTypeUid } from "../../entities/entity";
+import { IEntityProxy } from "../../entities/entity-proxy";
+/**
+ * The ISystemContextProxies is the access point for EntityProxy related APIs.
+ * The access is made in a SystemMiddleware through the provided ISystemPipelineContext.
+ */
+export interface ISystemContextProxies {
+    registerProxy(proxy: IEntityProxy, cleanup?: boolean): void;
+    registerProxies(proxies: IEntityProxy[], cleanup?: boolean): void;
+    removeProxy(proxy: IEntityProxy): void;
+    removeProxies(proxyEntityType?: EntityTypeUid): void;
+}

package/dist/systems/context/system-context-proxies.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=system-context-proxies.js.map

package/dist/systems/context/system-context-proxies.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"system-context-proxies.js","sourceRoot":"","sources":["../../../src/systems/context/system-context-proxies.ts"],"names":[],"mappings":""}

package/dist/systems/context/system-context-repository.d.ts

@@ -0,0 +1,13 @@
+import { EntityTypeUid, IEntityModel, IEntity } from "../../entities/entity";
+import { IEntityEvent, IEventData } from "../../entities/entity-events";
+import { EntityProxy, IEntityProxy } from "../../entities/entity-proxy";
+/**
+ * The ISystemContextRepository is the access point for EntityRepository related APIs.
+ * The access is made in a SystemMiddleware through the provided ISystemPipelineContext.
+ */
+export interface ISystemContextRepository {
+    addEntity(entityType: EntityTypeUid, model: IEntityModel, events?: IEntityEvent<IEventData>[]): void;
+    getEntity<TEntity extends IEntity>(proxy: EntityProxy<TEntity>): TEntity;
+    updateEntity(target?: IEntityProxy): void;
+    removeEntity(target: IEntityProxy): void;
+}

package/dist/systems/context/system-context-repository.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=system-context-repository.js.map

package/dist/systems/context/system-context-repository.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"system-context-repository.js","sourceRoot":"","sources":["../../../src/systems/context/system-context-repository.ts"],"names":[],"mappings":""}

package/dist/systems/context/system-context-scheduler.d.ts

@@ -0,0 +1,9 @@
+import { IEntityProxy } from "../../entities/entity-proxy";
+/**
+ * The ISystemContextRepository is the access point for Scheduler related APIs.
+ * The access is made in a SystemMiddleware through the provided ISystemPipelineContext.
+ */
+export interface ISystemContextScheduler {
+    scheduleUpdateOnInterval(target?: IEntityProxy, intervalMs?: number): void;
+    clearUpdateOnInterval(target?: IEntityProxy): void;
+}

package/dist/systems/context/system-context-scheduler.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=system-context-scheduler.js.map

package/dist/systems/context/system-context-scheduler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"system-context-scheduler.js","sourceRoot":"","sources":["../../../src/systems/context/system-context-scheduler.ts"],"names":[],"mappings":""}

package/dist/systems/runtime/systems-runtime-context.d.ts

@@ -0,0 +1,18 @@
+import { IEntity } from "../../entities/entity";
+import { IEntityUpdate } from "../../entities/entity-queue";
+import { IEntityRepository } from "../../entities/entity-repository";
+import { IPipeline } from "../../pipelines/pipeline";
+import { ISystemPipelineContext } from "../system-pipeline-context";
+import { SystemPipelineType } from "../system-pipeline-type";
+/**
+ * The ISystemsRuntimeContext is the Context passed by a SystemsRuntimePipeline.
+ * It helps orchestrate the execution of SystemPipelines registered in the SystemsModule.
+ */
+export interface ISystemsRuntimeContext<TEntity extends IEntity> {
+    readonly entityRepository: IEntityRepository;
+    readonly entityUpdate: IEntityUpdate;
+    readonly initializeEntity?: boolean;
+    readonly allowedSteps: Map<SystemPipelineType, boolean>;
+    readonly pipelineContext: ISystemPipelineContext<TEntity>;
+    readonly systemPipelines: ReadonlyMap<SystemPipelineType, IPipeline<ISystemPipelineContext<TEntity>>>;
+}

package/dist/systems/runtime/systems-runtime-context.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=systems-runtime-context.js.map

package/dist/systems/runtime/systems-runtime-context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"systems-runtime-context.js","sourceRoot":"","sources":["../../../src/systems/runtime/systems-runtime-context.ts"],"names":[],"mappings":""}

package/dist/systems/runtime/systems-runtime-middleware.d.ts

@@ -0,0 +1,8 @@
+import { IEntity } from "../../entities/entity";
+import { IMiddleware } from "../../pipelines/middleware";
+import { ISystemsRuntimeContext } from "./systems-runtime-context";
+/**
+ * The ISystemsRuntimeMiddleware represents the building blocks of executing SystemsModule registered Pipelines.
+ * It receives the current State in the Context, and can decide which SystemPipelines to execute.
+ */
+export declare type ISystemsRuntimeMiddleware<TEntity extends IEntity> = IMiddleware<ISystemsRuntimeContext<TEntity>>;

package/dist/systems/runtime/systems-runtime-middleware.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=systems-runtime-middleware.js.map

package/dist/systems/runtime/systems-runtime-middleware.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"systems-runtime-middleware.js","sourceRoot":"","sources":["../../../src/systems/runtime/systems-runtime-middleware.ts"],"names":[],"mappings":""}

package/dist/systems/system-pipeline-context.d.ts

@@ -1,39 +1,19 @@
-import { EntityTypeUid, IEntity, IEntityModel } from "../entities/entity";
-import { EntityEventUid, IEntityEvent, IEventData } from "../entities/entity-events";
-import { EntityProxy, IEntityProxy } from "../entities/entity-proxy";
-export interface ISystemContextRepository {
-    addEntity(entityType: EntityTypeUid, model: IEntityModel, events?: IEntityEvent<IEventData>[]): void;
-    getEntity<TEntity extends IEntity>(proxy: EntityProxy<TEntity>): TEntity;
-    updateEntity(target?: IEntityProxy): void;
-    removeEntity(target: IEntityProxy): void;
-}
-export interface ISystemContextScheduler {
-    scheduleUpdateOnInterval(target?: IEntityProxy, intervalMs?: number): void;
-    clearUpdateOnInterval(target?: IEntityProxy): void;
-}
-export interface ISystemContextProxies {
-    registerProxy(proxy: IEntityProxy, cleanup?: boolean): void;
-    registerProxies(proxies: IEntityProxy[], cleanup?: boolean): void;
-    removeProxy(proxy: IEntityProxy): void;
-    removeProxies(proxyEntityType?: EntityTypeUid): void;
-}
-export interface ISystemContextEvents {
-    dispatchEvent<TEventData extends IEventData>(data: TEventData, ...targets: IEntityProxy[]): void;
-    dispatchEvents<TEventData extends IEventData>(data: TEventData[], ...targets: IEntityProxy[]): void;
-    getEvent<TEventData extends IEventData>(uid: EntityEventUid): IEntityEvent<TEventData>;
-    listEvents<TEventData extends IEventData>(): IEntityEvent<TEventData>[];
-    hasEvent(uid?: EntityEventUid): boolean;
-    subscribeTo<TEventData extends IEventData>(uid: EntityEventUid, filter?: (event: IEntityEvent<TEventData>) => boolean): void;
-    unsubscribeFrom(uid: EntityEventUid): void;
-    clearSubscriptions(uid?: EntityEventUid): void;
-    setContextEvents(events: IEntityEvent<IEventData>[]): void;
-    setContextEvent(event: IEntityEvent<IEventData>): void;
-}
+import { IEntity } from "../entities/entity";
+import { ISystemContextEvents } from "./context/system-context-events";
+import { ISystemContextProxies } from "./context/system-context-proxies";
+import { ISystemContextRepository } from "./context/system-context-repository";
+import { ISystemContextScheduler } from "./context/system-context-scheduler";
+/**
+ * The ISystemPipelineContext 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.
+ *
+ * Any State changes done by the SystemMiddleware are executed using the APIs provided by the ISystemPipelineContext.
+ */
 export interface ISystemPipelineContext<TEntity extends IEntity> {
-    readonly entity: TEntity;
     readonly deltaTimeMs: number;
-    readonly repository: ISystemContextRepository;
-    readonly scheduler: ISystemContextScheduler;
-    readonly proxies: ISystemContextProxies;
-    readonly events: ISystemContextEvents;
+    readonly entity: Readonly<TEntity>;
+    readonly events: Readonly<ISystemContextEvents>;
+    readonly proxies: Readonly<ISystemContextProxies>;
+    readonly repository: Readonly<ISystemContextRepository>;
+    readonly scheduler: Readonly<ISystemContextScheduler>;
 }

package/dist/systems/system-pipeline-middleware.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=system-pipeline-middleware.js.map

package/dist/systems/system-pipeline-middleware.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"system-pipeline-middleware.js","sourceRoot":"","sources":["../../src/systems/system-pipeline-middleware.ts"],"names":[],"mappings":""}

package/dist/systems/system-pipeline-type.d.ts

@@ -1,3 +1,7 @@
+/**
+ * The built-in ECS pipeline types. They can be extended to introduce more types, and the SystemRuntimePipeline should
+ * add Middlewares to handle the newly added types.
+ */
 export declare enum SystemPipelineType {
     initialize = "initialize",
     update = "update",

package/dist/systems/system-pipeline-type.js

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SystemPipelineType = void 0;
+/**
+ * The built-in ECS pipeline types. They can be extended to introduce more types, and the SystemRuntimePipeline should
+ * add Middlewares to handle the newly added types.
+ */
 var SystemPipelineType;
 (function (SystemPipelineType) {
     SystemPipelineType["initialize"] = "initialize";

package/dist/systems/system-pipeline-type.js.map

@@ -1 +1 @@
-{"version":3,"file":"system-pipeline-type.js","sourceRoot":"","sources":["../../src/systems/system-pipeline-type.ts"],"names":[],"mappings":";;;AAAA,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,+CAAyB,CAAA;IACzB,uCAAiB,CAAA;IACjB,uCAAiB,CAAA;IACjB,mCAAa,CAAA;AACf,CAAC,EALW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAK7B"}
+{"version":3,"file":"system-pipeline-type.js","sourceRoot":"","sources":["../../src/systems/system-pipeline-type.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,+CAAyB,CAAA;IACzB,uCAAiB,CAAA;IACjB,uCAAiB,CAAA;IACjB,mCAAa,CAAA;AACf,CAAC,EALW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAK7B"}

package/dist/systems/systems-module.d.ts

@@ -1,25 +1,22 @@
 import { IEntity } from "../entities/entity";
 import { IEntityUpdate } from "../entities/entity-queue";
-import { PerformanceTimeEntry } from "../utils/performance-timer";
-import { ISystemMiddleware } from "./system-middleware";
+import { IRuntimeResult } from "../runtime/runtime-result";
+import { ISystemMiddleware } from "./system-pipeline-middleware";
 import { SystemPipelineType } from "./system-pipeline-type";
-export interface ISystemsModuleRuntimeResult {
-    metrics: PerformanceTimeEntry[];
-}
 /**
  * The SystemModule is the main way of registering and triggering the SystemMiddlewares registered for an Entity.
  * It can handle EntityUpdate objects and decides which SystemPipelines to trigger based on the information in the EntityUpdate.
  */
-export interface ISystemsModule {
-    /**
-     * The method allows triggering all registered SystemPipelines, to apply the changes from the provided EntityUpdate to an Entity instance.
-     * @param update The EntityUpdate containing the desired changes to be applied on an Entity instance.
-     */
-    triggerSystems(update: IEntityUpdate): ISystemsModuleRuntimeResult | Promise<ISystemsModuleRuntimeResult>;
+export interface ISystemsModule<TEntity extends IEntity> {
     /**
      * @param type The SystemPipelineType to append the provided SystemMiddlewares to.
      * @param systems The SystemMiddlewares will be registered in the provided SystemPipelineType in the same order as the provided array.
      * The SystemMiddlewares will be appended to existing Pipelines to allow easy extension of existing behaviors.
      */
-    registerSystems(type: SystemPipelineType, systems: ISystemMiddleware<IEntity>[]): void;
+    registerSystems(type: SystemPipelineType, systems: ISystemMiddleware<TEntity>[]): void;
+    /**
+     * Trigger all registered SystemPipelines, to apply the changes from the provided EntityUpdate to an Entity instance.
+     * @param update The EntityUpdate containing the desired changes to be applied on an Entity instance.
+     */
+    triggerSystems(update: IEntityUpdate): IRuntimeResult | Promise<IRuntimeResult>;
 }

package/dist/systems/systems-runtime.d.ts

@@ -1,10 +1,6 @@
-import { EntityTypeUid } from "../entities/entity";
-import { PerformanceTimeEntry } from "../utils/performance-timer";
+import { EntityTypeUid, IEntity } from "../entities/entity";
+import { IRuntimeResult } from "../runtime/runtime-result";
 import { ISystemsModule } from "./systems-module";
-export interface ISystemsRuntimeTickResult {
-    readonly remainingUpdatesCount: number;
-    readonly metrics: PerformanceTimeEntry[];
-}
 /**
  * The System Runtime allows running a loop of Ticks.
  *
@@ -18,9 +14,9 @@ export interface ISystemsRuntime {
      * @param entityType The EntityType this module will be registered for.
      * @param module The Module implementation that will be triggered when executing updates for the given EntityType.
      */
-    registerModule(entityType: EntityTypeUid, module: ISystemsModule): void;
+    registerModule<TEntity extends IEntity>(entityType: EntityTypeUid, module: ISystemsModule<TEntity>): void;
     /**
      * The method allows for an Unit of Work implementation, and returns the remaining quantity of items scheduled to be processed next.
      */
-    runTick(): ISystemsRuntimeTickResult | Promise<ISystemsRuntimeTickResult>;
+    runTick(): IRuntimeResult | Promise<IRuntimeResult>;
 }

package/dist/utils/types.d.ts

@@ -0,0 +1,3 @@
+export declare type Mutable<T> = {
+    -readonly [K in keyof T]: T[K];
+};

package/dist/utils/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/utils/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/utils/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@awesome-ecs/abstract",
-  "version": "0.7.0",
+  "version": "0.8.2",
   "description": "A comprehensive Entity-Component-System (ECS) Architecture implementation. Abstract components.",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -32,5 +32,5 @@
     "url": "https://github.com/andreicojocaru/awesome-ecs/issues"
   },
   "homepage": "https://github.com/andreicojocaru/awesome-ecs#readme",
-  "gitHead": "437c4702120c2fa0857a034e21096f0e683845bc"
+  "gitHead": "2243dd084e05965e28caa678e9f4689613902236"
 }

package/dist/systems/system-middleware.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"system-middleware.js","sourceRoot":"","sources":["../../src/systems/system-middleware.ts"],"names":[],"mappings":""}