@chaosity/location-client 0.12.0 → 0.13.1

package/dist/maps/mapToken.js

@@ -0,0 +1,177 @@
+import { TOKEN_REFUSAL_HOLD_MS, TokenHold, holdFor, sendRetryingOnce, } from '../auth/tokenHold.js';
+import { LocationServiceException } from '../errors/LocationServiceException.js';
+import { noTokenAvailable } from '../transport/errors.js';
+import { withinCall } from '../transport/http.js';
+import { isOurApi } from './createTransformRequest.js';
+/**
+ * One hold per `MapTokens` object, so the helpers handed the same one share
+ * what the API and `refreshToken` said (#38): a refusal one of them met is not
+ * asked again by the next. A bare `getToken` never asks again, and needs none.
+ */
+const holds = new WeakMap();
+function holdOf(tokens) {
+    let hold = holds.get(tokens);
+    if (!hold)
+        holds.set(tokens, (hold = new TokenHold()));
+    return hold;
+}
+/**
+ * The token each `MapTokens` object's refresh last brought, and until when a
+ * 401 while it is in hand is not news (#72). One per object, beside its hold:
+ * a note per helper had each of two helpers handed one object take the
+ * other's token as news, and ask again for every refusal.
+ */
+const broughtBy = new WeakMap();
+/**
+ * Send with the token in hand, and after a 401 once more with a different one
+ * from `refreshToken`, all within the call's signal and deadline (#62). A 403
+ * is never retried, and neither is the token the API refused.
+ */
+export async function sendWithTokenRefresh(source, noTokenAdvice, call, send) {
+    const tokens = typeof source === 'function' ? { getToken: source } : source;
+    const token = tokens.getToken();
+    if (!token)
+        throw noTokenAvailable(noTokenAdvice);
+    const { refreshToken } = tokens;
+    if (!refreshToken)
+        return send(token);
+    return sendRetryingOnce(holdOf(tokens), token, send, async () => (await withinCall(refreshToken(), call)) ?? tokens.getToken());
+}
+/**
+ * Recover the tiles MapLibre fetches itself when the API refuses the token
+ * (#72).
+ *
+ * `createTransformRequest` builds each request synchronously and never sees
+ * the answer, so a refused tile used to leave a hole until the page reloaded.
+ * This listens for MapLibre's `error` events. On a 401 from a URL of our API it
+ * asks `refreshToken` once for the whole burst. When `getToken` then returns a
+ * different token, it reloads each refused tile with `map.refreshTiles`, whose
+ * requests carry that token. So `refreshToken` must make `getToken` return
+ * what it obtained: the tiles have no other way to receive it. A refused
+ * request that is not a tile (a glyph, a sprite) has the token replaced for
+ * the next one, and nothing reloaded.
+ *
+ * Tiles are reloaded by id, never a whole source: MapLibre 6 reloads a source's
+ * errored tiles as still loading, and they wait for a load that never comes.
+ *
+ * What it learns is held as the fetch helpers hold it, and shared with them
+ * when they are handed the same `tokens` object (#38): a token `refreshToken`
+ * could not replace, a token it brought that the API refused on a tile
+ * reloaded with it, and a failure that says when to ask again, are not asked
+ * about again until they lapse or the token in hand changes. While the token
+ * a refresh brought is in hand, any other refused tile is reloaded once with
+ * it, without asking.
+ *
+ * Returns a function that stops listening.
+ *
+ * @example
+ * const tokens = { getToken, refreshToken }
+ * const map = new Map({
+ *   container: 'map',
+ *   style: await fetchMapStyle(API_URL, 'Standard', tokens),
+ *   transformRequest: createTransformRequest(API_URL, getToken),
+ * })
+ * refreshTokenOnUnauthorized(map, API_URL, tokens)
+ */
+export function refreshTokenOnUnauthorized(map, apiUrl, tokens) {
+    const hold = holdOf(tokens);
+    // Each source's refused tiles, keyed `z/x/y` so a tile refused twice is
+    // reloaded once. Tiles refused while a hold stands are kept, so the next ask
+    // reloads them; MapLibre ignores ids no longer in view.
+    const refused = new Map();
+    // The token each tile was reloaded with here, keyed `source:z/x/y`.
+    const reloadedWith = new Map();
+    let asking = false;
+    const reload = (sourceId, tiles, token) => {
+        for (const { x, y, z } of tiles)
+            reloadedWith.set(`${sourceId}:${z}/${x}/${y}`, token);
+        map.refreshTiles(sourceId, tiles);
+    };
+    const onError = ({ error, sourceId, tile }) => {
+        if (error?.status !== 401 || !error.url || !isOurApi(error.url, apiUrl))
+            return;
+        let refusedTile;
+        if (sourceId && tile) {
+            const { x, y, z } = tile.tileID.canonical;
+            const tiles = refused.get(sourceId) ?? new Map();
+            refused.set(sourceId, tiles.set(`${z}/${x}/${y}`, { x, y, z }));
+            refusedTile = [sourceId, { x, y, z }];
+        }
+        if (asking)
+            return;
+        const inHand = tokens.getToken();
+        const held = hold.check(inHand);
+        if (held && !held.askAgain)
+            return;
+        // A 401 while the token a refresh brought is in hand. The event does not
+        // say which token the refused request carried, and a tile requested with
+        // the token before, answered late, looks like the new token refused. So
+        // only a tile reloaded here with the token in hand is that token refused:
+        // the API refuses every token, as it does a map pointed at an API its
+        // tokens are not for, and asking again minted a token and reloaded the
+        // tiles several times a second. That is remembered, as a send path
+        // remembers its retry refused, and the next ask is after the hold. Any
+        // other tile is reloaded once with the token in hand; anything else (a
+        // glyph, a sprite) asks nothing.
+        const brought = broughtBy.get(tokens);
+        if (inHand && inHand === brought?.token && Date.now() < brought.until) {
+            if (!refusedTile)
+                return;
+            const [id, coordinates] = refusedTile;
+            const key = `${coordinates.z}/${coordinates.x}/${coordinates.y}`;
+            if (reloadedWith.get(`${id}:${key}`) !== inHand) {
+                refused.get(id)?.delete(key);
+                reload(id, [coordinates], inHand);
+                return;
+            }
+            // Kept in `refused`, as every tile refused during the hold is.
+            broughtBy.delete(tokens);
+            hold.remember(unauthorized('The API refused a tile reloaded with the token refreshToken brought.'), inHand);
+            return;
+        }
+        asking = true;
+        // Asked inside an executor, so a `refreshToken` that throws instead of
+        // rejecting lands in the catch below rather than in MapLibre's emitter.
+        new Promise((resolve) => resolve(tokens.refreshToken()))
+            .then(() => {
+            // A reloaded tile takes its token from `getToken`, as every tile does,
+            // so that is the token that must have changed. Reloading on what
+            // `refreshToken` returned alone would send the refused one again, and
+            // its 401 would ask again: a loop of refreshes and reloads.
+            const now = tokens.getToken();
+            if (!now || now === inHand) {
+                // MapLibre's error carries none of the API's fields, so the refusal
+                // is remembered as the 401 it was.
+                hold.remember(unauthorized('The API refused the token, and getToken has no other since refreshToken settled.'), inHand);
+                return;
+            }
+            broughtBy.set(tokens, {
+                token: now,
+                until: Date.now() + TOKEN_REFUSAL_HOLD_MS,
+            });
+            // What was reloaded with an earlier token can no longer match.
+            reloadedWith.clear();
+            for (const [id, tiles] of refused)
+                if (tiles.size)
+                    reload(id, [...tiles.values()], now);
+        })
+            .catch((refusal) => {
+            // Only a failure that says when to ask again is remembered; any other
+            // leaves the next refused tile to ask, as the send paths do.
+            if (holdFor(refusal) > 0)
+                hold.remember(refusal, inHand);
+        })
+            .finally(() => {
+            refused.clear();
+            asking = false;
+        });
+    };
+    map.on('error', onError);
+    return () => map.off('error', onError);
+}
+/** A refusal MapLibre reported, remembered as the 401 it was. */
+const unauthorized = (message) => new LocationServiceException({
+    code: 'UnauthorizedException',
+    message,
+    statusCode: 401,
+});

