@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,274 @@
|
|
|
1
|
+
import { connectToDaemon } from '../../node/daemon.js';
|
|
2
|
+
import type { LogRecord } from '../../node/logger.js';
|
|
3
|
+
/**
|
|
4
|
+
* How a dashboard turns what a feed delivers into state. Every method is pure.
|
|
5
|
+
*
|
|
6
|
+
* @typeParam S - The dashboard's data (without the connection fields).
|
|
7
|
+
* @typeParam E - One event, as the reducer understands it.
|
|
8
|
+
* @stability experimental
|
|
9
|
+
* @extensionPoint hook
|
|
10
|
+
*/
|
|
11
|
+
export interface DashboardReducer<S, E> {
|
|
12
|
+
/** The state before anything has arrived. */
|
|
13
|
+
initial(): S;
|
|
14
|
+
/** Folds the snapshot the feed delivers on connect (the daemon's snapshot frame). */
|
|
15
|
+
hydrate(state: S, snapshot: unknown): S;
|
|
16
|
+
/** Folds one event. */
|
|
17
|
+
reduce(state: S, event: E): S;
|
|
18
|
+
/** Folds a log tail, when the dashboard shows one. */
|
|
19
|
+
log?(state: S, lines: LogRecord[]): S;
|
|
20
|
+
/** Validates a raw frame from the wire; `undefined` drops it. */
|
|
21
|
+
parseEvent(frame: unknown): E | undefined;
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* Where a dashboard's data comes from.
|
|
25
|
+
*
|
|
26
|
+
* @stability experimental
|
|
27
|
+
*/
|
|
28
|
+
export type DashboardMode = 'attached' | 'embedded' | 'poll';
|
|
29
|
+
/**
|
|
30
|
+
* What a feed tells its source.
|
|
31
|
+
*
|
|
32
|
+
* `frame` carries an unvalidated wire value (the source runs it through
|
|
33
|
+
* `reducer.parseEvent`); `event` carries one already typed (an in-process
|
|
34
|
+
* emitter, a poll result).
|
|
35
|
+
*
|
|
36
|
+
* @stability experimental
|
|
37
|
+
*/
|
|
38
|
+
export type DashboardFeedMessage<E> = {
|
|
39
|
+
/** A connection or poll attempt began. */
|
|
40
|
+
kind: 'attempt';
|
|
41
|
+
} | {
|
|
42
|
+
/** The feed is reaching its source. */
|
|
43
|
+
kind: 'connected';
|
|
44
|
+
} | {
|
|
45
|
+
/** The feed lost its source (a closed socket, a failed poll). */
|
|
46
|
+
kind: 'disconnected';
|
|
47
|
+
/** Why, for the frame's notice line. */
|
|
48
|
+
error?: string | undefined;
|
|
49
|
+
} | {
|
|
50
|
+
/** The state to hydrate from (the daemon's on-connect snapshot). */
|
|
51
|
+
kind: 'snapshot';
|
|
52
|
+
/** The raw snapshot; the reducer validates it. */
|
|
53
|
+
snapshot: unknown;
|
|
54
|
+
} | {
|
|
55
|
+
/** An unvalidated wire value. */
|
|
56
|
+
kind: 'frame';
|
|
57
|
+
/** The raw value; the reducer's `parseEvent` validates it. */
|
|
58
|
+
frame: unknown;
|
|
59
|
+
} | {
|
|
60
|
+
/** An event already typed. */
|
|
61
|
+
kind: 'event';
|
|
62
|
+
/** The event. */
|
|
63
|
+
event: E;
|
|
64
|
+
} | {
|
|
65
|
+
/** A log tail. */
|
|
66
|
+
kind: 'logs';
|
|
67
|
+
/** The new log lines. */
|
|
68
|
+
lines: LogRecord[];
|
|
69
|
+
} | {
|
|
70
|
+
/** A message from the source itself (the daemon's `error` frame). */
|
|
71
|
+
kind: 'error';
|
|
72
|
+
/** The message. */
|
|
73
|
+
message: string;
|
|
74
|
+
};
|
|
75
|
+
/**
|
|
76
|
+
* A source of dashboard data. `start` resolves once the first attempt has
|
|
77
|
+
* settled; `stop` is idempotent and ends every timer and connection.
|
|
78
|
+
*
|
|
79
|
+
* @stability experimental
|
|
80
|
+
*/
|
|
81
|
+
export interface DashboardFeed<E> {
|
|
82
|
+
/** Where the data comes from. */
|
|
83
|
+
readonly mode: DashboardMode;
|
|
84
|
+
/** Begins feeding `emit`; resolves once the first attempt has settled. */
|
|
85
|
+
start(emit: (message: DashboardFeedMessage<E>) => void): Promise<void>;
|
|
86
|
+
/** Ends every connection, request and timer. Idempotent. */
|
|
87
|
+
stop(): void;
|
|
88
|
+
}
|
|
89
|
+
/**
|
|
90
|
+
* The connection fields every dashboard state carries.
|
|
91
|
+
*
|
|
92
|
+
* @stability experimental
|
|
93
|
+
*/
|
|
94
|
+
export interface DashboardConnection {
|
|
95
|
+
/** Whether the feed is reaching its source right now. */
|
|
96
|
+
connected: boolean;
|
|
97
|
+
/** Whether the feed was ever reached. Distinguishes "starting" from "gone". */
|
|
98
|
+
everConnected: boolean;
|
|
99
|
+
/** The last failure, for the frame's notice line. */
|
|
100
|
+
error: string | undefined;
|
|
101
|
+
/** Connection or poll attempts so far. */
|
|
102
|
+
attempts: number;
|
|
103
|
+
/** The feed's transport. */
|
|
104
|
+
mode: DashboardMode;
|
|
105
|
+
}
|
|
106
|
+
/**
|
|
107
|
+
* Options of {@link DashboardSource}.
|
|
108
|
+
*
|
|
109
|
+
* @stability experimental
|
|
110
|
+
*/
|
|
111
|
+
export interface DashboardSourceOptions<S> {
|
|
112
|
+
/** Called with every new state (in addition to `subscribe`). */
|
|
113
|
+
onChange?: ((state: S & DashboardConnection) => void) | undefined;
|
|
114
|
+
}
|
|
115
|
+
/**
|
|
116
|
+
* Owns a dashboard's state: applies the reducer to what the feed emits.
|
|
117
|
+
*
|
|
118
|
+
* @typeParam S - The dashboard's data.
|
|
119
|
+
* @typeParam E - One event.
|
|
120
|
+
* @stability experimental
|
|
121
|
+
* @example
|
|
122
|
+
* ```ts
|
|
123
|
+
* const source = new DashboardSource(myReducer, daemonAttachFeed({ socketPath, channel: 'backup' }));
|
|
124
|
+
* // in a screen: const state = useDashboard(source);
|
|
125
|
+
* ```
|
|
126
|
+
*/
|
|
127
|
+
export declare class DashboardSource<S, E> {
|
|
128
|
+
private readonly reducer;
|
|
129
|
+
private readonly feed;
|
|
130
|
+
private readonly options;
|
|
131
|
+
private inner;
|
|
132
|
+
private connection;
|
|
133
|
+
private current;
|
|
134
|
+
private readonly subscribers;
|
|
135
|
+
private stopped;
|
|
136
|
+
private started;
|
|
137
|
+
constructor(reducer: DashboardReducer<S, E>, feed: DashboardFeed<E>, options?: DashboardSourceOptions<S>);
|
|
138
|
+
/** The current state. A NEW object after every change, so React sees it. */
|
|
139
|
+
getState: () => S & DashboardConnection;
|
|
140
|
+
/** Registers a listener; returns the unsubscribe. */
|
|
141
|
+
subscribe: (listener: (state: S & DashboardConnection) => void) => (() => void);
|
|
142
|
+
/** Starts the feed. Resolves once its first attempt has settled. Idempotent. */
|
|
143
|
+
start(): Promise<void>;
|
|
144
|
+
/**
|
|
145
|
+
* Stops the feed and ignores anything it says afterwards. Idempotent. The
|
|
146
|
+
* daemon (or server) is not told and is not affected in any way.
|
|
147
|
+
*/
|
|
148
|
+
stop(): void;
|
|
149
|
+
private receive;
|
|
150
|
+
private publish;
|
|
151
|
+
}
|
|
152
|
+
/**
|
|
153
|
+
* Options of {@link daemonAttachFeed}.
|
|
154
|
+
*
|
|
155
|
+
* @stability experimental
|
|
156
|
+
*/
|
|
157
|
+
export interface DaemonAttachFeedOptions {
|
|
158
|
+
/** The daemon's socket. */
|
|
159
|
+
socketPath: string;
|
|
160
|
+
/** Which engine's frames to read. Default `node` (the frames with no `channel` field). */
|
|
161
|
+
channel?: string | undefined;
|
|
162
|
+
/** Wait between reconnect attempts. Default 2000. */
|
|
163
|
+
reconnectMs?: number | undefined;
|
|
164
|
+
/** @internal Test seam. */
|
|
165
|
+
connect?: typeof connectToDaemon | undefined;
|
|
166
|
+
/** @internal Test seam. */
|
|
167
|
+
setTimer?: ((fn: () => void, ms: number) => unknown) | undefined;
|
|
168
|
+
/** @internal Test seam. */
|
|
169
|
+
clearTimer?: ((handle: unknown) => void) | undefined;
|
|
170
|
+
}
|
|
171
|
+
/**
|
|
172
|
+
* Attaches read-only to a worker daemon's socket and keeps re-attaching until
|
|
173
|
+
* `stop()`. Never sends a frame.
|
|
174
|
+
*
|
|
175
|
+
* @typeParam E - The event type the reducer expects after `parseEvent`.
|
|
176
|
+
* @param options - The socket path and, to read an app's second engine, its channel id.
|
|
177
|
+
* @returns A feed in `attached` mode.
|
|
178
|
+
* @stability experimental
|
|
179
|
+
*/
|
|
180
|
+
export declare function daemonAttachFeed<E = unknown>(options: DaemonAttachFeedOptions): DashboardFeed<E>;
|
|
181
|
+
/**
|
|
182
|
+
* The slice of an emitter {@link inProcessFeed} needs. Node's `EventEmitter`
|
|
183
|
+
* satisfies it.
|
|
184
|
+
*
|
|
185
|
+
* @stability experimental
|
|
186
|
+
*/
|
|
187
|
+
export interface DashboardEmitter {
|
|
188
|
+
/** Adds a listener. (`any` because Node's EventEmitter declares `(...args: any[])`.) */
|
|
189
|
+
on(name: string, listener: (...args: any[]) => void): unknown;
|
|
190
|
+
/** Removes a listener. */
|
|
191
|
+
off(name: string, listener: (...args: any[]) => void): unknown;
|
|
192
|
+
}
|
|
193
|
+
/**
|
|
194
|
+
* Options of {@link inProcessFeed}.
|
|
195
|
+
*
|
|
196
|
+
* @stability experimental
|
|
197
|
+
*/
|
|
198
|
+
export interface InProcessFeedOptions {
|
|
199
|
+
/** The engine's current state, delivered on start and after every event. */
|
|
200
|
+
snapshot(): unknown;
|
|
201
|
+
/** The event name on the emitter. Default `event`. */
|
|
202
|
+
eventName?: string | undefined;
|
|
203
|
+
/** An optional second event name carrying one log record or an array of them. */
|
|
204
|
+
logEventName?: string | undefined;
|
|
205
|
+
/** `false` delivers the snapshot once only, like the daemon does. Default `true`. */
|
|
206
|
+
refreshSnapshot?: boolean | undefined;
|
|
207
|
+
}
|
|
208
|
+
/**
|
|
209
|
+
* Feeds a dashboard from an engine running in this process: the snapshot on
|
|
210
|
+
* start, then every event the emitter fires. No socket, no reconnection.
|
|
211
|
+
*
|
|
212
|
+
* @typeParam E - The event type the emitter fires.
|
|
213
|
+
* @param emitter - The engine's emitter.
|
|
214
|
+
* @param options - How to read its snapshot and which event name to follow.
|
|
215
|
+
* @returns A feed in `embedded` mode.
|
|
216
|
+
* @stability experimental
|
|
217
|
+
*/
|
|
218
|
+
export declare function inProcessFeed<E = unknown>(emitter: DashboardEmitter, options: InProcessFeedOptions): DashboardFeed<E>;
|
|
219
|
+
/**
|
|
220
|
+
* Options of {@link pollFeed}.
|
|
221
|
+
*
|
|
222
|
+
* @stability experimental
|
|
223
|
+
*/
|
|
224
|
+
export interface PollFeedOptions {
|
|
225
|
+
/** Wait between the end of one poll and the start of the next. */
|
|
226
|
+
intervalMs: number;
|
|
227
|
+
/** @internal Test seam. */
|
|
228
|
+
setTimer?: ((fn: () => void, ms: number) => unknown) | undefined;
|
|
229
|
+
/** @internal Test seam. */
|
|
230
|
+
clearTimer?: ((handle: unknown) => void) | undefined;
|
|
231
|
+
}
|
|
232
|
+
/**
|
|
233
|
+
* Polls a server endpoint: one request at a time, the next one `intervalMs`
|
|
234
|
+
* after the last settled. `stop()` aborts the request in flight and clears
|
|
235
|
+
* the timer, so unmounting a screen never leaves either behind.
|
|
236
|
+
*
|
|
237
|
+
* A failed poll is reported as a disconnect with the message and polling
|
|
238
|
+
* continues; a poll that needs to say something specific (a 403) returns it
|
|
239
|
+
* as an event instead of throwing.
|
|
240
|
+
*
|
|
241
|
+
* @typeParam E - What one poll returns; the reducer folds it.
|
|
242
|
+
* @param fetch - Performs one poll. Must honour `signal`.
|
|
243
|
+
* @param options - The interval.
|
|
244
|
+
* @returns A feed in `poll` mode.
|
|
245
|
+
* @stability experimental
|
|
246
|
+
*/
|
|
247
|
+
export declare function pollFeed<E>(fetch: (signal: AbortSignal) => Promise<E>, options: PollFeedOptions): DashboardFeed<E>;
|
|
248
|
+
/**
|
|
249
|
+
* Dependencies of {@link selectDashboardFeed}.
|
|
250
|
+
*
|
|
251
|
+
* @stability experimental
|
|
252
|
+
*/
|
|
253
|
+
export interface SelectDashboardFeedDeps<E> {
|
|
254
|
+
/** The daemon's socket. */
|
|
255
|
+
socketPath: string;
|
|
256
|
+
/** Which engine's frames to read when attaching. Default `node`. */
|
|
257
|
+
channel?: string | undefined;
|
|
258
|
+
/** Whether a daemon is listening. A probe, never a command. */
|
|
259
|
+
isDaemonRunning(): Promise<boolean>;
|
|
260
|
+
/** Builds the in-process feed. Omit to never run embedded. */
|
|
261
|
+
embedded?: (() => DashboardFeed<E>) | undefined;
|
|
262
|
+
}
|
|
263
|
+
/**
|
|
264
|
+
* Attach when a daemon is running; otherwise run embedded when the caller
|
|
265
|
+
* offers it; otherwise attach anyway (the feed keeps looking and the screen
|
|
266
|
+
* says that no worker is running).
|
|
267
|
+
*
|
|
268
|
+
* @typeParam E - The event type.
|
|
269
|
+
* @param deps - The socket, the probe and the optional embedded builder.
|
|
270
|
+
* @returns The feed to hand to a {@link DashboardSource}.
|
|
271
|
+
* @stability experimental
|
|
272
|
+
*/
|
|
273
|
+
export declare function selectDashboardFeed<E>(deps: SelectDashboardFeedDeps<E>): Promise<DashboardFeed<E>>;
|
|
274
|
+
//# sourceMappingURL=source.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"source.d.ts","sourceRoot":"","sources":["../../../../src/engine/tui/dashboard/source.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAyB,MAAM,sBAAsB,CAAC;AAE9E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAyCtD;;;;;;;GAOG;AACH,MAAM,WAAW,gBAAgB,CAAC,CAAC,EAAE,CAAC;IACpC,6CAA6C;IAC7C,OAAO,IAAI,CAAC,CAAC;IACb,qFAAqF;IACrF,OAAO,CAAC,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,OAAO,GAAG,CAAC,CAAC;IACxC,uBAAuB;IACvB,MAAM,CAAC,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC;IAC9B,sDAAsD;IACtD,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,CAAC,CAAC;IACtC,iEAAiE;IACjE,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,CAAC,GAAG,SAAS,CAAC;CAC3C;AAED;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,UAAU,GAAG,UAAU,GAAG,MAAM,CAAC;AAE7D;;;;;;;;GAQG;AACH,MAAM,MAAM,oBAAoB,CAAC,CAAC,IAC9B;IACE,0CAA0C;IAC1C,IAAI,EAAE,SAAS,CAAC;CACjB,GACD;IACE,uCAAuC;IACvC,IAAI,EAAE,WAAW,CAAC;CACnB,GACD;IACE,iEAAiE;IACjE,IAAI,EAAE,cAAc,CAAC;IACrB,wCAAwC;IACxC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC5B,GACD;IACE,oEAAoE;IACpE,IAAI,EAAE,UAAU,CAAC;IACjB,kDAAkD;IAClD,QAAQ,EAAE,OAAO,CAAC;CACnB,GACD;IACE,iCAAiC;IACjC,IAAI,EAAE,OAAO,CAAC;IACd,8DAA8D;IAC9D,KAAK,EAAE,OAAO,CAAC;CAChB,GACD;IACE,8BAA8B;IAC9B,IAAI,EAAE,OAAO,CAAC;IACd,iBAAiB;IACjB,KAAK,EAAE,CAAC,CAAC;CACV,GACD;IACE,kBAAkB;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,yBAAyB;IACzB,KAAK,EAAE,SAAS,EAAE,CAAC;CACpB,GACD;IACE,qEAAqE;IACrE,IAAI,EAAE,OAAO,CAAC;IACd,mBAAmB;IACnB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEN;;;;;GAKG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC;IAC9B,iCAAiC;IACjC,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC;IAC7B,0EAA0E;IAC1E,KAAK,CAAC,IAAI,EAAE,CAAC,OAAO,EAAE,oBAAoB,CAAC,CAAC,CAAC,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACvE,4DAA4D;IAC5D,IAAI,IAAI,IAAI,CAAC;CACd;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,yDAAyD;IACzD,SAAS,EAAE,OAAO,CAAC;IACnB,+EAA+E;IAC/E,aAAa,EAAE,OAAO,CAAC;IACvB,qDAAqD;IACrD,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,0CAA0C;IAC1C,QAAQ,EAAE,MAAM,CAAC;IACjB,4BAA4B;IAC5B,IAAI,EAAE,aAAa,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB,CAAC,CAAC;IACvC,gEAAgE;IAChE,QAAQ,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,GAAG,mBAAmB,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;CACnE;AAED;;;;;;;;;;;GAWG;AACH,qBAAa,eAAe,CAAC,CAAC,EAAE,CAAC;IAS7B,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,OAAO;IAV1B,OAAO,CAAC,KAAK,CAAI;IACjB,OAAO,CAAC,UAAU,CAAsB;IACxC,OAAO,CAAC,OAAO,CAA0B;IACzC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAuD;IACnF,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,OAAO,CAAS;gBAGL,OAAO,EAAE,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC,EAC/B,IAAI,EAAE,aAAa,CAAC,CAAC,CAAC,EACtB,OAAO,GAAE,sBAAsB,CAAC,CAAC,CAAM;IAO1D,4EAA4E;IAC5E,QAAQ,QAAO,CAAC,GAAG,mBAAmB,CAAiB;IAEvD,qDAAqD;IACrD,SAAS,GAAI,UAAU,CAAC,KAAK,EAAE,CAAC,GAAG,mBAAmB,KAAK,IAAI,KAAG,CAAC,MAAM,IAAI,CAAC,CAK5E;IAEF,gFAAgF;IAC1E,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAM5B;;;OAGG;IACH,IAAI,IAAI,IAAI;IAOZ,OAAO,CAAC,OAAO;IAkCf,OAAO,CAAC,OAAO;CAUhB;AAMD;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACtC,2BAA2B;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,0FAA0F;IAC1F,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,qDAAqD;IACrD,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,2BAA2B;IAC3B,OAAO,CAAC,EAAE,OAAO,eAAe,GAAG,SAAS,CAAC;IAC7C,2BAA2B;IAC3B,QAAQ,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,MAAM,IAAI,EAAE,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,GAAG,SAAS,CAAC;IACjE,2BAA2B;IAC3B,UAAU,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;CACtD;AAED;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,GAAG,OAAO,EAAE,OAAO,EAAE,uBAAuB,GAAG,aAAa,CAAC,CAAC,CAAC,CA2FhG;AAMD;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAC/B,wFAAwF;IACxF,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,GAAG,OAAO,CAAC;IAC9D,0BAA0B;IAC1B,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,GAAG,OAAO,CAAC;CAChE;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,4EAA4E;IAC5E,QAAQ,IAAI,OAAO,CAAC;IACpB,sDAAsD;IACtD,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,iFAAiF;IACjF,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,qFAAqF;IACrF,eAAe,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CACvC;AAED;;;;;;;;;GASG;AACH,wBAAgB,aAAa,CAAC,CAAC,GAAG,OAAO,EAAE,OAAO,EAAE,gBAAgB,EAAE,OAAO,EAAE,oBAAoB,GAAG,aAAa,CAAC,CAAC,CAAC,CAkCrH;AAMD;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,kEAAkE;IAClE,UAAU,EAAE,MAAM,CAAC;IACnB,2BAA2B;IAC3B,QAAQ,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,MAAM,IAAI,EAAE,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,GAAG,SAAS,CAAC;IACjE,2BAA2B;IAC3B,UAAU,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;CACtD;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,eAAe,GAAG,aAAa,CAAC,CAAC,CAAC,CA6ClH;AAMD;;;;GAIG;AACH,MAAM,WAAW,uBAAuB,CAAC,CAAC;IACxC,2BAA2B;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,oEAAoE;IACpE,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,+DAA+D;IAC/D,eAAe,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IACpC,8DAA8D;IAC9D,QAAQ,CAAC,EAAE,CAAC,MAAM,aAAa,CAAC,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;CACjD;AAED;;;;;;;;;GASG;AACH,wBAAsB,mBAAmB,CAAC,CAAC,EAAE,IAAI,EAAE,uBAAuB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAWxG"}
|
|
@@ -0,0 +1,351 @@
|
|
|
1
|
+
import { connectToDaemon, DaemonNotRunningError } from '../../node/daemon.js';
|
|
2
|
+
import { messageChannel, NODE_CHANNEL } from '../../node/ipc-protocol.js';
|
|
3
|
+
/**
|
|
4
|
+
* Owns a dashboard's state: applies the reducer to what the feed emits.
|
|
5
|
+
*
|
|
6
|
+
* @typeParam S - The dashboard's data.
|
|
7
|
+
* @typeParam E - One event.
|
|
8
|
+
* @stability experimental
|
|
9
|
+
* @example
|
|
10
|
+
* ```ts
|
|
11
|
+
* const source = new DashboardSource(myReducer, daemonAttachFeed({ socketPath, channel: 'backup' }));
|
|
12
|
+
* // in a screen: const state = useDashboard(source);
|
|
13
|
+
* ```
|
|
14
|
+
*/
|
|
15
|
+
export class DashboardSource {
|
|
16
|
+
reducer;
|
|
17
|
+
feed;
|
|
18
|
+
options;
|
|
19
|
+
inner;
|
|
20
|
+
connection;
|
|
21
|
+
current;
|
|
22
|
+
subscribers = new Set();
|
|
23
|
+
stopped = false;
|
|
24
|
+
started = false;
|
|
25
|
+
constructor(reducer, feed, options = {}) {
|
|
26
|
+
this.reducer = reducer;
|
|
27
|
+
this.feed = feed;
|
|
28
|
+
this.options = options;
|
|
29
|
+
this.inner = reducer.initial();
|
|
30
|
+
this.connection = { connected: false, everConnected: false, error: undefined, attempts: 0, mode: feed.mode };
|
|
31
|
+
this.current = { ...this.inner, ...this.connection };
|
|
32
|
+
}
|
|
33
|
+
/** The current state. A NEW object after every change, so React sees it. */
|
|
34
|
+
getState = () => this.current;
|
|
35
|
+
/** Registers a listener; returns the unsubscribe. */
|
|
36
|
+
subscribe = (listener) => {
|
|
37
|
+
this.subscribers.add(listener);
|
|
38
|
+
return () => {
|
|
39
|
+
this.subscribers.delete(listener);
|
|
40
|
+
};
|
|
41
|
+
};
|
|
42
|
+
/** Starts the feed. Resolves once its first attempt has settled. Idempotent. */
|
|
43
|
+
async start() {
|
|
44
|
+
if (this.started || this.stopped)
|
|
45
|
+
return;
|
|
46
|
+
this.started = true;
|
|
47
|
+
await this.feed.start((message) => this.receive(message));
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Stops the feed and ignores anything it says afterwards. Idempotent. The
|
|
51
|
+
* daemon (or server) is not told and is not affected in any way.
|
|
52
|
+
*/
|
|
53
|
+
stop() {
|
|
54
|
+
if (this.stopped)
|
|
55
|
+
return;
|
|
56
|
+
this.stopped = true;
|
|
57
|
+
this.feed.stop();
|
|
58
|
+
this.publish({ connection: { connected: false } });
|
|
59
|
+
}
|
|
60
|
+
receive(message) {
|
|
61
|
+
if (this.stopped)
|
|
62
|
+
return;
|
|
63
|
+
switch (message.kind) {
|
|
64
|
+
case 'attempt':
|
|
65
|
+
this.publish({ connection: { attempts: this.connection.attempts + 1 } });
|
|
66
|
+
return;
|
|
67
|
+
case 'connected':
|
|
68
|
+
this.publish({ connection: { connected: true, everConnected: true, error: undefined } });
|
|
69
|
+
return;
|
|
70
|
+
case 'disconnected':
|
|
71
|
+
this.publish({
|
|
72
|
+
connection: { connected: false, ...(message.error !== undefined ? { error: message.error } : {}) },
|
|
73
|
+
});
|
|
74
|
+
return;
|
|
75
|
+
case 'snapshot':
|
|
76
|
+
this.publish({ data: this.reducer.hydrate(this.inner, message.snapshot) });
|
|
77
|
+
return;
|
|
78
|
+
case 'frame': {
|
|
79
|
+
const event = this.reducer.parseEvent(message.frame);
|
|
80
|
+
if (event !== undefined)
|
|
81
|
+
this.publish({ data: this.reducer.reduce(this.inner, event) });
|
|
82
|
+
return;
|
|
83
|
+
}
|
|
84
|
+
case 'event':
|
|
85
|
+
this.publish({ data: this.reducer.reduce(this.inner, message.event) });
|
|
86
|
+
return;
|
|
87
|
+
case 'logs':
|
|
88
|
+
if (this.reducer.log !== undefined)
|
|
89
|
+
this.publish({ data: this.reducer.log(this.inner, message.lines) });
|
|
90
|
+
return;
|
|
91
|
+
case 'error':
|
|
92
|
+
this.publish({ connection: { error: message.message } });
|
|
93
|
+
return;
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
publish(patch) {
|
|
97
|
+
if (patch.data !== undefined)
|
|
98
|
+
this.inner = patch.data;
|
|
99
|
+
if (patch.connection !== undefined)
|
|
100
|
+
this.connection = { ...this.connection, ...patch.connection };
|
|
101
|
+
// A NEW OBJECT every time. The consumer is React, which compares by
|
|
102
|
+
// identity; mutating in place would render the first frame and then never
|
|
103
|
+
// update again: the classic "the TUI is frozen" bug.
|
|
104
|
+
this.current = { ...this.inner, ...this.connection };
|
|
105
|
+
this.options.onChange?.(this.current);
|
|
106
|
+
for (const subscriber of [...this.subscribers])
|
|
107
|
+
subscriber(this.current);
|
|
108
|
+
}
|
|
109
|
+
}
|
|
110
|
+
/**
|
|
111
|
+
* Attaches read-only to a worker daemon's socket and keeps re-attaching until
|
|
112
|
+
* `stop()`. Never sends a frame.
|
|
113
|
+
*
|
|
114
|
+
* @typeParam E - The event type the reducer expects after `parseEvent`.
|
|
115
|
+
* @param options - The socket path and, to read an app's second engine, its channel id.
|
|
116
|
+
* @returns A feed in `attached` mode.
|
|
117
|
+
* @stability experimental
|
|
118
|
+
*/
|
|
119
|
+
export function daemonAttachFeed(options) {
|
|
120
|
+
const channel = options.channel ?? NODE_CHANNEL;
|
|
121
|
+
let emit;
|
|
122
|
+
let client;
|
|
123
|
+
let timer;
|
|
124
|
+
let stopped = false;
|
|
125
|
+
const setTimer = options.setTimer ?? ((fn, ms) => setTimeout(fn, ms));
|
|
126
|
+
const clearTimer = options.clearTimer ?? ((handle) => clearTimeout(handle));
|
|
127
|
+
const receive = (message) => {
|
|
128
|
+
switch (message.type) {
|
|
129
|
+
case 'ack':
|
|
130
|
+
// This feed sends no commands, so an ack can only be the echo of
|
|
131
|
+
// another attached client's request. Not ours to render.
|
|
132
|
+
return;
|
|
133
|
+
case 'error':
|
|
134
|
+
emit?.({ kind: 'error', message: message.message });
|
|
135
|
+
return;
|
|
136
|
+
case 'snapshot':
|
|
137
|
+
if (messageChannel(message) === channel)
|
|
138
|
+
emit?.({ kind: 'snapshot', snapshot: message.snapshot });
|
|
139
|
+
return;
|
|
140
|
+
case 'log-tail':
|
|
141
|
+
if (messageChannel(message) === channel)
|
|
142
|
+
emit?.({ kind: 'logs', lines: message.lines });
|
|
143
|
+
return;
|
|
144
|
+
case 'event':
|
|
145
|
+
if (messageChannel(message) === channel)
|
|
146
|
+
emit?.({ kind: 'frame', frame: message.event });
|
|
147
|
+
return;
|
|
148
|
+
}
|
|
149
|
+
};
|
|
150
|
+
const scheduleReconnect = () => {
|
|
151
|
+
if (stopped || timer !== undefined)
|
|
152
|
+
return;
|
|
153
|
+
timer = setTimer(() => {
|
|
154
|
+
timer = undefined;
|
|
155
|
+
void attach();
|
|
156
|
+
}, options.reconnectMs ?? 2_000);
|
|
157
|
+
};
|
|
158
|
+
const attach = async () => {
|
|
159
|
+
if (stopped)
|
|
160
|
+
return;
|
|
161
|
+
emit?.({ kind: 'attempt' });
|
|
162
|
+
const connect = options.connect ?? connectToDaemon;
|
|
163
|
+
try {
|
|
164
|
+
const connected = await connect({
|
|
165
|
+
socketPath: options.socketPath,
|
|
166
|
+
onMessage: receive,
|
|
167
|
+
onClose: () => {
|
|
168
|
+
client = undefined;
|
|
169
|
+
emit?.({ kind: 'disconnected' });
|
|
170
|
+
scheduleReconnect();
|
|
171
|
+
},
|
|
172
|
+
});
|
|
173
|
+
if (stopped) {
|
|
174
|
+
connected.close();
|
|
175
|
+
return;
|
|
176
|
+
}
|
|
177
|
+
client = connected;
|
|
178
|
+
emit?.({ kind: 'connected' });
|
|
179
|
+
}
|
|
180
|
+
catch (error) {
|
|
181
|
+
client = undefined;
|
|
182
|
+
emit?.({
|
|
183
|
+
kind: 'disconnected',
|
|
184
|
+
error: error instanceof DaemonNotRunningError
|
|
185
|
+
? 'No worker is running here.'
|
|
186
|
+
: error instanceof Error
|
|
187
|
+
? error.message
|
|
188
|
+
: String(error),
|
|
189
|
+
});
|
|
190
|
+
scheduleReconnect();
|
|
191
|
+
}
|
|
192
|
+
};
|
|
193
|
+
return {
|
|
194
|
+
mode: 'attached',
|
|
195
|
+
async start(sink) {
|
|
196
|
+
emit = sink;
|
|
197
|
+
await attach();
|
|
198
|
+
},
|
|
199
|
+
stop() {
|
|
200
|
+
if (stopped)
|
|
201
|
+
return;
|
|
202
|
+
stopped = true;
|
|
203
|
+
if (timer !== undefined) {
|
|
204
|
+
clearTimer(timer);
|
|
205
|
+
timer = undefined;
|
|
206
|
+
}
|
|
207
|
+
client?.close();
|
|
208
|
+
client = undefined;
|
|
209
|
+
},
|
|
210
|
+
};
|
|
211
|
+
}
|
|
212
|
+
/**
|
|
213
|
+
* Feeds a dashboard from an engine running in this process: the snapshot on
|
|
214
|
+
* start, then every event the emitter fires. No socket, no reconnection.
|
|
215
|
+
*
|
|
216
|
+
* @typeParam E - The event type the emitter fires.
|
|
217
|
+
* @param emitter - The engine's emitter.
|
|
218
|
+
* @param options - How to read its snapshot and which event name to follow.
|
|
219
|
+
* @returns A feed in `embedded` mode.
|
|
220
|
+
* @stability experimental
|
|
221
|
+
*/
|
|
222
|
+
export function inProcessFeed(emitter, options) {
|
|
223
|
+
const eventName = options.eventName ?? 'event';
|
|
224
|
+
let stopped = false;
|
|
225
|
+
let detach;
|
|
226
|
+
return {
|
|
227
|
+
mode: 'embedded',
|
|
228
|
+
async start(emit) {
|
|
229
|
+
if (stopped)
|
|
230
|
+
return;
|
|
231
|
+
emit({ kind: 'attempt' });
|
|
232
|
+
const onEvent = (event) => {
|
|
233
|
+
if (stopped)
|
|
234
|
+
return;
|
|
235
|
+
emit({ kind: 'event', event });
|
|
236
|
+
if (options.refreshSnapshot !== false)
|
|
237
|
+
emit({ kind: 'snapshot', snapshot: options.snapshot() });
|
|
238
|
+
};
|
|
239
|
+
const onLog = (payload) => {
|
|
240
|
+
if (!stopped)
|
|
241
|
+
emit({ kind: 'logs', lines: Array.isArray(payload) ? payload : [payload] });
|
|
242
|
+
};
|
|
243
|
+
emitter.on(eventName, onEvent);
|
|
244
|
+
if (options.logEventName !== undefined)
|
|
245
|
+
emitter.on(options.logEventName, onLog);
|
|
246
|
+
detach = () => {
|
|
247
|
+
emitter.off(eventName, onEvent);
|
|
248
|
+
if (options.logEventName !== undefined)
|
|
249
|
+
emitter.off(options.logEventName, onLog);
|
|
250
|
+
};
|
|
251
|
+
emit({ kind: 'connected' });
|
|
252
|
+
emit({ kind: 'snapshot', snapshot: options.snapshot() });
|
|
253
|
+
},
|
|
254
|
+
stop() {
|
|
255
|
+
if (stopped)
|
|
256
|
+
return;
|
|
257
|
+
stopped = true;
|
|
258
|
+
detach?.();
|
|
259
|
+
detach = undefined;
|
|
260
|
+
},
|
|
261
|
+
};
|
|
262
|
+
}
|
|
263
|
+
/**
|
|
264
|
+
* Polls a server endpoint: one request at a time, the next one `intervalMs`
|
|
265
|
+
* after the last settled. `stop()` aborts the request in flight and clears
|
|
266
|
+
* the timer, so unmounting a screen never leaves either behind.
|
|
267
|
+
*
|
|
268
|
+
* A failed poll is reported as a disconnect with the message and polling
|
|
269
|
+
* continues; a poll that needs to say something specific (a 403) returns it
|
|
270
|
+
* as an event instead of throwing.
|
|
271
|
+
*
|
|
272
|
+
* @typeParam E - What one poll returns; the reducer folds it.
|
|
273
|
+
* @param fetch - Performs one poll. Must honour `signal`.
|
|
274
|
+
* @param options - The interval.
|
|
275
|
+
* @returns A feed in `poll` mode.
|
|
276
|
+
* @stability experimental
|
|
277
|
+
*/
|
|
278
|
+
export function pollFeed(fetch, options) {
|
|
279
|
+
const setTimer = options.setTimer ?? ((fn, ms) => setTimeout(fn, ms));
|
|
280
|
+
const clearTimer = options.clearTimer ?? ((handle) => clearTimeout(handle));
|
|
281
|
+
let controller;
|
|
282
|
+
let timer;
|
|
283
|
+
let stopped = false;
|
|
284
|
+
let emit;
|
|
285
|
+
const poll = async () => {
|
|
286
|
+
if (stopped)
|
|
287
|
+
return;
|
|
288
|
+
controller = new AbortController();
|
|
289
|
+
const signal = controller.signal;
|
|
290
|
+
emit?.({ kind: 'attempt' });
|
|
291
|
+
try {
|
|
292
|
+
const result = await fetch(signal);
|
|
293
|
+
if (stopped || signal.aborted)
|
|
294
|
+
return;
|
|
295
|
+
emit?.({ kind: 'connected' });
|
|
296
|
+
emit?.({ kind: 'event', event: result });
|
|
297
|
+
}
|
|
298
|
+
catch (error) {
|
|
299
|
+
if (stopped || signal.aborted)
|
|
300
|
+
return;
|
|
301
|
+
emit?.({ kind: 'disconnected', error: error instanceof Error ? error.message : String(error) });
|
|
302
|
+
}
|
|
303
|
+
if (stopped)
|
|
304
|
+
return;
|
|
305
|
+
timer = setTimer(() => {
|
|
306
|
+
timer = undefined;
|
|
307
|
+
void poll();
|
|
308
|
+
}, options.intervalMs);
|
|
309
|
+
};
|
|
310
|
+
return {
|
|
311
|
+
mode: 'poll',
|
|
312
|
+
async start(sink) {
|
|
313
|
+
emit = sink;
|
|
314
|
+
await poll();
|
|
315
|
+
},
|
|
316
|
+
stop() {
|
|
317
|
+
if (stopped)
|
|
318
|
+
return;
|
|
319
|
+
stopped = true;
|
|
320
|
+
controller?.abort();
|
|
321
|
+
if (timer !== undefined) {
|
|
322
|
+
clearTimer(timer);
|
|
323
|
+
timer = undefined;
|
|
324
|
+
}
|
|
325
|
+
},
|
|
326
|
+
};
|
|
327
|
+
}
|
|
328
|
+
/**
|
|
329
|
+
* Attach when a daemon is running; otherwise run embedded when the caller
|
|
330
|
+
* offers it; otherwise attach anyway (the feed keeps looking and the screen
|
|
331
|
+
* says that no worker is running).
|
|
332
|
+
*
|
|
333
|
+
* @typeParam E - The event type.
|
|
334
|
+
* @param deps - The socket, the probe and the optional embedded builder.
|
|
335
|
+
* @returns The feed to hand to a {@link DashboardSource}.
|
|
336
|
+
* @stability experimental
|
|
337
|
+
*/
|
|
338
|
+
export async function selectDashboardFeed(deps) {
|
|
339
|
+
const attach = () => daemonAttachFeed({ socketPath: deps.socketPath, ...(deps.channel !== undefined ? { channel: deps.channel } : {}) });
|
|
340
|
+
let running = false;
|
|
341
|
+
try {
|
|
342
|
+
running = await deps.isDaemonRunning();
|
|
343
|
+
}
|
|
344
|
+
catch {
|
|
345
|
+
running = false;
|
|
346
|
+
}
|
|
347
|
+
if (running)
|
|
348
|
+
return attach();
|
|
349
|
+
return deps.embedded !== undefined ? deps.embedded() : attach();
|
|
350
|
+
}
|
|
351
|
+
//# sourceMappingURL=source.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"source.js","sourceRoot":"","sources":["../../../../src/engine/tui/dashboard/source.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAC9E,OAAO,EAAE,cAAc,EAAE,YAAY,EAAsB,MAAM,4BAA4B,CAAC;AAwK9F;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,eAAe;IASP;IACA;IACA;IAVX,KAAK,CAAI;IACT,UAAU,CAAsB;IAChC,OAAO,CAA0B;IACxB,WAAW,GAAG,IAAI,GAAG,EAA4C,CAAC;IAC3E,OAAO,GAAG,KAAK,CAAC;IAChB,OAAO,GAAG,KAAK,CAAC;IAExB,YACmB,OAA+B,EAC/B,IAAsB,EACtB,UAAqC,EAAE;QAFvC,YAAO,GAAP,OAAO,CAAwB;QAC/B,SAAI,GAAJ,IAAI,CAAkB;QACtB,YAAO,GAAP,OAAO,CAAgC;QAExD,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;QAC/B,IAAI,CAAC,UAAU,GAAG,EAAE,SAAS,EAAE,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC;QAC7G,IAAI,CAAC,OAAO,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;IACvD,CAAC;IAED,4EAA4E;IAC5E,QAAQ,GAAG,GAA4B,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC;IAEvD,qDAAqD;IACrD,SAAS,GAAG,CAAC,QAAkD,EAAgB,EAAE;QAC/E,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC/B,OAAO,GAAG,EAAE;YACV,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACpC,CAAC,CAAC;IACJ,CAAC,CAAC;IAEF,gFAAgF;IAChF,KAAK,CAAC,KAAK;QACT,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO;YAAE,OAAO;QACzC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,MAAM,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;IAC5D,CAAC;IAED;;;OAGG;IACH,IAAI;QACF,IAAI,IAAI,CAAC,OAAO;YAAE,OAAO;QACzB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QACjB,IAAI,CAAC,OAAO,CAAC,EAAE,UAAU,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;IACrD,CAAC;IAEO,OAAO,CAAC,OAAgC;QAC9C,IAAI,IAAI,CAAC,OAAO;YAAE,OAAO;QACzB,QAAQ,OAAO,CAAC,IAAI,EAAE,CAAC;YACrB,KAAK,SAAS;gBACZ,IAAI,CAAC,OAAO,CAAC,EAAE,UAAU,EAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC;gBACzE,OAAO;YACT,KAAK,WAAW;gBACd,IAAI,CAAC,OAAO,CAAC,EAAE,UAAU,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,CAAC,CAAC;gBACzF,OAAO;YACT,KAAK,cAAc;gBACjB,IAAI,CAAC,OAAO,CAAC;oBACX,UAAU,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE;iBACnG,CAAC,CAAC;gBACH,OAAO;YACT,KAAK,UAAU;gBACb,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;gBAC3E,OAAO;YACT,KAAK,OAAO,CAAC,CAAC,CAAC;gBACb,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;gBACrD,IAAI,KAAK,KAAK,SAAS;oBAAE,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC;gBACxF,OAAO;YACT,CAAC;YACD,KAAK,OAAO;gBACV,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;gBACvE,OAAO;YACT,KAAK,MAAM;gBACT,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,KAAK,SAAS;oBAAE,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;gBACxG,OAAO;YACT,KAAK,OAAO;gBACV,IAAI,CAAC,OAAO,CAAC,EAAE,UAAU,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;gBACzD,OAAO;QACX,CAAC;IACH,CAAC;IAEO,OAAO,CAAC,KAA8D;QAC5E,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS;YAAE,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACtD,IAAI,KAAK,CAAC,UAAU,KAAK,SAAS;YAAE,IAAI,CAAC,UAAU,GAAG,EAAE,GAAG,IAAI,CAAC,UAAU,EAAE,GAAG,KAAK,CAAC,UAAU,EAAE,CAAC;QAClG,oEAAoE;QACpE,0EAA0E;QAC1E,qDAAqD;QACrD,IAAI,CAAC,OAAO,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QACrD,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACtC,KAAK,MAAM,UAAU,IAAI,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC;YAAE,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC3E,CAAC;CACF;AA0BD;;;;;;;;GAQG;AACH,MAAM,UAAU,gBAAgB,CAAc,OAAgC;IAC5E,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,YAAY,CAAC;IAChD,IAAI,IAA8D,CAAC;IACnE,IAAI,MAAqC,CAAC;IAC1C,IAAI,KAAc,CAAC;IACnB,IAAI,OAAO,GAAG,KAAK,CAAC;IAEpB,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,CAAC,CAAC,EAAc,EAAE,EAAU,EAAE,EAAE,CAAC,UAAU,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;IAC1F,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,CAAC,CAAC,MAAe,EAAE,EAAE,CAAC,YAAY,CAAC,MAAwB,CAAC,CAAC,CAAC;IAEvG,MAAM,OAAO,GAAG,CAAC,OAAsB,EAAQ,EAAE;QAC/C,QAAQ,OAAO,CAAC,IAAI,EAAE,CAAC;YACrB,KAAK,KAAK;gBACR,iEAAiE;gBACjE,yDAAyD;gBACzD,OAAO;YACT,KAAK,OAAO;gBACV,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;gBACpD,OAAO;YACT,KAAK,UAAU;gBACb,IAAI,cAAc,CAAC,OAAO,CAAC,KAAK,OAAO;oBAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;gBAClG,OAAO;YACT,KAAK,UAAU;gBACb,IAAI,cAAc,CAAC,OAAO,CAAC,KAAK,OAAO;oBAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;gBACxF,OAAO;YACT,KAAK,OAAO;gBACV,IAAI,cAAc,CAAC,OAAO,CAAC,KAAK,OAAO;oBAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;gBACzF,OAAO;QACX,CAAC;IACH,CAAC,CAAC;IAEF,MAAM,iBAAiB,GAAG,GAAS,EAAE;QACnC,IAAI,OAAO,IAAI,KAAK,KAAK,SAAS;YAAE,OAAO;QAC3C,KAAK,GAAG,QAAQ,CAAC,GAAG,EAAE;YACpB,KAAK,GAAG,SAAS,CAAC;YAClB,KAAK,MAAM,EAAE,CAAC;QAChB,CAAC,EAAE,OAAO,CAAC,WAAW,IAAI,KAAK,CAAC,CAAC;IACnC,CAAC,CAAC;IAEF,MAAM,MAAM,GAAG,KAAK,IAAmB,EAAE;QACvC,IAAI,OAAO;YAAE,OAAO;QACpB,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;QAC5B,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,eAAe,CAAC;QACnD,IAAI,CAAC;YACH,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC;gBAC9B,UAAU,EAAE,OAAO,CAAC,UAAU;gBAC9B,SAAS,EAAE,OAAO;gBAClB,OAAO,EAAE,GAAG,EAAE;oBACZ,MAAM,GAAG,SAAS,CAAC;oBACnB,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC,CAAC;oBACjC,iBAAiB,EAAE,CAAC;gBACtB,CAAC;aACF,CAAC,CAAC;YACH,IAAI,OAAO,EAAE,CAAC;gBACZ,SAAS,CAAC,KAAK,EAAE,CAAC;gBAClB,OAAO;YACT,CAAC;YACD,MAAM,GAAG,SAAS,CAAC;YACnB,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;QAChC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,GAAG,SAAS,CAAC;YACnB,IAAI,EAAE,CAAC;gBACL,IAAI,EAAE,cAAc;gBACpB,KAAK,EACH,KAAK,YAAY,qBAAqB;oBACpC,CAAC,CAAC,4BAA4B;oBAC9B,CAAC,CAAC,KAAK,YAAY,KAAK;wBACtB,CAAC,CAAC,KAAK,CAAC,OAAO;wBACf,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC;aACtB,CAAC,CAAC;YACH,iBAAiB,EAAE,CAAC;QACtB,CAAC;IACH,CAAC,CAAC;IAEF,OAAO;QACL,IAAI,EAAE,UAAU;QAChB,KAAK,CAAC,KAAK,CAAC,IAAI;YACd,IAAI,GAAG,IAAI,CAAC;YACZ,MAAM,MAAM,EAAE,CAAC;QACjB,CAAC;QACD,IAAI;YACF,IAAI,OAAO;gBAAE,OAAO;YACpB,OAAO,GAAG,IAAI,CAAC;YACf,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACxB,UAAU,CAAC,KAAK,CAAC,CAAC;gBAClB,KAAK,GAAG,SAAS,CAAC;YACpB,CAAC;YACD,MAAM,EAAE,KAAK,EAAE,CAAC;YAChB,MAAM,GAAG,SAAS,CAAC;QACrB,CAAC;KACF,CAAC;AACJ,CAAC;AAmCD;;;;;;;;;GASG;AACH,MAAM,UAAU,aAAa,CAAc,OAAyB,EAAE,OAA6B;IACjG,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,OAAO,CAAC;IAC/C,IAAI,OAAO,GAAG,KAAK,CAAC;IACpB,IAAI,MAAgC,CAAC;IAErC,OAAO;QACL,IAAI,EAAE,UAAU;QAChB,KAAK,CAAC,KAAK,CAAC,IAAI;YACd,IAAI,OAAO;gBAAE,OAAO;YACpB,IAAI,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;YAC1B,MAAM,OAAO,GAAG,CAAC,KAAQ,EAAQ,EAAE;gBACjC,IAAI,OAAO;oBAAE,OAAO;gBACpB,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;gBAC/B,IAAI,OAAO,CAAC,eAAe,KAAK,KAAK;oBAAE,IAAI,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;YAClG,CAAC,CAAC;YACF,MAAM,KAAK,GAAG,CAAC,OAAgC,EAAQ,EAAE;gBACvD,IAAI,CAAC,OAAO;oBAAE,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;YAC5F,CAAC,CAAC;YACF,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;YAC/B,IAAI,OAAO,CAAC,YAAY,KAAK,SAAS;gBAAE,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;YAChF,MAAM,GAAG,GAAG,EAAE;gBACZ,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;gBAChC,IAAI,OAAO,CAAC,YAAY,KAAK,SAAS;oBAAE,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;YACnF,CAAC,CAAC;YACF,IAAI,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;YAC5B,IAAI,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QAC3D,CAAC;QACD,IAAI;YACF,IAAI,OAAO;gBAAE,OAAO;YACpB,OAAO,GAAG,IAAI,CAAC;YACf,MAAM,EAAE,EAAE,CAAC;YACX,MAAM,GAAG,SAAS,CAAC;QACrB,CAAC;KACF,CAAC;AACJ,CAAC;AAoBD;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,QAAQ,CAAI,KAA0C,EAAE,OAAwB;IAC9F,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,CAAC,CAAC,EAAc,EAAE,EAAU,EAAE,EAAE,CAAC,UAAU,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;IAC1F,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,CAAC,CAAC,MAAe,EAAE,EAAE,CAAC,YAAY,CAAC,MAAwB,CAAC,CAAC,CAAC;IACvG,IAAI,UAAuC,CAAC;IAC5C,IAAI,KAAc,CAAC;IACnB,IAAI,OAAO,GAAG,KAAK,CAAC;IACpB,IAAI,IAA8D,CAAC;IAEnE,MAAM,IAAI,GAAG,KAAK,IAAmB,EAAE;QACrC,IAAI,OAAO;YAAE,OAAO;QACpB,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;QACnC,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC;QACjC,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;QAC5B,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,CAAC;YACnC,IAAI,OAAO,IAAI,MAAM,CAAC,OAAO;gBAAE,OAAO;YACtC,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;YAC9B,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;QAC3C,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,OAAO,IAAI,MAAM,CAAC,OAAO;gBAAE,OAAO;YACtC,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAClG,CAAC;QACD,IAAI,OAAO;YAAE,OAAO;QACpB,KAAK,GAAG,QAAQ,CAAC,GAAG,EAAE;YACpB,KAAK,GAAG,SAAS,CAAC;YAClB,KAAK,IAAI,EAAE,CAAC;QACd,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;IACzB,CAAC,CAAC;IAEF,OAAO;QACL,IAAI,EAAE,MAAM;QACZ,KAAK,CAAC,KAAK,CAAC,IAAI;YACd,IAAI,GAAG,IAAI,CAAC;YACZ,MAAM,IAAI,EAAE,CAAC;QACf,CAAC;QACD,IAAI;YACF,IAAI,OAAO;gBAAE,OAAO;YACpB,OAAO,GAAG,IAAI,CAAC;YACf,UAAU,EAAE,KAAK,EAAE,CAAC;YACpB,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACxB,UAAU,CAAC,KAAK,CAAC,CAAC;gBAClB,KAAK,GAAG,SAAS,CAAC;YACpB,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC;AAsBD;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAAI,IAAgC;IAC3E,MAAM,MAAM,GAAG,GAAqB,EAAE,CACpC,gBAAgB,CAAI,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,GAAG,CAAC,IAAI,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IACzH,IAAI,OAAO,GAAG,KAAK,CAAC;IACpB,IAAI,CAAC;QACH,OAAO,GAAG,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;IACzC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,GAAG,KAAK,CAAC;IAClB,CAAC;IACD,IAAI,OAAO;QAAE,OAAO,MAAM,EAAE,CAAC;IAC7B,OAAO,IAAI,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;AAClE,CAAC"}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import type { DashboardConnection, DashboardSource } from './source.js';
|
|
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 declare function useDashboard<S, E>(source: DashboardSource<S, E> | undefined): (S & DashboardConnection) | undefined;
|
|
23
|
+
//# sourceMappingURL=use-dashboard.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"use-dashboard.d.ts","sourceRoot":"","sources":["../../../../src/engine/tui/dashboard/use-dashboard.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAExE;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,SAAS,GAAG,CAAC,CAAC,GAAG,mBAAmB,CAAC,GAAG,SAAS,CAanH"}
|