@awesome-ecs/abstract 0.28.0 → 0.30.0

package/dist/index-DeYfvKO0.d.mts

@@ -1,224 +0,0 @@
-import { n as Immutable } from "./types-CnDtpKsY.mjs";
-import { r as PerformanceTimeEntry } from "./index-hHkhvmkO.mjs";
-
-//#region src/pipelines/pipeline-context.d.ts
-/**
- * Base interface for all pipeline context objects.
- * Provides hooks for runtime state and control flow during pipeline execution.
- */
-interface IPipelineContext {
-  /**
-   * The runtime state and control interface for the pipeline.
-   * Allows middleware to query and influence pipeline behavior.
-   */
-  readonly runtime?: PipelineRuntime;
-}
-/**
- * Runtime state and control interface for pipeline execution.
- * Allows middleware to query status and influence pipeline flow.
- */
-type PipelineRuntime = {
-  /**
-   * Flag to request pipeline halt.
-   * Set to true to stop executing remaining middleware (cleanup still runs).
-   */
-  shouldStop?: boolean;
-  /**
-   * Optional error state if an exception occurred during execution.
-   */
-  error?: any;
-  /**
-   * Results collected from middleware execution.
-   * Typically includes performance metrics and operational results.
-   */
-  readonly metrics?: PerformanceTimeEntry[];
-};
-//#endregion
-//#region src/pipelines/middleware.d.ts
-/**
- * The basic unit of work in a pipeline.
- * Middleware are chained together to form processing pipelines.
- * Each middleware can inspect/modify context during dispatch and perform cleanup on their changes.
- *
- * @template TContext The context type passed through the middleware chain.
- */
-interface IMiddleware<TContext extends IPipelineContext> {
-  /**
-   * Optional name for debugging and logging purposes.
-   */
-  readonly name?: string;
-  /**
-   * Optional guard condition before running the action.
-   * Allows middleware to skip execution based on context state.
-   * @param context The current pipeline context.
-   * @returns True to execute action, false to skip.
-   */
-  shouldRun?(context: TContext): boolean;
-  /**
-   * The main unit of work executed as part of the pipeline.
-   * Middlewares execute in registration order during dispatch phase.
-   * Can read and modify the context to influence downstream middleware and results.
-   * @param context The pipeline context containing all relevant state.
-   */
-  action(context: TContext): void | Promise<void>;
-  /**
-   * Optional cleanup function executed during pipeline teardown.
-   * Middlewares execute in reverse registration order during cleanup phase.
-   * Used to release resources, clear temporary state, and perform final operations.
-   * @param context The pipeline context (may be in modified state from action phases).
-   */
-  cleanup?(context: TContext): void | Promise<void>;
-}
-//#endregion
-//#region src/pipelines/middleware-runner.d.ts
-/**
- * Customizes how middleware is executed within a pipeline.
- * Allows decorators to wrap, intercept, or modify middleware execution behavior.
- * Useful for implementing middleware decorators (logging, timing, error handling, etc.).
- *
- * @template TContext The type of context passed to middleware.
- */
-interface IMiddlewareRunner<TContext extends IPipelineContext> {
-  /**
-   * Decides how to execute a middleware's action.
-   * Can add pre/post processing, error handling, or performance tracking around the middleware.
-   * @param context The current pipeline context.
-   * @param middleware The middleware whose action should be executed.
-   */
-  dispatch(context: TContext, middleware: IMiddleware<TContext>): void | Promise<void>;
-  /**
-   * Decides how to execute a middleware's cleanup.
-   * Can add pre/post processing or error handling around cleanup operations.
-   * @param context The current pipeline context.
-   * @param middleware The middleware whose cleanup should be executed.
-   */
-  cleanup(context: TContext, middleware: IMiddleware<TContext>): void | Promise<void>;
-}
-//#endregion
-//#region src/pipelines/pipeline.d.ts
-/**
- * A composable middleware chain for ordered execution of operations.
- * Pipelines provide a framework for registering and executing middleware with dispatch and cleanup phases.
- * Used throughout the ECS system for entity initialization, updates, rendering, and synchronization.
- *
- * @template TContext - The context type passed to all registered middleware.
- */
-interface IPipeline<TContext extends IPipelineContext> {
-  /**
-   * The pipeline's name, useful for debugging and logging.
-   */
-  readonly name?: string;
-  /**
-   * The number of middleware currently registered in this pipeline.
-   */
-  readonly length?: number;
-  /**
-   * Direct access to the ordered list of registered middleware.
-   * Allows inspection of the execution chain.
-   */
-  readonly middleware?: Immutable<IMiddleware<TContext>[]>;
-  /**
-   * Registers middleware to be executed as part of this pipeline.
-   * Middleware is added to the end of the chain and executed in registration order during dispatch.
-   * @param middleware - The middleware to register.
-   * @returns This instance for method chaining.
-   */
-  use(middleware: Immutable<IMiddleware<TContext>>): this;
-  /**
-   * Executes the dispatch phase with all registered middleware in order.
-   * Each middleware's action is called, allowing modifications to context state.
-   * Execution continues until all middleware complete or a middleware requests early termination.
-   * @param context - The context object passed to all middleware.
-   */
-  dispatch(context: Partial<TContext>): void | Promise<void>;
-  /**
-   * Executes the cleanup phase with all registered middleware in reverse order.
-   * Allows middleware to perform resource cleanup and final operations.
-   * Typically called after dispatch to ensure proper teardown.
-   *
-   * @param context - The context object that will be passed to each middleware function.
-   */
-  cleanup(context: Partial<TContext>): void | Promise<void>;
-}
-//#endregion
-//#region src/pipelines/pipeline-nested.d.ts
-/**
- * Context for a parent pipeline containing nested pipelines.
- * Allows coordination between outer and inner pipeline execution.
- *
- * @template N - The context type for the nested pipelines.
- */
-interface IParentContext<N extends IPipelineContext> extends IPipelineContext {
-  /**
-   * The nested pipeline to execute for each context in nestedContexts.
-   */
-  readonly nestedPipeline: IPipeline<INestedContext<this>>;
-  /**
-   * Contexts to pass to the nested pipeline.
-   * The parent pipeline iterates these and executes the nested pipeline for each.
-   */
-  readonly nestedContexts: Partial<N>[];
-}
-/**
- * Context for a nested pipeline.
- * Provides access to both current and previous nested context data plus the parent context.
- *
- * @template P - The context type of the parent pipeline.
- */
-interface INestedContext<P extends IParentContext<any>> extends IPipelineContext {
-  /**
-   * The current context item being processed in the nested pipeline.
-   */
-  readonly current: P extends IParentContext<infer N> ? N : never;
-  /**
-   * The previous context item (if this is not the first iteration).
-   */
-  readonly previous?: P extends IParentContext<infer N> ? N : never;
-  /**
-   * Reference back to the parent pipeline context.
-   */
-  readonly parent: P;
-}
-/**
- * Middleware executing within a nested pipeline.
- *
- * @template P - The context type of the parent pipeline.
- */
-type INestedMiddleware<P extends IParentContext<any>> = IMiddleware<INestedContext<P>>;
-/**
- * Middleware executing within a parent pipeline (containing nested pipelines).
- *
- * @template P - The context type of the parent pipeline.
- */
-type IParentMiddleware<P extends IParentContext<any>> = IMiddleware<P>;
-//#endregion
-//#region src/pipelines/pipeline-runner.d.ts
-/**
- * Executes an array of middleware in a controlled sequence.
- * Supports custom execution strategies through implementation flexibility.
- * Used by pipelines to manage complex middleware chains with features like early termination and nested pipelines.
- *
- * @template TContext - The context type passed to all middleware.
- */
-interface IPipelineRunner<TContext extends IPipelineContext> {
-  /**
-   * Executes the action phase of all middleware in sequence.
-   * Middleware at startIndex and onward are executed in order.
-   * Execution may terminate early if middleware requests it via context.runtime.shouldStop.
-   * @param context - The context passed to each middleware action.
-   * @param middleware - The ordered middleware array to execute.
-   * @param startIndex - Optional starting position in the middleware array (default: 0).
-   */
-  dispatch(context: Partial<TContext>, middleware: IMiddleware<TContext>[], startIndex?: number): void | Promise<void>;
-  /**
-   * Executes the cleanup phase of all middleware in reverse order.
-   * All middleware cleanup functions are called (if defined), regardless of errors.
-   * Allows proper resource release and final state management.
-   * @param context - The context passed to each middleware cleanup.
-   * @param middleware - The ordered middleware array for cleanup (reversed during execution).
-   */
-  cleanup(context: Partial<TContext>, middleware: IMiddleware<TContext>[]): void | Promise<void>;
-}
-//#endregion
-export { IParentMiddleware as a, IMiddleware as c, IParentContext as i, IPipelineContext as l, INestedContext as n, IPipeline as o, INestedMiddleware as r, IMiddlewareRunner as s, IPipelineRunner as t, PipelineRuntime as u };
-//# sourceMappingURL=index-DeYfvKO0.d.mts.map