package/dist/maps/staticMap.d.ts

@@ -1,5 +1,6 @@
 import type { RequestOptions } from '../transport/http.js';
 import type { ColorScheme, LabelSize, MapFeatureMode, ScaleBarUnit, StaticMapStyle } from './mapEnums.js';
+import type { MapTokenSource } from './mapToken.js';
 /**
  * Static maps: build the URL, send the right headers, get a Blob.
  *
@@ -110,11 +111,14 @@ export declare function buildStaticMapUrl(apiUrl: string, options: StaticMapOpti
  *
  * A refused plan feature — a Satellite `style`, the default when none is
  * given, or a `politicalView` — rejects with a `LocationServiceException`
- * whose `isFeatureNotEntitled` is true, as `fetchMapStyle` does.
+ * whose `isFeatureNotEntitled` is true, as `fetchMapStyle` does. Given
+ * `{ getToken, refreshToken }`, a refused token is replaced once, as
+ * `fetchMapStyle` does it (#72).
  *
  * @param apiUrl   Base URL of the Location Service API
  * @param options  Render options; exactly one of center / boundingBox / boundedPositions
- * @param getToken Callback returning the current auth token
+ * @param tokens   Callback returning the current auth token, or
+ *   `{ getToken, refreshToken }` to recover from a refused one
  * @param request  Transport options: `signal` to cancel, `timeoutMs`, `overallTimeoutMs`, `retry`
  *
  * @example
@@ -124,4 +128,4 @@ export declare function buildStaticMapUrl(apiUrl: string, options: StaticMapOpti
  * }, getToken)
  * const url = URL.createObjectURL(blob)   // remember to revokeObjectURL
  */
