@awesome-ecs/abstract 0.4.1 → 0.5.0

package/dist/components/component.d.ts

@@ -1,5 +1,17 @@
-export declare type ComponentUid = string | number;
+export declare type ComponentTypeUid = string | number;
+/**
+ * The Component provides the main storage mechanism of Entity state, and can be accessed and modified by Systems.
+ */
 export interface IComponent {
-    readonly componentType: ComponentUid;
+    /**
+     * The ComponentType is an Unique identifier for each Component type.
+     *
+     * It's possible to have multiple instances of the same Component type across different Entities,
+     * but only one Component type can exist on one Entity.
+     */
+    readonly componentType: ComponentTypeUid;
+    /**
+     * The serialization mechanism of this Component, when used to transfer it into a Snapshot, or used for logging the Component stored state.
+     */
     toJSON?(): string | object;
 }

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

@@ -1,12 +1,25 @@
 import { IComponent } from "./component";
 import { EntityTypeUid, IEntityModel } from "../entities/entity";
-import { IEntityProxy } from "..";
+import { IEntityProxy } from "../entities/entity-proxy";
 export declare enum BasicComponentType {
     identity = "identity"
 }
+/**
+ * Each Entity will have an Identity, containing basic information regarding what makes the current Entity unique.
+ */
 export interface IdentityComponent<TModel extends IEntityModel> extends IComponent {
-    entityType: EntityTypeUid;
-    model: TModel;
-    previousModel?: TModel;
-    proxies?: IEntityProxy[];
+    /**
+     * The Entity Type that defines what Category type the Entity is part of. There can be multiple Entities sharing the same EntityType.
+     */
+    readonly entityType: EntityTypeUid;
+    /**
+     * The Model is the basic information needed to create an Entity when it's first initialized.
+     * It provides a first snapshot of information needed for the successful creation of an Entity instance.
+     */
+    readonly model: TModel;
+    /**
+     * The Entity proxies that this Entity will always be linked to.
+     * Proxies can be registered at runtime to the Entity, but these proxies will always be registered when the Entity is first initialized (thus, they are guaranteed to exist in the beginning of the Entity lifetime).
+     */
+    readonly proxies?: IEntityProxy[];
 }

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

@@ -1,4 +1,11 @@
 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;
+}
 /**
  * The Entity Repository is the main storage for keeping track of existing Entities.
  * It provides basic CRUD functionality.
@@ -6,7 +13,8 @@ import { EntityUid, EntityTypeUid, IEntity } from "./entity";
 export interface IEntityRepository {
     has(type: EntityTypeUid, uid: EntityUid): boolean;
     get<TEntity extends IEntity>(type: EntityTypeUid, uid: EntityUid): TEntity;
-    getAll<TEntity extends IEntity>(type: EntityTypeUid): IterableIterator<TEntity>;
+    getWithTime<TEntity extends IEntity>(type: EntityTypeUid, uid: EntityUid): StoredEntity<TEntity>;
+    getAll<TEntity extends IEntity>(type: EntityTypeUid): TEntity[];
     set(entity: IEntity): void;
     delete(entity: IEntity): void;
     clear(entityType: EntityTypeUid): void;

package/dist/entities/entity.d.ts

@@ -1,5 +1,5 @@
 import { IdentityComponent } from "../components/identity-component";
-import { ComponentUid, IComponent } from "../components/component";
+import { ComponentTypeUid, IComponent } from "../components/component";
 import { IEntityProxy } from "./entity-proxy";
 export declare type EntityTypeUid = string | number;
 export declare type EntityUid = string | number;
@@ -10,7 +10,7 @@ export interface IEntityModel {
  * 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<ComponentUid, IComponent>;
+    readonly components: Map<ComponentTypeUid, IComponent>;
     readonly proxies: Map<EntityTypeUid, Map<EntityUid, IEntityProxy>>;
     readonly identity: IdentityComponent<IEntityModel>;
     readonly myProxy: IEntityProxy;

package/dist/index.d.ts

@@ -9,8 +9,8 @@ export * from './entities/entity-scheduler';
 export * from './pipelines/middleware';
 export * from './pipelines/pipeline';
 export * from './systems/system-middleware';
-export * from './systems/system-pipeline';
+export * from './systems/systems-module';
 export * from './systems/system-pipeline-context';
 export * from './systems/system-pipeline-type';
-export * from './systems/system-runtime';
+export * from './systems/systems-runtime';
 export * from './utils/performance-timer';

package/dist/index.js

@@ -25,9 +25,9 @@ __exportStar(require("./entities/entity-scheduler"), exports);
 __exportStar(require("./pipelines/middleware"), exports);
 __exportStar(require("./pipelines/pipeline"), exports);
 __exportStar(require("./systems/system-middleware"), exports);
-__exportStar(require("./systems/system-pipeline"), exports);
+__exportStar(require("./systems/systems-module"), exports);
 __exportStar(require("./systems/system-pipeline-context"), exports);
 __exportStar(require("./systems/system-pipeline-type"), exports);
-__exportStar(require("./systems/system-runtime"), exports);
+__exportStar(require("./systems/systems-runtime"), exports);
 __exportStar(require("./utils/performance-timer"), 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,0DAAuC;AACvC,0DAAuC;AACvC,0DAAuC;AACvC,+DAA4C;AAC5C,8DAA2C;AAE3C,yDAAsC;AACtC,uDAAoC;AAEpC,8DAA2C;AAC3C,4DAAyC;AACzC,oEAAiD;AACjD,iEAA8C;AAC9C,2DAAwC;AAExC,4DAAyC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yDAAsC;AACtC,kEAA+C;AAE/C,oDAAiC;AACjC,0DAAuC;AACvC,0DAAuC;AACvC,0DAAuC;AACvC,+DAA4C;AAC5C,8DAA2C;AAE3C,yDAAsC;AACtC,uDAAoC;AAEpC,8DAA2C;AAC3C,2DAAwC;AACxC,oEAAiD;AACjD,iEAA8C;AAC9C,4DAAyC;AAEzC,4DAAyC"}

package/dist/pipelines/middleware.d.ts

@@ -11,7 +11,7 @@ export interface IMiddleware<TContext> {
      * being met so this middleware's action should run.
      * @param context The Context to determine whether the run condition is satisfied.
      */
