@tellagen/mcp-server 0.4.1 → 0.5.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 (180) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +335 -102
  3. package/SKILL.md +183 -27
  4. package/contracts/mcp-protocol.json +155 -0
  5. package/contracts/runbooks/manifest.json +26 -6
  6. package/contracts/runbooks/v2/cause-lead.guidance.json +37 -0
  7. package/contracts/runbooks/v2/client-protocol.json +926 -0
  8. package/contracts/runbooks/v2/client-writes.guidance.json +42 -0
  9. package/contracts/runbooks/v2/fixtures/timeline-event-blocks-rejected.json +30 -5
  10. package/contracts/runbooks/v2/result-summary.guidance.json +21 -0
  11. package/contracts/runbooks/v2/timeline-event-blocks.schema.json +18 -11
  12. package/contracts/tellagen-runbook-contracts.json +4 -4
  13. package/dist/active-run.d.ts +29 -0
  14. package/dist/active-run.js +67 -0
  15. package/dist/active-run.js.map +1 -0
  16. package/dist/bootstrap.d.ts +20 -0
  17. package/dist/bootstrap.js +29 -0
  18. package/dist/bootstrap.js.map +1 -0
  19. package/dist/cause-lead.d.ts +25 -0
  20. package/dist/cause-lead.js +145 -0
  21. package/dist/cause-lead.js.map +1 -0
  22. package/dist/cli/auth.d.ts +22 -0
  23. package/dist/cli/auth.js +207 -0
  24. package/dist/cli/auth.js.map +1 -0
  25. package/dist/cli/io.d.ts +16 -0
  26. package/dist/cli/io.js +53 -0
  27. package/dist/cli/io.js.map +1 -0
  28. package/dist/cli/listen-guard.d.ts +12 -0
  29. package/dist/cli/listen-guard.js +50 -0
  30. package/dist/cli/listen-guard.js.map +1 -0
  31. package/dist/cli/listen.d.ts +28 -0
  32. package/dist/cli/listen.js +205 -0
  33. package/dist/cli/listen.js.map +1 -0
  34. package/dist/cli/main.d.ts +3 -0
  35. package/dist/cli/main.js +53 -0
  36. package/dist/cli/main.js.map +1 -0
  37. package/dist/cli/trace-hook.d.ts +23 -0
  38. package/dist/cli/trace-hook.js +99 -0
  39. package/dist/cli/trace-hook.js.map +1 -0
  40. package/dist/client.d.ts +92 -6
  41. package/dist/client.js +300 -23
  42. package/dist/client.js.map +1 -1
  43. package/dist/config.d.ts +17 -0
  44. package/dist/config.js +38 -0
  45. package/dist/config.js.map +1 -0
  46. package/dist/credentials.d.ts +120 -0
  47. package/dist/credentials.js +363 -0
  48. package/dist/credentials.js.map +1 -0
  49. package/dist/diagnosis-structure.d.ts +207 -147
  50. package/dist/diagnosis-structure.js +143 -2
  51. package/dist/diagnosis-structure.js.map +1 -1
  52. package/dist/diff-figure.d.ts +56 -0
  53. package/dist/diff-figure.js +276 -0
  54. package/dist/diff-figure.js.map +1 -0
  55. package/dist/errors.d.ts +21 -0
  56. package/dist/errors.js +60 -0
  57. package/dist/errors.js.map +1 -1
  58. package/dist/figures.d.ts +281 -201
  59. package/dist/figures.js +189 -47
  60. package/dist/figures.js.map +1 -1
  61. package/dist/guide-resources.d.ts +28 -0
  62. package/dist/guide-resources.js +81 -0
  63. package/dist/guide-resources.js.map +1 -0
  64. package/dist/heartbeat.d.ts +24 -0
  65. package/dist/heartbeat.js +94 -0
  66. package/dist/heartbeat.js.map +1 -0
  67. package/dist/home.d.ts +8 -0
  68. package/dist/home.js +14 -0
  69. package/dist/home.js.map +1 -0
  70. package/dist/identity.d.ts +32 -0
  71. package/dist/identity.js +83 -0
  72. package/dist/identity.js.map +1 -0
  73. package/dist/index.js +46 -14
  74. package/dist/index.js.map +1 -1
  75. package/dist/listen-config.d.ts +67 -0
  76. package/dist/listen-config.js +83 -0
  77. package/dist/listen-config.js.map +1 -0
  78. package/dist/listen-probe.d.ts +57 -0
  79. package/dist/listen-probe.js +158 -0
  80. package/dist/listen-probe.js.map +1 -0
  81. package/dist/listen-rules.d.ts +88 -0
  82. package/dist/listen-rules.js +252 -0
  83. package/dist/listen-rules.js.map +1 -0
  84. package/dist/listen-settings.d.ts +18 -0
  85. package/dist/listen-settings.js +50 -0
  86. package/dist/listen-settings.js.map +1 -0
  87. package/dist/listen-wrap.d.ts +21 -0
  88. package/dist/listen-wrap.js +52 -0
  89. package/dist/listen-wrap.js.map +1 -0
  90. package/dist/listener.d.ts +195 -0
  91. package/dist/listener.js +600 -0
  92. package/dist/listener.js.map +1 -0
  93. package/dist/open-run.d.ts +2 -0
  94. package/dist/open-run.js +5 -0
  95. package/dist/open-run.js.map +1 -0
  96. package/dist/prompts.d.ts +12 -0
  97. package/dist/prompts.js +37 -0
  98. package/dist/prompts.js.map +1 -0
  99. package/dist/redact.d.ts +13 -0
  100. package/dist/redact.js +76 -0
  101. package/dist/redact.js.map +1 -0
  102. package/dist/run-events.d.ts +54 -0
  103. package/dist/run-events.js +210 -0
  104. package/dist/run-events.js.map +1 -0
  105. package/dist/run-state.d.ts +184 -0
  106. package/dist/run-state.js +207 -0
  107. package/dist/run-state.js.map +1 -0
  108. package/dist/server.d.ts +22 -2
  109. package/dist/server.js +137 -29
  110. package/dist/server.js.map +1 -1
  111. package/dist/session.d.ts +86 -0
  112. package/dist/session.js +155 -0
  113. package/dist/session.js.map +1 -0
  114. package/dist/shell-rules.d.ts +49 -0
  115. package/dist/shell-rules.js +335 -0
  116. package/dist/shell-rules.js.map +1 -0
  117. package/dist/signin-index.d.ts +164 -0
  118. package/dist/signin-index.js +116 -0
  119. package/dist/signin-index.js.map +1 -0
  120. package/dist/signin.d.ts +169 -0
  121. package/dist/signin.js +541 -0
  122. package/dist/signin.js.map +1 -0
  123. package/dist/start.d.ts +7 -6
  124. package/dist/start.js +14 -7
  125. package/dist/start.js.map +1 -1
  126. package/dist/tools/catalog.d.ts +44 -0
  127. package/dist/tools/catalog.js +105 -0
  128. package/dist/tools/catalog.js.map +1 -0
  129. package/dist/tools/causes.d.ts +6 -6
  130. package/dist/tools/causes.js +4 -5
  131. package/dist/tools/causes.js.map +1 -1
  132. package/dist/tools/context.js +5 -5
  133. package/dist/tools/context.js.map +1 -1
  134. package/dist/tools/datasources.js +1 -1
  135. package/dist/tools/datasources.js.map +1 -1
  136. package/dist/tools/diagnostics.js +2 -2
  137. package/dist/tools/diagnostics.js.map +1 -1
  138. package/dist/tools/figures.d.ts +3 -2
  139. package/dist/tools/figures.js +38 -13
  140. package/dist/tools/figures.js.map +1 -1
  141. package/dist/tools/findings.d.ts +28 -0
  142. package/dist/tools/findings.js +88 -24
  143. package/dist/tools/findings.js.map +1 -1
  144. package/dist/tools/incidents.js +5 -5
  145. package/dist/tools/incidents.js.map +1 -1
  146. package/dist/tools/index.d.ts +19 -2
  147. package/dist/tools/index.js +115 -14
  148. package/dist/tools/index.js.map +1 -1
  149. package/dist/tools/investigations.d.ts +54 -0
  150. package/dist/tools/investigations.js +370 -69
  151. package/dist/tools/investigations.js.map +1 -1
  152. package/dist/tools/next.d.ts +20 -0
  153. package/dist/tools/next.js +136 -0
  154. package/dist/tools/next.js.map +1 -0
  155. package/dist/tools/postmortem-runbooks.d.ts +52 -52
  156. package/dist/tools/postmortem-runbooks.js +3 -10
  157. package/dist/tools/postmortem-runbooks.js.map +1 -1
  158. package/dist/tools/resume.d.ts +5 -0
  159. package/dist/tools/resume.js +136 -0
  160. package/dist/tools/resume.js.map +1 -0
  161. package/dist/tools/signin.d.ts +12 -0
  162. package/dist/tools/signin.js +54 -0
  163. package/dist/tools/signin.js.map +1 -0
  164. package/dist/tools/source-links.js +5 -3
  165. package/dist/tools/source-links.js.map +1 -1
  166. package/dist/tools/timeline.js +57 -11
  167. package/dist/tools/timeline.js.map +1 -1
  168. package/dist/trace-record.d.ts +36 -0
  169. package/dist/trace-record.js +283 -0
  170. package/dist/trace-record.js.map +1 -0
  171. package/dist/version.d.ts +10 -2
  172. package/dist/version.js +20 -1
  173. package/dist/version.js.map +1 -1
  174. package/package.json +23 -3
  175. package/server.json +5 -5
  176. package/contracts/runbooks/v1/fixtures/global-runbook.json +0 -7
  177. package/contracts/runbooks/v1/runbook-definition.schema.json +0 -25
  178. package/dist/auth.d.ts +0 -7
  179. package/dist/auth.js +0 -19
  180. package/dist/auth.js.map +0 -1
