@inploi/plugin-job-search 8.6.1 → 9.0.0

package/README.md

@@ -1,29 +1,43 @@
 # @inploi/plugin-job-search
 
+Location suggestions use `https://maps.inploi.com/places`, limited to the hub's countries. A random id persists
+in sessionStorage for the browser tab (or memory when storage is unavailable), so the Worker's rollout keeps
+each visitor on one search arm. Worker errors, invalid responses and a 2.5-second timeout fall back to the
+existing direct Mapbox geocoder. Exact typed postcodes still rank first. Applying a suggestion or searching
+typed text sends a codes-only outcome to the Worker; query text and location details are never included.
+
 The SDK job-search widget supports an optional map via `JobSearchPluginParams.map`.
-Mapbox remains the default renderer during the MapLibre rollout. Enable MapLibre per embed:
+It renders with MapLibre from `maps.inploi.com`, so by default a candidate's browser requests map resources
+from no third party:
 
 ```ts
 map: {
   enabled: true,
-  renderer: 'maplibre',
-  style: 'default',
+  style: 'default', // optional
 }
 ```
 
-CDN embeds load MapLibre on demand from `maplibre-gl.js` beside the plugin's `cdn/index.js`, so pages on
-the Mapbox renderer don't download it. npm builds keep `maplibre-gl` as an external dependency.
+`renderer: 'mapbox'` keeps Mapbox for an embed that sets it explicitly (careers hubs use it for per-company
+rollback); Mapbox code loads only then, with its optional performance telemetry off
+(`performanceMetricsCollection: false`). Its map-load and tile billing events have no opt-out.
+Mapbox's `accessToken` is used only by that renderer, is ignored by MapLibre, and is deprecated for eventual removal.
+
+CDN embeds load each map library on demand from a sibling of the plugin's `cdn/index.js`
+(`maplibre-gl.js` or `mapbox-gl.js`), so a page downloads only the renderer it uses. A sibling download that
+fails or takes longer than ten seconds, like a map that fails to start, gets one more attempt before the map shows
+the unavailable notice below. npm builds keep `maplibre-gl` external and load `mapbox-gl` from a lazy chunk.
 
-Enable hosted style ids after `maps.inploi.com` serves the selected style and its tile/glyph resources.
+Use a hosted style id only once `maps.inploi.com` serves it and its tile, glyph and sprite resources.
 MapLibre needs no access token. A style id resolves to `https://maps.inploi.com/styles/{id}.json`;
-omitting `style` selects `default`. HTTPS style URLs are also supported. The legacy Mapbox light-v10
-and light-v11 URLs map to `default` and Compass's custom job-page style maps to `compass`; other Mapbox URLs
-select `default` and emit a warning.
-For new configuration, use `mapbox://` URLs only with the Mapbox renderer. Unsupported style formats throw.
-MapLibre falls back once to OpenFreeMap Positron if the initial style or tile source fails before load,
-or loading takes longer than ten seconds. Styles hosted at `https://maps.inploi.com` show only the linked
-`© OpenStreetMap contributors` credit. OpenFreeMap styles show `© OpenMapTiles` and the OSM credit,
-including immediately on fallback. Other styles show de-duplicated source credits,
+omitting `style` selects `default`. Mapbox styles never reach Mapbox: the light-v10 and light-v11 URLs map to
+`default`, outdoors-v12 and streets-v12 to `outdoors` and `streets`, and each client's custom Mapbox style to its
+hosted id (see `MAPBOX_TO_ID`), in either the `mapbox://styles/…` or `https://api.mapbox.com/styles/v1/…` form;
+other Mapbox URLs select `default` and log a warning. Other HTTPS style URLs are used as given.
+If the style or a basemap tile fails before the map first loads, or it takes longer than ten seconds, MapLibre
+retries the same style once. If that fails too, or an unsupported style format is configured, the map is replaced
+by a static `Map unavailable` notice (`role="status"`, term `map_unavailable`) and the job list and search keep
+working. Styles hosted at `https://maps.inploi.com` show only the linked
+`© OpenStreetMap contributors` credit. Other styles show de-duplicated source credits,
 updated as the style and source metadata load. Source attribution is parsed in an inert document and rebuilt
 as text and HTTP(S) links only; remote elements and attributes are never copied into the page.
 OpenStreetMap credit is added if no source provides it.
@@ -39,19 +53,18 @@ permit automatic collapse after five seconds with discoverable licence informati
 [Protomaps attribution is optional](https://github.com/protomaps/basemaps#licensing-and-attribution-guidelines);
 its OSM tiles require OSM attribution. [MapLibre's BSD-3 licence](https://github.com/maplibre/maplibre-gl-js/blob/main/LICENSE.txt)
 requires distribution notices, not an on-map credit.
-[OpenFreeMap](https://openfreemap.org/#attribution) makes its own name optional; the
-[OpenMapTiles design licence](https://github.com/openmaptiles/openmaptiles/blob/master/LICENSE.md#design-license-cc-by-40)
-requires the linked OpenMapTiles credit for its schema-derived maps.
+Styles built on the OpenMapTiles schema carry the linked OpenMapTiles credit
+[its design licence](https://github.com/openmaptiles/openmaptiles/blob/master/LICENSE.md#design-license-cc-by-40)
+requires in their source attribution.
 
-The public `@inploi/plugin-job-search/utils` entry exports `resolveMapStyle`, `MAP_FALLBACK_STYLE`,
-and `createMapAttribution(styleUrl)`. Add the latter with `map.addControl(control, 'bottom-right')`
+The public `@inploi/plugin-job-search/utils` entry exports `resolveMapStyle` and
+`createMapAttribution(styleUrl)`. Add the latter with `map.addControl(control, 'bottom-right')`
 after loading MapLibre's CSS. Call `control.setStyle(styleUrl)` when swapping styles; MapLibre removes
 its observers, event listeners and scoped stylesheet through the control's `onRemove` lifecycle.
-`resolveMapStyle` returns `{ url, unmapped? }`; callers can use `unmapped` to identify a legacy style
-that needs migrating. Mapbox's `accessToken` remains supported and is deprecated for eventual removal.
+`resolveMapStyle` returns `{ url, unmapped? }`, and throws for an unsupported format; callers can use
+`unmapped` to identify a legacy style that needs migrating.
 MapLibre's cooperative-gesture hints use the plugin's `map_gesture_windows`, `map_gesture_mac` and
 `map_gesture_mobile` terms, so embeds can localise them through `terms`.
 
-For local manual checks, use `?test_renderer=maplibre`. The dev harness uses OpenFreeMap until the
-inploi tile service is live. Add `&test_map_style=hosted` to exercise the hosted default style,
-including browser tests that intercept `https://maps.inploi.com/**`.
+The dev harness uses the default renderer and hosted default style; browser tests intercept
+`https://maps.inploi.com/**`. For local manual checks of the Mapbox renderer, use `?test_renderer=mapbox`.