@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,32 @@
|
|
|
1
|
+
import { useEffect, useSyncExternalStore } from 'react';
|
|
2
|
+
/**
|
|
3
|
+
* Subscribes a screen to a {@link DashboardSource}: starts it on mount, stops
|
|
4
|
+
* it on unmount, and re-renders on every new state.
|
|
5
|
+
*
|
|
6
|
+
* The source is started and stopped by the hook, so build it once (in a
|
|
7
|
+
* `useMemo` or a ref) and pass the same instance on every render. Stopping
|
|
8
|
+
* on unmount is what keeps a reconnect timer or a poll from outliving the
|
|
9
|
+
* screen and holding the ink process open.
|
|
10
|
+
*
|
|
11
|
+
* @typeParam S - The dashboard's data.
|
|
12
|
+
* @typeParam E - One event.
|
|
13
|
+
* @param source - The source to follow; `undefined` renders nothing and starts nothing.
|
|
14
|
+
* @returns The current state (data plus connection fields), or `undefined` with no source.
|
|
15
|
+
* @stability experimental
|
|
16
|
+
* @example
|
|
17
|
+
* ```tsx
|
|
18
|
+
* const source = useMemo(() => new DashboardSource(jobsInsightsReducer, pollFeed(fetchJobs, { intervalMs: 5000 })), []);
|
|
19
|
+
* const state = useDashboard(source);
|
|
20
|
+
* ```
|
|
21
|
+
*/
|
|
22
|
+
export function useDashboard(source) {
|
|
23
|
+
const state = useSyncExternalStore((listener) => source?.subscribe(listener) ?? (() => { }), () => source?.getState());
|
|
24
|
+
useEffect(() => {
|
|
25
|
+
if (source === undefined)
|
|
26
|
+
return;
|
|
27
|
+
void source.start();
|
|
28
|
+
return () => source.stop();
|
|
29
|
+
}, [source]);
|
|
30
|
+
return state;
|
|
31
|
+
}
|
|
32
|
+
//# sourceMappingURL=use-dashboard.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"use-dashboard.js","sourceRoot":"","sources":["../../../../src/engine/tui/dashboard/use-dashboard.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,oBAAoB,EAAE,MAAM,OAAO,CAAC;AAIxD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,YAAY,CAAO,MAAyC;IAC1E,MAAM,KAAK,GAAG,oBAAoB,CAChC,CAAC,QAAQ,EAAE,EAAE,CAAC,MAAM,EAAE,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,EACvD,GAAG,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,CACzB,CAAC;IAEF,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,MAAM,KAAK,SAAS;YAAE,OAAO;QACjC,KAAK,MAAM,CAAC,KAAK,EAAE,CAAC;QACpB,OAAO,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;IAC7B,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IAEb,OAAO,KAAK,CAAC;AACf,CAAC"}
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
export interface StartTuiOptions {
|
|
2
2
|
stdout?: NodeJS.WriteStream | undefined;
|
|
3
3
|
stdin?: NodeJS.ReadStream | undefined;
|
|
4
|
+
/** Opens the controlling terminal when stdin cannot take raw mode (a test seam; defaults to `/dev/tty`). */
|
|
5
|
+
openTerminal?: (() => NodeJS.ReadStream | undefined) | undefined;
|
|
4
6
|
}
|
|
5
7
|
/**
|
|
6
8
|
* Mount the app and resolve with the process exit code once it unmounts.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/engine/tui/index.tsx"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/engine/tui/index.tsx"],"names":[],"mappings":"AAwBA,MAAM,WAAW,eAAe;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAC,WAAW,GAAG,SAAS,CAAC;IACxC,KAAK,CAAC,EAAE,MAAM,CAAC,UAAU,GAAG,SAAS,CAAC;IACtC,4GAA4G;IAC5G,YAAY,CAAC,EAAE,CAAC,MAAM,MAAM,CAAC,UAAU,GAAG,SAAS,CAAC,GAAG,SAAS,CAAC;CAClE;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,QAAQ,CAAC,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC,CAoEzE;AAED,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AACxD,YAAY,EAAE,UAAU,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC"}
|
package/dist/engine/tui/index.js
CHANGED
|
@@ -2,6 +2,8 @@ import { jsx as _jsx } from "react/jsx-runtime";
|
|
|
2
2
|
import { render } from 'ink';
|
|
3
3
|
import { EXIT, exitCodeFor, formatError } from '../errors.js';
|
|
4
4
|
import { App } from './app.js';
|
|
5
|
+
import { cliName } from '../identity.js';
|
|
6
|
+
import { resolveInteractiveStdin } from './raw-mode.js';
|
|
5
7
|
import { installTerminalRestore, restoreTerminal } from './terminal.js';
|
|
6
8
|
/**
|
|
7
9
|
* Mount the app and resolve with the process exit code once it unmounts.
|
|
@@ -20,7 +22,21 @@ import { installTerminalRestore, restoreTerminal } from './terminal.js';
|
|
|
20
22
|
*/
|
|
21
23
|
export async function startTui(options) {
|
|
22
24
|
const stdout = options?.stdout ?? process.stdout;
|
|
23
|
-
|
|
25
|
+
// A stdin ink can put in raw mode: the given one, else the controlling
|
|
26
|
+
// terminal. `setRawMode` throws EIO on serial, hypervisor and LXC consoles
|
|
27
|
+
// and when fd 0 is redirected; ink would surface that from `render` as a
|
|
28
|
+
// stack trace. With no usable terminal at all, say so and exit through the
|
|
29
|
+
// same path the TTY gate uses (usage error), never a throw.
|
|
30
|
+
const interactive = resolveInteractiveStdin({
|
|
31
|
+
stdin: options?.stdin ?? process.stdin,
|
|
32
|
+
...(options?.openTerminal === undefined ? {} : { openTerminal: options.openTerminal }),
|
|
33
|
+
});
|
|
34
|
+
if (interactive === null) {
|
|
35
|
+
process.stderr.write(`This terminal cannot run the interactive interface (raw keyboard input is unavailable). ` +
|
|
36
|
+
`Connect with a pseudo-terminal (ssh -t), or run \`${cliName()} --help\` to see the commands.\n`);
|
|
37
|
+
return EXIT.USAGE;
|
|
38
|
+
}
|
|
39
|
+
const stdin = interactive.stream;
|
|
24
40
|
// Installed BEFORE the first frame, removed in the `finally`. Between those
|
|
25
41
|
// two points the process may die in ways ink cannot see — a SIGTERM from
|
|
26
42
|
// another terminal, a SIGHUP when the window closes, a throw in our own async
|
|
@@ -65,6 +81,8 @@ export async function startTui(options) {
|
|
|
65
81
|
// the rest of the process's life.
|
|
66
82
|
restoreTerminal({ stdout, stdin });
|
|
67
83
|
uninstallRestore();
|
|
84
|
+
// Destroys the controlling-terminal stream when this function opened one.
|
|
85
|
+
interactive.release();
|
|
68
86
|
}
|
|
69
87
|
}
|
|
70
88
|
export { evaluateTuiGate, noTuiEnvVar } from './tty.js';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/engine/tui/index.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,KAAK,CAAC;AAE7B,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC9D,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAC/B,OAAO,EAAE,sBAAsB,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/engine/tui/index.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,KAAK,CAAC;AAE7B,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC9D,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAC/B,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AACzC,OAAO,EAAE,uBAAuB,EAAE,MAAM,eAAe,CAAC;AACxD,OAAO,EAAE,sBAAsB,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAyBxE;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,OAAyB;IACtD,MAAM,MAAM,GAAG,OAAO,EAAE,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC;IAEjD,uEAAuE;IACvE,2EAA2E;IAC3E,yEAAyE;IACzE,2EAA2E;IAC3E,4DAA4D;IAC5D,MAAM,WAAW,GAAG,uBAAuB,CAAC;QAC1C,KAAK,EAAE,OAAO,EAAE,KAAK,IAAI,OAAO,CAAC,KAAK;QACtC,GAAG,CAAC,OAAO,EAAE,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,OAAO,CAAC,YAAY,EAAE,CAAC;KACvF,CAAC,CAAC;IACH,IAAI,WAAW,KAAK,IAAI,EAAE,CAAC;QACzB,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB,0FAA0F;YACxF,qDAAqD,OAAO,EAAE,kCAAkC,CACnG,CAAC;QACF,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IACD,MAAM,KAAK,GAAG,WAAW,CAAC,MAAM,CAAC;IAEjC,4EAA4E;IAC5E,yEAAyE;IACzE,8EAA8E;IAC9E,6EAA6E;IAC7E,kEAAkE;IAClE,MAAM,gBAAgB,GAAG,sBAAsB,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;IAEnE,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAC,GAAG,KAAG,EAAE;YAC/B,MAAM;YACN,KAAK;YACL,2EAA2E;YAC3E,wEAAwE;YACxE,wEAAwE;YACxE,2EAA2E;YAC3E,sEAAsE;YACtE,uEAAuE;YACvE,WAAW,EAAE,IAAI;YACjB,qEAAqE;YACrE,2EAA2E;YAC3E,kEAAkE;YAClE,oDAAoD;YACpD,YAAY,EAAE,IAAI;SACnB,CAAC,CAAC;QAEH,MAAM,QAAQ,CAAC,aAAa,EAAE,CAAC;QAC/B,OAAO,IAAI,CAAC,EAAE,CAAC;IACjB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,wEAAwE;QACxE,0EAA0E;QAC1E,0EAA0E;QAC1E,4EAA4E;QAC5E,4CAA4C;QAC5C,eAAe,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;QACnC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAChD,OAAO,WAAW,CAAC,KAAK,CAAC,CAAC;IAC5B,CAAC;YAAS,CAAC;QACT,sEAAsE;QACtE,yEAAyE;QACzE,uEAAuE;QACvE,0EAA0E;QAC1E,kCAAkC;QAClC,eAAe,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;QACnC,gBAAgB,EAAE,CAAC;QACnB,0EAA0E;QAC1E,WAAW,CAAC,OAAO,EAAE,CAAC;IACxB,CAAC;AACH,CAAC;AAED,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC"}
|
|
@@ -15,6 +15,7 @@ import { type ReactNode } from 'react';
|
|
|
15
15
|
* refusal — a user in a tmux split or an 80-column window halved is a normal
|
|
16
16
|
* case, and a TUI that says "your terminal is too small" to someone who can
|
|
17
17
|
* plainly see text on it is a TUI they stop using.
|
|
18
|
+
* @stability experimental
|
|
18
19
|
*/
|
|
19
20
|
export declare const NARROW_COLUMNS = 56;
|
|
20
21
|
/**
|
|
@@ -22,10 +23,18 @@ export declare const NARROW_COLUMNS = 56;
|
|
|
22
23
|
*
|
|
23
24
|
* Thirty is about the width of a phone-sized SSH session. There is no useful
|
|
24
25
|
* layout left at this size, only content, so that is all that is drawn.
|
|
26
|
+
* @stability experimental
|
|
25
27
|
*/
|
|
26
28
|
export declare const TINY_COLUMNS = 30;
|
|
29
|
+
/**
|
|
30
|
+
* The terminal size and the width tier it falls in.
|
|
31
|
+
*
|
|
32
|
+
* @stability experimental
|
|
33
|
+
*/
|
|
27
34
|
export interface TerminalSize {
|
|
35
|
+
/** Width in cells (80 when the terminal will not say). */
|
|
28
36
|
columns: number;
|
|
37
|
+
/** Height in rows (24 when the terminal will not say). */
|
|
29
38
|
rows: number;
|
|
30
39
|
/** `columns < NARROW_COLUMNS`. Drop borders and side padding. */
|
|
31
40
|
narrow: boolean;
|
|
@@ -45,6 +54,7 @@ export interface TerminalSize {
|
|
|
45
54
|
* The listener is removed on unmount. `process.stdout` is a long-lived emitter
|
|
46
55
|
* shared with the whole runtime, so a leaked listener here outlives the UI and
|
|
47
56
|
* fires against unmounted components for the rest of the process's life.
|
|
57
|
+
* @stability experimental
|
|
48
58
|
*/
|
|
49
59
|
export declare function useTerminalSize(): TerminalSize;
|
|
50
60
|
/**
|
|
@@ -65,11 +75,17 @@ export declare function useTerminalSize(): TerminalSize;
|
|
|
65
75
|
* `true` and defeat the whole thing.
|
|
66
76
|
*/
|
|
67
77
|
export declare function useIsMounted(): () => boolean;
|
|
78
|
+
/**
|
|
79
|
+
* Props of {@link Frame}.
|
|
80
|
+
*
|
|
81
|
+
* @stability experimental
|
|
82
|
+
*/
|
|
68
83
|
export interface FrameProps {
|
|
69
84
|
/** Screen name, shown in the header. */
|
|
70
85
|
title: string;
|
|
71
86
|
/** Key hints for the bottom line, e.g. `['↑↓ move', 'enter select']`. */
|
|
72
87
|
hints?: string[];
|
|
88
|
+
/** The screen content. */
|
|
73
89
|
children: ReactNode;
|
|
74
90
|
}
|
|
75
91
|
/**
|
|
@@ -87,6 +103,7 @@ export interface FrameProps {
|
|
|
87
103
|
* so the right-hand edge wraps onto the next line and every frame ends with a
|
|
88
104
|
* row of orphaned box characters. Letting the box size itself and constraining
|
|
89
105
|
* only the CONTENT is what keeps the frame intact at every width.
|
|
106
|
+
* @stability experimental
|
|
90
107
|
*/
|
|
91
108
|
export declare function Frame({ title, hints, children }: FrameProps): ReactNode;
|
|
92
109
|
/**
|
|
@@ -99,6 +116,7 @@ export declare function Frame({ title, hints, children }: FrameProps): ReactNode
|
|
|
99
116
|
*
|
|
100
117
|
* Separators are dropped when narrow: at that width the hints wrap, and a
|
|
101
118
|
* wrapped line beginning with a lone dot reads as corruption.
|
|
119
|
+
* @stability experimental
|
|
102
120
|
*/
|
|
103
121
|
export declare function KeyHints({ hints }: {
|
|
104
122
|
hints: string[];
|
|
@@ -110,6 +128,7 @@ export declare function KeyHints({ hints }: {
|
|
|
110
128
|
* ink measures a Box in cells and these labels are ASCII — padding is exact,
|
|
111
129
|
* one flex node cheaper per row, and immune to the width-collapse described in
|
|
112
130
|
* `Frame`.
|
|
131
|
+
* @stability experimental
|
|
113
132
|
*/
|
|
114
133
|
export declare function Field({ label, value, color, dim, }: {
|
|
115
134
|
label: string;
|
|
@@ -124,6 +143,7 @@ export declare function Field({ label, value, color, dim, }: {
|
|
|
124
143
|
* diagnosis. The messages this CLI produces already carry their own remedy
|
|
125
144
|
* (see errors.ts), so `hint` is for the extra sentence a SCREEN can add and the
|
|
126
145
|
* error itself cannot — "press r to try again".
|
|
146
|
+
* @stability experimental
|
|
127
147
|
*/
|
|
128
148
|
export declare function ErrorNotice({ message, hint, }: {
|
|
129
149
|
message: string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"layout.d.ts","sourceRoot":"","sources":["../../../src/engine/tui/layout.tsx"],"names":[],"mappings":"AACA,OAAO,EAA+B,KAAK,SAAS,EAAE,MAAM,OAAO,CAAC;
|
|
1
|
+
{"version":3,"file":"layout.d.ts","sourceRoot":"","sources":["../../../src/engine/tui/layout.tsx"],"names":[],"mappings":"AACA,OAAO,EAA+B,KAAK,SAAS,EAAE,MAAM,OAAO,CAAC;AAiBpE;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,cAAc,KAAK,CAAC;AAEjC;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,KAAK,CAAC;AAe/B;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,0DAA0D;IAC1D,OAAO,EAAE,MAAM,CAAC;IAChB,0DAA0D;IAC1D,IAAI,EAAE,MAAM,CAAC;IACb,iEAAiE;IACjE,MAAM,EAAE,OAAO,CAAC;IAChB,mEAAmE;IACnE,IAAI,EAAE,OAAO,CAAC;CACf;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,eAAe,IAAI,YAAY,CAqC9C;AAMD;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,YAAY,IAAI,MAAM,OAAO,CAe5C;AAMD;;;;GAIG;AACH,MAAM,WAAW,UAAU;IACzB,wCAAwC;IACxC,KAAK,EAAE,MAAM,CAAC;IACd,yEAAyE;IACzE,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,0BAA0B;IAC1B,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,KAAK,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,UAAU,GAAG,SAAS,CAwCvE;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,QAAQ,CAAC,EAAE,KAAK,EAAE,EAAE;IAAE,KAAK,EAAE,MAAM,EAAE,CAAA;CAAE,GAAG,SAAS,CAgBlE;AAED;;;;;;;;GAQG;AACH,wBAAgB,KAAK,CAAC,EACpB,KAAK,EACL,KAAK,EACL,KAAK,EACL,GAAG,GACJ,EAAE;IACD,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,GAAG,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAC3B,GAAG,SAAS,CAYZ;AAID;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,EAC1B,OAAO,EACP,IAAI,GACL,EAAE;IACD,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC3B,GAAG,SAAS,CAUZ"}
|
|
@@ -2,6 +2,8 @@ import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
|
|
|
2
2
|
import { Box, Text, useStdout } from 'ink';
|
|
3
3
|
import { useEffect, useRef, useState } from 'react';
|
|
4
4
|
import { cliDisplayName, cliVersion } from '../identity.js';
|
|
5
|
+
import { useOptionalTuiApp, useTuiTheme } from './context.js';
|
|
6
|
+
import { textColor } from './theme.js';
|
|
5
7
|
// =============================================================================
|
|
6
8
|
// Layout primitives and the narrow-terminal degrade (issue #145, epic #110)
|
|
7
9
|
// =============================================================================
|
|
@@ -28,6 +30,7 @@ import { cliDisplayName, cliVersion } from '../identity.js';
|
|
|
28
30
|
* refusal — a user in a tmux split or an 80-column window halved is a normal
|
|
29
31
|
* case, and a TUI that says "your terminal is too small" to someone who can
|
|
30
32
|
* plainly see text on it is a TUI they stop using.
|
|
33
|
+
* @stability experimental
|
|
31
34
|
*/
|
|
32
35
|
export const NARROW_COLUMNS = 56;
|
|
33
36
|
/**
|
|
@@ -35,6 +38,7 @@ export const NARROW_COLUMNS = 56;
|
|
|
35
38
|
*
|
|
36
39
|
* Thirty is about the width of a phone-sized SSH session. There is no useful
|
|
37
40
|
* layout left at this size, only content, so that is all that is drawn.
|
|
41
|
+
* @stability experimental
|
|
38
42
|
*/
|
|
39
43
|
export const TINY_COLUMNS = 30;
|
|
40
44
|
/**
|
|
@@ -62,6 +66,7 @@ const FALLBACK_ROWS = 24;
|
|
|
62
66
|
* The listener is removed on unmount. `process.stdout` is a long-lived emitter
|
|
63
67
|
* shared with the whole runtime, so a leaked listener here outlives the UI and
|
|
64
68
|
* fires against unmounted components for the rest of the process's life.
|
|
69
|
+
* @stability experimental
|
|
65
70
|
*/
|
|
66
71
|
export function useTerminalSize() {
|
|
67
72
|
const { stdout } = useStdout();
|
|
@@ -145,16 +150,21 @@ export function useIsMounted() {
|
|
|
145
150
|
* so the right-hand edge wraps onto the next line and every frame ends with a
|
|
146
151
|
* row of orphaned box characters. Letting the box size itself and constraining
|
|
147
152
|
* only the CONTENT is what keeps the frame intact at every width.
|
|
153
|
+
* @stability experimental
|
|
148
154
|
*/
|
|
149
155
|
export function Frame({ title, hints, children }) {
|
|
150
156
|
const { narrow, tiny } = useTerminalSize();
|
|
157
|
+
const theme = useTuiTheme();
|
|
158
|
+
const app = useOptionalTuiApp();
|
|
159
|
+
// The app's selections as chips (`[Project: Alpha]`); none registered, none shown.
|
|
160
|
+
const chips = Object.values(app?.selection ?? {}).filter((entry) => entry.text !== undefined);
|
|
151
161
|
if (tiny) {
|
|
152
162
|
return _jsx(Box, { flexDirection: "column", children: children });
|
|
153
163
|
}
|
|
154
|
-
const body = (_jsxs(Box, { flexDirection: "column", gap: 1, children: [_jsxs(Box, { children: [_jsx(Text, { bold: true,
|
|
164
|
+
const body = (_jsxs(Box, { flexDirection: "column", gap: 1, children: [_jsxs(Box, { children: [_jsx(Text, { bold: true, ...textColor(theme.primary), children: cliDisplayName() }), _jsxs(Text, { dimColor: true, children: [" v", cliVersion()] }), _jsx(Text, { dimColor: true, children: " \u00B7 " }), _jsx(Text, { bold: true, children: title }), chips.map((chip) => (_jsx(Text, { ...textColor(theme.accent), children: ` [${chip.label}: ${chip.text ?? ''}]` }, chip.id)))] }), _jsx(Box, { flexDirection: "column", children: children }), hints !== undefined && hints.length > 0 ? _jsx(KeyHints, { hints: hints }) : null] }));
|
|
155
165
|
if (narrow)
|
|
156
166
|
return body;
|
|
157
|
-
return (_jsx(Box, { borderStyle: "round", borderColor:
|
|
167
|
+
return (_jsx(Box, { borderStyle: "round", ...(theme.dim === undefined ? {} : { borderColor: theme.dim }), paddingX: 2, paddingY: 1, flexDirection: "column", children: body }));
|
|
158
168
|
}
|
|
159
169
|
/**
|
|
160
170
|
* The bottom line of every screen.
|
|
@@ -166,6 +176,7 @@ export function Frame({ title, hints, children }) {
|
|
|
166
176
|
*
|
|
167
177
|
* Separators are dropped when narrow: at that width the hints wrap, and a
|
|
168
178
|
* wrapped line beginning with a lone dot reads as corruption.
|
|
179
|
+
* @stability experimental
|
|
169
180
|
*/
|
|
170
181
|
export function KeyHints({ hints }) {
|
|
171
182
|
const { narrow } = useTerminalSize();
|
|
@@ -181,6 +192,7 @@ export function KeyHints({ hints }) {
|
|
|
181
192
|
* ink measures a Box in cells and these labels are ASCII — padding is exact,
|
|
182
193
|
* one flex node cheaper per row, and immune to the width-collapse described in
|
|
183
194
|
* `Frame`.
|
|
195
|
+
* @stability experimental
|
|
184
196
|
*/
|
|
185
197
|
export function Field({ label, value, color, dim, }) {
|
|
186
198
|
return (_jsxs(Box, { children: [_jsx(Text, { dimColor: true, children: label.padEnd(FIELD_LABEL_WIDTH) }), _jsx(Text, { ...(color === undefined ? {} : { color }), ...(dim === true ? { dimColor: true } : {}), children: value })] }));
|
|
@@ -193,8 +205,10 @@ const FIELD_LABEL_WIDTH = 10;
|
|
|
193
205
|
* diagnosis. The messages this CLI produces already carry their own remedy
|
|
194
206
|
* (see errors.ts), so `hint` is for the extra sentence a SCREEN can add and the
|
|
195
207
|
* error itself cannot — "press r to try again".
|
|
208
|
+
* @stability experimental
|
|
196
209
|
*/
|
|
197
210
|
export function ErrorNotice({ message, hint, }) {
|
|
198
|
-
|
|
211
|
+
const theme = useTuiTheme();
|
|
212
|
+
return (_jsxs(Box, { flexDirection: "column", children: [_jsxs(Text, { bold: true, ...textColor(theme.error), children: [theme.glyphs.cross, " ", message] }), hint === undefined ? null : _jsx(Text, { dimColor: true, children: hint })] }));
|
|
199
213
|
}
|
|
200
214
|
//# sourceMappingURL=layout.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"layout.js","sourceRoot":"","sources":["../../../src/engine/tui/layout.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,KAAK,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAkB,MAAM,OAAO,CAAC;AAEpE,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;
|
|
1
|
+
{"version":3,"file":"layout.js","sourceRoot":"","sources":["../../../src/engine/tui/layout.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,KAAK,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAkB,MAAM,OAAO,CAAC;AAEpE,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5D,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEvC,gFAAgF;AAChF,6EAA6E;AAC7E,gFAAgF;AAChF,EAAE;AACF,8EAA8E;AAC9E,4EAA4E;AAC5E,6EAA6E;AAC7E,6EAA6E;AAC7E,SAAS;AACT,gFAAgF;AAEhF;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,EAAE,CAAC;AAEjC;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,EAAE,CAAC;AAE/B;;;;;;;;;GASG;AACH,MAAM,gBAAgB,GAAG,EAAE,CAAC;AAC5B,MAAM,aAAa,GAAG,EAAE,CAAC;AAkBzB;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,eAAe;IAC7B,MAAM,EAAE,MAAM,EAAE,GAAG,SAAS,EAAE,CAAC;IAE/B,MAAM,IAAI,GAAG,GAAsC,EAAE,CAAC,CAAC;QACrD,OAAO,EAAE,kBAAkB,CAAC,MAAM,EAAE,OAAO,EAAE,gBAAgB,CAAC;QAC9D,IAAI,EAAE,kBAAkB,CAAC,MAAM,EAAE,IAAI,EAAE,aAAa,CAAC;KACtD,CAAC,CAAC;IAEH,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;IAEvC,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,CAAC,MAAM;YAAE,OAAO;QAEpB,MAAM,QAAQ,GAAG,GAAS,EAAE;YAC1B,OAAO,CAAC;gBACN,OAAO,EAAE,kBAAkB,CAAC,MAAM,CAAC,OAAO,EAAE,gBAAgB,CAAC;gBAC7D,IAAI,EAAE,kBAAkB,CAAC,MAAM,CAAC,IAAI,EAAE,aAAa,CAAC;aACrD,CAAC,CAAC;QACL,CAAC,CAAC;QAEF,0EAA0E;QAC1E,2EAA2E;QAC3E,2EAA2E;QAC3E,iDAAiD;QACjD,QAAQ,EAAE,CAAC;QACX,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAC9B,OAAO,GAAG,EAAE;YACV,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QACjC,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IAEb,OAAO;QACL,OAAO,EAAE,IAAI,CAAC,OAAO;QACrB,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,MAAM,EAAE,IAAI,CAAC,OAAO,GAAG,cAAc;QACrC,IAAI,EAAE,IAAI,CAAC,OAAO,GAAG,YAAY;KAClC,CAAC;AACJ,CAAC;AAED,SAAS,kBAAkB,CAAC,KAAyB,EAAE,QAAgB;IACrE,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC;AAC7F,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,YAAY;IAC1B,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;IAE7B,SAAS,CAAC,GAAG,EAAE;QACb,2EAA2E;QAC3E,4EAA4E;QAC5E,wEAAwE;QACxE,uBAAuB;QACvB,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC;QACvB,OAAO,GAAG,EAAE;YACV,OAAO,CAAC,OAAO,GAAG,KAAK,CAAC;QAC1B,CAAC,CAAC;IACJ,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC;AAC/B,CAAC;AAoBD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,KAAK,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAc;IAC1D,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,eAAe,EAAE,CAAC;IAC3C,MAAM,KAAK,GAAG,WAAW,EAAE,CAAC;IAC5B,MAAM,GAAG,GAAG,iBAAiB,EAAE,CAAC;IAChC,mFAAmF;IACnF,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,SAAS,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;IAE9F,IAAI,IAAI,EAAE,CAAC;QACT,OAAO,KAAC,GAAG,IAAC,aAAa,EAAC,QAAQ,YAAE,QAAQ,GAAO,CAAC;IACtD,CAAC;IAED,MAAM,IAAI,GAAG,CACX,MAAC,GAAG,IAAC,aAAa,EAAC,QAAQ,EAAC,GAAG,EAAE,CAAC,aAChC,MAAC,GAAG,eACF,KAAC,IAAI,IAAC,IAAI,WAAK,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,YACpC,cAAc,EAAE,GACZ,EACP,MAAC,IAAI,IAAC,QAAQ,yBAAI,UAAU,EAAE,IAAQ,EACtC,KAAC,IAAI,IAAC,QAAQ,+BAAW,EACzB,KAAC,IAAI,IAAC,IAAI,kBAAE,KAAK,GAAQ,EACxB,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CACnB,KAAC,IAAI,OAAmB,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,YAC5C,MAAM,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,IAAI,IAAI,EAAE,GAAG,IAD/B,IAAI,CAAC,EAAE,CAEX,CACR,CAAC,IACE,EAEN,KAAC,GAAG,IAAC,aAAa,EAAC,QAAQ,YAAE,QAAQ,GAAO,EAE3C,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAC,QAAQ,IAAC,KAAK,EAAE,KAAK,GAAI,CAAC,CAAC,CAAC,IAAI,IACxE,CACP,CAAC;IAEF,IAAI,MAAM;QAAE,OAAO,IAAI,CAAC;IAExB,OAAO,CACL,KAAC,GAAG,IAAC,WAAW,EAAC,OAAO,KAAK,CAAC,KAAK,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,KAAK,CAAC,GAAG,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,aAAa,EAAC,QAAQ,YACvI,IAAI,GACD,CACP,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,QAAQ,CAAC,EAAE,KAAK,EAAuB;IACrD,MAAM,EAAE,MAAM,EAAE,GAAG,eAAe,EAAE,CAAC;IAErC,IAAI,MAAM,EAAE,CAAC;QACX,OAAO,CACL,KAAC,GAAG,IAAC,aAAa,EAAC,QAAQ,YACxB,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CACnB,KAAC,IAAI,IAAY,QAAQ,kBACtB,IAAI,IADI,IAAI,CAER,CACR,CAAC,GACE,CACP,CAAC;IACJ,CAAC;IAED,OAAO,KAAC,IAAI,IAAC,QAAQ,kBAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,GAAQ,CAAC;AACrD,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,KAAK,CAAC,EACpB,KAAK,EACL,KAAK,EACL,KAAK,EACL,GAAG,GAMJ;IACC,OAAO,CACL,MAAC,GAAG,eACF,KAAC,IAAI,IAAC,QAAQ,kBAAE,KAAK,CAAC,MAAM,CAAC,iBAAiB,CAAC,GAAQ,EACvD,KAAC,IAAI,OACC,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,KACtC,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,YAE3C,KAAK,GACD,IACH,CACP,CAAC;AACJ,CAAC;AAED,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAE7B;;;;;;;;GAQG;AACH,MAAM,UAAU,WAAW,CAAC,EAC1B,OAAO,EACP,IAAI,GAIL;IACC,MAAM,KAAK,GAAG,WAAW,EAAE,CAAC;IAC5B,OAAO,CACL,MAAC,GAAG,IAAC,aAAa,EAAC,QAAQ,aACzB,MAAC,IAAI,IAAC,IAAI,WAAK,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,aAClC,KAAK,CAAC,MAAM,CAAC,KAAK,OAAG,OAAO,IACxB,EACN,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAC,IAAI,IAAC,QAAQ,kBAAE,IAAI,GAAQ,IACrD,CACP,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
import { type TuiMenuContext } from './screen-registry.js';
|
|
2
|
+
import type { TuiColor } from './theme.js';
|
|
3
|
+
/**
|
|
4
|
+
* The id of the implicit root section. Reserved.
|
|
5
|
+
*
|
|
6
|
+
* @stability experimental
|
|
7
|
+
*/
|
|
8
|
+
export declare const TUI_MENU_ROOT = "root";
|
|
9
|
+
/**
|
|
10
|
+
* The deepest a section may nest (a section directly under the root is level 1).
|
|
11
|
+
*
|
|
12
|
+
* @stability experimental
|
|
13
|
+
*/
|
|
14
|
+
export declare const TUI_MENU_MAX_DEPTH = 4;
|
|
15
|
+
/**
|
|
16
|
+
* A menu label: fixed, or a function of the login state.
|
|
17
|
+
*
|
|
18
|
+
* @stability experimental
|
|
19
|
+
*/
|
|
20
|
+
export type TuiMenuLabel = string | ((context: TuiMenuContext) => string);
|
|
21
|
+
/**
|
|
22
|
+
* Fields both node kinds share.
|
|
23
|
+
*
|
|
24
|
+
* @stability experimental
|
|
25
|
+
*/
|
|
26
|
+
export interface TuiMenuNodeBase {
|
|
27
|
+
/** Unique across sections and entries: lowercase `[a-z][a-z0-9-]*`; `root` is reserved. */
|
|
28
|
+
id: string;
|
|
29
|
+
/** The section it sits in. Default `root`. */
|
|
30
|
+
parent?: string | undefined;
|
|
31
|
+
/** What the menu shows; a function gets `{ loggedIn }`. */
|
|
32
|
+
label: TuiMenuLabel;
|
|
33
|
+
/** Position among its siblings: lower first; ties sort by id. */
|
|
34
|
+
order: number;
|
|
35
|
+
/**
|
|
36
|
+
* Visible when logged out. Omitted means INHERITED from the nearest ancestor
|
|
37
|
+
* that sets it (default false: hidden until login). An explicit `false`
|
|
38
|
+
* opts one child out of an offline section.
|
|
39
|
+
*/
|
|
40
|
+
loggedOut?: boolean | undefined;
|
|
41
|
+
/** Hide the node once logged in (a "Login" entry that moves elsewhere). */
|
|
42
|
+
hideWhenLoggedIn?: boolean | undefined;
|
|
43
|
+
/** A theme token name (`error`, `success`, ...) or a plain colour such as `red`. Presentation only. */
|
|
44
|
+
color?: TuiColor;
|
|
45
|
+
}
|
|
46
|
+
/**
|
|
47
|
+
* A submenu.
|
|
48
|
+
*
|
|
49
|
+
* @stability experimental
|
|
50
|
+
*/
|
|
51
|
+
export interface TuiMenuSection extends TuiMenuNodeBase {
|
|
52
|
+
/** Discriminant. */
|
|
53
|
+
kind: 'section';
|
|
54
|
+
/** Shown under the breadcrumb instead of the default hint. */
|
|
55
|
+
subtitle?: string | undefined;
|
|
56
|
+
}
|
|
57
|
+
/**
|
|
58
|
+
* A menu line that opens a registered screen.
|
|
59
|
+
*
|
|
60
|
+
* @stability experimental
|
|
61
|
+
*/
|
|
62
|
+
export interface TuiMenuEntry extends TuiMenuNodeBase {
|
|
63
|
+
/** Discriminant. */
|
|
64
|
+
kind: 'entry';
|
|
65
|
+
/** A registered screen route (built-in or `registerTuiScreen`). */
|
|
66
|
+
route: string;
|
|
67
|
+
/** The screen asks for a further input step first; rendered with a trailing `…`. */
|
|
68
|
+
ellipsis?: boolean | undefined;
|
|
69
|
+
/**
|
|
70
|
+
* Opening the screen while logged out shows the shared "not logged in"
|
|
71
|
+
* notice instead. Default: true unless the entry is visible when logged out.
|
|
72
|
+
*/
|
|
73
|
+
requiresLogin?: boolean | undefined;
|
|
74
|
+
}
|
|
75
|
+
/**
|
|
76
|
+
* A node of the menu tree.
|
|
77
|
+
*
|
|
78
|
+
* @stability experimental
|
|
79
|
+
*/
|
|
80
|
+
export type TuiMenuNode = TuiMenuSection | TuiMenuEntry;
|
|
81
|
+
/**
|
|
82
|
+
* Adds a section or an entry to the TUI menu tree.
|
|
83
|
+
*
|
|
84
|
+
* Unknown `parent` and unknown `route` are rejected when `createCli` builds
|
|
85
|
+
* the CLI (so registration order is free), together with cycles and nesting
|
|
86
|
+
* deeper than {@link TUI_MENU_MAX_DEPTH}.
|
|
87
|
+
*
|
|
88
|
+
* @param node - A section (`kind: 'section'`) or an entry (`kind: 'entry'`, with a `route`).
|
|
89
|
+
* @throws Error when the id is malformed, reserved or taken, a field is missing, or `createCli` has already built the CLI.
|
|
90
|
+
* @stability experimental
|
|
91
|
+
* @extensionPoint registry
|
|
92
|
+
* @example
|
|
93
|
+
* ```ts
|
|
94
|
+
* registerTuiMenuNode({ kind: 'section', id: 'node', label: 'Worker node', order: 40 });
|
|
95
|
+
* registerTuiMenuNode({ kind: 'entry', id: 'node-dashboard', parent: 'node', route: 'node-dashboard', label: 'Dashboard', order: 10 });
|
|
96
|
+
* ```
|
|
97
|
+
*/
|
|
98
|
+
export declare function registerTuiMenuNode(node: TuiMenuNode): void;
|
|
99
|
+
/**
|
|
100
|
+
* The menu nodes registered so far, in registration order.
|
|
101
|
+
*
|
|
102
|
+
* @returns A frozen copy.
|
|
103
|
+
* @stability experimental
|
|
104
|
+
*/
|
|
105
|
+
export declare function listTuiMenuNodes(): readonly TuiMenuNode[];
|
|
106
|
+
/**
|
|
107
|
+
* Checks the references between nodes and screens.
|
|
108
|
+
*
|
|
109
|
+
* @param nodes - The registered nodes.
|
|
110
|
+
* @param routes - Every screen route that exists.
|
|
111
|
+
* @throws Error naming the offending node id for an unknown or non-section parent, an unknown route, a cycle, or nesting deeper than {@link TUI_MENU_MAX_DEPTH}.
|
|
112
|
+
* @stability experimental
|
|
113
|
+
*/
|
|
114
|
+
export declare function validateTuiMenuNodes(nodes: readonly TuiMenuNode[], routes: readonly string[]): void;
|
|
115
|
+
/**
|
|
116
|
+
* Validates the registered nodes against the screens, then refuses later
|
|
117
|
+
* registrations; `createCli` calls it.
|
|
118
|
+
*
|
|
119
|
+
* @throws Error from {@link validateTuiMenuNodes}; nothing is frozen then.
|
|
120
|
+
*/
|
|
121
|
+
export declare function freezeTuiMenuRegistry(by: string): void;
|
|
122
|
+
/** Empties the registry. Tests only. */
|
|
123
|
+
export declare function resetTuiMenuRegistryForTests(): void;
|
|
124
|
+
//# sourceMappingURL=menu-registry.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"menu-registry.d.ts","sourceRoot":"","sources":["../../../src/engine/tui/menu-registry.ts"],"names":[],"mappings":"AACA,OAAO,EAAiD,KAAK,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAC1G,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAmB3C;;;;GAIG;AACH,eAAO,MAAM,aAAa,SAAS,CAAC;AAEpC;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,IAAI,CAAC;AAEpC;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,CAAC,CAAC,OAAO,EAAE,cAAc,KAAK,MAAM,CAAC,CAAC;AAE1E;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,2FAA2F;IAC3F,EAAE,EAAE,MAAM,CAAC;IACX,8CAA8C;IAC9C,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,2DAA2D;IAC3D,KAAK,EAAE,YAAY,CAAC;IACpB,iEAAiE;IACjE,KAAK,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAChC,2EAA2E;IAC3E,gBAAgB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACvC,uGAAuG;IACvG,KAAK,CAAC,EAAE,QAAQ,CAAC;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAe,SAAQ,eAAe;IACrD,oBAAoB;IACpB,IAAI,EAAE,SAAS,CAAC;IAChB,8DAA8D;IAC9D,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAa,SAAQ,eAAe;IACnD,oBAAoB;IACpB,IAAI,EAAE,OAAO,CAAC;IACd,mEAAmE;IACnE,KAAK,EAAE,MAAM,CAAC;IACd,oFAAoF;IACpF,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC/B;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CACrC;AAED;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,cAAc,GAAG,YAAY,CAAC;AAqCxD;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,WAAW,GAAG,IAAI,CAE3D;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,IAAI,SAAS,WAAW,EAAE,CAEzD;AAED;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,SAAS,WAAW,EAAE,EAAE,MAAM,EAAE,SAAS,MAAM,EAAE,GAAG,IAAI,CAkCnG;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAItD;AAED,wCAAwC;AACxC,wBAAgB,4BAA4B,IAAI,IAAI,CAEnD"}
|
|
@@ -0,0 +1,151 @@
|
|
|
1
|
+
import { createCliRegistry } from '../../core/index.js';
|
|
2
|
+
import { BUILTIN_TUI_SCREENS, listRegisteredTuiScreens } from './screen-registry.js';
|
|
3
|
+
// =============================================================================
|
|
4
|
+
// The TUI menu tree registry (RETRO-G1.1, #1065)
|
|
5
|
+
// =============================================================================
|
|
6
|
+
//
|
|
7
|
+
// `registerTuiScreen` puts a screen in one flat list. A MENU NODE places things
|
|
8
|
+
// in a tree: a SECTION is a submenu (with a breadcrumb, a subtitle and a
|
|
9
|
+
// logged-out rule), an ENTRY opens a registered screen from inside a section.
|
|
10
|
+
// Nothing here is required: a screen that no entry references is shown at the
|
|
11
|
+
// root with its own label and order, exactly as before, so an app that never
|
|
12
|
+
// calls `registerTuiMenuNode` keeps today's menu.
|
|
13
|
+
//
|
|
14
|
+
// PURE ON PURPOSE, like screen-registry.ts: React is not imported at all, so
|
|
15
|
+
// registering a node from `createCli` never loads ink. References (`parent`,
|
|
16
|
+
// `route`) are resolved when `createCli` freezes the registries, not when a
|
|
17
|
+
// node is registered, so the order of registration does not matter.
|
|
18
|
+
// =============================================================================
|
|
19
|
+
/**
|
|
20
|
+
* The id of the implicit root section. Reserved.
|
|
21
|
+
*
|
|
22
|
+
* @stability experimental
|
|
23
|
+
*/
|
|
24
|
+
export const TUI_MENU_ROOT = 'root';
|
|
25
|
+
/**
|
|
26
|
+
* The deepest a section may nest (a section directly under the root is level 1).
|
|
27
|
+
*
|
|
28
|
+
* @stability experimental
|
|
29
|
+
*/
|
|
30
|
+
export const TUI_MENU_MAX_DEPTH = 4;
|
|
31
|
+
const ID_PATTERN = /^[a-z][a-z0-9-]*$/;
|
|
32
|
+
const registry = createCliRegistry({
|
|
33
|
+
name: 'TUI menu node',
|
|
34
|
+
registerFn: 'registerTuiMenuNode',
|
|
35
|
+
idOf: (node) => node.id,
|
|
36
|
+
validate: (node) => {
|
|
37
|
+
const id = node.id;
|
|
38
|
+
if (typeof id !== 'string' || !ID_PATTERN.test(id)) {
|
|
39
|
+
throw new Error(`TUI menu node id "${String(id)}" is invalid: use lowercase letters, digits and hyphens.`);
|
|
40
|
+
}
|
|
41
|
+
if (id === TUI_MENU_ROOT) {
|
|
42
|
+
throw new Error(`TUI menu node id "${TUI_MENU_ROOT}" is reserved for the menu root.`);
|
|
43
|
+
}
|
|
44
|
+
if (node.kind !== 'section' && node.kind !== 'entry') {
|
|
45
|
+
throw new Error(`TUI menu node "${id}" needs kind "section" or "entry".`);
|
|
46
|
+
}
|
|
47
|
+
if (typeof node.order !== 'number' || !Number.isFinite(node.order)) {
|
|
48
|
+
throw new Error(`TUI menu node "${id}" needs a finite numeric order.`);
|
|
49
|
+
}
|
|
50
|
+
if (typeof node.label !== 'string' && typeof node.label !== 'function') {
|
|
51
|
+
throw new Error(`TUI menu node "${id}" needs a label (a string or a function of the login state).`);
|
|
52
|
+
}
|
|
53
|
+
if (typeof node.label === 'string' && node.label.trim() === '') {
|
|
54
|
+
throw new Error(`TUI menu node "${id}" needs a non-empty label.`);
|
|
55
|
+
}
|
|
56
|
+
if (node.parent !== undefined && (typeof node.parent !== 'string' || node.parent === '')) {
|
|
57
|
+
throw new Error(`TUI menu node "${id}" has an invalid parent.`);
|
|
58
|
+
}
|
|
59
|
+
if (node.kind === 'entry' && (typeof node.route !== 'string' || node.route === '')) {
|
|
60
|
+
throw new Error(`TUI menu entry "${id}" needs the route of a registered screen.`);
|
|
61
|
+
}
|
|
62
|
+
},
|
|
63
|
+
});
|
|
64
|
+
/**
|
|
65
|
+
* Adds a section or an entry to the TUI menu tree.
|
|
66
|
+
*
|
|
67
|
+
* Unknown `parent` and unknown `route` are rejected when `createCli` builds
|
|
68
|
+
* the CLI (so registration order is free), together with cycles and nesting
|
|
69
|
+
* deeper than {@link TUI_MENU_MAX_DEPTH}.
|
|
70
|
+
*
|
|
71
|
+
* @param node - A section (`kind: 'section'`) or an entry (`kind: 'entry'`, with a `route`).
|
|
72
|
+
* @throws Error when the id is malformed, reserved or taken, a field is missing, or `createCli` has already built the CLI.
|
|
73
|
+
* @stability experimental
|
|
74
|
+
* @extensionPoint registry
|
|
75
|
+
* @example
|
|
76
|
+
* ```ts
|
|
77
|
+
* registerTuiMenuNode({ kind: 'section', id: 'node', label: 'Worker node', order: 40 });
|
|
78
|
+
* registerTuiMenuNode({ kind: 'entry', id: 'node-dashboard', parent: 'node', route: 'node-dashboard', label: 'Dashboard', order: 10 });
|
|
79
|
+
* ```
|
|
80
|
+
*/
|
|
81
|
+
export function registerTuiMenuNode(node) {
|
|
82
|
+
registry.register(Object.freeze({ ...node }));
|
|
83
|
+
}
|
|
84
|
+
/**
|
|
85
|
+
* The menu nodes registered so far, in registration order.
|
|
86
|
+
*
|
|
87
|
+
* @returns A frozen copy.
|
|
88
|
+
* @stability experimental
|
|
89
|
+
*/
|
|
90
|
+
export function listTuiMenuNodes() {
|
|
91
|
+
return registry.list();
|
|
92
|
+
}
|
|
93
|
+
/**
|
|
94
|
+
* Checks the references between nodes and screens.
|
|
95
|
+
*
|
|
96
|
+
* @param nodes - The registered nodes.
|
|
97
|
+
* @param routes - Every screen route that exists.
|
|
98
|
+
* @throws Error naming the offending node id for an unknown or non-section parent, an unknown route, a cycle, or nesting deeper than {@link TUI_MENU_MAX_DEPTH}.
|
|
99
|
+
* @stability experimental
|
|
100
|
+
*/
|
|
101
|
+
export function validateTuiMenuNodes(nodes, routes) {
|
|
102
|
+
const byId = new Map(nodes.map((node) => [node.id, node]));
|
|
103
|
+
for (const node of nodes) {
|
|
104
|
+
const parent = node.parent ?? TUI_MENU_ROOT;
|
|
105
|
+
if (parent !== TUI_MENU_ROOT) {
|
|
106
|
+
const found = byId.get(parent);
|
|
107
|
+
if (found === undefined) {
|
|
108
|
+
throw new Error(`TUI menu node "${node.id}" has unknown parent "${parent}".`);
|
|
109
|
+
}
|
|
110
|
+
if (found.kind !== 'section') {
|
|
111
|
+
throw new Error(`TUI menu node "${node.id}" has parent "${parent}", which is an entry; a parent must be a section.`);
|
|
112
|
+
}
|
|
113
|
+
}
|
|
114
|
+
if (node.kind === 'entry' && !routes.includes(node.route)) {
|
|
115
|
+
throw new Error(`TUI menu entry "${node.id}" opens unknown screen route "${node.route}"; register it with registerTuiScreen.`);
|
|
116
|
+
}
|
|
117
|
+
}
|
|
118
|
+
for (const node of nodes) {
|
|
119
|
+
// Walk up; the chain must reach the root within the cap without repeating.
|
|
120
|
+
const seen = new Set([node.id]);
|
|
121
|
+
let level = node.kind === 'section' ? 1 : 0;
|
|
122
|
+
let parent = node.parent ?? TUI_MENU_ROOT;
|
|
123
|
+
while (parent !== TUI_MENU_ROOT) {
|
|
124
|
+
if (seen.has(parent)) {
|
|
125
|
+
throw new Error(`TUI menu node "${node.id}" is part of a cycle through "${parent}".`);
|
|
126
|
+
}
|
|
127
|
+
seen.add(parent);
|
|
128
|
+
level += 1;
|
|
129
|
+
parent = byId.get(parent)?.parent ?? TUI_MENU_ROOT;
|
|
130
|
+
}
|
|
131
|
+
if (level > TUI_MENU_MAX_DEPTH) {
|
|
132
|
+
throw new Error(`TUI menu node "${node.id}" nests ${level} sections deep; the limit is ${TUI_MENU_MAX_DEPTH}.`);
|
|
133
|
+
}
|
|
134
|
+
}
|
|
135
|
+
}
|
|
136
|
+
/**
|
|
137
|
+
* Validates the registered nodes against the screens, then refuses later
|
|
138
|
+
* registrations; `createCli` calls it.
|
|
139
|
+
*
|
|
140
|
+
* @throws Error from {@link validateTuiMenuNodes}; nothing is frozen then.
|
|
141
|
+
*/
|
|
142
|
+
export function freezeTuiMenuRegistry(by) {
|
|
143
|
+
const routes = [...BUILTIN_TUI_SCREENS, ...listRegisteredTuiScreens()].map((screen) => screen.route);
|
|
144
|
+
validateTuiMenuNodes(registry.list(), routes);
|
|
145
|
+
registry.freeze(by);
|
|
146
|
+
}
|
|
147
|
+
/** Empties the registry. Tests only. */
|
|
148
|
+
export function resetTuiMenuRegistryForTests() {
|
|
149
|
+
registry.reset();
|
|
150
|
+
}
|
|
151
|
+
//# sourceMappingURL=menu-registry.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"menu-registry.js","sourceRoot":"","sources":["../../../src/engine/tui/menu-registry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,mBAAmB,EAAE,wBAAwB,EAAuB,MAAM,sBAAsB,CAAC;AAG1G,gFAAgF;AAChF,kDAAkD;AAClD,gFAAgF;AAChF,EAAE;AACF,gFAAgF;AAChF,yEAAyE;AACzE,8EAA8E;AAC9E,8EAA8E;AAC9E,6EAA6E;AAC7E,kDAAkD;AAClD,EAAE;AACF,6EAA6E;AAC7E,6EAA6E;AAC7E,4EAA4E;AAC5E,oEAAoE;AACpE,gFAAgF;AAEhF;;;;GAIG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,MAAM,CAAC;AAEpC;;;;GAIG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC;AAyEpC,MAAM,UAAU,GAAG,mBAAmB,CAAC;AAEvC,MAAM,QAAQ,GAAG,iBAAiB,CAAc;IAC9C,IAAI,EAAE,eAAe;IACrB,UAAU,EAAE,qBAAqB;IACjC,IAAI,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE;IACvB,QAAQ,EAAE,CAAC,IAAI,EAAE,EAAE;QACjB,MAAM,EAAE,GAAI,IAAyB,CAAC,EAAE,CAAC;QACzC,IAAI,OAAO,EAAE,KAAK,QAAQ,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;YACnD,MAAM,IAAI,KAAK,CAAC,qBAAqB,MAAM,CAAC,EAAE,CAAC,0DAA0D,CAAC,CAAC;QAC7G,CAAC;QACD,IAAI,EAAE,KAAK,aAAa,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,qBAAqB,aAAa,kCAAkC,CAAC,CAAC;QACxF,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YACrD,MAAM,IAAI,KAAK,CAAC,kBAAkB,EAAE,oCAAoC,CAAC,CAAC;QAC5E,CAAC;QACD,IAAI,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YACnE,MAAM,IAAI,KAAK,CAAC,kBAAkB,EAAE,iCAAiC,CAAC,CAAC;QACzE,CAAC;QACD,IAAI,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,IAAI,OAAO,IAAI,CAAC,KAAK,KAAK,UAAU,EAAE,CAAC;YACvE,MAAM,IAAI,KAAK,CAAC,kBAAkB,EAAE,8DAA8D,CAAC,CAAC;QACtG,CAAC;QACD,IAAI,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YAC/D,MAAM,IAAI,KAAK,CAAC,kBAAkB,EAAE,4BAA4B,CAAC,CAAC;QACpE,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,OAAO,IAAI,CAAC,MAAM,KAAK,QAAQ,IAAI,IAAI,CAAC,MAAM,KAAK,EAAE,CAAC,EAAE,CAAC;YACzF,MAAM,IAAI,KAAK,CAAC,kBAAkB,EAAE,0BAA0B,CAAC,CAAC;QAClE,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO,IAAI,CAAC,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,IAAI,IAAI,CAAC,KAAK,KAAK,EAAE,CAAC,EAAE,CAAC;YACnF,MAAM,IAAI,KAAK,CAAC,mBAAmB,EAAE,2CAA2C,CAAC,CAAC;QACpF,CAAC;IACH,CAAC;CACF,CAAC,CAAC;AAEH;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,mBAAmB,CAAC,IAAiB;IACnD,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,GAAG,IAAI,EAAE,CAAgB,CAAC,CAAC;AAC/D,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB;IAC9B,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;AACzB,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,oBAAoB,CAAC,KAA6B,EAAE,MAAyB;IAC3F,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IAC3D,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,aAAa,CAAC;QAC5C,IAAI,MAAM,KAAK,aAAa,EAAE,CAAC;YAC7B,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YAC/B,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACxB,MAAM,IAAI,KAAK,CAAC,kBAAkB,IAAI,CAAC,EAAE,yBAAyB,MAAM,IAAI,CAAC,CAAC;YAChF,CAAC;YACD,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;gBAC7B,MAAM,IAAI,KAAK,CAAC,kBAAkB,IAAI,CAAC,EAAE,iBAAiB,MAAM,mDAAmD,CAAC,CAAC;YACvH,CAAC;QACH,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1D,MAAM,IAAI,KAAK,CAAC,mBAAmB,IAAI,CAAC,EAAE,iCAAiC,IAAI,CAAC,KAAK,wCAAwC,CAAC,CAAC;QACjI,CAAC;IACH,CAAC;IACD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,2EAA2E;QAC3E,MAAM,IAAI,GAAG,IAAI,GAAG,CAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;QACxC,IAAI,KAAK,GAAG,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC5C,IAAI,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,aAAa,CAAC;QAC1C,OAAO,MAAM,KAAK,aAAa,EAAE,CAAC;YAChC,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;gBACrB,MAAM,IAAI,KAAK,CAAC,kBAAkB,IAAI,CAAC,EAAE,iCAAiC,MAAM,IAAI,CAAC,CAAC;YACxF,CAAC;YACD,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACjB,KAAK,IAAI,CAAC,CAAC;YACX,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,MAAM,IAAI,aAAa,CAAC;QACrD,CAAC;QACD,IAAI,KAAK,GAAG,kBAAkB,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CAAC,kBAAkB,IAAI,CAAC,EAAE,WAAW,KAAK,gCAAgC,kBAAkB,GAAG,CAAC,CAAC;QAClH,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,qBAAqB,CAAC,EAAU;IAC9C,MAAM,MAAM,GAAG,CAAC,GAAG,mBAAmB,EAAE,GAAG,wBAAwB,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACrG,oBAAoB,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,MAAM,CAAC,CAAC;IAC9C,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;AACtB,CAAC;AAED,wCAAwC;AACxC,MAAM,UAAU,4BAA4B;IAC1C,QAAQ,CAAC,KAAK,EAAE,CAAC;AACnB,CAAC"}
|