@bluelibs/runner 3.4.2 → 4.0.1
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.
- package/AI.md +621 -0
- package/README.md +1024 -577
- package/dist/context.d.ts +4 -8
- package/dist/context.js +5 -12
- package/dist/context.js.map +1 -1
- package/dist/define.d.ts +9 -113
- package/dist/define.js +29 -358
- package/dist/define.js.map +1 -1
- package/dist/definers/defineEvent.d.ts +2 -0
- package/dist/definers/defineEvent.js +23 -0
- package/dist/definers/defineEvent.js.map +1 -0
- package/dist/definers/defineHook.d.ts +6 -0
- package/dist/definers/defineHook.js +24 -0
- package/dist/definers/defineHook.js.map +1 -0
- package/dist/definers/defineOverride.d.ts +14 -0
- package/dist/definers/defineOverride.js +13 -0
- package/dist/definers/defineOverride.js.map +1 -0
- package/dist/definers/defineResource.d.ts +2 -0
- package/dist/definers/defineResource.js +69 -0
- package/dist/definers/defineResource.js.map +1 -0
- package/dist/definers/defineResourceMiddleware.d.ts +2 -0
- package/dist/definers/defineResourceMiddleware.js +42 -0
- package/dist/definers/defineResourceMiddleware.js.map +1 -0
- package/dist/definers/defineTag.d.ts +12 -0
- package/dist/definers/defineTag.js +106 -0
- package/dist/definers/defineTag.js.map +1 -0
- package/dist/definers/defineTask.d.ts +15 -0
- package/dist/definers/defineTask.js +42 -0
- package/dist/definers/defineTask.js.map +1 -0
- package/dist/definers/defineTaskMiddleware.d.ts +2 -0
- package/dist/definers/defineTaskMiddleware.js +42 -0
- package/dist/definers/defineTaskMiddleware.js.map +1 -0
- package/dist/definers/tools.d.ts +45 -0
- package/dist/definers/tools.js +75 -0
- package/dist/definers/tools.js.map +1 -0
- package/dist/defs.d.ts +16 -424
- package/dist/defs.js +26 -38
- package/dist/defs.js.map +1 -1
- package/dist/errors.d.ts +23 -8
- package/dist/errors.js +50 -10
- package/dist/errors.js.map +1 -1
- package/dist/globals/globalEvents.d.ts +15 -39
- package/dist/globals/globalEvents.js +20 -81
- package/dist/globals/globalEvents.js.map +1 -1
- package/dist/globals/globalMiddleware.d.ts +24 -17
- package/dist/globals/globalMiddleware.js +12 -4
- package/dist/globals/globalMiddleware.js.map +1 -1
- package/dist/globals/globalResources.d.ts +13 -28
- package/dist/globals/globalResources.js +15 -7
- package/dist/globals/globalResources.js.map +1 -1
- package/dist/globals/globalTags.d.ts +9 -0
- package/dist/globals/globalTags.js +23 -0
- package/dist/globals/globalTags.js.map +1 -0
- package/dist/globals/middleware/cache.middleware.d.ts +10 -17
- package/dist/globals/middleware/cache.middleware.js +4 -16
- package/dist/globals/middleware/cache.middleware.js.map +1 -1
- package/dist/globals/middleware/requireContext.middleware.d.ts +1 -1
- package/dist/globals/middleware/requireContext.middleware.js +5 -14
- package/dist/globals/middleware/requireContext.middleware.js.map +1 -1
- package/dist/globals/middleware/retry.middleware.d.ts +2 -1
- package/dist/globals/middleware/retry.middleware.js +32 -5
- package/dist/globals/middleware/retry.middleware.js.map +1 -1
- package/dist/globals/middleware/timeout.middleware.d.ts +2 -1
- package/dist/globals/middleware/timeout.middleware.js +31 -5
- package/dist/globals/middleware/timeout.middleware.js.map +1 -1
- package/dist/globals/resources/debug/debug.resource.d.ts +7 -0
- package/dist/globals/resources/debug/debug.resource.js +29 -0
- package/dist/globals/resources/debug/debug.resource.js.map +1 -0
- package/dist/globals/resources/debug/debug.tag.d.ts +2 -0
- package/dist/globals/resources/debug/debug.tag.js +12 -0
- package/dist/globals/resources/debug/debug.tag.js.map +1 -0
- package/dist/globals/resources/debug/debugConfig.resource.d.ts +22 -0
- package/dist/globals/resources/debug/debugConfig.resource.js +20 -0
- package/dist/globals/resources/debug/debugConfig.resource.js.map +1 -0
- package/dist/globals/resources/debug/executionTracker.middleware.d.ts +50 -0
- package/dist/globals/resources/debug/executionTracker.middleware.js +87 -0
- package/dist/globals/resources/debug/executionTracker.middleware.js.map +1 -0
- package/dist/globals/resources/debug/globalEvent.hook.d.ts +27 -0
- package/dist/globals/resources/debug/globalEvent.hook.js +38 -0
- package/dist/globals/resources/debug/globalEvent.hook.js.map +1 -0
- package/dist/globals/resources/debug/hook.hook.d.ts +25 -0
- package/dist/globals/resources/debug/hook.hook.js +42 -0
- package/dist/globals/resources/debug/hook.hook.js.map +1 -0
- package/dist/globals/resources/debug/index.d.ts +6 -0
- package/dist/{types → globals/resources/debug}/index.js +6 -11
- package/dist/globals/resources/debug/index.js.map +1 -0
- package/dist/globals/resources/debug/middleware.hook.d.ts +25 -0
- package/dist/globals/resources/debug/middleware.hook.js +71 -0
- package/dist/globals/resources/debug/middleware.hook.js.map +1 -0
- package/dist/globals/resources/debug/types.d.ts +25 -0
- package/dist/globals/resources/debug/types.js +65 -0
- package/dist/globals/resources/debug/types.js.map +1 -0
- package/dist/globals/resources/debug/utils.d.ts +2 -0
- package/dist/globals/resources/debug/utils.js +9 -0
- package/dist/globals/resources/debug/utils.js.map +1 -0
- package/dist/globals/resources/queue.resource.d.ts +3 -3
- package/dist/globals/resources/queue.resource.js.map +1 -1
- package/dist/globals/types.d.ts +1 -0
- package/dist/{task.types.js → globals/types.js} +2 -7
- package/dist/globals/types.js.map +1 -0
- package/dist/index.d.ts +58 -85
- package/dist/index.js +23 -10
- package/dist/index.js.map +1 -1
- package/dist/models/DependencyProcessor.d.ts +8 -6
- package/dist/models/DependencyProcessor.js +116 -33
- package/dist/models/DependencyProcessor.js.map +1 -1
- package/dist/models/EventManager.d.ts +127 -7
- package/dist/models/EventManager.js +251 -78
- package/dist/models/EventManager.js.map +1 -1
- package/dist/models/LogPrinter.d.ts +55 -0
- package/dist/models/LogPrinter.js +196 -0
- package/dist/models/LogPrinter.js.map +1 -0
- package/dist/models/Logger.d.ts +47 -27
- package/dist/models/Logger.js +133 -155
- package/dist/models/Logger.js.map +1 -1
- package/dist/models/MiddlewareManager.d.ts +86 -0
- package/dist/models/MiddlewareManager.js +409 -0
- package/dist/models/MiddlewareManager.js.map +1 -0
- package/dist/models/OverrideManager.d.ts +3 -3
- package/dist/models/OverrideManager.js +22 -7
- package/dist/models/OverrideManager.js.map +1 -1
- package/dist/models/ResourceInitializer.d.ts +4 -3
- package/dist/models/ResourceInitializer.js +12 -68
- package/dist/models/ResourceInitializer.js.map +1 -1
- package/dist/models/RunResult.d.ts +35 -0
- package/dist/models/RunResult.js +68 -0
- package/dist/models/RunResult.js.map +1 -0
- package/dist/models/Store.d.ts +30 -17
- package/dist/models/Store.js +87 -25
- package/dist/models/Store.js.map +1 -1
- package/dist/models/StoreRegistry.d.ts +34 -19
- package/dist/models/StoreRegistry.js +248 -100
- package/dist/models/StoreRegistry.js.map +1 -1
- package/dist/models/StoreValidator.d.ts +5 -7
- package/dist/models/StoreValidator.js +50 -17
- package/dist/models/StoreValidator.js.map +1 -1
- package/dist/models/TaskRunner.d.ts +3 -2
- package/dist/models/TaskRunner.js +6 -103
- package/dist/models/TaskRunner.js.map +1 -1
- package/dist/models/UnhandledError.d.ts +11 -0
- package/dist/models/UnhandledError.js +30 -0
- package/dist/models/UnhandledError.js.map +1 -0
- package/dist/models/index.d.ts +3 -0
- package/dist/models/index.js +3 -0
- package/dist/models/index.js.map +1 -1
- package/dist/{tools → models/utils}/findCircularDependencies.js +8 -16
- package/dist/models/utils/findCircularDependencies.js.map +1 -0
- package/dist/models/utils/safeStringify.d.ts +3 -0
- package/dist/models/utils/safeStringify.js +45 -0
- package/dist/models/utils/safeStringify.js.map +1 -0
- package/dist/processHooks.d.ts +2 -0
- package/dist/processHooks.js +70 -0
- package/dist/processHooks.js.map +1 -0
- package/dist/run.d.ts +14 -27
- package/dist/run.js +100 -36
- package/dist/run.js.map +1 -1
- package/dist/testing.d.ts +5 -4
- package/dist/testing.js +3 -2
- package/dist/testing.js.map +1 -1
- package/dist/tools/getCallerFile.d.ts +0 -8
- package/dist/tools/getCallerFile.js +0 -51
- package/dist/tools/getCallerFile.js.map +1 -1
- package/dist/types/contracts.d.ts +55 -0
- package/dist/types/contracts.js +4 -0
- package/dist/types/contracts.js.map +1 -0
- package/dist/types/event.d.ts +26 -7
- package/dist/types/event.js +1 -1
- package/dist/types/event.js.map +1 -1
- package/dist/types/hook.d.ts +21 -0
- package/dist/{models/StoreTypes.js → types/hook.js} +2 -1
- package/dist/types/hook.js.map +1 -0
- package/dist/types/meta.d.ts +6 -1
- package/dist/types/meta.js +4 -2
- package/dist/types/meta.js.map +1 -1
- package/dist/types/resource.d.ts +40 -52
- package/dist/types/resource.js +1 -0
- package/dist/types/resource.js.map +1 -1
- package/dist/types/resourceMiddleware.d.ts +47 -0
- package/dist/{middleware.types.js → types/resourceMiddleware.js} +1 -1
- package/dist/types/resourceMiddleware.js.map +1 -0
- package/dist/types/runner.d.ts +37 -0
- package/dist/types/{base.js → runner.js} +1 -1
- package/dist/types/runner.js.map +1 -0
- package/dist/types/storeTypes.d.ts +40 -0
- package/dist/types/{metadata.js → storeTypes.js} +1 -1
- package/dist/types/storeTypes.js.map +1 -0
- package/dist/types/symbols.d.ts +10 -21
- package/dist/types/symbols.js +17 -22
- package/dist/types/symbols.js.map +1 -1
- package/dist/types/tag.d.ts +46 -0
- package/dist/{resource.types.js → types/tag.js} +2 -1
- package/dist/types/tag.js.map +1 -0
- package/dist/types/task.d.ts +28 -52
- package/dist/types/task.js +1 -0
- package/dist/types/task.js.map +1 -1
- package/dist/types/taskMiddleware.d.ts +48 -0
- package/dist/{event.types.js → types/taskMiddleware.js} +1 -1
- package/dist/types/taskMiddleware.js.map +1 -0
- package/dist/types/utilities.d.ts +105 -6
- package/dist/types/utilities.js +16 -2
- package/dist/types/utilities.js.map +1 -1
- package/package.json +14 -5
- package/dist/cli/extract-docs.d.ts +0 -2
- package/dist/cli/extract-docs.js +0 -88
- package/dist/cli/extract-docs.js.map +0 -1
- package/dist/common.types.d.ts +0 -20
- package/dist/common.types.js +0 -4
- package/dist/common.types.js.map +0 -1
- package/dist/defs/core.d.ts +0 -144
- package/dist/defs/core.js +0 -6
- package/dist/defs/core.js.map +0 -1
- package/dist/defs/symbols.d.ts +0 -42
- package/dist/defs/symbols.js +0 -45
- package/dist/defs/symbols.js.map +0 -1
- package/dist/defs/tags.d.ts +0 -70
- package/dist/defs/tags.js +0 -6
- package/dist/defs/tags.js.map +0 -1
- package/dist/defs.returnTag.d.ts +0 -36
- package/dist/defs.returnTag.js +0 -4
- package/dist/defs.returnTag.js.map +0 -1
- package/dist/docs/introspect.d.ts +0 -7
- package/dist/docs/introspect.js +0 -199
- package/dist/docs/introspect.js.map +0 -1
- package/dist/docs/markdown.d.ts +0 -2
- package/dist/docs/markdown.js +0 -148
- package/dist/docs/markdown.js.map +0 -1
- package/dist/docs/model.d.ts +0 -62
- package/dist/docs/model.js +0 -33
- package/dist/docs/model.js.map +0 -1
- package/dist/event.types.d.ts +0 -18
- package/dist/event.types.js.map +0 -1
- package/dist/examples/express-mongo/index.d.ts +0 -0
- package/dist/examples/express-mongo/index.js +0 -3
- package/dist/examples/express-mongo/index.js.map +0 -1
- package/dist/examples/registrator-example.d.ts +0 -122
- package/dist/examples/registrator-example.js +0 -147
- package/dist/examples/registrator-example.js.map +0 -1
- package/dist/express/docsRouter.d.ts +0 -12
- package/dist/express/docsRouter.js +0 -54
- package/dist/express/docsRouter.js.map +0 -1
- package/dist/globalEvents.d.ts +0 -40
- package/dist/globalEvents.js +0 -94
- package/dist/globalEvents.js.map +0 -1
- package/dist/globalResources.d.ts +0 -10
- package/dist/globalResources.js +0 -43
- package/dist/globalResources.js.map +0 -1
- package/dist/middleware.types.d.ts +0 -40
- package/dist/middleware.types.js.map +0 -1
- package/dist/models/StoreConstants.d.ts +0 -14
- package/dist/models/StoreConstants.js +0 -19
- package/dist/models/StoreConstants.js.map +0 -1
- package/dist/models/StoreTypes.d.ts +0 -21
- package/dist/models/StoreTypes.js.map +0 -1
- package/dist/models/VarStore.d.ts +0 -17
- package/dist/models/VarStore.js +0 -60
- package/dist/models/VarStore.js.map +0 -1
- package/dist/resource.types.d.ts +0 -31
- package/dist/resource.types.js.map +0 -1
- package/dist/symbols.d.ts +0 -24
- package/dist/symbols.js +0 -29
- package/dist/symbols.js.map +0 -1
- package/dist/t1.d.ts +0 -1
- package/dist/t1.js +0 -13
- package/dist/t1.js.map +0 -1
- package/dist/task.types.d.ts +0 -55
- package/dist/task.types.js.map +0 -1
- package/dist/tools/findCircularDependencies.js.map +0 -1
- package/dist/tools/registratorId.d.ts +0 -4
- package/dist/tools/registratorId.js +0 -40
- package/dist/tools/registratorId.js.map +0 -1
- package/dist/tools/simpleHash.d.ts +0 -9
- package/dist/tools/simpleHash.js +0 -34
- package/dist/tools/simpleHash.js.map +0 -1
- package/dist/types/base-interfaces.d.ts +0 -18
- package/dist/types/base-interfaces.js +0 -6
- package/dist/types/base-interfaces.js.map +0 -1
- package/dist/types/base.d.ts +0 -13
- package/dist/types/base.js.map +0 -1
- package/dist/types/dependencies.d.ts +0 -51
- package/dist/types/dependencies.js +0 -3
- package/dist/types/dependencies.js.map +0 -1
- package/dist/types/dependency-core.d.ts +0 -14
- package/dist/types/dependency-core.js +0 -5
- package/dist/types/dependency-core.js.map +0 -1
- package/dist/types/events.d.ts +0 -52
- package/dist/types/events.js +0 -6
- package/dist/types/events.js.map +0 -1
- package/dist/types/hooks.d.ts +0 -16
- package/dist/types/hooks.js +0 -5
- package/dist/types/hooks.js.map +0 -1
- package/dist/types/index.d.ts +0 -8
- package/dist/types/index.js.map +0 -1
- package/dist/types/metadata.d.ts +0 -75
- package/dist/types/metadata.js.map +0 -1
- package/dist/types/middleware.d.ts +0 -63
- package/dist/types/middleware.js +0 -3
- package/dist/types/middleware.js.map +0 -1
- package/dist/types/registerable.d.ts +0 -10
- package/dist/types/registerable.js +0 -5
- package/dist/types/registerable.js.map +0 -1
- package/dist/types/resources.d.ts +0 -44
- package/dist/types/resources.js +0 -5
- package/dist/types/resources.js.map +0 -1
- package/dist/types/tasks.d.ts +0 -41
- package/dist/types/tasks.js +0 -5
- package/dist/types/tasks.js.map +0 -1
- package/src/__tests__/benchmark/benchmark.test.ts +0 -148
- package/src/__tests__/benchmark/task-benchmark.test.ts +0 -132
- package/src/__tests__/context.test.ts +0 -91
- package/src/__tests__/createTestResource.test.ts +0 -139
- package/src/__tests__/errors.test.ts +0 -341
- package/src/__tests__/globalEvents.test.ts +0 -542
- package/src/__tests__/globals/cache.middleware.test.ts +0 -772
- package/src/__tests__/globals/queue.resource.test.ts +0 -141
- package/src/__tests__/globals/requireContext.middleware.test.ts +0 -98
- package/src/__tests__/globals/retry.middleware.test.ts +0 -157
- package/src/__tests__/globals/timeout.middleware.test.ts +0 -88
- package/src/__tests__/index.helper.test.ts +0 -55
- package/src/__tests__/models/EventManager.test.ts +0 -585
- package/src/__tests__/models/Logger.test.ts +0 -519
- package/src/__tests__/models/Queue.test.ts +0 -189
- package/src/__tests__/models/ResourceInitializer.test.ts +0 -148
- package/src/__tests__/models/Semaphore.test.ts +0 -713
- package/src/__tests__/models/Store.test.ts +0 -227
- package/src/__tests__/models/TaskRunner.test.ts +0 -221
- package/src/__tests__/override.test.ts +0 -104
- package/src/__tests__/recursion/README.md +0 -3
- package/src/__tests__/recursion/a.resource.ts +0 -25
- package/src/__tests__/recursion/b.resource.ts +0 -33
- package/src/__tests__/recursion/c.resource.ts +0 -18
- package/src/__tests__/run.anonymous.test.ts +0 -706
- package/src/__tests__/run.dynamic-register-and-dependencies.test.ts +0 -1185
- package/src/__tests__/run.middleware.test.ts +0 -549
- package/src/__tests__/run.overrides.test.ts +0 -424
- package/src/__tests__/run.test.ts +0 -1040
- package/src/__tests__/setOutput.test.ts +0 -244
- package/src/__tests__/tags.test.ts +0 -396
- package/src/__tests__/tools/findCircularDependencies.test.ts +0 -217
- package/src/__tests__/tools/getCallerFile.test.ts +0 -179
- package/src/__tests__/typesafety.test.ts +0 -423
- package/src/__tests__/validation-edge-cases.test.ts +0 -111
- package/src/__tests__/validation-interface.test.ts +0 -428
- package/src/context.ts +0 -86
- package/src/define.ts +0 -480
- package/src/defs.returnTag.ts +0 -91
- package/src/defs.ts +0 -596
- package/src/errors.ts +0 -105
- package/src/globals/globalEvents.ts +0 -125
- package/src/globals/globalMiddleware.ts +0 -16
- package/src/globals/globalResources.ts +0 -53
- package/src/globals/middleware/cache.middleware.ts +0 -115
- package/src/globals/middleware/requireContext.middleware.ts +0 -36
- package/src/globals/middleware/retry.middleware.ts +0 -56
- package/src/globals/middleware/timeout.middleware.ts +0 -46
- package/src/globals/resources/queue.resource.ts +0 -34
- package/src/index.ts +0 -39
- package/src/models/DependencyProcessor.ts +0 -257
- package/src/models/EventManager.ts +0 -210
- package/src/models/Logger.ts +0 -282
- package/src/models/OverrideManager.ts +0 -79
- package/src/models/Queue.ts +0 -66
- package/src/models/ResourceInitializer.ts +0 -165
- package/src/models/Semaphore.ts +0 -208
- package/src/models/Store.ts +0 -193
- package/src/models/StoreConstants.ts +0 -18
- package/src/models/StoreRegistry.ts +0 -253
- package/src/models/StoreTypes.ts +0 -47
- package/src/models/StoreValidator.ts +0 -43
- package/src/models/TaskRunner.ts +0 -203
- package/src/models/index.ts +0 -8
- package/src/run.ts +0 -116
- package/src/testing.ts +0 -66
- package/src/tools/findCircularDependencies.ts +0 -69
- package/src/tools/getCallerFile.ts +0 -96
- /package/dist/{tools → models/utils}/findCircularDependencies.d.ts +0 -0
package/dist/cli/extract-docs.js
DELETED
|
@@ -1,88 +0,0 @@
|
|
|
1
|
-
#!/usr/bin/env node
|
|
2
|
-
"use strict";
|
|
3
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
-
const path = require("path");
|
|
5
|
-
const fs = require("fs");
|
|
6
|
-
// Note: avoid file URLs to keep CommonJS require working well
|
|
7
|
-
const introspect_1 = require("../docs/introspect");
|
|
8
|
-
function parseArgs(argv) {
|
|
9
|
-
const args = { entry: "", outDir: "./documentation" };
|
|
10
|
-
const offset = argv[2] === "extract-docs" ? 3 : 2;
|
|
11
|
-
const rest = argv.slice(offset);
|
|
12
|
-
if (!rest[0]) {
|
|
13
|
-
console.error("Usage: runner extract-docs <entry> [--export <name>] [--out-dir <dir>] [--include-globals] [--config <path>] [--format json|md|all]");
|
|
14
|
-
process.exit(1);
|
|
15
|
-
}
|
|
16
|
-
args.entry = rest[0];
|
|
17
|
-
for (let i = 1; i < rest.length; i++) {
|
|
18
|
-
const flag = rest[i];
|
|
19
|
-
if (flag === "--export") {
|
|
20
|
-
args.exportName = rest[++i];
|
|
21
|
-
}
|
|
22
|
-
else if (flag === "--out-dir") {
|
|
23
|
-
args.outDir = rest[++i];
|
|
24
|
-
}
|
|
25
|
-
else if (flag === "--include-globals") {
|
|
26
|
-
args.includeGlobals = true;
|
|
27
|
-
}
|
|
28
|
-
else if (flag === "--config") {
|
|
29
|
-
args.configPath = rest[++i];
|
|
30
|
-
}
|
|
31
|
-
else if (flag === "--format") {
|
|
32
|
-
const val = rest[++i];
|
|
33
|
-
if (val === "json" || val === "md" || val === "all") {
|
|
34
|
-
args.format = val;
|
|
35
|
-
}
|
|
36
|
-
}
|
|
37
|
-
}
|
|
38
|
-
return args;
|
|
39
|
-
}
|
|
40
|
-
async function loadModule(entryPath) {
|
|
41
|
-
const resolved = path.isAbsolute(entryPath)
|
|
42
|
-
? entryPath
|
|
43
|
-
: path.resolve(process.cwd(), entryPath);
|
|
44
|
-
// Prefer dynamic import; in CommonJS this becomes require(resolved)
|
|
45
|
-
return await Promise.resolve(`${resolved}`).then(s => require(s));
|
|
46
|
-
}
|
|
47
|
-
async function main() {
|
|
48
|
-
const args = parseArgs(process.argv);
|
|
49
|
-
const mod = await loadModule(args.entry);
|
|
50
|
-
const exportName = args.exportName || "default";
|
|
51
|
-
let resource;
|
|
52
|
-
if (exportName === "default") {
|
|
53
|
-
resource = (mod && mod.default) || mod;
|
|
54
|
-
}
|
|
55
|
-
else {
|
|
56
|
-
resource = mod[exportName];
|
|
57
|
-
}
|
|
58
|
-
if (!resource || typeof resource !== "object") {
|
|
59
|
-
console.error(`Could not find exported resource '${exportName}' from ${args.entry}`);
|
|
60
|
-
process.exit(2);
|
|
61
|
-
}
|
|
62
|
-
const config = args.configPath
|
|
63
|
-
? JSON.parse(fs.readFileSync(args.configPath, "utf-8"))
|
|
64
|
-
: {};
|
|
65
|
-
const graph = await (0, introspect_1.introspectResource)(resource, config, {
|
|
66
|
-
includeGlobals: args.includeGlobals,
|
|
67
|
-
});
|
|
68
|
-
const outDir = path.isAbsolute(args.outDir)
|
|
69
|
-
? args.outDir
|
|
70
|
-
: path.resolve(process.cwd(), args.outDir);
|
|
71
|
-
fs.mkdirSync(outDir, { recursive: true });
|
|
72
|
-
const format = args.format || "json";
|
|
73
|
-
if (format === "json" || format === "all") {
|
|
74
|
-
const outFile = path.join(outDir, "graph.json");
|
|
75
|
-
fs.writeFileSync(outFile, JSON.stringify(graph, null, 2), "utf-8");
|
|
76
|
-
console.log(`Docs graph written to ${outFile}`);
|
|
77
|
-
}
|
|
78
|
-
if (format === "md" || format === "all") {
|
|
79
|
-
const { renderMarkdown } = await Promise.resolve().then(() => require("../docs/markdown"));
|
|
80
|
-
renderMarkdown(graph, outDir);
|
|
81
|
-
console.log(`Markdown docs written under ${outDir}`);
|
|
82
|
-
}
|
|
83
|
-
}
|
|
84
|
-
main().catch((err) => {
|
|
85
|
-
console.error(err);
|
|
86
|
-
process.exit(99);
|
|
87
|
-
});
|
|
88
|
-
//# sourceMappingURL=extract-docs.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"extract-docs.js","sourceRoot":"","sources":["../../src/cli/extract-docs.ts"],"names":[],"mappings":";;;AACA,6BAA6B;AAC7B,yBAAyB;AACzB,8DAA8D;AAC9D,mDAAwD;AAYxD,SAAS,SAAS,CAAC,IAAc;IAC/B,MAAM,IAAI,GAAS,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,iBAAiB,EAAS,CAAC;IACnE,MAAM,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,KAAK,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAClD,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAChC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QACb,OAAO,CAAC,KAAK,CACX,qIAAqI,CACtI,CAAC;QACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IACD,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;IACrB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACrC,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QACrB,IAAI,IAAI,KAAK,UAAU,EAAE,CAAC;YACxB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;QAC9B,CAAC;aAAM,IAAI,IAAI,KAAK,WAAW,EAAE,CAAC;YAChC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;QAC1B,CAAC;aAAM,IAAI,IAAI,KAAK,mBAAmB,EAAE,CAAC;YACxC,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;QAC7B,CAAC;aAAM,IAAI,IAAI,KAAK,UAAU,EAAE,CAAC;YAC/B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;QAC9B,CAAC;aAAM,IAAI,IAAI,KAAK,UAAU,EAAE,CAAC;YAC/B,MAAM,GAAG,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;YACtB,IAAI,GAAG,KAAK,MAAM,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,KAAK,EAAE,CAAC;gBACnD,IAAY,CAAC,MAAM,GAAG,GAAG,CAAC;YAC7B,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,KAAK,UAAU,UAAU,CAAC,SAAiB;IACzC,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC;QACzC,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,SAAS,CAAC,CAAC;IAC3C,oEAAoE;IACpE,OAAO,yBAAa,QAAe,yBAAC,CAAC;AACvC,CAAC;AAED,KAAK,UAAU,IAAI;IACjB,MAAM,IAAI,GAAG,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACrC,MAAM,GAAG,GAAG,MAAM,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACzC,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,SAAS,CAAC;IAChD,IAAI,QAAmB,CAAC;IACxB,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC7B,QAAQ,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC;IACzC,CAAC;SAAM,CAAC;QACN,QAAQ,GAAG,GAAG,CAAC,UAAU,CAAC,CAAC;IAC7B,CAAC;IACD,IAAI,CAAC,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;QAC9C,OAAO,CAAC,KAAK,CACX,qCAAqC,UAAU,UAAU,IAAI,CAAC,KAAK,EAAE,CACtE,CAAC;QACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU;QAC5B,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QACvD,CAAC,CAAC,EAAE,CAAC;IACP,MAAM,KAAK,GAAG,MAAM,IAAA,+BAAkB,EAAC,QAAQ,EAAE,MAAM,EAAE;QACvD,cAAc,EAAE,IAAI,CAAC,cAAc;KACpC,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,MAAO,CAAC;QAC1C,CAAC,CAAC,IAAI,CAAC,MAAO;QACd,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,IAAI,CAAC,MAAO,CAAC,CAAC;IAC9C,EAAE,CAAC,SAAS,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC1C,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC;IACrC,IAAI,MAAM,KAAK,MAAM,IAAI,MAAM,KAAK,KAAK,EAAE,CAAC;QAC1C,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;QAChD,EAAE,CAAC,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;QACnE,OAAO,CAAC,GAAG,CAAC,yBAAyB,OAAO,EAAE,CAAC,CAAC;IAClD,CAAC;IACD,IAAI,MAAM,KAAK,IAAI,IAAI,MAAM,KAAK,KAAK,EAAE,CAAC;QACxC,MAAM,EAAE,cAAc,EAAE,GAAG,2CAAa,kBAAkB,EAAC,CAAC;QAC5D,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC9B,OAAO,CAAC,GAAG,CAAC,+BAA+B,MAAM,EAAE,CAAC,CAAC;IACvD,CAAC;AACH,CAAC;AAED,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;IACnB,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnB,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACnB,CAAC,CAAC,CAAC"}
|
package/dist/common.types.d.ts
DELETED
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
export interface IMeta {
|
|
2
|
-
title?: string;
|
|
3
|
-
description?: string;
|
|
4
|
-
tags?: string[];
|
|
5
|
-
}
|
|
6
|
-
export interface ITaskMeta extends IMeta {
|
|
7
|
-
}
|
|
8
|
-
export interface IResourceMeta extends IMeta {
|
|
9
|
-
}
|
|
10
|
-
export interface IEventMeta extends IMeta {
|
|
11
|
-
}
|
|
12
|
-
export interface IMiddlewareMeta extends IMeta {
|
|
13
|
-
}
|
|
14
|
-
export type Optional<T> = {
|
|
15
|
-
[K in keyof T]?: T[K];
|
|
16
|
-
};
|
|
17
|
-
export type IsVoid<T> = [T] extends [void] ? true : false;
|
|
18
|
-
export type IsOptional<T> = undefined extends T ? true : false;
|
|
19
|
-
export type OptionalOrVoidOrAnything<T> = IsVoid<T> extends true ? void : IsOptional<T> extends true ? Optional<T> : T;
|
|
20
|
-
export type OnlyOptionalFields<T> = {} extends T ? true : false;
|
package/dist/common.types.js
DELETED
package/dist/common.types.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"common.types.js","sourceRoot":"","sources":["../src/common.types.ts"],"names":[],"mappings":";AAAA,wCAAwC"}
|
package/dist/defs/core.d.ts
DELETED
|
@@ -1,144 +0,0 @@
|
|
|
1
|
-
import { IEventMeta, IMiddlewareMeta, IResourceMeta, ITaskMeta } from "./tags";
|
|
2
|
-
import { symbolEvent, symbolMiddleware, symbolMiddlewareConfigured, symbolMiddlewareEverywhereResources, symbolMiddlewareEverywhereTasks } from "./symbols";
|
|
3
|
-
export interface ITask<TInput = any, TOutput extends Promise<any> = any, TDependencies extends DependencyMapType = {}, TOn extends "*" | IEventDefinition<any> | undefined = undefined> extends ITaskDefinition<TInput, TOutput, TDependencies, TOn> {
|
|
4
|
-
id: string | symbol;
|
|
5
|
-
dependencies: TDependencies | (() => TDependencies);
|
|
6
|
-
computedDependencies?: DependencyValuesType<TDependencies>;
|
|
7
|
-
middleware: MiddlewareAttachments[];
|
|
8
|
-
events: {
|
|
9
|
-
beforeRun: IEvent<BeforeRunEventPayload<TInput>>;
|
|
10
|
-
afterRun: IEvent<AfterRunEventPayload<TInput, TOutput>>;
|
|
11
|
-
onError: IEvent<OnErrorEventPayload>;
|
|
12
|
-
};
|
|
13
|
-
}
|
|
14
|
-
export type DependencyMapType = Record<string, ITask<any, any, any, any> | IResource<any, any, any> | IEventDefinition<any>>;
|
|
15
|
-
type ExtractTaskInput<T> = T extends ITask<infer I, any, any, any> ? I : never;
|
|
16
|
-
type ExtractTaskOutput<T> = T extends ITask<any, infer O, any, any> ? O : never;
|
|
17
|
-
type ExtractResourceValue<T> = T extends IResource<any, infer V, any> ? V : never;
|
|
18
|
-
type ExtractEventParams<T> = T extends IEvent<infer P> ? P : never;
|
|
19
|
-
type TaskDependency<I, O> = (...args: I extends null | void ? [] : [I]) => O;
|
|
20
|
-
type ResourceDependency<V> = V;
|
|
21
|
-
type EventDependency<P> = P extends void ? (() => Promise<void>) & ((input?: Record<string, never>) => Promise<void>) : (input: P) => Promise<void>;
|
|
22
|
-
export type DependencyValueType<T> = T extends ITask<any, any, any, any> ? TaskDependency<ExtractTaskInput<T>, ExtractTaskOutput<T>> : T extends IResource<any, any, any> ? ResourceDependency<ExtractResourceValue<T>> : T extends IEventDefinition<any> ? EventDependency<ExtractEventParams<T>> : never;
|
|
23
|
-
export type DependencyValuesType<T extends DependencyMapType> = {
|
|
24
|
-
[K in keyof T]: DependencyValueType<T[K]>;
|
|
25
|
-
};
|
|
26
|
-
export type RegisterableItems<T = any> = IResourceWithConfig<any> | IResource<void, any, any, any> | IResource<{
|
|
27
|
-
[K in any]?: any;
|
|
28
|
-
}, any, any, any> | ITask<any, any, any, any> | IMiddleware<any> | IEvent<any>;
|
|
29
|
-
export type MiddlewareAttachments = IMiddleware<void> | IMiddleware<{
|
|
30
|
-
[K in any]?: any;
|
|
31
|
-
}> | IMiddlewareConfigured<any>;
|
|
32
|
-
export interface ITaskDefinition<TInput = any, TOutput extends Promise<any> = any, TDependencies extends DependencyMapType = {}, TOn extends "*" | IEventDefinition<any> | undefined = undefined> {
|
|
33
|
-
id?: string | symbol;
|
|
34
|
-
dependencies?: TDependencies | (() => TDependencies);
|
|
35
|
-
middleware?: MiddlewareAttachments[];
|
|
36
|
-
on?: TOn;
|
|
37
|
-
listenerOrder?: number;
|
|
38
|
-
meta?: ITaskMeta;
|
|
39
|
-
run: (input: TOn extends undefined ? TInput : IEventEmission<TOn extends "*" ? any : ExtractEventParams<TOn>>, dependencies: DependencyValuesType<TDependencies>) => TOutput;
|
|
40
|
-
}
|
|
41
|
-
export type BeforeRunEventPayload<TInput> = {
|
|
42
|
-
input: TInput;
|
|
43
|
-
};
|
|
44
|
-
export type AfterRunEventPayload<TInput, TOutput> = {
|
|
45
|
-
input: TInput;
|
|
46
|
-
output: TOutput extends Promise<infer U> ? U : TOutput;
|
|
47
|
-
setOutput(newOutput: TOutput extends Promise<infer U> ? U : TOutput): void;
|
|
48
|
-
};
|
|
49
|
-
export type OnErrorEventPayload = {
|
|
50
|
-
error: any;
|
|
51
|
-
suppress(): void;
|
|
52
|
-
};
|
|
53
|
-
export type BeforeInitEventPayload<TConfig> = {
|
|
54
|
-
config: TConfig;
|
|
55
|
-
};
|
|
56
|
-
export type AfterInitEventPayload<TConfig, TValue> = {
|
|
57
|
-
config: TConfig;
|
|
58
|
-
value: TValue;
|
|
59
|
-
};
|
|
60
|
-
export interface IResourceDefinition<TConfig = any, TValue = unknown, TDependencies extends DependencyMapType = {}, TContext = any> {
|
|
61
|
-
id?: string | symbol;
|
|
62
|
-
dependencies?: TDependencies | ((config: TConfig) => TDependencies);
|
|
63
|
-
register?: Array<RegisterableItems> | ((config: TConfig) => Array<RegisterableItems>);
|
|
64
|
-
init?: (this: any, config: TConfig, dependencies: DependencyValuesType<TDependencies>, context: TContext) => Promise<TValue>;
|
|
65
|
-
dispose?: (this: any, value: TValue, config: TConfig, dependencies: DependencyValuesType<TDependencies>, context: TContext) => Promise<void>;
|
|
66
|
-
meta?: IResourceMeta;
|
|
67
|
-
overrides?: Array<IResource | ITask | IMiddleware | IResourceWithConfig>;
|
|
68
|
-
middleware?: MiddlewareAttachments[];
|
|
69
|
-
context?: () => TContext;
|
|
70
|
-
[symbolFilePath]?: string;
|
|
71
|
-
[symbolIndexResource]?: boolean;
|
|
72
|
-
}
|
|
73
|
-
import { symbolFilePath, symbolIndexResource } from "./symbols";
|
|
74
|
-
export interface IResource<TConfig = void, TValue = any, TDependencies extends DependencyMapType = any, TContext = any> extends IResourceDefinition<TConfig, TValue, TDependencies, TContext> {
|
|
75
|
-
id: string | symbol;
|
|
76
|
-
with(config: TConfig): IResourceWithConfig<TConfig, TValue, TDependencies>;
|
|
77
|
-
register: Array<RegisterableItems> | ((config: TConfig) => Array<RegisterableItems>);
|
|
78
|
-
events: {
|
|
79
|
-
beforeInit: IEvent<BeforeInitEventPayload<TConfig>>;
|
|
80
|
-
afterInit: IEvent<AfterInitEventPayload<TConfig, TValue>>;
|
|
81
|
-
onError: IEvent<OnErrorEventPayload>;
|
|
82
|
-
};
|
|
83
|
-
overrides: Array<IResource | ITask | IMiddleware | IResourceWithConfig>;
|
|
84
|
-
middleware: MiddlewareAttachments[];
|
|
85
|
-
}
|
|
86
|
-
export interface IResourceWithConfig<TConfig = any, TValue = any, TDependencies extends DependencyMapType = any> {
|
|
87
|
-
id: string;
|
|
88
|
-
resource: IResource<TConfig, TValue, TDependencies>;
|
|
89
|
-
config: TConfig;
|
|
90
|
-
}
|
|
91
|
-
export type EventHandlerType<T = any> = (event: IEventEmission<T>) => any | Promise<any>;
|
|
92
|
-
export interface IEventDefinition<TPayload = void> {
|
|
93
|
-
id?: string | symbol;
|
|
94
|
-
meta?: IEventMeta;
|
|
95
|
-
}
|
|
96
|
-
export interface IEvent<TPayload = any> extends IEventDefinition<TPayload> {
|
|
97
|
-
id: string | symbol;
|
|
98
|
-
[symbolEvent]: true;
|
|
99
|
-
}
|
|
100
|
-
export interface IMiddlewareDefinition<TConfig = any, TDependencies extends DependencyMapType = any> {
|
|
101
|
-
id?: string | symbol;
|
|
102
|
-
dependencies?: TDependencies | ((config: TConfig) => TDependencies);
|
|
103
|
-
run: (input: IMiddlewareExecutionInput, dependencies: DependencyValuesType<TDependencies>, config: TConfig) => Promise<any>;
|
|
104
|
-
meta?: IMiddlewareMeta;
|
|
105
|
-
}
|
|
106
|
-
export interface IMiddleware<TConfig = any, TDependencies extends DependencyMapType = any> extends IMiddlewareDefinition<TConfig, TDependencies> {
|
|
107
|
-
[symbolMiddleware]: true;
|
|
108
|
-
[symbolMiddlewareConfigured]?: boolean;
|
|
109
|
-
[symbolMiddlewareEverywhereTasks]?: boolean;
|
|
110
|
-
[symbolMiddlewareEverywhereResources]?: boolean;
|
|
111
|
-
id: string | symbol;
|
|
112
|
-
dependencies: TDependencies | (() => TDependencies);
|
|
113
|
-
everywhere(config?: import("../define").MiddlewareEverywhereOptions): IMiddleware<TConfig, TDependencies>;
|
|
114
|
-
config: TConfig;
|
|
115
|
-
with: (config: TConfig) => IMiddlewareConfigured<TConfig, TDependencies>;
|
|
116
|
-
}
|
|
117
|
-
export interface IMiddlewareConfigured<TConfig = any, TDependencies extends DependencyMapType = any> extends IMiddleware<TConfig, TDependencies> {
|
|
118
|
-
[symbolMiddlewareConfigured]: true;
|
|
119
|
-
}
|
|
120
|
-
export interface IMiddlewareDefinitionConfigured<C extends Record<string, any> = {}> {
|
|
121
|
-
middleware: IMiddleware<C>;
|
|
122
|
-
config?: C;
|
|
123
|
-
}
|
|
124
|
-
export interface IMiddlewareExecutionInput<TTaskInput = any, TResourceConfig = any> {
|
|
125
|
-
task?: {
|
|
126
|
-
definition: ITask<TTaskInput>;
|
|
127
|
-
input: TTaskInput;
|
|
128
|
-
};
|
|
129
|
-
resource?: {
|
|
130
|
-
definition: IResource<TResourceConfig>;
|
|
131
|
-
config: TResourceConfig;
|
|
132
|
-
};
|
|
133
|
-
next: (taskInputOrResourceConfig?: TTaskInput | TResourceConfig) => Promise<any>;
|
|
134
|
-
}
|
|
135
|
-
export interface IEventEmission<TPayload = any> {
|
|
136
|
-
id: string | symbol;
|
|
137
|
-
data: TPayload;
|
|
138
|
-
timestamp: Date;
|
|
139
|
-
source: string | symbol;
|
|
140
|
-
meta: IEventMeta;
|
|
141
|
-
stopPropagation(): void;
|
|
142
|
-
isPropagationStopped(): boolean;
|
|
143
|
-
}
|
|
144
|
-
export {};
|
package/dist/defs/core.js
DELETED
package/dist/defs/core.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"core.js","sourceRoot":"","sources":["../../src/defs/core.ts"],"names":[],"mappings":";;AACA,uCASmB;AAyInB,kCAAkC;AAClC,uCAAgE"}
|
package/dist/defs/symbols.d.ts
DELETED
|
@@ -1,42 +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
|
-
export declare const symbolMiddlewareConfigured: unique symbol;
|
|
13
|
-
export declare const symbolMiddlewareGlobal: unique symbol;
|
|
14
|
-
export declare const symbolMiddlewareEverywhereTasks: unique symbol;
|
|
15
|
-
export declare const symbolMiddlewareEverywhereResources: unique symbol;
|
|
16
|
-
/** @internal Path to aid anonymous id generation and error messages */
|
|
17
|
-
export declare const symbolFilePath: unique symbol;
|
|
18
|
-
/** @internal Marks disposable instances */
|
|
19
|
-
export declare const symbolDispose: unique symbol;
|
|
20
|
-
/** @internal Link to internal Store */
|
|
21
|
-
export declare const symbolStore: unique symbol;
|
|
22
|
-
/** @internal Brand used by index() resources */
|
|
23
|
-
export declare const symbolIndexResource: unique symbol;
|
|
24
|
-
/**
|
|
25
|
-
* Convenience bag of internal symbols. Intended for framework internals;
|
|
26
|
-
* consumers should not rely on this shape.
|
|
27
|
-
* @internal
|
|
28
|
-
*/
|
|
29
|
-
export declare const symbols: {
|
|
30
|
-
task: symbol;
|
|
31
|
-
resource: symbol;
|
|
32
|
-
resourceWithConfig: symbol;
|
|
33
|
-
indexResource: symbol;
|
|
34
|
-
event: symbol;
|
|
35
|
-
middleware: symbol;
|
|
36
|
-
middlewareEverywhereTasks: symbol;
|
|
37
|
-
middlewareEverywhereResources: symbol;
|
|
38
|
-
filePath: symbol;
|
|
39
|
-
dispose: symbol;
|
|
40
|
-
store: symbol;
|
|
41
|
-
};
|
|
42
|
-
export type SymbolsBag = typeof symbols;
|
package/dist/defs/symbols.js
DELETED
|
@@ -1,45 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.symbols = exports.symbolIndexResource = exports.symbolStore = exports.symbolDispose = exports.symbolFilePath = exports.symbolMiddlewareEverywhereResources = exports.symbolMiddlewareEverywhereTasks = exports.symbolMiddlewareGlobal = exports.symbolMiddlewareConfigured = 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
|
-
exports.symbolMiddlewareConfigured = Symbol("runner.middlewareConfigured");
|
|
16
|
-
exports.symbolMiddlewareGlobal = Symbol("runner.middlewareGlobal");
|
|
17
|
-
exports.symbolMiddlewareEverywhereTasks = Symbol("runner.middlewareGlobalTasks");
|
|
18
|
-
exports.symbolMiddlewareEverywhereResources = Symbol("runner.middlewareGlobalResources");
|
|
19
|
-
/** @internal Path to aid anonymous id generation and error messages */
|
|
20
|
-
exports.symbolFilePath = Symbol("runner.filePath");
|
|
21
|
-
/** @internal Marks disposable instances */
|
|
22
|
-
exports.symbolDispose = Symbol("runner.dispose");
|
|
23
|
-
/** @internal Link to internal Store */
|
|
24
|
-
exports.symbolStore = Symbol("runner.store");
|
|
25
|
-
/** @internal Brand used by index() resources */
|
|
26
|
-
exports.symbolIndexResource = Symbol("runner.indexResource");
|
|
27
|
-
/**
|
|
28
|
-
* Convenience bag of internal symbols. Intended for framework internals;
|
|
29
|
-
* consumers should not rely on this shape.
|
|
30
|
-
* @internal
|
|
31
|
-
*/
|
|
32
|
-
exports.symbols = {
|
|
33
|
-
task: exports.symbolTask,
|
|
34
|
-
resource: exports.symbolResource,
|
|
35
|
-
resourceWithConfig: exports.symbolResourceWithConfig,
|
|
36
|
-
indexResource: exports.symbolIndexResource,
|
|
37
|
-
event: exports.symbolEvent,
|
|
38
|
-
middleware: exports.symbolMiddleware,
|
|
39
|
-
middlewareEverywhereTasks: exports.symbolMiddlewareEverywhereTasks,
|
|
40
|
-
middlewareEverywhereResources: exports.symbolMiddlewareEverywhereResources,
|
|
41
|
-
filePath: exports.symbolFilePath,
|
|
42
|
-
dispose: exports.symbolDispose,
|
|
43
|
-
store: exports.symbolStore,
|
|
44
|
-
};
|
|
45
|
-
//# sourceMappingURL=symbols.js.map
|
package/dist/defs/symbols.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"symbols.js","sourceRoot":"","sources":["../../src/defs/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;AAC9D,QAAA,0BAA0B,GAAkB,MAAM,CAC7D,6BAA6B,CAC9B,CAAC;AACW,QAAA,sBAAsB,GAAkB,MAAM,CACzD,yBAAyB,CAC1B,CAAC;AACW,QAAA,+BAA+B,GAAkB,MAAM,CAClE,8BAA8B,CAC/B,CAAC;AACW,QAAA,mCAAmC,GAAkB,MAAM,CACtE,kCAAkC,CACnC,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;AAEF;;;;GAIG;AACU,QAAA,OAAO,GAAG;IACrB,IAAI,EAAE,kBAAU;IAChB,QAAQ,EAAE,sBAAc;IACxB,kBAAkB,EAAE,gCAAwB;IAC5C,aAAa,EAAE,2BAAmB;IAClC,KAAK,EAAE,mBAAW;IAClB,UAAU,EAAE,wBAAgB;IAC5B,yBAAyB,EAAE,uCAA+B;IAC1D,6BAA6B,EAAE,2CAAmC;IAClE,QAAQ,EAAE,sBAAc;IACxB,OAAO,EAAE,qBAAa;IACtB,KAAK,EAAE,mBAAW;CACnB,CAAC"}
|
package/dist/defs/tags.d.ts
DELETED
|
@@ -1,70 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Tag system and metadata types.
|
|
3
|
-
*/
|
|
4
|
-
export interface ITagDefinition<TConfig = void> {
|
|
5
|
-
id: string | symbol;
|
|
6
|
-
}
|
|
7
|
-
/**
|
|
8
|
-
* A configured instance of a tag as produced by `ITag.with()`.
|
|
9
|
-
*/
|
|
10
|
-
export interface ITagWithConfig<TConfig = void> {
|
|
11
|
-
id: string | symbol;
|
|
12
|
-
/** The tag definition used to produce this configured instance. */
|
|
13
|
-
tag: ITag<TConfig>;
|
|
14
|
-
/** The configuration captured for this tag instance. */
|
|
15
|
-
config: TConfig;
|
|
16
|
-
}
|
|
17
|
-
/**
|
|
18
|
-
* A tag definition (builder). Use `.with(config)` to obtain configured instances,
|
|
19
|
-
* and `.extract(tags)` to find either a configured instance or the bare tag in a list.
|
|
20
|
-
*/
|
|
21
|
-
export interface ITag<TConfig = void> extends ITagDefinition<TConfig> {
|
|
22
|
-
/** Creates a configured instance of the tag. */
|
|
23
|
-
with(config: TConfig): ITagWithConfig<TConfig>;
|
|
24
|
-
/**
|
|
25
|
-
* Extracts either a configured instance or the bare tag from a list of tags
|
|
26
|
-
* or from a taggable object (`{ meta: { tags?: [] } }`).
|
|
27
|
-
*/
|
|
28
|
-
extract(target: TagType[] | ITaggable): ExtractedTagResult<TConfig> | null;
|
|
29
|
-
}
|
|
30
|
-
/**
|
|
31
|
-
* Restrict bare tags to those whose config can be omitted (void or optional object),
|
|
32
|
-
* mirroring the same principle used for resources in `RegisterableItems`.
|
|
33
|
-
* Required-config tags must appear as configured instances.
|
|
34
|
-
*/
|
|
35
|
-
export type TagType = string | ITag<void> | ITag<{
|
|
36
|
-
[K in any]?: any;
|
|
37
|
-
}> | ITagWithConfig<any>;
|
|
38
|
-
/**
|
|
39
|
-
* Conditional result type for `ITag.extract`:
|
|
40
|
-
* - For void config → just the identifier
|
|
41
|
-
* - For optional object config → identifier with optional config
|
|
42
|
-
* - For required config → identifier with required config
|
|
43
|
-
*/
|
|
44
|
-
export type ExtractedTagResult<TConfig> = {} extends TConfig ? {
|
|
45
|
-
id: string | symbol;
|
|
46
|
-
config?: TConfig;
|
|
47
|
-
} : {
|
|
48
|
-
id: string | symbol;
|
|
49
|
-
config: TConfig;
|
|
50
|
-
};
|
|
51
|
-
/** Any object that can carry tags via metadata. */
|
|
52
|
-
export interface ITaggable {
|
|
53
|
-
meta?: {
|
|
54
|
-
tags?: TagType[];
|
|
55
|
-
};
|
|
56
|
-
}
|
|
57
|
-
/** Common metadata you can attach to tasks/resources/events/middleware. */
|
|
58
|
-
export interface IMeta {
|
|
59
|
-
title?: string;
|
|
60
|
-
description?: string;
|
|
61
|
-
tags?: TagType[];
|
|
62
|
-
}
|
|
63
|
-
export interface ITaskMeta extends IMeta {
|
|
64
|
-
}
|
|
65
|
-
export interface IResourceMeta extends IMeta {
|
|
66
|
-
}
|
|
67
|
-
export interface IEventMeta extends IMeta {
|
|
68
|
-
}
|
|
69
|
-
export interface IMiddlewareMeta extends IMeta {
|
|
70
|
-
}
|
package/dist/defs/tags.js
DELETED
package/dist/defs/tags.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"tags.js","sourceRoot":"","sources":["../../src/defs/tags.ts"],"names":[],"mappings":";AAAA;;GAEG"}
|
package/dist/defs.returnTag.d.ts
DELETED
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
import { ITag, ITagWithConfig } from "./defs";
|
|
2
|
-
import { IMeta } from "./defs";
|
|
3
|
-
type NonVoid<T> = [T] extends [void] ? never : T;
|
|
4
|
-
type ExtractReturnFromTag<T> = T extends ITagWithConfig<any, infer R> ? NonVoid<R> : T extends ITag<any, infer R> ? NonVoid<R> : never;
|
|
5
|
-
type IsTuple<T extends readonly unknown[]> = number extends T["length"] ? false : true;
|
|
6
|
-
type FilterContracts<TTags extends readonly unknown[], Acc extends readonly unknown[] = []> = TTags extends readonly [infer H, ...infer R] ? ExtractReturnFromTag<H> extends never ? FilterContracts<R, Acc> : FilterContracts<R, [...Acc, ExtractReturnFromTag<H>]> : Acc;
|
|
7
|
-
export type ExtractContractsFromTags<TTags extends readonly unknown[]> = IsTuple<TTags> extends true ? FilterContracts<TTags> : Array<ExtractReturnFromTag<TTags[number]>>;
|
|
8
|
-
export type ExtractTagsWithNonVoidReturnTypeFromMeta<TMeta extends IMeta> = TMeta extends {
|
|
9
|
-
tags?: infer TTags;
|
|
10
|
-
} ? TTags extends readonly unknown[] ? ExtractContractsFromTags<TTags> : [] : [];
|
|
11
|
-
export type HasContracts<T extends IMeta> = ExtractTagsWithNonVoidReturnTypeFromMeta<T> extends never[] ? false : true;
|
|
12
|
-
type UnionToIntersection<U> = (U extends any ? (arg: U) => void : never) extends (arg: infer I) => void ? I : never;
|
|
13
|
-
type ContractsUnion<TMeta extends IMeta> = ExtractTagsWithNonVoidReturnTypeFromMeta<TMeta> extends readonly (infer U)[] ? U : never;
|
|
14
|
-
type ContractsIntersection<TMeta extends IMeta> = UnionToIntersection<ContractsUnion<TMeta>>;
|
|
15
|
-
/**
|
|
16
|
-
* Pretty-print helper to expand intersections for better IDE display.
|
|
17
|
-
*/
|
|
18
|
-
type Simplify<T> = {
|
|
19
|
-
[K in keyof T]: T[K];
|
|
20
|
-
} & {};
|
|
21
|
-
/**
|
|
22
|
-
* Verbose compile-time error surfaced when a value does not satisfy
|
|
23
|
-
* the intersection of all tag-enforced contracts.
|
|
24
|
-
*
|
|
25
|
-
* Intersected with `never` in call sites when desired to ensure assignment
|
|
26
|
-
* fails while still surfacing a readable shape in tooltips.
|
|
27
|
-
*/
|
|
28
|
-
export type ContractViolationError<TMeta extends IMeta, TActual> = {
|
|
29
|
-
message: "Value does not satisfy all tag contracts";
|
|
30
|
-
expected: Simplify<ContractsIntersection<TMeta>>;
|
|
31
|
-
received: TActual;
|
|
32
|
-
};
|
|
33
|
-
export type EnsureResponseSatisfiesContracts<TMeta extends IMeta, TResponse> = [
|
|
34
|
-
ContractsUnion<TMeta>
|
|
35
|
-
] extends [never] ? TResponse : TResponse extends Promise<infer U> ? Promise<U extends ContractsIntersection<TMeta> ? U : ContractViolationError<TMeta, U>> : TResponse extends ContractsIntersection<TMeta> ? TResponse : ContractViolationError<TMeta, TResponse>;
|
|
36
|
-
export {};
|
package/dist/defs.returnTag.js
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"defs.returnTag.js","sourceRoot":"","sources":["../src/defs.returnTag.ts"],"names":[],"mappings":";AAAA,6DAA6D"}
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
import type { IResource } from "../defs";
|
|
2
|
-
import { DocsGraph } from "./model";
|
|
3
|
-
type IntrospectOptions = {
|
|
4
|
-
includeGlobals?: boolean;
|
|
5
|
-
};
|
|
6
|
-
export declare function introspectResource(root: IResource<any, any, any, any>, config?: any, options?: IntrospectOptions): Promise<DocsGraph>;
|
|
7
|
-
export {};
|