@awesome-ecs/abstract 0.20.1 → 0.20.2

package/dist/pipeline-D43CXxWG.d.ts

@@ -1,83 +0,0 @@
-import { P as PerformanceTimeEntry } from './performance-timer-XvdCbcAE.js';
-
-/**
- * The PipelineResult can provide Performance metrics collected from self or inner middleware & pipeline calls.
- */
-type PipelineResult = {
-    readonly performance?: PerformanceTimeEntry;
-    readonly inner?: PipelineResult[];
-};
-
-/**
- * The MiddlewareResult can provide Pipeline Results inner pipeline calls.
- */
-type MiddlewareResult = void | PipelineResult;
-
-/**
- * The PipelineStatus tracks the current status of the pipeline.
- */
-declare enum PipelineStatus {
-    idle = "idle",
-    ongoing = "ongoing",
-    completed = "completed",
-    halted = "halted"
-}
-
-/**
- * The Pipeline Context allows exposing state to the Pipeline's middlewares.
- */
-interface IPipelineContext {
-    readonly runtime: PipelineRuntime;
-}
-/**
- * The Pipeline Runtime exposes runtime status controls for Middlewares, as part of tbe PipelineContext.
- */
-type PipelineRuntime = {
-    shouldStop: boolean;
-    status?: PipelineStatus;
-};
-
-/**
- * A middleware, the building block of a Pipeline. The middlewares will provide a unit-of-work implementation
- * dealing with potential state changes over the input Context, or running cleanup logic over the input Context.
- */
-interface IMiddleware<TContext extends IPipelineContext, TResult = MiddlewareResult> {
-    readonly name?: string;
-    /**
-     * 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): 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.
-     */
-    action(context: TContext): TResult;
-    /**
-     * 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): TResult;
-}
-
-/**
- * An {@link IMiddleware} container and dispatcher.
- */
-interface IPipeline<TContext extends IPipelineContext, TResult = MiddlewareResult> {
-    readonly name?: string;
-    /**
-     * Register middleware for this pipeline.
-     */
-    use(middleware: IMiddleware<TContext, TResult>): this;
-    /**
-     * Execute the Dispatch on the chain of middleware, with the given Context.
-     */
-    dispatch(context: TContext): PipelineResult;
-    /**
-     * Execute the Cleanup on the chain of middleware, with the given Context.
-     */
-    cleanup(context: TContext): PipelineResult;
-}
-
-export { type IPipelineContext as I, type MiddlewareResult as M, type PipelineResult as P, type IPipeline as a, type IMiddleware as b, type PipelineRuntime as c, PipelineStatus as d };

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

@@ -1,162 +0,0 @@
-import { c as IEntity, I as IEntityProxy, E as EntityTypeUid, b as IEntityModel, d as EntityProxy } from './index-BPDsRt_F.js';
-import { f as IEntityUpdate, I as IEventData, E as EntityEventUid, b as IEntityEvent, i as IEntitySnapshot, h as IEntityRepository } from './entity-repository-BASmOrq7.js';
-import { I as IPipelineContext, a as IPipeline } from './pipeline-D43CXxWG.js';
-import { I as Immutable } from './types-BNwBqRWY.js';
-import { IJsonSerializer, ILogger } from './utils/index.js';
-
-interface ISystemContextEntity {
-    readonly entity: Immutable<IEntity>;
-    readonly update: Immutable<IEntityUpdate>;
-    setEntity(entity: IEntity): void;
-    setUpdate(update: IEntityUpdate): void;
-}
-
-/**
- * The ISystemContextEvents is the access point for Event related APIs.
- * The access is made in a SystemMiddleware through the provided ISystemPipelineContext.
- */
-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;
-    /**
-     * 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;
-}
-
-/**
- * The ISystemContextProxies is the access point for EntityProxy related APIs.
- * The access is made in a SystemMiddleware through the provided ISystemPipelineContext.
- */
-interface ISystemContextProxies {
-    registerProxy(proxy: IEntityProxy, cleanup?: boolean): void;
-    registerProxies(proxies: IEntityProxy[], cleanup?: boolean): void;
-    removeProxy(proxy: IEntityProxy): void;
-    removeProxies(proxyEntityType?: EntityTypeUid): void;
-}
-
-/**
- * The `ISystemContextRepository` is the access point for the `IEntityRepository` related APIs.
- *
- * The access is made in an `ISystemMiddleware` through the provided `ISystemPipelineContext`.
- */
-interface ISystemContextRepository {
-    addEntity(entityType: EntityTypeUid, model: IEntityModel, snapshot?: IEntitySnapshot): void;
-    getEntity<TEntity extends IEntity>(proxy: EntityProxy<TEntity>): Immutable<TEntity>;
-    updateEntity(target?: IEntityProxy): void;
-    removeEntity(target: IEntityProxy): void;
-}
-
-/**
- * The ISystemContextRepository is the access point for Scheduler related APIs.
- * The access is made in a SystemMiddleware through the provided ISystemPipelineContext.
- */
-interface ISystemContextScheduler {
-    scheduleUpdate(target?: IEntityProxy, intervalMs?: number): void;
-    removeSchedule(target?: IEntityProxy): void;
-}
-
-/**
- * The ISystemContextSnapshot is the access point for Snapshot related APIs.
- * The access is made in a SystemMiddleware through the provided ISystemPipelineContext.
- */
-interface ISystemContextSnapshot {
-    readonly serializer: Immutable<IJsonSerializer>;
-    applyToEntity(snapshot: IEntitySnapshot): void;
-    createFromEntity(entity?: IEntity): IEntitySnapshot;
-    dispatchToUpdate(snapshot: IEntitySnapshot, proxy?: IEntityProxy): void;
-}
-
-/**
- * The ISystemContext is the Context passed to a SystemMiddleware as part of the Pipeline Dispatch.
- * It's an abstraction layer so that the Middleware code won't have explicit dependencies on other parts of the ECS.
- *
- * Any State changes done by the SystemMiddleware are executed using the APIs provided by the ISystemContext.
- */
-interface ISystemContext<TEntity extends IEntity> extends IPipelineContext {
-    readonly deltaTimeMs: Immutable<number>;
-    readonly entity: Immutable<TEntity>;
-    readonly update: Immutable<IEntityUpdate>;
-    readonly events: Immutable<ISystemContextEvents>;
-    readonly proxies: Immutable<ISystemContextProxies>;
-    readonly repository: Immutable<ISystemContextRepository>;
-    readonly scheduler: Immutable<ISystemContextScheduler>;
-    readonly snapshot: Immutable<ISystemContextSnapshot>;
-    readonly logger: Immutable<ILogger>;
-}
-
-/**
- * The built-in ECS pipeline types. They can be extended to introduce more types, and the System Runtime Pipeline should
- * add Middleware to handle the newly added types.
- */
-declare enum SystemType {
-    initialize = "initialize",
-    update = "update",
-    render = "render",
-    sync = "sync"
-}
-
-/**
- * The ISystemsRuntimeContext is the Context passed by a SystemsRuntimePipeline.
- * It helps orchestrate the execution of SystemPipelines registered in the SystemsModule.
- */
-interface ISystemsRuntimeContext<TEntity extends IEntity> extends IPipelineContext {
-    readonly allowedSteps: Set<SystemType>;
-    readonly entityProvider: ISystemContextEntity;
-    readonly entityRepository: IEntityRepository;
-    readonly systemPipelines: Map<SystemType, IPipeline<ISystemContext<TEntity>>>;
-    readonly systemContext: ISystemContext<TEntity>;
-}
-
-export { type ISystemsRuntimeContext as I, SystemType as S, type ISystemContext as a, type ISystemContextEntity as b, type ISystemContextEvents as c, type ISystemContextProxies as d, type ISystemContextRepository as e, type ISystemContextScheduler as f, type ISystemContextSnapshot as g };

package/dist/systems-runtime-context-CpgxOdc8.d.cts

@@ -1,162 +0,0 @@
-import { c as IEntity, I as IEntityProxy, E as EntityTypeUid, b as IEntityModel, d as EntityProxy } from './index-DK2CXVZ8.cjs';
-import { f as IEntityUpdate, I as IEventData, E as EntityEventUid, b as IEntityEvent, i as IEntitySnapshot, h as IEntityRepository } from './entity-repository-DmfcUSrX.cjs';
-import { I as IPipelineContext, a as IPipeline } from './pipeline-BowCAITe.cjs';
-import { I as Immutable } from './types-BNwBqRWY.cjs';
-import { IJsonSerializer, ILogger } from './utils/index.cjs';
-
-interface ISystemContextEntity {
-    readonly entity: Immutable<IEntity>;
-    readonly update: Immutable<IEntityUpdate>;
-    setEntity(entity: IEntity): void;
-    setUpdate(update: IEntityUpdate): void;
-}
-
-/**
- * The ISystemContextEvents is the access point for Event related APIs.
- * The access is made in a SystemMiddleware through the provided ISystemPipelineContext.
- */
-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;
-    /**
-     * 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;
-}
-
-/**
- * The ISystemContextProxies is the access point for EntityProxy related APIs.
- * The access is made in a SystemMiddleware through the provided ISystemPipelineContext.
- */
-interface ISystemContextProxies {
-    registerProxy(proxy: IEntityProxy, cleanup?: boolean): void;
-    registerProxies(proxies: IEntityProxy[], cleanup?: boolean): void;
-    removeProxy(proxy: IEntityProxy): void;
-    removeProxies(proxyEntityType?: EntityTypeUid): void;
-}
-
-/**
- * The `ISystemContextRepository` is the access point for the `IEntityRepository` related APIs.
- *
- * The access is made in an `ISystemMiddleware` through the provided `ISystemPipelineContext`.
- */
-interface ISystemContextRepository {
-    addEntity(entityType: EntityTypeUid, model: IEntityModel, snapshot?: IEntitySnapshot): void;
-    getEntity<TEntity extends IEntity>(proxy: EntityProxy<TEntity>): Immutable<TEntity>;
-    updateEntity(target?: IEntityProxy): void;
-    removeEntity(target: IEntityProxy): void;
-}
-
-/**
- * The ISystemContextRepository is the access point for Scheduler related APIs.
- * The access is made in a SystemMiddleware through the provided ISystemPipelineContext.
- */
-interface ISystemContextScheduler {
-    scheduleUpdate(target?: IEntityProxy, intervalMs?: number): void;
-    removeSchedule(target?: IEntityProxy): void;
-}
-
-/**
- * The ISystemContextSnapshot is the access point for Snapshot related APIs.
- * The access is made in a SystemMiddleware through the provided ISystemPipelineContext.
- */
-interface ISystemContextSnapshot {
-    readonly serializer: Immutable<IJsonSerializer>;
-    applyToEntity(snapshot: IEntitySnapshot): void;
-    createFromEntity(entity?: IEntity): IEntitySnapshot;
-    dispatchToUpdate(snapshot: IEntitySnapshot, proxy?: IEntityProxy): void;
-}
-
-/**
- * The ISystemContext is the Context passed to a SystemMiddleware as part of the Pipeline Dispatch.
- * It's an abstraction layer so that the Middleware code won't have explicit dependencies on other parts of the ECS.
- *
- * Any State changes done by the SystemMiddleware are executed using the APIs provided by the ISystemContext.
- */
-interface ISystemContext<TEntity extends IEntity> extends IPipelineContext {
-    readonly deltaTimeMs: Immutable<number>;
-    readonly entity: Immutable<TEntity>;
-    readonly update: Immutable<IEntityUpdate>;
-    readonly events: Immutable<ISystemContextEvents>;
-    readonly proxies: Immutable<ISystemContextProxies>;
-    readonly repository: Immutable<ISystemContextRepository>;
-    readonly scheduler: Immutable<ISystemContextScheduler>;
-    readonly snapshot: Immutable<ISystemContextSnapshot>;
-    readonly logger: Immutable<ILogger>;
-}
-
-/**
- * The built-in ECS pipeline types. They can be extended to introduce more types, and the System Runtime Pipeline should
- * add Middleware to handle the newly added types.
- */
-declare enum SystemType {
-    initialize = "initialize",
-    update = "update",
-    render = "render",
-    sync = "sync"
-}
-
-/**
- * The ISystemsRuntimeContext is the Context passed by a SystemsRuntimePipeline.
- * It helps orchestrate the execution of SystemPipelines registered in the SystemsModule.
- */
-interface ISystemsRuntimeContext<TEntity extends IEntity> extends IPipelineContext {
-    readonly allowedSteps: Set<SystemType>;
-    readonly entityProvider: ISystemContextEntity;
-    readonly entityRepository: IEntityRepository;
-    readonly systemPipelines: Map<SystemType, IPipeline<ISystemContext<TEntity>>>;
-    readonly systemContext: ISystemContext<TEntity>;
-}
-
-export { type ISystemsRuntimeContext as I, SystemType as S, type ISystemContext as a, type ISystemContextEntity as b, type ISystemContextEvents as c, type ISystemContextProxies as d, type ISystemContextRepository as e, type ISystemContextScheduler as f, type ISystemContextSnapshot as g };

package/dist/types-BNwBqRWY.d.cts

@@ -1,22 +0,0 @@
-type BooleanProps<T> = {
-    [Property in keyof T]: boolean;
-};
-type Mutable<T> = {
-    -readonly [K in keyof T]: T[K];
-};
-type MutableDeep<T> = {
-    -readonly [K in keyof T]: Mutable<T[K]>;
-};
-type ImmutablePrimitive = undefined | null | boolean | string | number | Function;
-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>;
-type ImmutableArray<T> = ReadonlyArray<Immutable<T>>;
-type ImmutableMap<K, V> = ReadonlyMap<Immutable<K>, Immutable<V>>;
-type ImmutableSet<T> = ReadonlySet<Immutable<T>>;
-type ImmutableObject<T> = {
-    readonly [K in keyof T]: T[K];
-};
-type ImmutableObjectDeep<T> = {
-    readonly [K in keyof T]: Immutable<T[K]>;
-};
-
-export type { BooleanProps as B, Immutable as I, Mutable as M, MutableDeep as a, ImmutableArray as b, ImmutableMap as c, ImmutableSet as d, ImmutableObject as e, ImmutableObjectDeep as f };

package/dist/types-BNwBqRWY.d.ts

@@ -1,22 +0,0 @@
-type BooleanProps<T> = {
-    [Property in keyof T]: boolean;
-};
-type Mutable<T> = {
-    -readonly [K in keyof T]: T[K];
-};
-type MutableDeep<T> = {
-    -readonly [K in keyof T]: Mutable<T[K]>;
-};
-type ImmutablePrimitive = undefined | null | boolean | string | number | Function;
-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>;
-type ImmutableArray<T> = ReadonlyArray<Immutable<T>>;
-type ImmutableMap<K, V> = ReadonlyMap<Immutable<K>, Immutable<V>>;
-type ImmutableSet<T> = ReadonlySet<Immutable<T>>;
-type ImmutableObject<T> = {
-    readonly [K in keyof T]: T[K];
-};
-type ImmutableObjectDeep<T> = {
-    readonly [K in keyof T]: Immutable<T[K]>;
-};
-
-export type { BooleanProps as B, Immutable as I, Mutable as M, MutableDeep as a, ImmutableArray as b, ImmutableMap as c, ImmutableSet as d, ImmutableObject as e, ImmutableObjectDeep as f };