package/dist/index-hHkhvmkO.d.mts

@@ -1,175 +0,0 @@
-//#region src/utils/dispatch-sequential.d.ts
-/**
- * Executes a function for each item in an iterable, sequentially.
- *
- * Uses a sync fast-path: iterates synchronously until the first Promise is
- * encountered, then switches to async for the remainder. If no item produces
- * a Promise, the entire call stays synchronous with zero async overhead.
- *
- * @param items - The iterable to iterate over.
- * @param fn - The function to call for each item. May return void or a Promise.
- * @returns void if all calls were synchronous, or a Promise if any were async.
- */
-declare function dispatchSequential<T>(items: Iterable<T>, fn: (item: T) => void | Promise<void>): void | Promise<void>;
-//#endregion
-//#region src/utils/json-serializer.d.ts
-/**
- * Custom JSON serialization and deserialization interface.
- * Allows different serialization strategies for handling complex types.
- * Used for entity snapshots, events, and any data needing JSON conversion.
- */
-interface IJsonSerializer {
-  /**
-   * Converts an object to a serializable JSON representation.
-   * Handles types that don't serialize naturally (dates, maps, custom objects, etc.).
-   * @param value - The object to serialize.
-   * @returns A JSON-serializable representation.
-   */
-  serializeCustom(value: object): string;
-  /**
-   * Converts a JSON string back to its original object type.
-   * Reconstructs complex types from their serialized form.
-   * @template TObject - The target object type.
-   * @param text - The JSON string to deserialize.
-   * @returns The deserialized object of the specified type.
-   */
-  parseCustom<TObject>(text: string): TObject;
-}
-//#endregion
-//#region src/utils/logger.d.ts
-/**
- * Logger interface for debug and diagnostic output.
- * Supports multiple log levels for controlling verbosity.
- * Implementations can target different outputs (console, file, remote, etc.).
- */
-interface ILogger {
-  /**
-   * Logs a message with a specified severity level.
-   * @param level - The severity level of the message.
-   * @param message - The primary message content.
-   * @param args - Additional arguments to include in the log output.
-   */
-  log(level: LogLevel, message: any, ...args: any[]): void;
-  /**
-   * Logs detailed diagnostic information.
-   * Typically the lowest level, most verbose output.
-   * @param message - The message to log.
-   * @param args - Additional data.
-   */
-  trace(message: any, ...args: any[]): void;
-  /**
-   * Logs debug-level information.
-   * Useful during development and troubleshooting.
-   * @param message - The message to log.
-   * @param args - Additional data.
-   */
-  debug(message: any, ...args: any[]): void;
-  /**
-   * Logs warning-level messages.
-   * Indicates potentially problematic conditions.
-   * @param message - The message to log.
-   * @param args - Additional data.
-   */
-  warn(message: any, ...args: any[]): void;
-  /**
-   * Logs error-level messages.
-   * Indicates error conditions that may require attention.
-   * @param message - The message to log.
-   * @param args - Additional data.
-   */
-  error(message: any, ...args: any[]): void;
-}
-/**
- * Logging severity levels in increasing order.
- */
-declare enum LogLevel {
-  /**
-   * Most detailed, diagnostic-level logging.
-   */
-  trace = 0,
-  /**
-   * Development and debugging information.
-   */
-  debug = 1,
-  /**
-   * Warning-level conditions.
-   */
-  warn = 2,
-  /**
-   * Error-level conditions.
-   */
-  error = 3
-}
-/**
- * Configuration options for logger instances.
- */
-interface ILoggerOptions {
-  /**
-   * Enables/disables each log level.
-   * If a level is disabled, log calls at that level are ignored.
-   */
-  enabled: Map<LogLevel, boolean>;
-}
-//#endregion
-//#region src/utils/performance-timer.d.ts
-/**
- * Unique identifier for a timer instance.
- */
-type PerformanceTimerUid = number;
-/**
- * Options for identifying and categorizing performance metrics.
- * Used by pipeline factories and performance decorators.
- */
-type PerformanceMetricOptions = {
-  name?: string;
-  category?: string;
-};
-/**
- * Record of a completed timer measurement.
- * Captures timing information for performance analysis and profiling.
- */
-interface PerformanceTimeEntry {
-  /**
-   * The name identifying this timer.
-   */
-  name: string;
-  /**
-   * The category of this metric (e.g. 'module', 'runtime', 'system').
-   */
-  category?: string;
-  /**
-   * Timestamp in milliseconds when the timer started.
-   */
-  startedAt: number;
-  /**
-   * Timestamp in milliseconds when the timer ended.
-   */
-  endedAt?: number;
-  /**
-   * Duration in milliseconds that elapsed.
-   */
-  msPassed?: number;
-}
-/**
- * Interface for measuring operation duration.
- * Provides start/stop functionality for performance profiling.
- * Used throughout the system to collect timing metrics.
- */
-interface IPerformanceTimer {
-  /**
-   * Starts a new timer.
-   * @param name - Label for this timer (used in results).
-   * @param category - Optional category for grouping metrics.
-   * @returns A unique identifier for this timer instance.
-   */
-  startTimer(name: string, category?: string): PerformanceTimerUid;
-  /**
-   * Stops a timer and returns the recorded metrics.
-   * @param timerUid - The timer identifier returned by startTimer.
-   * @returns Complete timing entry with start, end, and duration.
-   */
-  endTimer(timerUid: PerformanceTimerUid): PerformanceTimeEntry;
-}
-//#endregion
-export { ILogger as a, IJsonSerializer as c, PerformanceTimerUid as i, dispatchSequential as l, PerformanceMetricOptions as n, ILoggerOptions as o, PerformanceTimeEntry as r, LogLevel as s, IPerformanceTimer as t };
-//# sourceMappingURL=index-hHkhvmkO.d.mts.map

