@chaosity/location-client-react 0.2.0 → 0.3.1

package/dist/provider/LocationClientProvider.d.ts

@@ -1,4 +1,5 @@
 import type { ClientConfig } from '@chaosity/location-client';
+import { type AppConfigClaims } from '@chaosity/location-client';
 import type { ReactNode } from 'react';
 /**
  * Per-request transport options.
@@ -26,6 +27,24 @@ export interface LocationClient {
         serviceId: string;
     };
     send<TInput, TOutput>(command: TInput, options?: SendOptions): Promise<TOutput>;
+    /**
+     * This application's own configuration, read from the access token —
+     * bias precision, and the countries it is scoped to (api#65).
+     *
+     * Here so a React app can SHOW its own settings: populate a country
+     * selector with the markets it serves, label a settings screen. Being a
+     * few minutes stale is cosmetic for that.
+     *
+     * It is not an entitlement check, and the `countries` value must not be
+     * used to shape requests. The token is a snapshot; the API reads the scope
+     * fresh from the application row on every call. Injecting a stale scope
+     * turns a request that would have succeeded into a 400. See
+     * `AppConfigClaims` in @chaosity/location-client for the measurement.
+     *
+     * Returns `{}` when the token carries no application config, which is the
+     * case until one is set in the portal.
+     */
+    getAppConfig(): AppConfigClaims;
 }
 interface LocationClientContextValue {
     client: LocationClient | null;
@@ -38,9 +57,7 @@ export interface LocationClientProviderProps {
     getConfig: () => Promise<ClientConfig & {
         expiresAt?: number;
     }>;
-    /** Seconds before expiry to proactively refresh (default: 60) */
-    refreshBuffer?: number;
 }
-export declare function LocationClientProvider({ children, getConfig, refreshBuffer, }: LocationClientProviderProps): import("react").JSX.Element;
+export declare function LocationClientProvider({ children, getConfig, }: LocationClientProviderProps): import("react").JSX.Element;
 export declare function useLocationClient(): LocationClientContextValue;
 export {};

package/dist/provider/LocationClientProvider.js

@@ -1,12 +1,25 @@
 'use client';
 import { jsx as _jsx } from "react/jsx-runtime";
-import { GeoPlacesClient } from '@chaosity/location-client';
+import { GeoPlacesClient, TOKEN_REFRESH_BUFFER_SECONDS, readTokenExpiry, } from '@chaosity/location-client';
 import debug from 'debug';
 import { createContext, useCallback, useContext, useEffect, useRef, useState, } from 'react';
 const log = debug('location-client-react:provider');
 const LocationClientContext = createContext(undefined);
 const DEFAULT_LIFETIME_MS = 900000;
-export function LocationClientProvider({ children, getConfig, refreshBuffer = 60, }) {
+/**
+ * When this token needs replacing.
+ *
+ * The `exp` claim first — it is the only value that cannot disagree with what
+ * the API will accept, and the server-side TokenProvider reads the same one.
+ * `expiresAt` is whatever `getConfig` chose to report, and the final fallback
+ * is a guess used only when the token cannot be parsed at all.
+ */
+function expiryOf(cfg) {
+    return (readTokenExpiry(cfg.token) ??
+        cfg.expiresAt ??
+        Date.now() + DEFAULT_LIFETIME_MS);
+}
+export function LocationClientProvider({ children, getConfig, }) {
     const [client, setClient] = useState(null);
     const [loading, setLoading] = useState(true);
     const [error, setError] = useState(null);
@@ -22,8 +35,8 @@ export function LocationClientProvider({ children, getConfig, refreshBuffer = 60
     const isTokenExpired = useCallback(() => {
         if (!expiresAtRef.current)
             return true;
-        return Date.now() >= expiresAtRef.current - refreshBuffer * 1000;
-    }, [refreshBuffer]);
+        return (Date.now() >= expiresAtRef.current - TOKEN_REFRESH_BUFFER_SECONDS * 1000);
+    }, []);
     /**
      * Refresh once, however many callers ask at the same moment.
      *
@@ -38,7 +51,7 @@ export function LocationClientProvider({ children, getConfig, refreshBuffer = 60
         refreshPromiseRef.current = (async () => {
             const cfg = await getConfigRef.current();
             tokenRef.current = cfg.token;
-            expiresAtRef.current = cfg.expiresAt ?? Date.now() + DEFAULT_LIFETIME_MS;
+            expiresAtRef.current = expiryOf(cfg);
             log('Token refreshed (expires in %ds)', Math.floor((expiresAtRef.current - Date.now()) / 1000));
             if (mountedRef.current)
                 setError(null);
@@ -73,14 +86,14 @@ export function LocationClientProvider({ children, getConfig, refreshBuffer = 60
             clearTimeout(timerRef.current);
         if (!expiresAtRef.current)
             return;
-        const delay = Math.max(0, expiresAtRef.current - refreshBuffer * 1000 - Date.now());
+        const delay = Math.max(0, expiresAtRef.current - TOKEN_REFRESH_BUFFER_SECONDS * 1000 - Date.now());
         log('Next refresh in %ds', Math.floor(delay / 1000));
         timerRef.current = setTimeout(() => {
             // Errors are already surfaced onto state by refreshToken; swallow here so
             // a failed background refresh cannot become an unhandled rejection.
             void refreshToken().catch(() => { });
         }, delay);
-    }, [refreshBuffer, refreshToken]);
+    }, [refreshToken]);
     // refreshToken and scheduleRefresh reference each other; a ref breaks the cycle
     // without recreating either callback on every render.
     const scheduleRefreshRef = useRef(() => { });
@@ -141,7 +154,7 @@ export function LocationClientProvider({ children, getConfig, refreshBuffer = 60
             if (!mountedRef.current)
                 return;
             tokenRef.current = cfg.token;
-            expiresAtRef.current = cfg.expiresAt ?? Date.now() + DEFAULT_LIFETIME_MS;
+            expiresAtRef.current = expiryOf(cfg);
             const baseClient = new GeoPlacesClient({
                 apiUrl: cfg.apiUrl,
                 token: cfg.token,
@@ -157,6 +170,13 @@ export function LocationClientProvider({ children, getConfig, refreshBuffer = 60
                     await ensureValidTokenRef.current();
                     return baseClient.send(command, options);
                 },
+                // Reads whatever token the client currently holds. Deliberately not
+                // awaiting a refresh: this is display data, callers expect it to be
+                // synchronous, and a token that is minutes from expiry carries the
+                // same application config as its replacement will.
+                getAppConfig() {
+                    return baseClient.getAppConfig();
+                },
             };
             setClient(refreshing);
             scheduleRefreshRef.current();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chaosity/location-client-react",
-  "version": "0.2.0",
+  "version": "0.3.1",
   "description": "React bindings for Chaosity Location Service client",
   "type": "module",
   "main": "dist/index.js",
@@ -34,7 +34,7 @@
     "url": "https://github.com/chaosity-io/location-service-client-react/issues"
   },
   "dependencies": {
-    "@chaosity/location-client": "^0.2.0",
+    "@chaosity/location-client": "^0.3.0",
     "debug": "^4.4.3"
   },
   "peerDependencies": {
@@ -54,7 +54,7 @@
     "@types/react": "^19.0.0",
     "@vitest/coverage-v8": "^3.0.0",
     "eslint": "^10.1.0",
-    "happy-dom": "^17.0.0",
+    "happy-dom": "^20.11.6",
     "husky": "^9.0.0",
     "maplibre-gl": "^5.0.0",
     "prettier": "^3.8.1",