Files
TREK/client/src/repo/pluginPoiRepo.ts
T
Maurice 1727732841 feat(plugins): plugins can add POI categories to the map and answer them
A new manifest capability poiCategories (up to 4, icon from an allow-list,
strict #rrggbb color) and the hook poiCategoryProvider.getPois behind the
hook:poi-category-provider permission. GET /api/plugin-pois in the plugin
contributions module answers them in the /api/maps/pois shape, with
search_plugin_pois as the MCP twin. plugin: ids no longer count as Google
place ids. SDK 1.8.0 carries the types, validation and docs.

On the map, one hook merges the built-in categories with the ones active
plugins declare, and the pill shows the plugin chips after a divider on
desktop and phone, scrolling sideways instead of shrinking a chip below
its touch target. A plugin chip searches through a repo that refuses
offline and parses the answer strictly. Its pins, on Leaflet and GL, use
the category's own icon and color, both checked again before they reach
any markup, and the hover card lists the plugin's details as escaped
text. A plugin POI can be added as a place like any other. The admin
panels on desktop and phone show a chip for the new permission and the
categories a plugin would add, from one shared module.

Addresses discussion #1781.
2026-09-25 01:24:55 +00:00

28 lines
1.4 KiB
TypeScript

import { pluginPoiResponseSchema, type PluginPoi } from '@trek/shared'
import { pluginPoisApi, type PluginPoiArea } from '../api/pluginPois'
import type { Poi } from '../components/Map/poiCategories'
import { isEffectivelyOffline } from '../sync/networkMode'
// The contract row as the map's Poi. The nullable fields are spelled out because the
// client compiles without strict mode, where zod types them as optional.
function toPoi(row: PluginPoi): Poi {
return { ...row, address: row.address ?? null, website: row.website ?? null, phone: row.phone ?? null }
}
/**
* The places of a plugin POI category (#1781) for the explore pill.
*
* Online only, like the core categories: the answer comes from the plugin, live, and
* is never kept. Offline the request is not made at all and the chip shows its error
* dot instead. The answer is checked strictly on top of the api module's development
* warning, because a plugin POI's colour and icon go on to be drawn into marker
* markup, and only a row the shared contract accepts may get that far.
*/
export const pluginPoiRepo = {
async search(pluginId: string, categoryId: string, bbox: PluginPoiArea, lang: string, signal: AbortSignal) {
if (isEffectivelyOffline()) throw new Error('Plugin POI search requires a connection')
const reply = pluginPoiResponseSchema.parse(await pluginPoisApi.search(pluginId, categoryId, bbox, lang, signal))
return { ...reply, pois: reply.pois.map(toPoi) }
},
}