@bluelibs/runner 4.6.1 → 4.7.0-alpha

package/dist/types/runner.d.ts

@@ -0,0 +1,55 @@
+import { DebugFriendlyConfig } from "../globals/resources/debug";
+import { LogLevels, PrintStrategy } from "../models/Logger";
+import { OnUnhandledError } from "../models/UnhandledError";
+export type RunOptions = {
+    /**
+     * Defaults to undefined. If true, we introduce logging to the console.
+     */
+    debug?: DebugFriendlyConfig;
+    /**
+     * Configure logging settings.
+     */
+    logs?: {
+        /**
+         * Defaults to info. Use null to disable logging.
+         */
+        printThreshold?: null | LogLevels;
+        /**
+         * Defaults to PRETTY. How to print the logs.
+         */
+        printStrategy?: PrintStrategy;
+        /**
+         * Defaults to false. If true, we buffer logs until the root resource is ready.
+         * This provides you with the chance to see the logs before the root resource is ready.
+         */
+        bufferLogs?: boolean;
+    };
+    /**
+     * When true (default), installs a central error boundary that catches uncaught errors
+     * from process-level events and routes them to `onUnhandledError`.
+     */
+    errorBoundary?: boolean;
+    /**
+     * When true (default), installs SIGINT/SIGTERM handlers that call dispose() on the root allowing for graceful shutdown.
+     */
+    shutdownHooks?: boolean;
+    /**
+     * Custom handler for any unhandled error caught by Runner. Defaults to logging via the created logger.
+     */
+    onUnhandledError?: OnUnhandledError;
+    /**
+     * Defaults to false.
+     *
+     * Dry run mode. When true, the runner will setup the system, ensure there are no errors, but will not start the system.
+     * Your resources will not be initialized, and no events will be emitted. This is useful for testing and debugging.
+     *
+     * Note: this cannot catch init() errors that happen within resources.
+     */
+    dryRun?: boolean;
+    /**
+     * Defaults to true.
+     * When set, forces runtime cycle detection for event emissions. Disable if you're sure
+     * you don't have event deadlocks to improve event emission performance.
+     */
+    runtimeCycleDetection?: boolean;
+};

package/dist/types/storeTypes.d.ts

@@ -0,0 +1,40 @@
+import { DependencyMapType, DependencyValuesType, ResourceDependencyValuesType } from "./utilities";
+import { IResource } from "./resource";
+import { ITask } from "./task";
+import { IHook } from "./hook";
+import { ITaskMiddleware } from "./taskMiddleware";
+import { IResourceMiddleware } from "./resourceMiddleware";
+import { IEvent } from "./event";
+import { IEventDefinition } from "./event";
+import { TaskLocalInterceptor } from "./utilities";
+export type ResourceStoreElementType<C = any, V extends Promise<any> = any, D extends DependencyMapType = {}, TContext = any> = {
+    resource: IResource<C, V, D>;
+    computedDependencies?: ResourceDependencyValuesType<D>;
+    config: C;
+    value: V;
+    context: TContext;
+    isInitialized?: boolean;
+};
+export type TaskStoreElementType<Input = any, Output extends Promise<any> = any, D extends DependencyMapType = any> = {
+    task: ITask<Input, Output, D>;
+    computedDependencies: DependencyValuesType<D>;
+    isInitialized: boolean;
+    interceptors?: Array<TaskLocalInterceptor<any, any>>;
+};
+export type HookStoreElementType<D extends DependencyMapType = any, TOn extends "*" | IEventDefinition = any> = {
+    hook: IHook<D, TOn>;
+    computedDependencies: DependencyValuesType<D>;
+};
+export type TaskMiddlewareStoreElementType<TDeps extends DependencyMapType = any> = {
+    middleware: ITaskMiddleware<any, TDeps>;
+    computedDependencies: DependencyValuesType<TDeps>;
+    isInitialized: boolean;
+};
+export type ResourceMiddlewareStoreElementType<TDeps extends DependencyMapType = any> = {
+    middleware: IResourceMiddleware<any, TDeps>;
+    computedDependencies: DependencyValuesType<TDeps>;
+    isInitialized: boolean;
+};
+export type EventStoreElementType = {
+    event: IEvent<any>;
+};