-    shouldRun?(context: TContext): boolean;
+    shouldRun?(context: TContext): Promise<boolean> | boolean;
     /**
      * The function gets called as part of the pipeline, based on the registration order.
      * @param context The Context can be read or updated. The Context holds all the state necessary for the execution of the middleware.
@@ -19,7 +19,7 @@ export interface IMiddleware<TContext> {
      */
     action(context: TContext, stop: Stop): Promise<void> | void;
     /**
-     * The function gets called when the cleanup of the Pipeline is necessary, based on reverse order of Middleware registration.
+     * 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;

package/dist/pipelines/pipeline.d.ts

@@ -10,7 +10,7 @@ export interface IPipeline<TContext> {
     /**
      * Execute the chain of middlewares, in the order they were added on a given Context.
      */
-    dispatch(context: TContext): void;
+    dispatch(context: TContext): boolean;
     /**
      * Runs the Cleanup function on all middlewares.
      */

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

@@ -1,4 +1,8 @@
 import { IEntity } from "../entities/entity";
 import { IMiddleware } from "../pipelines/middleware";
 import { ISystemPipelineContext } from "./system-pipeline-context";
+/**
+ * The SystemMiddleware is the basic System implementation that can be registered as a Middleware in a SystemPipeline.
+ * It provides a SystemPipelineContext to it's exposed methods.
+ */
 export declare type ISystemMiddleware<TEntity extends IEntity> = IMiddleware<ISystemPipelineContext<TEntity>>;

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

@@ -33,4 +33,5 @@ export interface ISystemPipelineContext<TEntity extends IEntity> {
     readonly scheduler: ISystemContextScheduler;
     readonly proxies: ISystemContextProxies;
     readonly events: ISystemContextEvents;
+    readonly deltaTimeMs: number;
 }

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

@@ -2,6 +2,5 @@ export declare enum SystemPipelineType {
     initialize = "initialize",
     update = "update",
     render = "render",
-    sync = "sync",
-    dispatch = "dispatch"
+    sync = "sync"
 }

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

@@ -7,6 +7,5 @@ var SystemPipelineType;
     SystemPipelineType["update"] = "update";
     SystemPipelineType["render"] = "render";
     SystemPipelineType["sync"] = "sync";
-    SystemPipelineType["dispatch"] = "dispatch";
 })(SystemPipelineType = exports.SystemPipelineType || (exports.SystemPipelineType = {}));
 //# sourceMappingURL=system-pipeline-type.js.map

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,kBAMX;AAND,WAAY,kBAAkB;IAC5B,+CAAyB,CAAA;IACzB,uCAAiB,CAAA;IACjB,uCAAiB,CAAA;IACjB,mCAAa,CAAA;IACb,2CAAqB,CAAA;AACvB,CAAC,EANW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAM7B"}
+{"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"}

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

@@ -0,0 +1,21 @@
+import { IEntity } from "../entities/entity";
+import { IEntityUpdate } from "../entities/entity-queue";
+import { ISystemMiddleware } from "./system-middleware";
+import { SystemPipelineType } from "./system-pipeline-type";
+/**
+ * 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): void | Promise<void>;
+    /**
+     * @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;
+}

package/dist/systems/{system-runtime.js → systems-module.js}

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

package/dist/systems/systems-module.js.map

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

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

@@ -0,0 +1,21 @@
+import { EntityTypeUid } from "../entities/entity";
+import { ISystemsModule } from "./systems-module";
+/**
+ * The System Runtime allows running a loop of Ticks.
+ *
+ * Each RunTick can process one or more Entity Updates, from the EntityQueue.
+ * We can have multiple implementations of a SystemRuntime, based on the use-case.
+ * A different implementation can be chosen at runtime, based for example on performance.
+ */
+export interface ISystemsRuntime {
+    /**
+     * Allows registering the SystemsModule that will be triggered for any EntityUpdate for the given EntityType.
+     * @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;
+    /**
+     * The method allows for an Unit of Work implementation, and returns the remaining quantity of items scheduled to be processed next.
+     */
+    runTick(): number;
+}

package/dist/systems/{system-pipeline.js → systems-runtime.js}

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

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@awesome-ecs/abstract",
-  "version": "0.4.1",
+  "version": "0.5.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": "93369281b340cc8545737c852ba90e7fc0328a62"
+  "gitHead": "3e5a3223697d9f3618ff1517dce2b1f39b739d6f"
 }

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

@@ -1,4 +0,0 @@
-import { IEntityUpdate } from "../entities/entity-queue";
-export interface ISystemPipeline {
-    handleUpdate(update: IEntityUpdate): void | Promise<void>;
-}

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

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

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

@@ -1,3 +0,0 @@
-export interface ISystemRuntime {
-    runTick(): number;
-}

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

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