@minmaps-dev/mm-web-sdk 1.0.0-rc.4 → 1.0.0-rc.40

package/README.md

@@ -35,15 +35,19 @@ await sdk.init()
 
 ## Status
 
-This SDK is on a pre-1.0 release candidate (`1.0.0-rc.3`). The following capabilities are wired but **dormant pending backend support** — they are not yet functional in the published build:
+This SDK is on a pre-1.0 release candidate (`1.0.0-rc.24`). A few capabilities remain **dormant pending backend support** — they are not yet functional in the published build:
 
 | Area | Status | Notes |
 | --- | --- | --- |
 | Floors, POIs, amenities, destinations | ✅ Shipped | Loads via JACS `building/full` + `venue/full`. |
 | Camera + view modes (3D/2D/flat) | ✅ Shipped | Style toggles work against the bundled `alt3-hybrid-style.json`. |
+| Wayfinding | ✅ Shipped | Built-in JACS path-graph routing (rc.18). `JacsWayfindingProvider` is wired by default; route computation runs inside the SDK (`src/data/wayfinding/`). No provider injection needed. |
+| Contextual map APIs | ✅ Shipped | `highlightPOI`/`highlightAmenity`/`clearHighlight`, `setPOIFilter`/`clearPOIFilter`, `setDestinationCirclesVisible`/`setDestinationLabelsVisible`, `amenities.getDistinct`, `findClosestWaypoint`, `searchAllPOIs`, `navigateFromKioskToPOI`, `refit`. See `docs/API.md#contextual-map`. |
+| Opening hours | ✅ Shipped | `getPOIDetails(poi).openHours` parses the CMS's `mm_open_hours` extensor; `getOpenStatus()` derives open/closed, "closing soon", and the next opening. See `docs/API.md#opening-hours`. |
+| Destination detail fields | ✅ Shipped | `getPOIDetails(poi)` also surfaces `phone`, `imageAlt`, `buildingName` and `roomNumber` — the CMS's `mm_`-prefixed stand-in extensors, plus the real `unitNumber` column. See `docs/API.md#reserved-extensors`. |
+| Restroom icon grouping | ✅ Shipped | Restroom pins too close together to draw individually collapse into one Material `wc` badge and expand back as the camera zooms in — fixing men's/women's pairs where MapLibre silently dropped one icon. Tapping the badge emits `poiSelected` with every restroom it stands for. Opt out with `options.groupRestroomIcons: false`. |
 | Venue-served stylesheets | 🚧 Roadmap | SDK currently uses its bundled style; `loadAndPatchVenueStyle()` is bypassed. |
 | Polygon layers + 3D map templates | 🚧 Roadmap | `buildPolygonLayers` / `applyMapTemplate3d` imports are commented in `src/sdk.ts`. |
-| Wayfinding | 🚧 Roadmap | Route renderer is fully built, but the runtime provider is a stub that throws *"Wayfinding is not yet implemented in the SDK"*. |
 
 Track re-enable points by grepping `// TODO: Re-enable` in `src/sdk.ts` and `src/data/jacsDataProvider.ts`.
 
@@ -67,6 +71,7 @@ The lean root README intentionally stops here. For depth, see:
 - [`docs/ARCHITECTURE.md`](./docs/ARCHITECTURE.md) — module map, init flow, JACS data path, style patching, dormant 3D notes.
 - [`docs/API.md`](./docs/API.md) — full public API surface grouped by lifecycle, floors, POIs, amenities, wayfinding, camera, events.
 - [`docs/KIOSK.md`](./docs/KIOSK.md) — kiosk integration patterns (You-Are-Here, kiosk-to-destination wayfinding once enabled, view-mode UX, sprite hosting, idle reset).
+- [`docs/ICONS.md`](./docs/ICONS.md) — the curated icon registry, how amenity/connector icons resolve and render, why destinations render none, the CMS upload flow, and the release coupling between the icon-set and SDK packages.
 
 External integrators will usually only need the [API](./docs/API.md) and [Kiosk](./docs/KIOSK.md) docs. Internal MTS engineers should also read [Architecture](./docs/ARCHITECTURE.md) before touching `src/sdk.ts` or the JACS provider.
 
