@serfab/cadre-host 0.10.0 → 0.12.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (158) hide show
  1. package/README.md +406 -296
  2. package/dist/bin/host.d.ts +11 -7
  3. package/dist/bin/host.js +40 -12
  4. package/dist/bin/host.js.map +1 -1
  5. package/dist/installer/config.d.ts +4 -4
  6. package/dist/installer/config.js +5 -39
  7. package/dist/installer/config.js.map +1 -1
  8. package/dist/installer/identity.d.ts +8 -1
  9. package/dist/installer/identity.js +8 -1
  10. package/dist/installer/identity.js.map +1 -1
  11. package/dist/orchestrator/host-process-orchestrator.d.ts +2 -2
  12. package/dist/orchestrator/host-process-orchestrator.js +9 -4
  13. package/dist/orchestrator/host-process-orchestrator.js.map +1 -1
  14. package/dist/server/settings-store.d.ts +1 -1
  15. package/dist/server/settings-store.js +5 -1
  16. package/dist/server/settings-store.js.map +1 -1
  17. package/dist/server/static.js +38 -38
  18. package/dist/ui/assets/index-C-iks41M.js.map +1 -1
  19. package/dist/ui/index.html +12 -12
  20. package/package.json +4 -4
  21. package/service/cadre-host.service.tmpl +16 -16
  22. package/service/com.serfab.cadre-host.plist.tmpl +35 -35
  23. package/service/install-service.ps1 +98 -98
  24. package/service/uninstall-service.ps1 +19 -19
  25. package/src/__tests__/build-targets.test.ts +26 -26
  26. package/src/__tests__/cli-invite.smoke.test.ts +192 -192
  27. package/src/__tests__/cli-nat.smoke.test.ts +212 -212
  28. package/src/__tests__/cli.smoke.test.ts +51 -46
  29. package/src/__tests__/global-setup.ts +56 -51
  30. package/src/__tests__/host-owner.smoke.test.ts +123 -123
  31. package/src/__tests__/orchestrator-env-scrub.test.ts +140 -140
  32. package/src/__tests__/orchestrator-node-identity.test.ts +5 -5
  33. package/src/__tests__/orchestrator-owner.test.ts +198 -198
  34. package/src/__tests__/orchestrator-pin-keys.test.ts +153 -153
  35. package/src/__tests__/orchestrator-push.test.ts +145 -145
  36. package/src/__tests__/orchestrator.test.ts +951 -951
  37. package/src/auth/__tests__/duration.test.ts +28 -28
  38. package/src/auth/__tests__/self-label.test.ts +85 -85
  39. package/src/auth/__tests__/trust-circle-store.test.ts +115 -115
  40. package/src/auth/__tests__/trust-circle.test.ts +445 -445
  41. package/src/auth/duration.ts +33 -33
  42. package/src/auth/index.ts +21 -21
  43. package/src/auth/self-label.ts +74 -74
  44. package/src/auth/trust-circle-store.ts +155 -155
  45. package/src/auth/types.ts +99 -99
  46. package/src/bin/__tests__/cli-reference.test.ts +167 -0
  47. package/src/bin/host.ts +1326 -1299
  48. package/src/donation/__tests__/donation-service.test.ts +1068 -1068
  49. package/src/donation/__tests__/donation-supervisor.test.ts +510 -510
  50. package/src/donation/__tests__/fake-orchestrator.test.ts +168 -168
  51. package/src/donation/__tests__/fake-orchestrator.ts +225 -225
  52. package/src/donation/__tests__/grant-service.test.ts +213 -213
  53. package/src/donation/__tests__/grant-store.test.ts +113 -113
  54. package/src/donation/donation-service.ts +962 -962
  55. package/src/donation/donation-store.ts +171 -171
  56. package/src/donation/donation-supervisor.ts +388 -388
  57. package/src/donation/grant-service.ts +200 -200
  58. package/src/donation/grant-store.ts +152 -152
  59. package/src/donation/index.ts +64 -64
  60. package/src/donation/types.ts +243 -243
  61. package/src/installer/__tests__/config.test.ts +134 -112
  62. package/src/installer/__tests__/identity.test.ts +34 -34
  63. package/src/installer/__tests__/paths.test.ts +47 -47
  64. package/src/installer/__tests__/service-host.test.ts +62 -62
  65. package/src/installer/__tests__/wizard.test.ts +64 -64
  66. package/src/installer/config.ts +5 -43
  67. package/src/installer/identity.ts +56 -49
  68. package/src/installer/paths.ts +109 -109
  69. package/src/installer/platform.ts +27 -27
  70. package/src/installer/service-host/index.ts +21 -21
  71. package/src/installer/service-host/template.ts +21 -21
  72. package/src/installer/wizard.ts +103 -103
  73. package/src/nat/__tests__/address-resolver.test.ts +82 -82
  74. package/src/nat/__tests__/ddns-duckdns.test.ts +83 -83
  75. package/src/nat/__tests__/ddns-updater.test.ts +253 -253
  76. package/src/nat/__tests__/external-ip.test.ts +124 -124
  77. package/src/nat/__tests__/nat-service.test.ts +18 -0
  78. package/src/nat/__tests__/nat-store.test.ts +93 -93
  79. package/src/nat/__tests__/port-mapper.test.ts +191 -191
  80. package/src/nat/__tests__/reachability.test.ts +24 -24
  81. package/src/nat/__tests__/secrets.test.ts +178 -178
  82. package/src/nat/address-resolver.ts +51 -51
  83. package/src/nat/ddns/duckdns.ts +76 -76
  84. package/src/nat/ddns/index.ts +55 -55
  85. package/src/nat/ddns/updater.ts +243 -243
  86. package/src/nat/external-ip.ts +154 -154
  87. package/src/nat/index.ts +71 -71
  88. package/src/nat/nat-service.ts +501 -501
  89. package/src/nat/nat-store.ts +154 -154
  90. package/src/nat/port-mapper.ts +329 -329
  91. package/src/nat/reachability.ts +34 -34
  92. package/src/nat/secrets/file-store.ts +130 -130
  93. package/src/nat/secrets/index.ts +112 -112
  94. package/src/nat/secrets/keytar-store.ts +67 -67
  95. package/src/nat/types.ts +159 -159
  96. package/src/orchestrator/__tests__/node-identity.test.ts +62 -62
  97. package/src/orchestrator/host-process-orchestrator.ts +9 -4
  98. package/src/orchestrator/index.ts +10 -10
  99. package/src/orchestrator/log-rotator.ts +53 -53
  100. package/src/orchestrator/node-identity.ts +40 -40
  101. package/src/orchestrator/pid-liveness.ts +24 -24
  102. package/src/orchestrator/port-allocator.ts +91 -91
  103. package/src/orchestrator/state-store.ts +90 -90
  104. package/src/orchestrator/types.ts +141 -141
  105. package/src/owner/__tests__/owner-node-client.test.ts +194 -194
  106. package/src/owner/index.ts +12 -12
  107. package/src/owner/owner-node-client.ts +259 -259
  108. package/src/push/__tests__/push.test.ts +90 -90
  109. package/src/push/index.ts +146 -146
  110. package/src/server/__tests__/bus.test.ts +38 -38
  111. package/src/server/__tests__/error-handler.test.ts +118 -118
  112. package/src/server/__tests__/grants-admin-route.test.ts +73 -73
  113. package/src/server/__tests__/grants-route.test.ts +263 -263
  114. package/src/server/__tests__/nodes-route.test.ts +259 -259
  115. package/src/server/__tests__/origin-guard.test.ts +72 -72
  116. package/src/server/__tests__/publishers.test.ts +216 -216
  117. package/src/server/__tests__/server.smoke.test.ts +253 -253
  118. package/src/server/__tests__/settings-route.test.ts +195 -194
  119. package/src/server/__tests__/sse-route.test.ts +119 -119
  120. package/src/server/__tests__/static.test.ts +145 -145
  121. package/src/server/__tests__/status-route.test.ts +134 -134
  122. package/src/server/__tests__/strands-route.test.ts +233 -233
  123. package/src/server/error-handler.ts +178 -178
  124. package/src/server/events/bus.ts +42 -42
  125. package/src/server/events/sse-route.ts +81 -81
  126. package/src/server/events/types.ts +23 -23
  127. package/src/server/index.ts +267 -267
  128. package/src/server/origin-guard.ts +84 -84
  129. package/src/server/routes/grants-admin.ts +41 -41
  130. package/src/server/routes/grants.ts +210 -210
  131. package/src/server/routes/nat.ts +63 -63
  132. package/src/server/routes/nodes.ts +170 -170
  133. package/src/server/routes/settings.ts +123 -123
  134. package/src/server/routes/status.ts +118 -118
  135. package/src/server/routes/strands.ts +54 -54
  136. package/src/server/routes/trust-circle.ts +49 -49
  137. package/src/server/routes/update.ts +43 -43
  138. package/src/server/server.ts +122 -122
  139. package/src/server/settings-store.ts +5 -1
  140. package/src/server/static.ts +207 -207
  141. package/src/strands/__tests__/strand-service.test.ts +165 -165
  142. package/src/strands/index.ts +14 -14
  143. package/src/strands/strand-service.ts +135 -135
  144. package/src/strands/types.ts +102 -102
  145. package/src/update/__tests__/apply.test.ts +158 -158
  146. package/src/update/__tests__/manifest.test.ts +128 -128
  147. package/src/update/__tests__/release-key.test.ts +42 -42
  148. package/src/update/__tests__/sign.test.ts +78 -78
  149. package/src/update/__tests__/store.test.ts +81 -81
  150. package/src/update/__tests__/update-service.integration.test.ts +256 -256
  151. package/src/update/__tests__/version.test.ts +31 -31
  152. package/src/update/apply.ts +190 -190
  153. package/src/update/index.ts +341 -341
  154. package/src/update/release-key.ts +71 -71
  155. package/src/update/sign.ts +74 -74
  156. package/src/update/store.ts +101 -101
  157. package/src/update/types.ts +109 -109
  158. package/src/update/version.ts +80 -80
