@awesome-ecs/abstract 0.21.0 → 0.21.1

package/dist/performance-timer-BVyl0SRs.d.cts

@@ -1,45 +0,0 @@
-/**
- * A unique identifier for a timer.
- */
-type PerformanceTimerUid = number;
-/**
- * A record of a timer's execution.
- *
- * @remarks
- * This interface represents the details of a timer's execution.
- * It includes the timer's name, start timestamp, end timestamp, and the duration of the timer's execution in milliseconds.
- *
- * @property {string} name - The name of the timer.
- * @property {number} startedAt - The timestamp when the timer started.
- * @property {number} [endedAt] - The timestamp when the timer ended.
- * @property {number} [msPassed] - The time in milliseconds that the timer was active.
- */
-interface PerformanceTimeEntry {
-    name: string;
-    startedAt: number;
-    endedAt?: number;
-    msPassed?: number;
-}
-/**
- * An interface for a performance timer.
- * This interface provides methods to start and end timers,
- * and retrieve information about their execution.
- */
-interface IPerformanceTimer {
-    /**
-     * Starts a new timer with the given name.
-     * @param {string} name - The name of the timer.
-     * @returns {PerformanceTimerUid} - A unique identifier for the newly started timer.
-     */
-    startTimer(name: string): PerformanceTimerUid;
-    /**
-     * Ends the timer with the given timerUid and returns a record of its execution.
-     * @param {PerformanceTimerUid} timerUid - The unique identifier of the timer to end.
-     * @returns {PerformanceTimeEntry} - A record of the timer's execution.
-     * The returned object contains the timer's name, start timestamp, end timestamp,
-     * and the duration of the timer's execution in milliseconds.
-     */
-    endTimer(timerUid: PerformanceTimerUid): PerformanceTimeEntry;
-}
-
-export type { IPerformanceTimer as I, PerformanceTimeEntry as P, PerformanceTimerUid as a };

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

@@ -1,45 +0,0 @@
-/**
- * A unique identifier for a timer.
- */
-type PerformanceTimerUid = number;
-/**
- * A record of a timer's execution.
- *
- * @remarks
- * This interface represents the details of a timer's execution.
- * It includes the timer's name, start timestamp, end timestamp, and the duration of the timer's execution in milliseconds.
- *
- * @property {string} name - The name of the timer.
- * @property {number} startedAt - The timestamp when the timer started.
- * @property {number} [endedAt] - The timestamp when the timer ended.
- * @property {number} [msPassed] - The time in milliseconds that the timer was active.
- */
-interface PerformanceTimeEntry {
-    name: string;
-    startedAt: number;
-    endedAt?: number;
-    msPassed?: number;
-}
-/**
- * An interface for a performance timer.
- * This interface provides methods to start and end timers,
- * and retrieve information about their execution.
- */
-interface IPerformanceTimer {
-    /**
-     * Starts a new timer with the given name.
-     * @param {string} name - The name of the timer.
-     * @returns {PerformanceTimerUid} - A unique identifier for the newly started timer.
-     */
-    startTimer(name: string): PerformanceTimerUid;
-    /**
-     * Ends the timer with the given timerUid and returns a record of its execution.
-     * @param {PerformanceTimerUid} timerUid - The unique identifier of the timer to end.
-     * @returns {PerformanceTimeEntry} - A record of the timer's execution.
-     * The returned object contains the timer's name, start timestamp, end timestamp,
-     * and the duration of the timer's execution in milliseconds.
-     */
-    endTimer(timerUid: PerformanceTimerUid): PerformanceTimeEntry;
-}
-
-export type { IPerformanceTimer as I, PerformanceTimeEntry as P, PerformanceTimerUid as a };

package/dist/pipeline-9bVMwJKD.d.ts

