@bluelibs/runner 4.5.0-alpha → 4.5.0-alpha.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (228) hide show
  1. package/dist/index.cjs +4265 -0
  2. package/dist/index.cjs.map +1 -0
  3. package/dist/index.d.mts +1734 -0
  4. package/dist/index.d.ts +1696 -45
  5. package/dist/index.mjs +4233 -0
  6. package/dist/index.mjs.map +1 -0
  7. package/package.json +11 -14
  8. package/dist/context.d.ts +0 -29
  9. package/dist/context.js +0 -52
  10. package/dist/context.js.map +0 -1
  11. package/dist/define.d.ts +0 -9
  12. package/dist/define.js +0 -32
  13. package/dist/define.js.map +0 -1
  14. package/dist/definers/defineEvent.d.ts +0 -2
  15. package/dist/definers/defineEvent.js +0 -23
  16. package/dist/definers/defineEvent.js.map +0 -1
  17. package/dist/definers/defineHook.d.ts +0 -6
  18. package/dist/definers/defineHook.js +0 -24
  19. package/dist/definers/defineHook.js.map +0 -1
  20. package/dist/definers/defineOverride.d.ts +0 -14
  21. package/dist/definers/defineOverride.js +0 -13
  22. package/dist/definers/defineOverride.js.map +0 -1
  23. package/dist/definers/defineResource.d.ts +0 -2
  24. package/dist/definers/defineResource.js +0 -69
  25. package/dist/definers/defineResource.js.map +0 -1
  26. package/dist/definers/defineResourceMiddleware.d.ts +0 -2
  27. package/dist/definers/defineResourceMiddleware.js +0 -42
  28. package/dist/definers/defineResourceMiddleware.js.map +0 -1
  29. package/dist/definers/defineTag.d.ts +0 -12
  30. package/dist/definers/defineTag.js +0 -107
  31. package/dist/definers/defineTag.js.map +0 -1
  32. package/dist/definers/defineTask.d.ts +0 -15
  33. package/dist/definers/defineTask.js +0 -42
  34. package/dist/definers/defineTask.js.map +0 -1
  35. package/dist/definers/defineTaskMiddleware.d.ts +0 -2
  36. package/dist/definers/defineTaskMiddleware.js +0 -42
  37. package/dist/definers/defineTaskMiddleware.js.map +0 -1
  38. package/dist/definers/tools.d.ts +0 -45
  39. package/dist/definers/tools.js +0 -75
  40. package/dist/definers/tools.js.map +0 -1
  41. package/dist/defs.d.ts +0 -29
  42. package/dist/defs.js +0 -45
  43. package/dist/defs.js.map +0 -1
  44. package/dist/errors.d.ts +0 -96
  45. package/dist/errors.js +0 -178
  46. package/dist/errors.js.map +0 -1
  47. package/dist/globals/globalEvents.d.ts +0 -17
  48. package/dist/globals/globalEvents.js +0 -33
  49. package/dist/globals/globalEvents.js.map +0 -1
  50. package/dist/globals/globalMiddleware.d.ts +0 -31
  51. package/dist/globals/globalMiddleware.js +0 -25
  52. package/dist/globals/globalMiddleware.js.map +0 -1
  53. package/dist/globals/globalResources.d.ts +0 -30
  54. package/dist/globals/globalResources.js +0 -55
  55. package/dist/globals/globalResources.js.map +0 -1
  56. package/dist/globals/globalTags.d.ts +0 -9
  57. package/dist/globals/globalTags.js +0 -23
  58. package/dist/globals/globalTags.js.map +0 -1
  59. package/dist/globals/middleware/cache.middleware.d.ts +0 -27
  60. package/dist/globals/middleware/cache.middleware.js +0 -73
  61. package/dist/globals/middleware/cache.middleware.js.map +0 -1
  62. package/dist/globals/middleware/requireContext.middleware.d.ts +0 -6
  63. package/dist/globals/middleware/requireContext.middleware.js +0 -16
  64. package/dist/globals/middleware/requireContext.middleware.js.map +0 -1
  65. package/dist/globals/middleware/retry.middleware.d.ts +0 -21
  66. package/dist/globals/middleware/retry.middleware.js +0 -61
  67. package/dist/globals/middleware/retry.middleware.js.map +0 -1
  68. package/dist/globals/middleware/timeout.middleware.d.ts +0 -9
  69. package/dist/globals/middleware/timeout.middleware.js +0 -61
  70. package/dist/globals/middleware/timeout.middleware.js.map +0 -1
  71. package/dist/globals/resources/debug/debug.resource.d.ts +0 -7
  72. package/dist/globals/resources/debug/debug.resource.js +0 -29
  73. package/dist/globals/resources/debug/debug.resource.js.map +0 -1
  74. package/dist/globals/resources/debug/debug.tag.d.ts +0 -2
  75. package/dist/globals/resources/debug/debug.tag.js +0 -12
  76. package/dist/globals/resources/debug/debug.tag.js.map +0 -1
  77. package/dist/globals/resources/debug/debugConfig.resource.d.ts +0 -22
  78. package/dist/globals/resources/debug/debugConfig.resource.js +0 -20
  79. package/dist/globals/resources/debug/debugConfig.resource.js.map +0 -1
  80. package/dist/globals/resources/debug/executionTracker.middleware.d.ts +0 -50
  81. package/dist/globals/resources/debug/executionTracker.middleware.js +0 -78
  82. package/dist/globals/resources/debug/executionTracker.middleware.js.map +0 -1
  83. package/dist/globals/resources/debug/globalEvent.hook.d.ts +0 -27
  84. package/dist/globals/resources/debug/globalEvent.hook.js +0 -38
  85. package/dist/globals/resources/debug/globalEvent.hook.js.map +0 -1
  86. package/dist/globals/resources/debug/hook.hook.d.ts +0 -30
  87. package/dist/globals/resources/debug/hook.hook.js +0 -48
  88. package/dist/globals/resources/debug/hook.hook.js.map +0 -1
  89. package/dist/globals/resources/debug/index.d.ts +0 -6
  90. package/dist/globals/resources/debug/index.js +0 -23
  91. package/dist/globals/resources/debug/index.js.map +0 -1
  92. package/dist/globals/resources/debug/middleware.hook.d.ts +0 -30
  93. package/dist/globals/resources/debug/middleware.hook.js +0 -75
  94. package/dist/globals/resources/debug/middleware.hook.js.map +0 -1
  95. package/dist/globals/resources/debug/types.d.ts +0 -25
  96. package/dist/globals/resources/debug/types.js +0 -65
  97. package/dist/globals/resources/debug/types.js.map +0 -1
  98. package/dist/globals/resources/debug/utils.d.ts +0 -2
  99. package/dist/globals/resources/debug/utils.js +0 -13
  100. package/dist/globals/resources/debug/utils.js.map +0 -1
  101. package/dist/globals/resources/queue.resource.d.ts +0 -10
  102. package/dist/globals/resources/queue.resource.js +0 -31
  103. package/dist/globals/resources/queue.resource.js.map +0 -1
  104. package/dist/globals/types.d.ts +0 -1
  105. package/dist/globals/types.js +0 -18
  106. package/dist/globals/types.js.map +0 -1
  107. package/dist/index.js +0 -48
  108. package/dist/index.js.map +0 -1
  109. package/dist/models/DependencyProcessor.d.ts +0 -48
  110. package/dist/models/DependencyProcessor.js +0 -276
  111. package/dist/models/DependencyProcessor.js.map +0 -1
  112. package/dist/models/EventManager.d.ts +0 -153
  113. package/dist/models/EventManager.js +0 -421
  114. package/dist/models/EventManager.js.map +0 -1
  115. package/dist/models/LogPrinter.d.ts +0 -55
  116. package/dist/models/LogPrinter.js +0 -202
  117. package/dist/models/LogPrinter.js.map +0 -1
  118. package/dist/models/Logger.d.ts +0 -85
  119. package/dist/models/Logger.js +0 -194
  120. package/dist/models/Logger.js.map +0 -1
  121. package/dist/models/MiddlewareManager.d.ts +0 -86
  122. package/dist/models/MiddlewareManager.js +0 -391
  123. package/dist/models/MiddlewareManager.js.map +0 -1
  124. package/dist/models/OverrideManager.d.ts +0 -13
  125. package/dist/models/OverrideManager.js +0 -84
  126. package/dist/models/OverrideManager.js.map +0 -1
  127. package/dist/models/Queue.d.ts +0 -25
  128. package/dist/models/Queue.js +0 -56
  129. package/dist/models/Queue.js.map +0 -1
  130. package/dist/models/ResourceInitializer.d.ts +0 -20
  131. package/dist/models/ResourceInitializer.js +0 -34
  132. package/dist/models/ResourceInitializer.js.map +0 -1
  133. package/dist/models/RunResult.d.ts +0 -35
  134. package/dist/models/RunResult.js +0 -62
  135. package/dist/models/RunResult.js.map +0 -1
  136. package/dist/models/Semaphore.d.ts +0 -61
  137. package/dist/models/Semaphore.js +0 -164
  138. package/dist/models/Semaphore.js.map +0 -1
  139. package/dist/models/Store.d.ts +0 -56
  140. package/dist/models/Store.js +0 -209
  141. package/dist/models/Store.js.map +0 -1
  142. package/dist/models/StoreRegistry.d.ts +0 -43
  143. package/dist/models/StoreRegistry.js +0 -375
  144. package/dist/models/StoreRegistry.js.map +0 -1
  145. package/dist/models/StoreValidator.d.ts +0 -8
  146. package/dist/models/StoreValidator.js +0 -73
  147. package/dist/models/StoreValidator.js.map +0 -1
  148. package/dist/models/TaskRunner.d.ts +0 -27
  149. package/dist/models/TaskRunner.js +0 -53
  150. package/dist/models/TaskRunner.js.map +0 -1
  151. package/dist/models/UnhandledError.d.ts +0 -11
  152. package/dist/models/UnhandledError.js +0 -32
  153. package/dist/models/UnhandledError.js.map +0 -1
  154. package/dist/models/index.d.ts +0 -11
  155. package/dist/models/index.js +0 -28
  156. package/dist/models/index.js.map +0 -1
  157. package/dist/models/utils/findCircularDependencies.d.ts +0 -16
  158. package/dist/models/utils/findCircularDependencies.js +0 -45
  159. package/dist/models/utils/findCircularDependencies.js.map +0 -1
  160. package/dist/models/utils/safeStringify.d.ts +0 -3
  161. package/dist/models/utils/safeStringify.js +0 -45
  162. package/dist/models/utils/safeStringify.js.map +0 -1
  163. package/dist/platform/browser.d.ts +0 -15
  164. package/dist/platform/browser.js +0 -98
  165. package/dist/platform/browser.js.map +0 -1
  166. package/dist/platform/index.d.ts +0 -8
  167. package/dist/platform/index.js +0 -47
  168. package/dist/platform/index.js.map +0 -1
  169. package/dist/platform/node.d.ts +0 -11
  170. package/dist/platform/node.js +0 -45
  171. package/dist/platform/node.js.map +0 -1
  172. package/dist/platform/types.d.ts +0 -28
  173. package/dist/platform/types.js +0 -19
  174. package/dist/platform/types.js.map +0 -1
  175. package/dist/platform/universal.d.ts +0 -16
  176. package/dist/platform/universal.js +0 -57
  177. package/dist/platform/universal.js.map +0 -1
  178. package/dist/processHooks.d.ts +0 -2
  179. package/dist/processHooks.js +0 -79
  180. package/dist/processHooks.js.map +0 -1
  181. package/dist/run.d.ts +0 -14
  182. package/dist/run.js +0 -126
  183. package/dist/run.js.map +0 -1
  184. package/dist/testing.d.ts +0 -25
  185. package/dist/testing.js +0 -42
  186. package/dist/testing.js.map +0 -1
  187. package/dist/tools/getCallerFile.d.ts +0 -1
  188. package/dist/tools/getCallerFile.js +0 -30
  189. package/dist/tools/getCallerFile.js.map +0 -1
  190. package/dist/types/contracts.d.ts +0 -55
  191. package/dist/types/contracts.js +0 -4
  192. package/dist/types/contracts.js.map +0 -1
  193. package/dist/types/event.d.ts +0 -74
  194. package/dist/types/event.js +0 -17
  195. package/dist/types/event.js.map +0 -1
  196. package/dist/types/hook.d.ts +0 -23
  197. package/dist/types/hook.js +0 -4
  198. package/dist/types/hook.js.map +0 -1
  199. package/dist/types/meta.d.ts +0 -18
  200. package/dist/types/meta.js +0 -7
  201. package/dist/types/meta.js.map +0 -1
  202. package/dist/types/resource.d.ts +0 -84
  203. package/dist/types/resource.js +0 -4
  204. package/dist/types/resource.js.map +0 -1
  205. package/dist/types/resourceMiddleware.d.ts +0 -47
  206. package/dist/types/resourceMiddleware.js +0 -4
  207. package/dist/types/resourceMiddleware.js.map +0 -1
  208. package/dist/types/runner.d.ts +0 -55
  209. package/dist/types/runner.js +0 -3
  210. package/dist/types/runner.js.map +0 -1
  211. package/dist/types/storeTypes.d.ts +0 -40
  212. package/dist/types/storeTypes.js +0 -3
  213. package/dist/types/storeTypes.js.map +0 -1
  214. package/dist/types/symbols.d.ts +0 -30
  215. package/dist/types/symbols.js +0 -40
  216. package/dist/types/symbols.js.map +0 -1
  217. package/dist/types/tag.d.ts +0 -46
  218. package/dist/types/tag.js +0 -4
  219. package/dist/types/tag.js.map +0 -1
  220. package/dist/types/task.d.ts +0 -44
  221. package/dist/types/task.js +0 -4
  222. package/dist/types/task.js.map +0 -1
  223. package/dist/types/taskMiddleware.d.ts +0 -48
  224. package/dist/types/taskMiddleware.js +0 -4
  225. package/dist/types/taskMiddleware.js.map +0 -1
  226. package/dist/types/utilities.d.ts +0 -110
  227. package/dist/types/utilities.js +0 -19
  228. package/dist/types/utilities.js.map +0 -1
