arthron 1.2.0 → 2.0.1
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/README.md +309 -185
- package/dist/index.cjs +263 -156
- package/dist/index.d.cts +158 -115
- package/dist/index.d.mts +158 -115
- package/dist/index.mjs +244 -136
- package/dist/plugins.cjs +846 -6
- package/dist/plugins.d.cts +129 -2
- package/dist/plugins.d.mts +129 -2
- package/dist/plugins.mjs +842 -1
- package/dist/shared.cjs +635 -0
- package/dist/shared.d.cts +239 -0
- package/dist/shared.d.mts +239 -0
- package/dist/shared.mjs +498 -0
- package/llms.txt +45 -42
- package/package.json +5 -3
- package/dist/index-C3lylSNd.d.cts +0 -333
- package/dist/index-C3lylSNd.d.mts +0 -333
- package/dist/index.cjs.map +0 -1
- package/dist/index.mjs.map +0 -1
- package/dist/plugins-CHCMxtAE.mjs +0 -1166
- package/dist/plugins-CHCMxtAE.mjs.map +0 -1
- package/dist/plugins-Cigqz2SS.cjs +0 -1279
- package/dist/plugins-Cigqz2SS.cjs.map +0 -1
package/dist/index.mjs
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { _ as
|
|
1
|
+
import { C as withoutSecrets, S as resolveUrl, _ as leavesBase, a as responseError, b as redactUrl, c as isReadableStream, d as tagOf, f as ArthronError, h as httpOrigin, i as redactErrorUrl, l as runtimeStreamsRequestBody, m as fillPath, n as isCancellation, p as isArthronError, r as networkError, t as cancellationError, u as serializeBody, x as redactUrlIn, y as originSet } from "./shared.mjs";
|
|
2
2
|
//#region src/request/headers.ts
|
|
3
3
|
const isPlainRecord = (headers) => !Array.isArray(headers) && Object.prototype.toString.call(headers) !== "[object Headers]";
|
|
4
4
|
/**
|
|
@@ -23,22 +23,31 @@ function toHeaderRecord(headers) {
|
|
|
23
23
|
}
|
|
24
24
|
//#endregion
|
|
25
25
|
//#region src/pipeline/pipeline.ts
|
|
26
|
-
/**
|
|
26
|
+
/**
|
|
27
|
+
* The mutable body kinds an interceptor can `append` to; anything else is
|
|
28
|
+
* shared as is. Known by type tag, as serializeBody knows them, and copied
|
|
29
|
+
* into their own class — a polyfill's (formdata-node) or another realm's
|
|
30
|
+
* holds values the global one may not take.
|
|
31
|
+
*/
|
|
27
32
|
function cloneBody(body) {
|
|
28
|
-
|
|
29
|
-
|
|
33
|
+
const tag = tagOf(body);
|
|
34
|
+
if (tag !== "FormData" && tag !== "URLSearchParams") return body;
|
|
35
|
+
const Own = body.constructor;
|
|
36
|
+
try {
|
|
37
|
+
if (tag === "URLSearchParams") return new Own(String(body));
|
|
38
|
+
const copy = new Own();
|
|
30
39
|
for (const [name, value] of body) copy.append(name, value);
|
|
31
40
|
return copy;
|
|
41
|
+
} catch {
|
|
42
|
+
return body;
|
|
32
43
|
}
|
|
33
|
-
if (body instanceof URLSearchParams) return new URLSearchParams(body);
|
|
34
|
-
return body;
|
|
35
44
|
}
|
|
36
45
|
/**
|
|
37
46
|
* Interceptors mutate the context in place. A middleware that calls `next`
|
|
38
47
|
* again (retry) must not see the previous attempt's changes, so every attempt
|
|
39
48
|
* starts from a fresh copy of the headers and of a FormData/URLSearchParams body.
|
|
40
49
|
*/
|
|
41
|
-
function cloneContext({ url, init, meta,
|
|
50
|
+
function cloneContext({ url, init, meta, fetchFn }) {
|
|
42
51
|
const copy = {
|
|
43
52
|
...init,
|
|
44
53
|
headers: toHeaderRecord(init.headers)
|
|
@@ -49,7 +58,7 @@ function cloneContext({ url, init, meta, fetch }) {
|
|
|
49
58
|
init: copy,
|
|
50
59
|
meta: { ...meta }
|
|
51
60
|
};
|
|
52
|
-
if (
|
|
61
|
+
if (fetchFn) out.fetchFn = fetchFn;
|
|
53
62
|
return out;
|
|
54
63
|
}
|
|
55
64
|
/**
|
|
@@ -66,11 +75,20 @@ function normalize(ctx, previous) {
|
|
|
66
75
|
},
|
|
67
76
|
meta: ctx.meta ?? previous.meta
|
|
68
77
|
};
|
|
69
|
-
const
|
|
70
|
-
if (
|
|
78
|
+
const fetchFn = ctx.fetchFn ?? previous.fetchFn;
|
|
79
|
+
if (fetchFn) out.fetchFn = fetchFn;
|
|
71
80
|
return out;
|
|
72
81
|
}
|
|
73
82
|
/**
|
|
83
|
+
* The 1.x name of `fetchFn`. TypeScript does not flag it on a spread
|
|
84
|
+
* (`{ ...ctx, fetch }`), and ignored, a test's mock would be passed over for
|
|
85
|
+
* the real network.
|
|
86
|
+
*/
|
|
87
|
+
function refuseFetchField(ctx, problem, fix) {
|
|
88
|
+
if (ctx.fetch === void 0) return;
|
|
89
|
+
throw new TypeError(`arthron: ${problem}, which is requestContext.fetchFn since 2.0 — ${fix} { ...requestContext, fetchFn }`);
|
|
90
|
+
}
|
|
91
|
+
/**
|
|
74
92
|
* A plugin written in JS (or with a cast) that forgets to return would hand
|
|
75
93
|
* `undefined` on — and an error interceptor's would be what the caller
|
|
76
94
|
* catches. Name the plugin slot instead.
|
|
@@ -80,7 +98,9 @@ function returned(value, who, what, cause, verb = "returned") {
|
|
|
80
98
|
throw new TypeError(`arthron: ${who} ${verb} ${value} — return ${what}`, cause === void 0 ? void 0 : { cause });
|
|
81
99
|
}
|
|
82
100
|
/**
|
|
83
|
-
* Owns the order of
|
|
101
|
+
* Owns the order of every request a client sends. The plugins are sorted
|
|
102
|
+
* into their slots once, when the client is created — a client's plugins
|
|
103
|
+
* never change.
|
|
84
104
|
*
|
|
85
105
|
* Middleware wraps the whole call, outermost first in registration order.
|
|
86
106
|
* Each attempt below it runs request interceptors → `send` → response
|
|
@@ -88,56 +108,61 @@ function returned(value, who, what, cause, verb = "returned") {
|
|
|
88
108
|
* they return is thrown. Anything else that is thrown — cancellation, a bug
|
|
89
109
|
* in a plugin — propagates untouched.
|
|
90
110
|
*/
|
|
91
|
-
|
|
111
|
+
function createPipeline(plugins) {
|
|
92
112
|
const middlewares = [];
|
|
93
|
-
const
|
|
94
|
-
const
|
|
95
|
-
const
|
|
113
|
+
const requestInterceptors = [];
|
|
114
|
+
const responseInterceptors = [];
|
|
115
|
+
const errorInterceptors = [];
|
|
96
116
|
for (const plugin of plugins) {
|
|
97
117
|
if (plugin.middleware) middlewares.push(plugin.middleware);
|
|
98
|
-
if (plugin.
|
|
99
|
-
if (plugin.
|
|
100
|
-
if (plugin.
|
|
118
|
+
if (plugin.requestInterceptor) requestInterceptors.push(plugin.requestInterceptor);
|
|
119
|
+
if (plugin.responseInterceptor) responseInterceptors.push(plugin.responseInterceptor);
|
|
120
|
+
if (plugin.errorInterceptor) errorInterceptors.push(plugin.errorInterceptor);
|
|
101
121
|
}
|
|
102
|
-
const attempt = async (input) => {
|
|
122
|
+
const attempt = async (input, send) => {
|
|
103
123
|
let current = cloneContext(input);
|
|
104
|
-
for (const interceptor of
|
|
124
|
+
for (const interceptor of requestInterceptors) {
|
|
125
|
+
const changed = returned(await interceptor(current), "a request interceptor", "the context (requestContext or a changed copy)");
|
|
126
|
+
refuseFetchField(changed, "a request interceptor set requestContext.fetch", "return");
|
|
127
|
+
current = normalize(changed, current);
|
|
128
|
+
}
|
|
105
129
|
let res;
|
|
106
130
|
try {
|
|
107
131
|
res = await send(current);
|
|
108
132
|
} catch (thrown) {
|
|
109
133
|
if (!isArthronError(thrown)) throw thrown;
|
|
110
134
|
let err = thrown;
|
|
111
|
-
for (const interceptor of
|
|
135
|
+
for (const interceptor of errorInterceptors) err = returned(await interceptor(err, current), "an error interceptor", "the error (error or a changed one)", thrown);
|
|
112
136
|
throw err;
|
|
113
137
|
}
|
|
114
|
-
for (const interceptor of
|
|
138
|
+
for (const interceptor of responseInterceptors) res = returned(await interceptor(res, current), "a response interceptor", "the Response (response or a new one)");
|
|
115
139
|
return res;
|
|
116
140
|
};
|
|
117
|
-
const
|
|
141
|
+
const runFrom = async (index, input, send) => {
|
|
118
142
|
const middleware = middlewares[index];
|
|
119
|
-
if (!middleware) return attempt(input);
|
|
120
|
-
return returned(await middleware(input, (
|
|
143
|
+
if (!middleware) return attempt(input, send);
|
|
144
|
+
return returned(await middleware(input, (passed) => {
|
|
145
|
+
refuseFetchField(passed, "a middleware passed requestContext.fetch to next", "pass");
|
|
121
146
|
const ctx = {
|
|
122
|
-
...
|
|
123
|
-
meta:
|
|
147
|
+
...passed,
|
|
148
|
+
meta: passed.meta ?? input.meta
|
|
124
149
|
};
|
|
125
|
-
const
|
|
126
|
-
if (
|
|
127
|
-
return
|
|
128
|
-
}), "a middleware", "the Response, usually `return next(
|
|
150
|
+
const fetchFn = passed.fetchFn ?? input.fetchFn;
|
|
151
|
+
if (fetchFn) ctx.fetchFn = fetchFn;
|
|
152
|
+
return runFrom(index + 1, ctx, send);
|
|
153
|
+
}), "a middleware", "the Response, usually `return next(requestContext)`", void 0, "resolved with");
|
|
129
154
|
};
|
|
130
|
-
return
|
|
155
|
+
return (ctx, send) => runFrom(0, ctx, send);
|
|
131
156
|
}
|
|
132
157
|
//#endregion
|
|
133
158
|
//#region src/response/schema-validation.ts
|
|
134
159
|
const pathOf = (issue) => (issue.path ?? []).map((part) => String(typeof part === "object" && part !== null ? part.key : part)).join(".");
|
|
135
160
|
/**
|
|
136
|
-
* `.json(schema)` got a body that does not match. Not an
|
|
137
|
-
* request succeeded — the data is what is wrong.
|
|
161
|
+
* `.json(schema)` got a body that does not match the schema. Not an
|
|
162
|
+
* ArthronError: the request succeeded — the data is what is wrong.
|
|
138
163
|
*/
|
|
139
|
-
var
|
|
140
|
-
name = "
|
|
164
|
+
var SchemaMismatchError = class extends Error {
|
|
165
|
+
name = "SchemaMismatchError";
|
|
141
166
|
/** Every problem the validator reported, with the path to it. */
|
|
142
167
|
issues;
|
|
143
168
|
constructor(issues) {
|
|
@@ -148,10 +173,10 @@ var SchemaError = class extends Error {
|
|
|
148
173
|
this.issues = issues;
|
|
149
174
|
}
|
|
150
175
|
};
|
|
151
|
-
/** Validate `
|
|
152
|
-
async function validate(schema,
|
|
153
|
-
const result = await schema["~standard"].validate(
|
|
154
|
-
if (result.issues) throw new
|
|
176
|
+
/** Validate `body`; resolve with the schema's output or reject with a SchemaMismatchError. */
|
|
177
|
+
async function validate(schema, body) {
|
|
178
|
+
const result = await schema["~standard"].validate(body);
|
|
179
|
+
if (result.issues) throw new SchemaMismatchError(result.issues);
|
|
155
180
|
return result.value;
|
|
156
181
|
}
|
|
157
182
|
//#endregion
|
|
@@ -206,24 +231,24 @@ async function* lines(response, maxLineLength) {
|
|
|
206
231
|
* Provider sentinels like
|
|
207
232
|
* `[DONE]` are passed through untouched — they are not part of the spec.
|
|
208
233
|
*/
|
|
209
|
-
async function* parseSse(response, { maxLineLength = DEFAULT_LIMIT,
|
|
234
|
+
async function* parseSse(response, { maxLineLength = DEFAULT_LIMIT, maxDataLength = DEFAULT_LIMIT } = {}) {
|
|
210
235
|
let data = [];
|
|
211
236
|
let size = 0;
|
|
212
|
-
let
|
|
237
|
+
let type;
|
|
213
238
|
let id;
|
|
214
239
|
let lastEventId = "";
|
|
215
|
-
let
|
|
240
|
+
let reconnectionTime;
|
|
216
241
|
const flush = () => {
|
|
217
242
|
const out = data.length === 0 ? void 0 : {
|
|
243
|
+
type: type || "message",
|
|
218
244
|
data: data.join("\n"),
|
|
219
245
|
lastEventId
|
|
220
246
|
};
|
|
221
|
-
if (out && event !== void 0) out.event = event;
|
|
222
247
|
if (out && id !== void 0) out.id = id;
|
|
223
|
-
if (out &&
|
|
248
|
+
if (out && reconnectionTime !== void 0) out.reconnectionTime = reconnectionTime;
|
|
224
249
|
data = [];
|
|
225
250
|
size = 0;
|
|
226
|
-
|
|
251
|
+
type = id = void 0;
|
|
227
252
|
return out;
|
|
228
253
|
};
|
|
229
254
|
for await (const line of lines(response, maxLineLength)) {
|
|
@@ -240,16 +265,16 @@ async function* parseSse(response, { maxLineLength = DEFAULT_LIMIT, maxEventSize
|
|
|
240
265
|
switch (field) {
|
|
241
266
|
case "data":
|
|
242
267
|
size += value.length + 1;
|
|
243
|
-
if (size >
|
|
268
|
+
if (size > maxDataLength + 1) throw new RangeError(`arthron: an SSE event's data is longer than ${maxDataLength} characters — pass a larger maxDataLength to .sse() if that is expected`);
|
|
244
269
|
data.push(value);
|
|
245
270
|
break;
|
|
246
271
|
case "event":
|
|
247
|
-
|
|
272
|
+
type = value;
|
|
248
273
|
break;
|
|
249
274
|
case "id":
|
|
250
275
|
if (!value.includes("\0")) id = lastEventId = value;
|
|
251
276
|
break;
|
|
252
|
-
case "retry": if (/^\d+$/.test(value))
|
|
277
|
+
case "retry": if (/^\d+$/.test(value)) reconnectionTime = Number(value);
|
|
253
278
|
}
|
|
254
279
|
}
|
|
255
280
|
}
|
|
@@ -264,7 +289,7 @@ async function* parseNdjson(response, { maxLineLength = DEFAULT_LIMIT } = {}) {
|
|
|
264
289
|
}
|
|
265
290
|
}
|
|
266
291
|
//#endregion
|
|
267
|
-
//#region src/response/
|
|
292
|
+
//#region src/response/response-promise.ts
|
|
268
293
|
/** Defer the Response until iteration starts, so the helper itself never rejects. */
|
|
269
294
|
function iterate(promise, parse, signal) {
|
|
270
295
|
promise.catch(() => {});
|
|
@@ -280,14 +305,14 @@ function iterate(promise, parse, signal) {
|
|
|
280
305
|
* Sugar over `Promise<Response>`: `.json()` is `(await p).json()`. Awaiting
|
|
281
306
|
* without a helper still yields the untouched `Response`.
|
|
282
307
|
*/
|
|
283
|
-
function
|
|
284
|
-
const read = (
|
|
308
|
+
function toResponsePromise(promise, signal) {
|
|
309
|
+
const read = (readAs) => promise.then(readAs).catch((error) => {
|
|
285
310
|
throw cancellationError(error, signal);
|
|
286
311
|
});
|
|
287
312
|
return Object.assign(promise, {
|
|
288
313
|
json: ((schema) => read(async (res) => {
|
|
289
|
-
const
|
|
290
|
-
return schema ? validate(schema,
|
|
314
|
+
const body = await res.json();
|
|
315
|
+
return schema ? validate(schema, body) : body;
|
|
291
316
|
})),
|
|
292
317
|
text: () => read((res) => res.text()),
|
|
293
318
|
blob: () => read((res) => res.blob()),
|
|
@@ -298,19 +323,75 @@ function toArthronPromise(promise, signal) {
|
|
|
298
323
|
});
|
|
299
324
|
}
|
|
300
325
|
//#endregion
|
|
301
|
-
//#region src/
|
|
326
|
+
//#region src/pipeline/create-plugin.ts
|
|
327
|
+
/** The slots a plugin may fill. */
|
|
328
|
+
const SLOTS = [
|
|
329
|
+
"middleware",
|
|
330
|
+
"requestInterceptor",
|
|
331
|
+
"responseInterceptor",
|
|
332
|
+
"errorInterceptor"
|
|
333
|
+
];
|
|
334
|
+
/** 1.x slot names: a plugin that still uses one would have it ignored. */
|
|
335
|
+
const REPLACED_SLOTS = {
|
|
336
|
+
request: "requestInterceptor",
|
|
337
|
+
response: "responseInterceptor",
|
|
338
|
+
error: "errorInterceptor"
|
|
339
|
+
};
|
|
340
|
+
/**
|
|
341
|
+
* Throws a TypeError for what a plugin can get wrong where TypeScript does
|
|
342
|
+
* not look — JS, a cast, an object built at runtime: not an object, no
|
|
343
|
+
* pluginName, a key it does not take (a typo, a 1.x name), a slot that is not
|
|
344
|
+
* a function, or nothing to run. `createPlugin` runs it where the plugin is
|
|
345
|
+
* written; `use` and `plugins` run it again on whatever they are given.
|
|
346
|
+
*/
|
|
347
|
+
function checkPlugin(plugin) {
|
|
348
|
+
if (typeof plugin !== "object" || plugin === null) throw new TypeError(`arthron: a plugin is an object, got ${plugin === null ? "null" : `a ${typeof plugin}`} — e.g. createPlugin({ pluginName: "trace", middleware: fn })`);
|
|
349
|
+
const fields = plugin;
|
|
350
|
+
const own = (key) => Object.hasOwn(fields, key) ? fields[key] : void 0;
|
|
351
|
+
const given = fields.pluginName ?? own("name");
|
|
352
|
+
const label = typeof given === "string" && given !== "" ? `plugin "${given}"` : "a plugin";
|
|
353
|
+
if (own("name") !== void 0) throw new TypeError(`arthron: ${label}: the name field is called pluginName since 2.0 — rename it in the plugin`);
|
|
354
|
+
for (const [old, now] of Object.entries(REPLACED_SLOTS)) if (own(old) !== void 0) throw new TypeError(`arthron: ${label}: the ${old} interceptor is called ${now} since 2.0 — rename it in the plugin`);
|
|
355
|
+
if (typeof fields.pluginName !== "string" || fields.pluginName === "") throw new TypeError("arthron: a plugin needs a pluginName — e.g. createPlugin({ pluginName: \"trace\", … })");
|
|
356
|
+
for (const key of Object.keys(fields)) if (key !== "pluginName" && !SLOTS.includes(key)) throw new TypeError(`arthron: ${label} has an unknown key "${key}" — use pluginName, middleware, requestInterceptor, responseInterceptor or errorInterceptor; keep state in a closure, in a function that returns createPlugin({ … })`);
|
|
357
|
+
for (const slot of SLOTS) if (fields[slot] !== void 0 && typeof fields[slot] !== "function") throw new TypeError(`arthron: ${label}: ${slot} must be a function`);
|
|
358
|
+
if (SLOTS.every((slot) => fields[slot] === void 0)) throw new TypeError(`arthron: ${label} has nothing to run — add middleware, requestInterceptor, responseInterceptor or errorInterceptor`);
|
|
359
|
+
}
|
|
360
|
+
/**
|
|
361
|
+
* A plugin, checked where it is written and typed without annotations:
|
|
362
|
+
* `createPlugin({ pluginName: "trace", requestInterceptor: (requestContext) => … })`.
|
|
363
|
+
*/
|
|
364
|
+
function createPlugin(plugin) {
|
|
365
|
+
checkPlugin(plugin);
|
|
366
|
+
return plugin;
|
|
367
|
+
}
|
|
368
|
+
function aFunction(value, helper, example) {
|
|
369
|
+
if (typeof value !== "function") throw new TypeError(`arthron: ${helper} needs a function — e.g. ${example}`);
|
|
370
|
+
return value;
|
|
371
|
+
}
|
|
372
|
+
/** A middleware written on its own, typed without annotations. */
|
|
373
|
+
const createMiddleware = (middleware) => aFunction(middleware, "createMiddleware", "createMiddleware((requestContext, next) => next(requestContext))");
|
|
374
|
+
/** A request interceptor written on its own, typed without annotations. */
|
|
375
|
+
const createRequestInterceptor = (interceptor) => aFunction(interceptor, "createRequestInterceptor", "createRequestInterceptor((requestContext) => requestContext)");
|
|
376
|
+
/** A response interceptor written on its own, typed without annotations. */
|
|
377
|
+
const createResponseInterceptor = (interceptor) => aFunction(interceptor, "createResponseInterceptor", "createResponseInterceptor((response) => response)");
|
|
378
|
+
/** An error interceptor written on its own, typed without annotations. */
|
|
379
|
+
const createErrorInterceptor = (interceptor) => aFunction(interceptor, "createErrorInterceptor", "createErrorInterceptor((error) => error)");
|
|
380
|
+
//#endregion
|
|
381
|
+
//#region src/client/resolve-options.ts
|
|
302
382
|
/**
|
|
303
|
-
*
|
|
304
|
-
* default. Typed so that a new
|
|
305
|
-
* listed here — otherwise it would be sent to fetch.
|
|
383
|
+
* Option keys that configure arthron itself; every other key is a fetch
|
|
384
|
+
* default. Typed so that a new option key fails to compile until it is
|
|
385
|
+
* listed here — otherwise it would be sent to fetch. `headers` is a fetch
|
|
386
|
+
* field too, but one with arthron's own merge rules.
|
|
306
387
|
*/
|
|
307
388
|
const OWN_KEYS = {
|
|
308
389
|
baseURL: true,
|
|
309
|
-
|
|
390
|
+
allowedOrigins: true,
|
|
310
391
|
headers: true,
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
392
|
+
fetchFn: true,
|
|
393
|
+
plugins: true,
|
|
394
|
+
extractDescription: true,
|
|
314
395
|
throwOn: true
|
|
315
396
|
};
|
|
316
397
|
/** Fields that belong to one request, refused as client defaults. */
|
|
@@ -320,15 +401,27 @@ const PER_CALL_ONLY = [
|
|
|
320
401
|
"method"
|
|
321
402
|
];
|
|
322
403
|
/**
|
|
323
|
-
*
|
|
324
|
-
*
|
|
325
|
-
*
|
|
326
|
-
|
|
404
|
+
* 1.x config keys and what replaced them. Left alone, each would become an
|
|
405
|
+
* unknown key, then a fetch default, and be ignored: plugins not applied, a
|
|
406
|
+
* test's fake fetch passed over for the real network.
|
|
407
|
+
*/
|
|
408
|
+
const REPLACED = {
|
|
409
|
+
fetch: "fetchFn",
|
|
410
|
+
use: "plugins",
|
|
411
|
+
errorDetail: "extractDescription",
|
|
412
|
+
allowAbsoluteUrls: "allowedOrigins"
|
|
413
|
+
};
|
|
414
|
+
/**
|
|
415
|
+
* Add plugins to a list, each checked as `createPlugin` checks it. A plugin
|
|
416
|
+
* takes the place of the one already there with its pluginName — same position,
|
|
417
|
+
* so a replaced `logging()` stays outermost and a second `retry()` does not
|
|
418
|
+
* multiply attempts. Other names append.
|
|
327
419
|
*/
|
|
328
420
|
function addPlugins(base, added) {
|
|
329
421
|
const out = [...base];
|
|
330
422
|
for (const plugin of added) {
|
|
331
|
-
|
|
423
|
+
checkPlugin(plugin);
|
|
424
|
+
const at = out.findIndex((p) => p.pluginName === plugin.pluginName);
|
|
332
425
|
if (at === -1) out.push(plugin);
|
|
333
426
|
else out[at] = plugin;
|
|
334
427
|
}
|
|
@@ -339,29 +432,55 @@ function fetchDefaults(config) {
|
|
|
339
432
|
return Object.fromEntries(Object.entries(config).filter(([key, value]) => value !== void 0 && !(key in OWN_KEYS)));
|
|
340
433
|
}
|
|
341
434
|
/** Normalize once so `extend` can merge headers and add plugins cheaply. */
|
|
342
|
-
function
|
|
435
|
+
function resolveClientOptions(config) {
|
|
343
436
|
for (const key of PER_CALL_ONLY) if (config[key] !== void 0) throw new TypeError(`arthron: ${key} cannot be a client default, it belongs to one request — pass it per call (api.get(path, { signal }), api.post(path, body), api.request(path, { method }))`);
|
|
344
|
-
const {
|
|
345
|
-
|
|
437
|
+
for (const [old, now] of Object.entries(REPLACED)) if (config[old] !== void 0) throw new TypeError(`arthron: the ${old} option was replaced by ${now} in 2.0 — pass arthron({ ${now} })`);
|
|
438
|
+
const { headers, plugins, allowedOrigins, ...rest } = config;
|
|
439
|
+
if (rest.fetchFn !== void 0 && typeof rest.fetchFn !== "function") throw new TypeError(`arthron: fetchFn must be a function with fetch's signature, got ${kindOf(rest.fetchFn)} — e.g. arthron({ fetchFn: fetch })`);
|
|
440
|
+
if (rest.baseURL !== void 0) checkBaseURL(rest.baseURL);
|
|
441
|
+
if (allowedOrigins !== void 0 && !Array.isArray(allowedOrigins)) throw new TypeError(`arthron: allowedOrigins takes a list of URLs, got ${kindOf(allowedOrigins)} — e.g. allowedOrigins: ["https://cdn.example.com"]`);
|
|
442
|
+
const record = toHeaderRecord(headers);
|
|
443
|
+
if (rest.baseURL === void 0 && allowedOrigins !== void 0 && allowedOrigins.length > 0 && Object.keys(record).length > 0) throw new TypeError("arthron: config headers go to baseURL's origin only, and this client has allowedOrigins but no baseURL — set baseURL, or pass these headers per call");
|
|
444
|
+
const resolved = {
|
|
346
445
|
...rest,
|
|
347
|
-
headers:
|
|
348
|
-
|
|
446
|
+
headers: record,
|
|
447
|
+
plugins: addPlugins([], plugins ?? [])
|
|
349
448
|
};
|
|
449
|
+
if (allowedOrigins !== void 0) resolved.allowedOrigins = [...allowedOrigins];
|
|
450
|
+
return resolved;
|
|
451
|
+
}
|
|
452
|
+
/** "a string", "an object", "null" — for messages about a value of the wrong kind. */
|
|
453
|
+
function kindOf(value) {
|
|
454
|
+
if (value === null) return "null";
|
|
455
|
+
const kind = typeof value;
|
|
456
|
+
return /^[aeiou]/.test(kind) ? `an ${kind}` : `a ${kind}`;
|
|
457
|
+
}
|
|
458
|
+
/**
|
|
459
|
+
* An http(s) baseURL must name a host. `https://${HOST}/api` with HOST unset
|
|
460
|
+
* is "https:///api", which a URL parser reads as host "api" — and a relative
|
|
461
|
+
* path appended to "https://" chooses the host itself.
|
|
462
|
+
*/
|
|
463
|
+
function checkBaseURL(baseURL) {
|
|
464
|
+
if (!/^https?:\/\//i.test(baseURL)) return;
|
|
465
|
+
if (!/^https?:\/\/(?:[/\\?#]|$)/i.test(baseURL) && httpOrigin(baseURL)) return;
|
|
466
|
+
throw new TypeError(`arthron: baseURL "${withoutSecrets(baseURL)}" has no host — pass a full URL such as "https://api.example.com" (an unset environment variable?)`);
|
|
350
467
|
}
|
|
351
468
|
//#endregion
|
|
352
469
|
//#region src/client/send.ts
|
|
353
470
|
/**
|
|
354
471
|
* The global fetch rejects a malformed URL or method with a TypeError that
|
|
355
|
-
* looks just like a network failure (status 0, retried).
|
|
356
|
-
* runs the same checks
|
|
357
|
-
*
|
|
358
|
-
*
|
|
472
|
+
* looks just like a network failure (status 0, retried). Once fetch has
|
|
473
|
+
* failed, a bodiless `Request` runs the same checks, so those become argument
|
|
474
|
+
* errors instead — at no cost to a call that goes through. Only for the
|
|
475
|
+
* global fetch: an injected one owns its URL rules (SvelteKit's server-side
|
|
476
|
+
* `fetch` accepts relative URLs, for one).
|
|
359
477
|
*/
|
|
360
478
|
function assertSendable(url, method) {
|
|
361
479
|
if (typeof Request !== "function") return;
|
|
362
480
|
try {
|
|
363
481
|
new Request(url, { method });
|
|
364
482
|
} catch (cause) {
|
|
483
|
+
redactErrorUrl(cause, url);
|
|
365
484
|
const reason = redactUrlIn(cause instanceof Error ? cause.message : String(cause), url);
|
|
366
485
|
throw new TypeError(`arthron: cannot send ${method} ${redactUrl(url)} (${reason}) — use an absolute URL or a baseURL with a scheme (https://…), and a valid HTTP method`, { cause });
|
|
367
486
|
}
|
|
@@ -386,23 +505,23 @@ function failedByDefault(res, init) {
|
|
|
386
505
|
}
|
|
387
506
|
/** The one place a failure becomes an ArthronError. Cancellation passes through. */
|
|
388
507
|
async function send(resolved, ctx, throwOn) {
|
|
389
|
-
const
|
|
390
|
-
if (
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
}
|
|
508
|
+
const fetchFn = ctx.fetchFn ?? resolved.fetchFn ?? globalThis.fetch;
|
|
509
|
+
if (typeof fetchFn !== "function") throw new TypeError(`arthron: requestContext.fetchFn must be a function with fetch's signature, got ${fetchFn === null ? "null" : `a ${typeof fetchFn}`} — a plugin set it; return { ...requestContext, fetchFn: fn }`);
|
|
510
|
+
const runtimeFetch = resolved.fetchFn === void 0;
|
|
511
|
+
const method = ctx.init.method ?? "GET";
|
|
512
|
+
if (runtimeFetch) assertStreamable(ctx.url, method, ctx.init.body);
|
|
395
513
|
const { signal } = ctx.init;
|
|
396
514
|
let res;
|
|
397
515
|
try {
|
|
398
|
-
res = await
|
|
516
|
+
res = await fetchFn(ctx.url, ctx.init);
|
|
399
517
|
} catch (thrown) {
|
|
400
518
|
if (isCancellation(thrown, signal)) throw cancellationError(thrown, signal);
|
|
519
|
+
if (runtimeFetch) assertSendable(ctx.url, method);
|
|
401
520
|
throw networkError(thrown, ctx);
|
|
402
521
|
}
|
|
403
522
|
if (res.ok) return res;
|
|
404
523
|
if (!(throwOn ? throwOn(res) : failedByDefault(res, ctx.init))) return res;
|
|
405
|
-
const error = await responseError(res, ctx, resolved.
|
|
524
|
+
const error = await responseError(res, ctx, resolved.extractDescription);
|
|
406
525
|
if (signal?.aborted) throw signal.reason;
|
|
407
526
|
throw error;
|
|
408
527
|
}
|
|
@@ -421,19 +540,30 @@ const STANDARD_METHODS = /* @__PURE__ */ new Set([
|
|
|
421
540
|
"QUERY"
|
|
422
541
|
]);
|
|
423
542
|
/**
|
|
424
|
-
*
|
|
543
|
+
* 1.x per-call option names and what replaced them. Left in init they would
|
|
544
|
+
* reach fetch and be ignored: {id} sent unfilled, the query left off.
|
|
545
|
+
*/
|
|
546
|
+
const REPLACED_PER_CALL = {
|
|
547
|
+
path: "pathParams",
|
|
548
|
+
params: "queryParams"
|
|
549
|
+
};
|
|
550
|
+
/**
|
|
551
|
+
* Build a client from its options. The result is immutable — `use` and `extend`
|
|
425
552
|
* return new clients and never touch the one they were called on.
|
|
426
553
|
*/
|
|
427
|
-
function arthron(
|
|
428
|
-
const resolved =
|
|
554
|
+
function arthron(clientOptions = {}) {
|
|
555
|
+
const resolved = resolveClientOptions(clientOptions);
|
|
429
556
|
const initDefaults = fetchDefaults(resolved);
|
|
430
|
-
const
|
|
557
|
+
const allowed = resolved.allowedOrigins && originSet(resolved.allowedOrigins);
|
|
558
|
+
const pipeline = createPipeline(resolved.plugins);
|
|
559
|
+
const call = (path, method, rawBody, { queryParams, headers: callHeaders, meta, throwOn = resolved.throwOn, pathParams, ...init }) => {
|
|
431
560
|
try {
|
|
561
|
+
for (const [old, now] of Object.entries(REPLACED_PER_CALL)) if (init[old] !== void 0) throw new TypeError(`arthron: the ${old} option was replaced by ${now} in 2.0 — pass { ${now}: { … } }`);
|
|
432
562
|
const upper = method.toUpperCase();
|
|
433
563
|
const verb = STANDARD_METHODS.has(upper) ? upper : method;
|
|
434
|
-
if (rawBody !== void 0 && BODYLESS_METHODS.has(upper)) throw new TypeError(`arthron: ${upper} requests cannot carry a body — send it as
|
|
435
|
-
if (
|
|
436
|
-
const url = resolveUrl(resolved.baseURL, path,
|
|
564
|
+
if (rawBody !== void 0 && BODYLESS_METHODS.has(upper)) throw new TypeError(`arthron: ${upper} requests cannot carry a body — send it as queryParams or switch to POST`);
|
|
565
|
+
if (pathParams) path = fillPath(path, pathParams);
|
|
566
|
+
const url = resolveUrl(resolved.baseURL, path, queryParams, allowed);
|
|
437
567
|
const defaults = leavesBase(resolved.baseURL, path) ? void 0 : resolved.headers;
|
|
438
568
|
const { body, headers } = serializeBody(rawBody, mergeHeaders(defaults, callHeaders));
|
|
439
569
|
const requestInit = {
|
|
@@ -444,66 +574,44 @@ function arthron(config = {}) {
|
|
|
444
574
|
};
|
|
445
575
|
if (body !== void 0) requestInit.body = body;
|
|
446
576
|
if (isReadableStream(body)) Object.assign(requestInit, { duplex: "half" });
|
|
447
|
-
return
|
|
577
|
+
return toResponsePromise(pipeline({
|
|
448
578
|
url,
|
|
449
579
|
init: requestInit,
|
|
450
580
|
meta: { ...meta },
|
|
451
|
-
|
|
581
|
+
fetchFn: resolved.fetchFn ?? globalThis.fetch
|
|
452
582
|
}, (ctx) => send(resolved, ctx, throwOn)), init.signal);
|
|
453
583
|
} catch (thrown) {
|
|
454
|
-
return
|
|
584
|
+
return toResponsePromise(Promise.reject(thrown));
|
|
455
585
|
}
|
|
456
586
|
};
|
|
457
|
-
const derive = (
|
|
587
|
+
const derive = (changes) => {
|
|
458
588
|
return arthron({
|
|
459
589
|
...resolved,
|
|
460
|
-
...
|
|
461
|
-
headers: mergeHeaders(resolved.headers,
|
|
462
|
-
|
|
590
|
+
...changes,
|
|
591
|
+
headers: mergeHeaders(resolved.headers, changes.headers),
|
|
592
|
+
plugins: addPlugins(resolved.plugins, changes.plugins ?? [])
|
|
463
593
|
});
|
|
464
594
|
};
|
|
465
595
|
return {
|
|
466
|
-
get: (path,
|
|
467
|
-
delete: (path,
|
|
468
|
-
head: (path,
|
|
469
|
-
post: (path, body,
|
|
470
|
-
put: (path, body,
|
|
471
|
-
patch: (path, body,
|
|
472
|
-
query: (path, body,
|
|
473
|
-
request: (path,
|
|
474
|
-
const { method, body, ...rest } =
|
|
475
|
-
if (!method) return
|
|
476
|
-
return
|
|
596
|
+
get: (path, requestOptions = {}) => call(path, "GET", void 0, requestOptions),
|
|
597
|
+
delete: (path, requestOptions = {}) => call(path, "DELETE", void 0, requestOptions),
|
|
598
|
+
head: (path, requestOptions = {}) => call(path, "HEAD", void 0, requestOptions),
|
|
599
|
+
post: (path, body, requestOptions = {}) => call(path, "POST", body, requestOptions),
|
|
600
|
+
put: (path, body, requestOptions = {}) => call(path, "PUT", body, requestOptions),
|
|
601
|
+
patch: (path, body, requestOptions = {}) => call(path, "PATCH", body, requestOptions),
|
|
602
|
+
query: (path, body, requestOptions = {}) => call(path, "QUERY", body, requestOptions),
|
|
603
|
+
request: (path, requestOptions) => {
|
|
604
|
+
const { method, body, ...rest } = requestOptions;
|
|
605
|
+
if (!method) return toResponsePromise(Promise.reject(/* @__PURE__ */ new TypeError("arthron: request() needs a method — e.g. request(path, { method: \"OPTIONS\" }); use get/post/... for the common verbs")));
|
|
606
|
+
return call(path, method, body, rest);
|
|
477
607
|
},
|
|
478
|
-
use: (...plugins) => derive({
|
|
479
|
-
extend: (
|
|
480
|
-
without: (...
|
|
608
|
+
use: (...plugins) => derive({ plugins }),
|
|
609
|
+
extend: (changes) => derive(changes),
|
|
610
|
+
without: (...pluginNames) => arthron({
|
|
481
611
|
...resolved,
|
|
482
|
-
|
|
612
|
+
plugins: resolved.plugins.filter((p) => !pluginNames.includes(p.pluginName))
|
|
483
613
|
})
|
|
484
614
|
};
|
|
485
615
|
}
|
|
486
616
|
//#endregion
|
|
487
|
-
|
|
488
|
-
/** Identity helper: gives a middleware written in its own file the right parameter types. */
|
|
489
|
-
const defineMiddleware = (middleware) => middleware;
|
|
490
|
-
/** Identity helpers for each interceptor kind — `defineInterceptor.request(fn)` etc. */
|
|
491
|
-
const defineInterceptor = {
|
|
492
|
-
request: (interceptor) => interceptor,
|
|
493
|
-
response: (interceptor) => interceptor,
|
|
494
|
-
error: (interceptor) => interceptor
|
|
495
|
-
};
|
|
496
|
-
/** Identity helper: type-checks a plugin object literal without an annotation. */
|
|
497
|
-
const definePlugin = (plugin) => plugin;
|
|
498
|
-
//#endregion
|
|
499
|
-
//#region src/index.ts
|
|
500
|
-
/** @deprecated Import from "arthron/plugins"; this export goes in the next major. */
|
|
501
|
-
const logging = logging$1;
|
|
502
|
-
/** @deprecated Import from "arthron/plugins"; this export goes in the next major. */
|
|
503
|
-
const retry = retry$1;
|
|
504
|
-
/** @deprecated Import from "arthron/plugins"; this export goes in the next major. */
|
|
505
|
-
const timeout = timeout$1;
|
|
506
|
-
//#endregion
|
|
507
|
-
export { ArthronError, SchemaError, arthron, defineInterceptor, defineMiddleware, definePlugin, isArthronError, logging, retry, timeout };
|
|
508
|
-
|
|
509
|
-
//# sourceMappingURL=index.mjs.map
|
|
617
|
+
export { ArthronError, SchemaMismatchError, arthron, createErrorInterceptor, createMiddleware, createPlugin, createRequestInterceptor, createResponseInterceptor, isArthronError };
|