@@ -160,7 +165,7 @@ Browser apps should use `mode: 'proxy'` and forward requests through your own se
 2. Exchange the password grant for a bearer token (cache until expiry).
 3. Forward `GET /api/jacs/<path>` to `${JACS_HOST}/JACS/api/<path>` with the token attached.
 
-A reference Next.js route handler ships in the example app at `mm-web-sdk-example/app/api/jacs/[...path]/route.ts`. Copy it into your own backend or adapt it to your framework, then point `jacs.proxyBaseUrl` at it.
+A reference Next.js route handler ships in the example app at `apps/example/app/api/jacs/[...path]/route.ts`. Copy it into your own backend or adapt it to your framework, then point `jacs.proxyBaseUrl` at it.
 
 ### JACS direct mode
 
@@ -180,32 +185,35 @@ jacs: {
 
 ## Sprites
 
-`options.customSprite` is a sprite URL **prefix without extension** — MapLibre appends `.json` and `.png` (and `@2x` variants) automatically. The example app serves its sprite from `mm-web-sdk-example/public/sprites/`.
+`options.customSprite` is a sprite URL **prefix without extension** — MapLibre appends `.json` and `.png` (and `@2x` variants) automatically. The example app serves its sprite from `apps/example/public/sprites/`.
 
 ---
 
 ## Development
 
+Run commands from the **monorepo root** through pnpm/turbo (install pnpm via npm, not corepack):
+
 ```bash
-npm install
-npm run dev:sdk         # rollup --watch (rebuilds dist/ on change)
-npm run build           # rimraf dist + production rollup build
-npm run typecheck       # tsc --noEmit
-npm test                # vitest run
-npm run test:watch      # vitest in watch mode
-npm run test:coverage   # vitest run --coverage (v8 provider)
+pnpm install           # once, at the root — one lockfile for the whole monorepo
+pnpm dev               # turbo: SDK rollup --watch + example next dev together
+pnpm build             # turbo: production build of all packages
+pnpm typecheck         # turbo: tsc --noEmit
+pnpm test              # turbo: vitest run
 ```
 
+SDK-only build: `pnpm --filter @minmaps-dev/mm-web-sdk build`. Per-package scripts (`dev:sdk`, `test:watch`, `test:coverage`) still exist and can be run with `pnpm --filter @minmaps-dev/mm-web-sdk <script>`.
+
 The build emits ESM, CJS, and types under `dist/` for both the root entry and the `/react` entry. Tests live in `tests/` and target the three highest-leverage modules: `JacsProvider`, `WayfindingManager`, and `ViewModeController`. Coverage thresholds are gated in `vitest.config.ts` (currently 60% lines/funcs/stmts, 50% branches).
 
 ### Continuous integration
 
-Two workflows in `.github/workflows/`:
+CI lives at the **monorepo root** in `.github/workflows/`:
 
-- **`ci.yml`** — runs typecheck, vitest with coverage, and the production build on every push and pull request to `main` / `dev`. Coverage and `dist/` are uploaded as artifacts.
-- **`publish.yml`** — runs on tags matching `v*` (or via manual dispatch). Verifies the tag matches `package.json` version, runs the full pipeline, and publishes to npm with provenance. Requires an `NPM_TOKEN` repo secret.
+- **`ci.yml`** — runs typecheck, vitest with coverage, and the production build on every push and pull request to `main` / `dev`.
+- **`release.yml`** — Changesets-driven releases. Write a changeset, merge to `main`, and a "Version Packages" PR is opened; merging it runs `changeset publish` to npm (access `public`). There is no tag-based publish workflow and no provenance flag.
+- **`deploy-example.yml`** — deploys the example app.
 
-> **Internal note:** future Claude sessions get oriented from [`CLAUDE.md`](./CLAUDE.md). Repo-local subagents in [`.claude/agents/`](./.claude/agents/) cover API doc sync, release notes, and style/template edits.
+> **Internal note:** future Claude sessions get oriented from [`CLAUDE.md`](./CLAUDE.md). Subagents at the monorepo-root `.claude/agents/` cover API doc sync, release notes, and style/template edits.
 
 ---