Files
TREK/client/src/api/pluginPois.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

37 lines
1.3 KiB
TypeScript

import { pluginPoiResponseSchema, type PluginPoiResponse } from '@trek/shared'
import { apiClient, parseInDev } from './client'
/** The map area a plugin POI search covers, as the explore pill reports it. */
export interface PluginPoiArea {
south: number
west: number
north: number
east: number
}
/**
* The same ceiling as the core categories' GET /api/maps/pois. The server gives the
* plugin 8 seconds and answers 502 after that, so this only ever cuts off a request
* that got lost on the way.
*/
export const PLUGIN_POI_TIMEOUT_MS = 20_000
/**
* GET /api/plugin-pois (#1781): the places of one plugin POI category inside a map
* area. In a file of its own rather than in the `client.ts` god module, typed from the
* shared contract. The explore pill reaches it through repo/pluginPoiRepo.ts, which
* adds the offline guard and the strict check.
*/
export const pluginPoisApi = {
search: (
pluginId: string,
category: string,
bbox: PluginPoiArea,
lang: string | undefined,
signal?: AbortSignal,
): Promise<PluginPoiResponse> =>
apiClient
.get('/plugin-pois', { params: { pluginId, category, ...bbox, lang }, signal, timeout: PLUGIN_POI_TIMEOUT_MS })
.then(r => parseInDev(pluginPoiResponseSchema, r.data, 'pluginPois.search')),
}