package/dist/types-CnDtpKsY.d.mts

@@ -1,70 +0,0 @@
-//#region src/utils/types.d.ts
-/**
- * Maps all properties of a type to boolean flags.
- * Useful for feature flags, capability indicators, or boolean option sets.
- *
- * @template T - The type whose properties are mapped to booleans.
- * @example type Features = BooleanProps<{health: any; armor: any}>; // => {health: boolean, armor: boolean}
- */
-type BooleanProps<T> = { [Property in keyof T]: boolean };
-/**
- * Removes readonly modifiers from all properties, making them mutable.
- * One level of immutability removal (see MutableDeep for recursive removal).
- *
- * @template T - The type to make mutable.
- * @example type Mut = Mutable<{readonly x: number}>; // => {x: number}
- */
-type Mutable<T> = { -readonly [K in keyof T]: T[K] };
-/**
- * Recursively removes readonly modifiers from all properties at all nesting levels.
- * Makes entire object graph mutable.
- *
- * @template T - The type to make mutable recursively.
- */
-type MutableDeep<T> = { -readonly [K in keyof T]: Mutable<T[K]> };
-type ImmutablePrimitive = undefined | null | boolean | string | number | Function;
-/**
- * Makes a type fully immutable at the top level only.
- * Primitives and functions remain unchanged.
- * Collections (Array, Map, Set) become readonly.
- * Objects have their properties made readonly.
- *
- * @template T - The type to make immutable.
- * @example type Imm = Immutable<{x: number}>; // => {readonly x: number}
- */
-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>;
-/**
- * Readonly array variant for use in Immutable type transformation.
- *
- * @template T - Element type of the array.
- */
-type ImmutableArray<T> = ReadonlyArray<Immutable<T>>;
-/**
- * Readonly map variant for use in Immutable type transformation.
- *
- * @template K - Key type of the map.
- * @template V - Value type of the map.
- */
-type ImmutableMap<K, V> = ReadonlyMap<Immutable<K>, Immutable<V>>;
-/**
- * Readonly set variant for use in Immutable type transformation.
- *
- * @template T - Element type of the set.
- */
-type ImmutableSet<T> = ReadonlySet<Immutable<T>>;
-/**
- * Makes all object properties readonly (one level only).
- *
- * @template T - The type to make immutable.
- */
-type ImmutableObject<T> = { readonly [K in keyof T]: T[K] };
-/**
- * Recursively makes all properties readonly at all nesting levels.
- * Provides complete immutability guarantee for the entire object graph.
- *
- * @template T - The type to make deeply immutable.
- */
-type ImmutableObjectDeep<T> = { readonly [K in keyof T]: Immutable<T[K]> };
-//#endregion
-export { ImmutableObject as a, Mutable as c, ImmutableMap as i, MutableDeep as l, Immutable as n, ImmutableObjectDeep as o, ImmutableArray as r, ImmutableSet as s, BooleanProps as t };
-//# sourceMappingURL=types-CnDtpKsY.d.mts.map