package/dist/types/symbols.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Internal brand symbols used to tag created objects at runtime and help with
+ * type‑narrowing. Prefer the `isTask`/`isResource`/`isEvent`/`isMiddleware`
+ * helpers instead of touching these directly.
+ * @internal
+ */
+export declare const symbolTask: unique symbol;
+/** Marks a task as a phantom task (no-op run; meant to be tunneled/routed). */
+export declare const symbolPhantomTask: unique symbol;
+export declare const symbolResource: unique symbol;
+export declare const symbolResourceWithConfig: unique symbol;
+export declare const symbolEvent: unique symbol;
+export declare const symbolMiddleware: unique symbol;
+/** New brands for separated middleware kinds */
+export declare const symbolTaskMiddleware: unique symbol;
+export declare const symbolResourceMiddleware: unique symbol;
+export declare const symbolMiddlewareConfigured: unique symbol;
+/** Marks a task that has been patched by a tunnel. Value is the local side mode. */
+export declare const symbolTunneledTask: unique symbol;
+/** @internal Marks hook definitions (event listeners without middleware) */
+export declare const symbolHook: unique symbol;
+/** @internal Marks a tag definition */
+export declare const symbolTag: unique symbol;
+export declare const symbolTagConfigured: unique symbol;
+/** @internal Marks an optional dependency wrapper */
+export declare const symbolOptionalDependency: unique symbol;
+/** @internal Path to aid anonymous id generation and error messages */
+export declare const symbolFilePath: unique symbol;

package/dist/types/tag.d.ts

@@ -0,0 +1,46 @@
+import { IContractable } from "./contracts";
+import { ITagMeta } from "./meta";
+import { IValidationSchema, RequiredKeys, symbolFilePath, symbolTag, symbolTagConfigured } from "./utilities";
+export interface ITaggable {
+    tags: TagType[];
+}
+export interface ITagDefinition<TConfig = void, TEnforceInputContract = void, TEnforceOutputContract = void> {
+    id: string;
+    meta?: ITagMeta;
+    configSchema?: IValidationSchema<TConfig>;
+    /**
+     * Utilizing config at definition level stores its defaults
+     */
+    config?: TConfig;
+}
+export interface ITag<TConfig = void, TEnforceInputContract = void, TEnforceOutputContract = void> extends ITagDefinition<TConfig, TEnforceInputContract, TEnforceOutputContract>, IContractable<TConfig, TEnforceInputContract, TEnforceOutputContract> {
+    /**
+     * A special validation property.
+     * It resolves to `true` if TConfig only has optional keys, otherwise `false`.
+     */
+    readonly __configHasOnlyOptionalKeys: RequiredKeys<TConfig> extends never ? true : false;
+    config?: TConfig;
+    /**
+     * Checks if the tag exists in a taggable or a list of tags.
+     */
+    exists(target: ITaggable | TagType[]): boolean;
+    /**
+     * Creates a configured instance of the tag.
+     */
+    with(config: TConfig): ITagConfigured<TConfig, TEnforceInputContract, TEnforceOutputContract>;
+    /**
+     * Extracts the configuration of the tag from a taggable or a list of tags.
+     */
+    extract(target: ITaggable | TagType[]): TConfig | undefined;
+    [symbolFilePath]: string;
+    [symbolTag]: true;
+}
+type ITagWithOptionalConfig<TValue, TEnforceInputContract, TEnforceOutputContract> = ITag<any, TEnforceInputContract, TEnforceOutputContract> & {
+    readonly __configHasOnlyOptionalKeys: true;
+};
+export interface ITagConfigured<TConfig = void, TEnforceInputContract = void, TEnforceOutputContract = void> extends ITag<TConfig, TEnforceInputContract, TEnforceOutputContract> {
+    [symbolTagConfigured]: true;
+    config: TConfig;
+}
+export type TagType = ITag<void, any, any> | ITagWithOptionalConfig<any, any, any> | ITagConfigured<any, any, any>;
+export {};

package/dist/types/task.d.ts

