@awesome-ecs/abstract 0.5.4 → 0.7.0

package/dist/components/component.js

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

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

@@ -1,19 +1,19 @@
-import { IComponent } from "./component";
-import { EntityTypeUid, IEntityModel } from "../entities/entity";
-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 {
-    /**
-     * 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;
-}
+import { IComponent } from "./component";
+import { EntityTypeUid, IEntityModel } from "../entities/entity";
+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 {
+    /**
+     * 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;
+}

package/dist/components/identity-component.js

@@ -1,8 +1,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BasicComponentType = void 0;
-var BasicComponentType;
-(function (BasicComponentType) {
-    BasicComponentType["identity"] = "identity";
-})(BasicComponentType = exports.BasicComponentType || (exports.BasicComponentType = {}));
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BasicComponentType = void 0;
+var BasicComponentType;
+(function (BasicComponentType) {
+    BasicComponentType["identity"] = "identity";
+})(BasicComponentType = exports.BasicComponentType || (exports.BasicComponentType = {}));
 //# sourceMappingURL=identity-component.js.map

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

@@ -1,37 +1,37 @@
-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;
-}
-/**
- * The EntityEventsDispatcher is the main access point for dispatching events to Entities.
- *
- * It can leverage the IEntityEvents manager to find Subscribers, and the IEntityUpdateQueue to register events
- * into the Entity's next update.
- */
-export interface IEntityEventsDispatcher {
-    dispatchEvent(event: IEntityEvent<IEventData>, ...targets: IEntityProxy[]): void;
-    dispatchEvents(events: IEntityEvent<IEventData>[], ...targets: IEntityProxy[]): void;
-}
+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;
+}
+/**
+ * The EntityEventsDispatcher is the main access point for dispatching events to Entities.
+ *
+ * It can leverage the IEntityEvents manager to find Subscribers, and the IEntityUpdateQueue to register events
+ * into the Entity's next update.
+ */
+export interface IEntityEventsDispatcher {
+    dispatchEvent(event: IEntityEvent<IEventData>, ...targets: IEntityProxy[]): void;
+    dispatchEvents(events: IEntityEvent<IEventData>[], ...targets: IEntityProxy[]): void;
+}

package/dist/entities/entity-events.js

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

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

@@ -1,14 +1,14 @@
-import { EntityTypeUid, EntityUid, IEntity } from "./entity";
-/**
- * Represents a pointer to another Entity.
- */
-export interface IEntityProxy {
-    readonly entityType: EntityTypeUid;
-    readonly entityUid: EntityUid;
-}
-/**
- * A utility extension of IEntityProxy.
- * Useful for providing Type information when using the IEntityProxy.
- */
-export interface EntityProxy<TEntity extends IEntity> extends IEntityProxy {
-}
+import { EntityTypeUid, EntityUid, IEntity } from "./entity";
+/**
+ * Represents a pointer to another Entity.
+ */
+export interface IEntityProxy {
+    readonly entityType: EntityTypeUid;
+    readonly entityUid: EntityUid;
+}
+/**
+ * A utility extension of IEntityProxy.
+ * Useful for providing Type information when using the IEntityProxy.
+ */
+export interface EntityProxy<TEntity extends IEntity> extends IEntityProxy {
+}

package/dist/entities/entity-proxy.js

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

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

@@ -1,30 +1,30 @@
-import { IEntityModel } from "./entity";
-import { IEntityEvent, IEventData } from "./entity-events";
-import { IEntityProxy } from "./entity-proxy";
-/**
- * The Entity update state for this change.
- */
-export declare enum EntityUpdateType {
-    update = "update",
-    remove = "remove"
-}
-/**
- * Represents an Entity update that should be applied over an (existing) Entity.
- */
-export interface IEntityUpdate {
-    type: EntityUpdateType;
-    entity: IEntityProxy;
-    model?: IEntityModel;
-    events?: IEntityEvent<IEventData>[];
-}
-/**
- * The Entity Updates will be queued up, and can be picked up in order.
- * The interface can be implemented using a simple queue mechanism, or perhaps, a Priority Queue.
- */
-export interface IEntityUpdateQueue {
-    readonly size: number;
-    enqueue(change: IEntityUpdate): void;
-    dequeue(): IEntityUpdate;
-    peek(): IEntityUpdate;
-    clear(): void;
-}
+import { IEntityModel } from "./entity";
+import { IEntityEvent, IEventData } from "./entity-events";
+import { IEntityProxy } from "./entity-proxy";
+/**
+ * The Entity update state for this change.
+ */
+export declare enum EntityUpdateType {
+    update = "update",
+    remove = "remove"
+}
+/**
+ * Represents an Entity update that should be applied over an (existing) Entity.
+ */
+export interface IEntityUpdate {
+    type: EntityUpdateType;
+    entity: IEntityProxy;
+    model?: IEntityModel;
+    events?: IEntityEvent<IEventData>[];
+}
+/**
+ * The Entity Updates will be queued up, and can be picked up in order.
+ * The interface can be implemented using a simple queue mechanism, or perhaps, a Priority Queue.
+ */
+export interface IEntityUpdateQueue {
+    readonly size: number;
+    enqueue(change: IEntityUpdate): void;
+    dequeue(): IEntityUpdate;
+    peek(): IEntityUpdate;
+    clear(): void;
+}

