@marinoscar/platform-cli 0.1.0-next.22 → 0.1.0-next.24
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/CHANGELOG.md +28 -0
- package/README.md +6 -1
- package/dist/engine/commands/node.d.ts.map +1 -1
- package/dist/engine/commands/node.js +8 -0
- package/dist/engine/commands/node.js.map +1 -1
- package/dist/engine/config.d.ts +38 -0
- package/dist/engine/config.d.ts.map +1 -1
- package/dist/engine/config.js +55 -0
- package/dist/engine/config.js.map +1 -1
- package/dist/engine/create-cli.d.ts +29 -0
- package/dist/engine/create-cli.d.ts.map +1 -1
- package/dist/engine/create-cli.js +18 -0
- package/dist/engine/create-cli.js.map +1 -1
- package/dist/engine/index.d.ts +28 -3
- package/dist/engine/index.d.ts.map +1 -1
- package/dist/engine/index.js +15 -1
- package/dist/engine/index.js.map +1 -1
- package/dist/engine/node/daemon-channels.d.ts +66 -0
- package/dist/engine/node/daemon-channels.d.ts.map +1 -0
- package/dist/engine/node/daemon-channels.js +65 -0
- package/dist/engine/node/daemon-channels.js.map +1 -0
- package/dist/engine/node/daemon.d.ts.map +1 -1
- package/dist/engine/node/daemon.js +52 -0
- package/dist/engine/node/daemon.js.map +1 -1
- package/dist/engine/node/executors/credential-hygiene.d.ts +1 -1
- package/dist/engine/node/executors/credential-hygiene.d.ts.map +1 -1
- package/dist/engine/node/executors/credential-hygiene.js +23 -2
- package/dist/engine/node/executors/credential-hygiene.js.map +1 -1
- package/dist/engine/node/executors/index.d.ts +52 -7
- package/dist/engine/node/executors/index.d.ts.map +1 -1
- package/dist/engine/node/executors/index.js +14 -0
- package/dist/engine/node/executors/index.js.map +1 -1
- package/dist/engine/node/executors/registry.d.ts.map +1 -1
- package/dist/engine/node/executors/registry.js +13 -2
- package/dist/engine/node/executors/registry.js.map +1 -1
- package/dist/engine/node/ipc-protocol.d.ts +49 -2
- package/dist/engine/node/ipc-protocol.d.ts.map +1 -1
- package/dist/engine/node/ipc-protocol.js +39 -0
- package/dist/engine/node/ipc-protocol.js.map +1 -1
- package/dist/engine/node/lifecycle.js +2 -1
- package/dist/engine/node/lifecycle.js.map +1 -1
- package/dist/engine/node/logger.d.ts +13 -0
- package/dist/engine/node/logger.d.ts.map +1 -1
- package/dist/engine/node/logger.js.map +1 -1
- package/dist/engine/node/memory-watchdog.d.ts +11 -0
- package/dist/engine/node/memory-watchdog.d.ts.map +1 -1
- package/dist/engine/node/memory-watchdog.js +28 -4
- package/dist/engine/node/memory-watchdog.js.map +1 -1
- package/dist/engine/node/node-dashboard-source.d.ts +46 -19
- package/dist/engine/node/node-dashboard-source.d.ts.map +1 -1
- package/dist/engine/node/node-dashboard-source.js +70 -102
- package/dist/engine/node/node-dashboard-source.js.map +1 -1
- package/dist/engine/node/node-engine.d.ts +7 -1
- package/dist/engine/node/node-engine.d.ts.map +1 -1
- package/dist/engine/node/node-engine.js +81 -8
- package/dist/engine/node/node-engine.js.map +1 -1
- package/dist/engine/node/runtime-state.d.ts +24 -0
- package/dist/engine/node/runtime-state.d.ts.map +1 -0
- package/dist/engine/node/runtime-state.js +19 -0
- package/dist/engine/node/runtime-state.js.map +1 -0
- package/dist/engine/node/runtime-tuning.d.ts +111 -2
- package/dist/engine/node/runtime-tuning.d.ts.map +1 -1
- package/dist/engine/node/runtime-tuning.js +133 -4
- package/dist/engine/node/runtime-tuning.js.map +1 -1
- package/dist/engine/node/service.d.ts.map +1 -1
- package/dist/engine/node/service.js +4 -0
- package/dist/engine/node/service.js.map +1 -1
- package/dist/engine/node/start.d.ts +7 -0
- package/dist/engine/node/start.d.ts.map +1 -1
- package/dist/engine/node/start.js +33 -1
- package/dist/engine/node/start.js.map +1 -1
- package/dist/engine/node/worker-env-aliases.d.ts +39 -0
- package/dist/engine/node/worker-env-aliases.d.ts.map +1 -0
- package/dist/engine/node/worker-env-aliases.js +126 -0
- package/dist/engine/node/worker-env-aliases.js.map +1 -0
- package/dist/engine/node/worker-env-table.d.ts.map +1 -1
- package/dist/engine/node/worker-env-table.js +4 -1
- package/dist/engine/node/worker-env-table.js.map +1 -1
- package/dist/engine/node/worker-env.d.ts +13 -1
- package/dist/engine/node/worker-env.d.ts.map +1 -1
- package/dist/engine/node/worker-env.js +8 -0
- package/dist/engine/node/worker-env.js.map +1 -1
- package/dist/engine/registries.d.ts.map +1 -1
- package/dist/engine/registries.js +10 -0
- package/dist/engine/registries.js.map +1 -1
- package/dist/engine/tui/app-registry.d.ts +103 -0
- package/dist/engine/tui/app-registry.d.ts.map +1 -0
- package/dist/engine/tui/app-registry.js +103 -0
- package/dist/engine/tui/app-registry.js.map +1 -0
- package/dist/engine/tui/app.d.ts +9 -1
- package/dist/engine/tui/app.d.ts.map +1 -1
- package/dist/engine/tui/app.js +52 -18
- package/dist/engine/tui/app.js.map +1 -1
- package/dist/engine/tui/builtin-screens.d.ts.map +1 -1
- package/dist/engine/tui/builtin-screens.js +6 -0
- package/dist/engine/tui/builtin-screens.js.map +1 -1
- package/dist/engine/tui/context.d.ts +220 -0
- package/dist/engine/tui/context.d.ts.map +1 -0
- package/dist/engine/tui/context.js +258 -0
- package/dist/engine/tui/context.js.map +1 -0
- package/dist/engine/tui/dashboard/index.d.ts +8 -0
- package/dist/engine/tui/dashboard/index.d.ts.map +1 -0
- package/dist/engine/tui/dashboard/index.js +5 -0
- package/dist/engine/tui/dashboard/index.js.map +1 -0
- package/dist/engine/tui/dashboard/jobs-insights.d.ts +145 -0
- package/dist/engine/tui/dashboard/jobs-insights.d.ts.map +1 -0
- package/dist/engine/tui/dashboard/jobs-insights.js +63 -0
- package/dist/engine/tui/dashboard/jobs-insights.js.map +1 -0
- package/dist/engine/tui/dashboard/node-embedded.d.ts +33 -0
- package/dist/engine/tui/dashboard/node-embedded.d.ts.map +1 -0
- package/dist/engine/tui/dashboard/node-embedded.js +81 -0
- package/dist/engine/tui/dashboard/node-embedded.js.map +1 -0
- package/dist/engine/tui/dashboard/source.d.ts +274 -0
- package/dist/engine/tui/dashboard/source.d.ts.map +1 -0
- package/dist/engine/tui/dashboard/source.js +351 -0
- package/dist/engine/tui/dashboard/source.js.map +1 -0
- package/dist/engine/tui/dashboard/use-dashboard.d.ts +23 -0
- package/dist/engine/tui/dashboard/use-dashboard.d.ts.map +1 -0
- package/dist/engine/tui/dashboard/use-dashboard.js +32 -0
- package/dist/engine/tui/dashboard/use-dashboard.js.map +1 -0
- package/dist/engine/tui/index.d.ts +2 -0
- package/dist/engine/tui/index.d.ts.map +1 -1
- package/dist/engine/tui/index.js +19 -1
- package/dist/engine/tui/index.js.map +1 -1
- package/dist/engine/tui/layout.d.ts +20 -0
- package/dist/engine/tui/layout.d.ts.map +1 -1
- package/dist/engine/tui/layout.js +17 -3
- package/dist/engine/tui/layout.js.map +1 -1
- package/dist/engine/tui/menu-registry.d.ts +124 -0
- package/dist/engine/tui/menu-registry.d.ts.map +1 -0
- package/dist/engine/tui/menu-registry.js +151 -0
- package/dist/engine/tui/menu-registry.js.map +1 -0
- package/dist/engine/tui/menu-tree.d.ts +179 -0
- package/dist/engine/tui/menu-tree.d.ts.map +1 -0
- package/dist/engine/tui/menu-tree.js +250 -0
- package/dist/engine/tui/menu-tree.js.map +1 -0
- package/dist/engine/tui/raw-mode.d.ts +54 -0
- package/dist/engine/tui/raw-mode.d.ts.map +1 -0
- package/dist/engine/tui/raw-mode.js +106 -0
- package/dist/engine/tui/raw-mode.js.map +1 -0
- package/dist/engine/tui/screen-registry.d.ts +4 -2
- package/dist/engine/tui/screen-registry.d.ts.map +1 -1
- package/dist/engine/tui/screen-registry.js +2 -1
- package/dist/engine/tui/screen-registry.js.map +1 -1
- package/dist/engine/tui/screens/invoke.d.ts.map +1 -1
- package/dist/engine/tui/screens/invoke.js +5 -2
- package/dist/engine/tui/screens/invoke.js.map +1 -1
- package/dist/engine/tui/screens/jobs.d.ts +12 -0
- package/dist/engine/tui/screens/jobs.d.ts.map +1 -0
- package/dist/engine/tui/screens/jobs.js +72 -0
- package/dist/engine/tui/screens/jobs.js.map +1 -0
- package/dist/engine/tui/screens/login.d.ts.map +1 -1
- package/dist/engine/tui/screens/login.js +17 -9
- package/dist/engine/tui/screens/login.js.map +1 -1
- package/dist/engine/tui/screens/logout.d.ts.map +1 -1
- package/dist/engine/tui/screens/logout.js +12 -5
- package/dist/engine/tui/screens/logout.js.map +1 -1
- package/dist/engine/tui/screens/menu.d.ts +4 -1
- package/dist/engine/tui/screens/menu.d.ts.map +1 -1
- package/dist/engine/tui/screens/menu.js +90 -60
- package/dist/engine/tui/screens/menu.js.map +1 -1
- package/dist/engine/tui/screens/node.d.ts.map +1 -1
- package/dist/engine/tui/screens/node.js +88 -39
- package/dist/engine/tui/screens/node.js.map +1 -1
- package/dist/engine/tui/screens/not-logged-in.d.ts +12 -0
- package/dist/engine/tui/screens/not-logged-in.d.ts.map +1 -0
- package/dist/engine/tui/screens/not-logged-in.js +14 -0
- package/dist/engine/tui/screens/not-logged-in.js.map +1 -0
- package/dist/engine/tui/screens/status.d.ts.map +1 -1
- package/dist/engine/tui/screens/status.js +8 -4
- package/dist/engine/tui/screens/status.js.map +1 -1
- package/dist/engine/tui/scroll-box.d.ts +15 -0
- package/dist/engine/tui/scroll-box.d.ts.map +1 -1
- package/dist/engine/tui/scroll-box.js +10 -0
- package/dist/engine/tui/scroll-box.js.map +1 -1
- package/dist/engine/tui/theme.d.ts +179 -0
- package/dist/engine/tui/theme.d.ts.map +1 -0
- package/dist/engine/tui/theme.js +111 -0
- package/dist/engine/tui/theme.js.map +1 -0
- package/dist/engine/tui/tty.d.ts +7 -0
- package/dist/engine/tui/tty.d.ts.map +1 -1
- package/dist/engine/tui/tty.js +8 -1
- package/dist/engine/tui/tty.js.map +1 -1
- package/dist/engine/tui/ui/active-items.d.ts +40 -0
- package/dist/engine/tui/ui/active-items.d.ts.map +1 -0
- package/dist/engine/tui/ui/active-items.js +38 -0
- package/dist/engine/tui/ui/active-items.js.map +1 -0
- package/dist/engine/tui/ui/event-log.d.ts +58 -0
- package/dist/engine/tui/ui/event-log.d.ts.map +1 -0
- package/dist/engine/tui/ui/event-log.js +32 -0
- package/dist/engine/tui/ui/event-log.js.map +1 -0
- package/dist/engine/tui/ui/index.d.ts +20 -0
- package/dist/engine/tui/ui/index.d.ts.map +1 -0
- package/dist/engine/tui/ui/index.js +14 -0
- package/dist/engine/tui/ui/index.js.map +1 -0
- package/dist/engine/tui/ui/meter-legend.d.ts +26 -0
- package/dist/engine/tui/ui/meter-legend.d.ts.map +1 -0
- package/dist/engine/tui/ui/meter-legend.js +25 -0
- package/dist/engine/tui/ui/meter-legend.js.map +1 -0
- package/dist/engine/tui/ui/run-summary.d.ts +58 -0
- package/dist/engine/tui/ui/run-summary.d.ts.map +1 -0
- package/dist/engine/tui/ui/run-summary.js +29 -0
- package/dist/engine/tui/ui/run-summary.js.map +1 -0
- package/dist/engine/tui/ui/segment-meter.d.ts +72 -0
- package/dist/engine/tui/ui/segment-meter.d.ts.map +1 -0
- package/dist/engine/tui/ui/segment-meter.js +128 -0
- package/dist/engine/tui/ui/segment-meter.js.map +1 -0
- package/dist/engine/tui/ui/status-line.d.ts +42 -0
- package/dist/engine/tui/ui/status-line.d.ts.map +1 -0
- package/dist/engine/tui/ui/status-line.js +35 -0
- package/dist/engine/tui/ui/status-line.js.map +1 -0
- package/dist/engine/tui/ui/tone.d.ts +46 -0
- package/dist/engine/tui/ui/tone.d.ts.map +1 -0
- package/dist/engine/tui/ui/tone.js +48 -0
- package/dist/engine/tui/ui/tone.js.map +1 -0
- package/dist/node/index.d.ts +2 -2
- package/dist/node/index.d.ts.map +1 -1
- package/dist/node/index.js +1 -1
- package/dist/node/index.js.map +1 -1
- package/dist/tui/index.d.ts +2 -2
- package/dist/tui/index.d.ts.map +1 -1
- package/dist/tui/index.js +6 -4
- package/dist/tui/index.js.map +1 -1
- package/dist/tui/ui/index.d.ts +2 -0
- package/dist/tui/ui/index.d.ts.map +1 -0
- package/dist/tui/ui/index.js +10 -0
- package/dist/tui/ui/index.js.map +1 -0
- package/package.json +8 -3
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
import { workerEnv } from './worker-env.js';
|
|
2
|
+
import { disableMemoryValve } from './runtime-tuning.js';
|
|
3
|
+
import { runtimeState } from './runtime-state.js';
|
|
4
|
+
// =============================================================================
|
|
5
|
+
// Legacy names for worker environment variables (issue #1072, epic #1070)
|
|
6
|
+
// =============================================================================
|
|
7
|
+
//
|
|
8
|
+
// A fleet that predates the platform engine sets its own variable names in
|
|
9
|
+
// compose files, systemd units and runbooks. Renaming them is a change to every
|
|
10
|
+
// one of those, and a variable nothing reads fails silently: the worker starts
|
|
11
|
+
// with defaults nobody asked for. So an app may name legacy variables per
|
|
12
|
+
// `WORKER_ENV` key; they are read only when the canonical one is unset, and a
|
|
13
|
+
// deprecation line is logged once per alias that is actually in use.
|
|
14
|
+
//
|
|
15
|
+
// RULES
|
|
16
|
+
// - The canonical name wins whenever it is set (non-empty).
|
|
17
|
+
// - The credential (`token`) and the re-exec latch (`heapTuned`) can never be
|
|
18
|
+
// aliased: the first so a secret is never read from a second, unaudited
|
|
19
|
+
// name, the second because it is not an operator knob.
|
|
20
|
+
// - A value is copied verbatim, with two exceptions for the memory valve
|
|
21
|
+
// fraction, whose legacy meaning differs from the canonical one: `0` turns
|
|
22
|
+
// the VALVE off while sampling continues (the canonical variable would
|
|
23
|
+
// clamp it to 0.5), and a value outside [0, 1] is ignored.
|
|
24
|
+
// =============================================================================
|
|
25
|
+
/** Keys that must never be aliased. */
|
|
26
|
+
const NOT_ALIASABLE = ['token', 'heapTuned'];
|
|
27
|
+
const ENV_NAME = /^[A-Za-z_][A-Za-z0-9_]*$/;
|
|
28
|
+
const { aliases, warned } = runtimeState;
|
|
29
|
+
/**
|
|
30
|
+
* Lets `legacyName` supply the worker variable `key` when the canonical one is
|
|
31
|
+
* unset. A deprecation line is logged once per alias at startup.
|
|
32
|
+
*
|
|
33
|
+
* @param key - A `WORKER_ENV` key, e.g. `heapLimitMb`.
|
|
34
|
+
* @param legacyName - The old variable name, e.g. `APP_MAX_OLD_SPACE_MB`.
|
|
35
|
+
* @throws Error when `key` is the credential or the re-exec latch, the name is
|
|
36
|
+
* not a valid variable name, or it equals the canonical name.
|
|
37
|
+
* @stability experimental
|
|
38
|
+
* @extensionPoint registry
|
|
39
|
+
* @example
|
|
40
|
+
* ```ts
|
|
41
|
+
* registerWorkerEnvAlias('heapLimitMb', 'APP_MAX_OLD_SPACE_MB');
|
|
42
|
+
* ```
|
|
43
|
+
*/
|
|
44
|
+
export function registerWorkerEnvAlias(key, legacyName) {
|
|
45
|
+
const canonical = workerEnv()[key];
|
|
46
|
+
if (canonical === undefined)
|
|
47
|
+
throw new Error(`"${String(key)}" is not a worker environment key.`);
|
|
48
|
+
if (NOT_ALIASABLE.includes(key)) {
|
|
49
|
+
throw new Error(`The worker environment key "${key}" cannot have an alias.`);
|
|
50
|
+
}
|
|
51
|
+
if (!ENV_NAME.test(legacyName))
|
|
52
|
+
throw new Error(`"${legacyName}" is not a valid environment variable name.`);
|
|
53
|
+
if (legacyName === canonical)
|
|
54
|
+
throw new Error(`"${legacyName}" is already the canonical name of "${key}".`);
|
|
55
|
+
if (Object.values(workerEnv()).includes(legacyName)) {
|
|
56
|
+
throw new Error(`"${legacyName}" is the canonical name of another worker variable.`);
|
|
57
|
+
}
|
|
58
|
+
const existing = aliases.get(key) ?? [];
|
|
59
|
+
if (!existing.includes(legacyName))
|
|
60
|
+
aliases.set(key, [...existing, legacyName]);
|
|
61
|
+
}
|
|
62
|
+
/**
|
|
63
|
+
* The registered aliases per key, for the generated variable table.
|
|
64
|
+
*
|
|
65
|
+
* @stability experimental
|
|
66
|
+
*/
|
|
67
|
+
export function listWorkerEnvAliases() {
|
|
68
|
+
return Object.fromEntries([...aliases.entries()].map(([key, names]) => [key, [...names]]));
|
|
69
|
+
}
|
|
70
|
+
/** The aliases the last `applyWorkerEnvAliases` call actually used. */
|
|
71
|
+
export function appliedWorkerEnvAliases() {
|
|
72
|
+
return runtimeState.applied;
|
|
73
|
+
}
|
|
74
|
+
/**
|
|
75
|
+
* Copies each alias that is set into its canonical variable, when the canonical
|
|
76
|
+
* one is unset, so every reader of `WORKER_ENV` sees the value. Idempotent.
|
|
77
|
+
*
|
|
78
|
+
* @param env - The environment to read and write; defaults to `process.env`.
|
|
79
|
+
* @param warn - Receives one deprecation line per alias, the first time only.
|
|
80
|
+
* @returns The aliases that supplied a value.
|
|
81
|
+
*/
|
|
82
|
+
export function applyWorkerEnvAliases(env = process.env, warn) {
|
|
83
|
+
const applied = [];
|
|
84
|
+
for (const [key, names] of aliases) {
|
|
85
|
+
const canonical = workerEnv()[key];
|
|
86
|
+
if (isSet(env[canonical]))
|
|
87
|
+
continue;
|
|
88
|
+
for (const legacy of names) {
|
|
89
|
+
const raw = env[legacy];
|
|
90
|
+
if (!isSet(raw))
|
|
91
|
+
continue;
|
|
92
|
+
if (key === 'memoryThreshold') {
|
|
93
|
+
// Legacy meaning: a fraction in [0, 1]; 0 = valve off, out of range = ignored.
|
|
94
|
+
const fraction = Number(raw.trim());
|
|
95
|
+
if (!Number.isFinite(fraction) || fraction < 0 || fraction > 1)
|
|
96
|
+
continue;
|
|
97
|
+
if (fraction === 0)
|
|
98
|
+
disableMemoryValve();
|
|
99
|
+
else
|
|
100
|
+
env[canonical] = raw.trim();
|
|
101
|
+
}
|
|
102
|
+
else {
|
|
103
|
+
env[canonical] = raw;
|
|
104
|
+
}
|
|
105
|
+
applied.push({ key, canonical, legacy });
|
|
106
|
+
const id = `${legacy}->${canonical}`;
|
|
107
|
+
if (!warned.has(id)) {
|
|
108
|
+
warned.add(id);
|
|
109
|
+
warn?.(`${legacy} is deprecated; set ${canonical} instead. The legacy name is still honoured.`);
|
|
110
|
+
}
|
|
111
|
+
break;
|
|
112
|
+
}
|
|
113
|
+
}
|
|
114
|
+
runtimeState.applied = applied;
|
|
115
|
+
return applied;
|
|
116
|
+
}
|
|
117
|
+
/** Clears registered aliases and the once-only memory. Tests only. */
|
|
118
|
+
export function resetWorkerEnvAliasesForTests() {
|
|
119
|
+
aliases.clear();
|
|
120
|
+
warned.clear();
|
|
121
|
+
runtimeState.applied = [];
|
|
122
|
+
}
|
|
123
|
+
function isSet(value) {
|
|
124
|
+
return value !== undefined && value.trim().length > 0;
|
|
125
|
+
}
|
|
126
|
+
//# sourceMappingURL=worker-env-aliases.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"worker-env-aliases.js","sourceRoot":"","sources":["../../../src/engine/node/worker-env-aliases.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAqB,MAAM,iBAAiB,CAAC;AAC/D,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAE,YAAY,EAA8B,MAAM,oBAAoB,CAAC;AAE9E,gFAAgF;AAChF,2EAA2E;AAC3E,gFAAgF;AAChF,EAAE;AACF,2EAA2E;AAC3E,gFAAgF;AAChF,+EAA+E;AAC/E,0EAA0E;AAC1E,8EAA8E;AAC9E,qEAAqE;AACrE,EAAE;AACF,QAAQ;AACR,8DAA8D;AAC9D,gFAAgF;AAChF,4EAA4E;AAC5E,2DAA2D;AAC3D,2EAA2E;AAC3E,+EAA+E;AAC/E,2EAA2E;AAC3E,+DAA+D;AAC/D,gFAAgF;AAEhF,uCAAuC;AACvC,MAAM,aAAa,GAA4B,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;AAEtE,MAAM,QAAQ,GAAG,0BAA0B,CAAC;AAE5C,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,YAAY,CAAC;AAIzC;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,sBAAsB,CAAC,GAAiB,EAAE,UAAkB;IAC1E,MAAM,SAAS,GAAG,SAAS,EAAE,CAAC,GAAG,CAAC,CAAC;IACnC,IAAI,SAAS,KAAK,SAAS;QAAE,MAAM,IAAI,KAAK,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,oCAAoC,CAAC,CAAC;IAClG,IAAI,aAAa,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QAChC,MAAM,IAAI,KAAK,CAAC,+BAA+B,GAAG,yBAAyB,CAAC,CAAC;IAC/E,CAAC;IACD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,IAAI,UAAU,6CAA6C,CAAC,CAAC;IAC7G,IAAI,UAAU,KAAK,SAAS;QAAE,MAAM,IAAI,KAAK,CAAC,IAAI,UAAU,uCAAuC,GAAG,IAAI,CAAC,CAAC;IAC5G,IAAI,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;QACpD,MAAM,IAAI,KAAK,CAAC,IAAI,UAAU,qDAAqD,CAAC,CAAC;IACvF,CAAC;IAED,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;IACxC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAC;QAAE,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC;AAClF,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,oBAAoB;IAClC,OAAO,MAAM,CAAC,WAAW,CAAC,CAAC,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;AAC7F,CAAC;AAED,uEAAuE;AACvE,MAAM,UAAU,uBAAuB;IACrC,OAAO,YAAY,CAAC,OAAO,CAAC;AAC9B,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,qBAAqB,CACnC,MAAyB,OAAO,CAAC,GAAG,EACpC,IAAgC;IAEhC,MAAM,OAAO,GAA4B,EAAE,CAAC;IAE5C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,OAAO,EAAE,CAAC;QACnC,MAAM,SAAS,GAAG,SAAS,EAAE,CAAC,GAAG,CAAC,CAAC;QACnC,IAAI,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;YAAE,SAAS;QAEpC,KAAK,MAAM,MAAM,IAAI,KAAK,EAAE,CAAC;YAC3B,MAAM,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC;YACxB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC;gBAAE,SAAS;YAE1B,IAAI,GAAG,KAAK,iBAAiB,EAAE,CAAC;gBAC9B,+EAA+E;gBAC/E,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAI,CAAC,IAAI,EAAE,CAAC,CAAC;gBACrC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,QAAQ,GAAG,CAAC,IAAI,QAAQ,GAAG,CAAC;oBAAE,SAAS;gBACzE,IAAI,QAAQ,KAAK,CAAC;oBAAE,kBAAkB,EAAE,CAAC;;oBACpC,GAAG,CAAC,SAAS,CAAC,GAAG,GAAI,CAAC,IAAI,EAAE,CAAC;YACpC,CAAC;iBAAM,CAAC;gBACN,GAAG,CAAC,SAAS,CAAC,GAAG,GAAI,CAAC;YACxB,CAAC;YAED,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,CAAC;YACzC,MAAM,EAAE,GAAG,GAAG,MAAM,KAAK,SAAS,EAAE,CAAC;YACrC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;gBACpB,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;gBACf,IAAI,EAAE,CAAC,GAAG,MAAM,uBAAuB,SAAS,8CAA8C,CAAC,CAAC;YAClG,CAAC;YACD,MAAM;QACR,CAAC;IACH,CAAC;IAED,YAAY,CAAC,OAAO,GAAG,OAAO,CAAC;IAC/B,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,sEAAsE;AACtE,MAAM,UAAU,6BAA6B;IAC3C,OAAO,CAAC,KAAK,EAAE,CAAC;IAChB,MAAM,CAAC,KAAK,EAAE,CAAC;IACf,YAAY,CAAC,OAAO,GAAG,EAAE,CAAC;AAC5B,CAAC;AAED,SAAS,KAAK,CAAC,KAAyB;IACtC,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC;AACxD,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"worker-env-table.d.ts","sourceRoot":"","sources":["../../../src/engine/node/worker-env-table.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"worker-env-table.d.ts","sourceRoot":"","sources":["../../../src/engine/node/worker-env-table.ts"],"names":[],"mappings":"AAoFA,kFAAkF;AAClF,eAAO,MAAM,sBAAsB,8CAA8C,CAAC;AAClF,eAAO,MAAM,oBAAoB,4CAA4C,CAAC;AAE9E;;;;;;;;;GASG;AACH,wBAAgB,mBAAmB,IAAI,MAAM,CAY5C"}
|
|
@@ -2,6 +2,7 @@ import { readFileSync } from 'node:fs';
|
|
|
2
2
|
import { dirname, join } from 'node:path';
|
|
3
3
|
import { fileURLToPath } from 'node:url';
|
|
4
4
|
import { workerEnv } from './worker-env.js';
|
|
5
|
+
import { listWorkerEnvAliases } from './worker-env-aliases.js';
|
|
5
6
|
// =============================================================================
|
|
6
7
|
// The "Worker environment variables" table, generated from WORKER_ENV
|
|
7
8
|
// (issue #289, epic #254 — the documentation rollup)
|
|
@@ -89,7 +90,9 @@ export function buildWorkerEnvTable() {
|
|
|
89
90
|
const descriptions = parseWorkerEnvDescriptions();
|
|
90
91
|
const rows = Object.keys(workerEnv()).map((key) => {
|
|
91
92
|
const name = workerEnv()[key];
|
|
92
|
-
const
|
|
93
|
+
const legacy = listWorkerEnvAliases()[key] ?? [];
|
|
94
|
+
const suffix = legacy.length > 0 ? ` Legacy names still read: ${legacy.map((alias) => `\`${alias}\``).join(', ')}.` : '';
|
|
95
|
+
const description = `${descriptions[key] ?? ''}${suffix}`.trim();
|
|
93
96
|
return `| \`${name}\` | ${description} |`;
|
|
94
97
|
});
|
|
95
98
|
return ['| Variable | Description |', '| --- | --- |', ...rows].join('\n');
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"worker-env-table.js","sourceRoot":"","sources":["../../../src/engine/node/worker-env-table.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC,OAAO,EAAE,SAAS,EAAqB,MAAM,iBAAiB,CAAC;AAE/D,gFAAgF;AAChF,sEAAsE;AACtE,qDAAqD;AACrD,gFAAgF;AAChF,EAAE;AACF,4EAA4E;AAC5E,4EAA4E;AAC5E,8EAA8E;AAC9E,0EAA0E;AAC1E,8EAA8E;AAC9E,qEAAqE;AACrE,EAAE;AACF,wCAAwC;AACxC,EAAE;AACF,wEAAwE;AACxE,8EAA8E;AAC9E,iEAAiE;AACjE,8EAA8E;AAC9E,8EAA8E;AAC9E,sEAAsE;AACtE,EAAE;AACF,4DAA4D;AAC5D,yEAAyE;AACzE,6EAA6E;AAC7E,0EAA0E;AAC1E,gDAAgD;AAChD,gFAAgF;AAEhF,MAAM,IAAI,GAAG,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAErD;;;;;;;;;GASG;AACH,SAAS,0BAA0B;IACjC,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,eAAe,CAAC,EAAE,MAAM,CAAC,CAAC;IACjE,MAAM,YAAY,GAA0C,EAAE,CAAC;IAE/D,4EAA4E;IAC5E,oEAAoE;IACpE,qEAAqE;IACrE,sEAAsE;IACtE,yEAAyE;IACzE,0EAA0E;IAC1E,4EAA4E;IAC5E,2EAA2E;IAC3E,yEAAyE;IACzE,wBAAwB;IACxB,MAAM,OAAO,GAAG,gDAAgD,CAAC;IAEjE,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QAC7C,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAC3B,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAiB,CAAC;QAErC,uEAAuE;QACvE,qEAAqE;QACrE,mEAAmE;QACnE,kDAAkD;QAClD,MAAM,IAAI,GAAG,GAAG;aACb,KAAK,CAAC,IAAI,CAAC;aACX,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;aACnD,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;aACjC,IAAI,CAAC,GAAG,CAAC;aACT,IAAI,EAAE,CAAC;QAEV,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC;YAAE,YAAY,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;IAChD,CAAC;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,kFAAkF;AAClF,MAAM,CAAC,MAAM,sBAAsB,GAAG,2CAA2C,CAAC;AAClF,MAAM,CAAC,MAAM,oBAAoB,GAAG,yCAAyC,CAAC;AAE9E;;;;;;;;;GASG;AACH,MAAM,UAAU,mBAAmB;IACjC,MAAM,YAAY,GAAG,0BAA0B,EAAE,CAAC;IAElD,MAAM,IAAI,GAAI,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,CAAoB,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACpE,MAAM,IAAI,GAAG,SAAS,EAAE,CAAC,GAAG,CAAC,CAAC;QAC9B,MAAM,WAAW,GAAG,YAAY,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;
|
|
1
|
+
{"version":3,"file":"worker-env-table.js","sourceRoot":"","sources":["../../../src/engine/node/worker-env-table.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC,OAAO,EAAE,SAAS,EAAqB,MAAM,iBAAiB,CAAC;AAC/D,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAE/D,gFAAgF;AAChF,sEAAsE;AACtE,qDAAqD;AACrD,gFAAgF;AAChF,EAAE;AACF,4EAA4E;AAC5E,4EAA4E;AAC5E,8EAA8E;AAC9E,0EAA0E;AAC1E,8EAA8E;AAC9E,qEAAqE;AACrE,EAAE;AACF,wCAAwC;AACxC,EAAE;AACF,wEAAwE;AACxE,8EAA8E;AAC9E,iEAAiE;AACjE,8EAA8E;AAC9E,8EAA8E;AAC9E,sEAAsE;AACtE,EAAE;AACF,4DAA4D;AAC5D,yEAAyE;AACzE,6EAA6E;AAC7E,0EAA0E;AAC1E,gDAAgD;AAChD,gFAAgF;AAEhF,MAAM,IAAI,GAAG,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAErD;;;;;;;;;GASG;AACH,SAAS,0BAA0B;IACjC,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,eAAe,CAAC,EAAE,MAAM,CAAC,CAAC;IACjE,MAAM,YAAY,GAA0C,EAAE,CAAC;IAE/D,4EAA4E;IAC5E,oEAAoE;IACpE,qEAAqE;IACrE,sEAAsE;IACtE,yEAAyE;IACzE,0EAA0E;IAC1E,4EAA4E;IAC5E,2EAA2E;IAC3E,yEAAyE;IACzE,wBAAwB;IACxB,MAAM,OAAO,GAAG,gDAAgD,CAAC;IAEjE,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QAC7C,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAC3B,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAiB,CAAC;QAErC,uEAAuE;QACvE,qEAAqE;QACrE,mEAAmE;QACnE,kDAAkD;QAClD,MAAM,IAAI,GAAG,GAAG;aACb,KAAK,CAAC,IAAI,CAAC;aACX,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;aACnD,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;aACjC,IAAI,CAAC,GAAG,CAAC;aACT,IAAI,EAAE,CAAC;QAEV,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC;YAAE,YAAY,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;IAChD,CAAC;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,kFAAkF;AAClF,MAAM,CAAC,MAAM,sBAAsB,GAAG,2CAA2C,CAAC;AAClF,MAAM,CAAC,MAAM,oBAAoB,GAAG,yCAAyC,CAAC;AAE9E;;;;;;;;;GASG;AACH,MAAM,UAAU,mBAAmB;IACjC,MAAM,YAAY,GAAG,0BAA0B,EAAE,CAAC;IAElD,MAAM,IAAI,GAAI,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,CAAoB,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACpE,MAAM,IAAI,GAAG,SAAS,EAAE,CAAC,GAAG,CAAC,CAAC;QAC9B,MAAM,MAAM,GAAG,oBAAoB,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;QACjD,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,6BAA6B,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QACzH,MAAM,WAAW,GAAG,GAAG,YAAY,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC;QACjE,OAAO,OAAO,IAAI,QAAQ,WAAW,IAAI,CAAC;IAC5C,CAAC,CAAC,CAAC;IAEH,OAAO,CAAC,4BAA4B,EAAE,eAAe,EAAE,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC7E,CAAC"}
|
|
@@ -5,6 +5,8 @@
|
|
|
5
5
|
* a user sets. Adding a variable means adding it here first — #278's guard
|
|
6
6
|
* asserts this map and the container files agree in BOTH directions, so a
|
|
7
7
|
* variable that exists in only one of the two places is a failing test.
|
|
8
|
+
*
|
|
9
|
+
* @stability experimental
|
|
8
10
|
*/
|
|
9
11
|
export declare function workerEnv(): {
|
|
10
12
|
/** `APPCTL_SERVER_URL` — reused from `config.ts`, never minted again. */
|
|
@@ -42,8 +44,18 @@ export declare function workerEnv(): {
|
|
|
42
44
|
readonly memoryThreshold: string;
|
|
43
45
|
/** `false` to disable ALL THREE heap-snapshot paths. */
|
|
44
46
|
readonly heapSnapshots: string;
|
|
47
|
+
/**
|
|
48
|
+
* Thread cap for native image/codec libraries (libvips and the like), per
|
|
49
|
+
* pipeline. A positive whole number; unset means half the cores, between 1
|
|
50
|
+
* and 4. Handed to every registered worker runtime hook.
|
|
51
|
+
*/
|
|
52
|
+
readonly nativeThreads: string;
|
|
45
53
|
};
|
|
46
|
-
/**
|
|
54
|
+
/**
|
|
55
|
+
* The key set of `WORKER_ENV`, for exhaustive iteration in guards and docs.
|
|
56
|
+
*
|
|
57
|
+
* @stability experimental
|
|
58
|
+
*/
|
|
47
59
|
export type WorkerEnvKey = keyof ReturnType<typeof workerEnv>;
|
|
48
60
|
/** Every variable name the worker reads, deduplicated and sorted. */
|
|
49
61
|
export declare function workerEnvNames(): string[];
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"worker-env.d.ts","sourceRoot":"","sources":["../../../src/engine/node/worker-env.ts"],"names":[],"mappings":"AAmDA
|
|
1
|
+
{"version":3,"file":"worker-env.d.ts","sourceRoot":"","sources":["../../../src/engine/node/worker-env.ts"],"names":[],"mappings":"AAmDA;;;;;;;;;GASG;AACH,wBAAgB,SAAS;IAErB,yEAAyE;;IAEzE,+EAA+E;;IAE/E,gFAAgF;;IAEhF,mFAAmF;;IAEnF,+EAA+E;;IAE/E,gFAAgF;;IAEhF,0CAA0C;;IAE1C,8EAA8E;;IAE9E,sFAAsF;;IAEtF,8EAA8E;;IAE9E;;;;;;;OAOG;;IAEH,oEAAoE;;IAEpE,0EAA0E;;IAE1E,wDAAwD;;IAExD;;;;OAIG;;EAGN;AAED;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,UAAU,CAAC,OAAO,SAAS,CAAC,CAAC;AAE9D,qEAAqE;AACrE,wBAAgB,cAAc,IAAI,MAAM,EAAE,CAEzC"}
|
|
@@ -54,6 +54,8 @@ import { serverUrlEnvVar, tokenEnvVar } from '../config.js';
|
|
|
54
54
|
* a user sets. Adding a variable means adding it here first — #278's guard
|
|
55
55
|
* asserts this map and the container files agree in BOTH directions, so a
|
|
56
56
|
* variable that exists in only one of the two places is a failing test.
|
|
57
|
+
*
|
|
58
|
+
* @stability experimental
|
|
57
59
|
*/
|
|
58
60
|
export function workerEnv() {
|
|
59
61
|
return {
|
|
@@ -92,6 +94,12 @@ export function workerEnv() {
|
|
|
92
94
|
memoryThreshold: envVar('MEMORY_THRESHOLD'),
|
|
93
95
|
/** `false` to disable ALL THREE heap-snapshot paths. */
|
|
94
96
|
heapSnapshots: envVar('HEAP_SNAPSHOTS'),
|
|
97
|
+
/**
|
|
98
|
+
* Thread cap for native image/codec libraries (libvips and the like), per
|
|
99
|
+
* pipeline. A positive whole number; unset means half the cores, between 1
|
|
100
|
+
* and 4. Handed to every registered worker runtime hook.
|
|
101
|
+
*/
|
|
102
|
+
nativeThreads: envVar('NATIVE_THREADS'),
|
|
95
103
|
};
|
|
96
104
|
}
|
|
97
105
|
/** Every variable name the worker reads, deduplicated and sorted. */
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"worker-env.js","sourceRoot":"","sources":["../../../src/engine/node/worker-env.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AACxC,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAE5D,gFAAgF;AAChF,uFAAuF;AACvF,gFAAgF;AAChF,EAAE;AACF,4EAA4E;AAC5E,8EAA8E;AAC9E,6EAA6E;AAC7E,4EAA4E;AAC5E,6EAA6E;AAC7E,iEAAiE;AACjE,6EAA6E;AAC7E,EAAE;AACF,2EAA2E;AAC3E,4EAA4E;AAC5E,gFAAgF;AAChF,2DAA2D;AAC3D,EAAE;AACF,gFAAgF;AAChF,gDAAgD;AAChD,gFAAgF;AAChF,EAAE;AACF,+DAA+D;AAC/D,0EAA0E;AAC1E,6EAA6E;AAC7E,wCAAwC;AACxC,EAAE;AACF,uEAAuE;AACvE,8EAA8E;AAC9E,4EAA4E;AAC5E,0EAA0E;AAC1E,EAAE;AACF,8EAA8E;AAC9E,6EAA6E;AAC7E,wEAAwE;AACxE,8BAA8B;AAC9B,EAAE;AACF,gFAAgF;AAChF,YAAY;AACZ,gFAAgF;AAChF,EAAE;AACF,6EAA6E;AAC7E,2EAA2E;AAC3E,yEAAyE;AACzE,uEAAuE;AACvE,yEAAyE;AACzE,qDAAqD;AACrD,gFAAgF;AAEhF
|
|
1
|
+
{"version":3,"file":"worker-env.js","sourceRoot":"","sources":["../../../src/engine/node/worker-env.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AACxC,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAE5D,gFAAgF;AAChF,uFAAuF;AACvF,gFAAgF;AAChF,EAAE;AACF,4EAA4E;AAC5E,8EAA8E;AAC9E,6EAA6E;AAC7E,4EAA4E;AAC5E,6EAA6E;AAC7E,iEAAiE;AACjE,6EAA6E;AAC7E,EAAE;AACF,2EAA2E;AAC3E,4EAA4E;AAC5E,gFAAgF;AAChF,2DAA2D;AAC3D,EAAE;AACF,gFAAgF;AAChF,gDAAgD;AAChD,gFAAgF;AAChF,EAAE;AACF,+DAA+D;AAC/D,0EAA0E;AAC1E,6EAA6E;AAC7E,wCAAwC;AACxC,EAAE;AACF,uEAAuE;AACvE,8EAA8E;AAC9E,4EAA4E;AAC5E,0EAA0E;AAC1E,EAAE;AACF,8EAA8E;AAC9E,6EAA6E;AAC7E,wEAAwE;AACxE,8BAA8B;AAC9B,EAAE;AACF,gFAAgF;AAChF,YAAY;AACZ,gFAAgF;AAChF,EAAE;AACF,6EAA6E;AAC7E,2EAA2E;AAC3E,yEAAyE;AACzE,uEAAuE;AACvE,yEAAyE;AACzE,qDAAqD;AACrD,gFAAgF;AAEhF;;;;;;;;;GASG;AACH,MAAM,UAAU,SAAS;IACvB,OAAO;QACL,yEAAyE;QACzE,SAAS,EAAE,eAAe,EAAE;QAC5B,+EAA+E;QAC/E,KAAK,EAAE,WAAW,EAAE;QACpB,gFAAgF;QAChF,MAAM,EAAE,MAAM,CAAC,SAAS,CAAC;QACzB,mFAAmF;QACnF,QAAQ,EAAE,MAAM,CAAC,WAAW,CAAC;QAC7B,+EAA+E;QAC/E,WAAW,EAAE,MAAM,CAAC,aAAa,CAAC;QAClC,gFAAgF;QAChF,KAAK,EAAE,MAAM,CAAC,gBAAgB,CAAC;QAC/B,0CAA0C;QAC1C,MAAM,EAAE,MAAM,CAAC,kBAAkB,CAAC;QAClC,8EAA8E;QAC9E,QAAQ,EAAE,MAAM,CAAC,UAAU,CAAC;QAC5B,sFAAsF;QACtF,QAAQ,EAAE,MAAM,CAAC,WAAW,CAAC;QAC7B,8EAA8E;QAC9E,WAAW,EAAE,MAAM,CAAC,eAAe,CAAC;QACpC;;;;;;;WAOG;QACH,SAAS,EAAE,MAAM,CAAC,YAAY,CAAC;QAC/B,oEAAoE;QACpE,cAAc,EAAE,MAAM,CAAC,iBAAiB,CAAC;QACzC,0EAA0E;QAC1E,eAAe,EAAE,MAAM,CAAC,kBAAkB,CAAC;QAC3C,wDAAwD;QACxD,aAAa,EAAE,MAAM,CAAC,gBAAgB,CAAC;QACvC;;;;WAIG;QACH,aAAa,EAAE,MAAM,CAAC,gBAAgB,CAAC;KAC/B,CAAC;AACb,CAAC;AASD,qEAAqE;AACrE,MAAM,UAAU,cAAc;IAC5B,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;AACzD,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"registries.d.ts","sourceRoot":"","sources":["../../src/engine/registries.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"registries.d.ts","sourceRoot":"","sources":["../../src/engine/registries.ts"],"names":[],"mappings":"AAuCA,6DAA6D;AAC7D,wBAAgB,mBAAmB,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAepD;AAED,4DAA4D;AAC5D,wBAAgB,0BAA0B,IAAI,IAAI,CAkBjD"}
|
|
@@ -6,7 +6,11 @@ import { freezeEdgeConfigRegistry, resetEdgeConfigRegistryForTests } from './dep
|
|
|
6
6
|
import { freezeProxyStreamRegistry, resetProxyStreamRegistryForTests } from './deploy/proxy-streams.js';
|
|
7
7
|
import { freezeDeployStepRegistry, resetDeployStepRegistryForTests } from './deploy/steps/registry.js';
|
|
8
8
|
import { resetCapabilityRegistriesForTests } from './node/capabilities.js';
|
|
9
|
+
import { resetRuntimeStateForTests } from './node/runtime-state.js';
|
|
9
10
|
import { freezeNodeExecutorRegistry, resetNodeExecutorRegistryForTests } from './node/executors/registry.js';
|
|
11
|
+
import { freezeTuiAppRegistries, resetTuiAppRegistriesForTests } from './tui/app-registry.js';
|
|
12
|
+
import { resetTuiThemeForTests } from './tui/theme.js';
|
|
13
|
+
import { freezeTuiMenuRegistry, resetTuiMenuRegistryForTests } from './tui/menu-registry.js';
|
|
10
14
|
import { freezeTuiSectionRegistry, resetTuiSectionRegistryForTests } from './tui/section-registry.js';
|
|
11
15
|
import { freezeTuiScreenRegistry, resetTuiScreenRegistryForTests } from './tui/screen-registry.js';
|
|
12
16
|
import { resetUpdateNoticeForTests } from './update-notice-options.js';
|
|
@@ -24,6 +28,7 @@ import { resetUpdateNoticeForTests } from './update-notice-options.js';
|
|
|
24
28
|
// =============================================================================
|
|
25
29
|
/** Freezes every CLI registry; `createCli` calls it last. */
|
|
26
30
|
export function freezeCliRegistries(by) {
|
|
31
|
+
freezeTuiMenuRegistry(by);
|
|
27
32
|
freezeCommandRegistry(by);
|
|
28
33
|
freezeEnvSpecRegistry(by);
|
|
29
34
|
freezeEnvGroupRegistry(by);
|
|
@@ -33,6 +38,7 @@ export function freezeCliRegistries(by) {
|
|
|
33
38
|
freezeDeployStepRegistry(by);
|
|
34
39
|
freezeNodeExecutorRegistry(by);
|
|
35
40
|
freezeTuiSectionRegistry(by);
|
|
41
|
+
freezeTuiAppRegistries(by);
|
|
36
42
|
freezeProxyStreamRegistry(by);
|
|
37
43
|
freezeDeployCheckRegistry(by);
|
|
38
44
|
freezeEdgeConfigRegistry(by);
|
|
@@ -41,10 +47,14 @@ export function freezeCliRegistries(by) {
|
|
|
41
47
|
export function resetCliRegistriesForTests() {
|
|
42
48
|
resetPlatformRegistrationsForTests();
|
|
43
49
|
resetTuiScreenRegistryForTests();
|
|
50
|
+
resetTuiMenuRegistryForTests();
|
|
44
51
|
resetTuiSectionRegistryForTests();
|
|
52
|
+
resetTuiAppRegistriesForTests();
|
|
53
|
+
resetTuiThemeForTests();
|
|
45
54
|
resetDeployStepRegistryForTests();
|
|
46
55
|
resetNodeExecutorRegistryForTests();
|
|
47
56
|
resetCapabilityRegistriesForTests();
|
|
57
|
+
resetRuntimeStateForTests();
|
|
48
58
|
resetProxyStreamRegistryForTests();
|
|
49
59
|
resetEnvGeneratorRegistryForTests();
|
|
50
60
|
resetEnvAnnotationRegistryForTests();
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"registries.js","sourceRoot":"","sources":["../../src/engine/registries.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,2BAA2B,EAC3B,0BAA0B,EAC1B,sBAAsB,EACtB,qBAAqB,EACrB,kCAAkC,EAClC,iCAAiC,GAClC,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,kCAAkC,EAAE,MAAM,4BAA4B,CAAC;AAChF,OAAO,EAAE,+BAA+B,EAAE,MAAM,yBAAyB,CAAC;AAC1E,OAAO,EAAE,yBAAyB,EAAE,gCAAgC,EAAE,MAAM,6BAA6B,CAAC;AAC1G,OAAO,EAAE,wBAAwB,EAAE,+BAA+B,EAAE,MAAM,yBAAyB,CAAC;AACpG,OAAO,EAAE,yBAAyB,EAAE,gCAAgC,EAAE,MAAM,2BAA2B,CAAC;AACxG,OAAO,EAAE,wBAAwB,EAAE,+BAA+B,EAAE,MAAM,4BAA4B,CAAC;AACvG,OAAO,EAAE,iCAAiC,EAAE,MAAM,wBAAwB,CAAC;AAC3E,OAAO,EAAE,0BAA0B,EAAE,iCAAiC,EAAE,MAAM,8BAA8B,CAAC;AAC7G,OAAO,EAAE,wBAAwB,EAAE,+BAA+B,EAAE,MAAM,2BAA2B,CAAC;AACtG,OAAO,EAAE,uBAAuB,EAAE,8BAA8B,EAAE,MAAM,0BAA0B,CAAC;AACnG,OAAO,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAC;AAEvE,gFAAgF;AAChF,iDAAiD;AACjD,gFAAgF;AAChF,EAAE;AACF,sEAAsE;AACtE,4EAA4E;AAC5E,qEAAqE;AACrE,wEAAwE;AACxE,6EAA6E;AAC7E,4EAA4E;AAC5E,2EAA2E;AAC3E,gFAAgF;AAEhF,6DAA6D;AAC7D,MAAM,UAAU,mBAAmB,CAAC,EAAU;IAC5C,qBAAqB,CAAC,EAAE,CAAC,CAAC;IAC1B,qBAAqB,CAAC,EAAE,CAAC,CAAC;IAC1B,sBAAsB,CAAC,EAAE,CAAC,CAAC;IAC3B,0BAA0B,CAAC,EAAE,CAAC,CAAC;IAC/B,2BAA2B,CAAC,EAAE,CAAC,CAAC;IAChC,uBAAuB,CAAC,EAAE,CAAC,CAAC;IAC5B,wBAAwB,CAAC,EAAE,CAAC,CAAC;IAC7B,0BAA0B,CAAC,EAAE,CAAC,CAAC;IAC/B,wBAAwB,CAAC,EAAE,CAAC,CAAC;IAC7B,yBAAyB,CAAC,EAAE,CAAC,CAAC;IAC9B,yBAAyB,CAAC,EAAE,CAAC,CAAC;IAC9B,wBAAwB,CAAC,EAAE,CAAC,CAAC;AAC/B,CAAC;AAED,4DAA4D;AAC5D,MAAM,UAAU,0BAA0B;IACxC,kCAAkC,EAAE,CAAC;IACrC,8BAA8B,EAAE,CAAC;IACjC,+BAA+B,EAAE,CAAC;IAClC,+BAA+B,EAAE,CAAC;IAClC,iCAAiC,EAAE,CAAC;IACpC,iCAAiC,EAAE,CAAC;IACpC,gCAAgC,EAAE,CAAC;IACnC,iCAAiC,EAAE,CAAC;IACpC,kCAAkC,EAAE,CAAC;IACrC,gCAAgC,EAAE,CAAC;IACnC,+BAA+B,EAAE,CAAC;IAClC,+BAA+B,EAAE,CAAC;IAClC,yBAAyB,EAAE,CAAC;AAC9B,CAAC"}
|
|
1
|
+
{"version":3,"file":"registries.js","sourceRoot":"","sources":["../../src/engine/registries.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,2BAA2B,EAC3B,0BAA0B,EAC1B,sBAAsB,EACtB,qBAAqB,EACrB,kCAAkC,EAClC,iCAAiC,GAClC,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,kCAAkC,EAAE,MAAM,4BAA4B,CAAC;AAChF,OAAO,EAAE,+BAA+B,EAAE,MAAM,yBAAyB,CAAC;AAC1E,OAAO,EAAE,yBAAyB,EAAE,gCAAgC,EAAE,MAAM,6BAA6B,CAAC;AAC1G,OAAO,EAAE,wBAAwB,EAAE,+BAA+B,EAAE,MAAM,yBAAyB,CAAC;AACpG,OAAO,EAAE,yBAAyB,EAAE,gCAAgC,EAAE,MAAM,2BAA2B,CAAC;AACxG,OAAO,EAAE,wBAAwB,EAAE,+BAA+B,EAAE,MAAM,4BAA4B,CAAC;AACvG,OAAO,EAAE,iCAAiC,EAAE,MAAM,wBAAwB,CAAC;AAC3E,OAAO,EAAE,yBAAyB,EAAE,MAAM,yBAAyB,CAAC;AACpE,OAAO,EAAE,0BAA0B,EAAE,iCAAiC,EAAE,MAAM,8BAA8B,CAAC;AAC7G,OAAO,EAAE,sBAAsB,EAAE,6BAA6B,EAAE,MAAM,uBAAuB,CAAC;AAC9F,OAAO,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAC;AACvD,OAAO,EAAE,qBAAqB,EAAE,4BAA4B,EAAE,MAAM,wBAAwB,CAAC;AAC7F,OAAO,EAAE,wBAAwB,EAAE,+BAA+B,EAAE,MAAM,2BAA2B,CAAC;AACtG,OAAO,EAAE,uBAAuB,EAAE,8BAA8B,EAAE,MAAM,0BAA0B,CAAC;AACnG,OAAO,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAC;AAEvE,gFAAgF;AAChF,iDAAiD;AACjD,gFAAgF;AAChF,EAAE;AACF,sEAAsE;AACtE,4EAA4E;AAC5E,qEAAqE;AACrE,wEAAwE;AACxE,6EAA6E;AAC7E,4EAA4E;AAC5E,2EAA2E;AAC3E,gFAAgF;AAEhF,6DAA6D;AAC7D,MAAM,UAAU,mBAAmB,CAAC,EAAU;IAC5C,qBAAqB,CAAC,EAAE,CAAC,CAAC;IAC1B,qBAAqB,CAAC,EAAE,CAAC,CAAC;IAC1B,qBAAqB,CAAC,EAAE,CAAC,CAAC;IAC1B,sBAAsB,CAAC,EAAE,CAAC,CAAC;IAC3B,0BAA0B,CAAC,EAAE,CAAC,CAAC;IAC/B,2BAA2B,CAAC,EAAE,CAAC,CAAC;IAChC,uBAAuB,CAAC,EAAE,CAAC,CAAC;IAC5B,wBAAwB,CAAC,EAAE,CAAC,CAAC;IAC7B,0BAA0B,CAAC,EAAE,CAAC,CAAC;IAC/B,wBAAwB,CAAC,EAAE,CAAC,CAAC;IAC7B,sBAAsB,CAAC,EAAE,CAAC,CAAC;IAC3B,yBAAyB,CAAC,EAAE,CAAC,CAAC;IAC9B,yBAAyB,CAAC,EAAE,CAAC,CAAC;IAC9B,wBAAwB,CAAC,EAAE,CAAC,CAAC;AAC/B,CAAC;AAED,4DAA4D;AAC5D,MAAM,UAAU,0BAA0B;IACxC,kCAAkC,EAAE,CAAC;IACrC,8BAA8B,EAAE,CAAC;IACjC,4BAA4B,EAAE,CAAC;IAC/B,+BAA+B,EAAE,CAAC;IAClC,6BAA6B,EAAE,CAAC;IAChC,qBAAqB,EAAE,CAAC;IACxB,+BAA+B,EAAE,CAAC;IAClC,iCAAiC,EAAE,CAAC;IACpC,iCAAiC,EAAE,CAAC;IACpC,yBAAyB,EAAE,CAAC;IAC5B,gCAAgC,EAAE,CAAC;IACnC,iCAAiC,EAAE,CAAC;IACpC,kCAAkC,EAAE,CAAC;IACrC,gCAAgC,EAAE,CAAC;IACnC,+BAA+B,EAAE,CAAC;IAClC,+BAA+B,EAAE,CAAC;IAClC,yBAAyB,EAAE,CAAC;AAC9B,CAAC"}
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* What a selection or state loader is told when it runs. Never carries the token.
|
|
3
|
+
*
|
|
4
|
+
* @stability experimental
|
|
5
|
+
*/
|
|
6
|
+
export interface TuiLoaderContext {
|
|
7
|
+
/** Whether a token is stored. */
|
|
8
|
+
loggedIn: boolean;
|
|
9
|
+
/** The server the CLI is configured for. */
|
|
10
|
+
serverUrl: string | undefined;
|
|
11
|
+
/** Aborted when the provider unmounts or a `session.refresh()` supersedes this run. */
|
|
12
|
+
signal: AbortSignal;
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* An app-defined selection slot.
|
|
16
|
+
*
|
|
17
|
+
* @typeParam T - The selectable item.
|
|
18
|
+
* @stability experimental
|
|
19
|
+
*/
|
|
20
|
+
export interface TuiSelectionRegistration<T = unknown> {
|
|
21
|
+
/** Unique id, lowercase `[a-z0-9-]`; also the key under `tui.selection.<id>` in the CLI config. */
|
|
22
|
+
id: string;
|
|
23
|
+
/** The chip's label in the frame header, e.g. `Circle`. */
|
|
24
|
+
label: string;
|
|
25
|
+
/** Loads the choices. Runs on mount and again after `session.refresh()`. */
|
|
26
|
+
load: (context: TuiLoaderContext) => Promise<readonly T[]>;
|
|
27
|
+
/** The chip's text for an item. */
|
|
28
|
+
display: (item: T) => string;
|
|
29
|
+
/**
|
|
30
|
+
* A stable string identifying an item, used to restore a persisted choice.
|
|
31
|
+
* Defaults to `display(item)`; give it when two items can share a display text.
|
|
32
|
+
*/
|
|
33
|
+
keyOf?: ((item: T) => string) | undefined;
|
|
34
|
+
/** `config` keeps the choice in the CLI config file (`tui.selection.<id>`); `none` (the default) does not. */
|
|
35
|
+
persist?: 'config' | 'none' | undefined;
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* An app-defined loader of data shared by every screen.
|
|
39
|
+
*
|
|
40
|
+
* @typeParam T - The loaded value.
|
|
41
|
+
* @stability experimental
|
|
42
|
+
*/
|
|
43
|
+
export interface TuiStateLoaderRegistration<T = unknown> {
|
|
44
|
+
/** Unique id, lowercase `[a-z0-9-]`. */
|
|
45
|
+
id: string;
|
|
46
|
+
/** Loads the value. Runs on mount and again after `session.refresh()`. */
|
|
47
|
+
load: (context: TuiLoaderContext) => Promise<T>;
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Declares a selection: shown as a chip in the TUI header, read by screens
|
|
51
|
+
* with `useTuiSelection(id)`. None registered means no chip.
|
|
52
|
+
*
|
|
53
|
+
* @typeParam T - The selectable item.
|
|
54
|
+
* @param selection - The id, label, loader, display function and persistence.
|
|
55
|
+
* @throws Error when the id is malformed or taken, the shape is wrong, or `createCli` has already built the CLI.
|
|
56
|
+
* @stability experimental
|
|
57
|
+
* @extensionPoint registry
|
|
58
|
+
* @example
|
|
59
|
+
* ```ts
|
|
60
|
+
* registerTuiSelection<Project>({
|
|
61
|
+
* id: 'project',
|
|
62
|
+
* label: 'Project',
|
|
63
|
+
* persist: 'config',
|
|
64
|
+
* load: async () => (await listProjects()),
|
|
65
|
+
* display: (project) => project.name,
|
|
66
|
+
* keyOf: (project) => project.id,
|
|
67
|
+
* });
|
|
68
|
+
* ```
|
|
69
|
+
*/
|
|
70
|
+
export declare function registerTuiSelection<T>(selection: TuiSelectionRegistration<T>): void;
|
|
71
|
+
/**
|
|
72
|
+
* The selections registered so far, in registration order.
|
|
73
|
+
*
|
|
74
|
+
* @returns A frozen copy.
|
|
75
|
+
* @stability experimental
|
|
76
|
+
*/
|
|
77
|
+
export declare function listTuiSelections(): readonly TuiSelectionRegistration[];
|
|
78
|
+
/**
|
|
79
|
+
* Declares data loaded once for every screen, read with `useTuiState(id)`.
|
|
80
|
+
*
|
|
81
|
+
* @typeParam T - The loaded value.
|
|
82
|
+
* @param loader - The id and the loader.
|
|
83
|
+
* @throws Error when the id is malformed or taken, or `createCli` has already built the CLI.
|
|
84
|
+
* @stability experimental
|
|
85
|
+
* @extensionPoint registry
|
|
86
|
+
* @example
|
|
87
|
+
* ```ts
|
|
88
|
+
* registerTuiStateLoader({ id: 'update-info', load: async () => checkForUpdate() });
|
|
89
|
+
* ```
|
|
90
|
+
*/
|
|
91
|
+
export declare function registerTuiStateLoader<T>(loader: TuiStateLoaderRegistration<T>): void;
|
|
92
|
+
/**
|
|
93
|
+
* The state loaders registered so far, in registration order.
|
|
94
|
+
*
|
|
95
|
+
* @returns A frozen copy.
|
|
96
|
+
* @stability experimental
|
|
97
|
+
*/
|
|
98
|
+
export declare function listTuiStateLoaders(): readonly TuiStateLoaderRegistration[];
|
|
99
|
+
/** Refuses later registrations; `createCli` calls it. */
|
|
100
|
+
export declare function freezeTuiAppRegistries(by: string): void;
|
|
101
|
+
/** Empties both registries. Tests only. */
|
|
102
|
+
export declare function resetTuiAppRegistriesForTests(): void;
|
|
103
|
+
//# sourceMappingURL=app-registry.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"app-registry.d.ts","sourceRoot":"","sources":["../../../src/engine/tui/app-registry.ts"],"names":[],"mappings":"AAoBA;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,iCAAiC;IACjC,QAAQ,EAAE,OAAO,CAAC;IAClB,4CAA4C;IAC5C,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,uFAAuF;IACvF,MAAM,EAAE,WAAW,CAAC;CACrB;AAED;;;;;GAKG;AACH,MAAM,WAAW,wBAAwB,CAAC,CAAC,GAAG,OAAO;IACnD,mGAAmG;IACnG,EAAE,EAAE,MAAM,CAAC;IACX,2DAA2D;IAC3D,KAAK,EAAE,MAAM,CAAC;IACd,4EAA4E;IAC5E,IAAI,EAAE,CAAC,OAAO,EAAE,gBAAgB,KAAK,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IAC3D,mCAAmC;IACnC,OAAO,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,MAAM,CAAC;IAC7B;;;OAGG;IACH,KAAK,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,KAAK,MAAM,CAAC,GAAG,SAAS,CAAC;IAC1C,8GAA8G;IAC9G,OAAO,CAAC,EAAE,QAAQ,GAAG,MAAM,GAAG,SAAS,CAAC;CACzC;AAED;;;;;GAKG;AACH,MAAM,WAAW,0BAA0B,CAAC,CAAC,GAAG,OAAO;IACrD,wCAAwC;IACxC,EAAE,EAAE,MAAM,CAAC;IACX,0EAA0E;IAC1E,IAAI,EAAE,CAAC,OAAO,EAAE,gBAAgB,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;CACjD;AAsCD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,EAAE,SAAS,EAAE,wBAAwB,CAAC,CAAC,CAAC,GAAG,IAAI,CAEpF;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,IAAI,SAAS,wBAAwB,EAAE,CAEvE;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,EAAE,MAAM,EAAE,0BAA0B,CAAC,CAAC,CAAC,GAAG,IAAI,CAErF;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,IAAI,SAAS,0BAA0B,EAAE,CAE3E;AAED,yDAAyD;AACzD,wBAAgB,sBAAsB,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAGvD;AAED,2CAA2C;AAC3C,wBAAgB,6BAA6B,IAAI,IAAI,CAGpD"}
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
import { createCliRegistry } from '../../core/index.js';
|
|
2
|
+
const ID_PATTERN = /^[a-z][a-z0-9-]*$/;
|
|
3
|
+
function validateId(kind, id) {
|
|
4
|
+
if (typeof id !== 'string' || !ID_PATTERN.test(id)) {
|
|
5
|
+
throw new Error(`TUI ${kind} id "${String(id)}" is invalid: use lowercase letters, digits and hyphens.`);
|
|
6
|
+
}
|
|
7
|
+
}
|
|
8
|
+
const selections = createCliRegistry({
|
|
9
|
+
name: 'TUI selection',
|
|
10
|
+
registerFn: 'registerTuiSelection',
|
|
11
|
+
idOf: (entry) => entry.id,
|
|
12
|
+
validate: (entry) => {
|
|
13
|
+
validateId('selection', entry.id);
|
|
14
|
+
if (typeof entry.label !== 'string' || entry.label.trim() === '') {
|
|
15
|
+
throw new Error(`TUI selection "${entry.id}" needs a label.`);
|
|
16
|
+
}
|
|
17
|
+
if (typeof entry.load !== 'function' || typeof entry.display !== 'function') {
|
|
18
|
+
throw new Error(`TUI selection "${entry.id}" needs load and display functions.`);
|
|
19
|
+
}
|
|
20
|
+
if (entry.persist !== undefined && entry.persist !== 'config' && entry.persist !== 'none') {
|
|
21
|
+
throw new Error(`TUI selection "${entry.id}": persist must be 'config' or 'none'.`);
|
|
22
|
+
}
|
|
23
|
+
},
|
|
24
|
+
});
|
|
25
|
+
const stateLoaders = createCliRegistry({
|
|
26
|
+
name: 'TUI state loader',
|
|
27
|
+
registerFn: 'registerTuiStateLoader',
|
|
28
|
+
idOf: (entry) => entry.id,
|
|
29
|
+
validate: (entry) => {
|
|
30
|
+
validateId('state loader', entry.id);
|
|
31
|
+
if (typeof entry.load !== 'function')
|
|
32
|
+
throw new Error(`TUI state loader "${entry.id}" needs a load function.`);
|
|
33
|
+
},
|
|
34
|
+
});
|
|
35
|
+
/**
|
|
36
|
+
* Declares a selection: shown as a chip in the TUI header, read by screens
|
|
37
|
+
* with `useTuiSelection(id)`. None registered means no chip.
|
|
38
|
+
*
|
|
39
|
+
* @typeParam T - The selectable item.
|
|
40
|
+
* @param selection - The id, label, loader, display function and persistence.
|
|
41
|
+
* @throws Error when the id is malformed or taken, the shape is wrong, or `createCli` has already built the CLI.
|
|
42
|
+
* @stability experimental
|
|
43
|
+
* @extensionPoint registry
|
|
44
|
+
* @example
|
|
45
|
+
* ```ts
|
|
46
|
+
* registerTuiSelection<Project>({
|
|
47
|
+
* id: 'project',
|
|
48
|
+
* label: 'Project',
|
|
49
|
+
* persist: 'config',
|
|
50
|
+
* load: async () => (await listProjects()),
|
|
51
|
+
* display: (project) => project.name,
|
|
52
|
+
* keyOf: (project) => project.id,
|
|
53
|
+
* });
|
|
54
|
+
* ```
|
|
55
|
+
*/
|
|
56
|
+
export function registerTuiSelection(selection) {
|
|
57
|
+
selections.register(selection);
|
|
58
|
+
}
|
|
59
|
+
/**
|
|
60
|
+
* The selections registered so far, in registration order.
|
|
61
|
+
*
|
|
62
|
+
* @returns A frozen copy.
|
|
63
|
+
* @stability experimental
|
|
64
|
+
*/
|
|
65
|
+
export function listTuiSelections() {
|
|
66
|
+
return selections.list();
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* Declares data loaded once for every screen, read with `useTuiState(id)`.
|
|
70
|
+
*
|
|
71
|
+
* @typeParam T - The loaded value.
|
|
72
|
+
* @param loader - The id and the loader.
|
|
73
|
+
* @throws Error when the id is malformed or taken, or `createCli` has already built the CLI.
|
|
74
|
+
* @stability experimental
|
|
75
|
+
* @extensionPoint registry
|
|
76
|
+
* @example
|
|
77
|
+
* ```ts
|
|
78
|
+
* registerTuiStateLoader({ id: 'update-info', load: async () => checkForUpdate() });
|
|
79
|
+
* ```
|
|
80
|
+
*/
|
|
81
|
+
export function registerTuiStateLoader(loader) {
|
|
82
|
+
stateLoaders.register(loader);
|
|
83
|
+
}
|
|
84
|
+
/**
|
|
85
|
+
* The state loaders registered so far, in registration order.
|
|
86
|
+
*
|
|
87
|
+
* @returns A frozen copy.
|
|
88
|
+
* @stability experimental
|
|
89
|
+
*/
|
|
90
|
+
export function listTuiStateLoaders() {
|
|
91
|
+
return stateLoaders.list();
|
|
92
|
+
}
|
|
93
|
+
/** Refuses later registrations; `createCli` calls it. */
|
|
94
|
+
export function freezeTuiAppRegistries(by) {
|
|
95
|
+
selections.freeze(by);
|
|
96
|
+
stateLoaders.freeze(by);
|
|
97
|
+
}
|
|
98
|
+
/** Empties both registries. Tests only. */
|
|
99
|
+
export function resetTuiAppRegistriesForTests() {
|
|
100
|
+
selections.reset();
|
|
101
|
+
stateLoaders.reset();
|
|
102
|
+
}
|
|
103
|
+
//# sourceMappingURL=app-registry.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"app-registry.js","sourceRoot":"","sources":["../../../src/engine/tui/app-registry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAuExD,MAAM,UAAU,GAAG,mBAAmB,CAAC;AAEvC,SAAS,UAAU,CAAC,IAAY,EAAE,EAAW;IAC3C,IAAI,OAAO,EAAE,KAAK,QAAQ,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;QACnD,MAAM,IAAI,KAAK,CAAC,OAAO,IAAI,QAAQ,MAAM,CAAC,EAAE,CAAC,0DAA0D,CAAC,CAAC;IAC3G,CAAC;AACH,CAAC;AAED,MAAM,UAAU,GAAG,iBAAiB,CAA2B;IAC7D,IAAI,EAAE,eAAe;IACrB,UAAU,EAAE,sBAAsB;IAClC,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE;IACzB,QAAQ,EAAE,CAAC,KAAK,EAAE,EAAE;QAClB,UAAU,CAAC,WAAW,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC;QAClC,IAAI,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YACjE,MAAM,IAAI,KAAK,CAAC,kBAAkB,KAAK,CAAC,EAAE,kBAAkB,CAAC,CAAC;QAChE,CAAC;QACD,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,UAAU,IAAI,OAAO,KAAK,CAAC,OAAO,KAAK,UAAU,EAAE,CAAC;YAC5E,MAAM,IAAI,KAAK,CAAC,kBAAkB,KAAK,CAAC,EAAE,qCAAqC,CAAC,CAAC;QACnF,CAAC;QACD,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,IAAI,KAAK,CAAC,OAAO,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,KAAK,MAAM,EAAE,CAAC;YAC1F,MAAM,IAAI,KAAK,CAAC,kBAAkB,KAAK,CAAC,EAAE,wCAAwC,CAAC,CAAC;QACtF,CAAC;IACH,CAAC;CACF,CAAC,CAAC;AAEH,MAAM,YAAY,GAAG,iBAAiB,CAA6B;IACjE,IAAI,EAAE,kBAAkB;IACxB,UAAU,EAAE,wBAAwB;IACpC,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE;IACzB,QAAQ,EAAE,CAAC,KAAK,EAAE,EAAE;QAClB,UAAU,CAAC,cAAc,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC;QACrC,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,UAAU;YAAE,MAAM,IAAI,KAAK,CAAC,qBAAqB,KAAK,CAAC,EAAE,0BAA0B,CAAC,CAAC;IACjH,CAAC;CACF,CAAC,CAAC;AAEH;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,UAAU,oBAAoB,CAAI,SAAsC;IAC5E,UAAU,CAAC,QAAQ,CAAC,SAAgD,CAAC,CAAC;AACxE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB;IAC/B,OAAO,UAAU,CAAC,IAAI,EAAE,CAAC;AAC3B,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,sBAAsB,CAAI,MAAqC;IAC7E,YAAY,CAAC,QAAQ,CAAC,MAA+C,CAAC,CAAC;AACzE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB;IACjC,OAAO,YAAY,CAAC,IAAI,EAAE,CAAC;AAC7B,CAAC;AAED,yDAAyD;AACzD,MAAM,UAAU,sBAAsB,CAAC,EAAU;IAC/C,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACtB,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;AAC1B,CAAC;AAED,2CAA2C;AAC3C,MAAM,UAAU,6BAA6B;IAC3C,UAAU,CAAC,KAAK,EAAE,CAAC;IACnB,YAAY,CAAC,KAAK,EAAE,CAAC;AACvB,CAAC"}
|
package/dist/engine/tui/app.d.ts
CHANGED
|
@@ -1,3 +1,11 @@
|
|
|
1
1
|
import { type ReactNode } from 'react';
|
|
2
|
-
|
|
2
|
+
import { type TuiAppProviderProps } from './context.js';
|
|
3
|
+
/**
|
|
4
|
+
* The app root: the context provider around the router.
|
|
5
|
+
*
|
|
6
|
+
* @param props - The provider's seams (tests only).
|
|
7
|
+
*/
|
|
8
|
+
export declare function App(props?: Omit<TuiAppProviderProps, 'children'>): ReactNode;
|
|
9
|
+
/** Renders the top frame of the navigation stack and nothing else. */
|
|
10
|
+
export declare function Router(): ReactNode;
|
|
3
11
|
//# sourceMappingURL=app.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../../../src/engine/tui/app.tsx"],"names":[],"mappings":"AACA,OAAO,
|
|
1
|
+
{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../../../src/engine/tui/app.tsx"],"names":[],"mappings":"AACA,OAAO,EAAmD,KAAK,SAAS,EAAE,MAAM,OAAO,CAAC;AAGxF,OAAO,EAA6B,KAAK,mBAAmB,EAAE,MAAM,cAAc,CAAC;AA+CnF;;;;GAIG;AACH,wBAAgB,GAAG,CAAC,KAAK,GAAE,IAAI,CAAC,mBAAmB,EAAE,UAAU,CAAM,GAAG,SAAS,CAMhF;AAED,sEAAsE;AACtE,wBAAgB,MAAM,IAAI,SAAS,CAkFlC"}
|