package/dist/client.js CHANGED
@@ -1,4 +1,89 @@
1
- import { TellagenAPIError } from "./errors.js";
1
+ import { TellagenAPIError, TellagenSetupError } from "./errors.js";
2
+ import { Session } from "./session.js";
3
+ /**
4
+ * Timeouts and retries of every Tellagen call. One object, so a test can
5
+ * shorten the delays without a setting that a person could see.
6
+ */
7
+ export const httpDefaults = {
8
+ /** How long one attempt may take. */
9
+ timeoutMs: 30_000,
10
+ /** How long an attempt that sends screenshots may take. */
11
+ uploadTimeoutMs: 120_000,
12
+ /** How long one call may take with all its repeats and waits. */
13
+ totalMs: 60_000,
14
+ /** The same for a call that sends screenshots. */
15
+ uploadTotalMs: 150_000,
16
+ /** Repeats after the first attempt. */
17
+ retries: 3,
18
+ /** The first delay; each repeat doubles it. */
19
+ baseDelayMs: 500,
20
+ /** The longest delay, also for a Retry-After header. */
21
+ maxDelayMs: 30_000,
22
+ /** How long a refused key is trusted to be still refused. */
23
+ authRecheckMs: 15_000,
24
+ };
25
+ const RETRY_STATUSES = new Set([429, 502, 503, 504]);
26
+ const KEY_STEPS = [
27
+ "Easiest: call tellagen_sign_in and tell the person the code and the address it returns. They approve in the browser. There is no key to copy.",
28
+ "Or in Tellagen, open Settings > API Keys and create a key with the incidents:read and incidents:write scopes.",
29
+ "Put the key in TELLAGEN_API_KEY and the API address (for example https://yourcompany.api.tellagen.com) in TELLAGEN_API_URL, in the env block of this MCP server in your client's configuration.",
30
+ "Restart the client, or reconnect this MCP server.",
31
+ ];
32
+ /** The setup error for a missing key or address. It names no value. */
33
+ export function missingSetupError(missing) {
34
+ return new TellagenSetupError("tellagen_not_set_up", `Tellagen is not set up in this client: ${missing.join(" and ")} ${missing.length === 1 ? "is" : "are"} not set. Tell the person the steps in setup_steps. No Tellagen tool works until they are done.`, KEY_STEPS);
35
+ }
36
+ /**
37
+ * Rewrites an answer that means "a person must fix the access" into a clear
38
+ * message with the fix. Other errors pass unchanged.
39
+ */
40
+ function accessError(err) {
41
+ const payload = { ...(err.payload ?? {}) };
42
+ if (err.status === 401) {
43
+ const expired = /expired/i.test(err.code);
44
+ const message = expired
45
+ ? "Tellagen refused the API key because it has expired (HTTP 401)."
46
+ : "Tellagen refused the API key (HTTP 401). The key is wrong, was revoked or has expired.";
47
+ return new TellagenAPIError(401, expired ? err.code : err.code === "unknown" ? "api_key_refused" : err.code, `${message} Tell the person the steps in setup_steps.`, {
48
+ ...payload,
49
+ setup_steps: [
50
+ "If the person signed in with the browser, call tellagen_sign_in with restart true.",
51
+ "Otherwise in Tellagen, open Settings > API Keys and create a new key with the incidents:read and incidents:write scopes.",
52
+ "Replace the value of TELLAGEN_API_KEY in the env block of this MCP server, and check that TELLAGEN_API_URL is the API address of the same workspace.",
53
+ "Restart the client, or reconnect this MCP server.",
54
+ ],
55
+ });
56
+ }
57
+ if (err.status === 403 && err.code === "seat_access_suspended") {
58
+ return new TellagenAPIError(403, err.code, `${err.message} The API key belongs to a person whose seat in this workspace is paused, so Tellagen refuses its calls. Tell the person the steps in setup_steps.`, {
59
+ ...payload,
60
+ setup_steps: [
61
+ "Ask a workspace admin to restore the seat in Tellagen, under Settings > Members, or to change the plan.",
62
+ "Then call the tool again. The key itself does not need to change.",
63
+ ],
64
+ });
65
+ }
66
+ if (err.status === 403 && err.code === "company_disabled") {
67
+ return new TellagenAPIError(403, err.code, `${err.message} Tellagen refuses every call of this workspace until it is active again. Tell the person the steps in setup_steps.`, {
68
+ ...payload,
69
+ setup_steps: ["Ask the workspace owner to contact Tellagen support.", "Then call the tool again."],
70
+ });
71
+ }
72
+ return undefined;
73
+ }
74
+ function retryAfterMs(res) {
75
+ const value = res.headers.get("retry-after");
76
+ if (!value)
77
+ return undefined;
78
+ const seconds = Number(value);
79
+ if (Number.isFinite(seconds) && seconds >= 0)
80
+ return seconds * 1000;
81
+ const date = Date.parse(value);
82
+ if (Number.isFinite(date))
83
+ return Math.max(0, date - Date.now());
84
+ return undefined;
85
+ }
86
+ const sleep = (ms) => ms <= 0 ? Promise.resolve() : new Promise((resolve) => setTimeout(resolve, ms));
2
87
  /** The API error of a response that is not ok, from its JSON body when it has one. */
