@renaissancerentals/renaissance-component 13.0.14 → 13.0.16

package/lib/service/Api.d.ts

@@ -1,7 +1,36 @@
 import { AxiosResponse } from 'axios';
+/**
+ * The sites read their data from one or more hosts that serve the same API (REACT_APP_DATA_BASE_URLS, comma
+ * separated). The client is built to survive one of them being down:
+ *  - a tab sticks to one host (a random one to start with, so load spreads across visitors), which keeps the
+ *    connection warm; it does not alternate per request;
+ *  - a GET that fails on the host (network error, timeout, 429 or 5xx) is retried once on the next host;
+ *  - a host that fails twice in a row is skipped for a minute (circuit breaker), remembered for the tab;
+ *  - POST/PUT/PATCH/DELETE are never replayed on another host: a failed contact or application request may have
+ *    reached the server, and replaying it could send the message twice;
+ *  - identical GETs for listing data are answered once: concurrent callers share one request and the answer is
+ *    kept for a short time (see the cache below).
+ */
 export declare const REACT_APP_DATA_BASE_URLS: string[];
+export declare const GET_TIMEOUT_MS = 8000;
+export declare const clearApiCache: () => void;
+/** Starts from the state this tab remembers (or a random primary host). Mainly for tests and first load. */
+export declare const resetApiState: () => void;
+/** The host to use now. Reading it never changes anything, so calling it twice gives the same answer. */
 export declare const getBaseUrl: () => string;
 export declare const DEFAULT_IMAGE_URL: string;
-declare const _default: import("axios").AxiosInstance;
-export default _default;
-export declare const get: (url: string) => Promise<AxiosResponse<any, any>>;
+declare const Api: import("axios").AxiosInstance;
+/**
+ * Response cache for GETs. Several components ask for the same listing (a property, its floorplans, its FAQs) while
+ * a page is built, and visitors move back and forth between pages; the answer rarely changes within seconds.
+ *  - only paths that carry listing data are cached (see CACHEABLE); sublets, which change as people post, are not;
+ *  - the key is the path, not the host, because all hosts serve the same data;
+ *  - concurrent identical requests share one request, failures are never kept;
+ *  - every caller gets its own copy of the data, because components sort and edit the arrays they receive;
+ *  - any successful write empties the cache;
+ *  - a request with "Cache-Control: no-cache" skips the cache and refreshes it.
+ */
+/** How long a GET answer is reused, in milliseconds. 0 switches the cache off. */
+export declare const setApiCacheTtl: (ms: number) => void;
+export default Api;
+export declare const get: (url: string) => Promise<AxiosResponse>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@renaissancerentals/renaissance-component",
-  "version": "13.0.14",
+  "version": "13.0.16",
   "description": "Renaissance rentals UI component library",
   "author": "asikpradhan",
   "license": "MIT",