@@ -1,55 +0,0 @@
1
- import { DebugFriendlyConfig } from "../globals/resources/debug";
2
- import { LogLevels, PrintStrategy } from "../models/Logger";
3
- import { OnUnhandledError } from "../models/UnhandledError";
4
- export type RunOptions = {
5
- /**
6
- * Defaults to undefined. If true, we introduce logging to the console.
7
- */
8
- debug?: DebugFriendlyConfig;
9
- /**
10
- * Configure logging settings.
11
- */
12
- logs?: {
13
- /**
14
- * Defaults to info. Use null to disable logging.
15
- */
16
- printThreshold?: null | LogLevels;
17
- /**
18
- * Defaults to PRETTY. How to print the logs.
19
- */
20
- printStrategy?: PrintStrategy;
21
- /**
22
- * Defaults to false. If true, we buffer logs until the root resource is ready.
23
- * This provides you with the chance to see the logs before the root resource is ready.
24
- */
25
- bufferLogs?: boolean;
26
- };
27
- /**
28
- * When true (default), installs a central error boundary that catches uncaught errors
29
- * from process-level events and routes them to `onUnhandledError`.
30
- */
31
- errorBoundary?: boolean;
32
- /**
33
- * When true (default), installs SIGINT/SIGTERM handlers that call dispose() on the root allowing for graceful shutdown.
34
- */
35
- shutdownHooks?: boolean;
36
- /**
37
- * Custom handler for any unhandled error caught by Runner. Defaults to logging via the created logger.
38
- */
39
- onUnhandledError?: OnUnhandledError;
40
- /**
41
- * Defaults to false.
42
- *
43
- * Dry run mode. When true, the runner will setup the system, ensure there are no errors, but will not start the system.
44
- * Your resources will not be initialized, and no events will be emitted. This is useful for testing and debugging.
45
- *
46
- * Note: this cannot catch init() errors that happen within resources.
47
- */
48
- dryRun?: boolean;
49
- /**
50
- * Defaults to true.
51
- * When set, forces runtime cycle detection for event emissions. Disable if you're sure
52
- * you don't have event deadlocks to improve event emission performance.
53
- */
54
- runtimeCycleDetection?: boolean;
55
- };
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=runner.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"runner.js","sourceRoot":"","sources":["../../src/types/runner.ts"],"names":[],"mappings":""}
@@ -1,40 +0,0 @@
1
- import { DependencyMapType, DependencyValuesType, ResourceDependencyValuesType } from "./utilities";
2
- import { IResource } from "./resource";
3
- import { ITask } from "./task";
4
- import { IHook } from "./hook";
5
- import { ITaskMiddleware } from "./taskMiddleware";
6
- import { IResourceMiddleware } from "./resourceMiddleware";
7
- import { IEvent } from "./event";
8
- import { IEventDefinition } from "./event";
9
- import { TaskLocalInterceptor } from "./utilities";
10
- export type ResourceStoreElementType<C = any, V extends Promise<any> = any, D extends DependencyMapType = {}, TContext = any> = {
11
- resource: IResource<C, V, D>;
12
- computedDependencies?: ResourceDependencyValuesType<D>;
13
- config: C;
14
- value: V;
15
- context: TContext;
16
- isInitialized?: boolean;
17
- };
18
- export type TaskStoreElementType<Input = any, Output extends Promise<any> = any, D extends DependencyMapType = any> = {
19
- task: ITask<Input, Output, D>;
20
- computedDependencies: DependencyValuesType<D>;
21
- isInitialized: boolean;
22
- interceptors?: Array<TaskLocalInterceptor<any, any>>;
23
- };
24
- export type HookStoreElementType<D extends DependencyMapType = any, TOn extends "*" | IEventDefinition = any> = {
25
- hook: IHook<D, TOn>;
26
- computedDependencies: DependencyValuesType<D>;
27
- };
28
- export type TaskMiddlewareStoreElementType<TDeps extends DependencyMapType = any> = {
29
- middleware: ITaskMiddleware<any, TDeps>;
30
- computedDependencies: DependencyValuesType<TDeps>;
31
- isInitialized: boolean;
32
- };
33
- export type ResourceMiddlewareStoreElementType<TDeps extends DependencyMapType = any> = {
34
- middleware: IResourceMiddleware<any, TDeps>;
35
- computedDependencies: DependencyValuesType<TDeps>;
36
- isInitialized: boolean;
37
- };
38
- export type EventStoreElementType = {
39
- event: IEvent<any>;
40
- };
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=storeTypes.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"storeTypes.js","sourceRoot":"","sources":["../../src/types/storeTypes.ts"],"names":[],"mappings":""}
@@ -1,30 +0,0 @@
1
- /**
2
- * Internal brand symbols used to tag created objects at runtime and help with
3
- * type‑narrowing. Prefer the `isTask`/`isResource`/`isEvent`/`isMiddleware`
4
- * helpers instead of touching these directly.
5
- * @internal
6
- */
7
- export declare const symbolTask: unique symbol;
8
- export declare const symbolResource: unique symbol;
9
- export declare const symbolResourceWithConfig: unique symbol;
10
- export declare const symbolEvent: unique symbol;
11
- export declare const symbolMiddleware: unique symbol;
12
- /** New brands for separated middleware kinds */
13
- export declare const symbolTaskMiddleware: unique symbol;
14
- export declare const symbolResourceMiddleware: unique symbol;
15
- export declare const symbolMiddlewareConfigured: unique symbol;
16
- /** @internal Marks hook definitions (event listeners without middleware) */
17
- export declare const symbolHook: unique symbol;
18
- /** @internal Marks a tag definition */
19
- export declare const symbolTag: unique symbol;
20
- export declare const symbolTagConfigured: unique symbol;
21
- /** @internal Marks an optional dependency wrapper */
22
- export declare const symbolOptionalDependency: unique symbol;
23
- /** @internal Path to aid anonymous id generation and error messages */
24
- export declare const symbolFilePath: unique symbol;
25
- /** @internal Marks disposable instances */
26
- export declare const symbolDispose: unique symbol;
27
- /** @internal Link to internal Store */
28
- export declare const symbolStore: unique symbol;
29
- /** @internal Brand used by index() resources */
30
- export declare const symbolIndexResource: unique symbol;
@@ -1,40 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.symbolIndexResource = exports.symbolStore = exports.symbolDispose = exports.symbolFilePath = exports.symbolOptionalDependency = exports.symbolTagConfigured = exports.symbolTag = exports.symbolHook = exports.symbolMiddlewareConfigured = exports.symbolResourceMiddleware = exports.symbolTaskMiddleware = exports.symbolMiddleware = exports.symbolEvent = exports.symbolResourceWithConfig = exports.symbolResource = exports.symbolTask = void 0;
4
- /**
5
- * Internal brand symbols used to tag created objects at runtime and help with
6
- * type‑narrowing. Prefer the `isTask`/`isResource`/`isEvent`/`isMiddleware`
7
- * helpers instead of touching these directly.
8
- * @internal
9
- */
10
- exports.symbolTask = Symbol("runner.task");
11
- exports.symbolResource = Symbol("runner.resource");
12
- exports.symbolResourceWithConfig = Symbol("runner.resourceWithConfig");
13
- exports.symbolEvent = Symbol("runner.event");
14
- exports.symbolMiddleware = Symbol("runner.middleware");
15
- /** New brands for separated middleware kinds */
16
- exports.symbolTaskMiddleware = Symbol("runner.taskMiddleware");
17
- exports.symbolResourceMiddleware = Symbol("runner.resourceMiddleware");
18
- exports.symbolMiddlewareConfigured = Symbol("runner.middlewareConfigured");
19
- /** @internal Marks hook definitions (event listeners without middleware) */
20
- exports.symbolHook = Symbol("runner.hook");
21
- // export const symbolMiddlewareEverywhereTasks: unique symbol = Symbol(
22
- // "runner.middlewareGlobalTasks",
23
- // );
24
- // export const symbolMiddlewareEverywhereResources: unique symbol = Symbol(
25
- // "runner.middlewareGlobalResources",
26
- // );
27
- /** @internal Marks a tag definition */
28
- exports.symbolTag = Symbol("runner.tag");
29
- exports.symbolTagConfigured = Symbol("runner.tagConfigured");
30
- /** @internal Marks an optional dependency wrapper */
31
- exports.symbolOptionalDependency = Symbol("runner.optionalDependency");
32
- /** @internal Path to aid anonymous id generation and error messages */
33
- exports.symbolFilePath = Symbol("runner.filePath");
34
- /** @internal Marks disposable instances */
35
- exports.symbolDispose = Symbol("runner.dispose");
36
- /** @internal Link to internal Store */
37
- exports.symbolStore = Symbol("runner.store");
38
- /** @internal Brand used by index() resources */
39
- exports.symbolIndexResource = Symbol("runner.indexResource");
40
- //# sourceMappingURL=symbols.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"symbols.js","sourceRoot":"","sources":["../../src/types/symbols.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACU,QAAA,UAAU,GAAkB,MAAM,CAAC,aAAa,CAAC,CAAC;AAClD,QAAA,cAAc,GAAkB,MAAM,CAAC,iBAAiB,CAAC,CAAC;AAC1D,QAAA,wBAAwB,GAAkB,MAAM,CAC3D,2BAA2B,CAC5B,CAAC;AACW,QAAA,WAAW,GAAkB,MAAM,CAAC,cAAc,CAAC,CAAC;AACpD,QAAA,gBAAgB,GAAkB,MAAM,CAAC,mBAAmB,CAAC,CAAC;AAC3E,gDAAgD;AACnC,QAAA,oBAAoB,GAAkB,MAAM,CACvD,uBAAuB,CACxB,CAAC;AACW,QAAA,wBAAwB,GAAkB,MAAM,CAC3D,2BAA2B,CAC5B,CAAC;AACW,QAAA,0BAA0B,GAAkB,MAAM,CAC7D,6BAA6B,CAC9B,CAAC;AACF,4EAA4E;AAC/D,QAAA,UAAU,GAAkB,MAAM,CAAC,aAAa,CAAC,CAAC;AAC/D,wEAAwE;AACxE,oCAAoC;AACpC,KAAK;AACL,4EAA4E;AAC5E,wCAAwC;AACxC,KAAK;AACL,uCAAuC;AAC1B,QAAA,SAAS,GAAkB,MAAM,CAAC,YAAY,CAAC,CAAC;AAChD,QAAA,mBAAmB,GAAkB,MAAM,CACtD,sBAAsB,CACvB,CAAC;AAEF,qDAAqD;AACxC,QAAA,wBAAwB,GAAkB,MAAM,CAC3D,2BAA2B,CAC5B,CAAC;AAEF,uEAAuE;AAC1D,QAAA,cAAc,GAAkB,MAAM,CAAC,iBAAiB,CAAC,CAAC;AACvE,2CAA2C;AAC9B,QAAA,aAAa,GAAkB,MAAM,CAAC,gBAAgB,CAAC,CAAC;AACrE,uCAAuC;AAC1B,QAAA,WAAW,GAAkB,MAAM,CAAC,cAAc,CAAC,CAAC;AAEjE,gDAAgD;AACnC,QAAA,mBAAmB,GAAkB,MAAM,CACtD,sBAAsB,CACvB,CAAC"}
@@ -1,46 +0,0 @@
1
- import { IContractable } from "./contracts";
2
- import { ITagMeta } from "./meta";
3
- import { IValidationSchema, RequiredKeys, symbolFilePath, symbolTag, symbolTagConfigured } from "./utilities";
4
- export interface ITaggable {
5
- tags: TagType[];
6
- }
7
- export interface ITagDefinition<TConfig = void, TEnforceInputContract = void, TEnforceOutputContract = void> {
8
- id: string;
9
- meta?: ITagMeta;
10
- configSchema?: IValidationSchema<TConfig>;
11
- /**
12
- * Utilizing config at definition level stores its defaults
13
- */
14
- config?: TConfig;
15
- }
16
- export interface ITag<TConfig = void, TEnforceInputContract = void, TEnforceOutputContract = void> extends ITagDefinition<TConfig, TEnforceInputContract, TEnforceOutputContract>, IContractable<TConfig, TEnforceInputContract, TEnforceOutputContract> {
17
- /**
18
- * A special validation property.
19
- * It resolves to `true` if TConfig only has optional keys, otherwise `false`.
20
- */
21
- readonly __configHasOnlyOptionalKeys: RequiredKeys<TConfig> extends never ? true : false;
22
- config?: TConfig;
23
- /**
24
- * Checks if the tag exists in a taggable or a list of tags.
25
- */
26
- exists(target: ITaggable | TagType[]): boolean;
27
- /**
28
- * Creates a configured instance of the tag.
29
- */
30
- with(config: TConfig): ITagConfigured<TConfig, TEnforceInputContract, TEnforceOutputContract>;
31
- /**
32
- * Extracts the configuration of the tag from a taggable or a list of tags.
33
- */
34
- extract(target: ITaggable | TagType[]): TConfig | undefined;
35
- [symbolFilePath]: string;
36
- [symbolTag]: true;
37
- }
38
- type ITagWithOptionalConfig<TValue, TEnforceInputContract, TEnforceOutputContract> = ITag<any, TEnforceInputContract, TEnforceOutputContract> & {
39
- readonly __configHasOnlyOptionalKeys: true;
40
- };
41
- export interface ITagConfigured<TConfig = void, TEnforceInputContract = void, TEnforceOutputContract = void> extends ITag<TConfig, TEnforceInputContract, TEnforceOutputContract> {
42
- [symbolTagConfigured]: true;
43
- config: TConfig;
44
- }
45
- export type TagType = ITag<void, any, any> | ITagWithOptionalConfig<any, any, any> | ITagConfigured<any, any, any>;
46
- export {};
package/dist/types/tag.js DELETED
@@ -1,4 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const utilities_1 = require("./utilities");
4
- //# sourceMappingURL=tag.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"tag.js","sourceRoot":"","sources":["../../src/types/tag.ts"],"names":[],"mappings":";;AAEA,2CAMqB"}
@@ -1,44 +0,0 @@
1
- import { DependencyMapType, DependencyValuesType, IOptionalDependency, IValidationSchema, TaskMiddlewareAttachmentType } from "../defs";
2
- import { TagType } from "./tag";
3
- import { ITaskMeta } from "./meta";
4
- import { symbolFilePath, symbolTask } from "./symbols";
5
- import { EnsureInputSatisfiesContracts, EnsureOutputSatisfiesContracts, HasInputContracts, HasOutputContracts } from "./contracts";
6
- 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[]> {
7
- id: string;
8
- /**
9
- * Access other tasks/resources/events. Can be an object or a function when
10
- * you need late or config‑dependent resolution.
11
- */
12
- dependencies?: TDependencies | (() => TDependencies);
13
- /** Middleware applied around task execution. */
14
- middleware?: TMiddleware;
15
- /** Optional metadata used for docs, filtering and tooling. */
16
- meta?: TMeta;
17
- /**
18
- * Optional validation schema for runtime input validation.
19
- * When provided, task input will be validated before execution.
20
- */
21
- inputSchema?: IValidationSchema<TInput>;
22
- /**
23
- * Optional validation schema for the task result.
24
- * When provided, the result will be validated immediately after the task's
25
- * `run` resolves, without considering middleware.
26
- */
27
- resultSchema?: IValidationSchema<TOutput extends Promise<infer U> ? U : never>;
28
- run: (input: HasInputContracts<[...TTags, ...TMiddleware]> extends true ? EnsureInputSatisfiesContracts<[...TTags, ...TMiddleware], TInput> : TInput, dependencies: DependencyValuesType<TDependencies>) => HasOutputContracts<[...TTags, ...TMiddleware]> extends true ? EnsureOutputSatisfiesContracts<[...TTags, ...TMiddleware], TOutput> : TOutput;
29
- /**
30
- * Tags applied to the task that might define its behvaiour or impact the systems.
31
- */
32
- tags?: TTags;
33
- }
34
- 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> {
35
- [symbolFilePath]: string;
36
- [symbolTask]: true;
37
- id: string;
38
- dependencies: TDependencies | (() => TDependencies);
39
- computedDependencies?: DependencyValuesType<TDependencies>;
40
- middleware: TMiddleware;
41
- /** Return an optional dependency wrapper for this task. */
42
- optional: () => IOptionalDependency<ITask<TInput, TOutput, TDependencies, TMeta, TTags, TMiddleware>>;
43
- tags: TTags;
44
- }
@@ -1,4 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const symbols_1 = require("./symbols");
4
- //# sourceMappingURL=task.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"task.js","sourceRoot":"","sources":["../../src/types/task.ts"],"names":[],"mappings":";;AAUA,uCAAuD"}
@@ -1,48 +0,0 @@
1
- import { DependencyMapType, DependencyValuesType, IValidationSchema, ITask } from "../defs";
2
- import { TagType } from "./tag";
3
- import { IMiddlewareMeta } from "./meta";
4
- import { symbolFilePath, symbolMiddlewareConfigured, symbolTaskMiddleware } from "./symbols";
5
- import { IContractable } from "./contracts";
6
- export interface ITaskMiddlewareDefinition<TConfig = any, TEnforceInputContract = void, TEnforceOutputContract = void, TDependencies extends DependencyMapType = any> {
7
- id: string;
8
- /** Static or lazy dependency map. */
9
- dependencies?: TDependencies | ((config: TConfig) => TDependencies);
10
- /**
11
- * Optional validation schema for runtime config validation.
12
- * When provided, middleware config will be validated when .with() is called.
13
- */
14
- configSchema?: IValidationSchema<TConfig>;
15
- /**
16
- * The middleware body, called with task execution input.
17
- */
18
- run: (input: ITaskMiddlewareExecutionInput<TEnforceInputContract extends void ? any : TEnforceInputContract, TEnforceOutputContract extends void ? any : TEnforceOutputContract>, dependencies: DependencyValuesType<TDependencies>, config: TConfig) => Promise<any>;
19
- meta?: IMiddlewareMeta;
20
- tags?: TagType[];
21
- everywhere?: boolean | ((task: ITask<any, any, any, any>) => boolean);
22
- }
23
- export interface ITaskMiddleware<TConfig = any, TEnforceInputContract = void, TEnforceOutputContract = void, TDependencies extends DependencyMapType = any> extends ITaskMiddlewareDefinition<TConfig, TEnforceInputContract, TEnforceOutputContract, TDependencies>, IContractable<TConfig, TEnforceInputContract, TEnforceOutputContract> {
24
- [symbolTaskMiddleware]: true;
25
- [symbolFilePath]: string;
26
- id: string;
27
- dependencies: TDependencies | (() => TDependencies);
28
- /** Current configuration object (empty by default). */
29
- config: TConfig;
30
- /** Configure the middleware and return a marked, configured instance. */
31
- with: (config: TConfig) => ITaskMiddlewareConfigured<TConfig, TEnforceInputContract, TEnforceOutputContract, TDependencies>;
32
- tags: TagType[];
33
- }
34
- export interface ITaskMiddlewareConfigured<TConfig = any, TEnforceInputContract = void, TEnforceOutputContract = void, TDependencies extends DependencyMapType = any> extends ITaskMiddleware<TConfig, TEnforceInputContract, TEnforceOutputContract, TDependencies> {
35
- [symbolMiddlewareConfigured]: true;
36
- config: TConfig;
37
- }
38
- export interface ITaskMiddlewareExecutionInput<TTaskInput = any, TTaskOutput = any> {
39
- /** Task hook */
40
- task: {
41
- definition: ITask<TTaskInput, any, any, any>;
42
- input: TTaskInput;
43
- };
44
- next: (taskInput?: TTaskInput) => Promise<TTaskOutput>;
45
- }
46
- export type TaskMiddlewareAttachmentType = ITaskMiddleware<void, any, any, any> | ITaskMiddleware<{
47
- [K in any]?: any;
48
- }, any, any, any> | ITaskMiddlewareConfigured<any, any, any, any>;
@@ -1,4 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const symbols_1 = require("./symbols");
4
- //# sourceMappingURL=taskMiddleware.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"taskMiddleware.js","sourceRoot":"","sources":["../../src/types/taskMiddleware.ts"],"names":[],"mappings":";;AAQA,uCAImB"}
@@ -1,110 +0,0 @@
1
- import { IResource, IResourceWithConfig } from "./resource";
2
- import { ITask } from "./task";
3
- import { ITaskMiddleware } from "./taskMiddleware";
4
- import { IResourceMiddleware } from "./resourceMiddleware";
5
- import { IHook } from "./hook";
6
- import { IEvent, IEventDefinition } from "./event";
7
- import { ITag } from "./tag";
8
- import { symbolOptionalDependency } from "./symbols";
9
- export * from "./symbols";
10
- /**
11
- * Generic validation schema interface that can be implemented by any validation library.
12
- * Compatible with Zod, Yup, Joi, and other validation libraries.
13
- */
14
- export interface IValidationSchema<T = any> {
15
- /**
16
- * Parse and validate the input data.
17
- * Should throw an error if validation fails.
18
- * Can transform the data if the schema supports transformations.
19
- */
20
- parse(input: unknown): T;
21
- }
22
- /**
23
- * Core public TypeScript types for BlueLibs Runner.
24
- *
25
- * This file contains the strongly-typed contract for tasks, resources, events
26
- * and middleware. It mirrors the mental model described in the README:
27
- * - Tasks are functions
28
- * - Resources are singletons (with init/dispose hooks)
29
- * - Events are simple, strongly-typed emissions
30
- * - Middleware can target both tasks and resources
31
- *
32
- * DX goals:
33
- * - Crystal‑clear generics and helper types that infer dependency shapes
34
- * - Friendly JSDoc you can hover in editors to understand usage instantly
35
- * - Safe overrides and strong typing around config and register mechanics
36
- */
37
- export type RequiredKeys<T> = {
38
- [K in keyof T]-?: {} extends Pick<T, K> ? never : K;
39
- }[keyof T];
40
- /**
41
- * The reason we accept null and undefined is because we want to be able to offer beautiful DX:
42
- * overrides: [
43
- * process.env.NODE_ENV === 'production' ? prodEmailer : null,
44
- * ]
45
- */
46
- 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;
47
- /**
48
- * A mapping of dependency keys to Runner definitions. Used in `dependencies`
49
- * for tasks and resources. Values are later transformed into the actual
50
- * callable/value shape by `DependencyValuesType`.
51
- */
52
- 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>>>;
53
- /** Wrapper type marking a dependency as optional at wiring time */
54
- export interface IOptionalDependency<T> {
55
- /** The wrapped dependency definition */
56
- inner: T;
57
- /** Brand symbol for optional dependency */
58
- [symbolOptionalDependency]: true;
59
- }
60
- type ExtractTaskInput<T> = T extends ITask<infer I, any, infer D> ? I : never;
61
- type ExtractTaskOutput<T> = T extends ITask<any, infer O, infer D> ? O : never;
62
- type ExtractResourceValue<T> = T extends IResource<any, infer V, infer D> ? V extends Promise<infer U> ? U : V : never;
63
- export type ExtractEventParams<T> = T extends IEventDefinition<infer P> ? P : T extends IEvent<infer P> ? P : never;
64
- export type UnionToIntersection<U> = (U extends any ? (x: U) => any : never) extends (x: infer I) => any ? I : never;
65
- export type CommonPayload<T extends readonly IEventDefinition<any>[] | IEventDefinition<any>> = T extends readonly IEventDefinition<any>[] ? {
66
- [K in keyof ExtractEventParams<T[number]>]: UnionToIntersection<ExtractEventParams<T[number]> extends any ? ExtractEventParams<T[number]>[K] : never>;
67
- } : ExtractEventParams<T>;
68
- /**
69
- * Task dependencies transform into callable functions: call with the task input
70
- * and you receive the task output.
71
- */
72
- type TaskDependency<I, O> = (...args: I extends null | void ? [] : [I]) => O;
73
- /**
74
- * Resource dependencies resolve to the resource's value directly.
75
- */
76
- type ResourceDependency<V> = V;
77
- /**
78
- * Event dependencies resolve to an emitter function. If the payload type is
79
- * `void`, the function can be called with zero args (or an empty object).
80
- */
81
- type EventDependency<P> = P extends void ? (() => Promise<void>) & ((input?: Record<string, never>) => Promise<void>) : (input: P) => Promise<void>;
82
- /**
83
- * Transforms a dependency definition into the usable shape inside `run`/`init`:
84
- * - Task -> callable function
85
- * - Resource -> resolved value
86
- * - Event -> emit function
87
- */
88
- 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<ExtractEventParams<T>> : T extends IOptionalDependency<infer U> ? DependencyValueType<U> | undefined : never;
89
- export type DependencyValuesType<T extends DependencyMapType> = {
90
- [K in keyof T]: DependencyValueType<T[K]>;
91
- };
92
- export type TaskLocalInterceptor<TInput, TOutput> = (next: (input: TInput) => TOutput, input: TInput) => TOutput;
93
- export type TaskDependencyWithIntercept<TInput, TOutput> = TaskDependency<TInput, TOutput> & {
94
- intercept: (middleware: TaskLocalInterceptor<TInput, TOutput>) => void;
95
- };
96
- /** Resource-context dependency typing where tasks expose intercept() */
97
- 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<ExtractEventParams<T>> : T extends IOptionalDependency<infer U> ? ResourceDependencyValueType<U> | undefined : never;
98
- export type ResourceDependencyValuesType<T extends DependencyMapType> = {
99
- [K in keyof T]: ResourceDependencyValueType<T[K]>;
100
- };
101
- /**
102
- * Anything you can put inside a resource's `register: []`.
103
- * - Resources (with or without `.with()`)
104
- * - Tasks
105
- * - Middleware
106
- * - Events
107
- */
108
- export type RegisterableItems<T = any> = IResourceWithConfig<any, any, any, any, any, any, any> | IResource<void, any, any, any, any, any, any> | IResource<{
109
- [K in any]?: any;
110
- }, any, any, any, any, any, any> | ITask<any, any, any, any> | IHook<any, any> | ITaskMiddleware<any, any, any, any> | IResourceMiddleware<any, any, any, any> | IEvent<any> | ITag<any, any, any>;
@@ -1,19 +0,0 @@
1
- "use strict";
2
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
- if (k2 === undefined) k2 = k;
4
- var desc = Object.getOwnPropertyDescriptor(m, k);
5
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
- desc = { enumerable: true, get: function() { return m[k]; } };
7
- }
8
- Object.defineProperty(o, k2, desc);
9
- }) : (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- o[k2] = m[k];
12
- }));
13
- var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
- for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
- };
16
- Object.defineProperty(exports, "__esModule", { value: true });
17
- const symbols_1 = require("./symbols");
18
- __exportStar(require("./symbols"), exports);
19
- //# sourceMappingURL=utilities.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"utilities.js","sourceRoot":"","sources":["../../src/types/utilities.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAOA,uCAAqD;AAErD,4CAA0B"}