@@ -0,0 +1,50 @@
+import { DependencyMapType, DependencyValuesType, IOptionalDependency, IValidationSchema, TaskMiddlewareAttachmentType } from "../defs";
+import { TagType } from "./tag";
+import { ITaskMeta } from "./meta";
+import { symbolFilePath, symbolTask, symbolPhantomTask } from "./symbols";
+import { EnsureInputSatisfiesContracts, EnsureOutputSatisfiesContracts, HasInputContracts, HasOutputContracts, InferInputOrViolationFromContracts } from "./contracts";
+export interface ITaskDefinition<TInput = undefined, TOutput extends Promise<any> = any, TDependencies extends DependencyMapType = {}, TMeta extends ITaskMeta = any, TTags extends TagType[] = TagType[], TMiddleware extends TaskMiddlewareAttachmentType[] = TaskMiddlewareAttachmentType[]> {
+    id: string;
+    /**
+     * Access other tasks/resources/events. Can be an object or a function when
+     * you need late or config‑dependent resolution.
+     */
+    dependencies?: TDependencies | (() => TDependencies);
+    /** Middleware applied around task execution. */
+    middleware?: TMiddleware;
+    /** Optional metadata used for docs, filtering and tooling. */
+    meta?: TMeta;
+    /**
+     * Optional validation schema for runtime input validation.
+     * When provided, task input will be validated before execution.
+     */
+    inputSchema?: IValidationSchema<TInput>;
+    /**
+     * Optional validation schema for the task result.
+     * When provided, the result will be validated immediately after the task's
+     * `run` resolves, without considering middleware.
+     */
+    resultSchema?: IValidationSchema<TOutput extends Promise<infer U> ? U : never>;
+    run: (input: HasInputContracts<[...TTags, ...TMiddleware]> extends true ? [TInput] extends [undefined] ? InferInputOrViolationFromContracts<[...TTags, ...TMiddleware]> : EnsureInputSatisfiesContracts<[...TTags, ...TMiddleware], TInput> : TInput, dependencies: DependencyValuesType<TDependencies>) => HasOutputContracts<[...TTags, ...TMiddleware]> extends true ? EnsureOutputSatisfiesContracts<[...TTags, ...TMiddleware], TOutput> : TOutput;
+    /**
+     * Tags applied to the task that might define its behvaiour or impact the systems.
+     */
+    tags?: TTags;
+}
+export interface ITask<TInput = any, TOutput extends Promise<any> = any, TDependencies extends DependencyMapType = {}, TMeta extends ITaskMeta = any, TTags extends TagType[] = TagType[], TMiddleware extends TaskMiddlewareAttachmentType[] = TaskMiddlewareAttachmentType[]> extends ITaskDefinition<TInput, TOutput, TDependencies, TMeta, TTags, TMiddleware> {
+    [symbolFilePath]: string;
+    [symbolTask]: true;
+    /** Present only for phantom tasks. */
+    [symbolPhantomTask]?: true;
+    id: string;
+    dependencies: TDependencies | (() => TDependencies);
+    computedDependencies?: DependencyValuesType<TDependencies>;
+    middleware: TMiddleware;
+    /** Return an optional dependency wrapper for this task. */
+    optional: () => IOptionalDependency<ITask<TInput, TOutput, TDependencies, TMeta, TTags, TMiddleware>>;
+    tags: TTags;
+}
+/** Narrowed type for phantom tasks (no-op run by default). */
+export type IPhantomTask<TInput = any, TResolved = any, TDependencies extends DependencyMapType = {}, TMeta extends ITaskMeta = any, TTags extends TagType[] = TagType[], TMiddleware extends TaskMiddlewareAttachmentType[] = TaskMiddlewareAttachmentType[]> = ITask<TInput, Promise<TResolved>, TDependencies, TMeta, TTags, TMiddleware> & {
+    [symbolPhantomTask]: true;
+};

package/dist/types/taskMiddleware.d.ts

