The routeData Y.Map's ~15 string keys (geojson, coordinates, segmentBoundaries, road metadata, profile, colorMode, baseLayer, overlays, poiCategories) were read and written raw at ~30 call sites, each with its own JSON parsing and casts; parseJsonArray existed twice and waypoint extraction four times. GPX assembly was duplicated between SaveToJournalButton and ExportButton, so the saved plan and the exported file could silently diverge. - new lib/route-data.ts owns the routeData (+ noGoAreas) schema: typed read/write, JSON encoding internal, ColorMode moves here (re-exported from ColoredRoute for existing importers) - new lib/gpx-export.ts owns GPX assembly: buildRouteGpx / buildPlanGpx / buildDayGpxFiles / hasDayBreaks; multi-day splitting becomes a pure, tested function - waypoint-ymap.ts gains extractWaypoints / extractWaypointData; the four hand-rolled copies (use-routing, use-waypoint-manager, WaypointSidebar, use-days) now share it, and WaypointSidebar's moveWaypoint reuses the round-trip helpers instead of re-listing every waypoint field - all hooks/components consume the seam; no raw routeData key strings remain outside route-data.ts Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
221 lines
6.7 KiB
TypeScript
221 lines
6.7 KiB
TypeScript
import * as Y from "yjs";
|
|
import type { EnrichedRoute } from "./route-merge.ts";
|
|
|
|
// The schema of the shared `routeData` Y.Map (and the `noGoAreas` Y.Array).
|
|
// This module is the only place that knows the key strings and JSON
|
|
// encoding of the collaborative document's route state — consumers read
|
|
// and write through the typed functions below. Waypoints have their own
|
|
// schema module: waypoint-ymap.ts.
|
|
|
|
export type ColorMode =
|
|
| "plain"
|
|
| "elevation"
|
|
| "surface"
|
|
| "grade"
|
|
| "highway"
|
|
| "maxspeed"
|
|
| "smoothness"
|
|
| "tracktype"
|
|
| "cycleway"
|
|
| "bikeroute";
|
|
|
|
export const DEFAULT_PROFILE = "fastbike";
|
|
|
|
/** routeData key observed externally (use-routing recomputes on change). */
|
|
export const PROFILE_KEY = "profile";
|
|
|
|
/** Per-coordinate road attributes BRouter enriches the route with. */
|
|
export const ROAD_METADATA_KEYS = [
|
|
"surfaces",
|
|
"highways",
|
|
"maxspeeds",
|
|
"smoothnesses",
|
|
"tracktypes",
|
|
"cycleways",
|
|
"bikeroutes",
|
|
] as const;
|
|
|
|
export type RoadMetadataKey = (typeof ROAD_METADATA_KEYS)[number];
|
|
export type RoadMetadata = Record<RoadMetadataKey, string[]>;
|
|
|
|
/** The computed-route portion of routeData, decoded. */
|
|
export interface ComputedRoute extends RoadMetadata {
|
|
/** [lon, lat, ele] triples, GeoJSON axis order. */
|
|
coordinates: [number, number, number][] | null;
|
|
segmentBoundaries: number[];
|
|
}
|
|
|
|
export interface NoGoAreaData {
|
|
points: Array<{ lat: number; lon: number }>;
|
|
}
|
|
|
|
export function parseJsonArray<T>(json: string | undefined): T[] {
|
|
if (!json) return [];
|
|
try {
|
|
return JSON.parse(json);
|
|
} catch {
|
|
return [];
|
|
}
|
|
}
|
|
|
|
/** Like parseJsonArray, but distinguishes "absent or unparseable" from "empty". */
|
|
function parseJsonArrayOrUndefined<T>(json: string | undefined): T[] | undefined {
|
|
if (!json) return undefined;
|
|
try {
|
|
return JSON.parse(json);
|
|
} catch {
|
|
return undefined;
|
|
}
|
|
}
|
|
|
|
// --- Computed route (written by the routing host, read by everyone) ---
|
|
|
|
export function getGeojson(routeData: Y.Map<unknown>): string | undefined {
|
|
return routeData.get("geojson") as string | undefined;
|
|
}
|
|
|
|
/**
|
|
* Route coordinates as [lon, lat, ele] triples. Reads the "coordinates"
|
|
* key; falls back to extracting them from "geojson" for documents written
|
|
* before the coordinates key existed.
|
|
*/
|
|
export function getCoordinates(routeData: Y.Map<unknown>): [number, number, number][] | null {
|
|
const coordsJson = routeData.get("coordinates") as string | undefined;
|
|
if (coordsJson) {
|
|
try {
|
|
return JSON.parse(coordsJson);
|
|
} catch {
|
|
/* fall through to geojson */
|
|
}
|
|
}
|
|
const geojson = getGeojson(routeData);
|
|
if (geojson) {
|
|
try {
|
|
const parsed = JSON.parse(geojson);
|
|
const coords: number[][] | undefined = parsed.features?.[0]?.geometry?.coordinates;
|
|
if (coords) {
|
|
return coords.map((c) => [c[0]!, c[1]!, c[2] ?? 0] as [number, number, number]);
|
|
}
|
|
} catch {
|
|
/* invalid geojson */
|
|
}
|
|
}
|
|
return null;
|
|
}
|
|
|
|
export function readRoadMetadata(routeData: Y.Map<unknown>): RoadMetadata {
|
|
const metadata = {} as RoadMetadata;
|
|
for (const key of ROAD_METADATA_KEYS) {
|
|
metadata[key] = parseJsonArray<string>(routeData.get(key) as string | undefined);
|
|
}
|
|
return metadata;
|
|
}
|
|
|
|
export function readComputedRoute(routeData: Y.Map<unknown>): ComputedRoute {
|
|
return {
|
|
coordinates: getCoordinates(routeData),
|
|
segmentBoundaries: parseJsonArray<number>(
|
|
routeData.get("segmentBoundaries") as string | undefined,
|
|
),
|
|
...readRoadMetadata(routeData),
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Stores an enriched route for all participants in one transaction.
|
|
* Metadata keys are only written when non-empty, mirroring what the
|
|
* routing host has always done — a recompute that yields no metadata
|
|
* leaves the previous arrays in place.
|
|
*/
|
|
export function writeComputedRoute(
|
|
doc: Y.Doc,
|
|
routeData: Y.Map<unknown>,
|
|
enriched: EnrichedRoute,
|
|
): void {
|
|
doc.transact(() => {
|
|
routeData.set("geojson", JSON.stringify(enriched.geojson));
|
|
routeData.set("coordinates", JSON.stringify(enriched.coordinates));
|
|
routeData.set("segmentBoundaries", JSON.stringify(enriched.segmentBoundaries));
|
|
for (const key of ROAD_METADATA_KEYS) {
|
|
if (enriched[key]?.length) {
|
|
routeData.set(key, JSON.stringify(enriched[key]));
|
|
}
|
|
}
|
|
});
|
|
}
|
|
|
|
/** Debug/recovery escape hatch: store a raw GeoJSON route without enrichment. */
|
|
export function setGeojson(routeData: Y.Map<unknown>, geojson: unknown): void {
|
|
routeData.set("geojson", JSON.stringify(geojson));
|
|
}
|
|
|
|
/** Removes the computed route and profile (view preferences are kept). */
|
|
export function clearRouteData(doc: Y.Doc, routeData: Y.Map<unknown>): void {
|
|
doc.transact(() => {
|
|
routeData.delete("geojson");
|
|
routeData.delete("coordinates");
|
|
routeData.delete("segmentBoundaries");
|
|
for (const key of ROAD_METADATA_KEYS) {
|
|
routeData.delete(key);
|
|
}
|
|
routeData.delete(PROFILE_KEY);
|
|
});
|
|
}
|
|
|
|
// --- Routing profile ---
|
|
|
|
export function getProfile(routeData: Y.Map<unknown>): string | undefined {
|
|
return routeData.get(PROFILE_KEY) as string | undefined;
|
|
}
|
|
|
|
export function setProfile(routeData: Y.Map<unknown>, profile: string): void {
|
|
routeData.set(PROFILE_KEY, profile);
|
|
}
|
|
|
|
// --- View preferences (shared across participants) ---
|
|
|
|
export function getColorMode(routeData: Y.Map<unknown>): ColorMode {
|
|
return (routeData.get("colorMode") as ColorMode | undefined) ?? "plain";
|
|
}
|
|
|
|
export function setColorMode(routeData: Y.Map<unknown>, mode: ColorMode): void {
|
|
routeData.set("colorMode", mode);
|
|
}
|
|
|
|
export function getBaseLayer(routeData: Y.Map<unknown>): string | undefined {
|
|
return routeData.get("baseLayer") as string | undefined;
|
|
}
|
|
|
|
export function setBaseLayer(routeData: Y.Map<unknown>, name: string): void {
|
|
routeData.set("baseLayer", name);
|
|
}
|
|
|
|
export function getOverlays(routeData: Y.Map<unknown>): string[] | undefined {
|
|
return parseJsonArrayOrUndefined<string>(routeData.get("overlays") as string | undefined);
|
|
}
|
|
|
|
export function setOverlays(routeData: Y.Map<unknown>, ids: string[]): void {
|
|
routeData.set("overlays", JSON.stringify(ids));
|
|
}
|
|
|
|
export function getPoiCategories(routeData: Y.Map<unknown>): string[] | undefined {
|
|
return parseJsonArrayOrUndefined<string>(
|
|
routeData.get("poiCategories") as string | undefined,
|
|
);
|
|
}
|
|
|
|
export function setPoiCategories(routeData: Y.Map<unknown>, categories: string[]): void {
|
|
routeData.set("poiCategories", JSON.stringify(categories));
|
|
}
|
|
|
|
// --- No-go areas (their own Y.Array on the document) ---
|
|
|
|
/** Reads all no-go areas, dropping degenerate ones (fewer than 3 points). */
|
|
export function extractNoGoAreas(noGoAreas: Y.Array<Y.Map<unknown>>): NoGoAreaData[] {
|
|
return noGoAreas
|
|
.toArray()
|
|
.map((yMap) => ({
|
|
points: (yMap.get("points") as Array<{ lat: number; lon: number }>) ?? [],
|
|
}))
|
|
.filter((a) => a.points.length >= 3);
|
|
}
|