@simpleapps-com/augur-api 2026.11.3 → 2026.11.5
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 +40 -3
- package/dist/client.d.ts +31 -1
- package/dist/client.d.ts.map +1 -1
- package/dist/core/base-client.d.ts.map +1 -1
- package/dist/core/call-rules.d.ts +35 -0
- package/dist/core/call-rules.d.ts.map +1 -1
- package/dist/core/call.d.ts +2 -2
- package/dist/core/call.d.ts.map +1 -1
- package/dist/core/client-rules.d.ts +152 -0
- package/dist/core/client-rules.d.ts.map +1 -0
- package/dist/core/client.d.ts +36 -5
- package/dist/core/client.d.ts.map +1 -1
- package/dist/core/config.d.ts +24 -0
- package/dist/core/config.d.ts.map +1 -1
- package/dist/core/encoded-segment.d.ts +7 -1
- package/dist/core/encoded-segment.d.ts.map +1 -1
- package/dist/core/errors.d.ts.map +1 -1
- package/dist/core/http-rules.d.ts +0 -32
- package/dist/core/http-rules.d.ts.map +1 -1
- package/dist/core/proxy-rules.d.ts +53 -0
- package/dist/core/proxy-rules.d.ts.map +1 -1
- package/dist/core/registry-rules.d.ts +7 -0
- package/dist/core/registry-rules.d.ts.map +1 -1
- package/dist/core/registry.d.ts.map +1 -1
- package/dist/core/response-rules.d.ts +15 -0
- package/dist/core/response-rules.d.ts.map +1 -1
- package/dist/core/schemas.d.ts.map +1 -1
- package/dist/core/service-proxy.d.ts.map +1 -1
- package/dist/index.d.ts +2 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +774 -327
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +774 -327
- package/dist/index.mjs.map +1 -1
- package/dist/services/goog-mc/generated/schemas.d.ts +8 -0
- package/dist/services/goog-mc/generated/schemas.d.ts.map +1 -1
- package/dist/services/goog-mc/generated/types.d.ts +8 -0
- package/dist/services/goog-mc/generated/types.d.ts.map +1 -1
- package/dist/services/items/client.d.ts +1 -1
- package/dist/services/items/generated/endpoints.d.ts.map +1 -1
- package/dist/services/items/generated/schemas.d.ts +8 -0
- package/dist/services/items/generated/schemas.d.ts.map +1 -1
- package/dist/services/items/generated/types.d.ts +13 -4
- package/dist/services/items/generated/types.d.ts.map +1 -1
- package/dist/services/joomla/generated/endpoints.d.ts.map +1 -1
- package/dist/services/joomla/generated/schemas.d.ts +5 -0
- package/dist/services/joomla/generated/schemas.d.ts.map +1 -1
- package/dist/services/joomla/generated/types.d.ts +18 -2
- package/dist/services/joomla/generated/types.d.ts.map +1 -1
- package/dist/services/legacy/generated/endpoints.d.ts.map +1 -1
- package/dist/services/legacy/generated/schemas.d.ts +2 -0
- package/dist/services/legacy/generated/schemas.d.ts.map +1 -1
- package/dist/services/legacy/generated/types.d.ts +4 -0
- package/dist/services/legacy/generated/types.d.ts.map +1 -1
- package/dist/services/open-search/generated/endpoints.d.ts.map +1 -1
- package/dist/services/open-search/generated/schemas.d.ts +2 -0
- package/dist/services/open-search/generated/schemas.d.ts.map +1 -1
- package/dist/services/open-search/generated/types.d.ts +4 -0
- package/dist/services/open-search/generated/types.d.ts.map +1 -1
- package/dist/testing.d.ts.map +1 -1
- package/dist/testing.js +22 -9
- package/dist/testing.js.map +1 -1
- package/dist/testing.mjs +20 -9
- package/dist/testing.mjs.map +1 -1
- package/dist/utils/cross-site-auth.d.ts.map +1 -1
- package/package.json +3 -1
package/README.md
CHANGED
|
@@ -88,10 +88,44 @@ const config: AugurAPIConfig = {
|
|
|
88
88
|
};
|
|
89
89
|
const api = new AugurAPI(config);
|
|
90
90
|
|
|
91
|
-
// From context (for framework integration)
|
|
91
|
+
// From context (for framework integration). Options override the context's values, but can't
|
|
92
|
+
// remove its token: that throws ContextCreationError (field "bearerToken").
|
|
92
93
|
const api = AugurAPI.fromContext(context);
|
|
93
94
|
```
|
|
94
95
|
|
|
96
|
+
`timeout` is per attempt: with `retries: 3`, a slow service can hold one call for four
|
|
97
|
+
timeouts plus backoff. `setAuthToken` and `setSiteId` reach every service read from the client
|
|
98
|
+
afterwards; a service object read before the change keeps the old values, so read services from
|
|
99
|
+
the client after a change rather than holding them across it.
|
|
100
|
+
|
|
101
|
+
## Bounding a Call
|
|
102
|
+
|
|
103
|
+
`withRequest` gives a view of the client whose every call is bounded (atlas#106):
|
|
104
|
+
|
|
105
|
+
```typescript
|
|
106
|
+
// The whole call, every retry and the waits between them, within 5 s
|
|
107
|
+
const items = await api.withRequest({ deadline: 5000 }).items.categories.items.list(uid, params);
|
|
108
|
+
|
|
109
|
+
// Or cancel it yourself
|
|
110
|
+
const controller = new AbortController();
|
|
111
|
+
const view = api.withRequest({ signal: controller.signal });
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
- `deadline` (ms) bounds the whole call. Each attempt still has its per-attempt `timeout`, cut to
|
|
115
|
+
what is left. At the deadline the call rejects with a `TimeoutError` DOMException.
|
|
116
|
+
- `signal` cancels the call: the request in flight is aborted and nothing is retried. An
|
|
117
|
+
`AbortSignal.timeout(ms)` signal works the same, rejecting with its `TimeoutError`.
|
|
118
|
+
- The view keeps the client's siteId, token, timeouts, retries and hooks, and sends the same
|
|
119
|
+
headers. It builds its own service clients, so make one view per bounded call.
|
|
120
|
+
- A view of a view keeps every bound: both signals, and the earlier deadline.
|
|
121
|
+
- `withRequest` throws `InvalidArgumentError` for a `signal` that isn't an `AbortSignal` or a
|
|
122
|
+
`deadline` outside 0 to 2147483647 ms (NaN or Infinity included): options can arrive from a
|
|
123
|
+
browser through a server action.
|
|
124
|
+
- An identical GET already in flight on the same client is shared, unless either carries its own
|
|
125
|
+
per-request `signal`: then each runs on its own, so one caller's cancel never ends another's.
|
|
126
|
+
- A server render that awaits a read SHOULD bound it; augur-server's `queryActionWith` does
|
|
127
|
+
this for a method path.
|
|
128
|
+
|
|
95
129
|
## Edge Caching
|
|
96
130
|
|
|
97
131
|
Enable Cloudflare edge caching on any GET request using the `edgeCache` parameter:
|
|
@@ -215,7 +249,9 @@ Developed in the Atlas monorepo (`packages/augur-api`), moved from `simpleapps-c
|
|
|
215
249
|
siteId rule from `@atlas/auth-core/site`), `src/core/registry-rules.ts` (`hasBodyFor`, `isReadEntry`) and
|
|
216
250
|
`src/core/response-rules.ts` (list metadata normalisation), listed in
|
|
217
251
|
`LemmaScript-files.txt` and linked to `models/AugurApi.dfy`
|
|
218
|
-
(`models/links/augur-api-core-*.dfy`)
|
|
252
|
+
(`models/links/augur-api-core-*.dfy`); `src/core/client-rules.ts` (fromContext's refusals,
|
|
253
|
+
retries under a call's signal, abort names, the call deadline) is linked to
|
|
254
|
+
`models/AugurApiClient.dfy`, the model of the client object (`src/client.ts`). The path-segment checks (`hasLoneSurrogate`,
|
|
219
255
|
`isEncoded`) and the service id rule (`kebabCamel`, shared with the generator) are proved in
|
|
220
256
|
`@atlas/utils` (`uri`, `case`) and bundled into the build. The rest of the client's decisions are modelled in
|
|
221
257
|
`models/AugurApi.dfy`, and the generator's in `models/AugurApiGen.dfy`, ahead of their proofs.
|
|
@@ -233,7 +269,8 @@ pnpm smoke:workerd # after build: the bundle in workerd, endpoints() and one
|
|
|
233
269
|
```
|
|
234
270
|
|
|
235
271
|
The live suites in `tests/e2e/` read credentials from the Atlas project's `.simpleapps/` and
|
|
236
|
-
are not part of the gates.
|
|
272
|
+
are not part of the gates. `pnpm -C repo/packages/augur-api live:bounded` checks bounded calls
|
|
273
|
+
(`withRequest`) against the real services, read-only. The story CLI (`tests/e2e/stories/run-json-story.ts`) has no
|
|
237
274
|
TypeScript runner in Atlas yet (augur-api ran it with ts-node).
|
|
238
275
|
|
|
239
276
|
## Deployment
|
package/dist/client.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { type CallArgs, type CallResult } from "./core/call";
|
|
2
|
-
import { type AugurAPIConfig, type AugurContext } from "./core/config";
|
|
2
|
+
import { type AugurAPIConfig, type AugurContext, type CallOptions } from "./core/config";
|
|
3
3
|
import { type EndpointEntry } from "./core/registry";
|
|
4
4
|
import { JoomlaClient } from "./services/joomla";
|
|
5
5
|
import { CommerceClient } from "./services/commerce";
|
|
@@ -116,6 +116,8 @@ export type { AugurContext } from "./core/config";
|
|
|
116
116
|
*/
|
|
117
117
|
export declare class AugurAPI {
|
|
118
118
|
private config;
|
|
119
|
+
/** This client's call bounds: none, unless it is a view from `withRequest`. */
|
|
120
|
+
private bounds;
|
|
119
121
|
private _joomla?;
|
|
120
122
|
private _commerce?;
|
|
121
123
|
private _pricing?;
|
|
@@ -173,6 +175,26 @@ export declare class AugurAPI {
|
|
|
173
175
|
* ```
|
|
174
176
|
*/
|
|
175
177
|
call(id: string, args?: CallArgs): Promise<CallResult>;
|
|
178
|
+
/**
|
|
179
|
+
* A view of this client whose every call is bounded by `options` (atlas#106): the caller's
|
|
180
|
+
* `signal`, and a `deadline` in milliseconds for the whole call, retries and the waits between
|
|
181
|
+
* them included. The view has this client's siteId, token, timeouts, retries and hooks, sends
|
|
182
|
+
* the same headers, and builds its own service clients (sharing no in-flight request with this
|
|
183
|
+
* one). Building a view and its first service costs about what building this client did, so
|
|
184
|
+
* make one per bounded call, not per request inside a loop.
|
|
185
|
+
*
|
|
186
|
+
* @example
|
|
187
|
+
* ```typescript
|
|
188
|
+
* const items = await api.withRequest({ deadline: 5000 }).items.categories.items.list(uid, params);
|
|
189
|
+
* ```
|
|
190
|
+
*
|
|
191
|
+
* @throws InvalidArgumentError when `signal` is given but not an AbortSignal, or `deadline` is
|
|
192
|
+
* given but not a number from 0 to 2147483647 (NaN, Infinity or larger would fire at once).
|
|
193
|
+
* Options can come from a browser through a server action, so their shape is checked.
|
|
194
|
+
*/
|
|
195
|
+
withRequest(options: CallOptions): AugurAPI;
|
|
196
|
+
/** The HTTP client a service is built with: this client's config and call bounds. */
|
|
197
|
+
private httpFor;
|
|
176
198
|
/**
|
|
177
199
|
* Create AugurAPI client from context object
|
|
178
200
|
*
|
|
@@ -321,11 +343,19 @@ export declare class AugurAPI {
|
|
|
321
343
|
get basecamp2(): Basecamp2Client;
|
|
322
344
|
/**
|
|
323
345
|
* Update authentication token
|
|
346
|
+
*
|
|
347
|
+
* Every service read from this client afterwards (`api.items`, …) sends the new token. A
|
|
348
|
+
* service object read BEFORE the change keeps the token it was built with: read services from
|
|
349
|
+
* the client after a change, don't hold them across it (AugurApiClient.BuiltClientKeepsItsSnapshot).
|
|
350
|
+
*
|
|
324
351
|
* @param bearerToken New bearer token
|
|
325
352
|
*/
|
|
326
353
|
setAuthToken(bearerToken: string): void;
|
|
327
354
|
/**
|
|
328
355
|
* Update site ID
|
|
356
|
+
*
|
|
357
|
+
* As with `setAuthToken`: a service object read before the change keeps the old siteId.
|
|
358
|
+
*
|
|
329
359
|
* @param siteId New site ID
|
|
330
360
|
* @throws InvalidArgumentError when it is not a siteId (see the constructor)
|
|
331
361
|
*/
|
package/dist/client.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,KAAK,QAAQ,EAAE,KAAK,UAAU,EAAE,MAAM,aAAa,CAAC;
|
|
1
|
+
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,KAAK,QAAQ,EAAE,KAAK,UAAU,EAAE,MAAM,aAAa,CAAC;AAU3E,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,YAAY,EAEjB,KAAK,WAAW,EAGjB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAqC,KAAK,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAExF,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAChE,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEvD;;GAEG;AACH,YAAY,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAyClD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8EG;AACH,qBAAa,QAAQ;IACnB,OAAO,CAAC,MAAM,CAAiB;IAC/B,+EAA+E;IAC/E,OAAO,CAAC,MAAM,CAAyB;IACvC,OAAO,CAAC,OAAO,CAAC,CAAe;IAC/B,OAAO,CAAC,SAAS,CAAC,CAAiB;IACnC,OAAO,CAAC,QAAQ,CAAC,CAAgB;IACjC,OAAO,CAAC,IAAI,CAAC,CAAY;IACzB,OAAO,CAAC,WAAW,CAAC,CAAmB;IACvC,OAAO,CAAC,MAAM,CAAC,CAAc;IAC7B,OAAO,CAAC,OAAO,CAAC,CAAe;IAC/B,OAAO,CAAC,QAAQ,CAAC,CAAgB;IACjC,OAAO,CAAC,UAAU,CAAC,CAAkB;IACrC,OAAO,CAAC,OAAO,CAAC,CAAe;IAC/B,OAAO,CAAC,OAAO,CAAC,CAAe;IAC/B,OAAO,CAAC,SAAS,CAAC,CAAiB;IACnC,OAAO,CAAC,QAAQ,CAAC,CAAgB;IACjC,OAAO,CAAC,OAAO,CAAC,CAAe;IAC/B,OAAO,CAAC,QAAQ,CAAC,CAAgB;IACjC,OAAO,CAAC,QAAQ,CAAC,CAAgB;IACjC,OAAO,CAAC,YAAY,CAAC,CAAoB;IACzC,OAAO,CAAC,OAAO,CAAC,CAAe;IAC/B,OAAO,CAAC,YAAY,CAAC,CAAoB;IACzC,OAAO,CAAC,UAAU,CAAC,CAAkB;IACrC,OAAO,CAAC,QAAQ,CAAC,CAAgB;IACjC,OAAO,CAAC,cAAc,CAAC,CAAsB;IAC7C,OAAO,CAAC,QAAQ,CAAC,CAAgB;IACjC,OAAO,CAAC,QAAQ,CAAC,CAAgB;IACjC,OAAO,CAAC,QAAQ,CAAC,CAAgB;IACjC,OAAO,CAAC,SAAS,CAAC,CAAiB;IACnC,OAAO,CAAC,cAAc,CAAC,CAAsB;IAC7C,OAAO,CAAC,IAAI,CAAC,CAAY;IACzB,OAAO,CAAC,QAAQ,CAAC,CAAgB;IACjC,OAAO,CAAC,UAAU,CAAC,CAAkB;IAErC,mEAAmE;IACnE,MAAM,CAAC,QAAQ,CAAC,eAAe,KAAoB;IAEnD;;;;OAIG;gBACS,MAAM,EAAE,cAAc;IAKlC;;;OAGG;IACH,MAAM,CAAC,SAAS,IAAI,aAAa,EAAE;IAInC;;;;;;;;;;;;OAYG;IACH,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC;IAItD;;;;;;;;;;;;;;;;OAgBG;IACH,WAAW,CAAC,OAAO,EAAE,WAAW,GAAG,QAAQ;IA4B3C,qFAAqF;IACrF,OAAO,CAAC,OAAO;IAIf;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,GAAE,OAAO,CAAC,cAAc,CAAM,GAAG,QAAQ;IAuB1F;;OAEG;IACH,IAAI,MAAM,IAAI,YAAY,CAMzB;IAED;;OAEG;IACH,IAAI,QAAQ,IAAI,cAAc,CAM7B;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,aAAa,CAM3B;IAED;;OAEG;IACH,IAAI,GAAG,IAAI,SAAS,CAMnB;IAED;;OAEG;IACH,IAAI,UAAU,IAAI,gBAAgB,CAMjC;IAED;;OAEG;IACH,IAAI,KAAK,IAAI,WAAW,CAMvB;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,YAAY,CAMzB;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,aAAa,CAM3B;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,eAAe,CAM/B;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,YAAY,CAMzB;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,YAAY,CAMzB;IAED;;OAEG;IACH,IAAI,QAAQ,IAAI,cAAc,CAM7B;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,aAAa,CAM3B;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,YAAY,CAMzB;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,aAAa,CAM3B;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,aAAa,CAM3B;IAED;;OAEG;IACH,IAAI,WAAW,IAAI,iBAAiB,CAMnC;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,YAAY,CAMzB;IAED;;OAEG;IACH,IAAI,WAAW,IAAI,iBAAiB,CAMnC;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,eAAe,CAM/B;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,aAAa,CAM3B;IAED;;OAEG;IACH,IAAI,aAAa,IAAI,mBAAmB,CAMvC;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,aAAa,CAM3B;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,aAAa,CAM3B;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,aAAa,CAM3B;IAED;;OAEG;IACH,IAAI,QAAQ,IAAI,cAAc,CAM7B;IAED;;OAEG;IACH,IAAI,aAAa,IAAI,mBAAmB,CAMvC;IAED;;OAEG;IACH,IAAI,GAAG,IAAI,SAAS,CAMnB;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,aAAa,CAM3B;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,eAAe,CAM/B;IAED;;;;;;;;OAQG;IACH,YAAY,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI;IAMvC;;;;;;;OAOG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAM/B,8FAA8F;IAC9F,OAAO,CAAC,YAAY;CAgCrB"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"base-client.d.ts","sourceRoot":"","sources":["../../src/core/base-client.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"base-client.d.ts","sourceRoot":"","sources":["../../src/core/base-client.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAU3C,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,eAAe,EAAE,KAAK,QAAQ,EAAE,KAAK,UAAU,EAAE,MAAM,WAAW,CAAC;AACpG,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAE7B;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,CAAC;AAE3D;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,kCAAkC;IAClC,MAAM,EAAE,UAAU,CAAC;IACnB,oDAAoD;IACpD,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,YAAY,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAChD,uDAAuD;IACvD,YAAY,CAAC,EAAE,CAAC,CAAC,aAAa,CAAC;IAC/B,kDAAkD;IAClD,cAAc,EAAE,CAAC,CAAC,aAAa,CAAC;CACjC;AAED,2FAA2F;AAC3F,YAAY,EAAE,YAAY,EAAE,CAAC;AAE7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,8BAAsB,iBAAiB;IACrC,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IACvC,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IACpC,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAKnC,+DAA+D;IAC/D,QAAQ,CAAC,WAAW;mBACT,OAAO,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;MAE/C;IAEF,8CAA8C;IAC9C,QAAQ,CAAC,eAAe;mBACP,OAAO,CAAC,eAAe,CAAC;MACvC;IAEF,0CAA0C;IAC1C,QAAQ,CAAC,IAAI;mBACF,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;MAExC;IAEF,sCAAsC;IACtC,QAAQ,CAAC,QAAQ;mBACA,OAAO,CAAC,QAAQ,CAAC;MAChC;IAEF,2DAA2D;IAC3D,QAAQ,CAAC,MAAM;mBACJ,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;MAE1C;IAEF,wCAAwC;IACxC,QAAQ,CAAC,UAAU;mBACF,OAAO,CAAC,UAAU,CAAC;MAClC;IAEF;;;;;OAKG;gBACS,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM;IAMlE;;;;;;;;;;;;;;;OAeG;cACa,cAAc,CAAC,OAAO,GAAG,OAAO,EAAE,SAAS,GAAG,OAAO,EACnE,MAAM,EAAE,cAAc,EACtB,MAAM,CAAC,EAAE,OAAO,EAChB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,EAC5C,KAAK,CAAC,EAAE,OAAO,GACd,OAAO,CAAC,SAAS,CAAC;IAiBrB;;OAEG;IACH,OAAO,CAAC,eAAe;IAOvB;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAmB1B;;;;;;;OAOG;YACW,kBAAkB;IAwBhC;;;;;;OAMG;IACH,OAAO,CAAC,qBAAqB;IAmB7B;;;;;;;;;;;;;;;;OAgBG;IACH,OAAO,CAAC,iBAAiB;CA+B1B"}
|
|
@@ -1,3 +1,38 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* call()'s envelope: the body counts only when it is a plain object (not null, not an array)
|
|
3
|
+
* holding every one of the 8 keys.
|
|
4
|
+
*
|
|
5
|
+
* @ensures exactly the model's EnvelopeBody
|
|
6
|
+
*/
|
|
7
|
+
export declare function isEnvelopeBody(isPlainObject: boolean, allKeys: boolean): boolean;
|
|
8
|
+
/** What call()'s result body is. */
|
|
9
|
+
export type BodyKind = "json" | "text";
|
|
10
|
+
/**
|
|
11
|
+
* call()'s result body: the parsed JSON when the text is JSON, else the raw text.
|
|
12
|
+
*
|
|
13
|
+
* @ensures exactly the model's CallBodyKind
|
|
14
|
+
*/
|
|
15
|
+
export declare function callBodyKind(isJson: boolean): BodyKind;
|
|
16
|
+
/** Which validation failed: the request's params or the API's response. */
|
|
17
|
+
export type ValidationKind = "params" | "response";
|
|
18
|
+
/**
|
|
19
|
+
* A validation error's message, naming which side failed (base-client.ts).
|
|
20
|
+
*
|
|
21
|
+
* @ensures exactly the model's ValidationMessageOf
|
|
22
|
+
*/
|
|
23
|
+
export declare function validationMessageOf(kind: ValidationKind): string;
|
|
24
|
+
/**
|
|
25
|
+
* An issue's code: its type, or "unknown" (issues built outside valibot can lack one).
|
|
26
|
+
*
|
|
27
|
+
* @ensures exactly the model's IssueCodeOf
|
|
28
|
+
*/
|
|
29
|
+
export declare function issueCodeOf(type: string | undefined): string;
|
|
30
|
+
/**
|
|
31
|
+
* Whether a validation error's text lists its issues: only when it has some.
|
|
32
|
+
*
|
|
33
|
+
* @ensures exactly the model's AppendsIssues
|
|
34
|
+
*/
|
|
35
|
+
export declare function appendsIssues(count: number): boolean;
|
|
1
36
|
/**
|
|
2
37
|
* A query key is allowed when the entry declares it, or it is `edgeCache` on an edge-cached
|
|
3
38
|
* entry.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"call-rules.d.ts","sourceRoot":"","sources":["../../src/core/call-rules.ts"],"names":[],"mappings":"AAOA;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAI7F;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAIvE;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAIhE;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAIpE;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAI7E;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAIhD;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAInD;AAED,yEAAyE;AACzE,MAAM,MAAM,WAAW,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,GAAG,WAAW,CAAC;AAEnE;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,GAAG,WAAW,CAK9F;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAK7E;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAIxE;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAG5F"}
|
|
1
|
+
{"version":3,"file":"call-rules.d.ts","sourceRoot":"","sources":["../../src/core/call-rules.ts"],"names":[],"mappings":"AAOA;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,aAAa,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAIhF;AAED,oCAAoC;AACpC,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,MAAM,CAAC;AAEvC;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,OAAO,GAAG,QAAQ,CAKtD;AAED,2EAA2E;AAC3E,MAAM,MAAM,cAAc,GAAG,QAAQ,GAAG,UAAU,CAAC;AAEnD;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,cAAc,GAAG,MAAM,CAOhE;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,CAK5D;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAIpD;AAMD;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAI7F;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAIvE;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAIhE;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAIpE;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAI7E;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAIhD;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAInD;AAED,yEAAyE;AACzE,MAAM,MAAM,WAAW,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,GAAG,WAAW,CAAC;AAEnE;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,GAAG,WAAW,CAK9F;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAK7E;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAIxE;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAG5F"}
|
package/dist/core/call.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type
|
|
1
|
+
import { type AugurAPIConfig, type CallBounds } from "./config";
|
|
2
2
|
import { type EndpointEntry } from "./registry";
|
|
3
3
|
/** What `call()` sends. Keys are sent as given; there is no case renaming. */
|
|
4
4
|
export interface CallArgs {
|
|
@@ -44,5 +44,5 @@ export declare function fillPath(entry: EndpointEntry, pathParams: Record<string
|
|
|
44
44
|
* @throws InvalidArgumentError before any I/O when the id is unknown or `args` break checkArgs
|
|
45
45
|
* @throws AugurError subclasses for non-2xx and network failures, with `endpoint` = entry.path
|
|
46
46
|
*/
|
|
47
|
-
export declare function callEndpoint(config: AugurAPIConfig, id: string, args?: CallArgs): Promise<CallResult>;
|
|
47
|
+
export declare function callEndpoint(config: AugurAPIConfig, id: string, args?: CallArgs, bounds?: CallBounds): Promise<CallResult>;
|
|
48
48
|
//# sourceMappingURL=call.d.ts.map
|
package/dist/core/call.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"call.d.ts","sourceRoot":"","sources":["../../src/core/call.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"call.d.ts","sourceRoot":"","sources":["../../src/core/call.ts"],"names":[],"mappings":"AAqBA,OAAO,EAAE,KAAK,cAAc,EAAE,KAAK,UAAU,EAAa,MAAM,UAAU,CAAC;AAK3E,OAAO,EAAmB,KAAK,aAAa,EAAE,MAAM,YAAY,CAAC;AAEjE,8EAA8E;AAC9E,MAAM,WAAW,QAAQ;IACvB,uCAAuC;IACvC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;IAC7C,wFAAwF;IACxF,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,sCAAsC;IACtC,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED,iFAAiF;AACjF,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE,OAAO,CAAC;IACf,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,OAAO,CAAC;IAChB,MAAM,EAAE,OAAO,CAAC;IAChB,KAAK,EAAE,OAAO,CAAC;IACf,YAAY,EAAE,OAAO,CAAC;CACvB;AAED,sBAAsB;AACtB,MAAM,WAAW,UAAU;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,8EAA8E;IAC9E,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAC;IAC1B,8EAA8E;IAC9E,IAAI,EAAE,OAAO,CAAC;CACf;AA+DD;;;;GAIG;AACH,wBAAgB,QAAQ,CACtB,KAAK,EAAE,aAAa,EACpB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,GAC1C,MAAM,CAQR;AAgBD;;;;;;;;;GASG;AACH,wBAAsB,YAAY,CAChC,MAAM,EAAE,cAAc,EACtB,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,QAAa,EACnB,MAAM,GAAE,UAAsB,GAC7B,OAAO,CAAC,UAAU,CAAC,CAmBrB"}
|
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
/** What fromContext refuses, if anything. */
|
|
2
|
+
export type ContextRefusal = "ok" | "context" | "site-id" | "token" | "token-removed";
|
|
3
|
+
/**
|
|
4
|
+
* fromContext's own refusals, in order: no context; no siteId; no jwt or bearerToken in the
|
|
5
|
+
* context; options that removed the context's token. The siteId's shape is the constructor's.
|
|
6
|
+
*
|
|
7
|
+
* @ensures exactly the model's ContextRefusalOf
|
|
8
|
+
*/
|
|
9
|
+
export declare function contextRefusalOf(hasContext: boolean, siteIdTruthy: boolean, contextTokenTruthy: boolean, finalTokenTruthy: boolean): ContextRefusal;
|
|
10
|
+
/**
|
|
11
|
+
* An error worth retrying: anything but an AugurError whose status is final (`isRetryableError`).
|
|
12
|
+
*
|
|
13
|
+
* @ensures exactly the model's Retryable
|
|
14
|
+
*/
|
|
15
|
+
export declare function retryableError(isAugurError: boolean, status: number): boolean;
|
|
16
|
+
/**
|
|
17
|
+
* Attempt `attempt` (from 0) is retried while attempts remain and the error is retryable, and
|
|
18
|
+
* never once the call's own signal (the caller's, or its deadline) has fired: decided from the
|
|
19
|
+
* call signal, not the error, since the client's per-attempt timer raises an AbortError too.
|
|
20
|
+
*
|
|
21
|
+
* @ensures exactly the model's RetryAfterCall
|
|
22
|
+
*/
|
|
23
|
+
export declare function retryAfterCall(attempt: number, retries: number, retryable: boolean, callAborted: boolean): boolean;
|
|
24
|
+
/**
|
|
25
|
+
* Whether an attempt sets its own timer: only when its per-attempt timeout ends before the
|
|
26
|
+
* deadline. When the deadline is as tight or tighter, the call's one deadline timer cuts the
|
|
27
|
+
* attempt (with a TimeoutError); a second timer for the same instant could fire first and end the
|
|
28
|
+
* call with a bare AbortError.
|
|
29
|
+
*
|
|
30
|
+
* @ensures exactly the model's NeedsAttemptTimer
|
|
31
|
+
*/
|
|
32
|
+
export declare function needsAttemptTimer(perAttempt: number, hasDeadline: boolean, remaining: number): boolean;
|
|
33
|
+
/**
|
|
34
|
+
* A call is bounded (gets a scope with a signal) when it has a signal or a deadline.
|
|
35
|
+
*
|
|
36
|
+
* @ensures exactly the model's BoundedCall
|
|
37
|
+
*/
|
|
38
|
+
export declare function boundedCall(hasSignal: boolean, hasDeadline: boolean): boolean;
|
|
39
|
+
/**
|
|
40
|
+
* A deadline setTimeout keeps: 0 to 2^31 − 1 ms. At runtime NaN fails both comparisons and
|
|
41
|
+
* Infinity the second; setTimeout would fire either (or anything larger) at once.
|
|
42
|
+
*
|
|
43
|
+
* @ensures exactly the model's DeadlineInRange
|
|
44
|
+
*/
|
|
45
|
+
export declare function deadlineInRange(deadline: number): boolean;
|
|
46
|
+
/**
|
|
47
|
+
* The call options `withRequest` accepts: a signal, when given, an AbortSignal; a deadline, when
|
|
48
|
+
* given, in range. A server action can carry any JSON from the browser, so the shape is checked.
|
|
49
|
+
*
|
|
50
|
+
* @ensures exactly the model's CallOptionsAccepted
|
|
51
|
+
*/
|
|
52
|
+
export declare function callOptionsAccepted(hasSignal: boolean, isAbortSignal: boolean, hasDeadline: boolean, inRange: boolean): boolean;
|
|
53
|
+
/**
|
|
54
|
+
* Whether a GET joins an identical one already in flight: only when it carries no per-request
|
|
55
|
+
* signal. A joined call shares the first call's signal, so one of its own could neither cancel it
|
|
56
|
+
* nor be kept from cancelling the other caller.
|
|
57
|
+
*
|
|
58
|
+
* @ensures exactly the model's SharesInFlight
|
|
59
|
+
*/
|
|
60
|
+
export declare function sharesInFlight(hasRequestSignal: boolean): boolean;
|
|
61
|
+
/**
|
|
62
|
+
* The deadline of a view made from a view: the earlier of the two (both run from the call's
|
|
63
|
+
* start), or the one given when only one is. Read only when `hasMergedDeadline`.
|
|
64
|
+
*
|
|
65
|
+
* @ensures exactly the model's MergedDeadline (with `hasMergedDeadline`)
|
|
66
|
+
*/
|
|
67
|
+
export declare function mergedDeadlineOf(hasOuter: boolean, outer: number, hasInner: boolean, inner: number): number;
|
|
68
|
+
/**
|
|
69
|
+
* Whether a view made from a view has a deadline: when either does.
|
|
70
|
+
*
|
|
71
|
+
* @ensures with mergedDeadlineOf, exactly the model's MergedDeadline
|
|
72
|
+
*/
|
|
73
|
+
export declare function hasMergedDeadline(hasOuter: boolean, hasInner: boolean): boolean;
|
|
74
|
+
/** How an `edgeCache` value travels. */
|
|
75
|
+
export type EdgeCacheKind = "sub-hour" | "hourly" | "invalid";
|
|
76
|
+
/**
|
|
77
|
+
* An `edgeCache` value's kind (transformEdgeCacheParams, which reads it as `String(value)`):
|
|
78
|
+
* exactly the documented values, sub-hour "30s", "1m", "5m" and hourly "1"-"5" and "8" (a number
|
|
79
|
+
* reads as the same text); anything else is dropped. Not `parseInt`: that read "2abc", "1.5" and
|
|
80
|
+
* "08" as hours (tightened 2026-11-10).
|
|
81
|
+
*
|
|
82
|
+
* @ensures exactly the model's EdgeCacheKindOf
|
|
83
|
+
*/
|
|
84
|
+
export declare function edgeCacheKindOf(text: string): EdgeCacheKind;
|
|
85
|
+
/**
|
|
86
|
+
* The edge directive's name: `cacheSiteId<value>` for a valid value, "" for an invalid one
|
|
87
|
+
* (dropped). Its value is the client's `SiteId` (proved `isSiteId` at construction; model
|
|
88
|
+
* EdgeDirectiveCarriesASiteId), and each name has its zone rule (EveryDirectiveHasItsZoneRule).
|
|
89
|
+
*
|
|
90
|
+
* @ensures exactly the model's EdgeCacheKeyOf
|
|
91
|
+
*/
|
|
92
|
+
export declare function edgeCacheKeyOf(kind: EdgeCacheKind, text: string): string;
|
|
93
|
+
/** The error class a status gets: four with their own class, every other the base one. */
|
|
94
|
+
export type ErrorClassName = "validation" | "authentication" | "notFound" | "rateLimit" | "augur";
|
|
95
|
+
/**
|
|
96
|
+
* The one status → error class switch, shared by typed methods and call().
|
|
97
|
+
*
|
|
98
|
+
* @ensures exactly the model's ErrorClassOf
|
|
99
|
+
*/
|
|
100
|
+
export declare function errorClassOf(status: number): ErrorClassName;
|
|
101
|
+
/**
|
|
102
|
+
* The message an error body gives: its `message` only when the body is JSON, an object, and the
|
|
103
|
+
* message a non-empty string. A non-JSON body (an HTML error page) never reaches it.
|
|
104
|
+
*
|
|
105
|
+
* @ensures exactly the model's DetailMessageOf
|
|
106
|
+
*/
|
|
107
|
+
export declare function detailMessageOf(isJson: boolean, isObject: boolean, isText: boolean, message: string): string | undefined;
|
|
108
|
+
/**
|
|
109
|
+
* Each error class's fixed text; the base error's names the status.
|
|
110
|
+
*
|
|
111
|
+
* @ensures exactly the model's DefaultMessageOf
|
|
112
|
+
*/
|
|
113
|
+
export declare function defaultMessageOf(kind: ErrorClassName, status: number): string;
|
|
114
|
+
/**
|
|
115
|
+
* The error's message: the body's when it gave one, else the class's fixed text.
|
|
116
|
+
*
|
|
117
|
+
* @ensures exactly the model's ErrorMessageOf
|
|
118
|
+
*/
|
|
119
|
+
export declare function errorMessageOf(given: string | undefined, kind: ErrorClassName, status: number): string;
|
|
120
|
+
/**
|
|
121
|
+
* The signed-in user's id as text: a Joomla user id is an integer at least 1, so only a PosInt
|
|
122
|
+
* (`posIntOf` found one: `isId`) becomes its decimal text; anything else reports no id. Was
|
|
123
|
+
* `String(id)` for any number ("0", "-1", "1.5").
|
|
124
|
+
*
|
|
125
|
+
* @ensures exactly the model's CrossSiteUserIdOf
|
|
126
|
+
*/
|
|
127
|
+
export declare function crossSiteUserIdOf(isId: boolean, id: number): string | undefined;
|
|
128
|
+
/** Which response hook runs. */
|
|
129
|
+
export type ResponseHook = "onResponse" | "onError" | "noHook";
|
|
130
|
+
/**
|
|
131
|
+
* The response hook for a response: onResponse only on a 2xx, onError only on a failure, each
|
|
132
|
+
* only when configured (model HooksFollowTheOutcome).
|
|
133
|
+
*
|
|
134
|
+
* @ensures exactly the model's ResponseHookOf
|
|
135
|
+
*/
|
|
136
|
+
export declare function responseHookOf(ok: boolean, hasOnError: boolean, hasOnResponse: boolean): ResponseHook;
|
|
137
|
+
/** A cross-site sign-in's outcome. */
|
|
138
|
+
export type CrossSiteOutcome = "signedIn" | "notVerified" | "noToken";
|
|
139
|
+
/**
|
|
140
|
+
* Cross-site sign-in (utils/cross-site-auth.ts): refused unless verified; verified with no
|
|
141
|
+
* non-empty text token is no token; only then signed in, so only such a token becomes a bearer.
|
|
142
|
+
*
|
|
143
|
+
* @ensures exactly the model's CrossSiteOutcomeOf
|
|
144
|
+
*/
|
|
145
|
+
export declare function crossSiteOutcomeOf(isVerified: boolean, tokenIsText: boolean, token: string): CrossSiteOutcome;
|
|
146
|
+
/**
|
|
147
|
+
* `raw()` retries a GET like `get()`; anything else makes one attempt.
|
|
148
|
+
*
|
|
149
|
+
* @ensures exactly the model's RawRetries
|
|
150
|
+
*/
|
|
151
|
+
export declare function rawRetries(method: string): boolean;
|
|
152
|
+
//# sourceMappingURL=client-rules.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"client-rules.d.ts","sourceRoot":"","sources":["../../src/core/client-rules.ts"],"names":[],"mappings":"AASA,6CAA6C;AAC7C,MAAM,MAAM,cAAc,GAAG,IAAI,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,GAAG,eAAe,CAAC;AAEtF;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAC9B,UAAU,EAAE,OAAO,EACnB,YAAY,EAAE,OAAO,EACrB,kBAAkB,EAAE,OAAO,EAC3B,gBAAgB,EAAE,OAAO,GACxB,cAAc,CAWhB;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,YAAY,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAI7E;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAC5B,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,OAAO,EAClB,WAAW,EAAE,OAAO,GACnB,OAAO,CAKT;AAMD;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAC/B,UAAU,EAAE,MAAM,EAClB,WAAW,EAAE,OAAO,EACpB,SAAS,EAAE,MAAM,GAChB,OAAO,CAIT;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,SAAS,EAAE,OAAO,EAAE,WAAW,EAAE,OAAO,GAAG,OAAO,CAI7E;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAIzD;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,SAAS,EAAE,OAAO,EAClB,aAAa,EAAE,OAAO,EACtB,WAAW,EAAE,OAAO,EACpB,OAAO,EAAE,OAAO,GACf,OAAO,CAIT;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,gBAAgB,EAAE,OAAO,GAAG,OAAO,CAIjE;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,OAAO,EACjB,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,OAAO,EACjB,KAAK,EAAE,MAAM,GACZ,MAAM,CAQR;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,GAAG,OAAO,CAI/E;AAED,wCAAwC;AACxC,MAAM,MAAM,aAAa,GAAG,UAAU,GAAG,QAAQ,GAAG,SAAS,CAAC;AAE9D;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,CAS3D;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAKxE;AAED,0FAA0F;AAC1F,MAAM,MAAM,cAAc,GAAG,YAAY,GAAG,gBAAgB,GAAG,UAAU,GAAG,WAAW,GAAG,OAAO,CAAC;AAElG;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,cAAc,CAY3D;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,OAAO,EACf,QAAQ,EAAE,OAAO,EACjB,MAAM,EAAE,OAAO,EACf,OAAO,EAAE,MAAM,GACd,MAAM,GAAG,SAAS,CAMpB;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAc7E;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAC5B,KAAK,EAAE,MAAM,GAAG,SAAS,EACzB,IAAI,EAAE,cAAc,EACpB,MAAM,EAAE,MAAM,GACb,MAAM,CAOR;AAED;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAO/E;AAED,gCAAgC;AAChC,MAAM,MAAM,YAAY,GAAG,YAAY,GAAG,SAAS,GAAG,QAAQ,CAAC;AAE/D;;;;;GAKG;AACH,wBAAgB,cAAc,CAC5B,EAAE,EAAE,OAAO,EACX,UAAU,EAAE,OAAO,EACnB,aAAa,EAAE,OAAO,GACrB,YAAY,CAOd;AAED,sCAAsC;AACtC,MAAM,MAAM,gBAAgB,GAAG,UAAU,GAAG,aAAa,GAAG,SAAS,CAAC;AAEtE;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAChC,UAAU,EAAE,OAAO,EACnB,WAAW,EAAE,OAAO,EACpB,KAAK,EAAE,MAAM,GACZ,gBAAgB,CAQlB;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAIlD"}
|
package/dist/core/client.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { type AugurAPIConfig, type RequestConfig } from "./config";
|
|
1
|
+
import { type AugurAPIConfig, type CallBounds, type RequestConfig } from "./config";
|
|
2
2
|
/** A response as text, before any JSON parsing (what `call()` builds its result from). */
|
|
3
3
|
export interface RawResponse {
|
|
4
4
|
status: number;
|
|
@@ -24,9 +24,22 @@ export declare class HTTPClient {
|
|
|
24
24
|
private config;
|
|
25
25
|
private serviceName;
|
|
26
26
|
private inflightRequests;
|
|
27
|
-
|
|
27
|
+
private bounds;
|
|
28
28
|
/**
|
|
29
|
-
*
|
|
29
|
+
* The siteId this client sends (`x-site-id`, and the value of every `cacheSiteId` edge
|
|
30
|
+
* directive): a `SiteId`, so only a proved `isSiteId` string reaches the header or Cloudflare's
|
|
31
|
+
* cache key (AugurApiClient.EdgeDirectiveCarriesASiteId; owner 2026-11-10).
|
|
32
|
+
*/
|
|
33
|
+
private siteId;
|
|
34
|
+
/**
|
|
35
|
+
* `bounds` bound every call this client makes (a view's, from `AugurAPI.withRequest`).
|
|
36
|
+
*
|
|
37
|
+
* @throws InvalidArgumentError when `config.siteId` is not a siteId (as `AugurAPI` does)
|
|
38
|
+
*/
|
|
39
|
+
constructor(serviceName: string, config: AugurAPIConfig, bounds?: CallBounds);
|
|
40
|
+
/**
|
|
41
|
+
* Build request headers with auth. A request's own headers come before `x-site-id` and
|
|
42
|
+
* `Authorization`, so neither can be replaced by one (AugurApiClient.SiteIdHeaderIsTheClients).
|
|
30
43
|
*/
|
|
31
44
|
private buildRequestHeaders;
|
|
32
45
|
/**
|
|
@@ -46,12 +59,23 @@ export declare class HTTPClient {
|
|
|
46
59
|
* the result, inside the same error handling and timeout as the fetch.
|
|
47
60
|
*/
|
|
48
61
|
private request;
|
|
49
|
-
/**
|
|
62
|
+
/**
|
|
63
|
+
* An attempt's timeout (the per-attempt one, cut to what is left of the call's deadline: what
|
|
64
|
+
* the onRequest hook sees) and whether it sets its own timer: only when it ends before the
|
|
65
|
+
* deadline; otherwise the call's one deadline timer cuts it, with a TimeoutError
|
|
66
|
+
* (client-rules.ts; AugurApiClient.OneTimerCutsEachAttempt).
|
|
67
|
+
*/
|
|
68
|
+
private attemptBounds;
|
|
69
|
+
/** The signal one attempt is sent with, and how to clear its timer and listeners after. */
|
|
70
|
+
private attemptSignal;
|
|
71
|
+
/** The request's timeout: per request, else the client's, else the default (firstGiven). */
|
|
50
72
|
private timeoutFor;
|
|
51
73
|
/** The request as the `onRequest` hook receives it. */
|
|
52
74
|
private baseRequest;
|
|
53
75
|
/**
|
|
54
|
-
* Merge
|
|
76
|
+
* Merge the call's signal and an attempt's timer: aborts when either fires, with that one's
|
|
77
|
+
* reason. `dispose` removes the listener from the call's signal, which outlives the attempt
|
|
78
|
+
* (one per attempt would pile up on a long-lived caller signal).
|
|
55
79
|
*/
|
|
56
80
|
private mergeSignals;
|
|
57
81
|
/**
|
|
@@ -71,10 +95,17 @@ export declare class HTTPClient {
|
|
|
71
95
|
* Executes a single request attempt
|
|
72
96
|
*/
|
|
73
97
|
private executeAttempt;
|
|
98
|
+
/**
|
|
99
|
+
* One attempt, started only while the call's deadline has time left (client-rules.ts
|
|
100
|
+
* startsAttempt); past it the call rejects with a TimeoutError.
|
|
101
|
+
*/
|
|
102
|
+
private attemptWithin;
|
|
74
103
|
/**
|
|
75
104
|
* Executes a request with retry logic
|
|
76
105
|
*/
|
|
77
106
|
private executeWithRetry;
|
|
107
|
+
/** Runs `fn` in a fresh call scope and disposes it, however `fn` settles. */
|
|
108
|
+
private withinCall;
|
|
78
109
|
/**
|
|
79
110
|
* Transform edgeCache parameter to Cloudflare's cacheSiteId format
|
|
80
111
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/core/client.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/core/client.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,KAAK,cAAc,EAInB,KAAK,UAAU,EAGf,KAAK,aAAa,EACnB,MAAM,UAAU,CAAC;AAuClB,0FAA0F;AAC1F,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;CACd;AASD,mGAAmG;AACnG,wBAAgB,SAAS,CACvB,IAAI,EAAE,MAAM,GAAG,SAAS,GACvB;IAAE,IAAI,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,OAAO,CAAA;CAAE,GAAG;IAAE,IAAI,EAAE,KAAK,CAAA;CAAE,CAMlD;AA0DD;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,MAAM,CAIxF;AAkKD,qBAAa,UAAU;IACrB,OAAO,CAAC,MAAM,CAAiB;IAC/B,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,gBAAgB,CAA4C;IACpE,OAAO,CAAC,MAAM,CAAa;IAC3B;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAS;IAEvB;;;;OAIG;gBACS,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAE,UAAsB;IAOvF;;;OAGG;IACH,OAAO,CAAC,mBAAmB;IAe3B;;OAEG;YACW,gBAAgB;IAmC9B;;OAEG;YACW,kBAAkB;IA0BhC;;OAEG;YACW,OAAO;IAyBrB;;;OAGG;YACW,OAAO;IAuCrB;;;;;OAKG;IACH,OAAO,CAAC,aAAa;IAYrB,2FAA2F;IAC3F,OAAO,CAAC,aAAa;IAoBrB,4FAA4F;IAC5F,OAAO,CAAC,UAAU;IAYlB,uDAAuD;IACvD,OAAO,CAAC,WAAW;IAgBnB;;;;OAIG;IACH,OAAO,CAAC,YAAY;IAmBpB;;;;;;OAMG;IACH,OAAO,CAAC,eAAe;IAIvB;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAY1B,OAAO,CAAC,kBAAkB;IAU1B;;OAEG;YACW,cAAc;IAgC5B;;;OAGG;IACH,OAAO,CAAC,aAAa;IAOrB;;OAEG;YACW,gBAAgB;IAO9B,6EAA6E;YAC/D,UAAU;IAYxB;;;;;;;;;;;;;;;;OAgBG;IACH,OAAO,CAAC,wBAAwB;IA8B1B,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,CAAC,CAAC;IAqCzE,IAAI,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,CAAC,CAAC;IAO1F,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,CAAC,CAAC;IAOzF,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,CAAC,CAAC;IAOlF;;;;;OAKG;IACG,GAAG,CACP,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,EACX,OAAO,GAAE;QAAE,MAAM,CAAC,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,OAAO,CAAC;QAAC,MAAM,CAAC,EAAE,aAAa,CAAA;KAAO,GACzE,OAAO,CAAC,WAAW,CAAC;CAYxB"}
|
package/dist/core/config.d.ts
CHANGED
|
@@ -40,6 +40,30 @@ export interface RequestConfig {
|
|
|
40
40
|
/** Path template reported as `endpoint` in errors, e.g. `/inv-mast/{invMastUid}` */
|
|
41
41
|
endpoint?: string;
|
|
42
42
|
}
|
|
43
|
+
/**
|
|
44
|
+
* Bounds every call made through a client view (`api.withRequest(options)`, atlas#106).
|
|
45
|
+
*
|
|
46
|
+
* - `signal`: the caller's own abort. Once it fires the call stops: the request in flight is
|
|
47
|
+
* cancelled and no retry follows (an `AbortSignal.timeout` signal's `TimeoutError` included).
|
|
48
|
+
* - `deadline`: milliseconds for the WHOLE call, every attempt and every wait between retries
|
|
49
|
+
* together. Not the per-attempt `timeout` (30 s by default), which still applies to each
|
|
50
|
+
* attempt, cut to what is left of the deadline. At the deadline the call rejects with a
|
|
51
|
+
* `TimeoutError` DOMException.
|
|
52
|
+
*/
|
|
53
|
+
export interface CallOptions {
|
|
54
|
+
signal?: AbortSignal;
|
|
55
|
+
deadline?: number;
|
|
56
|
+
}
|
|
57
|
+
/**
|
|
58
|
+
* A client's call bounds, inside the SDK (not exported): every signal the view and the views it
|
|
59
|
+
* was made from were given, and the tightest deadline (AugurApiClient.Bounds). A plain client
|
|
60
|
+
* has none.
|
|
61
|
+
*/
|
|
62
|
+
export interface CallBounds {
|
|
63
|
+
signals: readonly AbortSignal[];
|
|
64
|
+
deadline?: number;
|
|
65
|
+
}
|
|
66
|
+
export declare const NO_BOUNDS: CallBounds;
|
|
43
67
|
export declare const DEFAULT_CONFIG: {
|
|
44
68
|
timeout: number;
|
|
45
69
|
retries: number;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/core/config.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,kBAAkB;IACjC,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED,MAAM,WAAW,aAAa,CAAC,CAAC,GAAG,OAAO;IACxC,IAAI,EAAE,CAAC,CAAC;IACR,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,MAAM,EAAE,kBAAkB,CAAC;CAC5B;AAED,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,kBAAkB,CAAC;IAC5B,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE,kBAAkB,KAAK,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAC7F,UAAU,CAAC,EAAE,CAAC,CAAC,GAAG,OAAO,EACvB,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,KACvB,aAAa,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;IAClD,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,iBAAiB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9D;AAED,MAAM,WAAW,aAAa;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,aAAa,CAAC;IACxD,oFAAoF;IACpF,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;
|
|
1
|
+
{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/core/config.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,kBAAkB;IACjC,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED,MAAM,WAAW,aAAa,CAAC,CAAC,GAAG,OAAO;IACxC,IAAI,EAAE,CAAC,CAAC;IACR,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,MAAM,EAAE,kBAAkB,CAAC;CAC5B;AAED,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,kBAAkB,CAAC;IAC5B,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE,kBAAkB,KAAK,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAC7F,UAAU,CAAC,EAAE,CAAC,CAAC,GAAG,OAAO,EACvB,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,KACvB,aAAa,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;IAClD,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,iBAAiB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9D;AAED,MAAM,WAAW,aAAa;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,aAAa,CAAC;IACxD,oFAAoF;IACpF,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,WAAW;IAC1B,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,SAAS,WAAW,EAAE,CAAC;IAChC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,eAAO,MAAM,SAAS,EAAE,UAA4B,CAAC;AAGrD,eAAO,MAAM,cAAc,EAAE;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,MAAM,CAAA;CAIlF,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,sBAAsB;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,0CAA0C;IAC1C,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,qCAAqC;IACrC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,yBAAyB;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACrC,wBAAwB;IACxB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,cAAc;IACd,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,KAAK;aAG3B,KAAK,CAAC,EAAE,MAAM;gBAD9B,OAAO,EAAE,MAAM,EACC,KAAK,CAAC,EAAE,MAAM,YAAA;CAKjC"}
|
|
@@ -17,7 +17,13 @@ export type EncodedSegment = string & {
|
|
|
17
17
|
export declare function encodePathSegment(value: string): EncodedSegment;
|
|
18
18
|
/** `path` with every `{placeholder}` replaced by an already-encoded segment. */
|
|
19
19
|
export declare function fillPlaceholder(path: string, placeholder: string, segment: EncodedSegment): string;
|
|
20
|
-
/**
|
|
20
|
+
/**
|
|
21
|
+
* The template with each `{name}` replaced by its encoded segment; a missing name is an error.
|
|
22
|
+
* The names are utils' proved `templateNames`, the missing ones its proved `notInFrom`, and each
|
|
23
|
+
* fill the proved `placeholderFilled`. Filling one name at a time is the regex's answer: an
|
|
24
|
+
* encoded segment holds no `{` or `}` (`encodeURIComponent` escapes them), so no fill can make
|
|
25
|
+
* a placeholder another fill would then see.
|
|
26
|
+
*/
|
|
21
27
|
export declare function renderPath(template: string, segments: Readonly<Record<string, EncodedSegment>>): string;
|
|
22
28
|
export {};
|
|
23
29
|
//# sourceMappingURL=encoded-segment.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"encoded-segment.d.ts","sourceRoot":"","sources":["../../src/core/encoded-segment.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"encoded-segment.d.ts","sourceRoot":"","sources":["../../src/core/encoded-segment.ts"],"names":[],"mappings":"AAcA,OAAO,CAAC,MAAM,mBAAmB,EAAE,OAAO,MAAM,CAAC;AAEjD,oGAAoG;AACpG,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG;IAAE,QAAQ,CAAC,CAAC,mBAAmB,CAAC,EAAE,IAAI,CAAA;CAAE,CAAC;AAE/E;;;;;;;;;;GAUG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,cAAc,CAa/D;AAED,gFAAgF;AAChF,wBAAgB,eAAe,CAC7B,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,cAAc,GACtB,MAAM,CAIR;AAED;;;;;;GAMG;AACH,wBAAgB,UAAU,CACxB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC,GACjD,MAAM,CAeR"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/core/errors.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/core/errors.ts"],"names":[],"mappings":"AAMA,qDAAqD;AACrD,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,aAAc,SAAQ,KAAK;IAC1C,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gBAAgB,CAAC,EAAE,eAAe,EAAE,CAAC;CACtC;AAED,qBAAa,UAAW,SAAQ,KAAM,YAAW,aAAa;IACrD,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gBAAgB,CAAC,EAAE,eAAe,EAAE,CAAC;gBAEhC,MAAM,EAAE;QAClB,OAAO,EAAE,MAAM,CAAC;QAChB,IAAI,EAAE,MAAM,CAAC;QACb,UAAU,EAAE,MAAM,CAAC;QACnB,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,EAAE,MAAM,CAAC;QACjB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,gBAAgB,CAAC,EAAE,eAAe,EAAE,CAAC;KACtC;CAeF;AAED,qBAAa,eAAgB,SAAQ,UAAU;gBACjC,MAAM,EAAE;QAClB,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,EAAE,MAAM,CAAC;QACjB,gBAAgB,EAAE,eAAe,EAAE,CAAC;KACrC;IAQD;;;OAGG;IACH,kBAAkB,IAAI,MAAM,EAAE;IAW9B;;;OAGG;IACH,iBAAiB,IAAI,KAAK,CAAC;QACzB,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;QAChB,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;KACpB,CAAC;IAcF;;;OAGG;IACH,QAAQ,IAAI,MAAM;CAWnB;AAED,qBAAa,mBAAoB,SAAQ,UAAU;gBACrC,MAAM,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE;CAO3E;AAED,qBAAa,aAAc,SAAQ,UAAU;gBAC/B,MAAM,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE;CAO3E;AAED,qBAAa,cAAe,SAAQ,UAAU;gBAChC,MAAM,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE;CAO3E;AAED,qBAAa,oBAAqB,SAAQ,UAAU;gBACtC,MAAM,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE;CAO3E"}
|
|
@@ -1,29 +1,3 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* A status worth retrying: a client error (4xx) never is, except 429; anything else (network
|
|
3
|
-
* 0, 5xx) is.
|
|
4
|
-
*
|
|
5
|
-
* @ensures exactly the model's RetryableStatus
|
|
6
|
-
*/
|
|
7
|
-
export declare function isRetryableStatus(status: number): boolean;
|
|
8
|
-
/**
|
|
9
|
-
* The backoff before attempt `attempt` (0-indexed), before jitter: base · 2^attempt.
|
|
10
|
-
*
|
|
11
|
-
* @ensures exactly the model's ExponentialDelay
|
|
12
|
-
*/
|
|
13
|
-
export declare function exponentialDelay(base: number, attempt: number): number;
|
|
14
|
-
/**
|
|
15
|
-
* A delay capped at 30 seconds.
|
|
16
|
-
*
|
|
17
|
-
* @ensures exactly the model's CappedDelay
|
|
18
|
-
*/
|
|
19
|
-
export declare function cappedDelay(d: number): number;
|
|
20
|
-
/**
|
|
21
|
-
* A request's timeout: its own when given, else the client's when configured, else
|
|
22
|
-
* `fallback` (the default).
|
|
23
|
-
*
|
|
24
|
-
* @ensures exactly the model's TimeoutOf
|
|
25
|
-
*/
|
|
26
|
-
export declare function timeoutOf(hasRequest: boolean, request: number, hasClient: boolean, client: number, fallback: number): number;
|
|
27
1
|
/**
|
|
28
2
|
* The endpoints every service serves without a token: a URL ending in /health-check or /ping.
|
|
29
3
|
*
|
|
@@ -43,12 +17,6 @@ export declare function sendsBearer(url: string, hasToken: boolean): boolean;
|
|
|
43
17
|
* @ensures exactly the model's SendsJsonBody
|
|
44
18
|
*/
|
|
45
19
|
export declare function sendsJsonBody(hasData: boolean, method: string): boolean;
|
|
46
|
-
/**
|
|
47
|
-
* The query string joins with `&` when the URL already has a `?`.
|
|
48
|
-
*
|
|
49
|
-
* @ensures exactly the model's QuerySeparator
|
|
50
|
-
*/
|
|
51
|
-
export declare function querySeparator(url: string): string;
|
|
52
20
|
/**
|
|
53
21
|
* In-flight requests are deduplicated by `METHOD:url:params`.
|
|
54
22
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"http-rules.d.ts","sourceRoot":"","sources":["../../src/core/http-rules.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"http-rules.d.ts","sourceRoot":"","sources":["../../src/core/http-rules.ts"],"names":[],"mappings":"AASA;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAIrD;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,GAAG,OAAO,CAInE;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAIvE;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAI9E;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAIrD"}
|