@@ -0,0 +1,48 @@
+import { DependencyMapType, DependencyValuesType, IValidationSchema, ITask } from "../defs";
+import { TagType } from "./tag";
+import { IMiddlewareMeta } from "./meta";
+import { symbolFilePath, symbolMiddlewareConfigured, symbolTaskMiddleware } from "./symbols";
+import { IContractable } from "./contracts";
+export interface ITaskMiddlewareDefinition<TConfig = any, TEnforceInputContract = void, TEnforceOutputContract = void, TDependencies extends DependencyMapType = any> {
+    id: string;
+    /** Static or lazy dependency map. */
+    dependencies?: TDependencies | ((config: TConfig) => TDependencies);
+    /**
+     * Optional validation schema for runtime config validation.
+     * When provided, middleware config will be validated when .with() is called.
+     */
+    configSchema?: IValidationSchema<TConfig>;
+    /**
+     * The middleware body, called with task execution input.
+     */
+    run: (input: ITaskMiddlewareExecutionInput<TEnforceInputContract extends void ? any : TEnforceInputContract, TEnforceOutputContract extends void ? any : TEnforceOutputContract>, dependencies: DependencyValuesType<TDependencies>, config: TConfig) => Promise<any>;
+    meta?: IMiddlewareMeta;
+    tags?: TagType[];
+    everywhere?: boolean | ((task: ITask<any, any, any, any>) => boolean);
+}
+export interface ITaskMiddleware<TConfig = any, TEnforceInputContract = void, TEnforceOutputContract = void, TDependencies extends DependencyMapType = any> extends ITaskMiddlewareDefinition<TConfig, TEnforceInputContract, TEnforceOutputContract, TDependencies>, IContractable<TConfig, TEnforceInputContract, TEnforceOutputContract> {
+    [symbolTaskMiddleware]: true;
+    [symbolFilePath]: string;
+    id: string;
+    dependencies: TDependencies | (() => TDependencies);
+    /** Current configuration object (empty by default). */
+    config: TConfig;
+    /** Configure the middleware and return a marked, configured instance. */
+    with: (config: TConfig) => ITaskMiddlewareConfigured<TConfig, TEnforceInputContract, TEnforceOutputContract, TDependencies>;
+    tags: TagType[];
+}
+export interface ITaskMiddlewareConfigured<TConfig = any, TEnforceInputContract = void, TEnforceOutputContract = void, TDependencies extends DependencyMapType = any> extends ITaskMiddleware<TConfig, TEnforceInputContract, TEnforceOutputContract, TDependencies> {
+    [symbolMiddlewareConfigured]: true;
+    config: TConfig;
+}
+export interface ITaskMiddlewareExecutionInput<TTaskInput = any, TTaskOutput = any> {
+    /** Task hook */
+    task: {
+        definition: ITask<TTaskInput, any, any, any>;
+        input: TTaskInput;
+    };
+    next: (taskInput?: TTaskInput) => Promise<TTaskOutput>;
+}
+export type TaskMiddlewareAttachmentType = ITaskMiddleware<void, any, any, any> | ITaskMiddleware<{
+    [K in any]?: any;
+}, any, any, any> | ITaskMiddlewareConfigured<any, any, any, any>;

package/dist/types/utilities.d.ts

