@awesome-ecs/abstract 0.2.4 → 0.3.1

package/LICENSE

@@ -1,21 +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.
+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/dist/entities/entity-event.d.ts

@@ -0,0 +1,27 @@
+import { IEntityProxy } from "./entity-proxy";
+export declare type EntityEventUid = string | number;
+export declare type EntityEventSubscriptionFilter = (event: IEntityEvent<IEventData>) => boolean;
+export interface IEventData {
+    uid: EntityEventUid;
+}
+/**
+ * Entity Events represent the basic building blocks for a Pub/Sub pattern, to synchronize
+ * state between multiple Entities.
+ *
+ * The Events are past actions that already happened within a state. They are scheduled as part of the EntityUpdate model.
+ * Other Systems subscribe and receive updates with the Events included in their SystemContext model.
+ */
+export interface IEntityEvent<TEventData extends IEventData> {
+    origin: IEntityProxy;
+    target?: IEntityProxy;
+    data: TEventData;
+}
+/**
+ * The EntityEventsManager represents the Pub/Sub broker for EntityEvents.
+ */
+export interface IEntityEventsManager {
+    subscribe(uid: EntityEventUid, entity: IEntityProxy, filter?: EntityEventSubscriptionFilter): void;
+    unsubscribe(uid: EntityEventUid, entity: IEntityProxy): void;
+    getSubscriptions(event: IEntityEvent<IEventData>): IEntityProxy[];
+    clearSubscriptions(uid?: EntityEventUid): void;
+}

package/dist/entities/{entity-trigger.js → entity-event.js}

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

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

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

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

@@ -1,7 +1,6 @@
-import { EntityTriggerUid } from "..";
 import { IEntityModel } from "./entity";
+import { IEntityEvent, IEventData } from "./entity-event";
 import { IEntityProxy } from "./entity-proxy";
-import { IEntityTrigger, ITriggerData } from "./entity-trigger";
 /**
  * The Entity update state for this change.
  */