package/dist/entities/entity-queue.js

@@ -1,12 +1,12 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EntityUpdateType = void 0;
-/**
- * The Entity update state for this change.
- */
-var EntityUpdateType;
-(function (EntityUpdateType) {
-    EntityUpdateType["update"] = "update";
-    EntityUpdateType["remove"] = "remove";
-})(EntityUpdateType = exports.EntityUpdateType || (exports.EntityUpdateType = {}));
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EntityUpdateType = void 0;
+/**
+ * The Entity update state for this change.
+ */
+var EntityUpdateType;
+(function (EntityUpdateType) {
+    EntityUpdateType["update"] = "update";
+    EntityUpdateType["remove"] = "remove";
+})(EntityUpdateType = exports.EntityUpdateType || (exports.EntityUpdateType = {}));
 //# sourceMappingURL=entity-queue.js.map

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

@@ -1,23 +1,24 @@
-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.
- */
-export interface IEntityRepository {
-    has(type: EntityTypeUid, uid: EntityUid): boolean;
-    get<TEntity extends IEntity>(type: EntityTypeUid, uid: EntityUid): TEntity;
-    getWithTime<TEntity extends IEntity>(type: EntityTypeUid, uid: EntityUid): StoredEntity<TEntity>;
-    getAll<TEntity extends IEntity>(type: EntityTypeUid): TEntity[];
-    set(entity: IEntity): void;
-    delete(type: EntityTypeUid, uid: EntityUid): void;
-    clear(entityType: EntityTypeUid): void;
-    onEntitySetCallback?: (entity: IEntity) => void;
-    onEntityDeletedCallback?: (entity: IEntity) => void;
-}
+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.
+ */
+export interface IEntityRepository {
+    has(type: EntityTypeUid, uid: EntityUid): boolean;
+    get<TEntity extends IEntity>(type: EntityTypeUid, uid: EntityUid): TEntity;
+    getWithTime<TEntity extends IEntity>(type: EntityTypeUid, uid: EntityUid): StoredEntity<TEntity>;
+    getAll<TEntity extends IEntity>(type: EntityTypeUid): TEntity[];
+    listAll(): StoredEntity<IEntity>[];
+    set(entity: IEntity): void;
+    delete(type: EntityTypeUid, uid: EntityUid): void;
+    clear(entityType: EntityTypeUid): void;
+    onEntitySetCallback?: (entity: IEntity) => void;
+    onEntityDeletedCallback?: (entity: IEntity) => void;
+}

package/dist/entities/entity-repository.js

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

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

@@ -1,11 +1,11 @@
-import { IEntityProxy } from "./entity-proxy";
-/**
- * The Entity Scheduler is the main way of scheduling Entity Updates on a Time Interval.
- * It usually reads the Entities from the Entity Repository,
- * and uses the Entity Update Queue to enqueue Entity updates.
- */
-export interface IEntityScheduler {
-    schedule(entityProxy: IEntityProxy, intervalMs?: number): void;
-    remove(entityProxy: IEntityProxy): void;
-    has(entityProxy: IEntityProxy): boolean;
-}
+import { IEntityProxy } from "./entity-proxy";
+/**
+ * The Entity Scheduler is the main way of scheduling Entity Updates on a Time Interval.
+ * It usually reads the Entities from the Entity Repository,
+ * and uses the Entity Update Queue to enqueue Entity updates.
+ */
+export interface IEntityScheduler {
+    schedule(entityProxy: IEntityProxy, intervalMs?: number): void;
+    remove(entityProxy: IEntityProxy): void;
+    has(entityProxy: IEntityProxy): boolean;
+}

package/dist/entities/entity-scheduler.js

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

package/dist/entities/entity.d.ts

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

package/dist/entities/entity.js

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

package/dist/index.d.ts