@@ -0,0 +1,111 @@
+import { IResource, IResourceWithConfig } from "./resource";
+import { ITask } from "./task";
+import { ITaskMiddleware } from "./taskMiddleware";
+import { IResourceMiddleware } from "./resourceMiddleware";
+import { IHook } from "./hook";
+import { IEvent, IEventDefinition } from "./event";
+import { ITag } from "./tag";
+import { symbolOptionalDependency } from "./symbols";
+export * from "./symbols";
+/**
+ * Generic validation schema interface that can be implemented by any validation library.
+ * Compatible with Zod, Yup, Joi, and other validation libraries.
+ */
+export interface IValidationSchema<T = any> {
+    /**
+     * Parse and validate the input data.
+     * Should throw an error if validation fails.
+     * Can transform the data if the schema supports transformations.
+     */
+    parse(input: unknown): T;
+}
+/**
+ * Core public TypeScript types for BlueLibs Runner.
+ *
+ * This file contains the strongly-typed contract for tasks, resources, events
+ * and middleware. It mirrors the mental model described in the README:
+ * - Tasks are functions
+ * - Resources are singletons (with init/dispose hooks)
+ * - Events are simple, strongly-typed emissions
+ * - Middleware can target both tasks and resources
+ *
+ * DX goals:
+ * - Crystal‑clear generics and helper types that infer dependency shapes
+ * - Friendly JSDoc you can hover in editors to understand usage instantly
+ * - Safe overrides and strong typing around config and register mechanics
+ */
+export type RequiredKeys<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? never : K;
+}[keyof T];
+/**
+ * The reason we accept null and undefined is because we want to be able to offer beautiful DX:
+ * overrides: [
+ *    process.env.NODE_ENV === 'production' ? prodEmailer : null,
+ * ]
+ */
+export type OverridableElements = IResource<any, any, any, any, any> | ITask<any, any, any, any> | ITaskMiddleware<any> | IResourceMiddleware<any, any> | IResourceWithConfig<any, any, any> | IHook<any, any> | undefined | null;
+/**
+ * A mapping of dependency keys to Runner definitions. Used in `dependencies`
+ * for tasks and resources. Values are later transformed into the actual
+ * callable/value shape by `DependencyValuesType`.
+ */
+export type DependencyMapType = Record<string, ITask<any, any, any, any, any, any> | IResource<any, any, any, any, any, any, any> | IEvent<any> | IOptionalDependency<ITask<any, any, any, any, any, any>> | IOptionalDependency<IResource<any, any, any, any, any, any, any>> | IOptionalDependency<IEvent<any>>>;
+/** Wrapper type marking a dependency as optional at wiring time */
+export interface IOptionalDependency<T> {
+    /** The wrapped dependency definition */
+    inner: T;
+    /** Brand symbol for optional dependency */
+    [symbolOptionalDependency]: true;
+}
+export type ExtractTaskInput<T> = T extends ITask<infer I, any, infer D> ? I : never;
+export type ExtractTaskOutput<T> = T extends ITask<any, infer O, infer D> ? O : never;
+export type ExtractResourceConfig<T> = T extends IResource<infer C, any, any> ? C : never;
+export type ExtractResourceValue<T> = T extends IResource<any, infer V, infer D> ? V extends Promise<infer U> ? U : V : never;
+export type ExtractEventPayload<T> = T extends IEventDefinition<infer P> ? P : T extends IEvent<infer P> ? P : never;
+export type UnionToIntersection<U> = (U extends any ? (x: U) => any : never) extends (x: infer I) => any ? I : never;
+export type CommonPayload<T extends readonly IEventDefinition<any>[] | IEventDefinition<any>> = T extends readonly IEventDefinition<any>[] ? {
+    [K in keyof ExtractEventPayload<T[number]>]: UnionToIntersection<ExtractEventPayload<T[number]> extends any ? ExtractEventPayload<T[number]>[K] : never>;
+} : ExtractEventPayload<T>;
+/**
+ * Task dependencies transform into callable functions: call with the task input
+ * and you receive the task output.
+ */
+type TaskDependency<I, O> = (...args: I extends null | void ? [] : [I]) => O;
+/**
+ * Resource dependencies resolve to the resource's value directly.
+ */
+type ResourceDependency<V> = V;
+/**
+ * Event dependencies resolve to an emitter function. If the payload type is
+ * `void`, the function can be called with zero args (or an empty object).
+ */
+type EventDependency<P> = P extends void ? (() => Promise<void>) & ((input?: Record<string, never>) => Promise<void>) : (input: P) => Promise<void>;
+/**
+ * Transforms a dependency definition into the usable shape inside `run`/`init`:
+ * - Task -> callable function
+ * - Resource -> resolved value
+ * - Event -> emit function
+ */
+export type DependencyValueType<T> = T extends ITask<any, any, any> ? TaskDependency<ExtractTaskInput<T>, ExtractTaskOutput<T>> : T extends IResource<any, any> ? ResourceDependency<ExtractResourceValue<T>> : T extends IEventDefinition<any> ? EventDependency<ExtractEventPayload<T>> : T extends IOptionalDependency<infer U> ? DependencyValueType<U> | undefined : never;
+export type DependencyValuesType<T extends DependencyMapType> = {
+    [K in keyof T]: DependencyValueType<T[K]>;
+};
+export type TaskLocalInterceptor<TInput, TOutput> = (next: (input: TInput) => TOutput, input: TInput) => TOutput;
+export type TaskDependencyWithIntercept<TInput, TOutput> = TaskDependency<TInput, TOutput> & {
+    intercept: (middleware: TaskLocalInterceptor<TInput, TOutput>) => void;
+};
+/** Resource-context dependency typing where tasks expose intercept() */
+export type ResourceDependencyValueType<T> = T extends ITask<any, any, any> ? TaskDependencyWithIntercept<ExtractTaskInput<T>, ExtractTaskOutput<T>> : T extends IResource<any, any> ? ResourceDependency<ExtractResourceValue<T>> : T extends IEventDefinition<any> ? EventDependency<ExtractEventPayload<T>> : T extends IOptionalDependency<infer U> ? ResourceDependencyValueType<U> | undefined : never;
+export type ResourceDependencyValuesType<T extends DependencyMapType> = {
+    [K in keyof T]: ResourceDependencyValueType<T[K]>;
+};
+/**
+ * Anything you can put inside a resource's `register: []`.
+ * - Resources (with or without `.with()`)
+ * - Tasks
+ * - Middleware
+ * - Events
+ */
+export type RegisterableItems = IResourceWithConfig<any, any, any, any, any, any, any> | IResource<void, any, any, any, any, any, any> | IResource<{
+    [K in any]?: any;
+}, any, any, any, any, any, any> | ITask<any, any, any, any, any, any> | IHook<any, any> | ITaskMiddleware<any, any, any, any> | IResourceMiddleware<any, any, any, any> | IEvent<any> | ITag<any, any, any>;