@awesome-ecs/abstract 0.0.1 → 0.0.5

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Andrei C
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,99 +1,99 @@
-# Awesome ECS (Entity-Component-System)
-
-## What is it?
-
-The Entity-Component-System is a well-known Architecture type used for responsive, complex applications, not only restricted to the Web.
-It's mostly associated with Game Engines, because of it's way of segregating Behavior from State, and allowing fine-control of the Runtime.
-
-## Building blocks
-
-### Entities
-
-Entities are really just collections of Components. 
-
-In this Awesome ECS Architecture implementation, an Entity is built of:
-
-- one or more Components
-- proxies to other Entities
-
-Entity changes can triggered from outside systems (e.g. UI events, data from backend, a Redux Store change), or on ran a Schedule (e.g. Engine Loop).
-
-### Components
-
-Components are data-holders. They are instantiated for each Entity, and hold the state for the Entity.
-An Entity can have many different types of Components, based on what the Entity State is.
-
-Components should not contain any behavior, only keep data (e.g. Plain-Objects).
-
-### Systems
-
-Systems are behaviors of the ECS Architecture. They receive an Entity as input, and run Behaviors, altering the data contained in the Entity's Components.
-Systems are usually Entity-specific, but they can be shared (e.g. Two Entities having the same Component Type, can in fact, share a System's Behavior).
-
-## Awesome ECS Architecture
-
-### Pipeline
-
-The Pipelines are at the heart of the Easy ECS Architecture implementation, and it's a way of declaring which Systems are run as part of the Runtime Loop.
-
-### Middleware
-
-The Middleware is the Unit-of-Work implementation of a System, and allows for a System to achieve Single-Responsibility (part of SOLID principles.).
-
-A Middleware has 3 methods:
- - `shouldRun: boolean` -> specifies whether the current System should run it's `action` method, to introduce State changes on the Entity's Components
- - `action: void` -> the System implementation that allows for altering Entity Component state, can use Entity Proxies, or Schedule updates for itself or other Entities
- - `cleanup: void` -> the System implementation method that gets called when the Entity Model Change Type is Removed. It handles the disposal of any internal objects the System might have instantiated
-
-Each Middleware method will receive a `context: SystemPipelineContext<TEntity>`, which contains the current Entity state, as well as the Entity Model Change, and any Entity changes Scheduled for Dispatch at the end of the current Tick
-
-## Entity Changes
-
-Each Entity has a mandatory Identity Component. This Identity Component will hold the current Entity Model, and it's Entity Unique Identifier.
-Model changes will prompt an Entity to introduce itself on a Entity Change Queue, to be processed on the next Tick by the Runtime. 
-
-### The Runtime
-
-The Awesome ECS Architecture implementation Runtime is structured in Loops of Ticks.
-
-Each Tick has an allocated time for running, and will process Entity Changes during that Tick.
-If there is more time left in the current Loop, and the Entity Change Queue is not empty, the next Entity Change in the Entity Change Queue, will be processed.
-
-### The Ticks
-
-Each Tick will receive as an input an Entity Model Change, which will contain: the Current Model, the Previous Model (if available), and the Change Type (Added, Updated or Removed).
-
-Based on the Change Type and Model, the Entity Identifier is being searched.
-Based on the found Entity Identifier and Change Type, The Runtime instantiates the System Pipeline associated with that change.
-
-## Runtime Stages
-
-The Runtime has a few Stages, that will run in this order:
-
-- Initializer Systems
-- Updater Systems
-- Renderer Systems
-- (Dispatcher) Systems
-
-Each Stage is a System Pipeline, which will run it's associated System Middlewares, in the order they were registered in.
-
-### Generator Systems
-
-The Generator Systems will be ran once per Entity, when the Model Change Type is Added.
-All the Middlewares registered for this stage will contribute to enrich the Entity Components with bootstrap data.
-
-### Updater Systems
-
-The Updater Systems will be ran on each Model Change, and it's the main way of altering the Entity's Components state.
-
-### Render Systems
-
-The Render Systems will make sure to update the underlying Render system with the Entity's `RenderingComponent` state. It's useful as an abstraction layer to lower-lever Rendering (e.g. a Game Engine, WebGL, Canvas)
-
-The Render Systems can be skipped from the Runtime, if needed. That can be useful to simulate the same Runtime in a non-rendered system, like the Backend.
-
-### (Dispatch) Systems
-
-The Dispatch Systems are built-in Systems in the Awesome ECS, and will take care of Dispatching Actions, Scheduling Entity updates, or synchronizing the Entity Repository with the latest Entity State in the current Context.
-
-The Dispatch Systems, as well as any other Runtime Stage, can be extended as needed by registering more System Middlewares in the Stage Pipeline.
+# Awesome ECS (Entity-Component-System)
+
+## What is it?
+
+The Entity-Component-System is a well-known Architecture type used for responsive, complex applications, not only restricted to the Web.
+It's mostly associated with Game Engines, because of it's way of segregating Behavior from State, and allowing fine-control of the Runtime.
+
+## Building blocks
+
+### Entities
+
+Entities are really just collections of Components. 
+
+In this Awesome ECS Architecture implementation, an Entity is built of:
+
+- one or more Components
+- proxies to other Entities
+
+Entity changes can triggered from outside systems (e.g. UI events, data from backend, a Redux Store change), or on ran a Schedule (e.g. Engine Loop).
+
+### Components
+
+Components are data-holders. They are instantiated for each Entity, and hold the state for the Entity.
+An Entity can have many different types of Components, based on what the Entity State is.
+
+Components should not contain any behavior, only keep data (e.g. Plain-Objects).
+
+### Systems
+
+Systems are behaviors of the ECS Architecture. They receive an Entity as input, and run Behaviors, altering the data contained in the Entity's Components.
+Systems are usually Entity-specific, but they can be shared (e.g. Two Entities having the same Component Type, can in fact, share a System's Behavior).
+
+## Awesome ECS Architecture
+
+### Pipeline
+
+The Pipelines are at the heart of the Easy ECS Architecture implementation, and it's a way of declaring which Systems are run as part of the Runtime Loop.
+
+### Middleware
+
+The Middleware is the Unit-of-Work implementation of a System, and allows for a System to achieve Single-Responsibility (part of SOLID principles.).
+
+A Middleware has 3 methods:
+ - `shouldRun: boolean` -> specifies whether the current System should run it's `action` method, to introduce State changes on the Entity's Components
+ - `action: void` -> the System implementation that allows for altering Entity Component state, can use Entity Proxies, or Schedule updates for itself or other Entities
+ - `cleanup: void` -> the System implementation method that gets called when the Entity Model Change Type is Removed. It handles the disposal of any internal objects the System might have instantiated
+
+Each Middleware method will receive a `context: SystemPipelineContext<TEntity>`, which contains the current Entity state, as well as the Entity Model Change, and any Entity changes Scheduled for Dispatch at the end of the current Tick
+
+## Entity Changes
+
+Each Entity has a mandatory Identity Component. This Identity Component will hold the current Entity Model, and it's Entity Unique Identifier.
+Model changes will prompt an Entity to introduce itself on a Entity Change Queue, to be processed on the next Tick by the Runtime. 
+
+### The Runtime
+
+The Awesome ECS Architecture implementation Runtime is structured in Loops of Ticks.
+
+Each Tick has an allocated time for running, and will process Entity Changes during that Tick.
+If there is more time left in the current Loop, and the Entity Change Queue is not empty, the next Entity Change in the Entity Change Queue, will be processed.
+
+### The Ticks
+
+Each Tick will receive as an input an Entity Model Change, which will contain: the Current Model, the Previous Model (if available), and the Change Type (Added, Updated or Removed).
+
+Based on the Change Type and Model, the Entity Identifier is being searched.
+Based on the found Entity Identifier and Change Type, The Runtime instantiates the System Pipeline associated with that change.
+
+## Runtime Stages
+
+The Runtime has a few Stages, that will run in this order:
+
+- Initializer Systems
+- Updater Systems
+- Renderer Systems
+- (Dispatcher) Systems
+
+Each Stage is a System Pipeline, which will run it's associated System Middlewares, in the order they were registered in.
+
+### Generator Systems
+
+The Generator Systems will be ran once per Entity, when the Model Change Type is Added.
+All the Middlewares registered for this stage will contribute to enrich the Entity Components with bootstrap data.
+
+### Updater Systems
+
+The Updater Systems will be ran on each Model Change, and it's the main way of altering the Entity's Components state.
+
+### Render Systems
+
+The Render Systems will make sure to update the underlying Render system with the Entity's `RenderingComponent` state. It's useful as an abstraction layer to lower-lever Rendering (e.g. a Game Engine, WebGL, Canvas)
+
+The Render Systems can be skipped from the Runtime, if needed. That can be useful to simulate the same Runtime in a non-rendered system, like the Backend.
+
+### (Dispatch) Systems
+
+The Dispatch Systems are built-in Systems in the Awesome ECS, and will take care of Dispatching Actions, Scheduling Entity updates, or synchronizing the Entity Repository with the latest Entity State in the current Context.
+
+The Dispatch Systems, as well as any other Runtime Stage, can be extended as needed by registering more System Middlewares in the Stage Pipeline.

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

@@ -1,6 +1,9 @@
 import { IComponent } from "./component";
 import { IEntityModel } from "../entities/entity-model";
 import { EntityTypeUid } from "../entities/entity";
+export declare enum BasicComponentType {
+    identity = "identity"
+}
 export interface IdentityComponent<TModel extends IEntityModel> extends IComponent {
     entityType: EntityTypeUid;
     model: TModel;

package/dist/components/identity-component.js

@@ -1,2 +1,5 @@
-export {};
+export var BasicComponentType;
+(function (BasicComponentType) {
+    BasicComponentType["identity"] = "identity";
+})(BasicComponentType || (BasicComponentType = {}));
 //# sourceMappingURL=identity-component.js.map

package/dist/components/identity-component.js.map

@@ -1 +1 @@
-{"version":3,"file":"identity-component.js","sourceRoot":"","sources":["../../src/components/identity-component.ts"],"names":[],"mappings":""}
+{"version":3,"file":"identity-component.js","sourceRoot":"","sources":["../../src/components/identity-component.ts"],"names":[],"mappings":"AAIA,MAAM,CAAN,IAAY,kBAEX;AAFD,WAAY,kBAAkB;IAC5B,2CAAqB,CAAA;AACvB,CAAC,EAFW,kBAAkB,KAAlB,kBAAkB,QAE7B"}

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

@@ -7,4 +7,6 @@ export interface IEntityRepository {
     set(entity: IEntity): void;
     delete(entity: IEntity): void;
     clear(entityType: EntityTypeUid): void;
+    onEntitySetCallback?: (entity: IEntity) => void;
+    onEntityDeletedCallback?: (entity: IEntity) => void;
 }

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

@@ -0,0 +1,5 @@
+import { IEntityProxy } from "./entity-proxy";
+export interface IEntityScheduler {
+    schedule(entityProxy: IEntityProxy, intervalMs?: number): void;
+    remove(entityProxy: IEntityProxy): void;
+}

package/dist/entities/entity-scheduler.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=entity-scheduler.js.map

package/dist/entities/entity-scheduler.js.map

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

package/dist/index.d.ts

@@ -4,6 +4,7 @@ export * from './entities/entity';
 export * from './entities/entity-model';
 export * from './entities/entity-proxy';
 export * from './entities/entity-repository';
+export * from './entities/entity-scheduler';
 export * from './pipelines/middleware';
 export * from './pipelines/pipeline';
 export * from './systems/system-middleware';

package/dist/index.js

@@ -4,6 +4,7 @@ export * from './entities/entity';
 export * from './entities/entity-model';
 export * from './entities/entity-proxy';
 export * from './entities/entity-repository';
+export * from './entities/entity-scheduler';
 export * from './pipelines/middleware';
 export * from './pipelines/pipeline';
 export * from './systems/system-middleware';

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAC;AACvC,cAAc,iCAAiC,CAAC;AAEhD,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,8BAA8B,CAAC;AAE7C,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AAErC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mCAAmC,CAAC;AAClD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,0BAA0B,CAAC;AAEzC,cAAc,2BAA2B,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAA;AACtC,cAAc,iCAAiC,CAAA;AAE/C,cAAc,mBAAmB,CAAA;AACjC,cAAc,yBAAyB,CAAA;AACvC,cAAc,yBAAyB,CAAA;AACvC,cAAc,8BAA8B,CAAA;AAC5C,cAAc,6BAA6B,CAAA;AAE3C,cAAc,wBAAwB,CAAA;AACtC,cAAc,sBAAsB,CAAA;AAEpC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,2BAA2B,CAAA;AACzC,cAAc,mCAAmC,CAAA;AACjD,cAAc,gCAAgC,CAAA;AAC9C,cAAc,0BAA0B,CAAA;AAExC,cAAc,2BAA2B,CAAA"}

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

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

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

@@ -3,6 +3,7 @@ export var SystemPipelineType;
     SystemPipelineType["initialize"] = "initialize";
     SystemPipelineType["update"] = "update";
     SystemPipelineType["render"] = "render";
+    SystemPipelineType["sync"] = "sync";
     SystemPipelineType["dispatch"] = "dispatch";
 })(SystemPipelineType || (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,MAAM,CAAN,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,+CAAyB,CAAA;IACzB,uCAAiB,CAAA;IACjB,uCAAiB,CAAA;IACjB,2CAAqB,CAAA;AACvB,CAAC,EALW,kBAAkB,KAAlB,kBAAkB,QAK7B"}
+{"version":3,"file":"system-pipeline-type.js","sourceRoot":"","sources":["../../src/systems/system-pipeline-type.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,kBAMX;AAND,WAAY,kBAAkB;IAC5B,+CAAyB,CAAA;IACzB,uCAAiB,CAAA;IACjB,uCAAiB,CAAA;IACjB,mCAAa,CAAA;IACb,2CAAqB,CAAA;AACvB,CAAC,EANW,kBAAkB,KAAlB,kBAAkB,QAM7B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@awesome-ecs/abstract",
-  "version": "0.0.1",
+  "version": "0.0.5",
   "description": "A comprehensive Entity-Component-System (ECS) Architecture implementation. Abstract components.",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -31,5 +31,6 @@
   "bugs": {
     "url": "https://github.com/andreicojocaru/awesome-ecs/issues"
   },
-  "homepage": "https://github.com/andreicojocaru/awesome-ecs#readme"
+  "homepage": "https://github.com/andreicojocaru/awesome-ecs#readme",
+  "gitHead": "34ab2cd27bc77e3b1269314b588ea458b1f78f23"
 }

package/dist/components/index.d.ts

@@ -1,2 +0,0 @@
-export * from './component';
-export * from './identity-component';

package/dist/components/index.js

@@ -1,3 +0,0 @@
-export * from './component';
-export * from './identity-component';
-//# sourceMappingURL=index.js.map

package/dist/components/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/components/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,sBAAsB,CAAA"}