@@ -1,16 +1,16 @@
-export * from './components/component';
-export * from './components/identity-component';
-export * from './entities/entity';
-export * from './entities/entity-events';
-export * from './entities/entity-proxy';
-export * from './entities/entity-queue';
-export * from './entities/entity-repository';
-export * from './entities/entity-scheduler';
-export * from './pipelines/middleware';
-export * from './pipelines/pipeline';
-export * from './systems/system-middleware';
-export * from './systems/systems-module';
-export * from './systems/system-pipeline-context';
-export * from './systems/system-pipeline-type';
-export * from './systems/systems-runtime';
-export * from './utils/performance-timer';
+export * from './components/component';
+export * from './components/identity-component';
+export * from './entities/entity';
+export * from './entities/entity-events';
+export * from './entities/entity-proxy';
+export * from './entities/entity-queue';
+export * from './entities/entity-repository';
+export * from './entities/entity-scheduler';
+export * from './pipelines/middleware';
+export * from './pipelines/pipeline';
+export * from './systems/system-middleware';
+export * from './systems/systems-module';
+export * from './systems/system-pipeline-context';
+export * from './systems/system-pipeline-type';
+export * from './systems/systems-runtime';
+export * from './utils/performance-timer';

package/dist/index.js

@@ -1,33 +1,33 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = 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];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-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-events"), 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("./pipelines/middleware"), exports);
-__exportStar(require("./pipelines/pipeline"), exports);
-__exportStar(require("./systems/system-middleware"), exports);
-__exportStar(require("./systems/systems-module"), exports);
-__exportStar(require("./systems/system-pipeline-context"), exports);
-__exportStar(require("./systems/system-pipeline-type"), exports);
-__exportStar(require("./systems/systems-runtime"), exports);
-__exportStar(require("./utils/performance-timer"), exports);
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = 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];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+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-events"), 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("./pipelines/middleware"), exports);
+__exportStar(require("./pipelines/pipeline"), exports);
+__exportStar(require("./systems/system-middleware"), exports);
+__exportStar(require("./systems/systems-module"), exports);
+__exportStar(require("./systems/system-pipeline-context"), exports);
+__exportStar(require("./systems/system-pipeline-type"), exports);
+__exportStar(require("./systems/systems-runtime"), exports);
+__exportStar(require("./utils/performance-timer"), exports);
 //# sourceMappingURL=index.js.map

package/dist/pipelines/middleware.d.ts

@@ -1,26 +1,26 @@
-/**
- * 'Stop' function, passed to a middleware. Call it to break the pipeline execution.
- */
-export declare type Stop = () => void;
-/**
- * A middleware, the building block of a Pipeline. The middlewares will get called in the same order they get registered in the Pipeline.
- */
-export interface IMiddleware<TContext> {
-    /**
-     * This (optional) function gets called before executing the middleware. It acts as a boolean gateway whether enough conditions are
-     * being met so this middleware's action should run.
-     * @param context The Context to determine whether the run condition is satisfied.
-     */
-    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.
-     * @param stop The function to halt the execution of the Pipeline. The next Middlewares won't be called anymore.
-     */
-    action(context: TContext, stop: Stop): Promise<void> | void;
-    /**
-     * 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;
-}
+/**
+ * 'Stop' function, passed to a middleware. Call it to break the pipeline execution.
+ */
+export declare type Stop = () => void;
+/**
+ * A middleware, the building block of a Pipeline. The middlewares will get called in the same order they get registered in the Pipeline.
+ */
+export interface IMiddleware<TContext> {
+    /**
+     * This (optional) function gets called before executing the middleware. It acts as a boolean gateway whether enough conditions are
+     * being met so this middleware's action should run.
+     * @param context The Context to determine whether the run condition is satisfied.
+     */
+    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.
+     * @param stop The function to halt the execution of the Pipeline. The next Middlewares won't be called anymore.
+     */
+    action(context: TContext, stop: Stop): Promise<void> | void;
+    /**
+     * 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/middleware.js

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

package/dist/pipelines/pipeline.d.ts

@@ -1,18 +1,27 @@
-import { IMiddleware } from "./middleware";
-/**
- * A middleware container and dispatcher.
- */
-export interface IPipeline<TContext> {
-    /**
-     * Register middlewares for this pipeline, in order.
-     */
-    use(...mw: IMiddleware<TContext>[]): void;
-    /**
-     * Execute the chain of middlewares, in the order they were added on a given Context.
-     */
-    dispatch(context: TContext): boolean;
-    /**
-     * Runs the Cleanup function on all middlewares.
-     */
-    cleanup(context: TContext): void;
-}
+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.
+ */
+export interface IPipeline<TContext> {
+    /**
+     * Register middlewares for this pipeline, in order.
+     */
+    use(...middleware: IMiddleware<TContext>[]): void;
+    /**
+     * Execute the chain of middlewares, in the order they were added on a given Context.
+     */
+    dispatch(context: TContext): IPipelineResult | Promise<IPipelineResult>;
+    /**
+     * Runs the Cleanup function on all middlewares.
+     */
+    cleanup(context: TContext): IPipelineResult | Promise<IPipelineResult>;
+}

package/dist/pipelines/pipeline.js

@@ -1,3 +1,9 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"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"}