@renaissancerentals/renaissance-component 13.0.14 → 13.0.15

package/lib/asset/service/AssetService.d.ts

@@ -1,7 +1,30 @@
 import { Asset } from "../data/Asset";
 export declare const propertyFragment: (propertyId?: string) => string;
-export declare const getAssetUrl: (imageUrl: string, assetGatewayId?: string) => string;
-export declare const assetUrlFrom: (id: string, assetGatewayId: string) => string;
+/**
+ * Images are served by Google's image CDN straight from Drive, so the bytes never pass through our servers and
+ * Google resizes them. Google throttles bursts (HTTP 429), so this is deliberately cautious:
+ *  - at most CDN_BUDGET images per CDN_WINDOW_MS use the CDN, the overflow goes straight to our own endpoint;
+ *  - after CDN_ERRORS_TO_TRIP failures the CDN is switched off for CDN_COOLDOWN_MS (remembered for the tab);
+ *  - a failed CDN image falls back to our own download endpoint (see installImageFallback);
+ *  - the choice for an image is made once, so re-rendering never flips an image between sources.
+ * Callers that pass no width get the original through our endpoint, as before.
+ */
+export { IMAGE_WIDTH } from "./ImageWidth";
+/** Starts a fresh state, picking up a cooldown that an earlier page of this tab recorded. */
+export declare const resetImageCdn: () => void;
+/** Switch the Google CDN off or on (off: every image comes through our own download endpoint). */
+export declare const setImageCdnEnabled: (enabled: boolean) => void;
+export declare const googleImageUrl: (id: string, width: number) => string;
+export declare const serverAssetUrl: (id: string, assetGatewayId?: string) => string;
+export declare const getAssetUrl: (imageUrl: string, assetGatewayId?: string, width?: number) => string;
+export declare const assetUrlFrom: (id: string, assetGatewayId: string, width?: number) => string;
+/**
+ * When an image from Google's CDN fails to load, load it from our own endpoint instead, and count the failure
+ * towards the circuit breaker. One listener covers every <img> in the library, so no component needs its own
+ * onError. A failure of the fallback itself is not retried.
+ */
+export declare const handleImageError: (event: Event) => void;
+export declare const installImageFallback: () => void;
 export declare const getAssetsFrom: (folderId: string) => Promise<Asset[]>;
 export declare const assetDomains: string[];
 export declare const propertyIdToDomain: (propertyId?: string) => string;

package/lib/asset/service/ImageWidth.d.ts

@@ -0,0 +1,6 @@
+/** Widths (px) we ask Google's image CDN for. Kept apart from AssetService so tests that mock that module keep them. */
+export declare const IMAGE_WIDTH: {
+    readonly thumb: 400;
+    readonly card: 800;
+    readonly large: 1600;
+};