package/dist/types-DLOd2zXO.d.cts

@@ -1,70 +0,0 @@
-//#region src/utils/types.d.ts
-/**
- * Maps all properties of a type to boolean flags.
- * Useful for feature flags, capability indicators, or boolean option sets.
- *
- * @template T - The type whose properties are mapped to booleans.
- * @example type Features = BooleanProps<{health: any; armor: any}>; // => {health: boolean, armor: boolean}
- */
-type BooleanProps<T> = { [Property in keyof T]: boolean };
-/**
- * Removes readonly modifiers from all properties, making them mutable.
- * One level of immutability removal (see MutableDeep for recursive removal).
- *
- * @template T - The type to make mutable.
- * @example type Mut = Mutable<{readonly x: number}>; // => {x: number}
- */
-type Mutable<T> = { -readonly [K in keyof T]: T[K] };
-/**
- * Recursively removes readonly modifiers from all properties at all nesting levels.
- * Makes entire object graph mutable.
- *
- * @template T - The type to make mutable recursively.
- */
-type MutableDeep<T> = { -readonly [K in keyof T]: Mutable<T[K]> };
-type ImmutablePrimitive = undefined | null | boolean | string | number | Function;
-/**
- * Makes a type fully immutable at the top level only.
- * Primitives and functions remain unchanged.
- * Collections (Array, Map, Set) become readonly.
- * Objects have their properties made readonly.
- *
- * @template T - The type to make immutable.
- * @example type Imm = Immutable<{x: number}>; // => {readonly x: number}
- */
-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>;
-/**
- * Readonly array variant for use in Immutable type transformation.
- *
- * @template T - Element type of the array.
- */
-type ImmutableArray<T> = ReadonlyArray<Immutable<T>>;
-/**
- * Readonly map variant for use in Immutable type transformation.
- *
- * @template K - Key type of the map.
- * @template V - Value type of the map.
- */
-type ImmutableMap<K, V> = ReadonlyMap<Immutable<K>, Immutable<V>>;
-/**
- * Readonly set variant for use in Immutable type transformation.
- *
- * @template T - Element type of the set.
- */
-type ImmutableSet<T> = ReadonlySet<Immutable<T>>;
-/**
- * Makes all object properties readonly (one level only).
- *
- * @template T - The type to make immutable.
- */
-type ImmutableObject<T> = { readonly [K in keyof T]: T[K] };
-/**
- * Recursively makes all properties readonly at all nesting levels.
- * Provides complete immutability guarantee for the entire object graph.
- *
- * @template T - The type to make deeply immutable.
- */
-type ImmutableObjectDeep<T> = { readonly [K in keyof T]: Immutable<T[K]> };
-//#endregion
-export { ImmutableObject as a, Mutable as c, ImmutableMap as i, MutableDeep as l, Immutable as n, ImmutableObjectDeep as o, ImmutableArray as r, ImmutableSet as s, BooleanProps as t };
-//# sourceMappingURL=types-DLOd2zXO.d.cts.map