@@ -1,161 +0,0 @@
-import { I as Immutable } from './types-cZ-1lGPD.js';
-import { P as PerformanceTimeEntry } from './performance-timer-BVyl0SRs.js';
-
-/**
- * The PipelineStatus enum represents the different states a pipeline can be in.
- *
- * @remarks
- * This enum is used to track the current status of the pipeline.
- */
-declare enum PipelineStatus {
-    /**
-     * The pipeline is currently idle and not processing any tasks.
-     */
-    idle = "idle",
-    /**
-     * The pipeline is currently processing tasks.
-     */
-    ongoing = "ongoing",
-    /**
-     * The pipeline has completed all tasks successfully.
-     */
-    completed = "completed",
-    /**
-     * The pipeline has been halted due to an error or middleware intervention.
-     */
-    halted = "halted"
-}
-
-/**
- * The Pipeline Context allows exposing state to the Pipeline's middlewares.
- */
-interface IPipelineContext {
-    /**
-     * The runtime state of the pipeline.
-     */
-    readonly runtime?: PipelineRuntime;
-}
-/**
- * The Pipeline Runtime exposes runtime status controls for Middlewares, as part of the PipelineContext.
- * It allows controlling the pipeline's execution flow.
- */
-type PipelineRuntime = {
-    /**
-     * A flag indicating whether the pipeline should stop executing.
-     * If true, the pipeline execution will be stopped.
-     */
-    shouldStop: boolean;
-    /**
-     * The current status of the pipeline.
-     * It can be undefined if the status is not set.
-     */
-    status?: PipelineStatus;
-    /**
-     * An optional error that occurred during the pipeline operation.
-     */
-    error?: any;
-};
-
-/**
- * Represents the result of a pipeline operation.
- * It can provide performance metrics collected from self or inner middleware & pipeline calls.
- */
-type PipelineResult = {
-    /**
-     * Performance metrics collected from the current pipeline operation.
-     * This field is optional and can be `undefined` if no performance metrics were collected.
-     */
-    readonly performance?: PerformanceTimeEntry;
-    /**
-     * An array of results from inner middleware & pipeline calls.
-     * This field is optional and can be `undefined` if there were no inner calls.
-     */
-    readonly inner?: PipelineResult[];
-};
-
-/**
- * A middleware, the building block of a Pipeline. 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.
- *
- * @template TContext The type of the context that the middleware will operate on.
- * @template TResult The type of the result that the middleware will return.
- */
-interface IMiddleware<TContext extends IPipelineContext> {
-    /**
-     * An optional name for the middleware.
-     */
-    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.
-     * @returns A boolean indicating whether the middleware should run.
-     */
-    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.
-     * @returns The result of the middleware's action.
-     */
-    action(context: TContext): void | PipelineResult;
-    /**
-     * 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.
-     * @returns The result of the middleware's cleanup.
-     */
-    cleanup?(context: TContext): void | PipelineResult;
-}
-
-/**
- * An interface representing a middleware container and dispatcher.
- * It allows registering and executing middleware functions in a pipeline.
- *
- * @template TContext - The type of the context object that will be passed to each middleware function.
- * @template TResult - The type of the result that each middleware function will return.
- *                     Defaults to {@link MiddlewareResult}.
- */
-interface IPipeline<TContext extends IPipelineContext> {
-    /**
-     * Represents the name of the pipeline.
-     * This property is optional and can be used for debugging purposes.
-     */
-    readonly name?: string;
-    /**
-     * Represents the number of middleware functions registered in the pipeline.
-     * This property is optional.
-     */
-    readonly length?: number;
-    /**
-     * Represents the middleware functions registered in the pipeline.
-     * This property is optional.
-     */
-    readonly middleware?: Immutable<IMiddleware<TContext>[]>;
-    /**
-     * Register middleware for this pipeline.
-     *
-     * @param middleware - The middleware function to be added to the pipeline.
-     * @returns This instance of the pipeline, allowing for method chaining.
-     */
-    use(middleware: Immutable<IMiddleware<TContext>>): this;
-    /**
-     * Execute the Dispatch phase on the chain of middleware, with the given Context.
-     * The Dispatch phase is responsible for invoking the middleware functions in the pipeline.
-     *
-     * @param context - The context object that will be passed to each middleware function.
-     * @returns A {@link PipelineResult} object representing the result of the pipeline execution.
-     */
-    dispatch(context: Partial<TContext>): PipelineResult;
-    /**
-     * Execute the Cleanup phase on the chain of middleware, with the given Context.
-     * The Cleanup phase is responsible for performing any necessary cleanup operations after the pipeline execution.
-     *
-     * @param context - The context object that will be passed to each middleware function.
-     * @returns A {@link PipelineResult} object representing the result of the cleanup execution.
-     */
-    cleanup(context: Partial<TContext>): PipelineResult;
-}
-
-export { type IPipelineContext as I, type PipelineResult as P, type IPipeline as a, type IMiddleware as b, type PipelineRuntime as c, PipelineStatus as d };

package/dist/pipeline-CzwetuCd.d.cts