@@ -16,8 +15,7 @@ export interface IEntityUpdate {
     type: EntityUpdateType;
     entity: IEntityProxy;
     model?: IEntityModel;
-    triggers?: Map<EntityTriggerUid, IEntityTrigger<ITriggerData>>;
-    forceUpdate?: boolean;
+    events?: IEntityEvent<IEventData>[];
 }
 /**
  * The Entity Updates will be queued up, and can be picked up in order.

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

@@ -1 +1 @@
-{"version":3,"file":"entity-queue.js","sourceRoot":"","sources":["../../src/entities/entity-queue.ts"],"names":[],"mappings":";;;AAKA;;GAEG;AACH,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,qCAAiB,CAAA;IACjB,qCAAiB,CAAA;AACnB,CAAC,EAHW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAG3B"}
+{"version":3,"file":"entity-queue.js","sourceRoot":"","sources":["../../src/entities/entity-queue.ts"],"names":[],"mappings":";;;AAIA;;GAEG;AACH,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,qCAAiB,CAAA;IACjB,qCAAiB,CAAA;AACnB,CAAC,EAHW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAG3B"}

package/dist/entities/entity.d.ts

@@ -1,6 +1,5 @@
 import { IdentityComponent } from "../components/identity-component";
 import { ComponentUid, IComponent } from "../components/component";
-import { EntityTriggerUid, IEntityTrigger, ITriggerData } from "./entity-trigger";
 import { IEntityProxy } from "./entity-proxy";
 export declare type EntityTypeUid = string | number;
 export declare type EntityUid = string | number;
@@ -13,7 +12,6 @@ export interface IEntityModel {
 export interface IEntity {
     readonly components: Map<ComponentUid, IComponent>;
     readonly proxies: Map<EntityTypeUid, Map<EntityUid, IEntityProxy>>;
-    readonly triggers: Map<EntityTriggerUid, IEntityTrigger<ITriggerData>[]>;
     readonly identity: IdentityComponent<IEntityModel>;
     readonly myProxy: IEntityProxy;
 }

package/dist/index.d.ts

@@ -1,11 +1,11 @@
 export * from './components/component';
 export * from './components/identity-component';
 export * from './entities/entity';
+export * from './entities/entity-event';
 export * from './entities/entity-proxy';
 export * from './entities/entity-queue';
 export * from './entities/entity-repository';
 export * from './entities/entity-scheduler';
-export * from './entities/entity-trigger';
 export * from './pipelines/middleware';
 export * from './pipelines/pipeline';
 export * from './systems/system-middleware';

package/dist/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -13,11 +17,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./components/component"), exports);
 __exportStar(require("./components/identity-component"), exports);
 __exportStar(require("./entities/entity"), exports);
+__exportStar(require("./entities/entity-event"), exports);
 __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("./entities/entity-trigger"), exports);
 __exportStar(require("./pipelines/middleware"), exports);
 __exportStar(require("./pipelines/pipeline"), exports);
 __exportStar(require("./systems/system-middleware"), exports);

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,+DAA4C;AAC5C,8DAA2C;AAC3C,4DAAyC;AAEzC,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,4DAAyC;AACzC,oEAAiD;AACjD,iEAA8C;AAC9C,2DAAwC;AAExC,4DAAyC"}

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

@@ -1,30 +1,36 @@
 import { EntityTypeUid, IEntity, IEntityModel } from "../entities/entity";
+import { EntityEventUid, IEntityEvent, IEventData } from "../entities/entity-event";
 import { EntityProxy, IEntityProxy } from "../entities/entity-proxy";
-import { EntityTriggerUid, IEntityTrigger, ITriggerData } from "../entities/entity-trigger";
-export interface IEntitySchedule {
-    target: IEntityProxy;
-    intervalMs?: number;
-}
-export interface ISystemPipelineContext<TEntity extends IEntity> {
-    readonly entity: TEntity;
-    addEntity(entityType: EntityTypeUid, model: IEntityModel, triggers?: ITriggerData[]): void;
+export interface ISystemContextRepository {
+    addEntity(entityType: EntityTypeUid, model: IEntityModel, events?: IEntityEvent<IEventData>[]): void;
+    getEntity<TEntity extends IEntity>(proxy: EntityProxy<TEntity>): TEntity;
     updateEntity(target?: IEntityProxy, model?: IEntityModel): void;
     removeEntity(target?: IEntityProxy): void;
+}
+export interface ISystemContextScheduler {
     scheduleUpdateOnInterval(target?: IEntityProxy, intervalMs?: number): void;
     clearUpdateOnInterval(target?: IEntityProxy): void;
-    getEntity<TEntity extends IEntity>(proxy: EntityProxy<TEntity>): TEntity;
+}
+export interface ISystemContextProxies {
     registerProxy(proxy: IEntityProxy, cleanup?: boolean): void;
     registerProxies(proxies: IEntityProxy[], cleanup?: boolean): void;
     removeProxy(proxy: IEntityProxy): void;
     removeProxies(proxyEntityType?: EntityTypeUid): void;
-    addTrigger<TTriggerData extends ITriggerData>(target: IEntityProxy, data: TTriggerData): void;
-    addTriggers<TTriggerData extends ITriggerData>(target: IEntityProxy, data: TTriggerData[]): void;
-    /**
-     * Retrieve the first Trigger of the specified type.
-     * @param uid The Trigger type.
-     */
-    getTrigger<TTriggerData extends ITriggerData>(uid: EntityTriggerUid): IEntityTrigger<TTriggerData>;
-    getTriggers<TTriggerData extends ITriggerData>(uid: EntityTriggerUid): IEntityTrigger<TTriggerData>[];
-    hasTriggers(uid?: EntityTriggerUid): boolean;
-    removeTriggers(uid?: EntityTriggerUid): 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>;
+    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;
+}
+export interface ISystemPipelineContext<TEntity extends IEntity> {
+    readonly entity: TEntity;
+    readonly repository: ISystemContextRepository;
+    readonly scheduler: ISystemContextScheduler;
+    readonly proxies: ISystemContextProxies;
+    readonly events: ISystemContextEvents;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@awesome-ecs/abstract",
-  "version": "0.2.4",
+  "version": "0.3.1",
   "description": "A comprehensive Entity-Component-System (ECS) Architecture implementation. Abstract components.",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -8,10 +8,10 @@
     "dist"
   ],
   "devDependencies": {
-    "typescript": "^4.5.5"
+    "typescript": "^4.6.2"
   },
   "scripts": {
-    "build": "npx tsc"
+    "build": "rm -rf ./dist && npx tsc --build"
   },
   "repository": {
     "type": "git",
@@ -32,5 +32,5 @@
     "url": "https://github.com/andreicojocaru/awesome-ecs/issues"
   },
   "homepage": "https://github.com/andreicojocaru/awesome-ecs#readme",
-  "gitHead": "267f28e09631652c5281c877529b6d286e3bae4b"
+  "gitHead": "0d3a32919b66610ab4e2a9b735d9cb53f181a3f3"
 }

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

@@ -1,4 +0,0 @@
-import { ComponentTypeUid, IComponent } from "./component";
-export interface IComponentFactory {
-    create<TComponent extends IComponent>(type: ComponentTypeUid): TComponent;
-}

package/dist/components/component-factory.js

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

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

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

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

@@ -1,4 +0,0 @@
-export declare type EntityUid = string | number;
-export interface IEntityModel {
-    uid: EntityUid;
-}

package/dist/entities/entity-model.js

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

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

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

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

@@ -1,17 +0,0 @@
-import { IEntityProxy } from "./entity-proxy";
-import { EntityUpdateType } from "./entity-queue";
-export declare type EntityTriggerUid = string | number;
-export interface ITriggerData {
-    uid: EntityTriggerUid;
-    action?: EntityUpdateType;
-}
-/**
- * Entity Triggers represent a basic inter-Entity messaging mechanism.
- * Can be used to "trigger" actions in an Entity, from the systems of another Entity.
- *
- * The Triggers will be enqueued as part of an Entity Update envelope.
- */
-export interface IEntityTrigger<TTriggerData extends ITriggerData> {
-    origin: IEntityProxy;
-    data: TTriggerData;
-}

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

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