@awesome-ecs/abstract 0.12.0 → 0.13.1

package/dist/components/component.d.ts

@@ -1,4 +1,4 @@
-export declare type ComponentTypeUid = string | number;
+export type ComponentTypeUid = string | number;
 /**
  * The `IComponent` provides the main storage mechanism of `IEntity` state, and can be accessed and modified by Systems.
  *

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

@@ -1,6 +1,6 @@
 import { IEntityProxy } from "./entity-proxies";
-export declare type EntityEventUid = string | number;
-export declare type EntityEventSubscriptionFilter = (event: IEntityEvent<IEventData>) => boolean;
+export type EntityEventUid = string | number;
+export type EntityEventSubscriptionFilter = (event: IEntityEvent<IEventData>) => boolean;
 /**
  * The `IEventData` contains the event-specific state. At the very least, it contains the `Event Unique Identifier`.
  */
@@ -25,7 +25,20 @@ 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;
+    /**
+     * Removes all Subscriptions for all Entities.
+     */
+    clearSubscriptions(): void;
+    /**
+     * Removes all Subscriptions for the given Event.
+     * @param uid The Event UID to remove all Subscribers from.
+     */
+    clearSubscriptionsForEvent(uid: EntityEventUid): void;
+    /**
+     * Removes all Event Subscriptions for the given Entity.
+     * @param entity The Entity to remove all of it's Event Subscriptions.
+     */
+    clearSubscriptionsForEntity(entity: IEntityProxy): void;
 }
 /**
  * The `IEntityEventsDispatcher` is the main access point for dispatching events to Entities.

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

@@ -5,6 +5,7 @@ import { IEntityProxy } from "./entity-proxies";
  * It provides basic CRUD functionality.
  */
 export interface IEntityRepository {
+    readonly size: number;
     has(proxy: IEntityProxy): boolean;
     get<TEntity extends IEntity>(proxy: IEntityProxy): TEntity;
     getAll<TEntity extends IEntity>(entityType: EntityTypeUid): TEntity[];

package/dist/entities/entity.d.ts

@@ -1,8 +1,8 @@
 import { IdentityComponent } from "../components/identity-component";
 import { ComponentTypeUid, IComponent } from "../components/component";
 import { IEntityProxy } from "./entity-proxies";
-export declare type EntityTypeUid = string | number;
-export declare type EntityUid = string | number;
+export type EntityTypeUid = string | number;
+export type EntityUid = string | number;
 /**
  * The `IEntityModel` represents the basic identity information about the current `IEntity`.
  * It's mandatory for each Entity, and it contains the minimal-required information needed for instantiating the Entity.

package/dist/index.d.ts

@@ -1,35 +1,35 @@
-export * from './components/component';
-export * from './components/identity-component';
-export * from './entities/entity';
-export * from './entities/entity-events';
-export * from './entities/entity-proxies';
-export * from './entities/entity-queue';
-export * from './entities/entity-repository';
-export * from './entities/entity-scheduler';
-export * from './entities/entity-snapshot';
-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 './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/context/system-context-snapshot';
-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/json-serializer';
-export * from './utils/performance-timer';
-export * from './utils/types';
+export * from "./components/component";
+export * from "./components/identity-component";
+export * from "./entities/entity";
+export * from "./entities/entity-events";
+export * from "./entities/entity-proxies";
+export * from "./entities/entity-queue";
+export * from "./entities/entity-repository";
+export * from "./entities/entity-scheduler";
+export * from "./entities/entity-snapshot";
+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 "./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/context/system-context-snapshot";
+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/json-serializer";
+export * from "./utils/performance-timer";
+export * from "./utils/types";

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,4DAAyC;AACzC,0DAAuC;AACvC,+DAA4C;AAC5C,8DAA2C;AAC3C,6DAA0C;AAE1C,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;AAC1D,4EAAyD;AAEzD,4EAAyD;AACzD,+EAA4D;AAE5D,uEAAoD;AACpD,oEAAiD;AACjD,iEAA8C;AAC9C,2DAAwC;AACxC,4DAAyC;AAEzC,0DAAuC;AACvC,4DAAyC;AACzC,gDAA6B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yDAAuC;AACvC,kEAAgD;AAEhD,oDAAkC;AAClC,2DAAyC;AACzC,4DAA0C;AAC1C,0DAAwC;AACxC,+DAA6C;AAC7C,8DAA4C;AAC5C,6DAA2C;AAE3C,8DAA4C;AAC5C,+DAA6C;AAC7C,8DAA4C;AAE5C,6DAA2C;AAC3C,2DAAyC;AACzC,2DAAyC;AAEzC,yDAAuC;AACvC,gEAA8C;AAC9C,8DAA4C;AAC5C,uDAAqC;AACrC,4DAA0C;AAE1C,0EAAwD;AACxD,2EAAyD;AACzD,8EAA4D;AAC5D,6EAA2D;AAC3D,4EAA0D;AAE1D,4EAA0D;AAC1D,+EAA6D;AAE7D,uEAAqD;AACrD,oEAAkD;AAClD,iEAA+C;AAC/C,2DAAyC;AACzC,4DAA0C;AAE1C,0DAAwC;AACxC,4DAA0C;AAC1C,gDAA8B"}

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

@@ -2,4 +2,4 @@ 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;
+export type MiddlewareResult = void | IRuntimeResult;

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

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

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

@@ -5,15 +5,61 @@ import { IEntityProxy } from "../../entities/entity-proxies";
  * The access is made in a SystemMiddleware through the provided ISystemPipelineContext.
  */
 export interface ISystemContextEvents {
+    /**
+     * Dispatches and schedules the Event to it's Subscribers or provided Entity Targets.
+     * @param data The EventData to dispatch.
+     * @param targets (optional) The Entities to send this event to. Providing this parameter will not broadcast this event.
+     */
     dispatchEvent<TEventData extends IEventData>(data: TEventData, ...targets: IEntityProxy[]): void;
+    /**
+     * Dispatches and schedules the Events to their Subscribers or provided Entity Targets.
+     * @param data The EventData Array to dispatch.
+     * @param targets (optional) The Entities to send this event to. Providing this parameter will not broadcast this event.
+     */
     dispatchEvents<TEventData extends IEventData>(data: TEventData[], ...targets: IEntityProxy[]): void;
+    /**
+     * Retrieves the Event with the given UID if it has been previously set on the current Context.
+     * @param uid The Event UID to retrieve.
+     */
     getEvent<TEventData extends IEventData>(uid: EntityEventUid): IEntityEvent<TEventData>;
+    /**
+     * Retrieves all the Events currently set on the Context.
+     */
     listEvents<TEventData extends IEventData>(): IEntityEvent<TEventData>[];
+    /**
+     * Returns whether the Event with the given UID has previously been set on the current Context.
+     * @param uid The Event UID to check for existence.
+     */
     hasEvent(uid?: EntityEventUid): boolean;
+    /**
+     * Subscribes to Events with the given UID. When the matching Event is dispatched,
+     * the Entity update loop will set this Event on the Pipeline Context.
+     * @param uid The Event UID to subscribe to.
+     * @param filter (optional) Provides a callback function that will be executed on all matching Events.
+     * Can be used to filter what Event to schedule through to the current Entity update.
+     */
     subscribeTo<TEventData extends IEventData>(uid: EntityEventUid, filter?: (event: IEntityEvent<TEventData>) => boolean): void;
+    /**
+     * Stops subscribing to Events with the given UID. The Entity will not receive any future Events with this UID.
+     * @param uid The Event UID to stop listening to.
+     */
     unsubscribeFrom(uid: EntityEventUid): void;
-    clearSubscriptions(uid?: EntityEventUid): void;
+    /**
+     * Adds the given Events into the Context instance.
+     * @param events The Event instances to be set on the Context.
+     */
     setContextEvents(events: IEntityEvent<IEventData>[]): void;
+    /**
+     * Adds the given Event into the Context instance.
+     * @param event The Event instance to be set on the Context.
+     */
     setContextEvent(event: IEntityEvent<IEventData>): void;
+    /**
+     * Removes all the Events currently set on the Context instance.
+     */
     clearContextEvents(): void;
+    /**
+     * Removes all the Event Subscriptions for the current Entity.
+     */
+    clearSubscriptions(): void;
 }

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

@@ -5,4 +5,4 @@ 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>>;
+export type ISystemsRuntimeMiddleware<TEntity extends IEntity> = IMiddleware<ISystemsRuntimeContext<TEntity>>;

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

@@ -5,4 +5,4 @@ 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>>;
+export type ISystemMiddleware<TEntity extends IEntity> = IMiddleware<ISystemPipelineContext<TEntity>>;

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

@@ -1,4 +1,4 @@
-export declare type PerformanceTimerUid = number;
+export type PerformanceTimerUid = number;
 export interface PerformanceTimeEntry {
     name: string;
     startedAt: number;

package/dist/utils/types.d.ts

@@ -1,18 +1,18 @@
-export declare type Mutable<T> = {
+export type Mutable<T> = {
     -readonly [K in keyof T]: T[K];
 };
-export declare type MutableDeep<T> = {
+export type MutableDeep<T> = {
     -readonly [K in keyof T]: Mutable<T[K]>;
 };
-declare type ImmutablePrimitive = undefined | null | boolean | string | number | Function;
-export declare type Immutable<T> = T extends ImmutablePrimitive ? T : T extends Array<infer U> ? ImmutableArray<U> : T extends Map<infer K, infer V> ? ImmutableMap<K, V> : T extends Set<infer M> ? ImmutableSet<M> : ImmutableObject<T>;
-export declare type ImmutableArray<T> = ReadonlyArray<Immutable<T>>;
-export declare type ImmutableMap<K, V> = ReadonlyMap<Immutable<K>, Immutable<V>>;
-export declare type ImmutableSet<T> = ReadonlySet<Immutable<T>>;
-export declare type ImmutableObject<T> = {
+type ImmutablePrimitive = undefined | null | boolean | string | number | Function;
+export type Immutable<T> = T extends ImmutablePrimitive ? T : T extends Array<infer U> ? ImmutableArray<U> : T extends Map<infer K, infer V> ? ImmutableMap<K, V> : T extends Set<infer M> ? ImmutableSet<M> : ImmutableObject<T>;
+export type ImmutableArray<T> = ReadonlyArray<Immutable<T>>;
+export type ImmutableMap<K, V> = ReadonlyMap<Immutable<K>, Immutable<V>>;
+export type ImmutableSet<T> = ReadonlySet<Immutable<T>>;
+export type ImmutableObject<T> = {
     readonly [K in keyof T]: T[K];
 };
-export declare type ImmutableObjectDeep<T> = {
+export type ImmutableObjectDeep<T> = {
     readonly [K in keyof T]: Immutable<T[K]>;
 };
 export {};

package/package.json

@@ -1,18 +1,19 @@
 {
   "name": "@awesome-ecs/abstract",
-  "version": "0.12.0",
+  "version": "0.13.1",
   "description": "A comprehensive Entity-Component-System (ECS) Architecture implementation. Abstract components.",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
     "dist"
   ],
-  "devDependencies": {
-    "typescript": "^4.8.2"
-  },
   "scripts": {
     "build": "rimraf ./dist && npx tsc --build"
   },
+  "devDependencies": {
+    "@types/node": "^18.11.18",
+    "typescript": "^4.9.5"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/andreicojocaru/awesome-ecs.git"
@@ -32,5 +33,5 @@
     "url": "https://github.com/andreicojocaru/awesome-ecs/issues"
   },
   "homepage": "https://github.com/andreicojocaru/awesome-ecs#readme",
-  "gitHead": "2b17c316d9799e4a04f7bb0e871ff305d59c95cc"
+  "gitHead": "f8f3bafbb56bf01e7e0f5603b915e7209fdd5c50"
 }