3
88
  async function apiError(res) {
4
89
  let code = "unknown";
@@ -8,15 +93,30 @@ async function apiError(res) {
8
93
  const candidate = (await res.json());
9
94
  if (candidate && typeof candidate === "object" && !Array.isArray(candidate)) {
10
95
  payload = candidate;
96
+ // Two shapes exist: {code, message} and {error: {code, message, field}}.
97
+ const nested = payload.error && typeof payload.error === "object" && !Array.isArray(payload.error)
98
+ ? payload.error
99
+ : undefined;
11
100
  if (typeof payload.code === "string") {
12
101
  code = payload.code;
13
102
  }
103
+ else if (typeof nested?.code === "string") {
104
+ code = nested.code;
105
+ }
14
106
  else if (typeof payload.error === "string") {
15
107
  code = payload.error;
16
108
  }
17
109
  if (typeof payload.message === "string") {
18
110
  message = payload.message;
19
111
  }
112
+ else if (typeof nested?.message === "string") {
113
+ message = nested.message;
114
+ }
115
+ if (nested) {
116
+ // Keep the detail and free the `error` key for the tool result flag.
117
+ const { error: _error, ...rest } = payload;
118
+ payload = { ...rest, error_detail: nested };
119
+ }
20
120
  }
21
121
  }
22
122
  catch {
@@ -28,32 +128,197 @@ async function apiError(res) {
28
128
  /** Thin HTTP wrapper for the Tellagen public API. */
29
129
  export class TellagenClient {
30
130
  baseUrl;
31
- apiKey;
131
+ #apiKey;
132
+ /** What this process knows about its client and its run. */
133
+ session;
134
+ authStatus;
135
+ authProblem;
136
+ authCheckedAt = 0;
32
137
  constructor(config) {
33
- this.baseUrl = config.apiUrl.replace(/\/+$/, "");
34
- this.apiKey = config.apiKey;
138
+ this.baseUrl = (config.apiUrl ?? "").trim().replace(/\/+$/, "");
139
+ this.#apiKey = (config.apiKey ?? "").trim();
140
+ this.session = new Session(this.baseUrl, config.stateDir);
141
+ this.authStatus = this.#apiKey && this.baseUrl ? "unknown" : "missing";
142
+ }
143
+ /**
144
+ * Replaces the key and the address, after a sign-in or a sign-out. The
145
+ * remembered-run file follows the address. The new key has not been tried
146
+ * yet, so the answer about the old one is dropped.
147
+ */
148
+ setCredentials(config) {
149
+ this.baseUrl = (config.apiUrl ?? "").trim().replace(/\/+$/, "");
150
+ this.#apiKey = (config.apiKey ?? "").trim();
151
+ this.session.setWorkspace(this.baseUrl);
152
+ this.authStatus = this.#apiKey && this.baseUrl ? "unknown" : "missing";
153
+ this.authProblem = undefined;
154
+ this.authCheckedAt = 0;
155
+ }
156
+ /** The API address in use; it holds no secret. */
157
+ apiUrl() {
158
+ return this.baseUrl;
159
+ }
160
+ /** Whether Tellagen accepted the key: not set, not asked yet, yes or no. */
161
+ auth() {
162
+ return this.authStatus;
163
+ }
164
+ missingSetup() {
165
+ const missing = [];
166
+ if (!this.#apiKey)
167
+ missing.push("TELLAGEN_API_KEY");
168
+ if (!this.baseUrl)
169
+ missing.push("TELLAGEN_API_URL");
170
+ return missing.length > 0 ? missingSetupError(missing) : undefined;
171
+ }
172
+ /**
173
+ * Asks Tellagen once whether it accepts the key. It never throws: a
174
+ * network error leaves the answer open, and the tools report it later.
175
+ */
176
+ async checkAuth() {
177
+ if (this.authStatus === "missing")
178
+ return this.authStatus;
179
+ this.authCheckedAt = Date.now();
180
+ try {
181
+ const me = await this.request("GET", "/api/v1/auth/me", undefined, {
182
+ safeToRepeat: false,
183
+ timeoutMs: 10_000,
184
+ });
185
+ // This route answers 200 with no user for a key Tellagen does not
186
+ // accept, so the status alone says nothing.
187
+ if (me && typeof me === "object" && me.user && typeof me.user === "object") {
188
+ this.authStatus = "ok";
189
+ this.authProblem = undefined;
190
+ }
191
+ else {
192
+ this.noteAccess(new TellagenAPIError(401, "api_key_refused", "The API key was not accepted"));
193
+ }
194
+ }
195
+ catch {
196
+ // request() already recorded a refusal; anything else stays open.
197
+ }
198
+ return this.authStatus;
199
+ }
200
+ /**
201
+ * The reason no tool can work right now, or nothing. A refused key is asked
202
+ * about again after a short while, so a restored seat needs no restart.
203
+ */
204
+ async accessProblem() {
205
+ const missing = this.missingSetup();
206
+ if (missing)
207
+ return missing;
208
+ if (this.authStatus !== "rejected")
209
+ return undefined;
210
+ if (Date.now() - this.authCheckedAt >= httpDefaults.authRecheckMs) {
211
+ await this.checkAuth();
212
+ }
213
+ return this.authStatus === "rejected" ? this.authProblem : undefined;
35
214
  }
36
215
  headers(extra) {
37
216
  return {
38
- Authorization: `Bearer ${this.apiKey}`,
217
+ Authorization: `Bearer ${this.#apiKey}`,
39
218
  "Content-Type": "application/json",
219
+ ...this.session.identityHeaders(),
40
220
  ...extra,
41
221
  };
42
222
  }
43
- async request(method, path, body) {
223
+ /**
224
+ * One fetch with a time limit, repeated on a network error, a timeout and
225
+ * on 429, 502, 503 and 504 when the call is safe to repeat. The response
226
+ * is returned with its timer still running; the caller ends it with done().
227
+ */
228
+ async send(url, init, options) {
229
+ let attempts = options.safeToRepeat ? httpDefaults.retries + 1 : 1;
230
+ // One deadline for all attempts and waits: a client gives up on a tool
231
+ // call long before four full attempts end.
232
+ const total = Math.max(options.timeoutMs, options.timeoutMs > httpDefaults.timeoutMs ? httpDefaults.uploadTotalMs : httpDefaults.totalMs);
233
+ const deadline = Date.now() + total;
234
+ for (let attempt = 1;; attempt++) {
235
+ const controller = new AbortController();
236
+ let timedOut = false;
237
+ const limit = Math.max(1, Math.min(options.timeoutMs, deadline - Date.now()));
238
+ const timer = setTimeout(() => {
239
+ timedOut = true;
240
+ controller.abort();
241
+ }, limit);
242
+ const done = () => clearTimeout(timer);
243
+ let delay = Math.min(httpDefaults.baseDelayMs * 2 ** (attempt - 1), httpDefaults.maxDelayMs);
244
+ try {
245
+ const res = await fetch(url, { ...init, signal: controller.signal });
246
+ if (!RETRY_STATUSES.has(res.status) || attempt >= attempts)
247
+ return { res, done };
248
+ const wait = retryAfterMs(res);
249
+ if (wait !== undefined)
250
+ delay = Math.min(Math.max(wait, delay), httpDefaults.maxDelayMs);
251
+ // No time is left for another attempt: this answer is the result.
252
+ if (Date.now() + delay >= deadline)
253
+ return { res, done };
254
+ await res.body?.cancel().catch(() => undefined);
255
+ done();
256
+ }
257
+ catch (err) {
258
+ done();
259
+ if (Date.now() + delay >= deadline)
260
+ attempts = attempt;
261
+ if (attempt >= attempts) {
262
+ if (timedOut) {
263
+ throw new TellagenAPIError(0, "timeout", `Tellagen did not answer within ${Math.round(limit / 1000)} seconds.${options.safeToRepeat ? "" : " The call was not repeated, because a repeat could create a second record. Read the current state before you send it again."}`);
264
+ }
265
+ throw err;
266
+ }
267
+ }
268
+ await sleep(delay);
269
+ }
270
+ }
271
+ /** Records a refusal of the key or the seat and returns the clear error. */
272
+ noteAccess(err) {
273
+ const clear = accessError(err);
274
+ if (!clear)
275
+ return err;
276
+ this.authStatus = "rejected";
277
+ this.authProblem = clear;
278
+ this.authCheckedAt = Date.now();
279
+ return clear;
280
+ }
281
+ async request(method, path, body, options = {}) {
282
+ const missing = this.missingSetup();
283
+ if (missing)
284
+ throw missing;
44
285
  const url = `${this.baseUrl}${path}`;
45
286
  const init = {
46
287
  method,
47
- headers: this.headers(),
288
+ headers: this.headers({
289
+ ...(options.headers ?? {}),
290
+ ...(options.idempotencyKey ? { "Idempotency-Key": options.idempotencyKey } : {}),
291
+ }),
48
292
  };
49
293
  if (body !== undefined) {
50
294
  init.body = JSON.stringify(body);
51
295
  }
52
- const res = await fetch(url, init);
53
- if (!res.ok) {
54
- throw await apiError(res);
296
+ const safeToRepeat = options.safeToRepeat ?? (method === "GET" || method === "PUT" || Boolean(options.idempotencyKey));
297
+ const { res, done } = await this.send(url, init, {
298
+ timeoutMs: options.timeoutMs ?? httpDefaults.timeoutMs,
299
+ safeToRepeat,
300
+ });
301
+ try {
302
+ if (!res.ok) {
303
+ throw this.noteAccess(await apiError(res));
304
+ }
305
+ // The auth route proves nothing by its status; checkAuth reads its body.
306
+ if (this.authStatus !== "ok" && path !== "/api/v1/auth/me") {
307
+ this.authStatus = "ok";
308
+ this.authProblem = undefined;
309
+ }
310
+ return (await res.json());
311
+ }
312
+ catch (err) {
313
+ // The time limit can also end the read of the answer.
314
+ if (err instanceof Error && err.name === "AbortError") {
315
+ throw new TellagenAPIError(0, "timeout", "Tellagen started to answer but did not finish within the time limit. Read the current state before you send the call again.");
316
+ }
317
+ throw err;
318
+ }
319
+ finally {
320
+ done();
55
321
  }
56
- return (await res.json());
57
322
  }
58
323
  /**
59
324
  * GET the bytes at an API path with the API key, for images and other
@@ -61,15 +326,27 @@ export class TellagenClient {
61
326
  * full, and an error status is reported like any other API error.
62
327
  */
63
328
  async getBinary(path, options) {
64
- const res = await fetch(`${this.baseUrl}${path}`, {
329
+ const missing = this.missingSetup();
330
+ if (missing)
331
+ throw missing;
332
+ const { res, done } = await this.send(`${this.baseUrl}${path}`, {
65
333
  method: "GET",
66
334
  headers: {
67
- Authorization: `Bearer ${this.apiKey}`,
335
+ Authorization: `Bearer ${this.#apiKey}`,
68
336
  Accept: options.accept ?? "*/*",
337
+ ...this.session.identityHeaders(),
69
338
  },
70
- });
339
+ }, { timeoutMs: httpDefaults.uploadTimeoutMs, safeToRepeat: true });
340
+ try {
341
+ return await this.readBinary(res, options);
342
+ }
343
+ finally {
344
+ done();
345
+ }
346
+ }
347
+ async readBinary(res, options) {
71
348
  if (!res.ok) {
72
- throw await apiError(res);
349
+ throw this.noteAccess(await apiError(res));
73
350
  }
74
351
  const tooLarge = (size) => new TellagenAPIError(413, "response_too_large", `The response is ${size} bytes; at most ${options.maxBytes} are read`);
75
352
  const declared = Number(res.headers.get("content-length") ?? "");
@@ -106,17 +383,17 @@ export class TellagenClient {
106
383
  contentDisposition: res.headers.get("content-disposition") ?? undefined,
107
384
  };
108
385
  }
109
- async get(path) {
110
- return this.request("GET", path);
386
+ async get(path, options) {
387
+ return this.request("GET", path, undefined, options);
111
388
  }
112
- async post(path, body) {
113
- return this.request("POST", path, body);
389
+ async post(path, body, options) {
390
+ return this.request("POST", path, body, options);
114
391
  }
115
- async put(path, body) {
116
- return this.request("PUT", path, body);
392
+ async put(path, body, options) {
393
+ return this.request("PUT", path, body, options);
117
394
  }
118
- async patch(path, body) {
119
- return this.request("PATCH", path, body);
395
+ async patch(path, body, options) {
396
+ return this.request("PATCH", path, body, options);
120
397
  }
121
398
  }
122
399
  //# sourceMappingURL=client.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAsB/C,sFAAsF;AACtF,KAAK,UAAU,QAAQ,CAAC,GAAa;IACnC,IAAI,IAAI,GAAG,SAAS,CAAC;IACrB,IAAI,OAAO,GAAG,QAAQ,GAAG,CAAC,MAAM,EAAE,CAAC;IACnC,IAAI,OAA4C,CAAC;IACjD,IAAI,CAAC;QACH,MAAM,SAAS,GAAG,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAY,CAAC;QAChD,IAAI,SAAS,IAAI,OAAO,SAAS,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;YAC5E,OAAO,GAAG,SAAoC,CAAC;YAC/C,IAAI,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBACrC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;YACtB,CAAC;iBAAM,IAAI,OAAO,OAAO,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;gBAC7C,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC;YACvB,CAAC;YACD,IAAI,OAAO,OAAO,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;gBACxC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;YAC5B,CAAC;QACH,CAAC;IACH,CAAC;IAAC,MAAM,CAAC;QACP,2CAA2C;QAC3C,OAAO,GAAG,GAAG,CAAC,UAAU,IAAI,OAAO,CAAC;IACtC,CAAC;IACD,OAAO,IAAI,gBAAgB,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;AAClE,CAAC;AAED,qDAAqD;AACrD,MAAM,OAAO,cAAc;IACR,OAAO,CAAS;IAChB,MAAM,CAAS;IAEhC,YAAY,MAAoB;QAC9B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QACjD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;IAC9B,CAAC;IAEO,OAAO,CAAC,KAA8B;QAC5C,OAAO;YACL,aAAa,EAAE,UAAU,IAAI,CAAC,MAAM,EAAE;YACtC,cAAc,EAAE,kBAAkB;YAClC,GAAG,KAAK;SACT,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,OAAO,CACnB,MAAc,EACd,IAAY,EACZ,IAAc;QAEd,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,OAAO,GAAG,IAAI,EAAE,CAAC;QACrC,MAAM,IAAI,GAAgB;YACxB,MAAM;YACN,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE;SACxB,CAAC;QACF,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACnC,CAAC;QAED,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAEnC,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;YACZ,MAAM,MAAM,QAAQ,CAAC,GAAG,CAAC,CAAC;QAC5B,CAAC;QAED,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAM,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,SAAS,CAAC,IAAY,EAAE,OAA2B;QACvD,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,IAAI,CAAC,OAAO,GAAG,IAAI,EAAE,EAAE;YAChD,MAAM,EAAE,KAAK;YACb,OAAO,EAAE;gBACP,aAAa,EAAE,UAAU,IAAI,CAAC,MAAM,EAAE;gBACtC,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,KAAK;aAChC;SACF,CAAC,CAAC;QACH,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;YACZ,MAAM,MAAM,QAAQ,CAAC,GAAG,CAAC,CAAC;QAC5B,CAAC;QACD,MAAM,QAAQ,GAAG,CAAC,IAAY,EAAE,EAAE,CAChC,IAAI,gBAAgB,CAClB,GAAG,EACH,oBAAoB,EACpB,mBAAmB,IAAI,mBAAmB,OAAO,CAAC,QAAQ,WAAW,CACtE,CAAC;QACJ,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,IAAI,EAAE,CAAC,CAAC;QACjE,IAAI,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,QAAQ,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;YAC7D,MAAM,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;YAChD,MAAM,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAC3B,CAAC;QACD,MAAM,MAAM,GAAiB,EAAE,CAAC;QAChC,IAAI,IAAI,GAAG,CAAC,CAAC;QACb,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC;YACb,MAAM,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACpC,SAAS,CAAC;gBACR,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;gBAC5C,IAAI,IAAI;oBAAE,MAAM;gBAChB,IAAI,IAAI,KAAK,CAAC,UAAU,CAAC;gBACzB,IAAI,IAAI,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;oBAC5B,MAAM,MAAM,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;oBAC7C,MAAM,QAAQ,CAAC,IAAI,CAAC,CAAC;gBACvB,CAAC;gBACD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACrB,CAAC;QACH,CAAC;QACD,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC;QACnC,IAAI,MAAM,GAAG,CAAC,CAAC;QACf,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,UAAU,CAAC;QAC7B,CAAC;QACD,OAAO;YACL,KAAK;YACL,WAAW,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAE,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE;YACxF,IAAI,EAAE,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,SAAS;YAC1C,kBAAkB,EAAE,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC,IAAI,SAAS;SACxE,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,GAAG,CAAI,IAAY;QACvB,OAAO,IAAI,CAAC,OAAO,CAAI,KAAK,EAAE,IAAI,CAAC,CAAC;IACtC,CAAC;IAED,KAAK,CAAC,IAAI,CAAI,IAAY,EAAE,IAAa;QACvC,OAAO,IAAI,CAAC,OAAO,CAAI,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAC7C,CAAC;IAED,KAAK,CAAC,GAAG,CAAI,IAAY,EAAE,IAAa;QACtC,OAAO,IAAI,CAAC,OAAO,CAAI,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAC5C,CAAC;IAED,KAAK,CAAC,KAAK,CAAI,IAAY,EAAE,IAAa;QACxC,OAAO,IAAI,CAAC,OAAO,CAAI,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAC9C,CAAC;CACF"}
1
+ {"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACnE,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAcvC;;;GAGG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,qCAAqC;IACrC,SAAS,EAAE,MAAM;IACjB,2DAA2D;IAC3D,eAAe,EAAE,OAAO;IACxB,iEAAiE;IACjE,OAAO,EAAE,MAAM;IACf,kDAAkD;IAClD,aAAa,EAAE,OAAO;IACtB,uCAAuC;IACvC,OAAO,EAAE,CAAC;IACV,+CAA+C;IAC/C,WAAW,EAAE,GAAG;IAChB,wDAAwD;IACxD,UAAU,EAAE,MAAM;IAClB,6DAA6D;IAC7D,aAAa,EAAE,MAAM;CACtB,CAAC;AAiBF,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;AAIrD,MAAM,SAAS,GAAG;IAChB,+IAA+I;IAC/I,+GAA+G;IAC/G,iMAAiM;IACjM,mDAAmD;CAC3C,CAAC;AAEX,uEAAuE;AACvE,MAAM,UAAU,iBAAiB,CAAC,OAA0B;IAC1D,OAAO,IAAI,kBAAkB,CAC3B,qBAAqB,EACrB,0CAA0C,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,iGAAiG,EACvM,SAAS,CACV,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,SAAS,WAAW,CAAC,GAAqB;IACxC,MAAM,OAAO,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC,EAAE,CAAC;IAC3C,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;QACvB,MAAM,OAAO,GAAG,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC1C,MAAM,OAAO,GAAG,OAAO;YACrB,CAAC,CAAC,iEAAiE;YACnE,CAAC,CAAC,wFAAwF,CAAC;QAC7F,OAAO,IAAI,gBAAgB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,OAAO,4CAA4C,EAAE;YACnK,GAAG,OAAO;YACV,WAAW,EAAE;gBACX,oFAAoF;gBACpF,0HAA0H;gBAC1H,sJAAsJ;gBACtJ,mDAAmD;aACpD;SACF,CAAC,CAAC;IACL,CAAC;IACD,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,IAAI,KAAK,uBAAuB,EAAE,CAAC;QAC/D,OAAO,IAAI,gBAAgB,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,EAAE,GAAG,GAAG,CAAC,OAAO,mJAAmJ,EAAE;YAC5M,GAAG,OAAO;YACV,WAAW,EAAE;gBACX,yGAAyG;gBACzG,mEAAmE;aACpE;SACF,CAAC,CAAC;IACL,CAAC;IACD,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,IAAI,KAAK,kBAAkB,EAAE,CAAC;QAC1D,OAAO,IAAI,gBAAgB,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,EAAE,GAAG,GAAG,CAAC,OAAO,oHAAoH,EAAE;YAC7K,GAAG,OAAO;YACV,WAAW,EAAE,CAAC,sDAAsD,EAAE,2BAA2B,CAAC;SACnG,CAAC,CAAC;IACL,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,YAAY,CAAC,GAAa;IACjC,MAAM,KAAK,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IAC7C,IAAI,CAAC,KAAK;QAAE,OAAO,SAAS,CAAC;IAC7B,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IAC9B,IAAI,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,OAAO,IAAI,CAAC;QAAE,OAAO,OAAO,GAAG,IAAI,CAAC;IACpE,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC/B,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;IACjE,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,MAAM,KAAK,GAAG,CAAC,EAAU,EAAE,EAAE,CAC3B,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;AAiBxF,sFAAsF;AACtF,KAAK,UAAU,QAAQ,CAAC,GAAa;IACnC,IAAI,IAAI,GAAG,SAAS,CAAC;IACrB,IAAI,OAAO,GAAG,QAAQ,GAAG,CAAC,MAAM,EAAE,CAAC;IACnC,IAAI,OAA4C,CAAC;IACjD,IAAI,CAAC;QACH,MAAM,SAAS,GAAG,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAY,CAAC;QAChD,IAAI,SAAS,IAAI,OAAO,SAAS,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;YAC5E,OAAO,GAAG,SAAoC,CAAC;YAC/C,yEAAyE;YACzE,MAAM,MAAM,GACV,OAAO,CAAC,KAAK,IAAI,OAAO,OAAO,CAAC,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC;gBACjF,CAAC,CAAE,OAAO,CAAC,KAAiC;gBAC5C,CAAC,CAAC,SAAS,CAAC;YAChB,IAAI,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBACrC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;YACtB,CAAC;iBAAM,IAAI,OAAO,MAAM,EAAE,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAC5C,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;YACrB,CAAC;iBAAM,IAAI,OAAO,OAAO,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;gBAC7C,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC;YACvB,CAAC;YACD,IAAI,OAAO,OAAO,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;gBACxC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;YAC5B,CAAC;iBAAM,IAAI,OAAO,MAAM,EAAE,OAAO,KAAK,QAAQ,EAAE,CAAC;gBAC/C,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;YAC3B,CAAC;YACD,IAAI,MAAM,EAAE,CAAC;gBACX,qEAAqE;gBACrE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,OAAO,CAAC;gBAC3C,OAAO,GAAG,EAAE,GAAG,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,CAAC;YAC9C,CAAC;QACH,CAAC;IACH,CAAC;IAAC,MAAM,CAAC;QACP,2CAA2C;QAC3C,OAAO,GAAG,GAAG,CAAC,UAAU,IAAI,OAAO,CAAC;IACtC,CAAC;IACD,OAAO,IAAI,gBAAgB,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;AAClE,CAAC;AAED,qDAAqD;AACrD,MAAM,OAAO,cAAc;IACjB,OAAO,CAAS;IACxB,OAAO,CAAS;IAChB,4DAA4D;IACnD,OAAO,CAAU;IAClB,UAAU,CAAa;IACvB,WAAW,CAA+B;IAC1C,aAAa,GAAG,CAAC,CAAC;IAE1B,YAAY,MAAoB;QAC9B,IAAI,CAAC,OAAO,GAAG,CAAC,MAAM,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QAChE,IAAI,CAAC,OAAO,GAAG,CAAC,MAAM,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;QAC5C,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC1D,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;IACzE,CAAC;IAED;;;;OAIG;IACH,cAAc,CAAC,MAA0C;QACvD,IAAI,CAAC,OAAO,GAAG,CAAC,MAAM,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QAChE,IAAI,CAAC,OAAO,GAAG,CAAC,MAAM,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;QAC5C,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;QACvE,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;QAC7B,IAAI,CAAC,aAAa,GAAG,CAAC,CAAC;IACzB,CAAC;IAED,kDAAkD;IAClD,MAAM;QACJ,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,4EAA4E;IAC5E,IAAI;QACF,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAEO,YAAY;QAClB,MAAM,OAAO,GAAa,EAAE,CAAC;QAC7B,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QACpD,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QACpD,OAAO,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACrE,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,SAAS;QACb,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS;YAAE,OAAO,IAAI,CAAC,UAAU,CAAC;QAC1D,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAChC,IAAI,CAAC;YACH,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAqB,KAAK,EAAE,iBAAiB,EAAE,SAAS,EAAE;gBACrF,YAAY,EAAE,KAAK;gBACnB,SAAS,EAAE,MAAM;aAClB,CAAC,CAAC;YACH,kEAAkE;YAClE,4CAA4C;YAC5C,IAAI,EAAE,IAAI,OAAO,EAAE,KAAK,QAAQ,IAAI,EAAE,CAAC,IAAI,IAAI,OAAO,EAAE,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAC3E,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;gBACvB,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;YAC/B,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,UAAU,CAAC,IAAI,gBAAgB,CAAC,GAAG,EAAE,iBAAiB,EAAE,8BAA8B,CAAC,CAAC,CAAC;YAChG,CAAC;QACH,CAAC;QAAC,MAAM,CAAC;YACP,kEAAkE;QACpE,CAAC;QACD,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,aAAa;QACjB,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;QACpC,IAAI,OAAO;YAAE,OAAO,OAAO,CAAC;QAC5B,IAAI,IAAI,CAAC,UAAU,KAAK,UAAU;YAAE,OAAO,SAAS,CAAC;QACrD,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,aAAa,IAAI,YAAY,CAAC,aAAa,EAAE,CAAC;YAClE,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QACzB,CAAC;QACD,OAAO,IAAI,CAAC,UAAU,KAAK,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;IACvE,CAAC;IAEO,OAAO,CAAC,KAA8B;QAC5C,OAAO;YACL,aAAa,EAAE,UAAU,IAAI,CAAC,OAAO,EAAE;YACvC,cAAc,EAAE,kBAAkB;YAClC,GAAG,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE;YACjC,GAAG,KAAK;SACT,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACK,KAAK,CAAC,IAAI,CAChB,GAAW,EACX,IAAiB,EACjB,OAAqD;QAErD,IAAI,QAAQ,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACnE,uEAAuE;QACvE,2CAA2C;QAC3C,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CACpB,OAAO,CAAC,SAAS,EACjB,OAAO,CAAC,SAAS,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC,YAAY,CAAC,OAAO,CAC/F,CAAC;QACF,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC;QACpC,KAAK,IAAI,OAAO,GAAG,CAAC,GAAI,OAAO,EAAE,EAAE,CAAC;YAClC,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;YACzC,IAAI,QAAQ,GAAG,KAAK,CAAC;YACrB,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,EAAE,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;YAC9E,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE;gBAC5B,QAAQ,GAAG,IAAI,CAAC;gBAChB,UAAU,CAAC,KAAK,EAAE,CAAC;YACrB,CAAC,EAAE,KAAK,CAAC,CAAC;YACV,MAAM,IAAI,GAAG,GAAG,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;YACvC,IAAI,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,WAAW,GAAG,CAAC,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC,EAAE,YAAY,CAAC,UAAU,CAAC,CAAC;YAC7F,IAAI,CAAC;gBACH,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC;gBACrE,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,OAAO,IAAI,QAAQ;oBAAE,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC;gBACjF,MAAM,IAAI,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC;gBAC/B,IAAI,IAAI,KAAK,SAAS;oBAAE,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,YAAY,CAAC,UAAU,CAAC,CAAC;gBACzF,kEAAkE;gBAClE,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,IAAI,QAAQ;oBAAE,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC;gBACzD,MAAM,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;gBAChD,IAAI,EAAE,CAAC;YACT,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,IAAI,EAAE,CAAC;gBACP,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,IAAI,QAAQ;oBAAE,QAAQ,GAAG,OAAO,CAAC;gBACvD,IAAI,OAAO,IAAI,QAAQ,EAAE,CAAC;oBACxB,IAAI,QAAQ,EAAE,CAAC;wBACb,MAAM,IAAI,gBAAgB,CACxB,CAAC,EACD,SAAS,EACT,kCAAkC,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,YAAY,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,6HAA6H,EAAE,CAClO,CAAC;oBACJ,CAAC;oBACD,MAAM,GAAG,CAAC;gBACZ,CAAC;YACH,CAAC;YACD,MAAM,KAAK,CAAC,KAAK,CAAC,CAAC;QACrB,CAAC;IACH,CAAC;IAED,4EAA4E;IACpE,UAAU,CAAC,GAAqB;QACtC,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,CAAC,KAAK;YAAE,OAAO,GAAG,CAAC;QACvB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;QACzB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAChC,OAAO,KAAK,CAAC;IACf,CAAC;IAEO,KAAK,CAAC,OAAO,CACnB,MAAc,EACd,IAAY,EACZ,IAAc,EACd,UAA0B,EAAE;QAE5B,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;QACpC,IAAI,OAAO;YAAE,MAAM,OAAO,CAAC;QAC3B,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,OAAO,GAAG,IAAI,EAAE,CAAC;QACrC,MAAM,IAAI,GAAgB;YACxB,MAAM;YACN,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC;gBACpB,GAAG,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC;gBAC1B,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aACjF,CAAC;SACH,CAAC;QACF,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACnC,CAAC;QACD,MAAM,YAAY,GAChB,OAAO,CAAC,YAAY,IAAI,CAAC,MAAM,KAAK,KAAK,IAAI,MAAM,KAAK,KAAK,IAAI,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC;QAEpG,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE;YAC/C,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,YAAY,CAAC,SAAS;YACtD,YAAY;SACb,CAAC,CAAC;QACH,IAAI,CAAC;YACH,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;gBACZ,MAAM,IAAI,CAAC,UAAU,CAAC,MAAM,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;YAC7C,CAAC;YACD,yEAAyE;YACzE,IAAI,IAAI,CAAC,UAAU,KAAK,IAAI,IAAI,IAAI,KAAK,iBAAiB,EAAE,CAAC;gBAC3D,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;gBACvB,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;YAC/B,CAAC;YACD,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAM,CAAC;QACjC,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,sDAAsD;YACtD,IAAI,GAAG,YAAY,KAAK,IAAI,GAAG,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;gBACtD,MAAM,IAAI,gBAAgB,CACxB,CAAC,EACD,SAAS,EACT,6HAA6H,CAC9H,CAAC;YACJ,CAAC;YACD,MAAM,GAAG,CAAC;QACZ,CAAC;gBAAS,CAAC;YACT,IAAI,EAAE,CAAC;QACT,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,SAAS,CAAC,IAAY,EAAE,OAA2B;QACvD,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;QACpC,IAAI,OAAO;YAAE,MAAM,OAAO,CAAC;QAC3B,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,CACnC,GAAG,IAAI,CAAC,OAAO,GAAG,IAAI,EAAE,EACxB;YACE,MAAM,EAAE,KAAK;YACb,OAAO,EAAE;gBACP,aAAa,EAAE,UAAU,IAAI,CAAC,OAAO,EAAE;gBACvC,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,KAAK;gBAC/B,GAAG,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE;aAClC;SACF,EACD,EAAE,SAAS,EAAE,YAAY,CAAC,eAAe,EAAE,YAAY,EAAE,IAAI,EAAE,CAChE,CAAC;QACF,IAAI,CAAC;YACH,OAAO,MAAM,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QAC7C,CAAC;gBAAS,CAAC;YACT,IAAI,EAAE,CAAC;QACT,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,UAAU,CAAC,GAAa,EAAE,OAA2B;QACjE,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;YACZ,MAAM,IAAI,CAAC,UAAU,CAAC,MAAM,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;QAC7C,CAAC;QACD,MAAM,QAAQ,GAAG,CAAC,IAAY,EAAE,EAAE,CAChC,IAAI,gBAAgB,CAClB,GAAG,EACH,oBAAoB,EACpB,mBAAmB,IAAI,mBAAmB,OAAO,CAAC,QAAQ,WAAW,CACtE,CAAC;QACJ,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,IAAI,EAAE,CAAC,CAAC;QACjE,IAAI,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,QAAQ,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;YAC7D,MAAM,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;YAChD,MAAM,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAC3B,CAAC;QACD,MAAM,MAAM,GAAiB,EAAE,CAAC;QAChC,IAAI,IAAI,GAAG,CAAC,CAAC;QACb,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC;YACb,MAAM,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACpC,SAAS,CAAC;gBACR,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;gBAC5C,IAAI,IAAI;oBAAE,MAAM;gBAChB,IAAI,IAAI,KAAK,CAAC,UAAU,CAAC;gBACzB,IAAI,IAAI,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;oBAC5B,MAAM,MAAM,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;oBAC7C,MAAM,QAAQ,CAAC,IAAI,CAAC,CAAC;gBACvB,CAAC;gBACD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACrB,CAAC;QACH,CAAC;QACD,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC;QACnC,IAAI,MAAM,GAAG,CAAC,CAAC;QACf,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,UAAU,CAAC;QAC7B,CAAC;QACD,OAAO;YACL,KAAK;YACL,WAAW,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAE,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE;YACxF,IAAI,EAAE,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,SAAS;YAC1C,kBAAkB,EAAE,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC,IAAI,SAAS;SACxE,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,GAAG,CAAI,IAAY,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAI,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED,KAAK,CAAC,IAAI,CAAI,IAAY,EAAE,IAAa,EAAE,OAAwB;QACjE,OAAO,IAAI,CAAC,OAAO,CAAI,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IACtD,CAAC;IAED,KAAK,CAAC,GAAG,CAAI,IAAY,EAAE,IAAa,EAAE,OAAwB;QAChE,OAAO,IAAI,CAAC,OAAO,CAAI,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAED,KAAK,CAAC,KAAK,CAAI,IAAY,EAAE,IAAa,EAAE,OAAwB;QAClE,OAAO,IAAI,CAAC,OAAO,CAAI,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;CACF"}
@@ -0,0 +1,17 @@
1
+ import { type ToolsetSelection } from "./tools/catalog.js";
2
+ export interface ServerConfig {
3
+ apiKey: string;
4
+ apiUrl: string;
5
+ toolsets: ToolsetSelection;
6
+ stateDir: string;
7
+ /** A setting that was wrong and was replaced by its default, in plain words. */
8
+ warnings: string[];
9
+ }
10
+ /**
11
+ * Reads the settings from the environment and the command line. A missing
12
+ * key or address is not an error here: the server still starts and each tool
13
+ * explains the setup. `--toolsets` wins over TELLAGEN_TOOLSETS. An unknown
14
+ * toolset does not stop the server: the default sets are used and a warning
15
+ * says so.
16
+ */
17
+ export declare function readConfig(env?: Record<string, string | undefined>, argv?: readonly string[]): ServerConfig;
package/dist/config.js ADDED
@@ -0,0 +1,38 @@
1
+ import { defaultStateDir } from "./run-state.js";
2
+ import { DEFAULT_TOOLSETS, parseToolsets } from "./tools/catalog.js";
3
+ /**
4
+ * Reads the settings from the environment and the command line. A missing
5
+ * key or address is not an error here: the server still starts and each tool
6
+ * explains the setup. `--toolsets` wins over TELLAGEN_TOOLSETS. An unknown
7
+ * toolset does not stop the server: the default sets are used and a warning
8
+ * says so.
9
+ */
10
+ export function readConfig(env = process.env, argv = process.argv.slice(2)) {
11
+ let toolsets = env.TELLAGEN_TOOLSETS;
12
+ for (let i = 0; i < argv.length; i++) {
13
+ const arg = argv[i];
14
+ if (arg === "--toolsets") {
15
+ toolsets = argv[i + 1] ?? "";
16
+ i++;
17
+ }
18
+ else if (arg.startsWith("--toolsets=")) {
19
+ toolsets = arg.slice("--toolsets=".length);
20
+ }
21
+ }
22
+ const warnings = [];
23
+ let selection = DEFAULT_TOOLSETS;
24
+ try {
25
+ selection = parseToolsets(toolsets);
26
+ }
27
+ catch (err) {
28
+ warnings.push(`${err instanceof Error ? err.message : "The toolset setting is not valid."} The default toolsets (${DEFAULT_TOOLSETS.join(", ")}) are on.`);
29
+ }
30
+ return {
31
+ apiKey: (env.TELLAGEN_API_KEY ?? "").trim(),
32
+ apiUrl: (env.TELLAGEN_API_URL ?? "").trim(),
33
+ toolsets: selection,
34
+ stateDir: (env.TELLAGEN_STATE_DIR ?? "").trim() || defaultStateDir(),
35
+ warnings,
36
+ };
37
+ }
38
+ //# sourceMappingURL=config.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAyB,MAAM,oBAAoB,CAAC;AAW5F;;;;;;GAMG;AACH,MAAM,UAAU,UAAU,CACxB,MAA0C,OAAO,CAAC,GAAG,EACrD,OAA0B,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAE/C,IAAI,QAAQ,GAAG,GAAG,CAAC,iBAAiB,CAAC;IACrC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACrC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAE,CAAC;QACrB,IAAI,GAAG,KAAK,YAAY,EAAE,CAAC;YACzB,QAAQ,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;YAC7B,CAAC,EAAE,CAAC;QACN,CAAC;aAAM,IAAI,GAAG,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,CAAC;YACzC,QAAQ,GAAG,GAAG,CAAC,KAAK,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAC7C,CAAC;IACH,CAAC;IACD,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,IAAI,SAAS,GAAqB,gBAAgB,CAAC;IACnD,IAAI,CAAC;QACH,SAAS,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC;IACtC,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,QAAQ,CAAC,IAAI,CACX,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,mCAAmC,0BAA0B,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAC5I,CAAC;IACJ,CAAC;IACD,OAAO;QACL,MAAM,EAAE,CAAC,GAAG,CAAC,gBAAgB,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE;QAC3C,MAAM,EAAE,CAAC,GAAG,CAAC,gBAAgB,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE;QAC3C,QAAQ,EAAE,SAAS;QACnB,QAAQ,EAAE,CAAC,GAAG,CAAC,kBAAkB,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,IAAI,eAAe,EAAE;QACpE,QAAQ;KACT,CAAC;AACJ,CAAC"}
@@ -0,0 +1,120 @@
1
+ /**
2
+ * Where the API key of a sign-in is kept.
3
+ *
4
+ * The key goes to the system keychain: the macOS Keychain, the Secret
5
+ * Service (libsecret) on Linux, the Windows credential vault. Where a
6
+ * computer has none, the key goes to a file that only its owner can read, and
7
+ * the person is told so. The key is never written to the state folder, to a
8
+ * log or to a message.
9
+ *
10
+ * Each keychain is reached through the command that ships with the system,
11
+ * so this package needs no native module. The key reaches that command on
12
+ * its standard input or in its environment, never in its arguments, because
13
+ * the arguments of a running command can be read by other users.
14
+ */
15
+ export declare const KEYCHAIN_SERVICE = "tellagen-mcp-server";
16
+ export type StoreKind = "macos-keychain" | "libsecret" | "windows-vault" | "file";
17
+ export interface CredentialStore {
18
+ readonly kind: StoreKind;
19
+ get(account: string): Promise<string | undefined>;
20
+ /** Stores the key and reads it back. It throws a plain error without the key. */
21
+ set(account: string, secret: string): Promise<void>;
22
+ delete(account: string): Promise<void>;
23
+ }
24
+ export interface CommandResult {
25
+ code: number | null;
26
+ stdout: string;
27
+ stderr: string;
28
+ /** The command is not installed. */
29
+ missing: boolean;
30
+ timedOut: boolean;
31
+ }
32
+ export type RunCommand = (command: string, args: readonly string[], options?: {
33
+ input?: string;
34
+ env?: Record<string, string>;
35
+ timeoutMs?: number;
36
+ cwd?: string;
37
+ }) => Promise<CommandResult>;
38
+ /** Runs a system command. It never throws and never prints. */
39
+ export declare const runCommand: RunCommand;
40
+ /** The account name of a workspace: the host of its API address. */
41
+ export declare function accountFor(apiUrl: string): string;
42
+ export declare function describeStore(kind: StoreKind): string;
43
+ /** The macOS Keychain, through the `security` command. */
44
+ export declare class MacKeychainStore implements CredentialStore {
45
+ private readonly run;
46
+ readonly kind: "macos-keychain";
47
+ constructor(run?: RunCommand);
48
+ get(account: string): Promise<string | undefined>;
49
+ set(account: string, secret: string): Promise<void>;
50
+ delete(account: string): Promise<void>;
51
+ }
52
+ /** The Secret Service of a Linux desktop, through `secret-tool`. */
53
+ export declare class SecretToolStore implements CredentialStore {
54
+ private readonly run;
55
+ readonly kind: "libsecret";
56
+ constructor(run?: RunCommand);
57
+ get(account: string): Promise<string | undefined>;
58
+ set(account: string, secret: string): Promise<void>;
59
+ delete(account: string): Promise<void>;
60
+ /** Whether the Secret Service answers on this computer (it does not over SSH with no session bus). */
61
+ available(): Promise<boolean>;
62
+ }
63
+ /** Windows Credential Manager, through the PasswordVault of Windows PowerShell. */
64
+ export declare class WindowsVaultStore implements CredentialStore {
65
+ private readonly run;
66
+ readonly kind: "windows-vault";
67
+ constructor(run?: RunCommand);
68
+ private script;
69
+ get(account: string): Promise<string | undefined>;
70
+ set(account: string, secret: string): Promise<void>;
71
+ delete(account: string): Promise<void>;
72
+ }
73
+ /** The last resort: a file that only the owner can read. */
74
+ export declare class KeyFileStore implements CredentialStore {
75
+ #private;
76
+ readonly kind: "file";
77
+ constructor(dir?: string);
78
+ path(account: string): string;
79
+ get(account: string): Promise<string | undefined>;
80
+ set(account: string, secret: string): Promise<void>;
81
+ delete(account: string): Promise<void>;
82
+ }
83
+ /** A store in memory, for a test or an embedder. */
84
+ export declare class MemoryStore implements CredentialStore {
85
+ readonly kind: StoreKind;
86
+ readonly entries: Map<string, string>;
87
+ constructor(kind?: StoreKind);
88
+ get(account: string): Promise<string | undefined>;
89
+ set(account: string, secret: string): Promise<void>;
90
+ delete(account: string): Promise<void>;
91
+ }
92
+ export interface SavedCredential {
93
+ kind: StoreKind;
94
+ /** Set when the key went to a file because the keychain could not be used. */
95
+ fileNotice?: string;
96
+ }
97
+ /**
98
+ * The keychain of this computer, with the file as the answer where there is
99
+ * no keychain. macOS always has one, so a failure there is reported and the
100
+ * key is not moved to a file.
101
+ */
102
+ export declare class CredentialVault {
103
+ private readonly primary;
104
+ private readonly file;
105
+ private readonly fileFallback;
106
+ constructor(primary: CredentialStore | undefined, file: CredentialStore, fileFallback: boolean);
107
+ save(account: string, secret: string): Promise<SavedCredential>;
108
+ /** The key of an account, looking where the sign-in said it was stored. */
109
+ load(account: string, kind?: StoreKind): Promise<string | undefined>;
110
+ /** Removes the key from every place it could be. */
111
+ remove(account: string): Promise<void>;
112
+ primaryKind(): StoreKind | undefined;
113
+ }
114
+ /**
115
+ * The vault for this computer. On Linux the Secret Service may be missing or
116
+ * unreachable (an SSH session has no session bus). The first save then
117
+ * fails and the key goes to the owner-only file, with a notice. Reading never
118
+ * waits on a probe.
119
+ */
120
+ export declare function openVault(platform?: NodeJS.Platform, run?: RunCommand, file?: CredentialStore, env?: Record<string, string | undefined>): CredentialVault;