@awesome-ecs/abstract 0.6.0 → 0.7.0

package/dist/pipelines/pipeline.d.ts

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

package/dist/pipelines/pipeline.js

@@ -1,3 +1,9 @@
 "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":""}
+{"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"}

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

@@ -1,7 +1,11 @@
 import { IEntity } from "../entities/entity";
 import { IEntityUpdate } from "../entities/entity-queue";
+import { PerformanceTimeEntry } from "../utils/performance-timer";
 import { ISystemMiddleware } from "./system-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.
@@ -11,7 +15,7 @@ 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): void | Promise<void>;
+    triggerSystems(update: IEntityUpdate): ISystemsModuleRuntimeResult | Promise<ISystemsModuleRuntimeResult>;
     /**
      * @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.

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

@@ -3,7 +3,7 @@ import { PerformanceTimeEntry } from "../utils/performance-timer";
 import { ISystemsModule } from "./systems-module";
 export interface ISystemsRuntimeTickResult {
     readonly remainingUpdatesCount: number;
-    readonly metrics?: PerformanceTimeEntry[];
+    readonly metrics: PerformanceTimeEntry[];
 }
 /**
  * The System Runtime allows running a loop of Ticks.
@@ -22,5 +22,5 @@ export interface ISystemsRuntime {
     /**
      * The method allows for an Unit of Work implementation, and returns the remaining quantity of items scheduled to be processed next.
      */
-    runTick(): ISystemsRuntimeTickResult;
+    runTick(): ISystemsRuntimeTickResult | Promise<ISystemsRuntimeTickResult>;
 }

package/dist/utils/performance-timer.d.ts

@@ -1,10 +1,11 @@
 export declare type PerformanceTimerUid = number;
 export interface PerformanceTimeEntry {
+    name: string;
     startedAt: number;
     endedAt?: number;
     msPassed?: number;
 }
 export interface IPerformanceTimer {
-    startTimer(name?: string): PerformanceTimerUid;
+    startTimer(name: string): PerformanceTimerUid;
     endTimer(timerUid: PerformanceTimerUid): PerformanceTimeEntry;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@awesome-ecs/abstract",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "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": "6c6fd0210fcaa7e91b3716b7708b7a44a8c3a822"
+  "gitHead": "437c4702120c2fa0857a034e21096f0e683845bc"
 }