@inploi/plugin-job-search 8.5.6 → 8.6.0

package/README.md

@@ -0,0 +1,56 @@
+# @inploi/plugin-job-search
+
+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:
+
+```ts
+map: {
+  enabled: true,
+  renderer: 'maplibre',
+  style: 'default',
+}
+```
+
+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.
+
+Enable hosted style ids after `maps.inploi.com` serves the selected style and its tile/glyph 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`; 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,
+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.
+Unchanged rendered credits preserve the existing attribution links and keyboard focus during source updates.
+Credits use Mapbox GL's attribution dimensions: 12px/20px Helvetica Neue/Arial, 0 5px padding,
+50% white background, square corners, and 75% black links, flush to the bottom-right corner.
+Below 480px map width, the credit is initially visible, then collapses after five visible seconds to
+MapLibre's 24px information button (10px inset). The labelled button supports Enter/Space and exposes
+`aria-expanded`. Focused credits never auto-collapse. Style changes disclose the new credit again.
+
+[OSMF's interactive-map guidelines](https://osmfoundation.org/wiki/Licence/Attribution_Guidelines#Interactive_maps)
+permit automatic collapse after five seconds with discoverable licence information.
+[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.
+
+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')`
+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.
+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/**`.