-export declare function fetchStaticMap(apiUrl: string, options: StaticMapOptions, getToken: () => string | undefined, request?: RequestOptions): Promise<Blob>;
+export declare function fetchStaticMap(apiUrl: string, options: StaticMapOptions, tokens: MapTokenSource, request?: RequestOptions): Promise<Blob>;

package/dist/maps/staticMap.js

@@ -1,5 +1,5 @@
-import { noTokenAvailable } from '../transport/errors.js';
-import { requestBlob } from '../transport/http.js';
+import { requestBlob, startCall } from '../transport/http.js';
+import { sendWithTokenRefresh } from './mapToken.js';
 /**
  * The Accept header this request must send.
  *
@@ -50,11 +50,14 @@ export function buildStaticMapUrl(apiUrl, options) {
  *
  * A refused plan feature — a Satellite `style`, the default when none is
  * given, or a `politicalView` — rejects with a `LocationServiceException`
- * whose `isFeatureNotEntitled` is true, as `fetchMapStyle` does.
+ * whose `isFeatureNotEntitled` is true, as `fetchMapStyle` does. Given
+ * `{ getToken, refreshToken }`, a refused token is replaced once, as
+ * `fetchMapStyle` does it (#72).
  *
  * @param apiUrl   Base URL of the Location Service API
  * @param options  Render options; exactly one of center / boundingBox / boundedPositions
- * @param getToken Callback returning the current auth token
+ * @param tokens   Callback returning the current auth token, or
+ *   `{ getToken, refreshToken }` to recover from a refused one
  * @param request  Transport options: `signal` to cancel, `timeoutMs`, `overallTimeoutMs`, `retry`
  *
  * @example
@@ -64,23 +67,21 @@ export function buildStaticMapUrl(apiUrl, options) {
  * }, getToken)
  * const url = URL.createObjectURL(blob)   // remember to revokeObjectURL
  */