@@ -1,170 +1,170 @@
1
- /**
2
- * /api/nodes — list managed cadre nodes, look up details, and control
3
- * lifecycle.
4
- *
5
- * Bus events for lifecycle transitions are emitted by the orchestrator's
6
- * `onStateChange` (forwarded by `createLocalUiServer.start`) — the route
7
- * handlers don't re-publish.
8
- *
9
- * start/restart are real for the admin's owner node (re-spawned from the
10
- * persisted `OwnerSpawnConfig`). Generic node lifecycle is owned by the
11
- * grantee-facing donation surface (`/grants`) — this route no longer spawns
12
- * generic nodes; start/restart of a known non-owner node points the caller
13
- * there. Stop works for any running node.
14
- */
15
-
16
- import { existsSync, openSync, readSync, closeSync, statSync } from 'node:fs';
17
-
18
- import type { FastifyInstance } from 'fastify';
19
-
20
- import type { HostProcessOrchestrator } from '../../orchestrator/index.js';
21
- import { defaultLogPath } from '../../orchestrator/log-rotator.js';
22
-
23
- const DEFAULT_LOG_LINES = 200;
24
- const MAX_LOG_LINES = 2000;
25
-
26
- export interface NodesRoutesOptions {
27
- orchestrator: HostProcessOrchestrator;
28
- }
29
-
30
- export function registerNodesRoutes(app: FastifyInstance, opts: NodesRoutesOptions): void {
31
- const { orchestrator } = opts;
32
-
33
- app.get('/api/nodes', async () => {
34
- return { ok: true, data: { nodes: orchestrator.listNodes() } };
35
- });
36
-
37
- app.get<{ Params: { id: string } }>('/api/nodes/:id', async (request, reply) => {
38
- const node = orchestrator.getNode(request.params.id);
39
- if (!node) {
40
- return reply.code(404).send({
41
- ok: false,
42
- error: { code: 'not_found', message: `Unknown node: ${request.params.id}` },
43
- });
44
- }
45
- let stats = null;
46
- try {
47
- stats = await orchestrator.getStats(node.dockerId);
48
- } catch {
49
- // Stats unavailable (dead process etc.) — surface null.
50
- }
51
- return { ok: true, data: { node, stats } };
52
- });
53
-
54
- app.get<{ Params: { id: string }; Querystring: { lines?: string } }>(
55
- '/api/nodes/:id/logs',
56
- async (request, reply) => {
57
- const node = orchestrator.getNode(request.params.id);
58
- if (!node) {
59
- return reply.code(404).send({
60
- ok: false,
61
- error: { code: 'not_found', message: `Unknown node: ${request.params.id}` },
62
- });
63
- }
64
- const requested = Number(request.query.lines ?? DEFAULT_LOG_LINES);
65
- const tail = Number.isFinite(requested)
66
- ? Math.max(1, Math.min(MAX_LOG_LINES, Math.floor(requested)))
67
- : DEFAULT_LOG_LINES;
68
- const lines = tailLogFile(defaultLogPath(node.workdir), tail);
69
- return { ok: true, data: { lines } };
70
- },
71
- );
72
-
73
- app.post<{ Params: { id: string } }>('/api/nodes/:id/stop', async (request, reply) => {
74
- const dockerId = orchestrator.resolveDockerId(request.params.id);
75
- if (!dockerId) {
76
- return reply.code(404).send({
77
- ok: false,
78
- error: { code: 'not_found', message: `Unknown node: ${request.params.id}` },
79
- });
80
- }
81
- await orchestrator.stopContainer(dockerId);
82
- // The orchestrator emits its own onStateChange — createLocalUiServer
83
- // forwards that to the bus. Don't double-publish here.
84
- return { ok: true };
85
- });
86
-
87
- // start / restart: real for the admin's owner node (spawned from the
88
- // persisted OwnerSpawnConfig). Generic node lifecycle now belongs to the
89
- // donation surface (/grants) — those ids return a clear not_implemented that
90
- // points there; unknown ids 404.
91
- app.post<{ Params: { id: string } }>('/api/nodes/:id/start', async (request, reply) => {
92
- const { id } = request.params;
93
- if (orchestrator.isOwnerNode(id)) {
94
- if (!orchestrator.hasOwnerConfig()) {
95
- return notImplemented(reply, `start ${id}: owner node has no saved spawn config.`);
96
- }
97
- const node = await orchestrator.ensureOwnerNode();
98
- return { ok: true, data: { node } };
99
- }
100
- return startRestartFallback(reply, orchestrator, id, 'start');
101
- });
102
-
103
- app.post<{ Params: { id: string } }>('/api/nodes/:id/restart', async (request, reply) => {
104
- const { id } = request.params;
105
- if (orchestrator.isOwnerNode(id)) {
106
- if (!orchestrator.hasOwnerConfig()) {
107
- return notImplemented(reply, `restart ${id}: owner node has no saved spawn config.`);
108
- }
109
- const node = await orchestrator.restartOwnerNode();
110
- return { ok: true, data: { node } };
111
- }
112
- return startRestartFallback(reply, orchestrator, id, 'restart');
113
- });
114
- }
115
-
116
- /** 404 for unknown ids; 501 not_implemented for known non-owner nodes. */
117
- function startRestartFallback(
118
- reply: import('fastify').FastifyReply,
119
- orchestrator: HostProcessOrchestrator,
120
- id: string,
121
- verb: string,
122
- ) {
123
- if (!orchestrator.getNode(id)) {
124
- return reply.code(404).send({
125
- ok: false,
126
- error: { code: 'not_found', message: `Unknown node: ${id}` },
127
- });
128
- }
129
- return notImplemented(
130
- reply,
131
- `${verb} ${id}: only the owner node is start/restart-able here; generic donated-node lifecycle is owned by the donation surface — use POST /grants to provision and DELETE /grants/:id to terminate.`,
132
- );
133
- }
134
-
135
- function notImplemented(reply: import('fastify').FastifyReply, message: string) {
136
- return reply.code(501).send({ ok: false, error: { code: 'not_implemented', message } });
137
- }
138
-
139
- /**
140
- * Read the last `n` lines from a log file by walking the tail in chunks.
141
- * Returns [] for a missing file.
142
- */
143
- export function tailLogFile(path: string, n: number): string[] {
144
- if (!existsSync(path)) return [];
145
- const fd = openSync(path, 'r');
146
- try {
147
- const size = statSync(path).size;
148
- const chunkSize = 8192;
149
- let pos = size;
150
- const buffers: Buffer[] = [];
151
- let newlineCount = 0;
152
- while (pos > 0 && newlineCount <= n) {
153
- const readLen = Math.min(chunkSize, pos);
154
- pos -= readLen;
155
- const buf = Buffer.alloc(readLen);
156
- readSync(fd, buf, 0, readLen, pos);
157
- buffers.unshift(buf);
158
- for (let i = 0; i < buf.length; i++) {
159
- if (buf[i] === 0x0a) newlineCount++;
160
- }
161
- }
162
- const joined = Buffer.concat(buffers).toString('utf8');
163
- const lines = joined.split('\n');
164
- const trimmed = lines[lines.length - 1] === '' ? lines.slice(0, -1) : lines;
165
- return trimmed.slice(-n);
166
- } finally {
167
- closeSync(fd);
168
- }
169
- }
170
-
1
+ /**
2
+ * /api/nodes — list managed cadre nodes, look up details, and control
3
+ * lifecycle.
4
+ *
5
+ * Bus events for lifecycle transitions are emitted by the orchestrator's
6
+ * `onStateChange` (forwarded by `createLocalUiServer.start`) — the route
7
+ * handlers don't re-publish.
8
+ *
9
+ * start/restart are real for the admin's owner node (re-spawned from the
10
+ * persisted `OwnerSpawnConfig`). Generic node lifecycle is owned by the
11
+ * grantee-facing donation surface (`/grants`) — this route no longer spawns
12
+ * generic nodes; start/restart of a known non-owner node points the caller
13
+ * there. Stop works for any running node.
14
+ */
15
+
16
+ import { existsSync, openSync, readSync, closeSync, statSync } from 'node:fs';
17
+
18
+ import type { FastifyInstance } from 'fastify';
19
+
20
+ import type { HostProcessOrchestrator } from '../../orchestrator/index.js';
21
+ import { defaultLogPath } from '../../orchestrator/log-rotator.js';
22
+
23
+ const DEFAULT_LOG_LINES = 200;
24
+ const MAX_LOG_LINES = 2000;
25
+
26
+ export interface NodesRoutesOptions {
27
+ orchestrator: HostProcessOrchestrator;
28
+ }
29
+
30
+ export function registerNodesRoutes(app: FastifyInstance, opts: NodesRoutesOptions): void {
31
+ const { orchestrator } = opts;
32
+
33
+ app.get('/api/nodes', async () => {
34
+ return { ok: true, data: { nodes: orchestrator.listNodes() } };
35
+ });
36
+
37
+ app.get<{ Params: { id: string } }>('/api/nodes/:id', async (request, reply) => {
38
+ const node = orchestrator.getNode(request.params.id);
39
+ if (!node) {
40
+ return reply.code(404).send({
41
+ ok: false,
42
+ error: { code: 'not_found', message: `Unknown node: ${request.params.id}` },
43
+ });
44
+ }
45
+ let stats = null;
46
+ try {
47
+ stats = await orchestrator.getStats(node.dockerId);
48
+ } catch {
49
+ // Stats unavailable (dead process etc.) — surface null.
50
+ }
51
+ return { ok: true, data: { node, stats } };
52
+ });
53
+
54
+ app.get<{ Params: { id: string }; Querystring: { lines?: string } }>(
55
+ '/api/nodes/:id/logs',
56
+ async (request, reply) => {
57
+ const node = orchestrator.getNode(request.params.id);
58
+ if (!node) {
59
+ return reply.code(404).send({
60
+ ok: false,
61
+ error: { code: 'not_found', message: `Unknown node: ${request.params.id}` },
62
+ });
63
+ }
64
+ const requested = Number(request.query.lines ?? DEFAULT_LOG_LINES);
65
+ const tail = Number.isFinite(requested)
66
+ ? Math.max(1, Math.min(MAX_LOG_LINES, Math.floor(requested)))
67
+ : DEFAULT_LOG_LINES;
68
+ const lines = tailLogFile(defaultLogPath(node.workdir), tail);
69
+ return { ok: true, data: { lines } };
70
+ },
71
+ );
72
+
73
+ app.post<{ Params: { id: string } }>('/api/nodes/:id/stop', async (request, reply) => {
74
+ const dockerId = orchestrator.resolveDockerId(request.params.id);
75
+ if (!dockerId) {
76
+ return reply.code(404).send({
77
+ ok: false,
78
+ error: { code: 'not_found', message: `Unknown node: ${request.params.id}` },
79
+ });
80
+ }
81
+ await orchestrator.stopContainer(dockerId);
82
+ // The orchestrator emits its own onStateChange — createLocalUiServer
83
+ // forwards that to the bus. Don't double-publish here.
84
+ return { ok: true };
85
+ });
86
+
87
+ // start / restart: real for the admin's owner node (spawned from the
88
+ // persisted OwnerSpawnConfig). Generic node lifecycle now belongs to the
89
+ // donation surface (/grants) — those ids return a clear not_implemented that
90
+ // points there; unknown ids 404.
91
+ app.post<{ Params: { id: string } }>('/api/nodes/:id/start', async (request, reply) => {
92
+ const { id } = request.params;
93
+ if (orchestrator.isOwnerNode(id)) {
94
+ if (!orchestrator.hasOwnerConfig()) {
95
+ return notImplemented(reply, `start ${id}: owner node has no saved spawn config.`);
96
+ }
97
+ const node = await orchestrator.ensureOwnerNode();
98
+ return { ok: true, data: { node } };
99
+ }
100
+ return startRestartFallback(reply, orchestrator, id, 'start');
101
+ });
102
+
103
+ app.post<{ Params: { id: string } }>('/api/nodes/:id/restart', async (request, reply) => {
104
+ const { id } = request.params;
105
+ if (orchestrator.isOwnerNode(id)) {
106
+ if (!orchestrator.hasOwnerConfig()) {
107
+ return notImplemented(reply, `restart ${id}: owner node has no saved spawn config.`);
108
+ }
109
+ const node = await orchestrator.restartOwnerNode();
110
+ return { ok: true, data: { node } };
111
+ }
112
+ return startRestartFallback(reply, orchestrator, id, 'restart');
113
+ });
114
+ }
115
+
116
+ /** 404 for unknown ids; 501 not_implemented for known non-owner nodes. */
117
+ function startRestartFallback(
118
+ reply: import('fastify').FastifyReply,
119
+ orchestrator: HostProcessOrchestrator,
120
+ id: string,
121
+ verb: string,
122
+ ) {
123
+ if (!orchestrator.getNode(id)) {
124
+ return reply.code(404).send({
125
+ ok: false,
126
+ error: { code: 'not_found', message: `Unknown node: ${id}` },
127
+ });
128
+ }
129
+ return notImplemented(
130
+ reply,
131
+ `${verb} ${id}: only the owner node is start/restart-able here; generic donated-node lifecycle is owned by the donation surface — use POST /grants to provision and DELETE /grants/:id to terminate.`,
132
+ );
133
+ }
134
+
135
+ function notImplemented(reply: import('fastify').FastifyReply, message: string) {
136
+ return reply.code(501).send({ ok: false, error: { code: 'not_implemented', message } });
137
+ }
138
+
139
+ /**
140
+ * Read the last `n` lines from a log file by walking the tail in chunks.
141
+ * Returns [] for a missing file.
142
+ */
143
+ export function tailLogFile(path: string, n: number): string[] {
144
+ if (!existsSync(path)) return [];
145
+ const fd = openSync(path, 'r');
146
+ try {
147
+ const size = statSync(path).size;
148
+ const chunkSize = 8192;
149
+ let pos = size;
150
+ const buffers: Buffer[] = [];
151
+ let newlineCount = 0;
152
+ while (pos > 0 && newlineCount <= n) {
153
+ const readLen = Math.min(chunkSize, pos);
154
+ pos -= readLen;
155
+ const buf = Buffer.alloc(readLen);
156
+ readSync(fd, buf, 0, readLen, pos);
157
+ buffers.unshift(buf);
158
+ for (let i = 0; i < buf.length; i++) {
159
+ if (buf[i] === 0x0a) newlineCount++;
160
+ }
161
+ }
162
+ const joined = Buffer.concat(buffers).toString('utf8');
163
+ const lines = joined.split('\n');
164
+ const trimmed = lines[lines.length - 1] === '' ? lines.slice(0, -1) : lines;
165
+ return trimmed.slice(-n);
166
+ } finally {
167
+ closeSync(fd);
168
+ }
169
+ }
170
+
@@ -1,123 +1,123 @@
1
- /**
2
- * /api/settings — host-level settings UI surface.
3
- *
4
- * The persisted shape is `host.config.json` (managed by the installer).
5
- * This route is a thin passthrough plus a write-whitelist:
6
- *
7
- * - uiPort rejected (restart required; only edit at install time)
8
- * - libp2pPort rejected (restart required)
9
- * - upnpEnabled accepted → also propagated to NatService.putSettings
10
- * - updates.autoApply accepted → propagated to UpdateService.putSettings
11
- * - updates.manifestUrl accepted → propagated to UpdateService.putSettings
12
- * - anything else 400 invalid_setting
13
- *
14
- * GET returns the full `HostConfigFile` (the SPA wants the full shape so it
15
- * can render a read-only view of the rejected keys).
16
- */
17
-
18
- import type { FastifyInstance } from 'fastify';
19
-
20
- import type { NatService } from '../../nat/index.js';
21
- import type { UpdateService } from '../../update/index.js';
22
- import type { HostSettingsStore } from '../settings-store.js';
23
-
24
- const FORBIDDEN_KEYS = new Set<string>(['uiPort', 'libp2pPort', 'dataDir', 'identityPath', 'installId', 'installedAt', 'installerVersion', 'version', 'ownCadre']);
25
-
26
- const WRITABLE_TOP_KEYS = new Set<string>(['upnpEnabled', 'updates']);
27
- const WRITABLE_UPDATES_KEYS = new Set<string>(['autoApply', 'manifestUrl']);
28
-
29
- export interface SettingsRoutesOptions {
30
- settingsStore: HostSettingsStore;
31
- /**
32
- * Present only when the host runs its own personal cadre. In donor-only mode
33
- * an `upnpEnabled` write still persists to host.config.json but has no running
34
- * NatService to propagate into.
35
- */
36
- nat?: NatService;
37
- update?: UpdateService;
38
- }
39
-
40
- export function registerSettingsRoutes(app: FastifyInstance, opts: SettingsRoutesOptions): void {
41
- const { settingsStore, nat, update } = opts;
42
-
43
- app.get('/api/settings', async () => {
44
- return { ok: true, data: settingsStore.read() };
45
- });
46
-
47
- app.put('/api/settings', async (request, reply) => {
48
- const body = (request.body ?? {}) as Record<string, unknown>;
49
- const validation = validatePatch(body);
50
- if (validation.error) {
51
- return reply.code(400).send({
52
- ok: false,
53
- error: { code: 'invalid_setting', message: validation.error },
54
- });
55
- }
56
-
57
- const current = settingsStore.read();
58
- const patch: { upnpEnabled?: boolean; updates?: typeof current.updates } = {};
59
-
60
- if ('upnpEnabled' in body) {
61
- patch.upnpEnabled = body.upnpEnabled as boolean;
62
- // Propagate UPnP toggle into the running NatService so the change
63
- // takes effect immediately. NatService persists into nat.json — that's
64
- // independent of host.config.json's `upnpEnabled` (which the installer
65
- // uses on first run to seed nat.json). Update both for consistency.
66
- // In donor-only mode there is no NatService — the write still persists.
67
- if (nat) {
68
- await nat.putSettings({ upnpEnabled: body.upnpEnabled as boolean });
69
- }
70
- }
71
- if ('updates' in body) {
72
- const updates = body.updates as { autoApply?: boolean; manifestUrl?: string };
73
- const nextUpdates = { ...current.updates };
74
- if ('autoApply' in updates) nextUpdates.autoApply = updates.autoApply as boolean;
75
- if ('manifestUrl' in updates) nextUpdates.manifestUrl = updates.manifestUrl as string;
76
- patch.updates = nextUpdates;
77
- if (update) {
78
- const propagate: { autoApply?: boolean; manifestUrl?: string } = {};
79
- if ('autoApply' in updates) propagate.autoApply = updates.autoApply as boolean;
80
- if ('manifestUrl' in updates) propagate.manifestUrl = updates.manifestUrl as string;
81
- await update.putSettings(propagate);
82
- }
83
- }
84
-
85
- const next = settingsStore.update(patch);
86
- return { ok: true, data: next };
87
- });
88
- }
89
-
90
- function validatePatch(body: Record<string, unknown>): { error?: string } {
91
- for (const key of Object.keys(body)) {
92
- if (FORBIDDEN_KEYS.has(key)) {
93
- return { error: `Setting "${key}" is not editable at runtime; change it in host.config.json and restart cadre-host.` };
94
- }
95
- if (!WRITABLE_TOP_KEYS.has(key)) {
96
- return { error: `Unknown setting "${key}"` };
97
- }
98
- }
99
- if ('upnpEnabled' in body && typeof body.upnpEnabled !== 'boolean') {
100
- return { error: '"upnpEnabled" must be a boolean' };
101
- }
102
- if ('updates' in body) {
103
- if (!body.updates || typeof body.updates !== 'object') {
104
- return { error: '"updates" must be an object' };
105
- }
106
- const updates = body.updates as Record<string, unknown>;
107
- for (const key of Object.keys(updates)) {
108
- if (!WRITABLE_UPDATES_KEYS.has(key)) {
109
- return { error: `Unknown setting "updates.${key}"` };
110
- }
111
- }
112
- if ('autoApply' in updates && typeof updates.autoApply !== 'boolean') {
113
- return { error: '"updates.autoApply" must be a boolean' };
114
- }
115
- if (
116
- 'manifestUrl' in updates &&
117
- typeof updates.manifestUrl !== 'string'
118
- ) {
119
- return { error: '"updates.manifestUrl" must be a string' };
120
- }
121
- }
122
- return {};
123
- }
1
+ /**
2
+ * /api/settings — host-level settings UI surface.
3
+ *
4
+ * The persisted shape is `host.config.json` (managed by the installer).
5
+ * This route is a thin passthrough plus a write-whitelist:
6
+ *
7
+ * - uiPort rejected (restart required; only edit at install time)
8
+ * - libp2pPort rejected (restart required)
9
+ * - upnpEnabled accepted → also propagated to NatService.putSettings
10
+ * - updates.autoApply accepted → propagated to UpdateService.putSettings
11
+ * - updates.manifestUrl accepted → propagated to UpdateService.putSettings
12
+ * - anything else 400 invalid_setting
13
+ *
14
+ * GET returns the full `HostConfigFile` (the SPA wants the full shape so it
15
+ * can render a read-only view of the rejected keys).
16
+ */
17
+
18
+ import type { FastifyInstance } from 'fastify';
19
+
20
+ import type { NatService } from '../../nat/index.js';
21
+ import type { UpdateService } from '../../update/index.js';
22
+ import type { HostSettingsStore } from '../settings-store.js';
23
+
24
+ const FORBIDDEN_KEYS = new Set<string>(['uiPort', 'libp2pPort', 'dataDir', 'identityPath', 'installId', 'installedAt', 'installerVersion', 'version', 'ownCadre']);
25
+
26
+ const WRITABLE_TOP_KEYS = new Set<string>(['upnpEnabled', 'updates']);
27
+ const WRITABLE_UPDATES_KEYS = new Set<string>(['autoApply', 'manifestUrl']);
28
+
29
+ export interface SettingsRoutesOptions {
30
+ settingsStore: HostSettingsStore;
31
+ /**
32
+ * Present only when the host runs its own personal cadre. In donor-only mode
33
+ * an `upnpEnabled` write still persists to host.config.json but has no running
34
+ * NatService to propagate into.
35
+ */
36
+ nat?: NatService;
37
+ update?: UpdateService;
38
+ }
39
+
40
+ export function registerSettingsRoutes(app: FastifyInstance, opts: SettingsRoutesOptions): void {
41
+ const { settingsStore, nat, update } = opts;
42
+
43
+ app.get('/api/settings', async () => {
44
+ return { ok: true, data: settingsStore.read() };
45
+ });
46
+
47
+ app.put('/api/settings', async (request, reply) => {
48
+ const body = (request.body ?? {}) as Record<string, unknown>;
49
+ const validation = validatePatch(body);
50
+ if (validation.error) {
51
+ return reply.code(400).send({
52
+ ok: false,
53
+ error: { code: 'invalid_setting', message: validation.error },
54
+ });
55
+ }
56
+
57
+ const current = settingsStore.read();
58
+ const patch: { upnpEnabled?: boolean; updates?: typeof current.updates } = {};
59
+
60
+ if ('upnpEnabled' in body) {
61
+ patch.upnpEnabled = body.upnpEnabled as boolean;
62
+ // Propagate UPnP toggle into the running NatService so the change
63
+ // takes effect immediately. NatService persists into nat.json — that's
64
+ // independent of host.config.json's `upnpEnabled` (which the installer
65
+ // uses on first run to seed nat.json). Update both for consistency.
66
+ // In donor-only mode there is no NatService — the write still persists.
67
+ if (nat) {
68
+ await nat.putSettings({ upnpEnabled: body.upnpEnabled as boolean });
69
+ }
70
+ }
71
+ if ('updates' in body) {
72
+ const updates = body.updates as { autoApply?: boolean; manifestUrl?: string };
73
+ const nextUpdates = { ...current.updates };
74
+ if ('autoApply' in updates) nextUpdates.autoApply = updates.autoApply as boolean;
75
+ if ('manifestUrl' in updates) nextUpdates.manifestUrl = updates.manifestUrl as string;
76
+ patch.updates = nextUpdates;
77
+ if (update) {
78
+ const propagate: { autoApply?: boolean; manifestUrl?: string } = {};
79
+ if ('autoApply' in updates) propagate.autoApply = updates.autoApply as boolean;
80
+ if ('manifestUrl' in updates) propagate.manifestUrl = updates.manifestUrl as string;
81
+ await update.putSettings(propagate);
82
+ }
83
+ }
84
+
85
+ const next = settingsStore.update(patch);
86
+ return { ok: true, data: next };
87
+ });
88
+ }
89
+
90
+ function validatePatch(body: Record<string, unknown>): { error?: string } {
91
+ for (const key of Object.keys(body)) {
92
+ if (FORBIDDEN_KEYS.has(key)) {
93
+ return { error: `Setting "${key}" is not editable at runtime; change it in host.config.json and restart cadre-host.` };
94
+ }
95
+ if (!WRITABLE_TOP_KEYS.has(key)) {
96
+ return { error: `Unknown setting "${key}"` };
97
+ }
98
+ }
99
+ if ('upnpEnabled' in body && typeof body.upnpEnabled !== 'boolean') {
100
+ return { error: '"upnpEnabled" must be a boolean' };
101
+ }
102
+ if ('updates' in body) {
103
+ if (!body.updates || typeof body.updates !== 'object') {
104
+ return { error: '"updates" must be an object' };
105
+ }
106
+ const updates = body.updates as Record<string, unknown>;
107
+ for (const key of Object.keys(updates)) {
108
+ if (!WRITABLE_UPDATES_KEYS.has(key)) {
109
+ return { error: `Unknown setting "updates.${key}"` };
110
+ }
111
+ }
112
+ if ('autoApply' in updates && typeof updates.autoApply !== 'boolean') {
113
+ return { error: '"updates.autoApply" must be a boolean' };
114
+ }
115
+ if (
116
+ 'manifestUrl' in updates &&
117
+ typeof updates.manifestUrl !== 'string'
118
+ ) {
119
+ return { error: '"updates.manifestUrl" must be a string' };
120
+ }
121
+ }
122
+ return {};
123
+ }