@@ -1,161 +0,0 @@
-import { I as Immutable } from './types-cZ-1lGPD.cjs';
-import { P as PerformanceTimeEntry } from './performance-timer-BVyl0SRs.cjs';
-
-/**
- * The PipelineStatus enum represents the different states a pipeline can be in.
- *
- * @remarks
- * This enum is used to track the current status of the pipeline.
- */
-declare enum PipelineStatus {
-    /**
-     * The pipeline is currently idle and not processing any tasks.
-     */
-    idle = "idle",
-    /**
-     * The pipeline is currently processing tasks.
-     */
-    ongoing = "ongoing",
-    /**
-     * The pipeline has completed all tasks successfully.
-     */
-    completed = "completed",
-    /**
-     * The pipeline has been halted due to an error or middleware intervention.
-     */
-    halted = "halted"
-}
-
-/**
- * The Pipeline Context allows exposing state to the Pipeline's middlewares.
- */
-interface IPipelineContext {
-    /**
-     * The runtime state of the pipeline.
-     */
-    readonly runtime?: PipelineRuntime;
-}
-/**
- * The Pipeline Runtime exposes runtime status controls for Middlewares, as part of the PipelineContext.
- * It allows controlling the pipeline's execution flow.
- */
-type PipelineRuntime = {
-    /**
-     * A flag indicating whether the pipeline should stop executing.
-     * If true, the pipeline execution will be stopped.
-     */
-    shouldStop: boolean;
-    /**
-     * The current status of the pipeline.
-     * It can be undefined if the status is not set.
-     */
-    status?: PipelineStatus;
-    /**
-     * An optional error that occurred during the pipeline operation.
-     */
-    error?: any;
-};
-
-/**
- * Represents the result of a pipeline operation.
- * It can provide performance metrics collected from self or inner middleware & pipeline calls.
- */
-type PipelineResult = {
-    /**
-     * Performance metrics collected from the current pipeline operation.
-     * This field is optional and can be `undefined` if no performance metrics were collected.
-     */
-    readonly performance?: PerformanceTimeEntry;
-    /**
-     * An array of results from inner middleware & pipeline calls.
-     * This field is optional and can be `undefined` if there were no inner calls.
-     */
-    readonly inner?: PipelineResult[];
-};
-
-/**
- * A middleware, the building block of a Pipeline. 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.
- *
- * @template TContext The type of the context that the middleware will operate on.
- * @template TResult The type of the result that the middleware will return.
- */
-interface IMiddleware<TContext extends IPipelineContext> {
-    /**
-     * An optional name for the middleware.
-     */
-    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.
-     * @returns A boolean indicating whether the middleware should run.
-     */
-    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.
-     * @returns The result of the middleware's action.
-     */
-    action(context: TContext): void | PipelineResult;
-    /**
-     * 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.
-     * @returns The result of the middleware's cleanup.
-     */
-    cleanup?(context: TContext): void | PipelineResult;
-}
-
-/**
- * An interface representing a middleware container and dispatcher.
- * It allows registering and executing middleware functions in a pipeline.
- *
- * @template TContext - The type of the context object that will be passed to each middleware function.
- * @template TResult - The type of the result that each middleware function will return.
- *                     Defaults to {@link MiddlewareResult}.
- */
-interface IPipeline<TContext extends IPipelineContext> {
-    /**
-     * Represents the name of the pipeline.
-     * This property is optional and can be used for debugging purposes.
-     */
-    readonly name?: string;
-    /**
-     * Represents the number of middleware functions registered in the pipeline.
-     * This property is optional.
-     */
-    readonly length?: number;
-    /**
-     * Represents the middleware functions registered in the pipeline.
-     * This property is optional.
-     */
-    readonly middleware?: Immutable<IMiddleware<TContext>[]>;
-    /**
-     * Register middleware for this pipeline.
-     *
-     * @param middleware - The middleware function to be added to the pipeline.
-     * @returns This instance of the pipeline, allowing for method chaining.
-     */
-    use(middleware: Immutable<IMiddleware<TContext>>): this;
-    /**
-     * Execute the Dispatch phase on the chain of middleware, with the given Context.
-     * The Dispatch phase is responsible for invoking the middleware functions in the pipeline.
-     *
-     * @param context - The context object that will be passed to each middleware function.
-     * @returns A {@link PipelineResult} object representing the result of the pipeline execution.
-     */
-    dispatch(context: Partial<TContext>): PipelineResult;
-    /**
-     * Execute the Cleanup phase on the chain of middleware, with the given Context.
-     * The Cleanup phase is responsible for performing any necessary cleanup operations after the pipeline execution.
-     *
-     * @param context - The context object that will be passed to each middleware function.
-     * @returns A {@link PipelineResult} object representing the result of the cleanup execution.
-     */
-    cleanup(context: Partial<TContext>): PipelineResult;
-}
-
-export { type IPipelineContext as I, type PipelineResult as P, type IPipeline as a, type IMiddleware as b, type PipelineRuntime as c, PipelineStatus as d };