-export async function fetchStaticMap(apiUrl, options, getToken, request = {}) {
-    const token = getToken();
-    // The same guard as fetchMapStyle and the server connector: a render is not
-    // worth requesting without a token to send (#37).
-    if (!token) {
-        throw noTokenAvailable('getToken() returned nothing, so no static map was requested. Check the token provider has finished initialising.');
-    }
+export async function fetchStaticMap(apiUrl, options, tokens, request = {}) {
+    const call = startCall(request);
     // Through the shared transport, so a static map gets the timeout, budget,
     // cancellation and retry every other call has -- and its failures arrive as
     // LocationServiceException rather than as a raw TypeError. The API's own
     // {message, code, requestId} survives, which matters here: the messages are
     // specific and actionable -- "'width' and 'height' are required", "Only one
     // of center, bounding-box or bounded-positions may be set".
-    return requestBlob(buildStaticMapUrl(apiUrl, options), {
+    //
+    // The same guard as fetchMapStyle and the server connector: a render is not
+    // worth requesting without a token to send (#37).
+    return sendWithTokenRefresh(tokens, 'getToken() returned nothing, so no static map was requested. Check the token provider has finished initialising.', call, (token) => requestBlob(buildStaticMapUrl(apiUrl, options), {
         headers: {
             Authorization: `Bearer ${token}`,
             Accept: staticMapAccept(options.style),
         },
-    }, request);
+    }, call));
 }

package/dist/server/LocationServiceConnector.d.ts

@@ -1,5 +1,7 @@
+import type { GetTokenOptions } from '../auth/TokenProvider.js';
 import type { VerifyAddressResponse } from '../client/commands.js';
 import type { RequestOptions } from '../transport/http.js';
+import type { CommandOutput, CommandWithOutput } from '../types/index.js';
 import type { AppConfigClaims } from '../utils/tokenClaims.js';
 export interface ConnectorConfig {
     /** Falls back to `LOCATION_API_URL` / `LOCATION_SERVICE_API_URL`. */
@@ -14,10 +16,13 @@ export interface ConnectorConfig {
      * a long-lived connector survive expiry.
      *
      * `forceRefresh` is passed as `true` when the API has just rejected the token
-     * this returned — the signature is `TokenProvider.getToken`'s exactly, so
-     * `getToken: (f) => provider.getToken(f)` is a complete implementation.
+     * this returned, and `options` always asks for `cachedUntilExpiry` (#63): a
+     * source that can keep sending its cached token through a throttled refresh
+     * should, since a connector's token never reaches a browser. The signature
+     * is `TokenProvider.getToken`'s, so
+     * `getToken: (f, o) => provider.getToken(f, o)` is a complete implementation.
      */
-    getToken?: (forceRefresh?: boolean) => Promise<string | {
+    getToken?: (forceRefresh?: boolean, options?: GetTokenOptions) => Promise<string | {
         token?: string;
     } | undefined>;
     /** Falls back to `LOCATION_CLIENT_ID` / `LOCATION_SERVICE_CLIENT_ID`. */
@@ -109,6 +114,16 @@ export declare class LocationServiceConnector {
      * header beats the connector default, whatever the caller capitalised.
      */
     private effectiveOrigin;
+    /**
+     * Send a command, and resolve with its output:
+     * `await connector.send(new SearchTextCommand(…))` is a
+     * `SearchTextCommandOutput`, with nothing to annotate (#68).
+     */
+    send<C extends CommandWithOutput>(command: C, options?: SendOptions): Promise<CommandOutput<C>>;
+    /**
+     * The signature `send` had before it inferred its output (#68), kept for
+     * calls naming both type arguments, as `GeoPlacesClient.send` keeps it.
+     */
     send<TInput, TOutput>(command: TInput, options?: SendOptions): Promise<TOutput>;
     /**
      * Verify a PlaceId: `send(new VerifyAddressCommand({ PlaceId }))`, typed

package/dist/server/LocationServiceConnector.js

@@ -1,10 +1,10 @@
 import debug from 'debug';
-import { TokenHold, holdFor } from '../auth/tokenHold.js';
+import { TokenHold, sendRetryingOnce } from '../auth/tokenHold.js';
 import { VerifyAddressCommand } from '../client/commands.js';
 import { LocationServiceException } from '../errors/LocationServiceException.js';
 import { resolveEndpoint } from '../transport/endpoints.js';
-import { isTokenRejected, noTokenAvailable } from '../transport/errors.js';
-import { requestJson } from '../transport/http.js';
+import { noTokenAvailable } from '../transport/errors.js';
+import { requestJson, startCall, withinCall } from '../transport/http.js';
 import { readAppConfigClaims } from '../utils/tokenClaims.js';
 import { resolveApiUrl, serverTokenSource } from './getClientConfig.js';
 const log = debug('location-client:connector');
@@ -134,7 +134,10 @@ export class LocationServiceConnector {
             return {
                 apiUrl: () => requireApiUrl(apiUrl),
                 get: async (forceRefresh) => {
-                    const result = await getToken(forceRefresh);
+                    // As the environment source below asks its provider (#63).
+                    const result = await getToken(forceRefresh, {
+                        cachedUntilExpiry: true,
+                    });
                     if (!result)
                         return undefined;
                     return typeof result === 'string' ? result : result.token;
@@ -156,7 +159,9 @@ export class LocationServiceConnector {
             // Already validated by serverTokenSource, which cannot resolve
             // credentials without it.
             apiUrl: () => env.apiUrl,
-            get: async (forceRefresh) => (await env.getToken(forceRefresh)).token,
+            // A throttled refresh keeps the cached token in use until its own exp
+            // (#63): this is a server dispatch, never a token handed to a browser.
+            get: async (forceRefresh) => (await env.getToken(forceRefresh, { cachedUntilExpiry: true })).token,
         };
     }
     /**
@@ -194,8 +199,11 @@ export class LocationServiceConnector {
         const source = this.source();
         const cmd = command;
         const url = `${source.apiUrl()}${resolveEndpoint(cmd)}`;
+        // The call's deadline starts here, before the token is waited for, so the
+        // caller's `overallTimeoutMs` and `signal` bound the whole call (#62).
+        const call = startCall(options);
         try {
-            return await this.dispatchWithRetry(source, url, cmd, options);
+            return await this.dispatchWithRetry(source, url, cmd, call);
         }
         catch (err) {
             throw explainMissingOrigin(err, this.effectiveOrigin(options));
@@ -213,63 +221,14 @@ export class LocationServiceConnector {
         return this.send(new VerifyAddressCommand({ PlaceId: placeId }), options);
     }
     async dispatchWithRetry(source, url, cmd, options) {
-        const token = await source.get();
+        // Raced against the caller's signal and deadline, not given them: the
+        // token fetch may be shared with other calls (#62).
+        const token = await withinCall(source.get(), options);
         if (!token)
             throw noTokenAvailable(NO_TOKEN_ADVICE);
-        // This token was refused a moment ago and nothing has replaced it: answer
-        // with that refusal rather than send it, and force the source, again (#38).
-        // A different token from the source ends the hold. When the refresh that
-        // followed said nothing about when to ask again, it is asked now — but the
-        // refused token is still not sent.
-        const held = this.refused.check(token);
-        if (held && !held.askAgain)
-            throw held.error;
-        let rejected = held?.error;
-        if (!held) {
-            try {
-                return await this.dispatch(url, token, cmd, options);
-            }
-            catch (err) {
-                if (!isTokenRejected(err))
-                    throw err;
-                rejected = err;
-            }
-        }
-        // One retry, and only when the replacement is genuinely a different token.
-        // That single comparison covers every source: a fixed `token` string, a
-        // caller `getToken` that ignores `forceRefresh`, and a cached token the API
-        // has revoked before its `exp` all hand back what we already sent — and
-        // re-sending it would be a second doomed request for the same answer.
-        let fresh;
-        try {
-            fresh = await source.get(true);
-        }
-        catch (refusal) {
-            // A suspended application's /auth/token refuses it as its data routes
-            // refuse its token. Without this, every send asked for another. A
-            // refusal that says nothing — a network fault — leaves the source to be
-            // asked again, but not the token sent.
-            if (holdFor(refusal) > 0)
-                this.refused.remember(refusal, token);
-            // Only when no hold stands: one already standing keeps its own end, so
-            // the refused token is tried again once per hold rather than never.
-            else if (!held)
-                this.refused.remember(rejected, token, { askAgain: true });
-            throw refusal;
-        }
-        if (!fresh || fresh === token) {
-            this.refused.remember(rejected, token);
-            throw rejected;
-        }
-        log('401 on a token the API no longer accepts — retrying once, refreshed');
-        try {
-            return await this.dispatch(url, fresh, cmd, options);
-        }
-        catch (again) {
-            if (isTokenRejected(again))
-                this.refused.remember(again, fresh);
-            throw again;
-        }
+        // Through `sendRetryingOnce`, like every 401 retry here (#38). The forced
+        // refresh is raced against the caller as the first ask was (#62).
+        return sendRetryingOnce(this.refused, token, (t) => this.dispatch(url, t, cmd, options), () => withinCall(source.get(true), options), () => log('401 on a token the API no longer accepts — retrying once, refreshed'));
     }
     dispatch(url, token, cmd, options) {
         // The caller's input goes out as the caller wrote it — nothing in the body

package/dist/server/getClientConfig.d.ts

@@ -1,4 +1,4 @@
-import type { TokenResponse } from '../auth/TokenProvider.js';
+import type { GetTokenOptions, TokenResponse } from '../auth/TokenProvider.js';
 import type { ClientConfig } from '../types/index.js';
 export interface ServerAuthConfig {
     apiUrl?: string;
@@ -60,8 +60,12 @@ export declare function resolveApiUrl(explicit?: string): string | undefined;
  */
 export interface ServerTokenSource {
     apiUrl: string;
-    /** Resolves with a token or rejects; it never resolves tokenless. */
-    getToken(forceRefresh?: boolean): Promise<TokenResponse & {
+    /**
+     * Resolves with a token or rejects; it never resolves tokenless. The options
+     * are `TokenProvider.getToken`'s: the connector asks for `cachedUntilExpiry`
+     * (#63), and `getClientConfig` never does.
+     */
+    getToken(forceRefresh?: boolean, options?: GetTokenOptions): Promise<TokenResponse & {
         token: string;
     }>;
 }

package/dist/server/getClientConfig.js

@@ -75,10 +75,10 @@ export function resolveApiUrl(explicit) {
  *
  * Two answers qualify. `/auth/token`'s own `Invalid credentials` is a secret
  * that matched nothing. The gateway's 401 (`UnauthorizedException`) is the
- * authorizer refusing the Basic pair before `/auth/token` runs, and it gives
- * the same answer for a wrong secret and for an application that is not
- * active, so the advice for it names both. `Application is not active`, and
- * every 403, is left as the API wrote it.
+ * authorizer refusing the Basic pair before `/auth/token` runs. An application
+ * that is not active is a 403 (`ApplicationNotActiveException`) on either
+ * path, whose sentence names its cause, and it is left as the API wrote it,
+ * like every 403.
  */
 function isCredentialsRefusal(error) {
     if (!(error instanceof LocationServiceException))
@@ -90,11 +90,8 @@ function isCredentialsRefusal(error) {
 }
 /** The API's words as a sentence, so the advice can follow them. */
 const sentence = (text) => (/[.!?]$/.test(text) ? text : `${text}.`);
-function credentialsAdvice(clientId, error) {
-    const check = `Check that LOCATION_CLIENT_ID ("${clientId}") and LOCATION_CLIENT_SECRET match your application in the developer portal`;
-    return error.code === 'UnauthorizedException'
-        ? `${check}, and that the application is active there.`
-        : `${check}.`;
+function credentialsAdvice(clientId) {
+    return `Check that LOCATION_CLIENT_ID ("${clientId}") and LOCATION_CLIENT_SECRET match your application in the developer portal.`;
 }
 export function serverTokenSource(config = {}) {
     log('[serverTokenSource] Starting with config:', {
@@ -130,11 +127,11 @@ export function serverTokenSource(config = {}) {
     const provider = getTokenProvider(apiUrl, clientId, clientSecret);
     return {
         apiUrl,
-        async getToken(forceRefresh = false) {
+        async getToken(forceRefresh = false, options) {
             log('[serverTokenSource] Fetching token (forceRefresh=%s)', forceRefresh);
             let result;
             try {
-                result = await provider.getToken(forceRefresh);
+                result = await provider.getToken(forceRefresh, options);
             }
             catch (error) {
                 // The API's code and sentence, passed through (#38). Every 401 and 403
@@ -144,7 +141,7 @@ export function serverTokenSource(config = {}) {
                 if (isCredentialsRefusal(error)) {
                     throw new LocationServiceException({
                         code: error.code,
-                        message: `${sentence(error.message)} ${credentialsAdvice(clientId, error)}`,
+                        message: `${sentence(error.message)} ${credentialsAdvice(clientId)}`,
                         statusCode: error.statusCode,
                         requestId: error.requestId,
                         details: error.details,

package/dist/server/index.d.ts

@@ -1,5 +1,5 @@
 export { TokenProvider } from '../auth/TokenProvider.js';
-export type { TokenProviderConfig, TokenResponse, } from '../auth/TokenProvider.js';
+export type { GetTokenOptions, TokenProviderConfig, TokenResponse, } from '../auth/TokenProvider.js';
 export { getClientConfig } from './getClientConfig.js';
 export type { ServerAuthConfig, ServerClientConfig } from './getClientConfig.js';
 export { LocationServiceConnector } from './LocationServiceConnector.js';

package/dist/transport/http.d.ts

@@ -38,6 +38,24 @@ export interface RequestOptions {
         maxAttempts?: number;
     };
 }
+/**
+ * A call's options once it has begun: `deadline` is when `overallTimeoutMs`
+ * runs out, fixed at the call's entry, so that a wait before the request — a
+ * token — spends the same budget the request then gets the rest of (#62).
+ */
+export interface CallOptions extends RequestOptions {
+    deadline: number;
+}
+/** Fix a call's deadline at its entry (#62). */
+export declare function startCall<T extends RequestOptions>(options?: T): T & CallOptions;
+/**
+ * Wait for `work` within the call: reject with `AbortedException` when the
+ * caller's signal aborts, and with `TimeoutException` when its deadline
+ * passes, whichever comes first (#62). `work` itself is left running, because
+ * it may be shared: one caller's abort must not fail another waiting on the
+ * same token fetch.
+ */
+export declare function withinCall<T>(work: Promise<T>, call: CallOptions): Promise<T>;
 /** Exponential backoff with FULL jitter, so retries never march in lockstep. */
 export declare function backoffMs(attempt: number, random?: () => number): number;
 /**

package/dist/transport/http.js

@@ -25,6 +25,40 @@ export const DEFAULT_OVERALL_TIMEOUT_MS = 30000;
 export const DEFAULT_MAX_ATTEMPTS = 3;
 const BACKOFF_BASE_MS = 250;
 const BACKOFF_CAP_MS = 4000;
+/** Fix a call's deadline at its entry (#62). */
+export function startCall(options = {}) {
+    return {
+        ...options,
+        deadline: Date.now() + (options.overallTimeoutMs ?? DEFAULT_OVERALL_TIMEOUT_MS),
+    };
+}
+/**
+ * Wait for `work` within the call: reject with `AbortedException` when the
+ * caller's signal aborts, and with `TimeoutException` when its deadline
+ * passes, whichever comes first (#62). `work` itself is left running, because
+ * it may be shared: one caller's abort must not fail another waiting on the
+ * same token fetch.
+ */
+export function withinCall(work, call) {
+    const { signal, deadline } = call;
+    const overallTimeoutMs = call.overallTimeoutMs ?? DEFAULT_OVERALL_TIMEOUT_MS;
+    if (signal?.aborted)
+        return Promise.reject(abortedException(signal));
+    const left = deadline - Date.now();
+    if (left <= 0)
+        return Promise.reject(overallTimeoutException(overallTimeoutMs));
+    return new Promise((resolve, reject) => {
+        const timer = setTimeout(() => finish(() => reject(overallTimeoutException(overallTimeoutMs))), left);
+        const onAbort = () => finish(() => reject(abortedException(signal)));
+        signal?.addEventListener('abort', onAbort, { once: true });
+        function finish(settle) {
+            clearTimeout(timer);
+            signal?.removeEventListener('abort', onAbort);
+            settle();
+        }
+        work.then((value) => finish(() => resolve(value)), (error) => finish(() => reject(error)));
+    });
+}
 /**
  * Combine the caller's signal with a per-attempt timeout.
  *
@@ -106,7 +140,9 @@ async function request(url, init, options, read) {
             details: { source: 'client' },
         });
     }
-    const deadline = Date.now() + overallTimeoutMs;
+    // A call that began before this request (#62) brings its own deadline, so
+    // the request has only what the wait before it left.
+    const deadline = options.deadline ?? Date.now() + overallTimeoutMs;
     let lastError;
     for (let attempt = 0; attempt < maxAttempts; attempt++) {
         // Checked before every attempt: a signal aborted during backoff must not fire one more.

package/dist/types/index.d.ts

@@ -1,3 +1,4 @@
+import type { VerifyAddressCommand, VerifyAddressResponse } from '../client/commands.js';
 /**
  * At least one of `token`, `getToken` or `refreshToken` must supply a token, or
  * `send` refuses locally with `InvalidCredentialsException` rather than putting
@@ -52,6 +53,30 @@ export interface ClientConfig {
 export interface GeoPlacesCommand {
     readonly input: object;
 }
+/**
+ * The part of an AWS SDK command that carries its output type: the request
+ * handler its `resolveMiddleware` builds resolves with `{ output }`. The SDK's
+ * own `send` reads the output from the command the same way.
+ */
+interface SdkCommandOutputs<O extends object = object> {
+    resolveMiddleware(...args: never[]): (...args: never[]) => Promise<{
+        output: O;
+    }>;
+}
+/**
+ * A command whose output `send` can name (#68): every SDK command, this
+ * package's narrowed Places commands among them, and `VerifyAddressCommand`.
+ */
+export type CommandWithOutput = SdkCommandOutputs | VerifyAddressCommand;
+/**
+ * What `send` resolves with for a command (#68): an SDK command's own
+ * `…CommandOutput`, and `VerifyAddressResponse` for `VerifyAddressCommand`,
+ * which is this package's and has no handler.
+ *
+ * @example
+ * type Out = CommandOutput<AutocompleteCommand> // AutocompleteCommandOutput
+ */
+export type CommandOutput<C extends CommandWithOutput> = C extends SdkCommandOutputs<infer O> ? O : VerifyAddressResponse;
 /**
  * Minimal interface for a MapLibre Map instance.
  * Using a structural type avoids hard coupling to a specific maplibre-gl version.
@@ -69,3 +94,4 @@ export interface MapLike {
     getLayoutProperty(layerId: string, name: string): unknown;
     setLayoutProperty(layerId: string, name: string, value: unknown): void;
 }
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chaosity/location-client",
-  "version": "0.12.0",
+  "version": "0.13.1",
   "description": "Client library for Chaosity Location Service with AWS Location Service compatibility",
   "type": "module",
   "main": "dist/cjs/index.js",
@@ -58,8 +58,8 @@
     "url": "https://github.com/chaosity-io/location-service-client/issues"
   },
   "dependencies": {
-    "@aws-sdk/client-geo-places": "^3.0.0",
-    "@aws/amazon-location-utilities-datatypes": "^1.0.0",
+    "@aws-sdk/client-geo-places": "^3.1116.0",
+    "@aws/amazon-location-utilities-datatypes": "^1.2.4",
     "debug": "^4.4.3"
   },
   "peerDependencies": {